.github: Use devcontainer to run integration UI tests

Author: TeddyAndrieux

.github/workflows/pre-merge.yaml

@@ -358,32 +358,31 @@ jobs:
         run: poetry run pytest -vv
 
   build_integration_container_nginx:
-    needs: changed-files
+    runs-on: ubuntu-latest
+    needs:
+      - build-devcontainer
+      - changed-files
+    container:
+      image: ghcr.io/${{ github.repository }}/devcontainer:${{ github.sha }}
+      # We have to use `root` for the moment
+      # Sees: https://github.com/actions/checkout/issues/1575
+      # Could work with a user with 1001 id but not for docker
+      options: --user root
+      credentials:
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    defaults:
+      run:
+        shell: bash
     if: needs.changed-files.outputs.integration-tests-ui == 'true'
-    runs-on: ubuntu-20.04
     permissions: write-all
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Set safe directory (since container is root and not user 1001)
+        run: git config --global --add safe.directory $GITHUB_WORKSPACE
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
-      - name: Install node
-        uses: actions/setup-node@v4
-        with:
-          node-version: "20"
-      - name: Cache node modules
-        id: cache-npm
-        uses: actions/cache@v4
-        env:
-          cache-name: cache-node-modules
-        with:
-          # npm cache files are stored in `~/.npm` on Linux/macOS
-          path: ~/.npm
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-build-${{ env.cache-name }}-
-            ${{ runner.os }}-build-
-            ${{ runner.os }}-
       - name: Install Shell UI dependencies
         run: |
           cd shell-ui
@@ -420,7 +419,6 @@ jobs:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
-
       - uses: docker/build-push-action@v6
         with:
           push: true
@@ -429,10 +427,23 @@ jobs:
           tags: ghcr.io/${{ github.repository_owner }}/metalk8s-nginx-integration-tests:${{ github.sha }}
 
   integration_tests_ui:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     needs:
+      - build-devcontainer
       - build_integration_container_nginx
       - changed-files
+    container:
+      image: ghcr.io/${{ github.repository }}/devcontainer:${{ github.sha }}
+      # We have to use `root` for the moment
+      # Sees: https://github.com/actions/checkout/issues/1575
+      # Could work with a user with 1001 id but not for docker
+      options: --user root
+      credentials:
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    defaults:
+      run:
+        shell: bash
     if: needs.changed-files.outputs.integration-tests-ui == 'true'
     services:
       app:
@@ -445,23 +456,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Install node
-        uses: actions/setup-node@v4
-        with:
-          node-version: "20"
-      - name: Cache node modules
-        id: cache-npm
-        uses: actions/cache@v4
-        env:
-          cache-name: cache-node-modules
-        with:
-          # npm cache files are stored in `~/.npm` on Linux/macOS
-          path: ~/.npm
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-build-${{ env.cache-name }}-
-            ${{ runner.os }}-build-
-            ${{ runner.os }}-
+      - name: Set safe directory (since container is root and not user 1001)
+        run: git config --global --add safe.directory $GITHUB_WORKSPACE
       - name: Install Cypress and its dependencies
         run: |
           cd ui
@@ -475,7 +471,7 @@ jobs:
         run: |
           bash -c '
             attempts=0
-            until curl -Isfo /dev/null http://localhost/; do
+            until curl -Isfo /dev/null http://app/; do
               (( attempts++ ))
               if [ $attempts -gt 100 ]; then
                 >&2 echo "Failed to reach application after 5 minutes"
@@ -486,7 +482,7 @@ jobs:
           '
       - name: Run all UI integration tests
         env:
-          CYPRESS_BASE_URL: http://localhost
+          CYPRESS_BASE_URL: http://app
         run: |
           cd ui
           rm -rf babel.config.js