Recursively build and diff Kustomizations

Signed-off-by: Boris Kreitchman <bkreitch@gmail.com>

cmd/flux/build_kustomization.go

@@ -53,7 +53,12 @@ flux build kustomization my-app --path ./path/to/local/manifests \
 # Exclude files by providing a comma separated list of entries that follow the .gitignore pattern fromat.
 flux build kustomization my-app --path ./path/to/local/manifests \
  --kustomization-file ./path/to/local/my-app.yaml \
- --ignore-paths "/to_ignore/**/*.yaml,ignore.yaml"`,
+ --ignore-paths "/to_ignore/**/*.yaml,ignore.yaml
+
+# Run recursively on all encountered Kustomizations
+flux build kustomization my-app --path ./path/to/local/manifests \
+ --recursive \
+ --local-sources GitRepository/flux-system/my-repo=./path/to/local/git"`,
  ValidArgsFunction: resourceNamesCompletionFunc(kustomizev1.GroupVersion.WithKind(kustomizev1.KustomizationKind)),
  RunE: buildKsCmdRun,
 }
@@ -64,6 +69,8 @@ type buildKsFlags struct {
  ignorePaths []string
  dryRun bool
  strictSubst bool
+ recursive bool
+ localSources map[string]string
 }
 
 var buildKsArgs buildKsFlags
@@ -75,6 +82,8 @@ func init() {
  buildKsCmd.Flags().BoolVar(&buildKsArgs.dryRun, "dry-run", false, "Dry run mode.")
  buildKsCmd.Flags().BoolVar(&buildKsArgs.strictSubst, "strict-substitute", false,
  "When enabled, the post build substitutions will fail if a var without a default value is declared in files but is missing from the input vars.")
+ buildKsCmd.Flags().BoolVarP(&buildKsArgs.recursive, "recursive", "r", false, "Recursively diff Kustomizations")
+ buildKsCmd.Flags().StringToStringVar(&buildKsArgs.localSources, "local-sources", nil, "Comma-separated list of repositories in format: Kind/namespace/name=path")
  buildCmd.AddCommand(buildKsCmd)
 }
 
@@ -111,6 +120,8 @@ func buildKsCmdRun(cmd *cobra.Command, args []string) (err error) {
  build.WithNamespace(*kubeconfigArgs.Namespace),
  build.WithIgnore(buildKsArgs.ignorePaths),
  build.WithStrictSubstitute(buildKsArgs.strictSubst),
+ build.WithRecursive(buildKsArgs.recursive),
+ build.WithLocalSources(buildKsArgs.localSources),
  )
  } else {
  builder, err = build.NewBuilder(name, buildKsArgs.path,
@@ -119,6 +130,8 @@ func buildKsCmdRun(cmd *cobra.Command, args []string) (err error) {
  build.WithKustomizationFile(buildKsArgs.kustomizationFile),
  build.WithIgnore(buildKsArgs.ignorePaths),
  build.WithStrictSubstitute(buildKsArgs.strictSubst),
+ build.WithRecursive(buildKsArgs.recursive),
+ build.WithLocalSources(buildKsArgs.localSources),
  )
  }
 

cmd/flux/build_kustomization_test.go

@@ -70,6 +70,12 @@ func TestBuildKustomization(t *testing.T) {
  resultFile: "./testdata/build-kustomization/podinfo-with-ignore-result.yaml",
  assertFunc: "assertGoldenTemplateFile",
  },
+ {
+ name: "build with recursive",
+ args: "build kustomization podinfo --path ./testdata/build-kustomization/podinfo-with-my-app --recursive --local-sources GitRepository/default/podinfo=./testdata/build-kustomization",
+ resultFile: "./testdata/build-kustomization/podinfo-with-my-app-result.yaml",
+ assertFunc: "assertGoldenTemplateFile",
+ },
  }
 
  tmpl := map[string]string{
@@ -157,6 +163,12 @@ spec:
  resultFile: "./testdata/build-kustomization/podinfo-with-var-substitution-result.yaml",
  assertFunc: "assertGoldenTemplateFile",
  },
+ {
+ name: "build with recursive",
+ args: "build kustomization podinfo --kustomization-file " + tmpFile + " --path ./testdata/build-kustomization/podinfo-with-my-app --recursive --local-sources GitRepository/default/podinfo=./testdata/build-kustomization",
+ resultFile: "./testdata/build-kustomization/podinfo-with-my-app-result.yaml",
+ assertFunc: "assertGoldenTemplateFile",
+ },
  }
 
  tmpl := map[string]string{

cmd/flux/diff_kustomization.go

@@ -44,7 +44,12 @@ flux diff kustomization my-app --path ./path/to/local/manifests \
 # Exclude files by providing a comma separated list of entries that follow the .gitignore pattern fromat.
 flux diff kustomization my-app --path ./path/to/local/manifests \
  --kustomization-file ./path/to/local/my-app.yaml \
- --ignore-paths "/to_ignore/**/*.yaml,ignore.yaml"`,
+ --ignore-paths "/to_ignore/**/*.yaml,ignore.yaml
+
+# Run recursively on all encountered Kustomizations
+flux diff kustomization my-app --path ./path/to/local/manifests \
+ --recursive \
+ --local-sources GitRepository/flux-system/my-repo=./path/to/local/git"`,
  ValidArgsFunction: resourceNamesCompletionFunc(kustomizev1.GroupVersion.WithKind(kustomizev1.KustomizationKind)),
  RunE: diffKsCmdRun,
 }
@@ -55,6 +60,8 @@ type diffKsFlags struct {
  ignorePaths []string
  progressBar bool
  strictSubst bool
+ recursive bool
+ localSources map[string]string
 }
 
 var diffKsArgs diffKsFlags
@@ -66,6 +73,8 @@ func init() {
  diffKsCmd.Flags().StringVar(&diffKsArgs.kustomizationFile, "kustomization-file", "", "Path to the Flux Kustomization YAML file.")
  diffKsCmd.Flags().BoolVar(&diffKsArgs.strictSubst, "strict-substitute", false,
  "When enabled, the post build substitutions will fail if a var without a default value is declared in files but is missing from the input vars.")
+ diffKsCmd.Flags().BoolVarP(&diffKsArgs.recursive, "recursive", "r", false, "Recursively diff Kustomizations")
+ diffKsCmd.Flags().StringToStringVar(&diffKsArgs.localSources, "local-sources", nil, "Comma-separated list of repositories in format: Kind/namespace/name=path")
  diffCmd.AddCommand(diffKsCmd)
 }
 
@@ -101,6 +110,9 @@ func diffKsCmdRun(cmd *cobra.Command, args []string) error {
  build.WithProgressBar(),
  build.WithIgnore(diffKsArgs.ignorePaths),
  build.WithStrictSubstitute(diffKsArgs.strictSubst),
+ build.WithRecursive(diffKsArgs.recursive),
+ build.WithLocalSources(diffKsArgs.localSources),
+ build.WithSingleKustomization(),
  )
  } else {
  builder, err = build.NewBuilder(name, diffKsArgs.path,
@@ -109,6 +121,9 @@ func diffKsCmdRun(cmd *cobra.Command, args []string) error {
  build.WithKustomizationFile(diffKsArgs.kustomizationFile),
  build.WithIgnore(diffKsArgs.ignorePaths),
  build.WithStrictSubstitute(diffKsArgs.strictSubst),
+ build.WithRecursive(diffKsArgs.recursive),
+ build.WithLocalSources(diffKsArgs.localSources),
+ build.WithSingleKustomization(),
  )
  }
 
@@ -138,6 +153,12 @@ func diffKsCmdRun(cmd *cobra.Command, args []string) error {
 
  select {
  case <-sigc:
+ if diffKsArgs.progressBar {
+ err := builder.StopSpinner()
+ if err != nil {
+ return err
+ }
+ }
  fmt.Println("Build cancelled... exiting.")
  return builder.Cancel()
  case err := <-errChan:

cmd/flux/diff_kustomization_test.go

@@ -97,6 +97,12 @@ func TestDiffKustomization(t *testing.T) {
  objectFile: "",
  assert: assertGoldenFile("./testdata/diff-kustomization/nothing-is-deployed.golden"),
  },
+ {
+ name: "diff with recursive",
+ args: "diff kustomization podinfo --path ./testdata/build-kustomization/podinfo-with-my-app --progress-bar=false --recursive --local-sources GitRepository/default/podinfo=./testdata/build-kustomization",
+ objectFile: "./testdata/diff-kustomization/my-app.yaml",
+ assert: assertGoldenFile("./testdata/diff-kustomization/diff-with-recursive.golden"),
+ },
  }
 
  tmpl := map[string]string{

cmd/flux/main_test.go

@@ -429,7 +429,9 @@ func resetCmdArgs() {
  tail: -1,
  fluxNamespace: rootArgs.defaults.Namespace,
  }
- buildKsArgs = buildKsFlags{}
+ buildKsArgs = buildKsFlags{
+ localSources: map[string]string{},
+ }
  checkArgs = checkFlags{}
  createArgs = createFlags{}
  deleteArgs = deleteFlags{}

cmd/flux/testdata/build-kustomization/my-app/configmap.yaml

@@ -0,0 +1,6 @@
+apiVersion: v1
+data:
+ var: test
+kind: ConfigMap
+metadata:
+ name: my-app

cmd/flux/testdata/build-kustomization/podinfo-with-my-app-result.yaml

@@ -0,0 +1,29 @@
+apiVersion: kustomize.toolkit.fluxcd.io/v1
+kind: Kustomization
+metadata:
+ labels:
+ kustomize.toolkit.fluxcd.io/name: podinfo
+ kustomize.toolkit.fluxcd.io/namespace: {{ .fluxns }}
+ name: my-app
+ namespace: default
+spec:
+ force: true
+ interval: 5m0s
+ path: ./my-app
+ prune: true
+ sourceRef:
+ kind: GitRepository
+ name: podinfo
+ targetNamespace: default
+---
+apiVersion: v1
+data:
+ var: test
+kind: ConfigMap
+metadata:
+ labels:
+ kustomize.toolkit.fluxcd.io/name: my-app
+ kustomize.toolkit.fluxcd.io/namespace: default
+ name: my-app
+ namespace: default
+---

cmd/flux/testdata/build-kustomization/podinfo-with-my-app/kustomization.yaml

@@ -0,0 +1,4 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+- ./my-app.yaml

cmd/flux/testdata/build-kustomization/podinfo-with-my-app/my-app.yaml

@@ -0,0 +1,14 @@
+---
+apiVersion: kustomize.toolkit.fluxcd.io/v1
+kind: Kustomization
+metadata:
+ name: my-app
+spec:
+ interval: 5m0s
+ path: ./my-app
+ force: true
+ prune: true
+ sourceRef:
+ kind: GitRepository
+ name: podinfo
+ targetNamespace: default

cmd/flux/testdata/diff-kustomization/diff-with-recursive.golden

@@ -0,0 +1,2 @@
+📁 Kustomization/default/my-app changed
+► ConfigMap/default/my-app created

cmd/flux/testdata/diff-kustomization/my-app.yaml

@@ -0,0 +1,18 @@
+---
+apiVersion: kustomize.toolkit.fluxcd.io/v1
+kind: Kustomization
+metadata:
+ labels:
+ kustomize.toolkit.fluxcd.io/name: podinfo
+ kustomize.toolkit.fluxcd.io/namespace: {{ .fluxns }}
+ name: my-app
+ namespace: default
+spec:
+ interval: 5m0s
+ path: ./my-app
+ force: true
+ prune: true
+ sourceRef:
+ kind: GitRepository
+ name: podinfo
+ targetNamespace: default