test-e2e/ansible : using samples (#4142)

**Description of the change:**
 Use Memcached sample instead of re-generate the project.

**Motivation for the change:**

operator-framework/enhancements#47

Author: camilamacedo86

hack/generate/samples/internal/ansible/constants.go

@@ -23,6 +23,8 @@ const roleFragment = `
       metadata:
         name: '{{ ansible_operator_meta.name }}-memcached'
         namespace: '{{ ansible_operator_meta.namespace }}'
+        labels:
+          app: memcached
       spec:
         replicas: "{{size}}"
         selector:
@@ -44,6 +46,11 @@ const roleFragment = `
               image: "docker.io/memcached:1.4.36-alpine"
               ports:
                 - containerPort: 11211
+              readinessProbe:
+                tcpSocket:
+                  port: 11211
+                initialDelaySeconds: 3
+                periodSeconds: 3
 `
 
 const defaultsFragment = `size: 1`
@@ -296,43 +303,6 @@ const molecuTaskToCheckConfigMap = `
 `
 
 const memcachedWithBlackListTask = `
-- name: start memcached
-  community.kubernetes.k8s:
-    definition:
-      kind: Deployment
-      apiVersion: apps/v1
-      metadata:
-        name: '{{ ansible_operator_meta.name }}-memcached'
-        namespace: '{{ ansible_operator_meta.namespace }}'
-        labels:
-          app: memcached
-      spec:
-        replicas: "{{size}}"
-        selector:
-          matchLabels:
-            app: memcached
-        template:
-          metadata:
-            labels:
-              app: memcached
-          spec:
-            containers:
-            - name: memcached
-              command:
-              - memcached
-              - -m=64
-              - -o
-              - modern
-              - -v
-              image: "docker.io/memcached:1.4.36-alpine"
-              ports:
-                - containerPort: 11211
-              readinessProbe:
-                tcpSocket:
-                  port: 11211
-                initialDelaySeconds: 3
-                periodSeconds: 3
-
 - operator_sdk.util.k8s_status:
     api_version: cache.example.com/v1alpha1
     kind: Memcached

hack/generate/samples/internal/ansible/molecule.go

@@ -85,7 +85,7 @@ func (ma *MoleculeAnsible) Run() {
 	pkg.CheckError("replacing in role.yml", err)
 
 	log.Infof("adding Memcached mock task to the role with black list")
-	err = testutils.ReplaceInFile(filepath.Join(ma.ctx.Dir, "roles", strings.ToLower(ma.ctx.Kind), "tasks", "main.yml"),
+	err = kbtestutils.InsertCode(filepath.Join(ma.ctx.Dir, "roles", strings.ToLower(ma.ctx.Kind), "tasks", "main.yml"),
 		roleFragment, memcachedWithBlackListTask)
 	pkg.CheckError("replacing in tasks/main.yml", err)
 

test/e2e-ansible/e2e_ansible_cluster_test.go

@@ -34,9 +34,12 @@ var _ = Describe("Running ansible projects", func() {
 	var fooSampleFile string
 	var memfinSampleFile string
 	var memcachedDeployment string
+	var metricsClusterRoleBindingName string
 
 	Context("built with operator-sdk", func() {
 		BeforeEach(func() {
+			metricsClusterRoleBindingName = fmt.Sprintf("%s-metrics-reader", tc.ProjectName)
+
 			By("checking samples")
 			memcachedSampleFile = filepath.Join(tc.Dir, "config", "samples",
 				fmt.Sprintf("%s_%s_%s.yaml", tc.Group, tc.Version, strings.ToLower(tc.Kind)))
@@ -45,11 +48,6 @@ var _ = Describe("Running ansible projects", func() {
 			memfinSampleFile = filepath.Join(tc.Dir, "config", "samples",
 				fmt.Sprintf("%s_%s_memfin.yaml", tc.Group, tc.Version))
 
-			By("enabling Prometheus via the kustomization.yaml")
-			Expect(kbtestutils.UncommentCode(
-				filepath.Join(tc.Dir, "config", "default", "kustomization.yaml"),
-				"#- ../prometheus", "#")).To(Succeed())
-
 			By("deploying project on the cluster")
 			err := tc.Make("deploy", "IMG="+tc.ImageName)
 			Expect(err).NotTo(HaveOccurred())
@@ -65,7 +63,7 @@ var _ = Describe("Running ansible projects", func() {
 
 			By("cleaning up permissions")
 			_, _ = tc.Kubectl.Command("delete", "clusterrolebinding",
-				fmt.Sprintf("metrics-%s", tc.TestSuffix))
+				metricsClusterRoleBindingName)
 
 			By("undeploy project")
 			_ = tc.Make("undeploy")
@@ -122,14 +120,14 @@ var _ = Describe("Running ansible projects", func() {
 			_, err := tc.Kubectl.Get(
 				true,
 				"ServiceMonitor",
-				fmt.Sprintf("e2e-%s-controller-manager-metrics-monitor", tc.TestSuffix))
+				fmt.Sprintf("%s-controller-manager-metrics-monitor", tc.ProjectName))
 			Expect(err).NotTo(HaveOccurred())
 
 			By("ensuring the created metrics Service for the manager")
 			_, err = tc.Kubectl.Get(
 				true,
 				"Service",
-				fmt.Sprintf("e2e-%s-controller-manager-metrics-service", tc.TestSuffix))
+				fmt.Sprintf("%s-controller-manager-metrics-service", tc.ProjectName))
 			Expect(err).NotTo(HaveOccurred())
 
 			By("create custom resource (Memcached CR)")
@@ -263,9 +261,8 @@ var _ = Describe("Running ansible projects", func() {
 			By("granting permissions to access the metrics and read the token")
 			_, err = tc.Kubectl.Command(
 				"create",
-				"clusterrolebinding",
-				fmt.Sprintf("metrics-%s", tc.TestSuffix),
-				fmt.Sprintf("--clusterrole=e2e-%s-metrics-reader", tc.TestSuffix),
+				"clusterrolebinding", metricsClusterRoleBindingName,
+				fmt.Sprintf("--clusterrole=%s-metrics-reader", tc.ProjectName),
 				fmt.Sprintf("--serviceaccount=%s:default", tc.Kubectl.Namespace))
 			Expect(err).NotTo(HaveOccurred())
 
@@ -286,8 +283,8 @@ var _ = Describe("Running ansible projects", func() {
 			cmdOpts := []string{
 				"run", "--generator=run-pod/v1", "curl", "--image=curlimages/curl:7.68.0", "--restart=OnFailure", "--",
 				"curl", "-v", "-k", "-H", fmt.Sprintf(`Authorization: Bearer %s`, token),
-				fmt.Sprintf("https://e2e-%v-controller-manager-metrics-service.e2e-%v-system.svc:8443/metrics",
-					tc.TestSuffix, tc.TestSuffix),
+				fmt.Sprintf("https://%s-controller-manager-metrics-service.%s.svc:8443/metrics",
+					tc.ProjectName, tc.Kubectl.Namespace),
 			}
 			_, err = tc.Kubectl.CommandInNamespace(cmdOpts...)
 			Expect(err).NotTo(HaveOccurred())

test/e2e-ansible/e2e_ansible_olm_test.go

@@ -26,12 +26,8 @@ var _ = Describe("Integrating ansible Projects with OLM", func() {
 		const operatorVersion = "0.0.1"
 
 		It("should generate and run a valid OLM bundle and packagemanifests", func() {
-			By("turning off interactive prompts for all generation tasks.")
-			err := tc.DisableOLMBundleInteractiveMode()
-			Expect(err).NotTo(HaveOccurred())
-
 			By("building the bundle")
-			err = tc.Make("bundle", "IMG="+tc.ImageName)
+			err := tc.Make("bundle", "IMG="+tc.ImageName)
 			Expect(err).NotTo(HaveOccurred())
 
 			By("building the operator bundle image")

test/e2e-ansible/e2e_ansible_suite_test.go

@@ -16,10 +16,13 @@ package e2e_ansible_test
 
 import (
 	"fmt"
+	"os/exec"
 	"path/filepath"
 	"strings"
 	"testing"
 
+	kbtestutils "sigs.k8s.io/kubebuilder/test/e2e/utils"
+
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 
@@ -47,8 +50,15 @@ var _ = BeforeSuite(func() {
 	tc, err = testutils.NewTestContext(testutils.BinaryName, "GO111MODULE=on")
 	Expect(err).NotTo(HaveOccurred())
 
-	By("creating the repository")
-	Expect(tc.Prepare()).To(Succeed())
+	tc.Domain = "example.com"
+	tc.Version = "v1alpha1"
+	tc.Group = "cache"
+	tc.Kind = "Memcached"
+	tc.ProjectName = "memcached-operator"
+	tc.Kubectl.Namespace = fmt.Sprintf("%s-system", tc.ProjectName)
+
+	By("copying sample to a temporary e2e directory")
+	Expect(exec.Command("cp", "-r", "../../testdata/ansible/memcached-operator", tc.Dir).Run()).To(Succeed())
 
 	By("fetching the current-context")
 	tc.Kubectx, err = tc.Kubectl.Command("config", "current-context")
@@ -57,50 +67,17 @@ var _ = BeforeSuite(func() {
 	By("preparing the prerequisites on cluster")
 	tc.InstallPrerequisites()
 
-	By("setting domain and GVK")
-	tc.Domain = "example.com"
-	tc.Version = "v1alpha1"
-	tc.Group = "ansible"
-	tc.Kind = "Memcached"
-
-	By("initializing a ansible project")
-	err = tc.Init(
-		"--plugins", "ansible",
-		"--project-version", "3-alpha",
-		"--domain", tc.Domain)
-	Expect(err).NotTo(HaveOccurred())
-
 	By("using dev image for scorecard-test")
 	err = tc.ReplaceScorecardImagesForDev()
 	Expect(err).NotTo(HaveOccurred())
 
-	By("creating the Memcached API")
-	err = tc.CreateAPI(
-		"--group", tc.Group,
-		"--version", tc.Version,
-		"--kind", tc.Kind,
-		"--generate-playbook",
-		"--generate-role")
-	Expect(err).NotTo(HaveOccurred())
-
 	By("replacing project Dockerfile to use ansible base image with the dev tag")
 	err = testutils.ReplaceRegexInFile(filepath.Join(tc.Dir, "Dockerfile"), "quay.io/operator-framework/ansible-operator:.*", "quay.io/operator-framework/ansible-operator:dev")
 	Expect(err).Should(Succeed())
 
 	By("adding Memcached mock task to the role")
-	err = testutils.ReplaceInFile(filepath.Join(tc.Dir, "roles", strings.ToLower(tc.Kind), "tasks", "main.yml"),
-		fmt.Sprintf("# tasks file for %s", tc.Kind), memcachedWithBlackListTask)
-	Expect(err).NotTo(HaveOccurred())
-
-	By("setting defaults to Memcached")
-	err = testutils.ReplaceInFile(filepath.Join(tc.Dir, "roles", strings.ToLower(tc.Kind), "defaults", "main.yml"),
-		fmt.Sprintf("# defaults file for %s", tc.Kind), "size: 1")
-	Expect(err).NotTo(HaveOccurred())
-
-	By("updating Memcached sample")
-	memcachedSampleFile := filepath.Join(tc.Dir, "config", "samples",
-		fmt.Sprintf("%s_%s_%s.yaml", tc.Group, tc.Version, strings.ToLower(tc.Kind)))
-	err = testutils.ReplaceInFile(memcachedSampleFile, "foo: bar", "size: 1")
+	err = kbtestutils.InsertCode(filepath.Join(tc.Dir, "roles", strings.ToLower(tc.Kind), "tasks", "main.yml"),
+		"periodSeconds: 3", memcachedWithBlackListTask)
 	Expect(err).NotTo(HaveOccurred())
 
 	By("creating an API definition to add a task to delete the config map")
@@ -134,15 +111,6 @@ var _ = BeforeSuite(func() {
 		"# +kubebuilder:scaffold:rules", rolesForBaseOperator)
 	Expect(err).NotTo(HaveOccurred())
 
-	By("turning off interactive prompts for all generation tasks.")
-	replace := "operator-sdk generate kustomize manifests"
-	err = testutils.ReplaceInFile(filepath.Join(tc.Dir, "Makefile"), replace, replace+" --interactive=false")
-	Expect(err).NotTo(HaveOccurred())
-
-	By("checking the kustomize setup")
-	err = tc.Make("kustomize")
-	Expect(err).NotTo(HaveOccurred())
-
 	By("building the project image")
 	err = tc.Make("docker-build", "IMG="+tc.ImageName)
 	Expect(err).NotTo(HaveOccurred())
@@ -168,45 +136,10 @@ var _ = AfterSuite(func() {
 	tc.Destroy()
 })
 
-const memcachedWithBlackListTask = `- name: start memcached
-  community.kubernetes.k8s:
-    definition:
-      kind: Deployment
-      apiVersion: apps/v1
-      metadata:
-        name: '{{ ansible_operator_meta.name }}-memcached'
-        namespace: '{{ ansible_operator_meta.namespace }}'
-        labels:
-          app: memcached
-      spec:
-        replicas: "{{size}}"
-        selector:
-          matchLabels:
-            app: memcached
-        template:
-          metadata:
-            labels:
-              app: memcached
-          spec:
-            containers:
-            - name: memcached
-              command:
-              - memcached
-              - -m=64
-              - -o
-              - modern
-              - -v
-              image: "docker.io/memcached:1.4.36-alpine"
-              ports:
-                - containerPort: 11211
-              readinessProbe:
-                tcpSocket:
-                  port: 11211
-                initialDelaySeconds: 3
-                periodSeconds: 3
+const memcachedWithBlackListTask = `
 
 - operator_sdk.util.k8s_status:
-    api_version: ansible.example.com/v1alpha1
+    api_version: cache.example.com/v1alpha1
     kind: Memcached
     name: "{{ ansible_operator_meta.name }}"
     namespace: "{{ ansible_operator_meta.namespace }}"
@@ -257,7 +190,7 @@ const taskToDeleteConfigMap = `- name: delete configmap for test
 
 const memcachedWatchCustomizations = `playbook: playbooks/memcached.yml
   finalizer:
-    name: finalizer.ansible.example.com
+    name: finalizer.cache.example.com
     role: memfin
   blacklist:
     - group: ""

testdata/ansible/memcached-operator/roles/memcached/tasks/main.yml

@@ -8,6 +8,8 @@
       metadata:
         name: '{{ ansible_operator_meta.name }}-memcached'
         namespace: '{{ ansible_operator_meta.namespace }}'
+        labels:
+          app: memcached
       spec:
         replicas: "{{size}}"
         selector:
@@ -29,4 +31,9 @@
               image: "docker.io/memcached:1.4.36-alpine"
               ports:
                 - containerPort: 11211
+              readinessProbe:
+                tcpSocket:
+                  port: 11211
+                initialDelaySeconds: 3
+                periodSeconds: 3