fix: stable naming of the environment

Before, the name of the internally used Environment type was different depending
on the argument passed on the command line, even though it resulted in the same
environment after all (relative vs absolute paths, etc.)

This fixes the issue by using the `jpath` package to compute baseDir and
rootDir, using the relative path from rootDir to baseDir as the name. This
results in stable names, regardless which directory representation is used.

Author: sh0rez

cmd/tk/main.go

@@ -5,13 +5,15 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"path/filepath"
 
 	"github.com/posener/complete"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"golang.org/x/crypto/ssh/terminal"
 
 	"github.com/grafana/tanka/pkg/cli/cmp"
+	"github.com/grafana/tanka/pkg/jsonnet/jpath"
 	"github.com/grafana/tanka/pkg/spec"
 	"github.com/grafana/tanka/pkg/spec/v1alpha1"
 )
@@ -86,7 +88,15 @@ func main() {
 }
 
 func setupConfiguration(baseDir string) *v1alpha1.Config {
-	config, err := spec.ParseDir(baseDir)
+	_, baseDir, rootDir, err := jpath.Resolve(baseDir)
+	if err != nil {
+		log.Fatalln("Resolving jpath:", err)
+	}
+
+	// name of the environment: relative path from rootDir
+	name, _ := filepath.Rel(rootDir, baseDir)
+
+	config, err := spec.ParseDir(baseDir, name)
 	if err != nil {
 		switch err.(type) {
 		// just run fine without config. Provider features won't work (apply, show, diff)

pkg/jsonnet/jpath/jpath.go

@@ -32,6 +32,11 @@ func (e ErrorFileNotFound) Error() string {
 // This results in predictable imports, as it doesn't matter whether the user called
 // called the command further down tree or not. A little bit like git.
 func Resolve(workdir string) (path []string, base, root string, err error) {
+	workdir, err = filepath.Abs(workdir)
+	if err != nil {
+		return nil, "", "", err
+	}
+
 	root, err = FindParentFile("jsonnetfile.json", workdir, "/")
 	if err != nil {
 		if _, ok := err.(ErrorFileNotFound); ok {

pkg/spec/spec.go

@@ -3,7 +3,6 @@ package spec
 import (
 	"bytes"
 	"os"
-	"path/filepath"
 
 	"github.com/pkg/errors"
 	"github.com/spf13/viper"
@@ -32,7 +31,7 @@ func Parse(data []byte, name string) (*v1alpha1.Config, error) {
 
 // ParseDir parses the given environments `spec.json` into a `v1alpha1.Config`
 // object with the name set to the directories name
-func ParseDir(baseDir string) (*v1alpha1.Config, error) {
+func ParseDir(baseDir, name string) (*v1alpha1.Config, error) {
 	fi, err := os.Stat(baseDir)
 	if err != nil {
 		return nil, err
@@ -49,7 +48,7 @@ func ParseDir(baseDir string) (*v1alpha1.Config, error) {
 		return nil, err
 	}
 
-	return parse(v, filepath.Base(baseDir))
+	return parse(v, name)
 }
 
 // parse accepts a viper.Viper already loaded with the actual config and

pkg/tanka/parse.go

@@ -35,7 +35,12 @@ func (p *ParseResult) newKube() (*kubernetes.Kubernetes, error) {
 // parse loads the `spec.json`, evaluates the jsonnet and returns both, the
 // kubernetes object and the reconciled manifests
 func parse(baseDir string, opts *options) (*ParseResult, error) {
-	env, err := parseEnv(baseDir, opts)
+	_, baseDir, rootDir, err := jpath.Resolve(baseDir)
+	if err != nil {
+		return nil, errors.Wrap(err, "resolving jpath")
+	}
+
+	env, err := parseEnv(baseDir, rootDir, opts)
 	if err != nil {
 		return nil, err
 	}
@@ -45,7 +50,7 @@ func parse(baseDir string, opts *options) (*ParseResult, error) {
 		return nil, errors.Wrap(err, "evaluating jsonnet")
 	}
 
-	rec, err := kubernetes.Reconcile(raw, env.Spec, opts.targets)
+	rec, err := kubernetes.Reconcile(raw, *env, opts.targets)
 	if err != nil {
 		return nil, errors.Wrap(err, "reconciling")
 	}
@@ -58,8 +63,11 @@ func parse(baseDir string, opts *options) (*ParseResult, error) {
 
 // parseEnv parses the `spec.json` of the environment and returns a
 // *kubernetes.Kubernetes from it
-func parseEnv(baseDir string, opts *options) (*v1alpha1.Config, error) {
-	config, err := spec.ParseDir(baseDir)
+func parseEnv(baseDir, rootDir string, opts *options) (*v1alpha1.Config, error) {
+	// name of the environment: relative path from rootDir
+	name, _ := filepath.Rel(rootDir, baseDir)
+
+	config, err := spec.ParseDir(baseDir, name)
 	if err != nil {
 		switch err.(type) {
 		// config is missing
@@ -82,15 +90,7 @@ func parseEnv(baseDir string, opts *options) (*v1alpha1.Config, error) {
 
 // eval evaluates the jsonnet environment at the given directory starting with
 // `main.jsonnet`
-func eval(path string) (map[string]interface{}, error) {
-	workdir, err := filepath.Abs(path)
-	if err != nil {
-		return nil, err
-	}
-	_, baseDir, _, err := jpath.Resolve(workdir)
-	if err != nil {
-		return nil, errors.Wrap(err, "resolving jpath")
-	}
+func eval(baseDir string) (map[string]interface{}, error) {
 	raw, err := jsonnet.EvaluateFile(filepath.Join(baseDir, "main.jsonnet"))
 	if err != nil {
 		return nil, err