Gaelg/mark spec unsafe

.github/workflows/deploy.yml

@@ -72,7 +72,7 @@ jobs:
     environment: deploy
     strategy:
       matrix:
-        id: ["operator-sdk", "helm-operator", "scorecard-test", "ansible-operator", "ansible-operator-2.11-preview", "scorecard-storage", "scorecard-untar"]
+        id: ["operator-sdk", "helm-operator", "scorecard-test", "ansible-operator", "ansible-operator-2.11-preview"]
     steps:
 
     - name: set up qemu

.github/workflows/test-ansible.yml

@@ -48,10 +48,12 @@ jobs:
         with:
           fetch-depth: 0
       - run: sudo rm -rf /usr/local/bin/kustomize
-      - run: |
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.8'
+      - name: Run test e2e ansible molecule
+        run: |
           env
-          export PATH=/opt/python/3.8.12/bin:${PATH}
-          sudo apt-get install python3 python3-pip
-          sudo pip3 install --upgrade setuptools pip
-          sudo pip3 install ansible~=2.9.13
+          pip3 install --user --upgrade setuptools pip
+          pip3 install --user ansible~=2.9.13
           make test-e2e-ansible-molecule

.golangci.yml

@@ -5,6 +5,7 @@ linters:
     - nakedret
     - misspell
     - ineffassign
+    - ginkgolinter
     - goconst
     - goimports
     - errcheck

Makefile

@@ -4,7 +4,7 @@ SHELL = /bin/bash
 # This value must be updated to the release tag of the most recent release, a change that must
 # occur in the release commit. IMAGE_VERSION will be removed once each subproject that uses this
 # version is moved to a separate repo and release process.
-export IMAGE_VERSION = v1.28.0
+export IMAGE_VERSION = v1.29.0
 # Build-time variables to inject into binaries
 export SIMPLE_VERSION = $(shell (test "$(shell git describe --tags)" = "$(shell git describe --tags --abbrev=0)" && echo $(shell git describe --tags)) || echo $(shell git describe --tags --abbrev=0)+git)
 export GIT_VERSION = $(shell git describe --dirty --tags --always)
@@ -92,7 +92,7 @@ build/scorecard-test build/scorecard-test-kuttl build/custom-scorecard-tests:
 
 # Convenience wrapper for building all remotely hosted images.
 .PHONY: image-build
-IMAGE_TARGET_LIST = operator-sdk helm-operator ansible-operator ansible-operator-2.11-preview scorecard-test scorecard-test-kuttl scorecard-untar scorecard-storage
+IMAGE_TARGET_LIST = operator-sdk helm-operator ansible-operator ansible-operator-2.11-preview scorecard-test scorecard-test-kuttl
 image-build: $(foreach i,$(IMAGE_TARGET_LIST),image/$(i)) ## Build all images.
 
 # Convenience wrapper for building dependency base images.

changelog/fragments/10-mark-unsafe.yaml

@@ -0,0 +1,25 @@
+# entries is a list of entries to include in
+# release notes and/or the migration guide
+entries:
+  - description: >
+      markUnsafe now correctly marks as unsafe the spec extra variable.
+
+    # kind is one of:
+    # - addition
+    # - change
+    # - deprecation
+    # - removal
+    # - bugfix
+    kind: "bugfix"
+
+    # Is this a breaking change?
+    breaking: false
+
+    # NOTE: ONLY USE `pull_request_override` WHEN ADDING THIS
+    # FILE FOR A PREVIOUSLY MERGED PULL_REQUEST!
+    #
+    # The generator auto-detects the PR number from the commit
+    # message in which this file was originally added.
+    #
+    # What is the pull request number (without the "#")?
+    # pull_request_override: 0

changelog/generated/v1.29.0.md

@@ -0,0 +1,13 @@
+## v1.29.0
+
+### Changes
+
+- (scorecard): Update kuttl to v0.15.0 in the scorecard-test-kuttl image. ([#6401](https://github.com/operator-framework/operator-sdk/pull/6401))
+- (ansible/v1): Bump the golang base image version in the ansible-operator Dockerfiles from 1.18 to 1.19. ([#6398](https://github.com/operator-framework/operator-sdk/pull/6398))
+- (operator-sdk run bundle): Compress the bundle content, to avoid the configMap exceed max length error. The error will look like this: 
+`... ConfigMap ... is invalid: []: Too long: must have at most 1048576 bytes`.
+Fixes issue [#6323](https://github.com/operator-framework/operator-sdk/issues/6323). ([#6408](https://github.com/operator-framework/operator-sdk/pull/6408))
+
+### Bug Fixes
+
+- (docs): Update the go version in the developer guide.  The documentation wasn't updated when the go version was bumped to v1.19. ([#6101](https://github.com/operator-framework/operator-sdk/pull/6101))

go.mod

@@ -14,7 +14,7 @@ require (
 	github.com/onsi/ginkgo/v2 v2.7.0
 	github.com/onsi/gomega v1.24.2
 	github.com/operator-framework/api v0.17.4-0.20230223191600-0131a6301e42
-	github.com/operator-framework/helm-operator-plugins v0.0.12-0.20230307164205-6e30bde28688
+	github.com/operator-framework/helm-operator-plugins v0.0.12-0.20230413193425-4632388adc61
 	github.com/operator-framework/java-operator-plugins v0.7.1-0.20230306190439-0eed476d2b75
 	github.com/operator-framework/operator-lib v0.11.1-0.20230306195046-28cadc6b6055
 	github.com/operator-framework/operator-manifest-tools v0.2.3-0.20230227155221-caa8b9e1ab12

go.sum

@@ -807,8 +807,8 @@ github.com/opencontainers/selinux v1.8.2/go.mod h1:MUIHuUEvKB1wtJjQdOyYRgOnLD2xA
 github.com/openzipkin/zipkin-go v0.1.6/go.mod h1:QgAqvLzwWbR/WpD4A3cGpPtJrZXNIiJc5AZX7/PBEpw=
 github.com/operator-framework/api v0.17.4-0.20230223191600-0131a6301e42 h1:d/Pnr19TnmIq3zQ6ebewC+5jt5zqYbRkvYd37YZENQY=
 github.com/operator-framework/api v0.17.4-0.20230223191600-0131a6301e42/go.mod h1:l/cuwtPxkVUY7fzYgdust2m9tlmb8I4pOvbsUufRb24=
-github.com/operator-framework/helm-operator-plugins v0.0.12-0.20230307164205-6e30bde28688 h1:cT4lGfZjYupUkxzieyfC/7RadF7Vk1FybgWCnViutnM=
-github.com/operator-framework/helm-operator-plugins v0.0.12-0.20230307164205-6e30bde28688/go.mod h1:QpVyiSOKGbWADyNRl7LvMlRuuMGrWXJQdEYyHPQWMUg=
+github.com/operator-framework/helm-operator-plugins v0.0.12-0.20230413193425-4632388adc61 h1:FPO2hS4HNIU2pzWeX2KusKxqDFeGIURRMkxRtn/i570=
+github.com/operator-framework/helm-operator-plugins v0.0.12-0.20230413193425-4632388adc61/go.mod h1:QpVyiSOKGbWADyNRl7LvMlRuuMGrWXJQdEYyHPQWMUg=
 github.com/operator-framework/java-operator-plugins v0.7.1-0.20230306190439-0eed476d2b75 h1:mjMid39qs1lEXpIldVmj7sa1wtuZvYge8oHkT0qOY0Y=
 github.com/operator-framework/java-operator-plugins v0.7.1-0.20230306190439-0eed476d2b75/go.mod h1:oQTt35EEUrDY8ca/kRWYz5omWsVhk9Sj78vKlHFqxjM=
 github.com/operator-framework/operator-lib v0.11.1-0.20230306195046-28cadc6b6055 h1:G9N8wEf9qDZ/4Fj5cbIejKUoFOYta0v72Yg8tPAdvc0=

hack/check-links.sh

@@ -16,4 +16,4 @@ docker run --rm -v sdk-html:/target klakegg/html-proofer:3.18.8 /target \
   --http-status-ignore 429 \
   --allow_hash_href \
   --typhoeus '{"followlocation":true,"connecttimeout":600,"timeout":600}' \
-  --url-ignore "/github.com\/operator-framework\/operator-sdk\/edit\/master\//,https://docs.github.com/en/get-started/quickstart/fork-a-repo"
+  --url-ignore "/github.com\/operator-framework\/operator-sdk\/edit\/master\//,https://docs.github.com/en/get-started/quickstart/fork-a-repo,https://github.com/operator-framework/operator-sdk/settings/access"

hack/generate/samples/internal/go/memcached-with-customization/memcached_with_customization.go

@@ -144,6 +144,8 @@ func (mh *Memcached) Run() {
 		mh.uncommentManifestsKustomizationv3()
 	}
 
+	mh.customizingMain()
+
 	mh.implementingE2ETests()
 
 	cmd := exec.Command("go", "mod", "tidy")
@@ -480,7 +482,7 @@ func (mh *Memcached) implementingMonitoring() {
 	mh.customizingController()
 
 	log.Infof("customizing Main")
-	mh.customizingMain()
+	mh.customizingMainMonitoring()
 
 	log.Infof("customizing Dockerfile")
 	mh.customizingDockerfile()
@@ -784,10 +786,26 @@ func (mh *Memcached) customizingController() {
 	pkg.CheckError("adding metric incrementation", err)
 }
 
-// customizingMain will customize main.go to register metrics
+// customizingMain will add comments to main
 func (mh *Memcached) customizingMain() {
 	var mainPath string
 
+	if mh.isV3() {
+		mainPath = filepath.Join(mh.ctx.Dir, "main.go")
+	} else {
+		mainPath = filepath.Join(mh.ctx.Dir, "cmd", "main.go")
+	}
+
+	err := kbutil.InsertCode(mainPath,
+		"Scheme:   mgr.GetScheme(),",
+		mainRecorderFragment)
+	pkg.CheckError("adding recorder fragment", err)
+}
+
+// customizingMainMonitoring will customize main.go to register metrics
+func (mh *Memcached) customizingMainMonitoring() {
+	var mainPath string
+
 	marker := "\"github.com/example/memcached-operator/"
 	if mh.isV3() {
 		mainPath = filepath.Join(mh.ctx.Dir, "main.go")
@@ -1385,6 +1403,10 @@ const controllerPrometheusRuleFragment = `
 	memcached := &cachev1alpha1.Memcached{}
 	err = r.Get(ctx, req.NamespacedName, memcached)`
 
+const mainRecorderFragment = `
+// Add a Recorder to the reconciler.
+// This allows the operator author to emit events during reconcilliation.`
+
 const monitoringv1ImportFragment = `
 
 	monitoringv1 "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"

images/ansible-operator-2.11-preview/Dockerfile

@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM --platform=$BUILDPLATFORM golang:1.18 as builder
+FROM --platform=$BUILDPLATFORM golang:1.19 as builder
 ARG TARGETARCH
 
 WORKDIR /workspace

images/ansible-operator/Dockerfile

@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM --platform=$BUILDPLATFORM golang:1.18 as builder
+FROM --platform=$BUILDPLATFORM golang:1.19 as builder
 ARG TARGETARCH
 
 WORKDIR /workspace

images/scorecard-test-kuttl/Dockerfile

@@ -18,8 +18,8 @@ COPY . .
 RUN GOOS=linux GOARCH=$TARGETARCH make build/scorecard-test-kuttl
 
 # Final image.
-#FROM kudobuilder/kuttl@sha256:924a709a1d2c6bede8815415ea5d5be640b506ec5aeaddc68acb443ae8ee7926
-FROM kudobuilder/kuttl:v0.12.1
+#FROM kudobuilder/kuttl@sha256:8d4dad161521450db95f88fe0e62487cc6587c5818df2a4e750fb9e54c082170
+FROM kudobuilder/kuttl:v0.15.0
 
 ENV HOME=/opt/scorecard-test-kuttl \
     USER_NAME=scorecard-test-kuttl \
@@ -29,6 +29,8 @@ ENV HOME=/opt/scorecard-test-kuttl \
 RUN echo "${USER_NAME}:x:${USER_UID}:0:${USER_NAME} user:${HOME}:/sbin/nologin" >> /etc/passwd
 
 WORKDIR ${HOME}
+# kuttl writes a kubeconfig file in the current working directory
+RUN chmod g+w "${HOME}"
 
 COPY --from=builder /workspace/build/scorecard-test-kuttl /usr/local/bin/scorecard-test-kuttl
 COPY --from=builder /workspace/images/scorecard-test-kuttl/entrypoint /usr/local/bin/entrypoint

images/scorecard-test-kuttl/main.go

@@ -31,10 +31,10 @@ import (
 // scorecard v1alpha3.TestStatus json format.
 //
 // The kuttl output is expected to be produced by kubectl-kuttl
-// at /tmp/kuttl-test.json.
+// at /tmp/kuttl-report.json.
 func main() {
 
-	jsonFile, err := os.Open("/tmp/kuttl-test.json")
+	jsonFile, err := os.Open("/tmp/kuttl-report.json")
 	if err != nil {
 		printErrorStatus(fmt.Errorf("could not open kuttl report %v", err))
 		return

internal/ansible/handler/logging_enqueue_annotation_test.go

@@ -95,8 +95,7 @@ var _ = Describe("LoggingEnqueueRequestForAnnotation", func() {
 			}
 			repl.SetGroupVersionKind(schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "ReplicaSet"})
 
-			err := handler.SetOwnerAnnotations(podOwner, repl)
-			Expect(err).To(BeNil())
+			Expect(handler.SetOwnerAnnotations(podOwner, repl)).To(Succeed())
 
 			evt := event.CreateEvent{
 				Object: repl,
@@ -280,8 +279,7 @@ var _ = Describe("LoggingEnqueueRequestForAnnotation", func() {
 			newPod.Name = pod.Name + "2"
 			newPod.Namespace = pod.Namespace + "2"
 
-			err := handler.SetOwnerAnnotations(podOwner, pod)
-			Expect(err).To(BeNil())
+			Expect(handler.SetOwnerAnnotations(podOwner, pod)).To(Succeed())
 
 			evt := event.UpdateEvent{
 				ObjectOld: pod,
@@ -395,8 +393,7 @@ var _ = Describe("LoggingEnqueueRequestForAnnotation", func() {
 			newPod.Name = pod.Name + "2"
 			newPod.Namespace = pod.Namespace + "2"
 
-			err := handler.SetOwnerAnnotations(podOwner, pod)
-			Expect(err).To(BeNil())
+			Expect(handler.SetOwnerAnnotations(podOwner, pod)).To(Succeed())
 
 			var podOwner2 = &corev1.Pod{
 				ObjectMeta: metav1.ObjectMeta{
@@ -406,8 +403,7 @@ var _ = Describe("LoggingEnqueueRequestForAnnotation", func() {
 			}
 			podOwner2.SetGroupVersionKind(schema.GroupVersionKind{Group: "", Kind: "Pod"})
 
-			err = handler.SetOwnerAnnotations(podOwner2, newPod)
-			Expect(err).To(BeNil())
+			Expect(handler.SetOwnerAnnotations(podOwner2, newPod)).To(Succeed())
 
 			evt := event.UpdateEvent{
 				ObjectOld: pod,

internal/ansible/handler/logging_enqueue_object_test.go

@@ -76,7 +76,7 @@ var _ = Describe("LoggingEnqueueRequestForObject", func() {
 			// verify metrics
 			gauges, err := metrics.Registry.Gather()
 			Expect(err).NotTo(HaveOccurred())
-			Expect(len(gauges)).To(Equal(1))
+			Expect(gauges).To(HaveLen(1))
 			assertMetrics(gauges[0], 1, []*corev1.Pod{pod})
 		})
 	})
@@ -119,7 +119,7 @@ var _ = Describe("LoggingEnqueueRequestForObject", func() {
 				// verify metrics
 				gauges, err := metrics.Registry.Gather()
 				Expect(err).NotTo(HaveOccurred())
-				Expect(len(gauges)).To(Equal(0))
+				Expect(gauges).To(BeEmpty())
 			})
 		})
 		Context("when a gauge does not exist", func() {
@@ -148,7 +148,7 @@ var _ = Describe("LoggingEnqueueRequestForObject", func() {
 				// verify metrics
 				gauges, err := metrics.Registry.Gather()
 				Expect(err).NotTo(HaveOccurred())
-				Expect(len(gauges)).To(Equal(0))
+				Expect(gauges).To(BeEmpty())
 			})
 		})
 
@@ -187,36 +187,31 @@ var _ = Describe("LoggingEnqueueRequestForObject", func() {
 			// verify metrics
 			gauges, err := metrics.Registry.Gather()
 			Expect(err).NotTo(HaveOccurred())
-			Expect(len(gauges)).To(Equal(1))
+			Expect(gauges).To(HaveLen(1))
 			assertMetrics(gauges[0], 2, []*corev1.Pod{newpod, pod})
 		})
 	})
 })
 
 func assertMetrics(gauge *dto.MetricFamily, count int, pods []*corev1.Pod) {
-	// need variables to compare the pointers
-	name := "name"
-	namespace := "namespace"
-	g := "group"
-	v := "version"
-	k := "kind"
-
-	Expect(len(gauge.Metric)).To(Equal(count))
+	Expect(gauge.Metric).To(HaveLen(count))
 	for i := 0; i < count; i++ {
 		Expect(*gauge.Metric[i].Gauge.Value).To(Equal(float64(pods[i].GetObjectMeta().GetCreationTimestamp().UTC().Unix())))
 
 		for _, l := range gauge.Metric[i].Label {
-			switch l.Name {
-			case &name:
-				Expect(l.Value).To(Equal(pods[i].GetObjectMeta().GetName()))
-			case &namespace:
-				Expect(l.Value).To(Equal(pods[i].GetObjectMeta().GetNamespace()))
-			case &g:
-				Expect(l.Value).To(Equal(pods[i].GetObjectKind().GroupVersionKind().Group))
-			case &v:
-				Expect(l.Value).To(Equal(pods[i].GetObjectKind().GroupVersionKind().Version))
-			case &k:
-				Expect(l.Value).To(Equal(pods[i].GetObjectKind().GroupVersionKind().Kind))
+			if l.Name != nil {
+				switch *l.Name {
+				case "name":
+					Expect(l.Value).To(HaveValue(Equal(pods[i].GetObjectMeta().GetName())))
+				case "namespace":
+					Expect(l.Value).To(HaveValue(Equal(pods[i].GetObjectMeta().GetNamespace())))
+				case "group":
+					Expect(l.Value).To(HaveValue(Equal(pods[i].GetObjectKind().GroupVersionKind().Group)))
+				case "version":
+					Expect(l.Value).To(HaveValue(Equal(pods[i].GetObjectKind().GroupVersionKind().Version)))
+				case "kind":
+					Expect(l.Value).To(HaveValue(Equal(pods[i].GetObjectKind().GroupVersionKind().Kind)))
+				}
 			}
 		}
 	}

internal/ansible/proxy/inject_owner_test.go

@@ -112,7 +112,7 @@ var _ = Describe("injectOwnerReferenceHandler", func() {
 			}
 			ownerRefs := modifiedCM.ObjectMeta.OwnerReferences
 
-			Expect(len(ownerRefs)).To(Equal(1))
+			Expect(ownerRefs).To(HaveLen(1))
 
 			ownerRef := ownerRefs[0]
 

internal/ansible/runner/runner.go

@@ -366,6 +366,9 @@ func (r *runner) makeParameters(u *unstructured.Unstructured) map[string]interfa
 
 	specKey := fmt.Sprintf("%s_spec", objKey)
 	parameters[specKey] = spec
+	if r.markUnsafe {
+		parameters[specKey] = markUnsafe(spec)
+	}
 
 	for k, v := range r.Vars {
 		parameters[k] = v
@@ -391,7 +394,7 @@ func (r *runner) makeParameters(u *unstructured.Unstructured) map[string]interfa
 func markUnsafe(values interface{}) interface{} {
 	switch v := values.(type) {
 	case []interface{}:
-		var p []interface{}
+		p := make([]interface{}, 0)
 		for _, n := range v {
 			p = append(p, markUnsafe(n))
 		}

internal/cmd/ansible-operator/version/cmd_test.go

@@ -48,7 +48,7 @@ var _ = Describe("Running a version command", func() {
 				w.Close()
 			}()
 			stdout, err := io.ReadAll(r)
-			Expect(err).To(BeNil())
+			Expect(err).ToNot(HaveOccurred())
 			stdoutString := string(stdout)
 			version := ver.GitVersion
 			if version == "unknown" {

internal/cmd/helm-operator/version/cmd_test.go

@@ -48,7 +48,7 @@ var _ = Describe("Running a version command", func() {
 				w.Close()
 			}()
 			stdout, err := io.ReadAll(r)
-			Expect(err).To(BeNil())
+			Expect(err).ToNot(HaveOccurred())
 			stdoutString := string(stdout)
 			version := ver.GitVersion
 			if version == "unknown" {

internal/cmd/operator-sdk/bundle/cmd_test.go

@@ -26,7 +26,7 @@ var _ = Describe("Running a bundle command", func() {
 			Expect(cmd).NotTo(BeNil())
 
 			subcommands := cmd.Commands()
-			Expect(len(subcommands)).To(Equal(1))
+			Expect(subcommands).To(HaveLen(1))
 			Expect(subcommands[0].Use).To(Equal("validate"))
 		})
 	})