Merge pull request #2423 from dgageot/helm-namespaces

Watch namespaces for each Helm release

Author: priyawadhwa

pkg/skaffold/kubernetes/context/context.go

@@ -24,6 +24,11 @@ import (
 	clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
 )
 
+// For testing
+var (
+	CurrentConfig = getCurrentConfig
+)
+
 var (
 	currentConfigOnce sync.Once
 	currentConfig     clientcmdapi.Config
@@ -35,7 +40,7 @@ func ResetCurrentConfig() {
 	currentConfigOnce = sync.Once{}
 }
 
-func CurrentConfig() (clientcmdapi.Config, error) {
+func getCurrentConfig() (clientcmdapi.Config, error) {
 	currentConfigOnce.Do(func() {
 		loadingRules := clientcmd.NewDefaultClientConfigLoadingRules()
 		kubeConfig := clientcmd.NewNonInteractiveDeferredLoadingClientConfig(loadingRules, &clientcmd.ConfigOverrides{})

pkg/skaffold/runner/context/context.go

@@ -53,7 +53,7 @@ func GetRunContext(opts *config.SkaffoldOptions, cfg *latest.Pipeline) (*RunCont
 		return nil, errors.Wrap(err, "finding current directory")
 	}
 
-	namespaces, err := runnerutil.GetAllPodNamespaces(opts.Namespace)
+	namespaces, err := runnerutil.GetAllPodNamespaces(opts.Namespace, cfg)
 	if err != nil {
 		return nil, errors.Wrap(err, "getting namespace list")
 	}

pkg/skaffold/runner/util/util.go

@@ -17,18 +17,27 @@ limitations under the License.
 package util
 
 import (
+	"sort"
+
 	kubectx "github.com/GoogleContainerTools/skaffold/pkg/skaffold/kubernetes/context"
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest"
 	"github.com/pkg/errors"
 )
 
-func GetAllPodNamespaces(configNamespace string) ([]string, error) {
-	// We also get the default namespace.
+// GetAllPodNamespaces lists the namespaces that should be watched.
+// + The namespace passed on the command line
+// + Current kube context's namespace
+// + Namespaces referenced in Helm releases
+func GetAllPodNamespaces(configNamespace string, cfg *latest.Pipeline) ([]string, error) {
 	nsMap := make(map[string]bool)
+
 	if configNamespace == "" {
+		// Get current kube context's namespace
 		config, err := kubectx.CurrentConfig()
 		if err != nil {
 			return nil, errors.Wrap(err, "getting k8s configuration")
 		}
+
 		context, ok := config.Contexts[config.CurrentContext]
 		if ok {
 			nsMap[context.Namespace] = true
@@ -39,12 +48,29 @@ func GetAllPodNamespaces(configNamespace string) ([]string, error) {
 		nsMap[configNamespace] = true
 	}
 
-	// FIXME: Set additional namespaces from the selected yamls.
+	// Set additional namespaces each helm release referenced
+	for _, namespace := range collectHelmReleasesNamespaces(cfg) {
+		nsMap[namespace] = true
+	}
 
 	// Collate the slice of namespaces.
 	namespaces := make([]string, 0, len(nsMap))
 	for ns := range nsMap {
 		namespaces = append(namespaces, ns)
 	}
+
+	sort.Strings(namespaces)
 	return namespaces, nil
 }
+
+func collectHelmReleasesNamespaces(cfg *latest.Pipeline) []string {
+	var namespaces []string
+
+	if cfg != nil && cfg.Deploy.HelmDeploy != nil {
+		for _, release := range cfg.Deploy.HelmDeploy.Releases {
+			namespaces = append(namespaces, release.Namespace)
+		}
+	}
+
+	return namespaces
+}

pkg/skaffold/runner/util/util_test.go

@@ -0,0 +1,89 @@
+/*
+Copyright 2019 The Skaffold Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package util
+
+import (
+	"testing"
+
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/kubernetes/context"
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest"
+	"github.com/GoogleContainerTools/skaffold/testutil"
+	"k8s.io/client-go/tools/clientcmd/api"
+	clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
+)
+
+func TestGetAllPodNamespaces(t *testing.T) {
+	var tests = []struct {
+		description    string
+		argNamespace   string
+		currentContext string
+		cfg            *latest.Pipeline
+		expected       []string
+	}{
+		{
+			description:  "namespace provided on the command line",
+			argNamespace: "ns",
+			expected:     []string{"ns"},
+		},
+		{
+			description:    "kube context's namespace",
+			currentContext: "prod-context",
+			expected:       []string{"prod"},
+		},
+		{
+			description:    "default namespace",
+			currentContext: "unknown context",
+			expected:       []string{""},
+		},
+		{
+			description:  "add namespaces for helm",
+			argNamespace: "ns",
+			cfg: &latest.Pipeline{
+				Deploy: latest.DeployConfig{
+					DeployType: latest.DeployType{
+						HelmDeploy: &latest.HelmDeploy{
+							Releases: []latest.HelmRelease{
+								{Namespace: "ns3"},
+								{Namespace: ""},
+								{Namespace: ""},
+								{Namespace: "ns2"},
+							},
+						},
+					},
+				},
+			},
+			expected: []string{"", "ns", "ns2", "ns3"},
+		},
+	}
+	for _, test := range tests {
+		testutil.Run(t, "", func(t *testutil.T) {
+			t.Override(&context.CurrentConfig, func() (clientcmdapi.Config, error) {
+				return api.Config{
+					CurrentContext: test.currentContext,
+					Contexts: map[string]*api.Context{
+						"prod-context": {Namespace: "prod"},
+					},
+				}, nil
+			})
+
+			namespaces, err := GetAllPodNamespaces(test.argNamespace, test.cfg)
+
+			t.CheckNoError(err)
+			t.CheckDeepEqual(test.expected, namespaces)
+		})
+	}
+}