From 20d87fb80bd60e6747ba78b53556907818fc22a9 Mon Sep 17 00:00:00 2001
From: Kittywhiskers Van Gogh <63189531+kwvg@users.noreply.github.com>
Date: Fri, 22 Nov 2024 11:50:28 +0000
Subject: [PATCH] ci: write artifact collection script, compress using `zstd`

---
 .github/workflows/build.yml      | 17 ++++---
 .gitlab-ci.yml                   | 17 +++----
 ci/dash/create-artifacts.sh      | 87 ++++++++++++++++++++++++++++++++
 contrib/containers/ci/Dockerfile |  3 +-
 4 files changed, 105 insertions(+), 19 deletions(-)
 create mode 100755 ci/dash/create-artifacts.sh

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 55ccfc500c2f4..3ebb8cb8fdfef 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -176,19 +176,22 @@ jobs:
       - name: Build source and run tests
         run: |
           git config --global --add safe.directory "$PWD"
-          CCACHE_SIZE="400M"
-          CACHE_DIR="/cache"
-          mkdir /output
-          BASE_OUTDIR="/output"
-          BUILD_TARGET="${{ matrix.build_target }}"
+          export ARTIFACT_PATH="/output"
+          export BUILD_TARGET="${{ matrix.build_target }}"
+          export CACHE_DIR="/cache"
+          export CCACHE_SIZE="400M"
           source ./ci/dash/matrix.sh
           ./ci/dash/build_src.sh
           ./ci/dash/test_unittests.sh
+          ./ci/dash/create-artifacts.sh
         shell: bash
 
       - name: Upload build artifacts
         uses: actions/upload-artifact@v4
         with:
-          name: build-artifacts-${{ matrix.build_target }}
+          name: artifacts_${{ matrix.build_target }}
           path: |
-            /output
+            /output/artifacts_${{ matrix.build_target }}.tar.zst
+            /output/artifacts_${{ matrix.build_target }}.tar.zst.sha256
+          compression-level: 0
+          retention-days: 3
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 67885d4a59e05..65c21e2b5d01e 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -100,10 +100,14 @@ builder-image:
   stage: build
   extends: .base-template
   variables:
+    ARTIFACT_COMPRESSION_LEVEL: "fastest"
+    ARTIFACT_PATH: "/output"
     CCACHE_SIZE: "400M"
+    FF_USE_FASTZIP: "true"
   script:
     - ./ci/dash/build_src.sh
     - ./ci/dash/test_unittests.sh # Run unit tests in build stage to avoid creating too many parallel jobs
+    - ./ci/dash/create-artifacts.sh
   cache:
     # Let all branches share the same cache, which is ok because ccache is able to handle it
     key:
@@ -113,19 +117,10 @@ builder-image:
     paths:
       - cache/ccache
   artifacts:
-    name: binaries
     when: always
     paths:
-      - build-ci
-    # Exclude some less important binaries to reduce the size of the artifacts
-    exclude:
-      - build-ci/dashcore-$BUILD_TARGET/src/bench/bench_dash
-      - build-ci/dashcore-$BUILD_TARGET/src/bench/bench_dash.exe
-      - build-ci/dashcore-$BUILD_TARGET/src/qt/test/test_dash-qt
-      - build-ci/dashcore-$BUILD_TARGET/src/qt/test/test_dash-qt.exe
-      - build-ci/dashcore-$BUILD_TARGET/src/test/test_dash
-      - build-ci/dashcore-$BUILD_TARGET/src/test/test_dash.exe
-      - build-ci/dashcore-$BUILD_TARGET/src/test/fuzz/*
+      - /output/artifacts_${BUILD_TARGET}.tar.zst
+      - /output/artifacts_${BUILD_TARGET}.tar.zst.sha256
     expire_in: 3 days
 
 .test-template:
diff --git a/ci/dash/create-artifacts.sh b/ci/dash/create-artifacts.sh
new file mode 100755
index 0000000000000..e8cca3b5426c9
--- /dev/null
+++ b/ci/dash/create-artifacts.sh
@@ -0,0 +1,87 @@
+#!/usr/bin/env bash
+# Copyright (c) 2024 The Dash Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+export LC_ALL=C.UTF-8
+
+set -ex;
+
+if [ -z "${BUILD_TARGET}" ]; then
+    echo "BUILD_TARGET not defined, cannot continue!";
+    exit 1;
+elif [ -z "${ARTIFACT_PATH}" ]; then
+    echo "ARTIFACT_PATH not defined, cannot continue!";
+    exit 1;
+elif  [ ! "$(command -v zstd)" ]; then
+    echo "zstd not found, cannot continue!";
+    exit 1;
+fi
+
+FILE_EXTENSION=""
+if [[ "${BUILD_TARGET}" == "win"* ]]; then
+    FILE_EXTENSION=".exe"
+fi
+
+# The extra comma is so that brace expansion works as expected, otherwise
+# it's just interpreted as literal braces
+ARTIFACT_DIRS=",bin"
+if [[ "${BUILD_TARGET}" == "mac"* ]]; then
+    ARTIFACT_DIRS="${ARTIFACT_DIRS},dist"
+fi
+
+# If there are new binaries, these need to be updated
+BIN_NAMES="d,-cli,-tx"
+if [[ ${BUILD_TARGET} != *"nowallet" ]]; then
+    BIN_NAMES="${BIN_NAMES},-wallet"
+fi
+if [[ ${BUILD_TARGET} == *"multiprocess" ]]; then
+    BIN_NAMES="${BIN_NAMES},-node"
+fi
+
+# Since brace expansion happens _before_ variable substitution, we need to
+# do the variable substitution in this bash instance, then use a fresh bash
+# instance to do the brace expansion, then take the word split output.
+#
+# This needs us to suppress SC2046.
+
+ARTIFACT_BASE_PATH="${ARTIFACT_PATH}/${BUILD_TARGET}"
+# shellcheck disable=SC2046
+mkdir -p $(echo -n $(bash -c "echo ${ARTIFACT_BASE_PATH}/{${ARTIFACT_DIRS}}"))
+
+# We aren't taking binaries from "release" as they're stripped and therefore,
+# impede debugging.
+BUILD_BASE_PATH="build-ci/dashcore-${BUILD_TARGET}/src"
+
+if [ -f "${BUILD_BASE_PATH}/dashd${FILE_EXTENSION}" ]; then
+    # shellcheck disable=SC2046
+    cp $(echo -n $(bash -c "echo ${BUILD_BASE_PATH}/dash{${BIN_NAMES}}${FILE_EXTENSION}")) \
+       "${BUILD_BASE_PATH}/bench/bench_dash${FILE_EXTENSION}" \
+       "${BUILD_BASE_PATH}/test/test_dash${FILE_EXTENSION}" \
+       "${ARTIFACT_BASE_PATH}/bin";
+fi
+
+if [ -f "${BUILD_BASE_PATH}/qt/dash-qt${FILE_EXTENSION}" ]; then
+    cp "${BUILD_BASE_PATH}/qt/dash-qt${FILE_EXTENSION}" \
+       "${BUILD_BASE_PATH}/qt/test/test_dash-qt${FILE_EXTENSION}" \
+       "${ARTIFACT_BASE_PATH}/bin";
+fi
+
+if [ -f "${BUILD_BASE_PATH}/test/fuzz/fuzz${FILE_EXTENSION}" ]; then
+    cp "${BUILD_BASE_PATH}/test/fuzz/fuzz${FILE_EXTENSION}" \
+       "${ARTIFACT_BASE_PATH}/bin";
+fi
+
+# TODO: After bitcoin#28432, it will be Dash-Core.zip. Remember to change this!
+if [[ "${ARTIFACT_DIRS}" == *"dist"* ]] && [[ "${BUILD_TARGET}" == "mac"* ]]; then
+    cp "${BUILD_BASE_PATH}/../Dash-Core.dmg" \
+       "${ARTIFACT_BASE_PATH}/dist"
+fi
+
+ARTIFACT_ARCHIVE="artifacts_${BUILD_TARGET}.tar.zst"
+# We have to cd into ARTIFACT_PATH so that the archive doesn't have the
+# directory structure ARTIFACT_PATH/BUILD_TARGET when we want BUILD_TARGET
+# as the root directory. `tar` offers no easy way to do this.
+cd "${ARTIFACT_PATH}"
+tar -cvf - "${BUILD_TARGET}" | zstd -T"$(nproc)" -5 > "${ARTIFACT_ARCHIVE}"
+sha256sum "${ARTIFACT_ARCHIVE}" > "${ARTIFACT_ARCHIVE}.sha256"
diff --git a/contrib/containers/ci/Dockerfile b/contrib/containers/ci/Dockerfile
index fb3f5923352e2..b61577a801e41 100644
--- a/contrib/containers/ci/Dockerfile
+++ b/contrib/containers/ci/Dockerfile
@@ -134,7 +134,8 @@ RUN apt-get update && apt-get install $APT_ARGS \
     valgrind \
     wine-stable \
     wine64 \
-    xorriso
+    xorriso \
+    zstd
 
 ARG CPPCHECK_VERSION=2.13.0
 RUN curl -sL "https://github.com/danmar/cppcheck/archive/${CPPCHECK_VERSION}.tar.gz" | tar -xvzf - --directory /tmp/