WIP: KUTTL coverage

Author: cbandy

.github/workflows/test.yaml

@@ -40,7 +40,7 @@ jobs:
       - run: gzip envtest.coverage
       - uses: actions/upload-artifact@v3
         with:
-          name: "kubernetes-api=${{ matrix.kubernetes }}"
+          name: "~coverage~kubernetes-api=${{ matrix.kubernetes }}"
           path: envtest.coverage.gz
           retention-days: 1
 
@@ -74,7 +74,7 @@ jobs:
       - run: gzip envtest-existing.coverage
       - uses: actions/upload-artifact@v3
         with:
-          name: "kubernetes-k3d=${{ matrix.kubernetes }}"
+          name: "~coverage~kubernetes-k3d=${{ matrix.kubernetes }}"
           path: envtest-existing.coverage.gz
           retention-days: 1
 
@@ -102,9 +102,11 @@ jobs:
             registry.developers.crunchydata.com/crunchydata/crunchy-postgres-gis:ubi8-14.4-3.1-0
 
       - run: go mod download
-      - name: Build PGO
+      - name: Build coverage executable
         run: |
-          make build-postgres-operator PGO_VERSION=${{ github.sha }}
+          make build-postgres-operator \
+            GO_BUILD='go test -c --tags main-with-coverage --trimpath --coverpkg ./internal/...' \
+            PGO_VERSION='${{ github.sha }}-coverage'
 
       # Start a Docker container with the working directory mounted.
       - name: Start PGO
@@ -122,7 +124,7 @@ jobs:
             --env 'RELATED_IMAGE_POSTGRES_14=registry.developers.crunchydata.com/crunchydata/crunchy-postgres:ubi8-14.4-0' \
             --env 'RELATED_IMAGE_POSTGRES_14_GIS_3.1=registry.developers.crunchydata.com/crunchydata/crunchy-postgres-gis:ubi8-14.4-3.1-0' \
             --name 'postgres-operator' ubuntu \
-            postgres-operator
+            postgres-operator --test.coverprofile 'kuttl.coverage'
 
       - run: make tools/kuttl
       - run: make generate-kuttl
@@ -138,12 +140,24 @@ jobs:
         env:
           KUTTL_TEST: hack/tools/kuttl test --test cluster-start --timeout=180 --parallel=1
 
+      - name: Stop PGO
+        run: docker stop 'postgres-operator' || true
+
+      # Upload coverage to GitHub
+      - run: gzip kuttl.coverage
+      - uses: actions/upload-artifact@v3
+        with:
+          name: "~coverage~kuttl-k3d=${{ matrix.kubernetes }}"
+          path: kuttl.coverage.gz
+          retention-days: 1
+
   coverage-report:
     if: ${{ success() || contains(needs.*.result, 'success') }}
     runs-on: ubuntu-latest
     needs:
       - kubernetes-api
       - kubernetes-k3d
+      - kuttl-k3d
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
@@ -174,6 +188,6 @@ jobs:
       - run: gzip total-coverage.html
       - uses: actions/upload-artifact@v3
         with:
-          name: coverage-report
+          name: coverage-report=html
           path: total-coverage.html.gz
           retention-days: 15

cmd/postgres-operator/main_coverage_test.go

@@ -0,0 +1,29 @@
+//go:build main-with-coverage
+// +build main-with-coverage
+
+/*
+ Copyright 2022 Crunchy Data Solutions, Inc.
+ 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 main
+
+import "testing"
+
+// TestWithCoverage is a simple way to run the entire application when built by
+// "go test -c" with code coverage enabled. This file has a build constraint,
+// and should *not* be run with regular "go test".
+//
+// - https://www.elastic.co/blog/code-coverage-for-your-golang-system-tests
+//
+func TestWithCoverage(t *testing.T) { main() }