feat(roboll#344): add inherits explicit selectors

Gopkg.toml

@@ -16,4 +16,8 @@
 
 [[constraint]]
   name = "github.com/tatsushid/go-prettytable"
-  branch= "master"
+  branch= "master"
+
+[[constraint]]
+  name = "gotest.tools"
+  version = "v2.3.0" 

README.md

@@ -332,7 +332,7 @@ The `selector` parameter can be specified multiple times. Each parameter is reso
 
 `--selector tier=frontend --selector tier=backend` will select all the charts
 
-In addition to user supplied labels the name, namespace, and chart are available to be used as selectors.  The chart will just be the chart name excluding the repository (Example `stable/filebeat` would be selected using `--selector chart=filebeat`).
+In addition to user supplied labels, the name, the namespace, and the chart are available to be used as selectors.  The chart will just be the chart name excluding the repository (Example `stable/filebeat` would be selected using `--selector chart=filebeat`).
 
 ## Templates
 
@@ -643,6 +643,27 @@ Just run `helmfile sync` inside `myteam/`, and you are done.
 
 All the files are sorted alphabetically per group = array item inside `helmfiles:`, so that you have granular control over ordering, too.
 
+#### selectors
+When composing helmfiles you can use selectors from the command line as well as explicit selectors inside the parent helmfile to filter the releases to be used.
+```yaml
+helmfiles:
+- apps/*/helmfile.yaml
+- apps/a-helmfile.yaml:
+    selectors:          # list of selectors
+    - name=prometheus      
+    - tier=frontend    
+- apps/b-helmfile.yaml: # no selector, so all releases are used
+    selectors: {}
+- apps/c-helmfile.yaml: # parent selector to be used or cli selector for the initial helmfile
+    selectors: inherits
+```
+* When a selector is specified, only this selector applies and the parents or CLI selectors are ignored.
+* When not selector is specified there are 2 modes for the selector inheritance because we would like to change the current inheritance behavior (see [issue #344](https://github.com/roboll/helmfile/issues/344)  ).
+  * Legacy mode, sub-helmfiles without selectors inherit selectors from their parent helmfile. The initial helmfiles inherit from the command line selectors. 
+  * explicit mode, sub-helmfile without selectors do not inherit from their parent or the CLI selector. If you want them to inherit from their parent selector then use `selectors: inherits`. To enable this explicit mode you need to set the following environment variable `EXPERIMENTAL=explicit-selector-inheritance`.
+* Using `selector: {}` will for all releases to be used regardless of the parent selector or cli for the initial helmfile
+* using `selector: inherits` make the sub-helmfile selects release with the parent selector or the cli for the initial helmfile
+
 ## Importing values from any source
 
 The `exec` template function that is available in `values.yaml.gotmpl` is useful for importing values from any source
@@ -805,6 +826,12 @@ Once you download all required charts into your machine, you can run `helmfile c
 It basically run only `helm upgrade --install` with your already-downloaded charts, hence no Internet connection is required.
 See #155 for more information on this topic.
 
+## Experimental features
+Some experimental features may be available for testing in perspective of being (or not) included in a future release.
+Those features are set using the environment variable `EXPERIMENTAL`. Here is the current experimental feature :
+* `explicit-selector-inheritance` : remove today implicit cli selectors inheritance for composed helmfiles, see [composition selector](#selectors)
+
+If you want to enable all experimental features set the env var to `EXPERIMENTAL=true`
 
 ## Examples
 

pkg/app/app.go

@@ -159,7 +159,7 @@ func (a *App) VisitDesiredStates(fileOrDir string, selector []string, converge f
 			noMatchInSubHelmfiles := true
 			for _, m := range st.Helmfiles {
 				//assign parent selector to sub helm selector in legacy mode or do not inherit in experimental mode
-				if m.Selectors == nil && os.Getenv(ExperimentalEnvVar) != "true" {
+				if (m.Selectors == nil && !isExplicitSelectorInheritanceEnabled()) || m.Inherits {
 					m.Selectors = selector
 				}
 				if err := a.VisitDesiredStates(m.Path, m.Selectors, converge); err != nil {

pkg/app/app_test.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"github.com/roboll/helmfile/helmexec"
 	"github.com/roboll/helmfile/state"
+	"gotest.tools/env"
 	"io/ioutil"
 	"os"
 	"path/filepath"
@@ -376,7 +377,7 @@ releases:
     whatever: yes
 `,
 	}
-
+	//Check with legacy behavior, that is when no explicit selector then sub-helmfiles inherits from command line selector
 	legacyTestcases := []struct {
 		label            string
 		expectedReleases []string
@@ -388,8 +389,9 @@ releases:
 		{label: "name=grafana", expectedReleases: []string{"zipkin", "prometheus", "grafana", "grafana", "postgresql"}, expectErr: false},
 		{label: "name=doesnotexists", expectedReleases: []string{"zipkin", "prometheus", "grafana", "postgresql"}, expectErr: false},
 	}
-	runFilterSubHelmFilesTests(legacyTestcases, files, t, "1st series")
+	runFilterSubHelmFilesTests(legacyTestcases, files, t, "1st EmbeddedSelectors")
 
+	//Check with experimental behavior, that is when no explicit selector then sub-helmfiles do no inherit from any selector
 	desiredTestcases := []struct {
 		label            string
 		expectedReleases []string
@@ -400,10 +402,119 @@ releases:
 		{label: "name=doesnotexists", expectedReleases: []string{"zipkin", "prometheus", "grafana", "bar", "bar", "grafana", "postgresql"}, expectErr: false},
 	}
 
-	os.Setenv(ExperimentalEnvVar, "true")
-	defer os.Unsetenv(ExperimentalEnvVar)
+	defer env.Patch(t, ExperimentalEnvVar, ExperimentalSelectorExplicit)()
+
+	runFilterSubHelmFilesTests(desiredTestcases, files, t, "2nd EmbeddedSelectors")
+
+}
+
+func TestVisitDesiredStatesWithReleasesFiltered_InheritedSelectors_3leveldeep(t *testing.T) {
+	files := map[string]string{
+		"/path/to/helmfile.yaml": `
+helmfiles:
+- helmfile.d/a*.yaml
+releases:
+- name: mongodb
+  chart: stable/mongodb
+`,
+		"/path/to/helmfile.d/a.yaml": `
+helmfiles:
+- b*.yaml
+releases:
+- name: zipkin
+  chart: stable/zipkin
+`,
+		"/path/to/helmfile.d/b.yaml": `
+releases:
+- name: grafana
+  chart: stable/grafana
+`,
+	}
+	//Check with legacy behavior, that is when no explicit selector then sub-helmfiles inherits from command line selector
+	legacyTestcases := []struct {
+		label            string
+		expectedReleases []string
+		expectErr        bool
+		errMsg           string
+	}{
+		{label: "name!=grafana", expectedReleases: []string{"zipkin", "mongodb"}, expectErr: false},
+	}
+	runFilterSubHelmFilesTests(legacyTestcases, files, t, "1st 3leveldeep")
+
+	//Check with experimental behavior, that is when no explicit selector then sub-helmfiles do no inherit from any selector
+	desiredTestcases := []struct {
+		label            string
+		expectedReleases []string
+		expectErr        bool
+		errMsg           string
+	}{
+		{label: "name!=grafana", expectedReleases: []string{"grafana", "zipkin", "mongodb"}, expectErr: false},
+	}
+
+	defer env.Patch(t, ExperimentalEnvVar, ExperimentalSelectorExplicit)()
+
+	runFilterSubHelmFilesTests(desiredTestcases, files, t, "2nd 3leveldeep")
+
+}
+
+func TestVisitDesiredStatesWithReleasesFiltered_InheritedSelectors_inherits(t *testing.T) {
+	files := map[string]string{
+		"/path/to/helmfile.yaml": `
+helmfiles:
+- helmfile.d/a*.yaml
+- helmfile.d/a*.yaml:
+    selectors:
+    - select=foo
+releases:
+- name: mongodb
+  chart: stable/mongodb
+`,
+		"/path/to/helmfile.d/a.yaml": `
+helmfiles:
+- b*.yaml:
+    selectors: inherits
+releases:
+- name: zipkin
+  chart: stable/zipkin
+  labels:
+    select: foo
+`,
+		"/path/to/helmfile.d/b.yaml": `
+releases:
+- name: grafana
+  chart: stable/grafana
+- name: prometheus
+  chart: stable/prometheus
+  labels:
+    select: foo
+`,
+	}
+	//Check with legacy behavior, that is when no explicit selector then sub-helmfiles inherits from command line selector
+	legacyTestcases := []struct {
+		label            string
+		expectedReleases []string
+		expectErr        bool
+		errMsg           string
+	}{
+		{label: "name=grafana", expectedReleases: []string{"grafana", "prometheus", "zipkin"}, expectErr: false},
+		{label: "select!=foo", expectedReleases: []string{"grafana", "prometheus", "zipkin", "mongodb"}, expectErr: false},
+	}
+	runFilterSubHelmFilesTests(legacyTestcases, files, t, "1st inherits")
+
+	//Check with experimental behavior, that is when no explicit selector then sub-helmfiles do no inherit from any selector
+	desiredTestcases := []struct {
+		label            string
+		expectedReleases []string
+		expectErr        bool
+		errMsg           string
+	}{
+		{label: "name=grafana", expectedReleases: []string{"grafana", "prometheus", "zipkin", "prometheus", "zipkin"}, expectErr: false},
+		{label: "select!=foo", expectedReleases: []string{"grafana", "prometheus", "zipkin", "prometheus", "zipkin", "mongodb"}, expectErr: false},
+	}
+
+	defer env.Patch(t, ExperimentalEnvVar, ExperimentalSelectorExplicit)()
 
-	runFilterSubHelmFilesTests(desiredTestcases, files, t, "2nd series")
+	runFilterSubHelmFilesTests(desiredTestcases, files, t, "2nd inherits")
 
 }
 

pkg/app/constants.go

@@ -1,8 +1,18 @@
 package app
 
+import (
+	"os"
+	"strings"
+)
+
 const (
-	DefaultHelmfile          = "helmfile.yaml"
-	DeprecatedHelmfile       = "charts.yaml"
-	DefaultHelmfileDirectory = "helmfile.d"
-	ExperimentalEnvVar       = "EXPERIMENTAL" // environment variable for experimental features, expecting "true" lower case
+	DefaultHelmfile              = "helmfile.yaml"
+	DeprecatedHelmfile           = "charts.yaml"
+	DefaultHelmfileDirectory     = "helmfile.d"
+	ExperimentalEnvVar           = "EXPERIMENTAL"                  // environment variable for experimental features, expecting "true" lower case
+	ExperimentalSelectorExplicit = "explicit-selector-inheritance" // value to remove default selector inheritance to sub-helmfiles and use the explicit one
 )
+
+func isExplicitSelectorInheritanceEnabled() bool {
+	return os.Getenv(ExperimentalEnvVar) == "true" || strings.Contains(os.Getenv(ExperimentalEnvVar), ExperimentalSelectorExplicit)
+}