Merge pull request #2439 from jmcclell/kustomize-configs

Support alternative Kustomization config filenames (#2422)

pkg/skaffold/deploy/kustomize.go

@@ -18,6 +18,7 @@ package deploy
 
 import (
 	"context"
+	"fmt"
 	"io"
 	"io/ioutil"
 	"os"
@@ -156,7 +157,11 @@ func (k *KustomizeDeployer) Cleanup(ctx context.Context, out io.Writer) error {
 func dependenciesForKustomization(dir string) ([]string, error) {
 	var deps []string
 
-	path := filepath.Join(dir, "kustomization.yaml")
+	path, err := findKustomizationConfig(dir)
+	if err != nil {
+		return nil, err
+	}
+
 	buf, err := ioutil.ReadFile(path)
 	if err != nil {
 		return nil, err
@@ -217,6 +222,18 @@ func joinPaths(root string, paths []string) []string {
 	return list
 }
 
+// A kustomization config must be at the root of the direectory. Kustomize will
+// error if more than one of these files exists so order doesn't matter.
+func findKustomizationConfig(dir string) (string, error) {
+	candidates := []string{"kustomization.yaml", "kustomization.yml", "Kustomization"}
+	for _, candidate := range candidates {
+		if local, _ := pathExistsLocally(candidate, dir); local {
+			return filepath.Join(dir, candidate), nil
+		}
+	}
+	return "", fmt.Errorf("no Kustomization configuration found in directory: %s", dir)
+}
+
 func pathExistsLocally(filename string, workingDir string) (bool, os.FileMode) {
 	path := filename
 	if !filepath.IsAbs(filename) {

pkg/skaffold/deploy/kustomize_test.go

@@ -162,6 +162,7 @@ func TestDependenciesForKustomization(t *testing.T) {
 		expected    []string
 		shouldErr   bool
 		createFiles map[string]string
+		configName  string
 	}{
 		{
 			description: "resources",
@@ -250,11 +251,54 @@ func TestDependenciesForKustomization(t *testing.T) {
 				"base/app.yaml":           "",
 			},
 		},
+		{
+			description: "alt config name: kustomization.yml",
+			yaml:        `resources: [app.yaml]`,
+			expected:    []string{"kustomization.yml", "app.yaml"},
+			createFiles: map[string]string{
+				"app.yaml": "",
+			},
+			configName: "kustomization.yml",
+		},
+		{
+			description: "alt config name: Kustomization",
+			yaml:        `resources: [app.yaml]`,
+			expected:    []string{"Kustomization", "app.yaml"},
+			createFiles: map[string]string{
+				"app.yaml": "",
+			},
+			configName: "Kustomization",
+		},
+		{
+			description: "mixture of config names",
+			yaml:        `resources: [app.yaml, base1, base2]`,
+			expected:    []string{"Kustomization", "app.yaml", "base1/kustomization.yml", "base1/app.yaml", "base2/Kustomization", "base2/app.yaml"},
+			createFiles: map[string]string{
+				"app.yaml":                "",
+				"base1/kustomization.yml": `resources: [app.yaml]`,
+				"base1/app.yaml":          "",
+				"base2/Kustomization":     `resources: [app.yaml]`,
+				"base2/app.yaml":          "",
+			},
+			configName: "Kustomization",
+		},
+		{
+			description: "no kustomization config",
+			yaml:        `resources: [foo]`,
+			shouldErr:   true,
+			createFiles: map[string]string{
+				"foo/invalid-config-name": "",
+			},
+		},
 	}
 	for _, test := range tests {
 		testutil.Run(t, test.description, func(t *testutil.T) {
+			if test.configName == "" {
+				test.configName = "kustomization.yaml"
+			}
+
 			tmpDir := t.NewTempDir().
-				Write("kustomization.yaml", test.yaml)
+				Write(test.configName, test.yaml)
 
 			for path, contents := range test.createFiles {
 				tmpDir.Write(path, contents)