instrument coverage collection during e2e test; other minor tweaks

joelanford · joelanford · commit 29acbfff81a4 · 2023-04-11T17:20:37.000-04:00
Signed-off-by: Joe Lanford &lt;joe.lanford@gmail.com&gt;
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -34,4 +34,18 @@ jobs:
 
       - name: Run ${{matrix.test}} test
         run: |
-          task test:${{matrix.test}}
+          task test:${{matrix.test}}
+
+      - name: Convert coverage data to Codecov format
+        if: ${{matrix.test == 'unit' || matrix.test == 'e2e'}}
+        run: |
+          go tool covdata textfmt -i=coverage/${{matrix.test}} -o=coverage/${{matrix.test}}.out
+
+      - name: Upload coverage data to Codecov
+        if: ${{matrix.test == 'unit' || matrix.test == 'e2e'}}
+        uses: codecov/codecov-action@v3
+        with:
+          file: coverage/${{matrix.test}}.out
+          flags: ${{matrix.test}}
+          fail_ci_if_error: true
+
diff --git a/.gitignore b/.gitignore
@@ -12,12 +12,12 @@ vendor
 *.test
 
 # Output of the go coverage tool, specifically when used with LiteIDE
-cover.out
+/coverage
 
 # Release output
 /dist/**
 /install.sh
-/operator-controller.yaml
+/operator-controller*.yaml
 
 # editor and IDE paraphernalia
 .idea
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -10,14 +10,22 @@ builds:
   - id: operator-controller
     main: ./
     binary: bin/manager
-    tags: upstream
+    tags:
+    - "{{ .Env.GO_BUILD_TAGS }}"
     goos:
     - linux
     goarch:
     - amd64
     - arm64
     - ppc64le
     - s390x
+    flags:
+    - -cover={{ .Env.GO_COVER }}
+    mod_timestamp: "{{ .CommitTimestamp }}"
+    asmflags:
+      - all=-trimpath={{ dir .Env.PWD }}
+    gcflags:
+      - all=-trimpath={{ dir .Env.PWD }}
     ldflags:
     - -X main.Version={{ .Version }}
 dockers:
diff --git a/.taskfile.build.yaml b/.taskfile.build.yaml
@@ -7,6 +7,7 @@ includes:
 
 vars:
   BIN: "{{.ROOT_DIR}}/bin"
+  KUSTOMIZE_DIR: "config/default"
   OPERATOR_CONTROLLER_MANIFEST: ./operator-controller.yaml
 
   OLMV0_VERSION: v0.24.0
@@ -36,9 +37,16 @@ tasks:
       By default, the binary is created at ./bin/manager.
       
       To generate the binary for a different OS, set the GOOS task variable accordingly.
+
+      The GO_COVER task variable instruments the operator with coverage enabled when set to "true"
+      or disabled when set to "false". The default is "false".
+    env:
+      GOOS: "{{.GOOS}}"
+      GO_COVER: '{{.GO_COVER | default "false" }}'
+      GO_BUILD_TAGS: "{{.GO_BUILD_TAGS}}"
     cmds:
       - mkdir -p {{.BIN}}
-      - GOOS={{.GOOS}} {{.TOOLSBIN}}/goreleaser build --single-target --snapshot --clean --output {{.BIN}}/manager
+      - "{{.TOOLSBIN}}/goreleaser build --debug --single-target --snapshot --clean --output {{.BIN}}/manager"
     deps: [tools:goreleaser, generate]
 
   docker:
@@ -60,6 +68,7 @@ tasks:
         vars:
           BIN: "{{.ROOT_DIR}}/bin/linux"
           GOOS: linux
+          GO_COVER: "{{.GO_COVER}}"
 
   manifest:
     desc: "Generate the operator manifest"
@@ -70,7 +79,7 @@ tasks:
       with the controller image set to the IMAGE_REPO and IMAGE_TAG environment variables.
     cmds:
       - cd config/manager && {{.TOOLSBIN}}/kustomize edit set image controller=$IMAGE_REPO:$IMAGE_TAG
-      - "{{.TOOLSBIN}}/kustomize build config/default > ./operator-controller.yaml"
+      - "{{.TOOLSBIN}}/kustomize build {{.KUSTOMIZE_DIR}} > {{.OPERATOR_CONTROLLER_MANIFEST}}"
     deps: [tools:kustomize, generate]
 
   install-script:
diff --git a/.taskfile.deploy.yaml b/.taskfile.deploy.yaml
@@ -18,9 +18,17 @@ tasks:
     - ./install.sh
     deps:
       - task: build:docker
+        vars:
+          GO_COVER: "{{.GO_COVER}}"
+          GO_BUILD_TAGS: "{{.GO_BUILD_TAGS}}"
       - task: build:manifest
+        vars:
+          KUSTOMIZE_DIR: "{{.KUSTOMIZE_DIR}}"
+          OPERATOR_CONTROLLER_MANIFEST: "{{.OPERATOR_CONTROLLER_MANIFEST}}"
       - task: build:install-script
+        vars:
+          OPERATOR_CONTROLLER_MANIFEST: "{{.OPERATOR_CONTROLLER_MANIFEST}}"
       - task: kind:create
         vars:
           KIND_CLUSTER_NAME: "{{.KIND_CLUSTER_NAME}}"
-    desc: "Run the operator in a fresh kind cluster"
+          KIND_EXTRA_FLAGS: "{{.KIND_EXTRA_FLAGS}}"
diff --git a/.taskfile.kind.yaml b/.taskfile.kind.yaml
@@ -12,7 +12,7 @@ tasks:
   create:
     desc: "Create a fresh kind cluster"
     cmds:
-      - "{{.TOOLSBIN}}/kind create cluster --name {{.KIND_CLUSTER_NAME}}"
+      - "{{.TOOLSBIN}}/kind create cluster --name {{.KIND_CLUSTER_NAME}} {{.KIND_EXTRA_FLAGS}}"
     deps:
       - tools:kind
       - task: delete
diff --git a/.taskfile.test.yaml b/.taskfile.test.yaml
@@ -44,8 +44,16 @@ tasks:
       
       The FOCUS variable can be used to filter tests by name.
       The PKGS variable can be used to filter tests by package.
+    vars:
+      GOCOVERDIR: "./coverage/unit"
     cmds:
-      - eval $({{.TOOLSBIN}}/setup-envtest use -p env {{.ENVTEST_VERSION}}) && {{.TOOLSBIN}}/ginkgo --tags {{.GO_BUILD_TAGS}} {{with .FOCUS}}-focus "{{.}}"{{end}} -coverprofile cover.out {{.PKGS}}
+      - rm -rf {{.GOCOVERDIR}} && mkdir -p {{.GOCOVERDIR}} && chmod 1777 {{.GOCOVERDIR}}
+      - defer:
+          task: rm-file
+          vars:
+            FILE: .ginkgo.coverprofile.out
+      - eval $({{.TOOLSBIN}}/setup-envtest use -p env {{.ENVTEST_VERSION}}) && {{.TOOLSBIN}}/ginkgo --coverprofile=.ginkgo.coverprofile.out --tags {{.GO_BUILD_TAGS}} --progress --trace {{with .FOCUS}}--focus "{{.}}"{{end}} {{.PKGS}} -- -test.gocoverdir="{{.ROOT_DIR}}/{{.GOCOVERDIR}}"
+      - go tool covdata percent -i={{.GOCOVERDIR}}
     deps: [tools:setup-envtest, tools:ginkgo]
 
   e2e:
@@ -54,17 +62,41 @@ tasks:
       Run e2e tests.
       
       The FOCUS variable can be used to filter tests by name.
+    vars:
+      GOCOVERDIR: "./coverage/e2e"
     cmds:
+      - rm -rf {{.GOCOVERDIR}} && mkdir -p {{.GOCOVERDIR}} && chmod 1777 {{.GOCOVERDIR}}
+      - |
+        cat << EOF > ./kind-e2e.yaml
+        kind: Cluster
+        apiVersion: kind.x-k8s.io/v1alpha4
+        nodes:
+          - role: control-plane
+            extraMounts:
+              - hostPath: {{.GOCOVERDIR}}
+                containerPath: /tmp/coverdata
+        EOF
       - defer:
-          task: kind:delete
+          task: rm-file
           vars:
-            KIND_CLUSTER_NAME: "{{.KIND_CLUSTER_NAME}}-e2e"
-      - "{{.TOOLSBIN}}/ginkgo --tags {{.GO_BUILD_TAGS}} -progress -trace {{with .FOCUS}}-focus '{{.}}'{{end}} ./test/e2e"
-    deps:
-      - tools:ginkgo
+            FILE: "./kind-e2e.yaml"
       - task: deploy:kind
         vars:
+          KUSTOMIZE_DIR: "config/e2e"
+          OPERATOR_CONTROLLER_MANIFEST: "operator-controller-e2e.yaml"
           KIND_CLUSTER_NAME: "{{.KIND_CLUSTER_NAME}}-e2e"
+          KIND_EXTRA_FLAGS: "--config ./kind-e2e.yaml"
+          GO_COVER: "true"
+      - defer:
+          task: kind:delete
+          vars:
+            KIND_CLUSTER_NAME: "{{.KIND_CLUSTER_NAME}}-e2e"
+      - "{{.TOOLSBIN}}/ginkgo --tags {{.GO_BUILD_TAGS}} --progress --trace {{with .FOCUS}}--focus '{{.}}'{{end}} ./test/e2e"
+
+      # Delete the operator controller manager pod to write the coverage data to disk.
+      - kubectl delete --wait pod -n operator-controller-system -l control-plane=controller-manager
+      - go tool covdata percent -i={{.GOCOVERDIR}}
+    deps: [tools:ginkgo]
 
   sanity:
     desc: "Run sanity checks"
@@ -78,3 +110,9 @@ tasks:
     cmds:
       - git diff --exit-code
     deps: [ style, build:generate ]
+
+  rm-file:
+    cmds:
+      - rm -f {{.FILE}}
+    silent: true
+    internal: true
diff --git a/.taskfile.tools.yaml b/.taskfile.tools.yaml
@@ -4,7 +4,7 @@ vars:
   CONTROLLER_GEN_VERSION: v0.11.3
   GINKGO_VERSION:
     sh: go list -m -f {{ "{{.Version}}" }} github.com/onsi/ginkgo/v2
-  GORELEASER_VERSION: main
+  GORELEASER_VERSION: v1.16.1
   KIND_VERSION: v0.17.0
   KUSTOMIZE_VERSION: v4.5.7
   SETUP_ENVTEST_VERSION: latest
diff --git a/Taskfile.dist.yaml b/Taskfile.dist.yaml
@@ -57,6 +57,9 @@ tasks:
         GitHub changelog and release pipeline steps. By default, this is set to false.
         This should only be set to true when running the release task for a tagged
         release.
+    env:
+      GO_COVER: false
+      GO_BUILD_TAGS: "{{.GO_BUILD_TAGS}}"
     cmds:
       - task: build:manifest
       - task: build:install-script
diff --git a/config/default/manager_auth_proxy_patch.yaml b/config/default/manager_auth_proxy_patch.yaml
@@ -8,22 +8,6 @@ metadata:
 spec:
   template:
     spec:
-      affinity:
-        nodeAffinity:
-          requiredDuringSchedulingIgnoredDuringExecution:
-            nodeSelectorTerms:
-              - matchExpressions:
-                - key: kubernetes.io/arch
-                  operator: In
-                  values:
-                    - amd64
-                    - arm64
-                    - ppc64le
-                    - s390x
-                - key: kubernetes.io/os
-                  operator: In
-                  values:
-                    - linux
       containers:
       - name: kube-rbac-proxy
         securityContext:
diff --git a/config/e2e/kustomization.yaml b/config/e2e/kustomization.yaml
@@ -0,0 +1,7 @@
+resources:
+- ../default
+
+patchesStrategicMerge:
+  # Tweak the operator manifest to use configure volume mount and environment
+  # variables to facilitate coverage collection.
+  - manager_e2e_patch.yaml
diff --git a/config/e2e/manager_e2e_patch.yaml b/config/e2e/manager_e2e_patch.yaml
@@ -0,0 +1,22 @@
+# This patch inject a sidecar container which is a HTTP proxy for the
+# controller manager, it performs RBAC authorization against the Kubernetes API using SubjectAccessReviews.
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: controller-manager
+  namespace: system
+spec:
+  template:
+    spec:
+      containers:
+      - name: manager
+        env:
+          - name: GOCOVERDIR
+            value: /tmp/coverdata
+        volumeMounts:
+        - mountPath: /tmp/coverdata
+          name: coverdata
+      volumes:
+        - name: coverdata
+          hostPath:
+            path: /tmp/coverdata
diff --git a/config/manager/manager.yaml b/config/manager/manager.yaml
@@ -36,35 +36,26 @@ spec:
       labels:
         control-plane: controller-manager
     spec:
-      # TODO(user): Uncomment the following code to configure the nodeAffinity expression
-      # according to the platforms which are supported by your solution.
-      # It is considered best practice to support multiple architectures. You can
-      # build your manager image using the makefile target docker-buildx.
-      # affinity:
-      #   nodeAffinity:
-      #     requiredDuringSchedulingIgnoredDuringExecution:
-      #       nodeSelectorTerms:
-      #         - matchExpressions:
-      #           - key: kubernetes.io/arch
-      #             operator: In
-      #             values:
-      #               - amd64
-      #               - arm64
-      #               - ppc64le
-      #               - s390x
-      #           - key: kubernetes.io/os
-      #             operator: In
-      #             values:
-      #               - linux
+      affinity:
+         nodeAffinity:
+           requiredDuringSchedulingIgnoredDuringExecution:
+             nodeSelectorTerms:
+               - matchExpressions:
+                 - key: kubernetes.io/arch
+                   operator: In
+                   values:
+                     - amd64
+                     - arm64
+                     - ppc64le
+                     - s390x
+                 - key: kubernetes.io/os
+                   operator: In
+                   values:
+                     - linux
       securityContext:
         runAsNonRoot: true
-        # TODO(user): For common cases that do not require escalating privileges
-        # it is recommended to ensure that all your Pods/Containers are restrictive.
-        # More info: https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted
-        # Please uncomment the following code if your project does NOT have to work on old Kubernetes
-        # versions < 1.19 or on vendors versions which do NOT support this field by default (i.e. Openshift < 4.11 ).
-        # seccompProfile:
-        #   type: RuntimeDefault
+        seccompProfile:
+          type: RuntimeDefault
       containers:
       - command:
         - /manager
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/operator-framework/operator-controller
 
-go 1.19
+go 1.20
 
 require (
 	github.com/blang/semver/v4 v4.0.0
diff --git a/test/e2e/e2e_suite_test.go b/test/e2e/e2e_suite_test.go
@@ -6,6 +6,7 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+	rukpakv1alpha1 "github.com/operator-framework/rukpak/api/v1alpha1"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/rest"
@@ -14,7 +15,6 @@ import (
 
 	catsrcapi "github.com/operator-framework/api/pkg/operators/v1alpha1"
 	operatorv1alpha1 "github.com/operator-framework/operator-controller/api/v1alpha1"
-	rukpakv1alpha1 "github.com/operator-framework/rukpak/api/v1alpha1"
 )
 
 var (
