zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(ci): Add Rust environment variables to Docker test workflows (#9318) 

* feat(ci): Add Rust environment variables to Docker test workflows

Enhance test workflows by adding Rust-specific environment variables:
- Include RUST_LOG for logging configuration
- Add RUST_BACKTRACE and RUST_LIB_BACKTRACE for improved error tracing
- Include COLORBT_SHOW_HIDDEN for detailed backtraces
- Add CARGO_INCREMENTAL for build performance optimization

These changes improve debugging capabilities and provide more flexibility in test environments across dockerized CI jobs.

* feat(ci): Add CARGO_INCREMENTAL build argument to Docker workflow

Enable configurable Rust incremental compilation in Docker builds by:
- Adding CARGO_INCREMENTAL as a build argument in GitHub Actions workflow
- Setting a default value of 0 in Dockerfile to control build performance
- Integrating with existing Rust environment variable configuration

This change provides more granular control over Rust compilation strategies in containerized builds.

* fix(docker): resolve user creation issues in Dockerfile

- Move WORKDIR after user creation to prevent home directory ownership issues
- Properly set environment variables for UID, GID, HOME, and USER in each stage
- Reorganize Dockerfile to ensure home directory is created after user setup
- Fix interactive prompts during adduser by ensuring proper directory ownership

* fix(docs): Apply suggestions from code review

Co-authored-by: Marek <mail@marek.onl>

---------

Co-authored-by: Marek <mail@marek.onl>
This commit is contained in:
Gustavo Valverde 2025-03-12 10:43:31 +00:00 committed by GitHub
parent f873aa12a6
commit 49741e8b47
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 67 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/sub-build-docker-image.yml vendored
View File

@ -166,6 +166,7 @@ jobs:
build-args: |
SHORT_SHA=${{ env.GITHUB_SHA_SHORT }}
RUST_LOG=${{ env.RUST_LOG }}
CARGO_INCREMENTAL=${{ env.CARGO_INCREMENTAL }}
FEATURES=${{ env.FEATURES }}
push: true
# It's recommended to build images with max-level provenance attestations

43
.github/workflows/sub-ci-unit-tests-docker.yml vendored
View File

@ -53,10 +53,15 @@ jobs:
- name: Run all tests
run: |
docker pull ${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
docker run -t \
docker run --tty \
-e RUN_ALL_TESTS=1 \
-e FEATURES="journald prometheus filter-reload" \
-e NETWORK="${{ inputs.network || vars.ZCASH_NETWORK }}" \
-e RUST_LOG=${{ env.RUST_LOG }} \
-e RUST_BACKTRACE=${{ env.RUST_BACKTRACE }} \
-e RUST_LIB_BACKTRACE=${{ env.RUST_LIB_BACKTRACE }} \
-e COLORBT_SHOW_HIDDEN=${{ env.COLORBT_SHOW_HIDDEN }} \
-e CARGO_INCREMENTAL=${{ env.CARGO_INCREMENTAL }} \
${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
# Run state tests with fake activation heights.
@ -85,9 +90,14 @@ jobs:
NETWORK: ${{ inputs.network || vars.ZCASH_NETWORK }}
run: |
docker pull ${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
docker run -t \
docker run --tty \
-e TEST_FAKE_ACTIVATION_HEIGHTS=1 \
-e NETWORK="${{ inputs.network || vars.ZCASH_NETWORK }}" \
-e RUST_LOG=${{ env.RUST_LOG }} \
-e RUST_BACKTRACE=${{ env.RUST_BACKTRACE }} \
-e RUST_LIB_BACKTRACE=${{ env.RUST_LIB_BACKTRACE }} \
-e COLORBT_SHOW_HIDDEN=${{ env.COLORBT_SHOW_HIDDEN }} \
-e CARGO_INCREMENTAL=${{ env.CARGO_INCREMENTAL }} \
${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
# Test that Zebra syncs and checkpoints a few thousand blocks from an empty state.
@ -108,7 +118,15 @@ jobs:
NETWORK: ${{ inputs.network || vars.ZCASH_NETWORK }}
run: |
docker pull ${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
docker run --tty -e TEST_ZEBRA_EMPTY_SYNC=1 ${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
docker run --tty \
-e TEST_ZEBRA_EMPTY_SYNC=1 \
-e NETWORK="${{ inputs.network || vars.ZCASH_NETWORK }}" \
-e RUST_LOG=${{ env.RUST_LOG }} \
-e RUST_BACKTRACE=${{ env.RUST_BACKTRACE }} \
-e RUST_LIB_BACKTRACE=${{ env.RUST_LIB_BACKTRACE }} \
-e COLORBT_SHOW_HIDDEN=${{ env.COLORBT_SHOW_HIDDEN }} \
-e CARGO_INCREMENTAL=${{ env.CARGO_INCREMENTAL }} \
${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
# Test launching lightwalletd with an empty lightwalletd and Zebra state.
test-lightwalletd-integration:
@ -128,7 +146,13 @@ jobs:
NETWORK: ${{ inputs.network || vars.ZCASH_NETWORK }}
run: |
docker pull ${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
docker run --tty -e ZEBRA_TEST_LIGHTWALLETD=1 -e TEST_LWD_INTEGRATION=1 ${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
docker run --tty \
-e ZEBRA_TEST_LIGHTWALLETD=1 \
-e TEST_LWD_INTEGRATION=1 \
-e NETWORK="${{ inputs.network || vars.ZCASH_NETWORK }}" \
-e RUST_LOG=${{ env.RUST_LOG }} \
-e RUST_BACKTRACE=${{ env.RUST_BACKTRACE }} \
${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
# Test that Zebra works using the default config with the latest Zebra version.
test-configuration-file:
@ -147,8 +171,8 @@ jobs:
with:
test_id: "testnet-conf"
docker_image: ${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
grep_patterns: '-e "net.*=.*Test.*estimated progress to chain tip.*Genesis" -e "net.*=.*Test.*estimated progress to chain tip.*BeforeOverwinter"'
test_variables: "-e NETWORK=Testnet"
grep_patterns: '-e "net.*=.*Test.*estimated progress to chain tip.*Genesis" -e "net.*=.*Test.*estimated progress to chain tip.*BeforeOverwinter"'
# Test that Zebra works using $ZEBRA_CONF_PATH config
test-zebra-conf-path:
@ -198,4 +222,11 @@ jobs:
- name: Run check_no_git_refs_in_cargo_lock
run: |
docker pull ${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
docker run --tty -e RUN_CHECK_NO_GIT_REFS=1 ${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}
docker run --tty \
-e RUN_CHECK_NO_GIT_REFS=1 \
-e NETWORK="${{ inputs.network || vars.ZCASH_NETWORK }}" \
-e RUST_LOG=${{ env.RUST_LOG }} \
-e RUST_BACKTRACE=${{ env.RUST_BACKTRACE }} \
-e RUST_LIB_BACKTRACE=${{ env.RUST_LIB_BACKTRACE }} \
-e COLORBT_SHOW_HIDDEN=${{ env.COLORBT_SHOW_HIDDEN }} \
${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}@${{ inputs.image_digest }}

11
.github/workflows/sub-deploy-integration-tests-gcp.yml vendored
View File

@ -85,6 +85,11 @@ on:
description: 'Application name, used to work out when a job is an update job'
env:
RUST_LOG: ${{ vars.RUST_LOG }}
RUST_BACKTRACE: ${{ vars.RUST_BACKTRACE }}
RUST_LIB_BACKTRACE: ${{ vars.RUST_LIB_BACKTRACE }}
COLORBT_SHOW_HIDDEN: ${{ vars.COLORBT_SHOW_HIDDEN }}
CARGO_INCREMENTAL: ${{ vars.CARGO_INCREMENTAL }}
# How many previous log lines we show at the start of each new log job.
# Increase this number if some log lines are skipped between jobs
#
@ -95,7 +100,6 @@ env:
# How many blocks to wait before creating an updated cached state image.
# 1 day is approximately 1152 blocks.
CACHED_STATE_UPDATE_LIMIT: 576
jobs:
# Find a cached state disk for ${{ inputs.test_id }}, matching all of:
# - disk cached state prefix -> zebrad-cache or lwd-cache
@ -279,6 +283,11 @@ jobs:
--tty \
--detach \
${{ inputs.test_variables }} \
-e RUST_LOG=${{ env.RUST_LOG }} \
-e RUST_BACKTRACE=${{ env.RUST_BACKTRACE }} \
-e RUST_LIB_BACKTRACE=${{ env.RUST_LIB_BACKTRACE }} \
-e COLORBT_SHOW_HIDDEN=${{ env.COLORBT_SHOW_HIDDEN }} \
-e CARGO_INCREMENTAL=${{ env.CARGO_INCREMENTAL }} \
${MOUNT_FLAGS} \
${{ vars.GAR_BASE }}/${{ vars.CI_IMAGE_NAME }}:sha-${{ env.GITHUB_SHA_SHORT }} \
'

36
docker/Dockerfile
View File

@ -52,19 +52,14 @@ ENV RUST_LIB_BACKTRACE=${RUST_LIB_BACKTRACE:-1}
ARG COLORBT_SHOW_HIDDEN
ENV COLORBT_SHOW_HIDDEN=${COLORBT_SHOW_HIDDEN:-1}
ARG CARGO_INCREMENTAL
ENV CARGO_INCREMENTAL=${CARGO_INCREMENTAL:-0}
ARG SHORT_SHA
# If this is not set, it must be an empty string, so Zebra can try an alternative git commit source:
# https://github.com/ZcashFoundation/zebra/blob/9ebd56092bcdfc1a09062e15a0574c94af37f389/zebrad/src/application.rs#L179-L182
ENV SHORT_SHA=${SHORT_SHA:-}
# Set the working directory for the build.
ARG HOME
WORKDIR ${HOME}
ENV HOME=${HOME}
ENV CARGO_HOME="${HOME}/.cargo/"
ENV USER=${USER}
# This stage builds tests without running them.
#
# We also download needed dependencies for tests to work, from other images.
@ -81,15 +76,22 @@ ENV ZEBRA_SKIP_IPV6_TESTS=${ZEBRA_SKIP_IPV6_TESTS:-1}
# This environment setup is almost identical to the `runtime` target so that the
# `tests` target differs minimally. In fact, a subset of this setup is used for
# the `runtime` target.
ARG UID
ENV UID=${UID}
ARG GID
ENV GID=${GID}
ARG HOME
ENV HOME=${HOME}
ARG USER
ENV USER=${USER}
RUN addgroup --gid ${GID} ${USER} && \
adduser --gid ${GID} --uid ${UID} --home ${HOME} ${USER}
# Set the working directory for the build.
WORKDIR ${HOME}
ENV CARGO_HOME="${HOME}/.cargo/"
# Build Zebra test binaries, but don't run them
# Leverage a cache mount to /usr/local/cargo/registry/
@ -189,14 +191,8 @@ FROM debian:bookworm-slim AS runtime
ARG FEATURES
ENV FEATURES=${FEATURES}
# Create a non-privileged system user for running `zebrad`.
ARG USER
ENV USER=${USER}
# System users have no home dirs, but we set one for users' convenience.
ARG HOME
WORKDIR ${HOME}
# Create a non-privileged user for running `zebrad`.
#
# We use a high UID/GID (10001) to avoid overlap with host system users.
# This reduces the risk of container user namespace conflicts with host accounts,
# which could potentially lead to privilege escalation if a container escape occurs.
@ -213,10 +209,16 @@ ARG UID
ENV UID=${UID}
ARG GID
ENV GID=${GID}
ARG HOME
ENV HOME=${HOME}
ARG USER
ENV USER=${USER}
RUN addgroup --gid ${GID} ${USER} && \
adduser --gid ${GID} --uid ${UID} --home ${HOME} ${USER}
WORKDIR ${HOME}
# We set the default locations of the conf and cache dirs according to the XDG
# spec: https://specifications.freedesktop.org/basedir-spec/latest/