ci: Build workhorse binaries and upload/download as generic package

What does this MR do and why?

This MR does two things:

1. Adds a new build-components job that runs automatically for all GitLab.com gitlab-org/gitlab scheduled pipelines, for any master commit that touches the workhorse/ folder, and is manual for GitLab.com's gitlab-org's MRs.
   1. This job tries to download a generic package that contains GitLab Workhorse binaries needed in the GitLab's test suite (under tmp/tests/gitlab-workhorse).
   2. If the package URL returns a 404:
      1. It runs scripts/setup-test-env, so that the GitLab Workhorse binaries are built.
      2. It then creates an archive which contains the binaries and upload it as a generic package to https://gitlab.com/gitlab-org/gitlab/-/packages/.
2. Change the setup-test-env job to:
   1. First download the GitLab Workhorse generic package build and uploaded by build-components.
   2. If the package is retrieved successfully, its content is placed in the right folder (i.e. tmp/tests/gitlab-workhorse), preventing the building of the binaries when scripts/setup-test-env is run later on.
   3. If the package URL returns a 404, the behavior doesn't change compared to the current one: the GitLab Workhorse binaries are built as part of scripts/setup-test-env

Notes:

• The diff to achieve this is quite small, and we can see that TestEnv didn't have to be touched at all, so this is really an optimization that sits on top of what we have today (i.e. caching of GitLab Workhorse binaries).
• The version of the package is the workhorse tree SHA (i.e. git rev-parse HEAD:workhorse).
• Since the workhorse shouldn't change too often, most of the MRs should be able to take advantage of the pre-built package, which would be built every two hours.
• As a further iteration, the package could be downloaded by TestEnv directly, so that local GDK instances, and GitPod instances (not sure about that) would benefit from it as well (though, different architectures should be taken in account, see gitlab-development-kit#1391).

Improvements

Duration of scripts/setup-test-env

With package	Duration
No	92s, 84s, 82s
Yes	42s, 44s, 46s

It looks like we could already save 42 seconds on average for the setup-test-env job.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

• I have evaluated the MR acceptance checklist for this MR.
• Documentation is up-to-date: #353078 (closed) => !81289 (merged)

Related to #351035 (closed).

scripts/gitlab_workhorse_component_helpers.sh

 #!/usr/bin/env bash
 
+export CURL_TOKEN_HEADER="${CURL_TOKEN_HEADER:-"JOB-TOKEN"}"
 export GITLAB_WORKHORSE_FOLDER="gitlab-workhorse"
 export TMP_GITLAB_WORKHORSE_FOLDER="${CI_PROJECT_DIR}/tmp/${GITLAB_WORKHORSE_FOLDER}"
 export GITLAB_WORKHORSE_BINARIES_LIST="gitlab-resize-image gitlab-zip-cat gitlab-zip-metadata gitlab-workhorse"
@@ -12,11 +13,6 @@ function gitlab_workhorse_archive_doesnt_exist() {
   [ ! -f "${GITLAB_WORKHORSE_ARCHIVE}" ]
 }
 
-function create_gitlab_workhorse_archive() {
-  compress_or_decompress "compress"
-  tar -czvf ${GITLAB_WORKHORSE_ARCHIVE} -C ${TMP_TEST_FOLDER} ${GITLAB_WORKHORSE_FOLDER}
-}
-
 function compress_or_decompress() {
   local action="${1}"
   local workhorse_folder="${2:${TMP_TEST_GITLAB_WORKHOSE_FOLDER}}"
@@ -44,40 +40,66 @@ function compress_or_decompress() {
   fi
 }
 
+function create_gitlab_workhorse_archive() {
+  local archive_file="${1:-${GITLAB_WORKHORSE_ARCHIVE}}"
+  local archive_folder="${2:-${GITLAB_WORKHORSE_FOLDER}}"
+  local working_folder=$(dirname "${TMP_TEST_GITLAB_WORKHOSE_FOLDER}")
+
+  # Un-compressed
+  tar -czvf ${archive_file} -C ${working_folder} ${archive_folder}
+
+  # Compressed
+  compress_or_decompress "compress"
+  tar -czvf "upx-compressed-${archive_file}" -C ${working_folder} ${archive_folder}
+}
+
+function extract_gitlab_workhorse_archive() {
+  local destination_folder="${1:-${TMP_TEST_FOLDER}}"
+
+  echoinfo "Extracting archive to ${destination_folder}"
+
+  tar -xzv -C ${destination_folder} < /dev/stdin
+}
+
 function upload_gitlab_workhorse_package() {
-  echoinfo "Uploading ${GITLAB_WORKHORSE_ARCHIVE} to ${GITLAB_WORKHORSE_PACKAGE_URL} ..."
-  curl --fail --silent --retry 3 --header "JOB-TOKEN: ${CI_JOB_TOKEN}" --upload-file "${GITLAB_WORKHORSE_ARCHIVE}" "${GITLAB_WORKHORSE_PACKAGE_URL}"
+  local archive_file="${1:-${GITLAB_WORKHORSE_ARCHIVE}}"
+  local package_url="${2:-${GITLAB_WORKHORSE_PACKAGE_URL}}"
+  local token_header="${3:-${CURL_TOKEN_HEADER}}"
+  local token="${4:-${CI_JOB_TOKEN}}"
+
+  echoinfo "Uploading ${archive_file} to ${package_url} ..."
+
+  curl --fail --silent --retry 3 --header "${token_header}: ${token}" --upload-file "${archive_file}" "${package_url}"
 }
 
 function download_gitlab_workhorse_package() {
   local output_file="${1}"
+  local package_url="${2:-${GITLAB_WORKHORSE_PACKAGE_URL}}"
+  local token_header="${3:-${CURL_TOKEN_HEADER}}"
+  local token="${4:-${CI_JOB_TOKEN}}"
   local extra_curl_args=""
 
   if [ -n "${output_file}" ]; then
     extra_curl_args=" -o \"${output_file}\""
   fi
 
-  echoinfo "Downloading from ${GITLAB_WORKHORSE_PACKAGE_URL} ..."
-  eval "curl --fail --retry 3 --header \"JOB-TOKEN: ${CI_JOB_TOKEN}\" \"${GITLAB_WORKHORSE_PACKAGE_URL}\"${extra_curl_args}"
+  echoinfo "Downloading from ${package_url} ..."
+  eval "curl --fail --retry 3 --header \"${token_header}: ${token}\" \"${package_url}\"${extra_curl_args}"
 }
 
 function download_and_extract_gitlab_workhorse_package() {
   download_gitlab_workhorse_package | extract_gitlab_workhorse_archive | compress_or_decompress "decompress"
 }
 
-function extract_gitlab_workhorse_archive() {
-  local destination_folder="${1:-${TMP_TEST_FOLDER}}"
-
-  echoinfo "Extracting archive to ${destination_folder}"
-
-  tar -xzv -C ${destination_folder} -
-}
-
 function filter_gitlab_workhorse_binaries() {
-  mkdir -p "${TMP_GITLAB_WORKHORSE_FOLDER}"
-  cd ${TMP_TEST_GITLAB_WORKHOSE_FOLDER} && cp ${GITLAB_WORKHORSE_PACKAGE_FILES_LIST} ${TMP_GITLAB_WORKHORSE_FOLDER} && cd -
-  rm -rf ${TMP_TEST_GITLAB_WORKHOSE_FOLDER}
+  local gitlab_workhose_tmp_folder="${1:-${TMP_GITLAB_WORKHORSE_FOLDER}}"
+  local gitlab_workhose_final_folder="${2:-${TMP_TEST_GITLAB_WORKHOSE_FOLDER}}"
+  local destination_folder="${3:-$(dirname "${TMP_TEST_GITLAB_WORKHOSE_FOLDER}")}"
+
+  mkdir -p "${gitlab_workhose_tmp_folder}"
+  cd ${gitlab_workhose_final_folder} && cp ${GITLAB_WORKHORSE_PACKAGE_FILES_LIST} ${gitlab_workhose_tmp_folder} && cd -
+  rm -rf ${gitlab_workhose_final_folder}
 
   # Move the temp folder to its final destination
-  mv ${TMP_GITLAB_WORKHORSE_FOLDER} ${TMP_TEST_FOLDER};
+  mv ${gitlab_workhose_tmp_folder} ${destination_folder}
 }