Skip to content

Support setting namespace for every deployer #852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 7, 2018
Merged

Support setting namespace for every deployer #852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
18a6763
Support setting namespace for every deployer.
dgageot Jul 24, 2018
d839679
Generate random name for k8s namespace
dgageot Jul 24, 2018
aaf518a
Improve integrations tests.
dgageot Jul 24, 2018
bf6ce07
Extract kubectl CLI
dgageot Aug 4, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions cmd/skaffold/app/cmd/cmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ import (
"context"
"fmt"
"io"
"os"
"strings"

cmdutil "github.com/GoogleContainerTools/skaffold/cmd/skaffold/app/cmd/util"
"github.com/GoogleContainerTools/skaffold/pkg/skaffold/config"
Expand All @@ -29,6 +31,7 @@ import (
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
)

var (
Expand Down Expand Up @@ -78,6 +81,9 @@ func NewSkaffoldCommand(out, err io.Writer) *cobra.Command {
rootCmd.AddCommand(NewCmdFix(out))

rootCmd.PersistentFlags().StringVarP(&v, "verbosity", "v", constants.DefaultLogLevel.String(), "Log level (debug, info, warn, error, fatal, panic")

setFlagsFromEnvVariables(rootCmd.Commands())

return rootCmd
}

Expand All @@ -100,6 +106,26 @@ func updateCheck(ch chan string) error {
return nil
}

// Each flag can also be set with an env variable whose name starts with `SKAFFOLD_`.
func setFlagsFromEnvVariables(commands []*cobra.Command) {
for _, cmd := range commands {
cmd.Flags().VisitAll(func(f *pflag.Flag) {
// special case for backward compatibility.
if f.Name == "namespace" {
if val, present := os.LookupEnv("SKAFFOLD_DEPLOY_NAMESPACE"); present {
logrus.Warnln("Using SKAFFOLD_DEPLOY_NAMESPACE env variable is deprecated. Please use SKAFFOLD_NAMESPACE instead.")
cmd.Flags().Set(f.Name, val)
}
}

envVar := fmt.Sprintf("SKAFFOLD_%s", strings.Replace(strings.ToUpper(f.Name), "-", "_", -1))
if val, present := os.LookupEnv(envVar); present {
cmd.Flags().Set(f.Name, val)
}
})
}
}

func AddDevFlags(cmd *cobra.Command) {
cmd.Flags().BoolVar(&opts.Cleanup, "cleanup", true, "Delete deployments after dev mode is interrupted")
}
Expand Down
167 changes: 55 additions & 112 deletions integration/run_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ package integration
import (
"bytes"
"flag"
"fmt"
"os"
"os/exec"
"testing"
Expand All @@ -34,18 +33,16 @@ import (
"k8s.io/api/core/v1"
meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/tools/clientcmd"
"k8s.io/client-go/tools/clientcmd/api"
)

var gkeZone = flag.String("gke-zone", "us-central1-a", "gke zone")
var gkeClusterName = flag.String("gke-cluster-name", "integration-tests", "name of the integration test cluster")
var gcpProject = flag.String("gcp-project", "k8s-skaffold", "the gcp project where the integration test cluster lives")
var remote = flag.Bool("remote", false, "if true, run tests on a remote GKE cluster")
var (
gkeZone = flag.String("gke-zone", "us-central1-a", "gke zone")
gkeClusterName = flag.String("gke-cluster-name", "integration-tests", "name of the integration test cluster")
gcpProject = flag.String("gcp-project", "k8s-skaffold", "the gcp project where the integration test cluster lives")
remote = flag.Bool("remote", false, "if true, run tests on a remote GKE cluster")

var client kubernetes.Interface

var context *api.Context
client kubernetes.Interface
)

func TestMain(m *testing.M) {
flag.Parse()
Expand All @@ -62,95 +59,57 @@ func TestMain(m *testing.M) {
logrus.Fatalf("Test setup error: getting kubernetes client: %s", err)
}

loadingRules := clientcmd.NewDefaultClientConfigLoadingRules()
kubeConfig := clientcmd.NewNonInteractiveDeferredLoadingClientConfig(loadingRules, &clientcmd.ConfigOverrides{})

cfg, err := kubeConfig.RawConfig()
if err != nil {
logrus.Fatalf("loading kubeconfig: %s", err)
}

context = cfg.Contexts[cfg.CurrentContext]

exitCode := m.Run()

// Reset default context and namespace
if err := exec.Command("kubectl", "config", "set-context", context.Cluster, "--namespace", context.Namespace).Run(); err != nil {
logrus.Warn(err)
}

os.Exit(exitCode)
}

func TestRun(t *testing.T) {
type testObject struct {
name string
}

type testRunCase struct {
description string
dir string
filename string
args []string
deployments []testObject
pods []testObject
deployments []string
pods []string
deploymentValidation func(t *testing.T, d *appsv1.Deployment)
env map[string]string
env []string

remoteOnly bool
cleanup func(t *testing.T)
}

var testCases = []testRunCase{
{
description: "getting-started example",
args: []string{"run"},
pods: []testObject{
{
name: "getting-started",
},
},
dir: "../examples/getting-started",
pods: []string{"getting-started"},
dir: "../examples/getting-started",
},
{
description: "annotated getting-started example",
args: []string{"run", "-f", "annotated-skaffold.yaml"},
pods: []testObject{
{
name: "getting-started",
},
},
dir: "../examples",
args: []string{"run"},
filename: "annotated-skaffold.yaml",
pods: []string{"getting-started"},
dir: "../examples",
},
{
description: "getting-started envTagger",
args: []string{"run"},
pods: []testObject{
{
name: "getting-started",
},
},
dir: "../examples/tagging-with-environment-variables",
env: map[string]string{"FOO": "foo"},
pods: []string{"getting-started"},
dir: "../examples/tagging-with-environment-variables",
env: []string{"FOO=foo"},
},
{
description: "gcb builder example",
args: []string{"run", "-p", "gcb"},
pods: []testObject{
{
name: "getting-started",
},
},
dir: "../examples/getting-started",
remoteOnly: true,
pods: []string{"getting-started"},
dir: "../examples/getting-started",
remoteOnly: true,
},
{
description: "deploy kustomize",
args: []string{"deploy", "--images", "index.docker.io/library/busybox:1"},
deployments: []testObject{
{
name: "kustomize-test",
},
},
deployments: []string{"kustomize-test"},
deploymentValidation: func(t *testing.T, d *appsv1.Deployment) {
if d == nil {
t.Fatalf("Could not find deployment")
Expand All @@ -164,31 +123,16 @@ func TestRun(t *testing.T) {
{
description: "kaniko example",
args: []string{"run"},
pods: []testObject{
{
name: "getting-started-kaniko",
},
},
dir: "../examples/kaniko",
remoteOnly: true,
pods: []string{"getting-started-kaniko"},
dir: "../examples/kaniko",
remoteOnly: true,
},
{
description: "helm example",
args: []string{"run"},
deployments: []testObject{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 for the yagni cleanup.

{
name: "skaffold-helm",
},
},
dir: "../examples/helm-deployment",
remoteOnly: true,
cleanup: func(t *testing.T) {
cmd := exec.Command("helm", "delete", "--purge", "skaffold-helm")
output, err := util.RunCmdOut(cmd)
if err != nil {
t.Fatalf("skaffold: %s %v", output, err)
}
},
deployments: []string{"skaffold-helm"},
dir: "../examples/helm-deployment",
remoteOnly: true,
},
}

Expand All @@ -201,70 +145,69 @@ func TestRun(t *testing.T) {
ns, deleteNs := setupNamespace(t)
defer deleteNs()

cmd := exec.Command("skaffold", testCase.args...)
env := os.Environ()
for k, v := range testCase.env {
env = append(env, fmt.Sprintf("%s=%s", k, v))
args := []string{}
args = append(args, testCase.args...)
args = append(args, "--namespace", ns.Name)
if testCase.filename != "" {
args = append(args, "-f", testCase.filename)
}
cmd.Env = env

cmd := exec.Command("skaffold", args...)
cmd.Env = append(os.Environ(), testCase.env...)
cmd.Dir = testCase.dir
output, err := util.RunCmdOut(cmd)
if err != nil {
if output, err := util.RunCmdOut(cmd); err != nil {
t.Fatalf("skaffold: %s %v", output, err)
}

for _, p := range testCase.pods {
if err := kubernetesutil.WaitForPodReady(client.CoreV1().Pods(ns.Name), p.name); err != nil {
if err := kubernetesutil.WaitForPodReady(client.CoreV1().Pods(ns.Name), p); err != nil {
t.Fatalf("Timed out waiting for pod ready")
}
}

for _, d := range testCase.deployments {
if err := kubernetesutil.WaitForDeploymentToStabilize(client, ns.Name, d.name, 10*time.Minute); err != nil {
if err := kubernetesutil.WaitForDeploymentToStabilize(client, ns.Name, d, 10*time.Minute); err != nil {
t.Fatalf("Timed out waiting for deployment to stabilize")
}
if testCase.deploymentValidation != nil {
deployment, err := client.AppsV1().Deployments(ns.Name).Get(d.name, meta_v1.GetOptions{})
deployment, err := client.AppsV1().Deployments(ns.Name).Get(d, meta_v1.GetOptions{})
if err != nil {
t.Fatalf("Could not find deployment: %s %s", ns.Name, d)
}
testCase.deploymentValidation(t, deployment)
}
}

if testCase.cleanup != nil {
testCase.cleanup(t)
}
// Cleanup
args = []string{"delete", "--namespace", ns.Name}
if testCase.filename != "" {
args = append(args, "-f", testCase.filename)
}
cmd = exec.Command("skaffold", args...)
cmd.Dir = testCase.dir
if output, err := util.RunCmdOut(cmd); err != nil {
t.Fatalf("skaffold delete: %s %v", output, err)
}
})
}
}

func setupNamespace(t *testing.T) (*v1.Namespace, func()) {
namespaceName := util.RandomID()
ns, err := client.CoreV1().Namespaces().Create(&v1.Namespace{
ObjectMeta: meta_v1.ObjectMeta{
Name: namespaceName,
Namespace: namespaceName,
GenerateName: "skaffold",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

},
})
if err != nil {
t.Fatalf("creating namespace: %s", err)
}

kubectlCmd := exec.Command("kubectl", "config", "set-context", context.Cluster, "--namespace", ns.Name)
if err := util.RunCmd(kubectlCmd); err != nil {
t.Fatalf("kubectl config set-context --namespace: %v", err)
}

os.Setenv("SKAFFOLD_DEPLOY_NAMESPACE", namespaceName)

return ns, func() {
client.CoreV1().Namespaces().Delete(ns.Name, &meta_v1.DeleteOptions{})
os.Setenv("SKAFFOLD_DEPLOY_NAMESPACE", "")
}
}
func TestFix(t *testing.T) {
_, deleteNs := setupNamespace(t)
ns, deleteNs := setupNamespace(t)
defer deleteNs()

fixCmd := exec.Command("skaffold", "fix", "-f", "skaffold.yaml")
Expand All @@ -274,7 +217,7 @@ func TestFix(t *testing.T) {
t.Fatalf("testing error: %v", err)
}

runCmd := exec.Command("skaffold", "run", "-f", "-")
runCmd := exec.Command("skaffold", "run", "--namespace", ns.Name, "-f", "-")
runCmd.Dir = "testdata/old-config"
runCmd.Stdin = bytes.NewReader(out)
err = util.RunCmd(runCmd)
Expand Down
2 changes: 0 additions & 2 deletions pkg/skaffold/deploy/helm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,6 @@ func (h *HelmDeployer) deployRelease(out io.Writer, r v1alpha2.HelmRelease, buil
ns = h.namespace
} else if r.Namespace != "" {
ns = r.Namespace
} else {
ns = os.Getenv("SKAFFOLD_DEPLOY_NAMESPACE")
}
if ns != "" {
args = append(args, "--namespace", ns)
Expand Down
Loading