ci: improve tests to pass with workflow_dispatch event

neilime · neilime · commit c3184398aa78 · 2025-11-04T13:50:29.000+01:00
Signed-off-by: Emilien Escalle &lt;emilien.escalle@escemi.com&gt;
diff --git a/.github/workflows/__test-action-docker-build-image.yml b/.github/workflows/__test-action-docker-build-image.yml
@@ -109,35 +109,43 @@ jobs:
               `"annotations.org.opencontainers.image.url" output is not valid`
             );
 
+            const expectedTags = [];
+            let expectedImageVersion;
             if (`${{ github.event_name }}` === "pull_request") {
               const shortSha = `${{ github.sha }}`.substring(0, 7);
               const prShaTag = `pr-${{ github.event.pull_request.number }}-${shortSha}`;
               const prTag = `pr-${{ github.event.pull_request.number }}`;
 
-              assert.equal(builtImage.tags.length, 2, `"tags" output is not valid`);
-
-              assert.equal(builtImage.tags[0], prShaTag, `"tags" output is not valid`);
-              assert.equal(builtImage.tags[1], prTag, `"tags" output is not valid`);
-
-              assert.equal(
-                builtImage.annotations["org.opencontainers.image.version"],
-                prTag,
-                `"annotations.org.opencontainers.image.version" output is not valid`
-              );
+              expectedTags.push(prShaTag, prTag);
+              expectedImageVersion = prShaTag;
             } else {
               const refTag = `${{ github.ref_name }}`;
+              expectedTags.push(refTag);
+              expectedImageVersion = refTag;
 
-              assert.equal(builtImage.tags.length, 2, `"tags" output is not valid`);
-              assert.equal(builtImage.tags[0], refTag, `"tags" output is not valid`);
-              assert.equal(builtImage.tags[1], "latest", `"tags" output is not valid`);
+              if (`${{ github.event_name }}` !== "workflow_dispatch") {
+                expectedTags.push("latest");
+              }
+            }
 
-              assert.equal(
-                builtImage.annotations["org.opencontainers.image.version"],
-                refTag,
-                `"annotations.org.opencontainers.image.version" output is not valid`
-              );
+            assert.equal(
+              builtImage.tags.length,
+              expectedTags.length,
+              `"tags" output is not valid, expected ${expectedTags.length} tags but got ${builtImage.tags.length}`
+            );
+
+            for (const expectedTag of expectedTags) {
+              if (!builtImage.tags.includes(expectedTag)) {
+                assert.fail(`Expected tag "${expectedTag}" not found in "tags" output`);
+              }
             }
 
+            assert.equal(
+              builtImage.annotations["org.opencontainers.image.version"],
+              expectedImageVersion,
+              `"annotations.org.opencontainers.image.version" output is not valid`
+            );
+
       - uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
         with:
           registry: ghcr.io
diff --git a/.github/workflows/__test-action-docker-prune-pull-requests-image-tags.yml b/.github/workflows/__test-action-docker-prune-pull-requests-image-tags.yml
@@ -31,7 +31,9 @@ jobs:
           fi
 
       - id: generate-tag
+        name: Generate random PR tag
         run: |
+          # Generate a random tag to be deleted that cannot collide with an open PR tag
           TAG="pr-$(( 1 + RANDOM % 210))"
           echo "tag=$TAG" >> "$GITHUB_OUTPUT"
 
@@ -55,10 +57,55 @@ jobs:
           }
         ]
 
+  arrange-verify:
+    name: Arrange - Verify built images
+    runs-on: ubuntu-latest
+    needs: arrange
+    permissions:
+      contents: read
+      packages: read
+    outputs:
+      base-image: ${{ steps.assert-built-images.outputs.base-image }}
+    steps:
+      - name: Assert - Ensure images have been built
+        id: assert-built-images
+        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
+        env:
+          IMAGE_NAME: ${{ env.IMAGE_NAME }}
+          BUILT_IMAGES: ${{ needs.arrange.outputs.built-images }}
+        with:
+          script: |
+            const packages = process.env.PACKAGES.split("\n").map(packageName => packageName.trim()).filter(Boolean);
+
+            for(const packageName of packages) {
+              const packagePayload = {
+                package_type: 'container',
+                package_name: packageName,
+                org: process.env.GITHUB_REPOSITORY_OWNER,
+              };
+
+              // Ensure that package exists
+              const packageExists = await github.rest.packages.getPackageForOrganization(packagePayload);
+              if (!packageExists) {
+                return core.setFailed(`Package "${packageName}" does not exist`);
+              }
+            }
+
+            // Ensure base image has been built
+            const builtImagesOutput = process.env.BUILT_IMAGES;
+            const builtImages = JSON.parse(builtImagesOutput);
+            if (!builtImages[process.env.IMAGE_NAME] || !builtImages[process.env.IMAGE_NAME].images.length) {
+              return core.setFailed(`No built images found for image name "${process.env.IMAGE_NAME}"`);
+            }
+            const baseImage = builtImages[process.env.IMAGE_NAME].images[0];
+            await exec.exec("docker", ["pull", baseImage]);
+
+            core.setOutput("base-image", baseImage);
+
   act:
     name: Act - Prune pull requests image tags
     runs-on: ubuntu-latest
-    needs: [setup, arrange]
+    needs: [setup, arrange, arrange-verify]
     permissions:
       packages: write
     steps:
@@ -71,9 +118,13 @@ jobs:
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Generate a image tag that should be deleted
+        env:
+          BASE_IMAGE: ${{ needs.arrange-verify.outputs.base-image }}
+          IMAGE_NAME: ${{ env.IMAGE_NAME }}
+          TAG_TO_DELETE: ${{ needs.setup.outputs.tag }}
+          BUILT_IMAGES: ${{ needs.arrange.outputs.built-images }}
         run: |
-          BASE_IMAGE=$(echo '${{ needs.arrange.outputs.built-images }}' | jq -r '."${{ env.IMAGE_NAME }}".images[0]')
-          NEW_IMAGE=ghcr.io/hoverkraft-tech/ci-github-container/${{ env.IMAGE_NAME }}:${{ needs.setup.outputs.tag }}
+          NEW_IMAGE="ghcr.io/hoverkraft-tech/ci-github-container/$IMAGE_NAME:$TAG_TO_DELETE"
 
           docker pull "$BASE_IMAGE"
           docker tag "$BASE_IMAGE" "$NEW_IMAGE"
@@ -91,6 +142,8 @@ jobs:
     steps:
       - name: Assert - Ensure expected packages versions have been deleted
         uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
+        env:
+          TAG_TO_DELETE: ${{ needs.setup.outputs.tag }}
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
@@ -105,16 +158,20 @@ jobs:
                 org: process.env.GITHUB_REPOSITORY_OWNER,
               };
 
+              // Ensure that package still exists
+              const packageExists = await github.rest.packages.getPackageForOrganization(packagePayload);
+              assert(packageExists, `Package "${packageName}" does not exist`);
+
               const packageVersions = await github.paginate(
                 github.rest.packages.getAllPackageVersionsForPackageOwnedByOrg.endpoint.merge(packagePayload)
               );
 
               const packageVersionExists = packageVersions.some(
                 (packageVersion) => packageVersion.metadata.container.tags.some(
-                  (tag) => tag === "${{ needs.setup.outputs.tag }}"
+                  (tag) => tag === process.env.TAG_TO_DELETE
                 )
               );
-              assert.equal(packageVersionExists, false, `Package version "${{ needs.setup.outputs.tag }}" has not been deleted`);
+              assert.equal(packageVersionExists, false, `Package version "${process.env.TAG_TO_DELETE}" has not been deleted`);
             }
 
       - uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
@@ -126,6 +183,8 @@ jobs:
 
       - name: Assert - Ensure current image tag didn't get deleted
         if: ${{ github.event_name == 'pull_request' }}
+        env:
+          IMAGE_NAME: ${{ env.IMAGE_NAME }}
         run: |
           for IMAGE_TAG in $(echo '${{ needs.arrange.outputs.built-images }}' | jq -r '."${{ env.IMAGE_NAME }}".images[]'); do
             docker pull "$IMAGE_TAG"
@@ -139,7 +198,7 @@ jobs:
 
             # Ensure all manifests digest didn't get deleted
             for DIGEST in $(echo "$MANIFEST" | jq -r '.manifests[].digest'); do
-              IMAGE_MANIFEST="ghcr.io/hoverkraft-tech/ci-github-container/${{ env.IMAGE_NAME }}@$DIGEST"
+              IMAGE_MANIFEST="ghcr.io/hoverkraft-tech/ci-github-container/$IMAGE_NAME@$DIGEST"
               docker pull "$IMAGE_MANIFEST"
               if ! docker manifest inspect "$IMAGE_MANIFEST" > /dev/null; then
                 echo "Failed to inspect manifest for image: ${IMAGE_MANIFEST}"
diff --git a/.github/workflows/__test-action-get-image-metadata.yml b/.github/workflows/__test-action-get-image-metadata.yml
@@ -77,31 +77,33 @@ jobs:
             const tags = tagsOutput.split("\n").filter(Boolean);
             assert(tags.length, `"tags" output is empty`);
 
-            if (`${{ github.event_name }}` === "pull_request") {
-              assert.equal(
-                tags.length,
-                2,
-                `"tags" output must contain 2 tags for pull_request event`
-              );
+            const expectedTags = [];
 
-              assert(
-                tags[0].startsWith("ghcr.io/hoverkraft-tech/ci-github-container/application-test:pr-${{ github.event.pull_request.number }}-"),
-                `"tags" output is not valid`
-              );
+            if (`${{ github.event_name }}` === "pull_request") {
+              const shortSha = `${{ github.sha }}`.substring(0, 7);
+              const prShaTag = `pr-${{ github.event.pull_request.number }}-${shortSha}`;
+              const prTag = `pr-${{ github.event.pull_request.number }}`;
 
-              assert.equal(
-                tags[1],
-                "ghcr.io/hoverkraft-tech/ci-github-container/application-test:pr-${{ github.event.pull_request.number }}", `"tags" output is not valid`
-              );
+              expectedTags.push(prShaTag, prTag);
             } else {
-              assert.equal(
-                tags.length,
-                2,
-                `"tags" output must contain 2 tags for push event`
-              );
+              expectedTags.push("main");
+              if (`${{ github.event_name }}` !== "workflow_dispatch") {
+                expectedTags.push("latest");
+              }
+            }
+
+            assert.equal(
+              tags.length,
+              expectedTags.length,
+              `"tags" output must contain ${expectedTags.length} tags for ${{ github.event_name }} event`
+            );
 
-              assert.equal(tags[0],"ghcr.io/hoverkraft-tech/ci-github-container/application-test:main", `"tags" output is not valid`);
-              assert.equal(tags[1],"ghcr.io/hoverkraft-tech/ci-github-container/application-test:latest", `"tags" output is not valid`);
+            for(const expectedTag of expectedTags) {
+              const fullTag = `ghcr.io/hoverkraft-tech/ci-github-container/application-test:${expectedTag}`;
+              assert(
+                tags.includes(fullTag),
+                `Expected tag "${fullTag}" not found in "tags" output`
+              );
             }
 
   tests-with-given-tag:
