Merge pull request #509 from bcgov/feat/qa-environment

Add QA Workflows
bcgov · Jul 4, 2024 · 4f9f51f · 4f9f51f
2 parents f9d4449 + 1f9299e
commit 4f9f51f
Show file tree

Hide file tree

Showing 16 changed files with 557 additions and 110 deletions.
diff --git a/.github/workflows/codeql-analysis.yaml b/.github/workflows/codeql-analysis.yaml
@@ -26,7 +26,7 @@ on:
 jobs:
   analyze:
     name: Analyze
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     permissions:
       actions: read
       contents: read

diff --git a/.github/workflows/deploy-to-openshift-backend-dev.yml b/.github/workflows/deploy-to-openshift-backend-dev.yml
@@ -25,7 +25,8 @@ env:
   REPO_NAME: "educ-ccof"
   #grabs the branch name from github dynamically
   BRANCH: ${{ github.ref_name }}
-  APP_NAME_BACKEND: "backend"
+  IMAGE_NAME: "backend"
+  APP_ENVIRONMENT: "dev"
   APP_FOLDER: "backend"
   NAMESPACE: ${{ secrets.CCOF_NAMESPACE_NO_ENV }}
   NAMESPACE_TOOLS: ${{ secrets.CCOF_NAMESPACE_NO_ENV }}-tools
@@ -47,7 +48,7 @@ on:
 jobs:
   openshift-ci-cd:
     name: Build and deploy Backend to DEV
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     environment: dev
 
     outputs:
@@ -109,7 +110,7 @@ jobs:
         id: build-image-backend
         uses: redhat-actions/buildah-build@v2
         with:
-          image: ${{ env.APP_NAME_BACKEND }}
+          image: ${{ env.IMAGE_NAME }}
           tags: "latest"
 
           # If you don't have a Dockerfile/Containerfile, refer to https://github.com/redhat-actions/buildah-build#scratch-build-inputs
@@ -133,7 +134,7 @@ jobs:
       - name: Install oc
         uses: redhat-actions/openshift-tools-installer@v1
         with:
-          oc: 4
+          oc: 4.16
 
         # https://github.com/redhat-actions/oc-login#readme
       #    - uses: actions/checkout@v2
@@ -144,27 +145,48 @@ jobs:
           oc login --token=${{ env.OPENSHIFT_TOKEN }} --server=${{ env.OPENSHIFT_SERVER }}
           oc project ${{ env.OPENSHIFT_NAMESPACE }}
           # Cancel any rollouts in progress
-          oc rollout cancel dc/${{ env.APP_NAME }}-${{ env.APP_NAME_BACKEND }} 2> /dev/null \
-          || true && echo "No rollout in progress"
+          oc rollout cancel dc/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }} 2> /dev/null \
+              || true && echo "No rollout in progress"
 
           # Create the image stream if it doesn't exist
-          oc create imagestream ${{ env.REPO_NAME }}-${{ env.APP_NAME_BACKEND }}-${{ env.BRANCH }} 2> /dev/null || true && echo "Backend image stream in place"
+          oc create imagestream ${{ env.REPO_NAME }}-${{ env.IMAGE_NAME }}-${{ env.BRANCH }} 2> /dev/null || true && echo "Backend image stream in place"
 
-          oc tag ${{ steps.push-image-backend.outputs.registry-path }} ${{ env.REPO_NAME }}-${{ env.APP_NAME_BACKEND }}-${{ env.BRANCH }}:${{ env.TAG }}
+          oc tag \
+             ${{ steps.push-image-backend.outputs.registry-path }} \
+             ${{ env.REPO_NAME }}-${{ env.IMAGE_NAME }}-${{ env.BRANCH }}:${{ env.TAG }}
 
           # Process and apply deployment template
-          oc process -f tools/openshift/backend.dc.yaml -p APP_NAME=${{ env.APP_NAME }} -p REPO_NAME=${{ env.REPO_NAME }} -p BRANCH=${{ env.BRANCH }} -p NAMESPACE=${{ env.OPENSHIFT_NAMESPACE }} -p TAG=${{ env.TAG }} -p MIN_REPLICAS=${{ env.MIN_REPLICAS }} -p MAX_REPLICAS=${{ env.MAX_REPLICAS }} -p MIN_CPU=${{ env.MIN_CPU }} -p MAX_CPU=${{ env.MAX_CPU }} -p MIN_MEM=${{ env.MIN_MEM }} -p MAX_MEM=${{ env.MAX_MEM }} -p HOST_ROUTE=${{ env.HOST_ROUTE }}\
-          | oc apply -f -
+          oc process \
+             -f tools/openshift/backend.dc.yaml \
+             -p APP_NAME=${{ env.APP_NAME }} \
+             -p REPO_NAME=${{ env.REPO_NAME }} \
+             -p BRANCH=${{ env.BRANCH }} \
+             -p NAMESPACE=${{ env.OPENSHIFT_NAMESPACE }} \
+             -p TAG=${{ env.TAG }} \
+             -p MIN_REPLICAS=${{ env.MIN_REPLICAS }} \
+             -p MAX_REPLICAS=${{ env.MAX_REPLICAS }} \
+             -p MIN_CPU=${{ env.MIN_CPU }} \
+             -p MAX_CPU=${{ env.MAX_CPU }} \
+             -p MIN_MEM=${{ env.MIN_MEM }} \
+             -p MAX_MEM=${{ env.MAX_MEM }} \
+             -p HOST_ROUTE=${{ env.HOST_ROUTE }} \
+             -p APP_ENVIRONMENT=${{ env.APP_ENVIRONMENT }} \
+              | oc apply -f -
 
           # Process update-configmap
-          curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/update-configmap.sh | bash /dev/stdin dev ${{ env.APP_NAME }} ${{ env.NAMESPACE }} ${{ env.SPLUNK_TOKEN }}
+          curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/update-configmap.sh \
+              | bash /dev/stdin \
+                     dev \
+                     ${{ env.APP_NAME }} \
+                     ${{ env.NAMESPACE }} \
+                     ${{ env.SPLUNK_TOKEN }}
 
           # Start rollout (if necessary) and follow it
-          oc rollout latest dc/${{ env.APP_NAME }}-${{ env.APP_NAME_BACKEND }} 2> /dev/null \
-          || true && echo "Rollout in progress"
+          oc rollout latest dc/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }} 2> /dev/null \
+              || true && echo "Rollout in progress"
 
           # Get status, returns 0 if rollout is successful
-          oc rollout status dc/${{ env.APP_NAME }}-${{ env.APP_NAME_BACKEND }}
+          oc rollout status dc/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }}
 
     # - name: ZAP Scan
     #   uses: zaproxy/[email protected]

diff --git a/.github/workflows/deploy-to-openshift-backend-prod.yml b/.github/workflows/deploy-to-openshift-backend-prod.yml
@@ -1,4 +1,4 @@
-name: 9 PROD - Deploy Backend
+name: 4 PROD - Deploy Backend
 
 env:
   # 🖊️ EDIT your repository secrets to log into your OpenShift cluster and set up the context.
@@ -24,7 +24,8 @@ env:
   REPO_NAME: "educ-ccof"
   #grabs the branch name from github dynamically
   BRANCH: ${{ github.ref_name }}
-  APP_NAME_BACKEND: "backend"
+  IMAGE_NAME: "backend"
+  APP_ENVIRONMENT: "prod"
 
 
   NAMESPACE: ${{ secrets.CCOF_NAMESPACE_NO_ENV }}
@@ -48,8 +49,8 @@ on:
 
 jobs:
   openshift-ci-cd:
-    name: Deploy  Backend to PROD
-    runs-on: ubuntu-latest
+    name: Deploy Backend to PROD
+    runs-on: ubuntu-24.04
     environment: prod
 
     outputs:
@@ -107,7 +108,7 @@ jobs:
     - name: Install oc
       uses: redhat-actions/openshift-tools-installer@v1
       with:
-        oc: 4
+        oc: 4.16
 
     - name: Deploy
       run: |
@@ -116,25 +117,46 @@ jobs:
         oc login --token=${{ env.OPENSHIFT_TOKEN }} --server=${{ env.OPENSHIFT_SERVER }}
         oc project ${{ env.OPENSHIFT_NAMESPACE }}
         # Cancel any rollouts in progress
-        oc rollout cancel dc/${{ env.APP_NAME }}-${{ env.APP_NAME_BACKEND }} 2> /dev/null \
-        || true && echo "No rollout in progress"
+        oc rollout cancel dc/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }} 2> /dev/null \
+            || true && echo "No rollout in progress"
 
         # Create tag for PROD env from DEV env image
-        oc tag ${{ env.NAMESPACE }}-dev/${{ env.REPO_NAME }}-${{ env.APP_NAME_BACKEND }}-${{ env.BRANCH }}:${{ steps.get-latest-tag.outputs.tag }} ${{ env.NAMESPACE }}-prod/${{ env.REPO_NAME }}-${{ env.APP_NAME_BACKEND }}-${{ env.BRANCH }}:${{ steps.get-latest-tag.outputs.tag }}
+        oc tag \
+           ${{ env.NAMESPACE }}-dev/${{ env.REPO_NAME }}-${{ env.IMAGE_NAME }}-${{ env.BRANCH }}:${{ steps.get-latest-tag.outputs.tag }} \
+           ${{ env.NAMESPACE }}-prod/${{ env.REPO_NAME }}-${{ env.IMAGE_NAME }}-${{ env.BRANCH }}:${{ steps.get-latest-tag.outputs.tag }}
 
         # Process and apply deployment template
-        oc process -f tools/openshift/backend.dc.yaml -p APP_NAME=${{ env.APP_NAME }} -p REPO_NAME=${{ env.REPO_NAME }} -p BRANCH=${{ env.BRANCH }} -p NAMESPACE=${{ env.OPENSHIFT_NAMESPACE }} -p TAG=${{ steps.get-latest-tag.outputs.tag }} -p MIN_REPLICAS=${{ env.MIN_REPLICAS }} -p MAX_REPLICAS=${{ env.MAX_REPLICAS }} -p MIN_CPU=${{ env.MIN_CPU }} -p MAX_CPU=${{ env.MAX_CPU }} -p MIN_MEM=${{ env.MIN_MEM }} -p MAX_MEM=${{ env.MAX_MEM }} -p HOST_ROUTE=${{ env.HOST_ROUTE }}\
-        | oc apply -f -
+        oc process \
+           -f tools/openshift/backend.dc.yaml \
+           -p APP_NAME=${{ env.APP_NAME }} \
+           -p REPO_NAME=${{ env.REPO_NAME }} \
+           -p BRANCH=${{ env.BRANCH }} \
+           -p NAMESPACE=${{ env.OPENSHIFT_NAMESPACE }} \
+           -p TAG=${{ steps.get-latest-tag.outputs.tag }} \
+           -p MIN_REPLICAS=${{ env.MIN_REPLICAS }} \
+           -p MAX_REPLICAS=${{ env.MAX_REPLICAS }} \
+           -p MIN_CPU=${{ env.MIN_CPU }} \
+           -p MAX_CPU=${{ env.MAX_CPU }} \
+           -p MIN_MEM=${{ env.MIN_MEM }} \
+           -p MAX_MEM=${{ env.MAX_MEM }} \
+           -p HOST_ROUTE=${{ env.HOST_ROUTE }}\
+           -p APP_ENVIRONMENT=${{ env.APP_ENVIRONMENT }} \
+            | oc apply -f -
 
         # Process update-configmap
-        curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/update-configmap.sh | bash /dev/stdin prod ${{ env.APP_NAME }} ${{ env.NAMESPACE }} ${{ env.SPLUNK_TOKEN }}
+        curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/update-configmap.sh \
+            | bash /dev/stdin \
+                   prod \
+                   ${{ env.APP_NAME }} \
+                   ${{ env.NAMESPACE }} \
+                   ${{ env.SPLUNK_TOKEN }}
 
         # Start rollout (if necessary) and follow it
-        oc rollout latest dc/${{ env.APP_NAME }}-${{ env.APP_NAME_BACKEND }} 2> /dev/null \
-        || true && echo "Rollout in progress"
+        oc rollout latest dc/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }} 2> /dev/null \
+            || true && echo "Rollout in progress"
 
         # Get status, returns 0 if rollout is successful
-        oc rollout status dc/${{ env.APP_NAME }}-${{ env.APP_NAME_BACKEND }}
+        oc rollout status dc/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }}
 
     - name: ZAP Scan
       uses: zaproxy/[email protected]

diff --git a/.github/workflows/deploy-to-openshift-backend-qa.yml b/.github/workflows/deploy-to-openshift-backend-qa.yml
@@ -0,0 +1,160 @@
+name: 2 QA - Deploy Backend
+
+env:
+  # 🖊️ EDIT your repository secrets to log into your OpenShift cluster and set up the context.
+  # See https://github.com/redhat-actions/oc-login#readme for how to retrieve these values.
+  # To get a permanent token, refer to https://github.com/redhat-actions/oc-login/wiki/Using-a-Service-Account-for-GitHub-Actions
+  OPENSHIFT_SERVER: ${{ secrets.OPENSHIFT_SERVER }}
+  OPENSHIFT_TOKEN: ${{ secrets.OPENSHIFT_TOKEN }}
+  # 🖊️ EDIT to set the kube context's namespace after login. Leave blank to use your user's default namespace.
+  OPENSHIFT_NAMESPACE: ${{ secrets.CCOF_NAMESPACE_NO_ENV }}-test
+
+  SPLUNK_TOKEN: ${{ secrets.SPLUNK_TOKEN }}
+
+    # 🖊️ EDIT to change the image registry settings.
+  # Registries such as GHCR, Quay.io, and Docker Hub are supported.
+  IMAGE_REGISTRY: ghcr.io/${{ github.repository_owner }}
+  IMAGE_REGISTRY_USER: ${{ github.actor }}
+  IMAGE_REGISTRY_PASSWORD: ${{ github.token }}
+
+  DOCKER_ARTIFACTORY_REPO: artifacts.developer.gov.bc.ca/docker-remote
+  ARTIFACTORY_REPO: artifacts.developer.gov.bc.ca
+
+  APP_NAME: 'ccof'
+  REPO_NAME: "educ-ccof"
+  #grabs the branch name from github dynamically
+  BRANCH: ${{ github.ref_name }}
+  IMAGE_NAME: "backend"
+  APP_ENVIRONMENT: "qa"
+
+  NAMESPACE: ${{ secrets.CCOF_NAMESPACE_NO_ENV }}
+
+  MIN_REPLICAS: "3"
+  MAX_REPLICAS: "5"
+  MIN_CPU: "50m"
+  MAX_CPU: "250m"
+  MIN_MEM: "200Mi"
+  MAX_MEM: "700Mi"
+  # SITE_URL should have no scheme or port. It will be prepended with https://
+  HOST_ROUTE: ${{ secrets.SITE_URL }}
+  CA_CERT: ${{ secrets.CA_CERT }}
+  CERTIFICATE: ${{ secrets.CERTIFICATE }}
+  PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
+
+on:
+  workflow_dispatch:
+
+jobs:
+  openshift-ci-cd:
+    name: Deploy Backend to QA
+    runs-on: ubuntu-24.04
+    environment: qa
+
+    outputs:
+      ROUTE: ${{ steps.deploy-and-expose.outputs.route }}
+      SELECTOR: ${{ steps.deploy-and-expose.outputs.selector }}
+
+    steps:
+    - name: Check for required secrets
+      uses: actions/github-script@v4
+      with:
+        script: |
+          const secrets = {
+            OPENSHIFT_SERVER: `${{ secrets.OPENSHIFT_SERVER }}`,
+            OPENSHIFT_TOKEN: `${{ secrets.OPENSHIFT_TOKEN }}`,
+          };
+
+          const GHCR = "ghcr.io";
+          if (`${{ env.IMAGE_REGISTRY }}`.startsWith(GHCR)) {
+            core.info(`Image registry is ${GHCR} - no registry password required`);
+          }
+          else {
+            core.info("A registry password is required");
+            secrets["IMAGE_REGISTRY_PASSWORD"] = `${{ secrets.IMAGE_REGISTRY_PASSWORD }}`;
+          }
+
+          const missingSecrets = Object.entries(secrets).filter(([ name, value ]) => {
+            if (value.length === 0) {
+              core.error(`Secret "${name}" is not set`);
+              return true;
+            }
+            core.info(`✔️ Secret "${name}" is set`);
+            return false;
+          });
+
+          if (missingSecrets.length > 0) {
+            core.setFailed(`❌ At least one required secret is not set in the repository. \n` +
+              "You can add it using:\n" +
+              "GitHub UI: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository \n" +
+              "GitHub CLI: https://cli.github.com/manual/gh_secret_set \n" +
+              "Also, refer to https://github.com/redhat-actions/oc-login#getting-started-with-the-action-or-see-example");
+          }
+          else {
+            core.info(`✅ All the required secrets are set`);
+          }
+
+    - name: Check out repository
+      uses: actions/checkout@v2
+      with:
+        ref: ${{ env.BRANCH }}
+
+    - name: Get latest tag
+      uses: actions-ecosystem/action-get-latest-tag@v1
+      id: get-latest-tag
+
+    - name: Install oc
+      uses: redhat-actions/openshift-tools-installer@v1
+      with:
+        oc: 4.16
+
+    - name: Deploy
+      run: |
+        set -eux
+        # Login to OpenShift and select project
+        oc login --token=${{ env.OPENSHIFT_TOKEN }} --server=${{ env.OPENSHIFT_SERVER }}
+        oc project ${{ env.OPENSHIFT_NAMESPACE }}
+        # Cancel any rollouts in progress
+        oc rollout cancel dc/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }} 2> /dev/null \
+            || true && echo "No rollout in progress"
+
+        # Create tag for TEST env from DEV env image
+        oc tag \
+           ${{ env.NAMESPACE }}-dev/${{ env.REPO_NAME }}-${{ env.IMAGE_NAME }}-${{ env.BRANCH }}:${{ steps.get-latest-tag.outputs.tag }} \
+           ${{ env.NAMESPACE }}-qa/${{ env.REPO_NAME }}-${{ env.IMAGE_NAME }}-${{ env.BRANCH }}:${{ steps.get-latest-tag.outputs.tag }}
+
+        # Process and apply deployment template
+        oc process \
+           -f tools/openshift/backend.dc.yaml \
+           -p APP_NAME=${{ env.APP_NAME }} \
+           -p REPO_NAME=${{ env.REPO_NAME }} \
+           -p BRANCH=${{ env.BRANCH }} \
+           -p NAMESPACE=${{ env.OPENSHIFT_NAMESPACE }} \
+           -p TAG=${{ steps.get-latest-tag.outputs.tag }} \
+           -p MIN_REPLICAS=${{ env.MIN_REPLICAS }} \
+           -p MAX_REPLICAS=${{ env.MAX_REPLICAS }} \
+           -p MIN_CPU=${{ env.MIN_CPU }} \
+           -p MAX_CPU=${{ env.MAX_CPU }} \
+           -p MIN_MEM=${{ env.MIN_MEM }} \
+           -p MAX_MEM=${{ env.MAX_MEM }} \
+           -p HOST_ROUTE=${{ env.HOST_ROUTE }} \
+           -p APP_ENVIRONMENT=${{ env.APP_ENVIRONMENT }} \
+            | oc apply -f -
+
+        # Process update-configmap
+        curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/update-configmap.sh \
+            | bash /dev/stdin \
+                   qa ${{ env.APP_NAME }} \
+                   ${{ env.NAMESPACE }} \
+                   ${{ env.SPLUNK_TOKEN }}
+
+        # Start rollout (if necessary) and follow it
+        oc rollout latest dc/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }}} 2> /dev/null \
+            || true && echo "Rollout in progress"
+
+        # Get status, returns 0 if rollout is successful
+        oc rollout status dc/${{ env.APP_NAME }}-${{ env.IMAGE_NAME }}-${{ env.APP_ENVIRONMENT }}
+
+    - name: ZAP Scan
+      uses: zaproxy/[email protected]
+      with:
+        target: 'https://${{ env.HOST_ROUTE }}/api'