-
Notifications
You must be signed in to change notification settings - Fork 4
466 lines (401 loc) · 18.5 KB
/
zxc-verify-docker-build-determinism.yaml
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
##
# Copyright (C) 2023-2025 Hedera Hashgraph, LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
##
name: "ZXC: Verify Docker Build Determinism"
# Here, the ZXC prefix:
# Z - Ensures sort order such that this script appears at the bottom of the UI
# X - Indicates it's not for direct user consumption
# C - Indicates this is a 'workflow_call' based reusable workflow
on:
workflow_call:
inputs:
ref:
description: "The branch, tag, or commit to checkout:"
type: string
required: false
default: ""
java-distribution:
description: "Java JDK Distribution:"
type: string
required: false
default: "temurin"
java-version:
description: "Java JDK Version:"
type: string
required: false
default: "21.0.4"
defaults:
run:
shell: bash
permissions:
id-token: write
contents: read
packages: write
env:
DOCKER_MANIFEST_GENERATOR: .github/workflows/support/scripts/generate-docker-artifact-baseline.sh
DOCKER_MANIFEST_PATH: ${{ github.workspace }}/.manifests/docker
DOCKER_REGISTRY: ghcr.io
DOCKER_IMAGE_NAME: hashgraph/hedera-block-node
DOCKER_CONTEXT_PATH: server/docker
SKOPEO_VERSION: v1.14.0
OWNER: hashgraph
jobs:
generate-baseline:
name: Generate Baseline
runs-on: block-node-linux-medium
outputs:
sha: ${{ steps.commit.outputs.sha }}
sha-abbrev: ${{ steps.commit.outputs.sha-abbrev }}
source-date: ${{ steps.commit.outputs.source-date }}
path: ${{ steps.baseline.outputs.path }}
file: ${{ steps.baseline.outputs.file }}
name: ${{ steps.baseline.outputs.name }}
steps:
- name: Harden Runner
uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
with:
egress-policy: audit
- name: Standardize Git Line Endings
run: |
git config --global core.autocrlf false
git config --global core.eol lf
- name: Checkout Code
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
ref: ${{ inputs.ref }}
- name: Authenticate to Google Cloud
id: google-auth
uses: google-github-actions/auth@6fc4af4b145ae7821d527454aa9bd537d1f2dc5f # v2.1.7
with:
workload_identity_provider: "projects/235822363393/locations/global/workloadIdentityPools/hedera-builds-pool/providers/hedera-builds-gh-actions"
service_account: "[email protected]"
- name: Setup Google Cloud SDK
uses: google-github-actions/setup-gcloud@6189d56e4096ee891640bb02ac264be376592d6a # v2.1.2
- name: Retrieve Commit Hash
id: commit
run: |
echo "sha=$(git rev-parse HEAD)" >> "${GITHUB_OUTPUT}"
echo "sha-abbrev=$(git rev-parse HEAD | tr -d '[:space:]' | cut -c1-8)" >> "${GITHUB_OUTPUT}"
echo "source-date=$(git log -1 --pretty=%ct)" >> "${GITHUB_OUTPUT}"
- name: Baseline Existence Check
id: baseline
run: |
BASELINE_NAME="${{ steps.commit.outputs.sha }}.tar.gz"
BASELINE_PATH="gs://hedera-ci-ephemeral-artifacts/${{ github.repository }}/docker/baselines"
BASELINE_FILE="${BASELINE_PATH}/${BASELINE_NAME}"
BASELINE_EXISTS="false"
if gsutil ls "${BASELINE_FILE}" >/dev/null 2>&1; then
BASELINE_EXISTS="false"
fi
echo "exists=${BASELINE_EXISTS}" >> "${GITHUB_OUTPUT}"
echo "path=${BASELINE_PATH}" >> "${GITHUB_OUTPUT}"
echo "name=${BASELINE_NAME}" >> "${GITHUB_OUTPUT}"
echo "file=${BASELINE_FILE}" >> "${GITHUB_OUTPUT}"
- name: Setup Java
uses: actions/setup-java@8df1039502a15bceb9433410b1a100fbe190c53b # v4.5.0
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
with:
distribution: ${{ inputs.java-distribution }}
java-version: ${{ inputs.java-version }}
- name: Setup Gradle
uses: gradle/actions/setup-gradle@cc4fc85e6b35bafd578d5ffbc76a5518407e1af0 # v4.2.1
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
with:
cache-disabled: true
- name: Install Skopeo and JQ
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
run: |
sudo apt-get update
sudo apt-get install --yes --no-install-recommends skopeo jq
- name: Setup QEmu Support
uses: docker/setup-qemu-action@49b3bc8e6bdd4a60e6116a5414239cba5943d3cf # v3.2.0
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
- name: Setup Docker Buildx Support
uses: docker/setup-buildx-action@c47758b77c9736f4b2ef4073d4d51994fabfe349 # v3.7.1
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
with:
version: v0.16.2
driver-opts: network=host
- name: Setup Local Docker Registry
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
run: docker run -d -p 5000:5000 --restart=always --name registry registry:latest
- name: Show Docker Version
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
run: docker version
- name: Show Docker Info
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
run: docker info
- name: Build Gradle Artifacts
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
run: ./gradlew assemble --scan
- name: Login to GitHub Container Registry
uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
with:
registry: ${{ env.DOCKER_REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
# - name: Prepare for Docker Build
# if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
# run: |
# mkdir -p "${{ github.workspace }}/${{ env.DOCKER_CONTEXT_PATH }}/sdk/data"
#
# echo "::group::Copying Application Artifacts"
# cp -Rvf "${{ github.workspace }}/server/build/libs" "${{ github.workspace }}/${{ env.DOCKER_CONTEXT_PATH }}/sdk/data/"
# echo "::endgroup::"
- name: Write Artifact Version Descriptor
run: |
printf "VERSION=%s\nCOMMIT=%s\nDATE=%s" "$(./gradlew -q showVersion)" "$(git log -1 --format='%H' | cut -c1-8)" "$(date -u)" | tee "${{ github.workspace }}/${{ env.DOCKER_CONTEXT_PATH }}/sdk/VERSION"
- name: Extract version
id: extract_version
run: |
VERSION=$(grep 'version=' gradle.properties | cut -d '=' -f2)
echo "VERSION=${VERSION}" >> $GITHUB_ENV
- name: Build Docker Image
uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 # v6.10.0
env:
SOURCE_DATE_EPOCH: ${{ steps.commit.outputs.source-date }}
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
with:
push: false
no-cache: true
platforms: linux/amd64,linux/arm64
build-args: |
SOURCE_DATE_EPOCH=${{ steps.commit.outputs.source-date }}
VERSION=${{ env.VERSION }}
context: ./${{ env.DOCKER_CONTEXT_PATH }}
file: ./${{ env.DOCKER_CONTEXT_PATH }}/Dockerfile
tags: ${{ env.DOCKER_REGISTRY }}/${{ env.DOCKER_IMAGE_NAME }}:${{ env.VERSION }}
build-contexts: |
distributions=./server/build/distributions
- name: Generate Manifest
id: manifest
env:
MANIFEST_PATH: ${{ env.DOCKER_MANIFEST_PATH }}
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
run: GITHUB_SHA="${{ needs.generate-baseline.outputs.sha-abbrev }}" ${{ env.DOCKER_MANIFEST_GENERATOR }}
- name: Amend Manifest with Gradle Artifacts
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
working-directory: ${{ env.DOCKER_MANIFEST_PATH }}
run: |
EXTRACTED_FILE_NAME="${{ steps.commit.outputs.sha }}.tar"
echo "Before manifest operations ----------"
pwd
ls -la
gunzip "${{ steps.manifest.outputs.name }}"
echo "After gunzip ----------"
ls -la
tar -rvf "${EXTRACTED_FILE_NAME}" -C "${{ github.workspace }}/${{ env.DOCKER_CONTEXT_PATH }}" ../../server/build/
gzip "${EXTRACTED_FILE_NAME}"
echo "After augmenting and gzipping ----------"
ls -la
# - name: Clear Bucket
# run: |
# echo "::group::Clear Bucket Group"
# BASELINE_PATH="gs://hedera-ci-ephemeral-artifacts/${{ github.repository }}/docker/baselines"
# DOCKER_PATH="gs://hedera-ci-ephemeral-artifacts/${{ github.repository }}/docker/"
# gsutil ls "${DOCKER_PATH}"
#
# echo "Baseline Path: ${BASELINE_PATH}"
# gsutil ls "${BASELINE_PATH}/"
# echo "end of ls"
#
# gsutil rm "${BASELINE_PATH}/*"
# echo "end of rm"
#
# gsutil ls "${BASELINE_PATH}/"
# echo "end of second ls"
# echo "::endgroup::"
- name: Upload Baseline
if: ${{ steps.baseline.outputs.exists == 'false' && !failure() && !cancelled() }}
run: gsutil cp "${{ steps.manifest.outputs.file }}" "${{ steps.baseline.outputs.file }}"
verify-artifacts:
name: "Verify Artifacts (${{ join(matrix.os, ', ') }})"
runs-on: ${{ matrix.os }}
needs:
- generate-baseline
strategy:
fail-fast: false
matrix:
# Windows is not supported due to GitHub not supporting Docker Desktop/Podman Desktop and Docker CE on Windows
# not supporting BuildKit and the Buildx plugin.
# GitHub hosted MacOS and Ubuntu runners are temporarily disabled.
os:
#- ubuntu-22.04
#- ubuntu-20.04
#- macos-12
#- macos-11
- block-node-linux-medium
steps:
- name: Harden Runner
uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
with:
egress-policy: audit
- name: Standardize Git Line Endings
run: |
git config --global core.autocrlf false
git config --global core.eol lf
- name: Checkout Code
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
ref: ${{ inputs.ref }}
- name: Setup Python
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
with:
python-version: 3.9
- name: Install JQ (Linux)
if: ${{ runner.os == 'Linux' }}
run: |
sudo apt-get update
sudo apt-get install --yes --no-install-recommends jq
- name: Install Skopeo (Linux)
if: ${{ runner.os == 'Linux' }}
run: |
source /etc/os-release
if [[ "${VERSION_ID}" != "20.04" ]]; then
sudo apt-get install --yes --no-install-recommends skopeo
fi
- name: Authenticate to Google Cloud
id: google-auth
uses: google-github-actions/auth@6fc4af4b145ae7821d527454aa9bd537d1f2dc5f # v2.1.7
with:
workload_identity_provider: "projects/235822363393/locations/global/workloadIdentityPools/hedera-builds-pool/providers/hedera-builds-gh-actions"
service_account: "[email protected]"
- name: Setup Google Cloud SDK
uses: google-github-actions/setup-gcloud@6189d56e4096ee891640bb02ac264be376592d6a # v2.1.2
env:
CLOUDSDK_PYTHON: ${{ format('{0}{1}', env.pythonLocation, runner.os == 'Windows' && '\python.exe' || '/bin/python3') }}
- name: Download Baseline
env:
CLOUDSDK_PYTHON: ${{ format('{0}{1}', env.pythonLocation, runner.os == 'Windows' && '\python.exe' || '/bin/python3') }}
run: |
STARTING_DIR=$(pwd)
echo "Starting directory: ${STARTING_DIR}"
echo "Making: ${{ env.DOCKER_MANIFEST_PATH }}"
mkdir -p "${{ env.DOCKER_MANIFEST_PATH }}"
cd "${{ env.DOCKER_MANIFEST_PATH }}"
echo "Downloading: ${{ needs.generate-baseline.outputs.file }}"
gsutil cp "${{ needs.generate-baseline.outputs.file }}" .
echo "Extracting: ${{ needs.generate-baseline.outputs.name }}"
tar -xzf "${{ needs.generate-baseline.outputs.name }}"
pwd
ls -la
echo "listing sub dir ./server/build/distributions/"
ls -la ./server/build/distributions/
echo "Creating build directory: ${STARTING_DIR}/server/build/distributions"
# cp *.json "${{ github.workspace }}/${{ env.DOCKER_CONTEXT_PATH }}/"
cd ./server/build/distributions
cp *.tar "${STARTING_DIR}/server/build/distributions/"
echo "Copied files to: ${STARTING_DIR}/server/build/distributions"
- name: Determine Home Directory
id: home
run: echo "directory=$(tr -d '[:space:]' < <(cd ~ && pwd))" >> "${GITHUB_OUTPUT}"
- name: Setup QEmu Support
uses: docker/setup-qemu-action@49b3bc8e6bdd4a60e6116a5414239cba5943d3cf # v3.2.0
- name: Setup Docker Buildx Support
uses: docker/setup-buildx-action@c47758b77c9736f4b2ef4073d4d51994fabfe349 # v3.7.1
with:
version: v0.16.2
driver-opts: network=host
- name: Setup Local Docker Registry
run: docker run -d -p 5000:5000 --restart=always --name registry registry:latest
- name: Show Docker Version
run: docker version
- name: Show Docker Info
run: docker info
- name: Login to GitHub Container Registry
uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
with:
registry: ${{ env.DOCKER_REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract version
id: extract_version
run: |
VERSION=$(grep 'version=' gradle.properties | cut -d '=' -f2)
echo "VERSION=${VERSION}" >> $GITHUB_ENV
- name: Docker Image Debugging
run: |
echo "zero ---------------------"
pwd
ls -la
echo "${{ env.VERSION }}\n"
ls -la "${{ github.workspace }}/${{ env.DOCKER_CONTEXT_PATH }}/"
- name: Build Docker Image
uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 # v6.10.0
env:
SOURCE_DATE_EPOCH: ${{ needs.generate-baseline.outputs.source-date }}
with:
push: false
no-cache: true
platforms: linux/amd64,linux/arm64
build-args: |
SOURCE_DATE_EPOCH=${{ needs.generate-baseline.outputs.source-date }}
VERSION=${{ env.VERSION }}
context: ./${{ env.DOCKER_CONTEXT_PATH }}
file: ./${{ env.DOCKER_CONTEXT_PATH }}/Dockerfile
tags: ${{ env.DOCKER_REGISTRY }}/${{ env.DOCKER_IMAGE_NAME }}:${{ needs.generate-baseline.outputs.sha-abbrev }}
build-contexts: |
distributions=./${{ env.DOCKER_CONTEXT_PATH }}/
- name: Regenerate Manifest
id: regen-manifest
env:
MANIFEST_PATH: ${{ env.DOCKER_MANIFEST_PATH }}/regenerated
run: GITHUB_SHA="${{ needs.generate-baseline.outputs.sha-abbrev }}" ${{ env.DOCKER_MANIFEST_GENERATOR }}
- name: Validate Layers (linux/amd64)
run: |
if ! diff -u "${{ env.DOCKER_MANIFEST_PATH }}/linux-amd64.layers.json" "${{ steps.regen-manifest.outputs.path }}/linux-amd64.layers.json" >/dev/null 2>&1; then
echo "::group::Debug Bucket Group"
BASELINE_NAME="${{ steps.commit.outputs.sha }}.tar.gz"
BASELINE_PATH="gs://hedera-ci-ephemeral-artifacts/${{ github.repository }}/docker/baselines"
BASELINE_FILE="${BASELINE_PATH}/${BASELINE_NAME}"
echo "Baseline Path: ${BASELINE_PATH}"
gsutil ls "${BASELINE_PATH}"
echo "end"
echo "::endgroup::"
echo "::group::Layer Differences"
diff -u "${{ env.DOCKER_MANIFEST_PATH }}/linux-amd64.layers.json" "${{ steps.regen-manifest.outputs.path }}/linux-amd64.layers.json"
echo "::endgroup::"
exit 1
fi
- name: Validate Layers (linux/arm64)
run: |
if ! diff -u "${DOCKER_MANIFEST_PATH}/linux-arm64.layers.json" "${{ steps.regen-manifest.outputs.path }}/linux-arm64.layers.json" >/dev/null 2>&1; then
echo "::group::Layer Differences"
diff -u "${DOCKER_MANIFEST_PATH}/linux-arm64.layers.json" "${{ steps.regen-manifest.outputs.path }}/linux-arm64.layers.json"
echo "::endgroup::"
exit 1
fi
- name: Validate Full Manifest (linux/amd64)
run: |
if ! diff -u "${DOCKER_MANIFEST_PATH}/linux-amd64.comparable.json" "${{ steps.regen-manifest.outputs.path }}/linux-amd64.comparable.json" >/dev/null 2>&1; then
echo "::group::Layer Differences"
diff -u "${DOCKER_MANIFEST_PATH}/linux-amd64.comparable.json" "${{ steps.regen-manifest.outputs.path }}/linux-amd64.comparable.json"
echo "::endgroup::"
exit 1
fi
- name: Validate Full Manifest (linux/arm64)
run: |
if ! diff -u "${DOCKER_MANIFEST_PATH}/linux-arm64.comparable.json" "${{ steps.regen-manifest.outputs.path }}/linux-arm64.comparable.json" >/dev/null 2>&1; then
echo "::group::Layer Differences"
diff -u "${DOCKER_MANIFEST_PATH}/linux-arm64.comparable.json" "${{ steps.regen-manifest.outputs.path }}/linux-arm64.comparable.json"
echo "::endgroup::"
exit 1
fi
- name: Publish Manifests
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
if: ${{ steps.regen-manifest.conclusion == 'success' && failure() && !cancelled() }}
with:
name: Docker Manifests [${{ join(matrix.os, ', ') }}]
path: ${{ env.DOCKER_MANIFEST_PATH }}/**