boilerplating e2e suite (#498)

ritmun · web-flow · commit 512c8c433479 · 2025-07-09T00:25:57.000Z
* boilerplating e2e

* boilerplating e2e + bp update

* remove old makefile

will be provided by bp

* bp update
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,13 +1,5 @@
 version: 2
 updates:
-  - package-ecosystem: "gomod"
-    directories:
-      - "/"
-      - "interceptor/"
-    allow:
-      - dependency-type: all
-    schedule:
-      interval: "daily"
   - package-ecosystem: "docker"
     directory: "/build"
     labels:
diff --git a/Makefile b/Makefile
@@ -7,7 +7,6 @@ define ADDITIONAL_IMAGE_SPECS
 endef
 
 include boilerplate/generated-includes.mk
-include test/e2e/project.mk
 
 GOLANGCI_LINT_VERSION=v2.0.2
 MOCKGEN_VERSION=v0.5.0
diff --git a/OWNERS_ALIASES b/OWNERS_ALIASES
@@ -65,14 +65,14 @@ aliases:
     - smarthall
   srep-infra-cicd:
     - mmazur
-    - mrsantamaria
     - ritmun
     - jbpratt
     - yiqinzhang
+    - varunraokadaparthi
   srep-functional-leads:
     - abyrne55
     - clcollins
-    - Nikokolas3270
+    - bergmannf
     - theautoroboto
     - smarthall
     - sam-nguyen7
diff --git a/boilerplate/_data/last-boilerplate-commit b/boilerplate/_data/last-boilerplate-commit
@@ -1 +1 @@
-25d548ae98a0a1c8125aecf14cc168ad36968920
+b655ba1347f9bd549afec9f383b5154ca4747c37
diff --git a/boilerplate/generated-includes.mk b/boilerplate/generated-includes.mk
@@ -3,3 +3,5 @@
 # conventions. Please ensure your base Makefile includes only this file.
 include boilerplate/_lib/boilerplate.mk
 include boilerplate/openshift/osd-container-image/standard.mk
+include boilerplate/openshift/golang-osd-e2e/project.mk
+include boilerplate/openshift/golang-osd-e2e/standard.mk
diff --git a/boilerplate/openshift/golang-osd-e2e/OWNERS b/boilerplate/openshift/golang-osd-e2e/OWNERS
@@ -0,0 +1,4 @@
+reviewers:
+- srep-infra-cicd
+approvers:
+- srep-infra-cicd
diff --git a/boilerplate/openshift/golang-osd-e2e/README.md b/boilerplate/openshift/golang-osd-e2e/README.md
@@ -0,0 +1,38 @@
+# Conventions for Ginkgo based e2e tests
+
+- [Conventions for Ginkgo based e2e tests](#conventions-for-ginkgo-based-e2e-tests)
+    - [Consuming](#consuming)
+    - [`make` targets and functions.](#make-targets-and-functions)
+        - [E2E Test](#e2e-test)
+            - [Local Testing](#e2e-local-testing)
+
+## Consuming
+Currently, this convention is only intended for OSD operators. To adopt this convention, your `boilerplate/update.cfg` should include:
+
+```
+openshift/golang-osd-e2e
+```
+
+## `make` targets and functions.
+
+**Note:** Your repository's main `Makefile` needs to be edited to include:
+
+```
+include boilerplate/generated-includes.mk
+```
+
+One of the primary purposes of these `make` targets is to allow you to
+standardize your prow and app-sre pipeline configurations using the
+following:
+
+### E2e Test
+
+| `make` target          | Purpose                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `e2e-binary-build`     | Compiles ginkgo tests under test/e2e and creates the ginkgo binary.                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| `e2e-image-build-push` | Builds e2e image and pushes to operator's quay repo. Image name is defaulted to <operator-image-name>-test-harness. Quay repository must be created beforehand.                                                                                                                                                                                                                                                                                                                        |
+
+#### E2E Local Testing
+
+Please follow [this README](https://github.com/openshift/ops-sop/blob/master/v4/howto/osde2e/operator-test-harnesses.md#using-ginkgo) to run your e2e tests locally
+
diff --git a/boilerplate/openshift/golang-osd-e2e/e2e-template.yml b/boilerplate/openshift/golang-osd-e2e/e2e-template.yml
@@ -1,15 +1,17 @@
+# THIS FILE IS GENERATED BY BOILERPLATE. DO NOT EDIT.
 apiVersion: template.openshift.io/v1
 kind: Template
 metadata:
   name: osde2e-focused-tests
-
 parameters:
   - name: OSDE2E_CONFIGS
     required: true
-  - name: TEST_E2E_SUITE_IMAGE
-    required: true
-  - name: OCM_TOKEN
+  - name: TEST_IMAGE
     required: true
+  - name: OCM_CLIENT_ID
+    required: false
+  - name: OCM_CLIENT_SECRET
+    required: false
   - name: OCM_CCS
     required: false
   - name: AWS_ACCESS_KEY_ID
@@ -32,7 +34,7 @@ objects:
   - apiVersion: batch/v1
     kind: Job
     metadata:
-      name: configuration-anomaly-detection-${IMAGE_TAG}-${JOBID}
+      name: osde2e-${OPERATOR_NAME}-${IMAGE_TAG}-${JOBID}
     spec:
       backoffLimit: 0
       template:
@@ -45,6 +47,9 @@ objects:
                 - /osde2e
               args:
                 - test
+                - --only-health-check-nodes
+                - --skip-destroy-cluster
+                - --skip-must-gather
                 - --configs
                 - ${OSDE2E_CONFIGS}
               securityContext:
@@ -55,10 +60,12 @@ objects:
                 seccompProfile:
                   type: RuntimeDefault
               env:
-                - name: TEST_HARNESSES
-                  value: ${TEST_E2E_SUITE_IMAGE}:${IMAGE_TAG}
-                - name: OCM_TOKEN
-                  value: ${OCM_TOKEN}
+                - name: AD_HOC_TEST_IMAGES
+                  value: ${TEST_IMAGE}:${IMAGE_TAG}
+                - name: OCM_CLIENT_ID
+                  value: ${OCM_CLIENT_ID}
+                - name: OCM_CLIENT_SECRET
+                  value: ${OCM_CLIENT_SECRET}
                 - name: OCM_CCS
                   value: ${OCM_CCS}
                 - name: AWS_ACCESS_KEY_ID
@@ -70,4 +77,4 @@ objects:
                 - name: GCP_CREDS_JSON
                   value: ${GCP_CREDS_JSON}
                 - name: LOG_BUCKET
-                  value: ${LOG_BUCKET}                 
+                  value: ${LOG_BUCKET}                 
diff --git a/boilerplate/openshift/golang-osd-e2e/project.mk b/boilerplate/openshift/golang-osd-e2e/project.mk
@@ -0,0 +1,10 @@
+# Project specific values
+OPERATOR_NAME?=$(shell sed -n 's/.*OperatorName .*"\([^"]*\)".*/\1/p' config/config.go)
+
+E2E_IMAGE_REGISTRY?=quay.io
+E2E_IMAGE_REPOSITORY?=app-sre
+E2E_IMAGE_NAME?=$(OPERATOR_NAME)-e2e
+
+ 
+REGISTRY_USER?=$(QUAY_USER)
+REGISTRY_TOKEN?=$(QUAY_TOKEN)
diff --git a/boilerplate/openshift/golang-osd-e2e/standard.mk b/boilerplate/openshift/golang-osd-e2e/standard.mk
@@ -0,0 +1,73 @@
+# Validate variables in project.mk exist
+ifndef OPERATOR_NAME
+$(error OPERATOR_NAME is not set; only operators should consume this convention; check project.mk file)
+endif
+ifndef E2E_IMAGE_REGISTRY
+$(error E2E_IMAGE_REGISTRY is not set; check project.mk file)
+endif
+ifndef E2E_IMAGE_REPOSITORY
+$(error E2E_IMAGE_REPOSITORY is not set; check project.mk file)
+endif
+
+# Use current commit as e2e image tag
+CURRENT_COMMIT=$(shell git rev-parse --short=7 HEAD)
+E2E_IMAGE_TAG=$(CURRENT_COMMIT)
+
+### Accommodate docker or podman
+#
+# The docker/podman creds cache needs to be in a location unique to this
+# invocation; otherwise it could collide across jenkins jobs. We'll use
+# a .docker folder relative to pwd (the repo root).
+CONTAINER_ENGINE_CONFIG_DIR = .docker
+JENKINS_DOCKER_CONFIG_FILE = /var/lib/jenkins/.docker/config.json
+export REGISTRY_AUTH_FILE = ${CONTAINER_ENGINE_CONFIG_DIR}/config.json
+
+# If this configuration file doesn't exist, podman will error out. So
+# we'll create it if it doesn't exist.
+ifeq (,$(wildcard $(REGISTRY_AUTH_FILE)))
+$(shell mkdir -p $(CONTAINER_ENGINE_CONFIG_DIR))
+# Copy the node container auth file so that we get access to the registries the
+# parent node has access to
+$(shell if test -f $(JENKINS_DOCKER_CONFIG_FILE); then cp $(JENKINS_DOCKER_CONFIG_FILE) $(REGISTRY_AUTH_FILE); fi)
+endif
+
+# ==> Docker uses --config=PATH *before* (any) subcommand; so we'll glue
+# that to the CONTAINER_ENGINE variable itself. (NOTE: I tried half a
+# dozen other ways to do this. This was the least ugly one that actually
+# works.)
+ifndef CONTAINER_ENGINE
+CONTAINER_ENGINE=$(shell command -v podman 2>/dev/null || echo docker --config=$(CONTAINER_ENGINE_CONFIG_DIR))
+endif
+
+REGISTRY_USER ?=
+REGISTRY_TOKEN ?=
+
+# TODO: Figure out how to discover this dynamically
+OSDE2E_CONVENTION_DIR := boilerplate/openshift/golang-osd-operator-osde2e
+
+# log into quay.io
+.PHONY: container-engine-login
+container-engine-login:
+	@test "${REGISTRY_USER}" != "" && test "${REGISTRY_TOKEN}" != "" || (echo "REGISTRY_USER and REGISTRY_TOKEN must be defined" && exit 1)
+	mkdir -p ${CONTAINER_ENGINE_CONFIG_DIR}
+	@${CONTAINER_ENGINE} login -u="${REGISTRY_USER}" -p="${REGISTRY_TOKEN}" quay.io
+
+######################
+# Targets used by e2e test suite
+######################
+
+# create binary
+.PHONY: e2e-binary-build
+e2e-binary-build: GOFLAGS_MOD=-mod=mod
+e2e-binary-build: GOENV=GOOS=${GOOS} GOARCH=${GOARCH} CGO_ENABLED=0 GOFLAGS="${GOFLAGS_MOD}"
+e2e-binary-build:
+	go mod tidy
+	go test ./test/e2e -v -c --tags=osde2e -o e2e.test
+
+# push e2e image tagged as latest and as repo commit hash
+.PHONY: e2e-image-build-push
+e2e-image-build-push: container-engine-login
+	${CONTAINER_ENGINE} build --pull -f test/e2e/Dockerfile -t $(E2E_IMAGE_REGISTRY)/$(E2E_IMAGE_REPOSITORY)/$(E2E_IMAGE_NAME):$(E2E_IMAGE_TAG) .
+	${CONTAINER_ENGINE} tag $(E2E_IMAGE_REGISTRY)/$(E2E_IMAGE_REPOSITORY)/$(E2E_IMAGE_NAME):$(E2E_IMAGE_TAG) $(E2E_IMAGE_REGISTRY)/$(E2E_IMAGE_REPOSITORY)/$(E2E_IMAGE_NAME):latest
+	${CONTAINER_ENGINE} push $(E2E_IMAGE_REGISTRY)/$(E2E_IMAGE_REPOSITORY)/$(E2E_IMAGE_NAME):$(E2E_IMAGE_TAG)
+	${CONTAINER_ENGINE} push $(E2E_IMAGE_REGISTRY)/$(E2E_IMAGE_REPOSITORY)/$(E2E_IMAGE_NAME):latest
diff --git a/boilerplate/openshift/golang-osd-e2e/update b/boilerplate/openshift/golang-osd-e2e/update
@@ -0,0 +1,112 @@
+#!/usr/bin/env bash
+
+set -e
+
+source $CONVENTION_ROOT/_lib/common.sh
+
+# No PRE
+[[ "$1" == "PRE" ]] && exit 0
+
+# Expect POST
+[[ "$1" == "POST" ]] || err "Got a parameter I don't understand: '$1'. Did the infrastructure change?"
+
+REPO_ROOT=$(git rev-parse --show-toplevel)
+OPERATOR_NAME=$(sed -n 's/.*OperatorName .*=.*"\([^"]*\)".*/\1/p' "${REPO_ROOT}/config/config.go")
+E2E_SUITE_DIRECTORY=$REPO_ROOT/test/e2e
+
+# Update operator name in templates
+OPERATOR_UNDERSCORE_NAME=${OPERATOR_NAME//-/_}
+OPERATOR_PROPER_NAME=$(echo "$OPERATOR_NAME" | sed 's/-/ /g' | awk '{for(i=1;i<=NF;i++){ $i=toupper(substr($i,1,1)) substr($i,2) }}1')
+OPERATOR_NAME_CAMEL_CASE=${OPERATOR_PROPER_NAME// /}
+
+mkdir -p "${E2E_SUITE_DIRECTORY}"
+
+E2E_SUITE_BUILDER_IMAGE=registry.ci.openshift.org/openshift/release:rhel-8-release-golang-1.23-openshift-4.19
+if [[ -n ${KONFLUX_BUILDS} ]]; then
+	E2E_SUITE_BUILDER_IMAGE="brew.registry.redhat.io/rh-osbs/openshift-golang-builder:rhel_8_1.23"
+fi
+
+echo "syncing ${E2E_SUITE_DIRECTORY}/Dockerfile"
+tee "${E2E_SUITE_DIRECTORY}/Dockerfile" <<EOF
+# THIS FILE IS GENERATED BY BOILERPLATE. DO NOT EDIT.
+FROM ${E2E_SUITE_BUILDER_IMAGE} as builder
+WORKDIR /go/src/github.com/openshift/$OPERATOR_NAME/
+COPY . .
+RUN  CGO_ENABLED=0 GOFLAGS="-mod=mod" go test ./test/e2e -v -c --tags=osde2e -o /e2e.test
+
+FROM registry.access.redhat.com/ubi8/ubi-minimal:latest
+COPY --from=builder ./e2e.test e2e.test
+ENTRYPOINT [ "/e2e.test" ]
+EOF
+
+if [ ! -f "${E2E_SUITE_DIRECTORY}/${OPERATOR_UNDERSCORE_NAME}_tests.go" ]; then
+	echo "syncing ${E2E_SUITE_DIRECTORY}/${OPERATOR_UNDERSCORE_NAME}_tests.go"
+	tee "${E2E_SUITE_DIRECTORY}/${OPERATOR_UNDERSCORE_NAME}_tests.go" <<EOF
+// DO NOT REMOVE TAGS BELOW. IF ANY NEW TEST FILES ARE CREATED UNDER /test/e2e, PLEASE ADD THESE TAGS TO THEM IN ORDER TO BE EXCLUDED FROM UNIT TESTS.
+//go:build osde2e
+
+package osde2etests
+
+import "github.com/onsi/ginkgo/v2"
+
+var _ = ginkgo.Describe("$OPERATOR_NAME", func() {
+	//	 Add your tests
+})
+EOF
+fi
+
+echo "syncing ${E2E_SUITE_DIRECTORY}/${OPERATOR_UNDERSCORE_NAME}_runner_test.go"
+tee "${E2E_SUITE_DIRECTORY}/${OPERATOR_UNDERSCORE_NAME}_runner_test.go" <<EOF
+// THIS FILE IS GENERATED BY BOILERPLATE. DO NOT EDIT.
+//go:build osde2e
+
+package osde2etests
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+const (
+	testResultsDirectory = "/test-run-results"
+	jUnitOutputFilename  = "junit-${OPERATOR_NAME}.xml"
+)
+
+// Test entrypoint. osde2e runs this as a test suite on test pod.
+func Test${OPERATOR_NAME_CAMEL_CASE}(t *testing.T) {
+	RegisterFailHandler(Fail)
+	suiteConfig, reporterConfig := GinkgoConfiguration()
+	if _, ok := os.LookupEnv("DISABLE_JUNIT_REPORT"); !ok {
+		reporterConfig.JUnitReport = filepath.Join(testResultsDirectory, jUnitOutputFilename)
+	}
+	RunSpecs(t, "${OPERATOR_PROPER_NAME}", suiteConfig, reporterConfig)
+}
+EOF
+
+tee "${E2E_SUITE_DIRECTORY}/README.md" <<EOF
+## Locally running e2e test suite
+When updating your operator it's beneficial to add e2e tests for new functionality AND ensure existing functionality is not breaking using e2e tests. 
+To do this, following steps are recommended
+
+1. Run "make e2e-binary-build"  to make sure e2e tests build 
+2. Deploy your new version of operator in a test cluster
+3. Run "go install github.com/onsi/ginkgo/ginkgo@latest"
+4. Get kubeadmin credentials from your cluster using 
+
+ocm get /api/clusters_mgmt/v1/clusters/(cluster-id)/credentials | jq -r .kubeconfig > /(path-to)/kubeconfig
+
+5. Run test suite using 
+ 
+DISABLE_JUNIT_REPORT=true KUBECONFIG=/(path-to)/kubeconfig  ./(path-to)/bin/ginkgo  --tags=osde2e -v test/e2e
+EOF
+
+sed -e "s/\${OPERATOR_NAME}/${OPERATOR_NAME}/" $(dirname $0)/e2e-template.yml >"${E2E_SUITE_DIRECTORY}/e2e-template.yml"
+
+# todo: remove after file is renamed in ALL consumer repos
+if [ -f "${E2E_SUITE_DIRECTORY}/test-harness-template.yml" ]; then
+  rm -f "${E2E_SUITE_DIRECTORY}/test-harness-template.yml"
+fi
diff --git a/boilerplate/openshift/osd-container-image/OWNERS_ALIASES b/boilerplate/openshift/osd-container-image/OWNERS_ALIASES
@@ -65,14 +65,14 @@ aliases:
     - smarthall
   srep-infra-cicd:
     - mmazur
-    - mrsantamaria
     - ritmun
     - jbpratt
     - yiqinzhang
+    - varunraokadaparthi
   srep-functional-leads:
     - abyrne55
     - clcollins
-    - Nikokolas3270
+    - bergmannf
     - theautoroboto
     - smarthall
     - sam-nguyen7
diff --git a/boilerplate/update.cfg b/boilerplate/update.cfg
@@ -1 +1,2 @@
 openshift/osd-container-image
+openshift/golang-osd-e2e
diff --git a/config/config.go b/config/config.go
@@ -0,0 +1,6 @@
+package config
+
+const (
+	// OperatorName This isn't an operator, but boilerplate uses this to determine names
+	OperatorName = "configuration-anomaly-detection"
+)
diff --git a/test/e2e/Dockerfile b/test/e2e/Dockerfile
@@ -1,5 +1,6 @@
+# THIS FILE IS GENERATED BY BOILERPLATE. DO NOT EDIT.
 FROM registry.ci.openshift.org/openshift/release:rhel-8-release-golang-1.23-openshift-4.19 as builder
-WORKDIR /go/src/github.com/openshift/configuration-anomaly-detection
+WORKDIR /go/src/github.com/openshift/configuration-anomaly-detection/
 COPY . .
 RUN  CGO_ENABLED=0 GOFLAGS="-mod=mod" go test ./test/e2e -v -c --tags=osde2e -o /e2e.test
 
diff --git a/test/e2e/README.md b/test/e2e/README.md
diff --git a/test/e2e/configuration_anomaly_detection_runner_test.go b/test/e2e/configuration_anomaly_detection_runner_test.go
diff --git a/test/e2e/configuration_anomaly_detection_tests.go b/test/e2e/configuration_anomaly_detection_tests.go
diff --git a/test/e2e/e2e-template.yml b/test/e2e/e2e-template.yml
diff --git a/test/e2e/project.mk b/test/e2e/project.mk

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-25d548ae98a0a1c8125aecf14cc168ad36968920`
	`1`	`+b655ba1347f9bd549afec9f383b5154ca4747c37`