write basic integration tests using a local kind cluster (#150)

gotwarlost · web-flow · commit e38447a839bb · 2020-08-29T17:52:09.000-07:00
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -27,17 +27,14 @@ jobs:
           echo "::add-path::$HOME/go/bin"
           make install-ci install
 
-      - name: Install package dependencies
-        run: make get
-
       - name: Build
         run: make build
 
       - name: Lint
         run: make lint
 
       - name: Test
-        run: make test
+        run: TEST_FLAGS="-tags integration" make test
 
       - name: Coverage Report
         run: make publish-coverage
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ helm.tar.gz
 linux-amd64/
 bin/
 .release-notes.md
+.tools/
diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,33 @@
+run:
+    timeout: 3m
+    tests: true
+
+linters-settings:
+    exhaustive:
+      default-signifies-exhaustive: false
+    golint:
+      min-confidence: 0
+          
+linters:
+    disable-all: true
+    enable:
+    - bodyclose
+    - deadcode
+    - depguard
+    - dogsled
+    - errcheck
+    - goconst
+    - gocyclo
+    - gofmt
+    - goimports
+    - golint
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - structcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unused
+    - varcheck
diff --git a/Makefile b/Makefile
@@ -1,3 +1,5 @@
+include Makefile.tools
+
 VERSION         := 0.12.1
 SHORT_COMMIT    := $(shell git rev-parse --short HEAD 2>/dev/null || echo dev)
 GO_VERSION      := $(shell go version | awk '{ print $$3}' | sed 's/^go//')
@@ -11,25 +13,24 @@ LD_FLAGS +=  -X "$(LD_FLAGS_PKG).commit=$(SHORT_COMMIT)"
 LD_FLAGS +=  -X "$(LD_FLAGS_PKG).goVersion=$(GO_VERSION)"
 
 LINT_FLAGS ?=
+TEST_FLAGS ?=
 
 export GO111MODULE=on
 GOOS ?= $(shell go env GOOS)
 GOARCH ?= $(shell go env GOARCH)
 
-.PHONY: all
-all: get build lint test
+.DEFAULT_GOAL := all
 
-.PHONY: get
-get:
-	go get ./...
+.PHONY: all
+all: build lint test
 
 .PHONY: build
 build:
 	go install -ldflags '$(LD_FLAGS)' ./...
 
 .PHONY: test
 test:
-	go test -coverprofile=coverage.txt -covermode=atomic -race ./...
+	go test $(TEST_FLAGS) -coverprofile=coverage.txt -covermode=atomic -race ./...
 
 .PHONY: publish-coverage
 publish-coverage:
@@ -52,11 +53,12 @@ check-format:
 		@echo All files are well formatted.\
 	)
 .PHONY: install-ci
-install-ci:
+install-ci: .tools/kind
 	curl -sSL -o helm.tar.gz https://storage.googleapis.com/kubernetes-helm/helm-v2.13.1-linux-amd64.tar.gz
 	tar -xvzf helm.tar.gz
 	mv linux-amd64/helm $(GOPATH)/bin/
 	curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(GOPATH)/bin v1.21.0
+	.tools/kind create cluster
 
 .PHONY: install
 install:
diff --git a/Makefile.tools b/Makefile.tools
@@ -0,0 +1,17 @@
+
+.tools/jb: JB_VERSION := v0.4.0
+.tools/jb: JB_PLATFORM := $(shell uname |  tr '[:upper:]' '[:lower:]')
+.tools/jb:
+	mkdir -p .tools
+	curl -sSL -o .tools/jb https://github.com/jsonnet-bundler/jsonnet-bundler/releases/download/$(JB_VERSION)/jb-$(JB_PLATFORM)-amd64
+	chmod +x .tools/jb
+
+.tools/kind: KIND_VERSION := 0.7.0
+.tools/kind: KIND_PLATFORM := $(shell uname)
+.tools/kind:
+	mkdir -p .tools
+	curl -o $@ -sSL https://kind.sigs.k8s.io/dl/v0.7.0/kind-$(KIND_PLATFORM)-amd64
+	chmod +x $@
+
+tools: .tools/jb .tools/kind
+
diff --git a/go.mod b/go.mod
@@ -38,6 +38,7 @@ require (
 	github.com/stretchr/testify v1.4.0
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c
+	k8s.io/api v0.0.0-20191016110246-af539daaa43a
 	k8s.io/apimachinery v0.0.0-20191004115701-31ade1b30762
 	k8s.io/client-go v0.0.0-20191016110837-54936ba21026
 	k8s.io/gengo v0.0.0-20200728071708-7794989d0000
diff --git a/internal/commands/integration_scaffold_test.go b/internal/commands/integration_scaffold_test.go
@@ -0,0 +1,79 @@
+// +build integration
+
+package commands
+
+import (
+	"fmt"
+	"os"
+	"sync"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	v1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	corev1 "k8s.io/client-go/kubernetes/typed/core/v1"
+	"k8s.io/client-go/rest"
+	"k8s.io/client-go/tools/clientcmd"
+)
+
+var (
+	once        sync.Once
+	contextName string
+	restConfig  *rest.Config
+	coreClient  *corev1.CoreV1Client
+)
+
+func initialize(t *testing.T) {
+	contextName = os.Getenv("QBEC_CONTEXT")
+	if contextName != "" {
+		contextName = "kind-kind"
+	}
+	c, err := clientcmd.NewNonInteractiveDeferredLoadingClientConfig(
+		clientcmd.NewDefaultClientConfigLoadingRules(),
+		&clientcmd.ConfigOverrides{CurrentContext: contextName},
+	).ClientConfig()
+	require.NoError(t, err)
+	restConfig = c
+	coreClient, err = corev1.NewForConfig(restConfig)
+	require.NoError(t, err)
+}
+
+type integrationScaffold struct {
+	baseScaffold
+	ns string
+}
+
+func newNamespace(t *testing.T) (name string, reset func()) {
+	once.Do(func() { initialize(t) })
+	ns, err := coreClient.Namespaces().Create(&v1.Namespace{
+		ObjectMeta: metav1.ObjectMeta{
+			GenerateName: "qbec-test-",
+		},
+		Spec: v1.NamespaceSpec{},
+	})
+	require.NoError(t, err)
+	return ns.GetName(), func() {
+		pp := metav1.DeletePropagationForeground
+		err := coreClient.Namespaces().Delete(ns.GetName(), &metav1.DeleteOptions{PropagationPolicy: &pp})
+		if err != nil {
+			fmt.Println("Error deleting namespace", ns.GetName(), err)
+		}
+	}
+}
+
+func newIntegrationScaffold(t *testing.T, ns string, dir string) *integrationScaffold {
+	once.Do(func() { initialize(t) })
+	b := newBaseScaffold(t, dir, nil)
+	return &integrationScaffold{
+		baseScaffold: b,
+		ns:           ns,
+	}
+}
+
+func (s *integrationScaffold) executeCommand(testArgs ...string) error {
+	args := append(testArgs,
+		"--force:k8s-context="+contextName,
+		"--force:k8s-namespace="+s.ns,
+	)
+	return s.baseScaffold.executeCommand(args...)
+}
diff --git a/internal/commands/integration_test.go b/internal/commands/integration_test.go
@@ -0,0 +1,101 @@
+// +build integration
+
+package commands
+
+import (
+	"regexp"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestIntegrationBasic(t *testing.T) {
+	dir := "testdata/projects/simple-service"
+	ns, reset := newNamespace(t)
+	defer reset()
+
+	t.Run("show", func(t *testing.T) {
+		s := newIntegrationScaffold(t, ns, dir)
+		defer s.reset()
+		err := s.executeCommand("show", "-O", "local")
+		require.NoError(t, err)
+		s.assertOutputLineMatch(regexp.MustCompile(`^simple-service\s+ConfigMap\s+nginx`))
+		s.assertOutputLineMatch(regexp.MustCompile(`^simple-service\s+Service\s+nginx`))
+		s.assertOutputLineMatch(regexp.MustCompile(`^simple-service\s+Deployment\s+nginx`))
+	})
+	t.Run("validate", func(t *testing.T) {
+		s := newIntegrationScaffold(t, ns, dir)
+		defer s.reset()
+		err := s.executeCommand("validate", "local")
+		require.NoError(t, err)
+		s.assertOutputLineMatch(regexp.MustCompile(`✔ configmaps nginx`))
+		s.assertOutputLineMatch(regexp.MustCompile(`✔ deployments nginx`))
+		s.assertOutputLineMatch(regexp.MustCompile(`✔ services nginx`))
+	})
+	allAddsDiffTest := func(t *testing.T) {
+		s := newIntegrationScaffold(t, ns, dir)
+		defer s.reset()
+		err := s.executeCommand("diff", "--error-exit=false", "local")
+		require.NoError(t, err)
+		stats := s.outputStats()
+		a := assert.New(t)
+		a.EqualValues(3, len(stats["additions"].([]interface{})))
+	}
+	t.Run("diff", allAddsDiffTest)
+	t.Run("apply dryrun", func(t *testing.T) {
+		s := newIntegrationScaffold(t, ns, dir)
+		defer s.reset()
+		err := s.executeCommand("apply", "-n", "local")
+		require.NoError(t, err)
+		stats := s.outputStats()
+		a := assert.New(t)
+		a.EqualValues(3, len(stats["created"].([]interface{})))
+	})
+	// ensure dryrun did not change state above
+	t.Run("diff1", allAddsDiffTest)
+	t.Run("apply", func(t *testing.T) {
+		s := newIntegrationScaffold(t, ns, dir)
+		defer s.reset()
+		err := s.executeCommand("apply", "local", "--wait")
+		require.NoError(t, err)
+		stats := s.outputStats()
+		a := assert.New(t)
+		a.EqualValues(3, len(stats["created"].([]interface{})))
+	})
+	t.Run("diff2", func(t *testing.T) {
+		s := newIntegrationScaffold(t, ns, dir)
+		defer s.reset()
+		err := s.executeCommand("diff", "--error-exit=false", "local")
+		require.NoError(t, err)
+		stats := s.outputStats()
+		a := assert.New(t)
+		a.EqualValues(3, stats["same"])
+	})
+
+	changeArgs := []string{"--vm:ext-code=replicas=2", "--vm:ext-str=cmContent=goodbye world"}
+	t.Run("diff3", func(t *testing.T) {
+		s := newIntegrationScaffold(t, ns, dir)
+		defer s.reset()
+		err := s.executeCommand(append(changeArgs, "diff", "--error-exit=false", "local")...)
+		require.NoError(t, err)
+		stats := s.outputStats()
+		a := assert.New(t)
+		a.EqualValues(1, stats["same"])
+		a.EqualValues(2, len(stats["changes"].([]interface{})))
+		s.assertOutputLineMatch(regexp.MustCompile(`-\s+replicas: 1$`))
+		s.assertOutputLineMatch(regexp.MustCompile(`\+\s+replicas: 2$`))
+		s.assertOutputLineMatch(regexp.MustCompile(`-\s+index.html: hello world$`))
+		s.assertOutputLineMatch(regexp.MustCompile(`\+\s+index.html: goodbye world$`))
+	})
+	t.Run("apply2", func(t *testing.T) {
+		s := newIntegrationScaffold(t, ns, dir)
+		defer s.reset()
+		err := s.executeCommand(append(changeArgs, "apply", "local", "--wait")...)
+		require.NoError(t, err)
+		stats := s.outputStats()
+		a := assert.New(t)
+		a.EqualValues(1, stats["same"])
+		a.EqualValues(2, len(stats["updated"].([]interface{})))
+	})
+}
diff --git a/internal/commands/testdata/projects/simple-service/components/simple-service/index.yaml b/internal/commands/testdata/projects/simple-service/components/simple-service/index.yaml
@@ -0,0 +1,56 @@
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: nginx
+data:
+  'index.html': 'Hello world'
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  labels:
+    app: nginx
+  name: nginx
+spec:
+  progressDeadlineSeconds: 600
+  replicas: 1
+  revisionHistoryLimit: 10
+  selector:
+    matchLabels:
+      app: nginx
+  strategy:
+    rollingUpdate:
+      maxSurge: 25%
+      maxUnavailable: 25%
+    type: RollingUpdate
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+        - image: nginx
+          imagePullPolicy: Always
+          name: nginx
+          volumeMounts:
+            - mountPath: /usr/share/nginx/html
+              name: content
+      volumes:
+      - configMap:
+          name: nginx
+        name: content
+---
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    app: nginx
+  name: nginx
+spec:
+  ports:
+    - name: http
+      port: 80
+      protocol: TCP
+  selector:
+    app: nginx
diff --git a/internal/commands/testdata/projects/simple-service/pp.libsonnet b/internal/commands/testdata/projects/simple-service/pp.libsonnet
@@ -0,0 +1,11 @@
+function(object) (
+  // please don't do things like this for real. This is just to make my testing easy :)
+  local replicas = std.extVar('replicas');
+  local cmContent = std.extVar('cmContent');
+  if object.kind == 'Deployment' then
+    object { spec+: { replicas: replicas } }
+  else if object.kind == 'ConfigMap' then
+    object { data+: { 'index.html': cmContent } }
+  else
+    object
+)
diff --git a/internal/commands/testdata/projects/simple-service/qbec.yaml b/internal/commands/testdata/projects/simple-service/qbec.yaml
diff --git a/internal/commands/utils_test.go b/internal/commands/utils_test.go
