Merge pull request #108 from shanduur/make-test

Added make targets to run E2E tests on ephemeral clusters

Author: k8s-ci-robot

Makefile

@@ -41,6 +41,11 @@ CONTROLLER_TAG ?= cosi-controller:latest
 ## Image tag for sidecar image build
 SIDECAR_TAG ?= cosi-provisioner-sidecar:latest
 
+## Location to install dependencies to
+TOOLBIN ?= $(CURDIR)/.cache/tools
+$(TOOLBIN):
+	mkdir -p $(TOOLBIN)
+
 ##@ Development
 
 .PHONY: all .gen
@@ -66,16 +71,15 @@ vet: vet.client vet.controller vet.sidecar ## Vet code
 test: .test.proto test.client test.controller test.sidecar ## Run tests including unit tests
 
 .PHONY: test-e2e
-test-e2e: # Run e2e tests
-	@echo "unimplemented placeholder"
+test-e2e: chainsaw # Run e2e tests against the K8s cluster specified in ~/.kube/config. It requires both controller and driver deployed. If you need to create a cluster beforehand, consider using 'cluster' and 'deploy' targets.
+	$(CHAINSAW) test --values ./test/e2e/values.yaml
 
 .PHONY: lint
 lint: golangci-lint.client golangci-lint.controller golangci-lint.sidecar ## Run all linters (suggest `make -k`)
 
 .PHONY: lint-fix
 lint-fix: golangci-lint-fix.client golangci-lint-fix.controller golangci-lint-fix.sidecar ## Run all linters and perform fixes where possible (suggest `make -k`)
 
-
 ##@ Build
 
 .PHONY: build
@@ -96,39 +100,9 @@ clean:
 ## Clean build environment and cached tools
 clobber:
 	$(MAKE) -C proto clobber
+	rm -rf $(TOOLBIN)
 	rm -rf $(CURDIR)/.cache
 
-##
-## === TOOLS === #
-
-GOLANGCI_LINT_VERSION ?= v1.61.0
-
-TOOLBIN ?= $(CURDIR)/.cache/tools
-$(TOOLBIN):
-	mkdir -p $(TOOLBIN)
-
-GOLANGCI_LINT ?= $(TOOLBIN)/golangci-lint
-# .PHONY: golangci-lint
-# golangci-lint: $(GOLANGCI_LINT)
-$(GOLANGCI_LINT): $(TOOLBIN)
-	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
-
-# go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
-# $1 - target path with name of binary
-# $2 - package url which can be installed
-# $3 - specific version of package
-define go-install-tool
-@[ -f "$(1)-$(3)" ] || { \
-set -e; \
-package=$(2)@$(3) ;\
-echo "Downloading $${package}" ;\
-rm -f $(1) || true ;\
-GOBIN=$(TOOLBIN) go install $${package} ;\
-mv $(1) $(1)-$(3) ;\
-} ;\
-ln -sf $(1)-$(3) $(1)
-endef
-
 ##
 ## === INTERMEDIATES === #
 
@@ -160,3 +134,79 @@ golangci-lint-fix.%: $(GOLANGCI_LINT)
 
 .PHONY: FORCE # use this to force phony behavior for targets with pattern rules
 FORCE:
+
+##@ Deployment
+
+.PHONY: cluster
+cluster: kind ctlptl ## Create Kind cluster and local registry
+	$(CTLPTL) apply -f ctlptl.yaml
+
+.PHONY: cluster-reset
+cluster-reset: kind ctlptl ## Delete Kind cluster
+	$(CTLPTL) delete -f ctlptl.yaml
+
+.PHONY: deploy
+deploy: kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config. The 'generate' and 'codegen' targets should be run manually, and are expected to be run at least once before the 'deploy' target, as those are not cached.
+	$(KUSTOMIZE) build . | $(KUBECTL) apply -f -
+
+.PHONY: undeploy
+undeploy: kustomize ## Undeploy controller from the K8s cluster specified in ~/.kube/config.
+	$(KUSTOMIZE) build . | $(KUBECTL) delete --ignore-not-found=true -f -
+
+##@ Tools
+
+## Tool Binaries
+CHAINSAW ?= $(TOOLBIN)/chainsaw
+CTLPTL ?= $(TOOLBIN)/ctlptl
+GOLANGCI_LINT ?= $(LOCALBIN)/golangci-lint
+KIND ?= $(TOOLBIN)/kind
+KUBECTL ?= kubectl ## Special case, we do not manage it via tools.go
+KUSTOMIZE ?= $(TOOLBIN)/kustomize
+
+## Tool Versions
+CHAINSAW_VERSION ?= $(shell grep 'github.com/kyverno/chainsaw ' ./hack/tools/go.mod | cut -d ' ' -f 2)
+CTLPTL_VERSION ?= $(shell grep 'github.com/tilt-dev/ctlptl ' ./hack/tools/go.mod | cut -d ' ' -f 2)
+GOLANGCI_LINT_VERSION ?= $(shell grep 'github.com/golangci/golangci-lint ' ./hack/tools/go.mod | cut -d ' ' -f 2)
+KIND_VERSION ?= $(shell grep 'sigs.k8s.io/kind ' ./hack/tools/go.mod | cut -d ' ' -f 2)
+KUSTOMIZE_VERSION ?= $(shell grep 'sigs.k8s.io/kustomize/kustomize/v5 ' ./hack/tools/go.mod | cut -d ' ' -f 2)
+
+.PHONY: chainsaw
+chainsaw: $(CHAINSAW)$(CHAINSAW_VERSION) ## Download chainsaw locally if necessary.
+$(CHAINSAW)$(CHAINSAW_VERSION): $(TOOLBIN)
+	$(call go-install-tool,$(CHAINSAW),github.com/kyverno/chainsaw,$(CHAINSAW_VERSION))
+
+.PHONY: ctlptl
+ctlptl: $(CTLPTL)$(CTLPTL_VERSION) ## Download ctlptl locally if necessary.
+$(CTLPTL)$(CTLPTL_VERSION): $(TOOLBIN)
+	$(call go-install-tool,$(CTLPTL),github.com/tilt-dev/ctlptl/cmd/ctlptl,$(CTLPTL_VERSION))
+
+.PHONY: golangci-lint
+golangci-lint: $(GOLANGCI_LINT)$(GOLANGCI_LINT_VERSION) ## Download golangci-lint locally if necessary.
+$(GOLANGCI_LINT)$(GOLANGCI_LINT_VERSION): $(LOCALBIN)
+	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
+
+.PHONY: kind
+kind: $(KIND)$(KIND_VERSION) ## Download kind locally if necessary.
+$(KIND)$(KIND_VERSION): $(TOOLBIN)
+	$(call go-install-tool,$(KIND),sigs.k8s.io/kind,$(KIND_VERSION))
+
+.PHONY: kustomize
+kustomize: $(KUSTOMIZE)$(KUSTOMIZE_VERSION) ## Download kustomize locally if necessary.
+$(KUSTOMIZE)$(KUSTOMIZE_VERSION): $(TOOLBIN)
+	$(call go-install-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v5,$(KUSTOMIZE_VERSION))
+
+# go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
+# $1 - target path with name of binary
+# $2 - package url which can be installed
+# $3 - specific version of package
+define go-install-tool
+@[ -f "$(1)-$(3)" ] || { \
+set -e; \
+package=$(2)@$(3) ;\
+echo "Downloading $${package}" ;\
+rm -f $(1) || true ;\
+GOBIN=$(TOOLBIN) go install $${package} ;\
+mv $(1) $(1)-$(3) ;\
+} ;\
+ln -sf $(1)-$(3) $(1)
+endef

controller/kustomization.yaml

@@ -1,6 +1,8 @@
 ---
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
+namespace: container-object-storage-system
+namePrefix: container-object-storage-
 
 labels:
   - includeTemplates: true
@@ -11,6 +13,7 @@ labels:
       app.kubernetes.io/managed-by: kustomize
 
 resources:
-- resources/sa.yaml
-- resources/rbac.yaml
-- resources/deployment.yaml
+  - resources/deployment.yaml
+  - resources/namespace.yaml
+  - resources/rbac.yaml
+  - resources/sa.yaml

controller/resources/deployment.yaml

@@ -2,7 +2,7 @@
 kind: Deployment
 apiVersion: apps/v1
 metadata:
-  name: objectstorage-controller
+  name: controller
   labels:
     app: container-object-storage-interface-controller
 spec:
@@ -19,7 +19,7 @@ spec:
       labels:
         app: container-object-storage-interface-controller
     spec:
-      serviceAccountName: objectstorage-controller-sa
+      serviceAccountName: controller-sa
       containers:
         - name: objectstorage-controller
           image: gcr.io/k8s-staging-sig-storage/objectstorage-controller:v20221027-v0.1.1-8-g300019f

controller/resources/namespace.yaml

@@ -0,0 +1,5 @@
+---
+kind: Namespace
+apiVersion: v1
+metadata:
+  name: system

controller/resources/rbac.yaml

@@ -2,7 +2,7 @@
 kind: ClusterRole
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
-  name: objectstorage-controller-role
+  name: controller-role
   namespace: default
 rules:
   - apiGroups: ["objectstorage.k8s.io"]
@@ -24,7 +24,7 @@ rules:
 kind: ClusterRoleBinding
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
-  name: objectstorage-controller
+  name: controller
   namespace: default
   labels:
     app.kubernetes.io/part-of: container-object-storage-interface
@@ -33,17 +33,17 @@ metadata:
     app.kubernetes.io/name: container-object-storage-interface-controller
 subjects:
   - kind: ServiceAccount
-    name: objectstorage-controller-sa
+    name: controller-sa
     namespace: default
 roleRef:
   kind: ClusterRole
-  name: objectstorage-controller-role
+  name: controller-role
   apiGroup: rbac.authorization.k8s.io
 ---
 kind: Role
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
-  name: objectstorage-controller
+  name: controller
   namespace: default
   labels:
     app.kubernetes.io/part-of: container-object-storage-interface
@@ -58,7 +58,7 @@ rules:
 kind: RoleBinding
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
-  name: objectstorage-controller
+  name: controller
   namespace: default
   labels:
     app.kubernetes.io/part-of: container-object-storage-interface
@@ -67,9 +67,9 @@ metadata:
     app.kubernetes.io/name: container-object-storage-interface-controller
 subjects:
   - kind: ServiceAccount
-    name: objectstorage-controller-sa
+    name: controller-sa
     namespace: default
 roleRef:
   kind: Role
-  name: objectstorage-controller
+  name: controller
   apiGroup: rbac.authorization.k8s.io

controller/resources/sa.yaml

@@ -2,4 +2,4 @@
 apiVersion: v1
 kind: ServiceAccount
 metadata:
-  name: objectstorage-controller-sa
+  name: controller-sa

ctlptl.yaml

@@ -8,3 +8,7 @@ apiVersion: ctlptl.dev/v1alpha1
 kind: Cluster
 product: kind
 registry: ctlptl-registry
+kindV1Alpha4Cluster:
+  nodes:
+  - role: control-plane
+    image: kindest/node:v1.31.1