Few verification tests with GitHub Actions workflow

.env

@@ -0,0 +1,30 @@
+BROKER_NAME=activemq-artemis
+BUNDLE_PACKAGE=$BROKER_NAME
+
+TARGET_IMAGE=$BROKER_NAME-operator-bundle
+
+REGISTRY=quay.io/artemiscloud_scratch
+
+VERSION="0.15"
+ARCHITECTURE="amd64"
+
+BROKER=$BROKER_NAME-openshift-image
+BROKER_VERSION=2.13
+BROKER_IMAGE=$REGISTRY/$BROKER:$BROKER_VERSION
+
+OPERATOR=$BROKER_NAME-operator
+OPERATOR_VERSION=0.15.0
+OPERATOR_IMAGE=$REGISTRY/$OPERATOR:$OPERATOR_VERSION
+OPERATOR_PACKAGE=$BROKER_NAME
+
+GROUP=broker.amq.io
+NAME="artemiscloud/$BROKER_NAME-operator-bundle"
+DESCRIPTION="ActiveMQ Artemis $BROKER_VERSION Operator Bundle"
+SUMMARY=$DESCRIPTION
+
+REDHAT_OPENSHIFT_VERSION="v4.5"
+REDHAT_COMPONENT="activemq-artemis-operator-bundle-container"
+OPENSHIFT_TAGS="messaging,artemis,integration,operator,golang"
+
+K8S_DISPLAY_NAME=$DESCRIPTION
+K8S_DESCRIPTION="An associated operator bundle of metadata."

.github/workflows/master.yml

@@ -0,0 +1,29 @@
+name: 'PR/Push to master'
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: |
+          sudo curl -L https://github.com/aelsabbahy/goss/releases/latest/download/goss-linux-amd64 -o /usr/local/bin/goss
+          sudo chmod +rx /usr/local/bin/goss
+
+      - name: Build the image
+        run: "make all-ci"
+
+      - uses: actions/upload-artifact@v2
+        with:
+          name: Test results (JUnit)
+          path: validate_results.junit.xml

Makefile

@@ -0,0 +1,34 @@
+#!make
+
+SHELL := /bin/sh -x
+
+all: clean build prepare-image-check validate
+verify-image: clean pull prepare-image-check validate
+
+all-ci: clean build prepare-image-check validate-ci
+verify-image-ci: clean prepare-image-check validate-ci
+
+build:
+	@set -a; . ./.env; \
+	docker build . -f bundle.Dockerfile -t $${TARGET_IMAGE}
+
+pull:
+	@set -a; . ./.env; \
+	docker pull $${TARGET_IMAGE}
+
+prepare-image-check:
+	@set -a; . ./.env; \
+	tests/scripts/prepare.sh $${TARGET_IMAGE}
+
+validate:
+	@set -a; . ./.env; \
+	goss validate
+
+validate-ci:
+	@set -a; . ./.env; \
+	goss validate --format documentation --format-options verbose; \
+	goss validate --format junit --format-options verbose > validate_results.junit.xml; \
+	tests/scripts/junit.sh validate_results.junit.xml
+
+clean:
+	@rm -rf tests/verify

goss.yaml

@@ -0,0 +1,44 @@
+file:
+  tests/verify/layer/manifests/{{getEnv "OPERATOR"}}.v{{getEnv "OPERATOR_VERSION"}}.clusterserviceversion.yaml:
+    exists: true
+    contains:
+      - {{getEnv "BROKER_IMAGE"}}
+      - 'containerImage: {{getEnv "OPERATOR_IMAGE"}}'
+      - 'operated-by: {{getEnv "OPERATOR"}}.v{{getEnv "OPERATOR_VERSION"}}'
+  tests/verify/layer/manifests/broker_activemqartemis_crd.yaml:
+    exists: true
+    contains:
+      - 'name: activemqartemises.{{getEnv "GROUP"}}'
+      - 'group: {{getEnv "GROUP"}}'
+  tests/verify/layer/manifests/broker_activemqartemisaddress_crd.yaml:
+    exists: true
+    contains:
+      - 'name: activemqartemisaddresses.{{getEnv "GROUP"}}'
+  tests/verify/layer/manifests/broker_activemqartemisscaledown_crd.yaml:
+    exists: true
+    contains:
+      - 'name: activemqartemisscaledowns.{{getEnv "GROUP"}}'
+  tests/verify/layer/metadata/annotations.yaml:
+    exists: true
+    contains:
+      - 'operators.operatorframework.io.bundle.package.v1: {{getEnv "BROKER_NAME"}}'
+  tests/verify/image/config.json:
+    exists: true
+    contains:
+      - '"architecture":"{{getEnv "ARCHITECTURE"}}"'
+      - '"com.redhat.component":"{{getEnv "REDHAT_COMPONENT"}}"'
+      - '"com.redhat.delivery.operator.bundle":"true"'
+      - '"com.redhat.openshift.versions":"{{getEnv "REDHAT_OPENSHIFT_VERSION"}}"'
+      - '"description":"{{getEnv "DESCRIPTION"}}"'
+      - '"io.k8s.description":"{{getEnv "K8S_DESCRIPTION"}}"'
+      - '"io.k8s.display-name":"{{getEnv "K8S_DISPLAY_NAME"}}"'
+      - '"io.openshift.tags":"{{getEnv "OPENSHIFT_TAGS"}}"'
+      - '"name":"{{getEnv "NAME"}}"'
+      - '"operators.operatorframework.io.bundle.channel.default.v1":"current"'
+      - '"operators.operatorframework.io.bundle.channels.v1":"current"'
+      - '"operators.operatorframework.io.bundle.manifests.v1":"manifests/"'
+      - '"operators.operatorframework.io.bundle.mediatype.v1":"registry+v1"'
+      - '"operators.operatorframework.io.bundle.metadata.v1":"metadata/"'
+      - '"operators.operatorframework.io.bundle.package.v1":"{{getEnv "BUNDLE_PACKAGE"}}"'
+      - '"summary":"{{getEnv "SUMMARY"}}"'
+      - '"version":"{{getEnv "VERSION"}}"'

tests/README.md

@@ -0,0 +1,43 @@
+# Testing bundle images
+
+## Dependency
+
+- [goss](https://github.com/aelsabbahy/goss)
+
+## Configuration
+
+1. Check all variables in [/bundle.env](../blob/master/.env)
+2. Tests are located in [/goss.yaml](../blob/master/goss.yaml)
+3. For running test check first also [/Makefile](../blob/master/Makefile)
+
+## Run tests
+
+By passing this command at the command line:
+
+```shell
+make all
+```
+
+1. Build the image
+2. Unpack image
+3. Unpacked files from image is tested by goss
+
+## Add test
+
+### Files
+
+All files related to the image will be available under `/tests/verify/`
+
+Start with `make all` to get these files.
+
+Now you can add more test by running [goss](https://github.com/aelsabbahy/goss). `goss add --help`
+
+Or by editing [/goss.yaml](../blob/master/goss.yaml) file.
+
+## Validate existing image
+
+Make sure [/bundle.env](../blob/master/.env) `TARGET_IMAGE=activemq-artemis-operator-bundle`
+
+```shell
+make verify-image
+```

tests/scripts/junit.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+sed -i -e 's/tests\/verify\/layer//g' $1

tests/scripts/prepare.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+mkdir -p tests/verify/{image,layer}
+docker save $1 > tests/verify/image.tar
+tar -xf tests/verify/image.tar -C tests/verify/image
+find tests/verify/image -type f -name "layer.tar" -exec tar -xf {} -C tests/verify/layer \;
+find tests/verify/layer -type f -name ".wh..wh..opq" -delete
+
+# Predicable image config name
+CONFIG_FILE="tests/verify/image/$(grep -o '"Config":"[^"]*' tests/verify/image/manifest.json | grep -o '[^"]*$')"
+cp $CONFIG_FILE tests/verify/image/pre_config.json
+
+# Encode unicode chars
+echo -e $(cat tests/verify/image/pre_config.json) > tests/verify/image/config.json
+rm tests/verify/image/pre_config.json