__test-action-get-image-metadata.yml

---
name: Test for "docker/get-image-metadata" action
run-name: Test for "docker/get-image-metadata" action

on: # yamllint disable-line rule:truthy
  workflow_call:

permissions: {}

jobs:
  tests:
    name: Test for "docker/get-image-metadata" action
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          persist-credentials: false

      - name: Act
        id: get-image-metadata
        uses: ./actions/docker/get-image-metadata
        with:
          oci-registry: ghcr.io
          image: application-test

      - name: Assert - Check get image metadata outputs
        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
        env:
          IMAGE_OUTPUT: ${{ steps.get-image-metadata.outputs.image }}
          LABELS_OUTPUT: ${{ steps.get-image-metadata.outputs.labels }}
          ANNOTATIONS_OUTPUT: ${{ steps.get-image-metadata.outputs.annotations }}
          TAGS_OUTPUT: ${{ steps.get-image-metadata.outputs.tags }}
        with:
          script: |
            const assert = require("assert");
            const pullRequestNumber = context.payload.pull_request?.number;
            const refName = process.env.GITHUB_REF_NAME;
            const defaultBranch = context.payload.repository?.default_branch;

            const imageOutput = process.env.IMAGE_OUTPUT;
            assert(imageOutput.length, `"image" output is empty`);
            assert.equal(imageOutput,"ghcr.io/hoverkraft-tech/ci-github-container/application-test", `"image" output is not valid`);

            const labelsOutput = process.env.LABELS_OUTPUT;
            assert(labelsOutput.length, `"labels" output is empty`);
            assert(
              labelsOutput.startsWith("org.opencontainers.image.created"),
              `"labels" "org.opencontainers.image.created" output is not valid`
            );

            const expectedLabels = "org.opencontainers.image.source=https://github.com/hoverkraft-tech/ci-github-container\n" +
                "org.opencontainers.image.title=ci-github-container\n" +
                "org.opencontainers.image.url=https://github.com/hoverkraft-tech/ci-github-container\n";

            assert(
              labelsOutput.includes(expectedLabels),
              `"labels" output is not valid`
            );

            const annotationsOutput = process.env.ANNOTATIONS_OUTPUT;
            assert(annotationsOutput.length, `"annotations" output is empty`);

            const expectedManifestAnnotations = expectedLabels.split("\n").map(line => {
              if (line.length === 0) return line;
              return `manifest:${line}`;
            }).join("\n");

            assert(
              annotationsOutput.includes(expectedManifestAnnotations),
              `"annotations - manifest" output is not valid`
            );

            const expectedManifestDescriptorAnnotations = expectedLabels.split("\n").map(line => {
              if (line.length === 0) return line;
              return `manifest-descriptor:${line}`;
            }).join("\n");

            assert(
              annotationsOutput.includes(expectedManifestDescriptorAnnotations),
              `"annotations - manifest-descriptor" output is not valid`
            );

            const tagsOutput = process.env.TAGS_OUTPUT;
            assert(tagsOutput.length, `"tags" output is empty`);

            const tags = tagsOutput.split("\n").filter(Boolean);
            assert(tags.length, `"tags" output is empty`);

            const expectedTags = [];

            if (context.eventName === "pull_request") {
              const shortSha = context.sha.substring(0, 7);
              const prShaTag = `pr-${pullRequestNumber}-${shortSha}`;
              const prTag = `pr-${pullRequestNumber}`;

              expectedTags.push(prShaTag, prTag);
            } else {
              const refTag = refName;
              expectedTags.push(refTag);

              const isTag = context.ref.startsWith('refs/tags/');
              const isPushOnDefaultBranch = context.eventName === "push" && !isTag && refTag === defaultBranch;

              if (isPushOnDefaultBranch) {
                expectedTags.push("latest");
              }
            }

            assert.equal(
              tags.length,
              expectedTags.length,
              `"tags" output must contain ${expectedTags.length} tags for ${context.eventName} event`
            );

            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:
    name: Test for "docker/get-image-metadata" action with given tag
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          persist-credentials: false

      - name: Act
        id: get-image-metadata
        uses: ./actions/docker/get-image-metadata
        with:
          oci-registry: ghcr.io
          image: application-test
          tag: 1.0.0

      - name: Assert - Check get image metadata outputs
        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
        env:
          TAGS_OUTPUT: ${{ steps.get-image-metadata.outputs.tags }}
        with:
          script: |
            const assert = require("assert");

            const tagsOutput = process.env.TAGS_OUTPUT;
            assert(tagsOutput.length, `"tags" output is empty`);
            assert.equal(
              tagsOutput,
              "ghcr.io/hoverkraft-tech/ci-github-container/application-test:1.0.0"
            );