feat: Build and run e2e after PR is added to merge queue. (#190)

# Description

This PR enhances the CI/CD pipeline by integrating end-to-end (E2E)
tests on Azure Kubernetes Service (AKS) after a PR has been reviewed and
initially approved. This update allows PRs from forks to undergo E2E
testing after receiving initial approval.

The updated workflow is as follows:

For a successful E2E run:

1. Open PR
2. Unit tests, build, and lints are executed
3. A maintainer approves the PR
4. The PR is added to the merge queue
5. E2E tests are run
6. If E2E tests pass, the PR is merged into the main branch

For a failing E2E run:

1. Open PR
2. Unit tests, build, and lints are executed
3. A maintainer approves the PR
4. The PR is added to the merge queue
5. E2E tests are run
6. If E2E tests fail, the PR is removed from the queue
7. The developer is notified of the failure and can fix the issue

![image](https://github.com/microsoft/retina/assets/2801007/afbd7053-3e42-40e7-9f51-2a93c109444a)


Testing.

- Successful merge: [Merge queue test by jimassa · Pull Request #188 ·
microsoft/retina
(github.com)](#188)
Mergequue Run : [Build images and run E2E tests. ·
49ed7df
(github.com)](https://github.com/microsoft/retina/actions/runs/8480556009)

- Unsuccessful merge: [Merge queue test fail by jimassa · Pull Request
#189 · microsoft/retina
(github.com)](#189)

## Related Issue

If this pull request is related to any issue, please mention it here.
Additionally, make sure that the issue is assigned to you before
submitting this pull request.

## Checklist

- [x] I have read the [contributing
documantation](https://retina.sh/docs/contributing).
- [x] I signed and signed-off the commits (`git commit -S -s ...`)
- [x] I have correctly attributed the author(s) of the code.
- [x] I have tested the changes locally.
- [x] I have followed the project's style guidelines.
- [x] I have updated the documentation, if necessary.
- [x] I have added tests, if applicable.

## Screenshots (if applicable)

Please add any relevant screenshots or GIFs to showcase the changes
made.

## Additional Notes

Add any additional notes or context about the pull request here.

---

Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more
information on how to contribute to this project.

---------

Signed-off-by: Jacques Massa <[email protected]>

Author: jimassa

.github/workflows/codeql.yaml

@@ -1,12 +1,14 @@
 name: "CodeQL"
 on:
+  merge_group:
   workflow_dispatch:
   push:
     branches: [ main ]
   pull_request:
     branches: [ main ]
 jobs:
   analyze:
+    if: ${{ github.event_name != 'merge_group' }}
     name: Analyze
     strategy:
       fail-fast: false

.github/workflows/commit-message.yaml

@@ -1,5 +1,6 @@
 name: commit-message
 on:
+  merge_group:
   pull_request:
     branches: [ main ]
     types:
@@ -9,6 +10,7 @@ on:
       - reopened
 jobs:
   commit-message:
+    if: ${{ github.event_name != 'merge_group' }}
     runs-on: ubuntu-20.04
     steps:
     - name: verify_commit_message

.github/workflows/docs.yaml

@@ -4,6 +4,7 @@ on:
   push:
     branches: ["main"]
   workflow_dispatch:
+  merge_group:
 permissions:
   contents: read
   pages: write
@@ -13,6 +14,7 @@ concurrency:
   cancel-in-progress: false
 jobs:
   deploy:
+    if: ${{ github.event_name != 'merge_group' }}
     environment:
       name: retina.sh 
       url: ${{ steps.deployment.outputs.page_url }}

.github/workflows/golangci-lint.yaml

@@ -1,12 +1,14 @@
 name: golangci-lint
 on:
+  merge_group:
   workflow_dispatch:
   push:
     branches: [main]
   pull_request:
     branches: [main]
 jobs:
   golangci:
+    if: ${{ github.event_name != 'merge_group' }}
     strategy:
       fail-fast: false
       matrix:

.github/workflows/images.yaml

@@ -1,8 +1,11 @@
-name: Build Retina Container Images
+name: Build images and run E2E tests. 
 
 on:
   pull_request:
     branches: [main]
+  merge_group:
+    types: [checks_requested]
+  workflow_dispatch:
 
 permissions:
   contents: read
@@ -29,14 +32,32 @@ jobs:
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
 
+      - name: Az CLI login
+        uses: azure/login@v1
+        if: ${{ github.event_name == 'merge_group' }}
+        with:
+          creds: ${{ secrets.AZURE_CREDENTIALS }}
+
       - name: Build Images
         shell: bash
         run: |
           set -euo pipefail
           echo "TAG=$(make version)" >> $GITHUB_ENV
-          make retina-image \
-            IMAGE_NAMESPACE=${{ github.repository }} \
-            PLATFORM=${{ matrix.platform }}/${{ matrix.arch }}
+          if [ "$IS_MERGE_GROUP" == "true" ]; then
+            az acr login -n ${{ vars.ACR_NAME }} 
+            make retina-image \
+              IMAGE_NAMESPACE=${{ github.repository }} \
+              PLATFORM=${{ matrix.platform }}/${{ matrix.arch }} \
+              IMAGE_REGISTRY=${{ vars.ACR_NAME }}  \
+              BUILDX_ACTION=--push
+          else
+            make retina-image \
+              IMAGE_NAMESPACE=${{ github.repository }} \
+              PLATFORM=${{ matrix.platform }}/${{ matrix.arch }}
+          fi
+        env:
+          IS_MERGE_GROUP: ${{ github.event_name == 'merge_group' }}
+
 
   retina-win-images:
     name: Build Agent Windows Images
@@ -58,15 +79,32 @@ jobs:
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
-
+      
+      - name: Az CLI login
+        uses: azure/login@v1
+        if: ${{ github.event_name == 'merge_group' }}
+        with:
+          creds: ${{ secrets.AZURE_CREDENTIALS }}
+        
       - name: Build Images
         shell: bash
         run: |
           set -euo pipefail
           echo "TAG=$(make version)" >> $GITHUB_ENV
-          make retina-image-win \
-            IMAGE_NAMESPACE=${{ github.repository }} \
-            PLATFORM=${{ matrix.platform }}/${{ matrix.arch }}
+          if [ "$IS_MERGE_GROUP" == "true" ]; then
+            az acr login -n ${{ vars.ACR_NAME }} 
+            make retina-image-win \
+              IMAGE_NAMESPACE=${{ github.repository }} \
+              PLATFORM=${{ matrix.platform }}/${{ matrix.arch }} \
+              IMAGE_REGISTRY=${{ vars.ACR_NAME }}  \
+              BUILDX_ACTION=--push
+          else
+            make retina-image-win \
+              IMAGE_NAMESPACE=${{ github.repository }} \
+              PLATFORM=${{ matrix.platform }}/${{ matrix.arch }}
+          fi
+        env:
+          IS_MERGE_GROUP: ${{ github.event_name == 'merge_group' }}
 
   operator-images:
     name: Build Operator Images
@@ -89,11 +127,91 @@ jobs:
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
 
+      - name: Az CLI login
+        uses: azure/login@v1
+        if: ${{ github.event_name == 'merge_group' }}
+        with:
+          creds: ${{ secrets.AZURE_CREDENTIALS }}
+        
       - name: Build Images
         shell: bash
         run: |
           set -euo pipefail
           echo "TAG=$(make version)" >> $GITHUB_ENV
-          make retina-operator-image \
-            IMAGE_NAMESPACE=${{ github.repository }} \
-            PLATFORM=${{ matrix.platform }}/${{ matrix.arch }}
+          if [ "$IS_MERGE_GROUP" == "true" ]; then
+            az acr login -n ${{ vars.ACR_NAME }} 
+            make retina-operator-image \
+              IMAGE_NAMESPACE=${{ github.repository }} \
+              PLATFORM=${{ matrix.platform }}/${{ matrix.arch }} \
+              IMAGE_REGISTRY=${{ vars.ACR_NAME }} \
+              BUILDX_ACTION=--push
+          else
+            make retina-operator-image \
+              IMAGE_NAMESPACE=${{ github.repository }} \
+              PLATFORM=${{ matrix.platform }}/${{ matrix.arch }}
+          fi
+        env:
+          IS_MERGE_GROUP: ${{ github.event_name == 'merge_group' }}
+
+  manifests:
+    if: ${{ github.event_name == 'merge_group' }}
+    name: Generate Manifests
+    runs-on: ubuntu-latest
+    needs: [retina-images, retina-win-images, operator-images]
+
+    strategy:
+      matrix:
+        components: ["retina", "operator"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup QEMU
+        uses: docker/setup-qemu-action@v3
+      
+      - name: Azure CLI login
+        uses: azure/login@v1
+        with:
+          creds: ${{ secrets.AZURE_CREDENTIALS }}
+
+      - name: Generate Manifests
+        shell: bash
+        run: |
+          set -euo pipefail
+          az acr login -n ${{ vars.ACR_NAME }}  
+          make manifest COMPONENT=${{ matrix.components }} \
+          IMAGE_REGISTRY=${{ vars.ACR_NAME }}  \
+      
+  e2e:
+    if: ${{ github.event_name == 'merge_group' }}
+    name: Run E2E Tests
+    runs-on: ubuntu-latest
+    needs: [manifests]
+
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup go
+        uses: actions/setup-go@v4
+        with:
+          go-version: ">=1.21.0"
+      - run: go version
+
+      - name: Az CLI login
+        uses: azure/login@v1
+        if: ${{ github.event_name == 'merge_group' }}
+        with:
+          creds: ${{ secrets.AZURE_CREDENTIALS }}
+
+      - name: Run E2E Tests
+        shell: bash
+        run: |
+          set -euo pipefail
+          export AZURE_SUBSCRIPTION_ID=${{ secrets.AZURE_SUBSCRIPTION }}
+          go test -v ./test/e2e/scenarios/retina/*.go -timeout 30m -tags=e2e -count=1  -args -image-tag=$(make version) -image-registry=${{ vars.ACR_NAME }}  -image-namespace=${{ github.repository}}