Refactor approach

Author: dlzhry2nhs

.github/workflows/continuous-deployment.yml

@@ -6,46 +6,57 @@ on:
       - master
 
 jobs:
-  deploy-internal-dev:
+  deploy-internal-dev-backend:
     uses: ./.github/workflows/deploy-backend.yml
     with:
       apigee_environment: internal-dev
       create_mns_subscription: true
       environment: dev
       sub_environment: internal-dev
+
+  run-internal-dev-sandbox-tests:
+    # Technically the first step is not a pre-requisite - sandbox backed deployment is handled by APIM
+    # Stipulating this condition simply makes it more likely the environment will be ready when tests are invoked
+    needs: [deploy-internal-dev-backend]
+    uses: ./.github/workflows/run-e2e-tests.yml
+    with:
+      apigee_environment: internal-dev-sandbox
+      environment: dev
+      sub_environment: internal-dev-sandbox
     secrets:
       APIGEE_PASSWORD: ${{ secrets.APIGEE_PASSWORD }}
       APIGEE_BASIC_AUTH_TOKEN: ${{ secrets.APIGEE_BASIC_AUTH_TOKEN }}
       APIGEE_OTP_KEY: ${{ secrets.APIGEE_OTP_KEY }}
       STATUS_API_KEY: ${{ secrets.STATUS_API_KEY }}
 
-  deploy-internal-dev-sandbox:
-    uses: ./.github/workflows/deploy-backend.yml
+  run-sandbox-tests:
+    needs: [run-internal-dev-sandbox-tests]
+    uses: ./.github/workflows/run-e2e-tests.yml
     with:
-      apigee_environment: internal-dev-sandbox
+      apigee_environment: sandbox
       environment: dev
-      sub_environment: internal-dev-sandbox
+      sub_environment: sandbox
     secrets:
       APIGEE_PASSWORD: ${{ secrets.APIGEE_PASSWORD }}
       APIGEE_BASIC_AUTH_TOKEN: ${{ secrets.APIGEE_BASIC_AUTH_TOKEN }}
       APIGEE_OTP_KEY: ${{ secrets.APIGEE_OTP_KEY }}
       STATUS_API_KEY: ${{ secrets.STATUS_API_KEY }}
 
-  deploy-sandbox:
-    needs: [deploy-internal-dev-sandbox]
-    uses: ./.github/workflows/deploy-backend.yml
+  run-internal-dev-tests:
+    needs: [deploy-internal-dev-backend]
+    uses: ./.github/workflows/run-e2e-tests.yml
     with:
-      apigee_environment: sandbox
+      apigee_environment: internal-dev
       environment: dev
-      sub_environment: sandbox
+      sub_environment: internal-dev
     secrets:
       APIGEE_PASSWORD: ${{ secrets.APIGEE_PASSWORD }}
       APIGEE_BASIC_AUTH_TOKEN: ${{ secrets.APIGEE_BASIC_AUTH_TOKEN }}
       APIGEE_OTP_KEY: ${{ secrets.APIGEE_OTP_KEY }}
       STATUS_API_KEY: ${{ secrets.STATUS_API_KEY }}
 
   deploy-higher-dev-envs:
-    needs: [deploy-internal-dev]
+    needs: [run-internal-dev-tests]
     strategy:
       matrix:
         sub_environment_name: [ref, int]
@@ -55,6 +66,17 @@ jobs:
       create_mns_subscription: true
       environment: dev
       sub_environment: ${{ matrix.sub_environment_name }}
+
+  run-higher-dev-env-tests:
+    needs: [deploy-higher-dev-envs]
+    strategy:
+      matrix:
+        sub_environment_name: [ref, int]
+    uses: ./.github/workflows/run-e2e-tests.yml
+    with:
+      apigee_environment: ${{ matrix.sub_environment_name }}
+      environment: dev
+      sub_environment: ${{ matrix.sub_environment_name }}
     secrets:
       APIGEE_PASSWORD: ${{ secrets.APIGEE_PASSWORD }}
       APIGEE_BASIC_AUTH_TOKEN: ${{ secrets.APIGEE_BASIC_AUTH_TOKEN }}

.github/workflows/deploy-backend.yml

@@ -32,13 +32,11 @@ on:
         description: Select the Apigee proxy environment
         options:
           - internal-dev
-          - internal-dev-sandbox
-          - sandbox
           - int
           - ref
           - prod
       create_mns_subscription:
-        description: Create an MNS Subscription. Only available in dev
+        description: Create an MNS Subscription programatically. Only available in AWS dev
         required: false
         type: boolean
         default: true
@@ -64,7 +62,6 @@ permissions:
 
 jobs:
   terraform-plan:
-    if: ${{ !(inputs.apigee_environment == 'internal-dev-sandbox' || inputs.apigee_environment == 'sandbox') }}
     runs-on: ubuntu-latest
     environment:
       name: ${{ inputs.environment }}
@@ -98,7 +95,6 @@ jobs:
           path: terraform/tfplan
 
   terraform-apply:
-    if: ${{ !(inputs.apigee_environment == 'internal-dev-sandbox' || inputs.apigee_environment == 'sandbox') }}
     needs: terraform-plan
     runs-on: ubuntu-latest
     environment:
@@ -155,17 +151,3 @@ jobs:
           poetry install --no-root
           echo "Subscribing SQS to MNS for notifications..."
           make subscribe
-
-  run-e2e-tests:
-    needs: [terraform-apply]
-    if: ${{ needs.terraform-apply.result == 'success' && needs.terraform-apply.result == null }}
-    uses: ./.github/workflows/run-e2e-tests.yml
-    with:
-      apigee_environment: ${{ inputs.apigee_environment }}
-      environment: ${{ inputs.environment }}
-      sub_environment: ${{ inputs.sub_environment }}
-    secrets:
-      APIGEE_PASSWORD: ${{ secrets.APIGEE_PASSWORD }}
-      APIGEE_BASIC_AUTH_TOKEN: ${{ secrets.APIGEE_BASIC_AUTH_TOKEN }}
-      APIGEE_OTP_KEY: ${{ secrets.APIGEE_OTP_KEY }}
-      STATUS_API_KEY: ${{ secrets.STATUS_API_KEY }}

.github/workflows/pr-deploy-and-test.yml

@@ -5,14 +5,22 @@ on:
     types: [opened, synchronize, reopened]
 
 jobs:
-  deploy-pr-envs:
+  deploy-pr-backend:
+    uses: ./.github/workflows/deploy-backend.yml
+    with:
+      apigee_environment: internal-dev
+      create_mns_subscription: true
+      environment: dev
+      sub_environment: pr-${{github.event.pull_request.number}}
+
+  run-e2e-tests:
+    needs: [deploy-pr-backend]
     strategy:
       matrix:
         apigee_environment_name: [internal-dev, internal-dev-sandbox]
-    uses: ./.github/workflows/deploy-backend.yml
+    uses: ./.github/workflows/run-e2e-tests.yml
     with:
       apigee_environment: ${{ matrix.apigee_environment_name }}
-      create_mns_subscription: true
       environment: dev
       sub_environment: pr-${{github.event.pull_request.number}}
     secrets: