Merge pull request #34 from RedHatGov/bugfix/replace_travis

- Replace Travis with GitHub Actions.
- Update Operator SDK base to 1.4.2
- Some improvements to testing methodology
- Update to new osdk-manager
- Some Lint fixes
- Explicitly namespace modules in role

Author: jharmison-redhat

.github/workflows/test-and-release.yml

@@ -0,0 +1,76 @@
+name: Run Operator SDK tests, release new operator images if tests succeed
+
+on:
+  schedule:
+    - cron: '0 1 * * *' # everyday at 1am
+  push:
+    branches:
+      - develop
+      - main
+  pull_request:
+    branches:
+      - develop
+
+jobs:
+  test-cluster:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Kind
+        uses: engineerd/[email protected]
+        with:
+          config: molecule/kind-cluster/files/kind-config.yml
+          name: osdk-test
+          version: v0.9.0
+      - name: Prereq setup
+        run: hack/ci-setup.sh
+      - name: Test
+        run: hack/ci-test.sh kind-cluster
+
+  test-namespace:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Kind
+        uses: engineerd/[email protected]
+        with:
+          config: molecule/kind-cluster/files/kind-config.yml
+          name: osdk-test
+          version: v0.9.0
+      - name: Prereq setup
+        run: hack/ci-setup.sh
+      - name: Test
+        run: hack/ci-test.sh kind-namespace
+
+  release:
+    needs: [test-cluster, test-namespace]
+    if: >
+      github.event_name != 'pull_request' &&
+      (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Login to Quay
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v1
+        with:
+          registry: quay.io
+          username: ${{ secrets.QUAY_USERNAME }}
+          password: ${{ secrets.QUAY_PASSWORD }}
+      - name: Build, bundle, and push (develop)
+        run: |
+          hack/operate.sh --push-images --bundle --develop --verbose --formatter
+        if: github.ref == 'refs/heads/develop'
+      - name: Build, bundle, and push
+        run: |
+          hack/operate.sh --push-images --bundle --extra-tag=latest --verbose --formatter
+        if: github.ref == 'refs/heads/main'

.travis.yml

@@ -1,4 +1,4 @@
-FROM quay.io/operator-framework/ansible-operator:v1.0.0
+FROM quay.io/operator-framework/ansible-operator:v1.4.2
 
 COPY requirements.yml ${HOME}/requirements.yml
 RUN ansible-galaxy collection install -r ${HOME}/requirements.yml \

Dockerfile

@@ -1,16 +1,33 @@
-# Current Operator version
+# VERSION defines the project version for the bundle.
+# Update this value when you upgrade the version of your project.
+# To re-generate a bundle for another specific version without changing the standard setup, you can:
+# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
+# - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
 VERSION ?= 0.0.1
-# Default bundle image tag
-BUNDLE_IMG ?= controller-bundle:$(VERSION)
-# Options for 'bundle-build'
+
+# CHANNELS define the bundle channels used in the bundle.
+# Add a new line here if you would like to change its default config. (E.g CHANNELS = "preview,fast,stable")
+# To re-generate a bundle for other specific channels without changing the standard setup, you can:
+# - use the CHANNELS as arg of the bundle target (e.g make bundle CHANNELS=preview,fast,stable)
+# - use environment variables to overwrite this value (e.g export CHANNELS="preview,fast,stable")
 ifneq ($(origin CHANNELS), undefined)
 BUNDLE_CHANNELS := --channels=$(CHANNELS)
 endif
+
+# DEFAULT_CHANNEL defines the default channel used in the bundle.
+# Add a new line here if you would like to change its default config. (E.g DEFAULT_CHANNEL = "stable")
+# To re-generate a bundle for any other default channel without changing the default setup, you can:
+# - use the DEFAULT_CHANNEL as arg of the bundle target (e.g make bundle DEFAULT_CHANNEL=stable)
+# - use environment variables to overwrite this value (e.g export DEFAULT_CHANNEL="stable")
 ifneq ($(origin DEFAULT_CHANNEL), undefined)
 BUNDLE_DEFAULT_CHANNEL := --default-channel=$(DEFAULT_CHANNEL)
 endif
 BUNDLE_METADATA_OPTS ?= $(BUNDLE_CHANNELS) $(BUNDLE_DEFAULT_CHANNEL)
 
+# BUNDLE_IMG defines the image:tag used for the bundle.
+# You can use it as an arg. (E.g make bundle-build BUNDLE_IMG=<some-registry>/<project-name-bundle>:<tag>)
+BUNDLE_IMG ?= controller-bundle:$(VERSION)
+
 # Image URL to use all building/pushing image targets
 IMG ?= controller:latest
 
@@ -41,43 +58,49 @@ undeploy: kustomize
 
 # Build the docker image
 docker-build:
-	docker build . -t ${IMG}
+	docker build -t ${IMG} .
 
 # Push the docker image
 docker-push:
 	docker push ${IMG}
 
 PATH  := $(PATH):$(PWD)/bin
 SHELL := env PATH=$(PATH) /bin/sh
-OS    = $(shell uname -s | tr '[:upper:]' '[:lower:]')
-ARCH  = $(shell uname -m | sed 's/x86_64/amd64/')
-OSOPER   = $(shell uname -s | tr '[:upper:]' '[:lower:]' | sed 's/darwin/apple-darwin/' | sed 's/linux/linux-gnu/')
-ARCHOPER = $(shell uname -m )
+OS := $(shell uname -s | tr '[:upper:]' '[:lower:]')
+ARCH := $(shell uname -m | sed 's/x86_64/amd64/')
 
+# Download kustomize locally if necessary, preferring the $(pwd)/bin path over global if both exist.
+.PHONY: kustomize
+KUSTOMIZE = $(shell pwd)/bin/kustomize
 kustomize:
-ifeq (, $(shell which kustomize 2>/dev/null))
+ifeq (,$(wildcard $(KUSTOMIZE)))
+ifeq (,$(shell which kustomize 2>/dev/null))
 	@{ \
 	set -e ;\
-	mkdir -p bin ;\
-	curl -sSLo - https://github.com/kubernetes-sigs/kustomize/releases/download/kustomize/v3.5.4/kustomize_v3.5.4_$(OS)_$(ARCH).tar.gz | tar xzf - -C bin/ ;\
+	mkdir -p $(dir $(KUSTOMIZE)) ;\
+	curl -sSLo - https://github.com/kubernetes-sigs/kustomize/releases/download/kustomize/v3.5.4/kustomize_v3.5.4_$(OS)_$(ARCH).tar.gz | \
+	tar xzf - -C bin/ ;\
 	}
-KUSTOMIZE=$(realpath ./bin/kustomize)
 else
-KUSTOMIZE=$(shell which kustomize)
+KUSTOMIZE = $(shell which kustomize)
+endif
 endif
 
+# Download ansible-operator locally if necessary, preferring the $(pwd)/bin path over global if both exist.
+.PHONY: ansible-operator
+ANSIBLE_OPERATOR = $(shell pwd)/bin/ansible-operator
 ansible-operator:
-ifeq (, $(shell which ansible-operator 2>/dev/null))
+ifeq (,$(wildcard $(ANSIBLE_OPERATOR)))
+ifeq (,$(shell which ansible-operator 2>/dev/null))
 	@{ \
 	set -e ;\
-	mkdir -p bin ;\
-	curl -LO https://github.com/operator-framework/operator-sdk/releases/download/v1.0.0/ansible-operator-v1.0.0-$(ARCHOPER)-$(OSOPER) ;\
-	mv ansible-operator-v1.0.0-$(ARCHOPER)-$(OSOPER) ./bin/ansible-operator ;\
-	chmod +x ./bin/ansible-operator ;\
+	mkdir -p $(dir $(ANSIBLE_OPERATOR)) ;\
+	curl -sSLo $(ANSIBLE_OPERATOR) https://github.com/operator-framework/operator-sdk/releases/download/v1.4.2/ansible-operator_$(OS)_$(ARCH) ;\
+	chmod +x $(ANSIBLE_OPERATOR) ;\
 	}
-ANSIBLE_OPERATOR=$(realpath ./bin/ansible-operator)
 else
-ANSIBLE_OPERATOR=$(shell which ansible-operator)
+ANSIBLE_OPERATOR = $(shell which ansible-operator)
+endif
 endif
 
 # Generate bundle manifests and metadata, then validate generated files.

Makefile

@@ -6,3 +6,6 @@ resources:
   kind: Gitea
   version: v1alpha1
 version: 3-alpha
+plugins:
+  manifests.sdk.operatorframework.io/v2: {}
+  scorecard.sdk.operatorframework.io/v2: {}

PROJECT

@@ -23,15 +23,29 @@ spec:
         control-plane: controller-manager
     spec:
       containers:
-        - name: manager
-          args:
-            - "--enable-leader-election"
-            - "--leader-election-id=gitea-operator"
-          image: controller:latest
-          env:
-          - name: WATCH_NAMESPACE
-            valueFrom:
-              fieldRef:
-                fieldPath: metadata.annotations['olm.targetNamespaces']
+      - name: manager
+        args:
+        - "--enable-leader-election"
+        - "--leader-election-id=gitea-operator"
+        image: controller:latest
+        env:
+        - name: ANSIBLE_GATHERING
+          value: explicit
+        - name: WATCH_NAMESPACE
+          valueFrom:
+            fieldRef:
+              fieldPath: metadata.annotations['olm.targetNamespaces']
+        livenessProbe:
+          httpGet:
+            path: /readyz
+            port: 6789
+          initialDelaySeconds: 15
+          periodSeconds: 20
+        readinessProbe:
+          httpGet:
+            path: /healthz
+            port: 6789
+          initialDelaySeconds: 5
+          periodSeconds: 10
       terminationGracePeriodSeconds: 10
       serviceAccountName: gitea-operator-sa

config/manager/manager.yaml

@@ -4,7 +4,7 @@
     entrypoint:
     - scorecard-test
     - basic-check-spec
-    image: quay.io/operator-framework/scorecard-test:master
+    image: quay.io/operator-framework/scorecard-test:v1.4.2
     labels:
       suite: basic
       test: basic-check-spec-test

config/scorecard/patches/basic.config.yaml

@@ -4,7 +4,7 @@
     entrypoint:
     - scorecard-test
     - olm-bundle-validation
-    image: quay.io/operator-framework/scorecard-test:master
+    image: quay.io/operator-framework/scorecard-test:v1.4.2
     labels:
       suite: olm
       test: olm-bundle-validation-test
@@ -14,7 +14,7 @@
     entrypoint:
     - scorecard-test
     - olm-crds-have-validation
-    image: quay.io/operator-framework/scorecard-test:master
+    image: quay.io/operator-framework/scorecard-test:v1.4.2
     labels:
       suite: olm
       test: olm-crds-have-validation-test
@@ -24,7 +24,7 @@
     entrypoint:
     - scorecard-test
     - olm-crds-have-resources
-    image: quay.io/operator-framework/scorecard-test:master
+    image: quay.io/operator-framework/scorecard-test:v1.4.2
     labels:
       suite: olm
       test: olm-crds-have-resources-test
@@ -34,7 +34,7 @@
     entrypoint:
     - scorecard-test
     - olm-spec-descriptors
-    image: quay.io/operator-framework/scorecard-test:master
+    image: quay.io/operator-framework/scorecard-test:v1.4.2
     labels:
       suite: olm
       test: olm-spec-descriptors-test
@@ -44,7 +44,7 @@
     entrypoint:
     - scorecard-test
     - olm-status-descriptors
-    image: quay.io/operator-framework/scorecard-test:master
+    image: quay.io/operator-framework/scorecard-test:v1.4.2
     labels:
       suite: olm
       test: olm-status-descriptors-test

config/scorecard/patches/olm.config.yaml

@@ -0,0 +1,25 @@
+#!/bin/bash -ex
+# Installs dependencies needed to run the tests in CI environment
+
+
+mkdir -p $HOME/.local/bin
+export PATH="$HOME/.local/bin:$PATH"
+export KUBECONFIG=$HOME/.kube/config
+
+# Basic pip prereqs
+pip3 install --user --upgrade setuptools wheel pip
+
+# Dependencies for test environment
+pip3 install --user docker==4.2.2 ansible molecule ansible-lint yamllint flake8 openshift jmespath
+
+# Ansible dependencies
+ansible-galaxy collection install -r requirements.yml
+
+# Kind CLI (for loading images into cluster)
+curl -Lo $HOME/.local/bin/kind https://kind.sigs.k8s.io/dl/v0.9.0/kind-linux-amd64
+chmod +x $HOME/.local/bin/kind
+
+# Helm CLI (for loading Ingress)
+curl -Lo $HOME/helm.tgz https://get.helm.sh/helm-v3.5.2-linux-amd64.tar.gz
+tar xvzf $HOME/helm.tgz -C $HOME/.local/bin --strip-components 1 linux-amd64/helm
+helm repo add stable https://charts.helm.sh/stable

hack/ci-setup.sh

@@ -0,0 +1,10 @@
+#!/bin/bash -ex
+# Exports correct environment for the CI system (relies on ci-setup.sh) and runs requested tests
+
+export KUBECONFIG=$HOME/.kube/config
+export PATH="$HOME/.local/bin:$PATH"
+export OPERATORDIR="$(pwd)"
+make kustomize
+[ -f ./bin/kustomize ] && export KUSTOMIZE_PATH="$(realpath ./bin/kustomize)" || export KUSTOMIZE_PATH="$(which kustomize)"
+
+TEST_OPERATOR_NAMESPACE=default molecule test -s $1