Merge pull request #6585 from Ocelot-Social-Community/cache-docker-images-for-backend-webapp-e2e-testing

refactor(other): cache docker images for backend webapp e2e testing

.github/file-filters.yml

@@ -1,4 +1,5 @@
 backend: &backend
+  - '.github/workflows/test-backend.yml'
   - 'backend/**/*'
   - 'neo4j/**/*'
 
@@ -6,4 +7,5 @@ docker: &docker
   - 'docker-compose.*'
 
 webapp: &webapp
+  - '.github/workflows/test-webapp.yml'
   - 'webapp/**/*'

.github/workflows/test-backend.yml

@@ -10,10 +10,11 @@ jobs:
     outputs:
       backend: ${{ steps.changes.outputs.backend }}
       docker: ${{ steps.changes.outputs.docker }}
+      pr-number: ${{ steps.pr.outputs.number }}
     steps:
       - uses: actions/checkout@v3.3.0
 
-      - name: Check for frontend file changes
+      - name: Check for backend file changes
         uses: dorny/paths-filter@v2.11.1
         id: changes
         with:
@@ -21,6 +22,10 @@ jobs:
           filters: .github/file-filters.yml
           list-files: shell
 
+      - name: Get pr number
+        id: pr
+        uses: 8BitJonny/gh-get-current-pr@2.2.0
+
   build_test_neo4j:
     name: Docker Build Test - Neo4J
     if: needs.files-changed.outputs.backend == 'true' || needs.files-changed.outputs.docker == 'true'
@@ -35,11 +40,12 @@ jobs:
           docker build --target community -t "ocelotsocialnetwork/neo4j-community:test" neo4j/
           docker save "ocelotsocialnetwork/neo4j-community:test" > /tmp/neo4j.tar
       
-      - name: Upload Artifact
+      - name: Cache docker images
-        uses: actions/upload-artifact@v3
+        id: cache-neo4j
+        uses: actions/cache/save@v3.3.1
         with:
-          name: docker-neo4j-image
           path: /tmp/neo4j.tar
+          key: backend-neo4j-cache-pr${{ needs.files-changed.outputs.pr-number }}
 
   build_test_backend:
     name: Docker Build Test - Backend
@@ -55,11 +61,12 @@ jobs:
           docker build --target test -t "ocelotsocialnetwork/backend:test" backend/
           docker save "ocelotsocialnetwork/backend:test" > /tmp/backend.tar
       
-      - name: Upload Artifact
+      - name: Cache docker images
-        uses: actions/upload-artifact@v3
+        id: cache-backend
+        uses: actions/cache/save@v3.3.1
         with:
-          name: docker-backend-test
           path: /tmp/backend.tar
+          key: backend-cache-pr${{ needs.files-changed.outputs.pr-number }}
 
   lint_backend:
     name: Lint Backend
@@ -84,28 +91,29 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
 
-      - name: Download Docker Image (Neo4J)
+      - name: Restore Neo4J cache
-        uses: actions/download-artifact@v3
+        uses: actions/cache/restore@v3.3.1
         with:
-          name: docker-neo4j-image
+          path: /tmp/neo4j.tar
-          path: /tmp
+          key: backend-neo4j-cache-pr${{ needs.files-changed.outputs.pr-number }}
+          fail-on-cache-miss: true
 
-      - name: Load Docker Image
+      - name: Restore Backend cache
-        run: docker load < /tmp/neo4j.tar
+        uses: actions/cache/restore@v3.3.1
-
-      - name: Download Docker Image (Backend)
-        uses: actions/download-artifact@v3
         with:
-          name: docker-backend-test
+          path: /tmp/backend.tar
-          path: /tmp
+          key: backend-cache-pr${{ needs.files-changed.outputs.pr-number }}
+          fail-on-cache-miss: true
 
-      - name: Load Docker Image
+      - name: Load Docker Images
-        run: docker load < /tmp/backend.tar
+        run: |
+          docker load < /tmp/neo4j.tar
+          docker load < /tmp/backend.tar
 
-      - name: backend | copy env files webapp
+      - name: backend | copy env files
-        run: cp webapp/.env.template webapp/.env
+        run: |
-      - name: backend | copy env files backend
+          cp webapp/.env.template webapp/.env
-        run: cp backend/.env.template backend/.env
+          cp backend/.env.template backend/.env
 
       - name: backend | docker-compose
         run: docker-compose -f docker-compose.yml -f docker-compose.test.yml up --detach --no-deps neo4j backend
@@ -118,3 +126,20 @@ jobs:
 
       - name: backend | Unit test incl. coverage check
         run: docker-compose exec -T backend yarn test
+
+  cleanup:
+    name: Cleanup
+    if: always()
+    needs: [files-changed, unit_test_backend]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Delete cache
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh extension install actions/gh-actions-cache
+          set +e
+          KEY="backend-neo4j-cache-pr${{ needs.files-changed.outputs.pr-number }}"
+          gh actions-cache delete $KEY -R Ocelot-Social-Community/Ocelot-Social --confirm
+          KEY="backend-cache-pr${{ needs.files-changed.outputs.pr-number }}"
+          gh actions-cache delete $KEY -R Ocelot-Social-Community/Ocelot-Social --confirm

.github/workflows/test-webapp.yml

@@ -9,6 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       docker: ${{ steps.changes.outputs.docker }}
+      pr-number: ${{ steps.pr.outputs.number }}
       webapp: ${{ steps.changes.outputs.webapp }}
     steps:
       - uses: actions/checkout@v3.3.0
@@ -21,6 +22,10 @@ jobs:
           filters: .github/file-filters.yml
           list-files: shell
 
+      - name: Get pr number
+        id: pr
+        uses: 8BitJonny/gh-get-current-pr@2.2.0
+
   prepare:
     name: Prepare
     if: needs.files-changed.outputs.webapp == 'true'
@@ -44,16 +49,16 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
 
-      - name: webapp | Build 'test' image
+      - name: Webapp | Build 'test' image
         run: |
           docker build --target test -t "ocelotsocialnetwork/webapp:test" webapp/
           docker save "ocelotsocialnetwork/webapp:test" > /tmp/webapp.tar
 
-      - name: Upload Artifact
+      - name: Cache docker image
-        uses: actions/upload-artifact@v3
+        uses: actions/cache/save@v3.3.1
         with:
-          name: docker-webapp-test
           path: /tmp/webapp.tar
+          key: webapp-cache-pr${{ needs.files-changed.outputs.pr-number }}
 
   lint_webapp:
     name: Lint Webapp
@@ -78,20 +83,19 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
 
-      - name: Download Docker Image (Webapp)
+      - name: Restore webapp cache
-        uses: actions/download-artifact@v3
+        uses: actions/cache/restore@v3.3.1
         with:
-          name: docker-webapp-test
+          path: /tmp/webapp.tar
-          path: /tmp
+          key: webapp-cache-pr${{ needs.files-changed.outputs.pr-number }}
 
       - name: Load Docker Image
         run: docker load < /tmp/webapp.tar
 
-      - name: backend | copy env files webapp
+      - name: Copy env files
-        run: cp webapp/.env.template webapp/.env
+        run: |
-
+          cp webapp/.env.template webapp/.env
-      - name: backend | copy env files backend
+          cp backend/.env.template backend/.env
-        run: cp backend/.env.template backend/.env
 
       - name: backend | docker-compose
         run: docker-compose -f docker-compose.yml -f docker-compose.test.yml up --detach --no-deps webapp
@@ -99,3 +103,18 @@ jobs:
       - name: webapp | Unit tests incl. coverage check
         run: docker-compose exec -T webapp yarn test
 
+  cleanup:
+    name: Cleanup
+    if: always()
+    needs: [files-changed, unit_test_webapp]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Delete cache
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh extension install actions/gh-actions-cache
+          set +e
+          KEY="webapp-cache-pr${{ needs.files-changed.outputs.pr-number }}"
+          gh actions-cache delete $KEY -R Ocelot-Social-Community/Ocelot-Social --confirm
+