ci-github-container/.github/workflows/__test-action-docker-setup.yml at 84d7e3d494baa77548d2b0b5692a68fefbf04552 · hoverkraft-tech/ci-github-container · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
---
name: Test for "docker/setup" action
run-name: Test for "docker/setup" action

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

permissions: {}

jobs:
  tests:
    name: Test for "docker/setup" action
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: Arrange - Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false

      - name: Arrange - Ensure token is set
        run: |
          if [ -z "${{ github.token }}" ]; then
            echo "GitHub token is not set"
            exit 1
          fi

      - name: Act - Setup Docker
        id: docker-setup
        uses: ./actions/docker/setup
        with:
          oci-registry: ghcr.io
          oci-registry-username: ${{ github.repository_owner }}
          oci-registry-password: ${{ github.token }}

      - name: Assert - Check setup outputs and installed tooling
        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
        env:
          EXPECTED_DOCKER_VERSION: 29.5.2
          PUSH_REGISTRY_OUTPUT: ${{ steps.docker-setup.outputs.push-registry }}
          CACHE_REGISTRY_OUTPUT: ${{ steps.docker-setup.outputs.cache-registry }}
          PULL_REGISTRIES_OUTPUT: ${{ steps.docker-setup.outputs.pull-registries }}
          BUILDX_NAME_OUTPUT: ${{ steps.docker-setup.outputs.buildx-name }}
        with:
          script: |
            const assert = require("assert");

            assert.equal(process.env.PUSH_REGISTRY_OUTPUT, "ghcr.io", '"push-registry" output is not valid');
            assert.equal(process.env.CACHE_REGISTRY_OUTPUT, "ghcr.io", '"cache-registry" output is not valid');

            let pullRegistries = null;
            try {
              pullRegistries = JSON.parse(process.env.PULL_REGISTRIES_OUTPUT);
            } catch (error) {
              assert.fail(`Failed to parse "pull-registries" output: ${error}`);
            }

            assert.deepEqual(pullRegistries, ["ghcr.io"], '"pull-registries" output is not valid');

            const buildxName = `${process.env.BUILDX_NAME_OUTPUT || ''}`.trim();
            assert(buildxName.length, '"buildx-name" output is empty');

            const dockerVersionResult = await exec.getExecOutput(
              "docker",
              ["version", "--format", "{{.Server.Version}}"],
              { silent: true },
            );
            assert.equal(
              dockerVersionResult.stdout.trim(),
              process.env.EXPECTED_DOCKER_VERSION,
              'Installed Docker version is not the expected pinned version',
            );

            const buildxVersionResult = await exec.getExecOutput(
              "docker",
              ["buildx", "version"],
              { silent: true },
            );
            assert(buildxVersionResult.stdout.trim().length, '"docker buildx version" returned an empty result');

            const buildxInspectResult = await exec.getExecOutput(
              "docker",
              ["buildx", "inspect", buildxName],
              { ignoreReturnCode: true, silent: true },
            );
            assert.equal(buildxInspectResult.exitCode, 0, 'Configured Buildx builder is not inspectable');

  tests-with-multiple-registries-and-no-buildx:
    name: Test for "docker/setup" action with multiple registries and no Buildx
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: Arrange - Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false

      - name: Arrange - Ensure token is set
        run: |
          if [ -z "${{ github.token }}" ]; then
            echo "GitHub token is not set"
            exit 1
          fi

      - name: Act - Setup Docker
        id: docker-setup
        uses: ./actions/docker/setup
        with:
          oci-registry: |
            {"pull":"docker.io","pull:private":"ghcr.io","push":"ghcr.io"}
          oci-registry-username: |
            {"push":"${{ github.repository_owner }}"}
          oci-registry-password: |
            {"push":"${{ github.token }}"}
          setup-buildx: false

      - name: Assert - Check registry outputs without Buildx
        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
        env:
          EXPECTED_DOCKER_VERSION: 29.5.2
          PUSH_REGISTRY_OUTPUT: ${{ steps.docker-setup.outputs.push-registry }}
          CACHE_REGISTRY_OUTPUT: ${{ steps.docker-setup.outputs.cache-registry }}
          PULL_REGISTRIES_OUTPUT: ${{ steps.docker-setup.outputs.pull-registries }}
          BUILDX_NAME_OUTPUT: ${{ steps.docker-setup.outputs.buildx-name }}
        with:
          script: |
            const assert = require("assert");

            assert.equal(process.env.PUSH_REGISTRY_OUTPUT, "ghcr.io", '"push-registry" output is not valid');
            assert.equal(process.env.CACHE_REGISTRY_OUTPUT, "ghcr.io", '"cache-registry" output is not valid');

            let pullRegistries = null;
            try {
              pullRegistries = JSON.parse(process.env.PULL_REGISTRIES_OUTPUT);
            } catch (error) {
              assert.fail(`Failed to parse "pull-registries" output: ${error}`);
            }

            assert.deepEqual(
              pullRegistries,
              ["docker.io", "ghcr.io"],
              '"pull-registries" output is not valid for multiple registries',
            );
            assert.equal(`${process.env.BUILDX_NAME_OUTPUT || ''}`.trim(), '', '"buildx-name" output must be empty when Buildx is disabled');

            const dockerVersionResult = await exec.getExecOutput(
              "docker",
              ["version", "--format", "{{.Server.Version}}"],
              { silent: true },
            );
            assert.equal(
              dockerVersionResult.stdout.trim(),
              process.env.EXPECTED_DOCKER_VERSION,
              'Installed Docker version is not the expected pinned version',
            );