Merge pull request #338 from dem4gus/dependabot-boilerplate

openshift-merge-bot[bot] · web-flow · commit 78779bcf520e · 2025-04-25T14:55:34.000Z
update boilerplate
diff --git a/.ci-operator.yaml b/.ci-operator.yaml
@@ -1,4 +1,4 @@
 build_root_image:
   name: boilerplate
   namespace: openshift
-  tag: image-v6.0.1
+  tag: image-v7.2.0
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -8,7 +8,7 @@ updates:
     schedule:
       interval: "weekly"
     ignore:
-      - dependency-name: "app-sre/boilerplate"
+      - dependency-name: "redhat-services-prod/openshift/boilerplate"
         # don't upgrade boilerplate via these means
       - dependency-name: "openshift4/ose-operator-registry"
         # don't upgrade ose-operator-registry via these means
diff --git a/Makefile b/Makefile
@@ -1,7 +1,5 @@
 FIPS_ENABLED=true
 
-export LATEST_IMAGE_TAG=image-v6.0.1
-
 include boilerplate/generated-includes.mk
 
 .PHONY: boilerplate-update
diff --git a/OWNERS_ALIASES b/OWNERS_ALIASES
@@ -14,9 +14,7 @@ aliases:
     - theautoroboto
     - rhdedgar
     - katherinelc321
-    - robotmaxtron
     - rojasreinold
-    - hbhushan3
     - fsferraz-rh
   srep-functional-team-hulk:
     - a7vicky
diff --git a/boilerplate/_data/backing-image-tag b/boilerplate/_data/backing-image-tag
@@ -1 +1 @@
-image-v6.0.1
+image-v7.2.0
diff --git a/boilerplate/_data/last-boilerplate-commit b/boilerplate/_data/last-boilerplate-commit
@@ -1 +1 @@
-5d599ff5771f30d4e09248ddcb116375b3a38102
+afc8fe6dee4d437d2e84faaf18019fbb97d8c266
diff --git a/boilerplate/openshift/golang-osd-operator-osde2e/README.md b/boilerplate/openshift/golang-osd-operator-osde2e/README.md
@@ -15,8 +15,7 @@ openshift/golang-osd-operator-osde2e
 
 ## `make` targets and functions.
 
-**Note:** Your repository's main `Makefile` needs to be edited to include the
-"nexus makefile include":
+**Note:** Your repository's main `Makefile` needs to be edited to include:
 
 ```
 include boilerplate/generated-includes.mk
@@ -30,11 +29,10 @@ following:
 
 | `make` target      | Purpose                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 |--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `e2e-harness-generate` | Generate scaffolding for an end to end test harness. The `test/e2e` directory is created where the tests and test runner reside. The harness has access to cloud client and harness passthrough secrets within the test job cluster. Add your operator  related ginkgo e2e tests under the `test/e2e/<operator-name>_tests.go` file. See [this README](https://github.com/openshift/osde2e-example-test-harness/blob/main/README.md#locally-running-this-example) for more details on test harness. |
 | `e2e-harness-build`| Compiles ginkgo tests under test/e2e and creates the ginkgo binary.                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | `e2e-image-build-push` | Builds e2e test harness 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 Harness Local Testing
 
-Please follow [this README](https://github.com/openshift/osde2e-example-test-harness/blob/main/README.md#locally-running-this-example) to run your e2e tests locally
+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-operator-osde2e/standard.mk b/boilerplate/openshift/golang-osd-operator-osde2e/standard.mk
@@ -19,6 +19,7 @@ HARNESS_IMAGE_TAG=$(CURRENT_COMMIT)
 # 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
@@ -27,7 +28,7 @@ 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 cp /var/lib/jenkins/.docker/config.json $(REGISTRY_AUTH_FILE))
+$(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
@@ -69,7 +70,7 @@ e2e-harness-build: GOFLAGS_MOD=-mod=mod
 e2e-harness-build: GOENV=GOOS=${GOOS} GOARCH=${GOARCH} CGO_ENABLED=0 GOFLAGS="${GOFLAGS_MOD}"
 e2e-harness-build:
 	go mod tidy
-	${GOENV} go test ./test/e2e -v -c --tags=osde2e -o harness.test
+	go test ./test/e2e -v -c --tags=osde2e -o harness.test
 
 # TODO: Push to a known image tag and commit id
 # push harness image
diff --git a/boilerplate/openshift/golang-osd-operator-osde2e/test-harness-template.yml b/boilerplate/openshift/golang-osd-operator-osde2e/test-harness-template.yml
@@ -3,7 +3,6 @@ apiVersion: template.openshift.io/v1
 kind: Template
 metadata:
   name: osde2e-focused-tests
-
 parameters:
   - name: OSDE2E_CONFIGS
     required: true
@@ -46,6 +45,9 @@ objects:
                 - /osde2e
               args:
                 - test
+                - --only-health-check-nodes
+                - --skip-destroy-cluster
+                - --skip-must-gather
                 - --configs
                 - ${OSDE2E_CONFIGS}
               securityContext:
diff --git a/boilerplate/openshift/golang-osd-operator-osde2e/update b/boilerplate/openshift/golang-osd-operator-osde2e/update
@@ -10,8 +10,8 @@ source $CONVENTION_ROOT/_lib/common.sh
 # Expect POST
 [[ "$1" == "POST" ]] || err "Got a parameter I don't understand: '$1'. Did the infrastructure change?"
 
-OPERATOR_NAME=$(sed -n 's/.*OperatorName .*"\([^"]*\)".*/\1/p' "${REPO_ROOT}/config/config.go")
 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
@@ -87,4 +87,21 @@ func Test${OPERATOR_NAME_CAMEL_CASE}(t *testing.T) {
 }
 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-harness-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)/test-harness-template.yml >"${E2E_SUITE_DIRECTORY}/test-harness-template.yml"
diff --git a/boilerplate/openshift/golang-osd-operator/OWNERS_ALIASES b/boilerplate/openshift/golang-osd-operator/OWNERS_ALIASES
@@ -14,9 +14,7 @@ aliases:
     - theautoroboto
     - rhdedgar
     - katherinelc321
-    - robotmaxtron
     - rojasreinold
-    - hbhushan3
     - fsferraz-rh
   srep-functional-team-hulk:
     - a7vicky
diff --git a/boilerplate/openshift/golang-osd-operator/README.md b/boilerplate/openshift/golang-osd-operator/README.md
@@ -99,7 +99,6 @@ Consult [this doc](app-sre.md) for information on local execution/testing.
 - ensures the proper version of `golangci-lint` is installed, and
 - runs it against
 - a `golangci.yml` config.
-- a `GOLANGCI_OPTIONAL_CONFIG` config if it is defined and file exists
 
 ## Checks on generated code
 
diff --git a/boilerplate/openshift/golang-osd-operator/dependabot.yml b/boilerplate/openshift/golang-osd-operator/dependabot.yml
@@ -8,7 +8,7 @@ updates:
     schedule:
       interval: "weekly"
     ignore:
-      - dependency-name: "app-sre/boilerplate"
+      - dependency-name: "redhat-services-prod/openshift/boilerplate"
         # don't upgrade boilerplate via these means
       - dependency-name: "openshift4/ose-operator-registry"
         # don't upgrade ose-operator-registry via these means
diff --git a/boilerplate/openshift/golang-osd-operator/ensure.sh b/boilerplate/openshift/golang-osd-operator/ensure.sh
@@ -1,11 +1,14 @@
 #!/usr/bin/env bash
-set -x
 set -eo pipefail
 
+if [ "$BOILERPLATE_SET_X" ]; then
+  set -x
+fi
+
 REPO_ROOT=$(git rev-parse --show-toplevel)
 source $REPO_ROOT/boilerplate/_lib/common.sh
 
-GOLANGCI_LINT_VERSION="1.59.1"
+GOLANGCI_LINT_VERSION="2.0.2"
 OPM_VERSION="v1.23.2"
 GRPCURL_VERSION="1.7.0"
 DEPENDENCY=${1:-}
@@ -19,10 +22,8 @@ golangci-lint)
         exit
     else
         mkdir -p "${GOPATH}/bin"
-        echo "${PATH}" | grep -q "${GOPATH}/bin"
-        IN_PATH=$?
-        if [ $IN_PATH != 0 ]; then
-            echo "${GOPATH}/bin not in $$PATH"
+        if ! echo "${PATH}" | grep -q "${GOPATH}/bin"; then
+            echo "${GOPATH}/bin not in $PATH"
             exit 1
         fi
         DOWNLOAD_URL="https://github.com/golangci/golangci-lint/releases/download/v${GOLANGCI_LINT_VERSION}/golangci-lint-${GOLANGCI_LINT_VERSION}-${GOOS}-amd64.tar.gz"
diff --git a/boilerplate/openshift/golang-osd-operator/golangci.yml b/boilerplate/openshift/golang-osd-operator/golangci.yml
@@ -1,33 +1,39 @@
-# options for analysis running
+version: "2"
 run:
-  # default concurrency is a available CPU number
   concurrency: 10
-  # timeout for analysis, e.g. 30s, 5m, default is 1m
-  # We're using a somewhat resource-constrained container in the CI
-  # environment, so make this longish.
-  timeout: 10m
-
+linters:
+  default: none
+  enable:
+    - errcheck
+    - gosec
+    - govet
+    - ineffassign
+    - misspell
+    - staticcheck
+    - unused
+  settings:
+    misspell:
+      extra-words:
+        - typo: openshit
+          correction: OpenShift
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    paths:
+      - third_party/
+      - builtin/
+      - examples/
 issues:
-  # We want to make sure we get a full report every time. Setting these
-  # to zero disables the limit.
   max-issues-per-linter: 0
   max-same-issues: 0
-
-linters:
-  disable-all: true
-  enable:
-  - errcheck
-  - gosec
-  - gosimple
-  - govet
-  - ineffassign
-  - misspell
-  - staticcheck
-  - typecheck
-  - unused
-
-linters-settings:
-  misspell:
-    extra-words:
-      - typo: "openshit"
-        correction: "OpenShift"
+formatters:
+  exclusions:
+    generated: lax
+    paths:
+      - third_party/
+      - builtin/
+      - examples/
diff --git a/boilerplate/openshift/golang-osd-operator/standard.mk b/boilerplate/openshift/golang-osd-operator/standard.mk
@@ -21,6 +21,7 @@ endif
 # 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
@@ -29,7 +30,7 @@ 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 cp /var/lib/jenkins/.docker/config.json $(REGISTRY_AUTH_FILE))
+$(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
@@ -97,34 +98,25 @@ GOBIN?=$(shell go env GOBIN)
 unexport GOFLAGS
 GOFLAGS_MOD ?=
 
-# In openshift ci (Prow), we need to set $HOME to a writable directory else tests will fail
-# because they don't have permissions to create /.local or /.cache directories
-# as $HOME is set to "/" by default.
-ifeq ($(HOME),/)
-export HOME=/tmp/home
-endif
-PWD=$(shell pwd)
-
-GOENV=GOOS=${GOOS} GOARCH=${GOARCH} CGO_ENABLED=1 GOFLAGS="${GOFLAGS_MOD}"
+GOENV+=GOOS=${GOOS} GOARCH=${GOARCH} CGO_ENABLED=1 GOFLAGS="${GOFLAGS_MOD}"
 GOBUILDFLAGS=-gcflags="all=-trimpath=${GOPATH}" -asmflags="all=-trimpath=${GOPATH}"
 
 ifeq (${FIPS_ENABLED}, true)
 GOFLAGS_MOD+=-tags=fips_enabled
 GOFLAGS_MOD:=$(strip ${GOFLAGS_MOD})
-$(warning Setting GOEXPERIMENT=strictfipsruntime,boringcrypto - this generally causes builds to fail unless building inside the provided Dockerfile. If building locally consider calling 'go build .')
-GOENV+=GOEXPERIMENT=strictfipsruntime,boringcrypto
+$(warning Setting GOEXPERIMENT=boringcrypto - this generally causes builds to fail unless building inside the provided Dockerfile. If building locally consider calling 'go build .')
+GOENV+=GOEXPERIMENT=boringcrypto
 GOENV:=$(strip ${GOENV})
 endif
 
 # GOLANGCI_LINT_CACHE needs to be set to a directory which is writeable
 # Relevant issue - https://github.com/golangci/golangci-lint/issues/734
 GOLANGCI_LINT_CACHE ?= /tmp/golangci-cache
 
-GOLANGCI_OPTIONAL_CONFIG ?=
-
 ifeq ($(origin TESTTARGETS), undefined)
 TESTTARGETS := $(shell ${GOENV} go list -e ./... | grep -E -v "/(vendor)/" | grep -E -v "/(test/e2e)/")
 endif
+
 # ex, -v
 TESTOPTS :=
 
@@ -183,11 +175,16 @@ docker-login:
 .PHONY: go-check
 go-check: ## Golang linting and other static analysis
 	${CONVENTION_DIR}/ensure.sh golangci-lint
-	GOLANGCI_LINT_CACHE=${GOLANGCI_LINT_CACHE} golangci-lint run -c ${CONVENTION_DIR}/golangci.yml ./...
-	test "${GOLANGCI_OPTIONAL_CONFIG}" = "" || test ! -e "${GOLANGCI_OPTIONAL_CONFIG}" || GOLANGCI_LINT_CACHE="${GOLANGCI_LINT_CACHE}" golangci-lint run -c "${GOLANGCI_OPTIONAL_CONFIG}" ./...
+	${GOENV} GOLANGCI_LINT_CACHE=${GOLANGCI_LINT_CACHE} golangci-lint run -c ${CONVENTION_DIR}/golangci.yml ./...
 
 .PHONY: go-generate
 go-generate:
+	# If for any reason we've made it this far and TESTTARGETS is still empty, fail early.
+	@if [ -z "$(TESTTARGETS)" ]; then \
+		echo "ERROR: TESTTARGETS is empty"; \
+		exit 1; \
+	fi
+
 	${GOENV} go generate $(TESTTARGETS)
 	# Don't forget to commit generated files
 
@@ -213,8 +210,8 @@ YQ = yq
 .PHONY: op-generate
 ## CRD v1beta1 is no longer supported.
 op-generate:
-	cd ./api; $(CONTROLLER_GEN) crd:crdVersions=v1,generateEmbeddedObjectMeta=true paths=./... output:dir=$(PWD)/deploy/crds
-	cd ./api; $(CONTROLLER_GEN) object paths=./...
+	cd ./api; ${GOENV} $(CONTROLLER_GEN) crd:crdVersions=v1,generateEmbeddedObjectMeta=true paths=./... output:dir=$(shell pwd)/deploy/crds
+	cd ./api; ${GOENV} $(CONTROLLER_GEN) object paths=./...
 
 .PHONY: openapi-generate
 openapi-generate:
@@ -266,7 +263,13 @@ SHELL = /usr/bin/env bash -o pipefail
 
 .PHONY: go-test
 go-test: setup-envtest
-	KUBEBUILDER_ASSETS=$(KUBEBUILDER_ASSETS) go test $(TESTOPTS) $(TESTTARGETS)
+	# If for any reason we've made it this far and TESTTARGETS is still empty, fail early.
+	@if [ -z "$(TESTTARGETS)" ]; then \
+		echo "ERROR: TESTTARGETS is empty"; \
+		exit 1; \
+	fi
+
+	${GOENV} KUBEBUILDER_ASSETS=$(KUBEBUILDER_ASSETS) go test $(TESTOPTS) $(TESTTARGETS)
 
 .PHONY: python-venv
 python-venv:
diff --git a/build/Dockerfile b/build/Dockerfile
@@ -1,9 +1,9 @@
-FROM quay.io/redhat-services-prod/openshift/boilerplate:image-v6.0.1 AS builder
+FROM quay.io/redhat-services-prod/openshift/boilerplate:image-v7.2.0 AS builder
 COPY . /go/src/github.com/openshift/splunk-forwarder-operator
 WORKDIR /go/src/github.com/openshift/splunk-forwarder-operator
 RUN make go-build
 
-FROM registry.access.redhat.com/ubi8/ubi-minimal:8.10-1179.1741863533
+FROM registry.access.redhat.com/ubi8/ubi-minimal:8.10-1255
 ENV OPERATOR_PATH=/go/src/github.com/openshift/splunk-forwarder-operator \
     OPERATOR_BIN=splunk-forwarder-operator
 
diff --git a/build/Dockerfile.olm-registry b/build/Dockerfile.olm-registry
@@ -4,7 +4,7 @@ COPY ${SAAS_OPERATOR_DIR} manifests
 RUN initializer --permissive
 
 # ubi-micro does not work for clusters with fips enabled unless we make OpenSSL available
-FROM registry.access.redhat.com/ubi8/ubi-minimal:8.10-1179.1741863533
+FROM registry.access.redhat.com/ubi8/ubi-minimal:8.10-1255
 
 COPY --from=builder /bin/registry-server /bin/registry-server
 COPY --from=builder /bin/grpc_health_probe /bin/grpc_health_probe
diff --git a/controllers/secret/secret_controller.go b/controllers/secret/secret_controller.go
@@ -83,7 +83,7 @@ func (r *SecretReconciler) Reconcile(ctx context.Context, request reconcile.Requ
 		return reconcile.Result{}, err
 	}
 	if len(sfCrds.Items) > 1 {
-		return reconcile.Result{}, goerr.New("More than one CR in namespace")
+		return reconcile.Result{}, goerr.New("more than one CR in namespace")
 	}
 
 	// Our CR does not exist in this namespace, just ignore and continue
diff --git a/pkg/kube/daemonset.go b/pkg/kube/daemonset.go
diff --git a/pkg/kube/daemonset_test.go b/pkg/kube/daemonset_test.go
diff --git a/test/e2e/README.md b/test/e2e/README.md
diff --git a/test/e2e/test-harness-template.yml b/test/e2e/test-harness-template.yml

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-5d599ff5771f30d4e09248ddcb116375b3a38102`
	`1`	`+afc8fe6dee4d437d2e84faaf18019fbb97d8c266`