Add a fallback to inline environment when path doesn't exist (#637)

* Add a fallback to inline environment when path doesn't exist

* Add test + better error message in case of env not being found

Co-authored-by: Julien Duchesne <[email protected]>

Author: josephglanville

pkg/tanka/errors.go

@@ -17,12 +17,17 @@ func (e ErrNoEnv) Error() string {
 
 // ErrMultipleEnvs means that the given jsonnet has multiple Environment objects
 type ErrMultipleEnvs struct {
-	path  string
-	names []string
+	path      string
+	givenName string
+	foundEnvs []string
 }
 
 func (e ErrMultipleEnvs) Error() string {
-	return fmt.Sprintf("found multiple Environments in '%s'. Use `--name` to select a single one: \n - %s", e.path, strings.Join(e.names, "\n - "))
+	if e.givenName != "" {
+		return fmt.Sprintf("found multiple Environments in %q matching %q. Provide a more specific name that matches a single one: \n - %s", e.path, e.givenName, strings.Join(e.foundEnvs, "\n - "))
+	}
+
+	return fmt.Sprintf("found multiple Environments in %q. Use `--name` to select a single one: \n - %s", e.path, strings.Join(e.foundEnvs, "\n - "))
 }
 
 // ErrParallel is an array of errors collected while processing in parallel

pkg/tanka/inline.go

@@ -46,7 +46,7 @@ func (i *InlineLoader) Load(path string, opts LoaderOpts) (*v1alpha1.Environment
 		}
 		if len(envs) > 1 {
 			sort.Strings(names)
-			return nil, ErrMultipleEnvs{path, names}
+			return nil, ErrMultipleEnvs{path, opts.Name, names}
 		}
 	}
 

pkg/tanka/load.go

@@ -2,6 +2,7 @@ package tanka
 
 import (
 	"fmt"
+	"log"
 	"os"
 	"path/filepath"
 
@@ -41,6 +42,15 @@ func Load(path string, opts Opts) (*LoadResult, error) {
 }
 
 func LoadEnvironment(path string, opts Opts) (*v1alpha1.Environment, error) {
+	_, err := os.Stat(path)
+	if os.IsNotExist(err) {
+		log.Printf("Path %q does not exist, trying to use it as an environment name", path)
+		opts.Name = path
+		path = "."
+	} else if err != nil {
+		return nil, err
+	}
+
 	loader, err := DetectLoader(path)
 	if err != nil {
 		return nil, err

pkg/tanka/load_test.go

@@ -1,6 +1,7 @@
 package tanka
 
 import (
+	"os"
 	"testing"
 
 	"github.com/grafana/tanka/pkg/kubernetes/manifest"
@@ -157,11 +158,11 @@ func TestLoadSelectEnvironment(t *testing.T) {
 
 	// Empty options, match all environments
 	_, err = Load("./testdata/cases/multiple-inline-envs", Opts{})
-	assert.EqualError(t, err, "found multiple Environments in './testdata/cases/multiple-inline-envs'. Use `--name` to select a single one: \n - project1-env1\n - project1-env2\n - project2-env1")
+	assert.EqualError(t, err, "found multiple Environments in \"./testdata/cases/multiple-inline-envs\". Use `--name` to select a single one: \n - project1-env1\n - project1-env2\n - project2-env1")
 
 	// Partial match two environments
 	_, err = Load("./testdata/cases/multiple-inline-envs", Opts{Name: "env1"})
-	assert.EqualError(t, err, "found multiple Environments in './testdata/cases/multiple-inline-envs'. Use `--name` to select a single one: \n - project1-env1\n - project2-env1")
+	assert.EqualError(t, err, "found multiple Environments in \"./testdata/cases/multiple-inline-envs\" matching \"env1\". Provide a more specific name that matches a single one: \n - project1-env1\n - project2-env1")
 
 	// Partial match
 	result, err := Load("./testdata/cases/multiple-inline-envs", Opts{Name: "project2"})
@@ -174,6 +175,30 @@ func TestLoadSelectEnvironment(t *testing.T) {
 	assert.Equal(t, "project1-env1", result.Env.Metadata.Name)
 }
 
+// Tests that the load function will consider the path to be an environment name if it is not found
+func TestLoadEnvironmentFallbackToName(t *testing.T) {
+	// Temporarily change the working directory to the testdata directory
+	cwd, err := os.Getwd()
+	require.NoError(t, err)
+	err = os.Chdir("./testdata/cases/multiple-inline-envs")
+	require.NoError(t, err)
+	defer os.Chdir(cwd)
+
+	// Partial match two environments
+	_, err = Load("env1", Opts{})
+	assert.EqualError(t, err, "found multiple Environments in \".\" matching \"env1\". Provide a more specific name that matches a single one: \n - project1-env1\n - project2-env1")
+
+	// Partial match
+	result, err := Load("project2", Opts{})
+	require.NoError(t, err)
+	assert.Equal(t, "project2-env1", result.Env.Metadata.Name)
+
+	// Full match
+	result, err = Load("project1-env1", Opts{})
+	require.NoError(t, err)
+	assert.Equal(t, "project1-env1", result.Env.Metadata.Name)
+}
+
 func TestLoadSelectEnvironmentFullMatchHasPriority(t *testing.T) {
 	// `base` matches both `base` and `base-and-more`
 	// However, the full match should win