2020-01-28 01:59:40 +00:00
name : CICD
2023-04-14 17:19:57 +00:00
# spell-checker:ignore (abbrev/names) CICD CodeCOV MacOS MinGW MSVC musl taiki
# spell-checker:ignore (env/flags) Awarnings Ccodegen Coverflow Cpanic Dwarnings RUSTDOCFLAGS RUSTFLAGS Zpanic CARGOFLAGS
# spell-checker:ignore (jargon) SHAs deps dequote softprops subshell toolchain fuzzers
2023-04-22 14:49:49 +00:00
# spell-checker:ignore (people) Peltoche rivy dtolnay
2023-01-18 17:35:26 +00:00
# spell-checker:ignore (shell/tools) choco clippy dmake dpkg esac fakeroot fdesc fdescfs gmake grcov halium lcov libssl mkdir popd printf pushd rsync rustc rustfmt rustup shopt utmpdump xargs
2023-02-06 14:52:29 +00:00
# spell-checker:ignore (misc) aarch alnum armhf bindir busytest coreutils defconfig DESTDIR gecos gnueabihf issuecomment maint multisize nullglob onexitbegin onexitend pell runtest Swatinem tempfile testsuite toybox uutils
2020-01-28 01:59:40 +00:00
env :
2020-05-25 03:24:56 +00:00
PROJECT_NAME : coreutils
PROJECT_DESC : "Core universal (cross-platform) utilities"
2020-01-28 01:59:40 +00:00
PROJECT_AUTH : "uutils"
2023-09-04 05:18:18 +00:00
RUST_MIN_SRV : "1.70.0"
2021-11-17 03:31:15 +00:00
# * style job configuration
2021-11-10 19:36:23 +00:00
STYLE_FAIL_ON_FAULT : true ## (bool) fail the build if a style job contains a fault (error or warning); may be overridden on a per-job basis
2020-01-28 01:59:40 +00:00
2023-12-01 10:52:23 +00:00
on :
pull_request :
push :
branches :
- main
2020-01-28 01:59:40 +00:00
2022-09-25 14:30:33 +00:00
permissions :
contents : read # to fetch code (actions/checkout)
2023-02-17 16:55:33 +00:00
# End the current execution if there is a new changeset in the PR.
concurrency :
group : ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress : ${{ github.ref != 'refs/heads/main' }}
2020-01-28 01:59:40 +00:00
jobs :
2022-03-18 10:29:49 +00:00
cargo-deny :
name : Style/cargo-deny
runs-on : ubuntu-latest
steps :
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2022-03-18 10:29:49 +00:00
- uses : EmbarkStudios/cargo-deny-action@v1
2021-11-10 19:36:23 +00:00
style_deps :
## ToDO: [2021-11-10; rivy] 'Style/deps' needs more informative output and better integration of results into the GHA dashboard
name : Style/deps
runs-on : ${{ matrix.job.os }}
strategy :
fail-fast : false
matrix :
job :
# note: `cargo-udeps` panics when processing stdbuf/libstdbuf ("uu_stdbuf_libstdbuf"); either b/c of the 'cpp' crate or 'libstdbuf' itself
# ... b/c of the panic, a more limited feature set is tested (though only excluding `stdbuf`)
- { os: ubuntu-latest , features : "feat_Tier1,feat_require_unix,feat_require_unix_utmpx" }
- { os: macos-latest , features : "feat_Tier1,feat_require_unix,feat_require_unix_utmpx" }
- { os: windows-latest , features : feat_os_windows }
steps :
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2023-04-22 14:49:49 +00:00
- uses : dtolnay/rust-toolchain@nightly
2023-04-22 14:25:37 +00:00
## note: requires 'nightly' toolchain b/c `cargo-udeps` uses the `rustc` '-Z save-analysis' option
## * ... ref: <https://github.com/est31/cargo-udeps/issues/73>
- uses : taiki-e/install-action@cargo-udeps
2023-04-15 09:55:40 +00:00
- uses : Swatinem/rust-cache@v2
2021-11-10 19:36:23 +00:00
- name : Initialize workflow variables
id : vars
shell : bash
run : |
## VARs setup
2023-01-18 17:34:08 +00:00
outputs() { step_id="${{ github.action }}"; for var in "$@" ; do echo steps.${step_id}.outputs.${var}="${!var}"; echo "${var}=${!var}" >> $GITHUB_OUTPUT; done; }
2021-11-10 19:36:23 +00:00
# failure mode
unset FAIL_ON_FAULT ; case '${{ env.STYLE_FAIL_ON_FAULT }}' in
'' |0|f|false|n|no|off) FAULT_TYPE=warning ;;
*) FAIL_ON_FAULT=true ; FAULT_TYPE=error ;;
esac;
outputs FAIL_ON_FAULT FAULT_TYPE
# target-specific options
# * CARGO_FEATURES_OPTION
CARGO_FEATURES_OPTION='' ;
if [ -n "${{ matrix.job.features }}" ]; then CARGO_FEATURES_OPTION='--features "${{ matrix.job.features }}"' ; fi
outputs CARGO_FEATURES_OPTION
- name : Detect unused dependencies
shell : bash
run : |
## Detect unused dependencies
unset fault
fault_type="${{ steps.vars.outputs.FAULT_TYPE }}"
fault_prefix=$(echo "$fault_type" | tr '[:lower:]' '[:upper:]')
#
2022-04-13 08:55:35 +00:00
cargo +nightly udeps ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} --all-targets &> udeps.log || cat udeps.log
2021-11-10 19:36:23 +00:00
grep --ignore-case "all deps seem to have been used" udeps.log || { printf "%s\n" "::${fault_type} ::${fault_prefix}: \`cargo udeps\`: style violation (unused dependency found)" ; fault=true ; }
if [ -n "${{ steps.vars.outputs.FAIL_ON_FAULT }}" ] && [ -n "$fault" ]; then exit 1 ; fi
2022-01-28 23:09:33 +00:00
doc_warnings :
name : Documentation/warnings
runs-on : ${{ matrix.job.os }}
2023-03-08 21:39:39 +00:00
env :
SCCACHE_GHA_ENABLED : "true"
RUSTC_WRAPPER : "sccache"
2022-01-28 23:09:33 +00:00
strategy :
fail-fast : false
matrix :
job :
- { os: ubuntu-latest , features : feat_os_unix }
# for now, don't build it on mac & windows because the doc is only published from linux
# + it needs a bunch of duplication for build
# and I don't want to add a doc step in the regular build to avoid long builds
# - { os: macos-latest , features: feat_os_macos }
# - { os: windows-latest , features: feat_os_windows }
steps :
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2023-04-22 14:49:49 +00:00
- uses : dtolnay/rust-toolchain@master
with :
toolchain : stable
components : clippy
2023-03-10 15:41:05 +00:00
- uses : Swatinem/rust-cache@v2
2023-03-08 21:39:39 +00:00
- name : Run sccache-cache
2023-03-23 09:29:03 +00:00
uses : mozilla-actions/sccache-action@v0.0.3
2022-01-28 23:09:33 +00:00
- name : Initialize workflow variables
id : vars
shell : bash
run : |
## VARs setup
2023-01-18 17:34:08 +00:00
outputs() { step_id="${{ github.action }}"; for var in "$@" ; do echo steps.${step_id}.outputs.${var}="${!var}"; echo "${var}=${!var}" >> $GITHUB_OUTPUT; done; }
2022-01-28 23:09:33 +00:00
# failure mode
unset FAIL_ON_FAULT ; case '${{ env.STYLE_FAIL_ON_FAULT }}' in
'' |0|f|false|n|no|off) FAULT_TYPE=warning ;;
*) FAIL_ON_FAULT=true ; FAULT_TYPE=error ;;
esac;
outputs FAIL_ON_FAULT FAULT_TYPE
# target-specific options
# * CARGO_FEATURES_OPTION
CARGO_FEATURES_OPTION='--all-features' ;
2023-03-20 09:30:21 +00:00
if [ -n "${{ matrix.job.features }}" ]; then CARGO_FEATURES_OPTION='--features ${{ matrix.job.features }}' ; fi
2022-01-28 23:09:33 +00:00
outputs CARGO_FEATURES_OPTION
# * determine sub-crate utility list
UTILITY_LIST="$(./util/show-utils.sh ${CARGO_FEATURES_OPTION})"
echo UTILITY_LIST=${UTILITY_LIST}
2022-10-20 06:59:00 +00:00
CARGO_UTILITY_LIST_OPTIONS="$(for u in ${UTILITY_LIST}; do echo -n "-puu_${u} "; done;)"
2022-01-28 23:09:33 +00:00
outputs CARGO_UTILITY_LIST_OPTIONS
- name : "`cargo doc` with warnings"
shell : bash
run : |
RUSTDOCFLAGS="-Dwarnings" cargo doc ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} --no-deps --workspace --document-private-items
2023-11-26 00:47:15 +00:00
- uses : DavidAnson/markdownlint-cli2-action@v14
2023-03-03 17:42:51 +00:00
with :
2023-09-12 14:08:19 +00:00
fix : "true"
2023-03-03 17:42:51 +00:00
globs : |
*.md
docs/src/*.md
src/uu/*/*.md
2022-01-28 23:09:33 +00:00
2020-01-28 01:59:40 +00:00
min_version :
2021-11-17 03:31:15 +00:00
name : MinRustV # Minimum supported rust version (aka, MinSRV or MSRV)
2020-04-08 16:30:31 +00:00
runs-on : ${{ matrix.job.os }}
2023-03-08 21:39:39 +00:00
env :
SCCACHE_GHA_ENABLED : "true"
RUSTC_WRAPPER : "sccache"
2020-04-08 16:30:31 +00:00
strategy :
matrix :
job :
- { os: ubuntu-latest , features : feat_os_unix }
2020-01-28 01:59:40 +00:00
steps :
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2023-04-22 14:49:49 +00:00
- uses : dtolnay/rust-toolchain@master
with :
toolchain : ${{ env.RUST_MIN_SRV }}
components : rustfmt
2023-04-14 17:19:57 +00:00
- uses : taiki-e/install-action@nextest
2023-04-22 14:25:37 +00:00
- uses : Swatinem/rust-cache@v2
2023-03-08 21:39:39 +00:00
- name : Run sccache-cache
2023-03-23 09:29:03 +00:00
uses : mozilla-actions/sccache-action@v0.0.3
2021-11-17 03:31:15 +00:00
- name : Initialize workflow variables
id : vars
shell : bash
run : |
## VARs setup
2023-01-18 17:34:08 +00:00
outputs() { step_id="${{ github.action }}"; for var in "$@" ; do echo steps.${step_id}.outputs.${var}="${!var}"; echo "${var}=${!var}" >> $GITHUB_OUTPUT; done; }
2021-11-17 03:31:15 +00:00
# target-specific options
# * CARGO_FEATURES_OPTION
unset CARGO_FEATURES_OPTION
if [ -n "${{ matrix.job.features }}" ]; then CARGO_FEATURES_OPTION='--features "${{ matrix.job.features }}"' ; fi
outputs CARGO_FEATURES_OPTION
2021-06-12 18:46:37 +00:00
- name : Confirm MinSRV compatible 'Cargo.lock'
2020-10-23 15:25:18 +00:00
shell : bash
run : |
2021-06-12 18:46:37 +00:00
## Confirm MinSRV compatible 'Cargo.lock'
2020-10-23 15:25:18 +00:00
# * 'Cargo.lock' is required to be in a format that `cargo` of MinSRV can interpret (eg, v1-format for MinSRV < v1.38)
2021-06-12 18:46:37 +00:00
cargo fetch --locked --quiet || { echo "::error file=Cargo.lock::Incompatible (or out-of-date) 'Cargo.lock' file; update using \`cargo +${{ env.RUST_MIN_SRV }} update\`" ; exit 1 ; }
2022-02-02 05:01:34 +00:00
- name : Confirm MinSRV equivalence for '.clippy.toml'
shell : bash
run : |
## Confirm MinSRV equivalence for '.clippy.toml'
# * ensure '.clippy.toml' MSRV configuration setting is equal to ${{ env.RUST_MIN_SRV }}
CLIPPY_MSRV=$(grep -P "(?i)^\s*msrv\s*=\s*" .clippy.toml | grep -oP "\d+([.]\d+)+")
if [ "${CLIPPY_MSRV}" != "${{ env.RUST_MIN_SRV }}" ]; then { echo "::error file=.clippy.toml::Incorrect MSRV configuration for clippy (found '${CLIPPY_MSRV}'; should be '${{ env.RUST_MIN_SRV }}'); update '.clippy.toml' with 'msrv = \"${{ env.RUST_MIN_SRV }}\"'" ; exit 1 ; } ; fi
2020-04-08 16:30:31 +00:00
- name : Info
shell : bash
run : |
2021-06-12 18:46:37 +00:00
## Info
# environment
2020-06-14 00:38:24 +00:00
echo "## environment"
echo "CI='${CI}'"
2021-06-12 18:46:37 +00:00
# tooling info display
2020-04-08 16:30:31 +00:00
echo "## tooling"
which gcc >/dev/null 2>&1 && (gcc --version | head -1) || true
2021-06-23 15:05:49 +00:00
rustup -V 2>/dev/null
2020-04-08 16:30:31 +00:00
rustup show active-toolchain
cargo -V
rustc -V
2022-09-12 11:22:33 +00:00
cargo tree -V
2021-06-12 18:46:37 +00:00
# dependencies
2020-04-08 16:30:31 +00:00
echo "## dependency list"
2020-04-15 05:34:40 +00:00
## * using the 'stable' toolchain is necessary to avoid "unexpected '--filter-platform'" errors
2021-11-17 03:31:15 +00:00
RUSTUP_TOOLCHAIN=stable cargo fetch --locked --quiet
2022-09-12 11:22:33 +00:00
RUSTUP_TOOLCHAIN=stable cargo tree --all --locked --no-dev-dependencies --no-indent ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} | grep -vE "$PWD" | sort --unique
2020-01-28 01:59:40 +00:00
- name : Test
2023-04-14 17:19:57 +00:00
run : cargo nextest run --hide-progress-bar --profile ci ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} -p uucore -p coreutils
2020-08-10 14:53:32 +00:00
env :
2023-03-26 19:47:12 +00:00
RUSTFLAGS : "-Awarnings"
2023-01-01 13:07:59 +00:00
RUST_BACKTRACE : "1"
2021-11-17 03:31:15 +00:00
deps :
name : Dependencies
runs-on : ${{ matrix.job.os }}
strategy :
fail-fast : false
matrix :
job :
- { os: ubuntu-latest , features : feat_os_unix }
steps :
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2023-04-22 14:49:49 +00:00
- uses : dtolnay/rust-toolchain@stable
2023-04-15 09:55:40 +00:00
- uses : Swatinem/rust-cache@v2
2021-11-17 03:31:15 +00:00
- name : "`cargo update` testing"
shell : bash
run : |
## `cargo update` testing
# * convert any errors/warnings to GHA UI annotations; ref: <https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-a-warning-message>
cargo fetch --locked --quiet || { echo "::error file=Cargo.lock::'Cargo.lock' file requires update (use \`cargo +${{ env.RUST_MIN_SRV }} update\`)" ; exit 1 ; }
2020-01-28 01:59:40 +00:00
2021-06-12 18:46:37 +00:00
build_makefile :
name : Build/Makefile
2021-11-10 19:37:00 +00:00
needs : [ min_version, deps ]
2021-03-14 19:30:53 +00:00
runs-on : ${{ matrix.job.os }}
2023-03-08 21:39:39 +00:00
env :
SCCACHE_GHA_ENABLED : "true"
RUSTC_WRAPPER : "sccache"
2021-03-14 19:30:53 +00:00
strategy :
fail-fast : false
matrix :
job :
2021-11-10 18:09:46 +00:00
- { os: ubuntu-latest , features : feat_os_unix }
2021-03-14 19:30:53 +00:00
steps :
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2023-04-22 14:49:49 +00:00
- uses : dtolnay/rust-toolchain@stable
2023-04-14 17:19:57 +00:00
- uses : taiki-e/install-action@nextest
2023-04-15 09:55:40 +00:00
- uses : Swatinem/rust-cache@v2
- name : Run sccache-cache
uses : mozilla-actions/sccache-action@v0.0.3
2021-06-12 18:46:37 +00:00
- name : "`make build`"
2021-03-14 19:30:53 +00:00
shell : bash
run : |
2021-06-12 18:46:37 +00:00
make build
2023-04-14 17:19:57 +00:00
- name : "`make nextest`"
2021-04-02 20:22:50 +00:00
shell : bash
2023-04-14 17:19:57 +00:00
run : make nextest CARGOFLAGS="--profile ci --hide-progress-bar"
2023-01-01 13:07:59 +00:00
env :
RUST_BACKTRACE : "1"
2023-03-04 17:54:05 +00:00
- name : "`make install`"
shell : bash
run : |
DESTDIR=/tmp/ make PROFILE=release install
# Check that the manpage is present
test -f /tmp/usr/local/share/man/man1/whoami.1
# Check that the completion is present
test -f /tmp/usr/local/share/zsh/site-functions/_install
2023-07-20 07:53:32 +00:00
test -f /tmp/usr/local/share/bash-completion/completions/head
test -f /tmp/usr/local/share/fish/vendor_completions.d/cat.fish
2023-03-04 17:54:05 +00:00
env :
RUST_BACKTRACE : "1"
2023-07-20 07:53:32 +00:00
- name : "`make uninstall`"
shell : bash
run : |
DESTDIR=/tmp/ make uninstall
# Check that the manpage is not present
! test -f /tmp/usr/local/share/man/man1/whoami.1
# Check that the completion is not present
! test -f /tmp/usr/local/share/zsh/site-functions/_install
! test -f /tmp/usr/local/share/bash-completion/completions/head
! test -f /tmp/usr/local/share/fish/vendor_completions.d/cat.fish
2021-04-02 20:22:50 +00:00
2022-03-07 20:48:15 +00:00
build_rust_stable :
name : Build/stable
needs : [ min_version, deps ]
runs-on : ${{ matrix.job.os }}
2022-08-20 17:29:25 +00:00
timeout-minutes : 90
2023-03-08 21:39:39 +00:00
env :
SCCACHE_GHA_ENABLED : "true"
RUSTC_WRAPPER : "sccache"
2022-03-07 20:48:15 +00:00
strategy :
fail-fast : false
matrix :
job :
- { os: ubuntu-latest , features : feat_os_unix }
- { os: macos-latest , features : feat_os_macos }
- { os: windows-latest , features : feat_os_windows }
steps :
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2023-04-22 14:49:49 +00:00
- uses : dtolnay/rust-toolchain@stable
2023-04-14 17:19:57 +00:00
- uses : taiki-e/install-action@nextest
2023-04-15 09:55:40 +00:00
- uses : Swatinem/rust-cache@v2
- name : Run sccache-cache
uses : mozilla-actions/sccache-action@v0.0.3
2022-03-07 20:48:15 +00:00
- name : Test
2023-04-14 17:19:57 +00:00
run : cargo nextest run --hide-progress-bar --profile ci ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }}
2023-01-01 13:07:59 +00:00
env :
RUST_BACKTRACE : "1"
2022-03-07 20:48:15 +00:00
2022-03-07 20:48:42 +00:00
build_rust_nightly :
name : Build/nightly
needs : [ min_version, deps ]
runs-on : ${{ matrix.job.os }}
2022-08-20 17:29:25 +00:00
timeout-minutes : 90
2023-03-08 21:39:39 +00:00
env :
SCCACHE_GHA_ENABLED : "true"
RUSTC_WRAPPER : "sccache"
2022-03-07 20:48:42 +00:00
strategy :
fail-fast : false
matrix :
job :
- { os: ubuntu-latest , features : feat_os_unix }
- { os: macos-latest , features : feat_os_macos }
- { os: windows-latest , features : feat_os_windows }
steps :
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2023-04-22 14:49:49 +00:00
- uses : dtolnay/rust-toolchain@nightly
2023-04-14 17:19:57 +00:00
- uses : taiki-e/install-action@nextest
2023-04-15 09:55:40 +00:00
- uses : Swatinem/rust-cache@v2
- name : Run sccache-cache
uses : mozilla-actions/sccache-action@v0.0.3
2022-03-07 20:48:42 +00:00
- name : Test
2023-04-14 17:19:57 +00:00
run : cargo nextest run --hide-progress-bar --profile ci ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }}
2023-01-01 13:07:59 +00:00
env :
RUST_BACKTRACE : "1"
2022-03-07 20:48:42 +00:00
2022-01-30 18:58:47 +00:00
compute_size :
name : Binary sizes
needs : [ min_version, deps ]
runs-on : ${{ matrix.job.os }}
2023-03-08 21:39:39 +00:00
env :
SCCACHE_GHA_ENABLED : "true"
RUSTC_WRAPPER : "sccache"
2022-01-30 18:58:47 +00:00
strategy :
fail-fast : false
matrix :
job :
- { os: ubuntu-latest , features : feat_os_unix }
steps :
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2023-04-22 14:49:49 +00:00
- uses : dtolnay/rust-toolchain@stable
2023-03-10 15:41:05 +00:00
- uses : Swatinem/rust-cache@v2
2023-03-08 21:39:39 +00:00
- name : Run sccache-cache
2023-03-23 09:29:03 +00:00
uses : mozilla-actions/sccache-action@v0.0.3
2022-01-30 18:58:47 +00:00
- name : Install dependencies
shell : bash
run : |
## Install dependencies
sudo apt-get update
sudo apt-get install jq
- name : "`make install`"
shell : bash
run : |
2023-01-18 17:41:39 +00:00
## `make install`
2022-01-30 18:58:47 +00:00
make install DESTDIR=target/size-release/
make install MULTICALL=y DESTDIR=target/size-multi-release/
# strip the results
strip target/size*/usr/local/bin/*
2023-01-18 17:41:39 +00:00
- name : Compute uutil release sizes
2022-01-30 18:58:47 +00:00
shell : bash
run : |
2023-01-18 17:41:39 +00:00
## Compute uutil release sizes
2023-03-31 05:46:29 +00:00
DATE=$(date --rfc-email)
find target/size-release/usr/local/bin -type f -printf '%f\0' | sort -z |
while IFS= read -r -d '' name; do
size=$(du -s target/size-release/usr/local/bin/$name | awk '{print $1}')
echo "\"$name\""
echo "$size"
done | \
jq -n \
--arg date "$DATE" \
--arg sha "$GITHUB_SHA" \
'reduce inputs as $name ({}; . + { ($name): input }) | { ($date): {sha: $sha, sizes: map_values(.)} }' > individual-size-result.json
SIZE=$(cat individual-size-result.json | jq '[.[] | .sizes | .[]] | reduce .[] as $num (0; . + $num)')
SIZE_MULTI=$(du -s target/size-multi-release/usr/local/bin/coreutils | awk '{print $1}')
2022-01-30 18:58:47 +00:00
jq -n \
2023-03-31 05:46:29 +00:00
--arg date "$DATE" \
2022-01-30 18:58:47 +00:00
--arg sha "$GITHUB_SHA" \
--arg size "$SIZE" \
2023-01-18 17:42:06 +00:00
--arg multisize "$SIZE_MULTI" \
2022-03-13 20:03:40 +00:00
'{($date): { sha: $sha, size: $size, multisize: $multisize, }}' > size-result.json
2023-04-17 06:24:57 +00:00
- name : Download the previous individual size result
uses : dawidd6/action-download-artifact@v2
with :
workflow : CICD.yml
name : individual-size-result
repo : uutils/coreutils
path : dl
- name : Download the previous size result
uses : dawidd6/action-download-artifact@v2
with :
workflow : CICD.yml
name : size-result
repo : uutils/coreutils
path : dl
- name : Check uutil release sizes
shell : bash
run : |
check() {
# Warn if the size increases by more than 5%
threshold='1.05'
2023-10-06 20:08:04 +00:00
if [[ "$2" -eq 0 || "$3" -eq 0 ]]; then
echo "::warning file=$4::Invalid size for $1. Sizes cannot be 0."
return
fi
2023-04-17 06:24:57 +00:00
ratio=$(jq -n "$2 / $3")
echo "$1: size=$2, previous_size=$3, ratio=$ratio, threshold=$threshold"
if [[ "$(jq -n "$ratio > $threshold")" == 'true' ]]; then
echo "::warning file=$4::Size of $1 increases by more than 5%"
fi
}
## Check individual size result
while read -r name previous_size; do
size=$(cat individual-size-result.json | jq -r ".[] | .sizes | .\"$name\"")
check "\`$name\` binary" "$size" "$previous_size" 'individual-size-result.json'
done < <(cat dl/individual-size-result.json | jq -r '.[] | .sizes | to_entries[] | "\(.key) \(.value)"')
## Check size result
size=$(cat size-result.json | jq -r '.[] | .size')
previous_size=$(cat dl/size-result.json | jq -r '.[] | .size')
check 'multiple binaries' "$size" "$previous_size" 'size-result.json'
multisize=$(cat size-result.json | jq -r '.[] | .multisize')
previous_multisize=$(cat dl/size-result.json | jq -r '.[] | .multisize')
check 'multicall binary' "$multisize" "$previous_multisize" 'size-result.json'
2023-03-31 05:46:29 +00:00
- name : Upload the individual size result
uses : actions/upload-artifact@v3
with :
name : individual-size-result
path : individual-size-result.json
- name : Upload the size result
uses : actions/upload-artifact@v3
2022-01-30 18:58:47 +00:00
with :
name : size-result
path : size-result.json
2020-01-28 01:59:40 +00:00
build :
2022-09-25 14:30:33 +00:00
permissions :
contents : write # to create GitHub release (softprops/action-gh-release)
2020-01-28 01:59:40 +00:00
name : Build
2021-11-10 19:37:00 +00:00
needs : [ min_version, deps ]
2020-01-28 01:59:40 +00:00
runs-on : ${{ matrix.job.os }}
2022-08-20 17:29:25 +00:00
timeout-minutes : 90
2022-09-04 21:06:58 +00:00
env :
DOCKER_OPTS : '--volume /etc/passwd:/etc/passwd --volume /etc/group:/etc/group'
2023-03-08 21:39:39 +00:00
SCCACHE_GHA_ENABLED : "true"
RUSTC_WRAPPER : "sccache"
2020-01-28 01:59:40 +00:00
strategy :
fail-fast : false
matrix :
job :
2023-11-11 17:53:15 +00:00
# - { os , target , cargo-options , features , use-cross , toolchain, skip-tests }
2021-11-17 03:31:15 +00:00
- { os: ubuntu-latest , target: arm-unknown-linux-gnueabihf, features: feat_os_unix_gnueabihf, use-cross : use-cross, }
2020-05-28 21:01:24 +00:00
- { os: ubuntu-latest , target: aarch64-unknown-linux-gnu , features: feat_os_unix_gnueabihf , use-cross : use-cross }
2021-07-12 15:33:24 +00:00
# - { os: ubuntu-latest , target: x86_64-unknown-linux-gnu , features: feat_selinux , use-cross: use-cross }
2023-11-11 17:53:15 +00:00
- { os: ubuntu-latest , target: i686-unknown-linux-gnu , features: feat_os_unix , use-cross : use-cross }
- { os: ubuntu-latest , target: i686-unknown-linux-musl , features: feat_os_unix_musl , use-cross : use-cross }
- { os: ubuntu-latest , target: x86_64-unknown-linux-gnu , features: feat_os_unix , use-cross : use-cross }
- { os: ubuntu-latest , target: x86_64-unknown-linux-musl , features: feat_os_unix_musl , use-cross : use-cross }
- { os: macos-latest , target: aarch64-apple-darwin , features: feat_os_macos , use-cross: use-cross, skip-tests : true } # Hopefully github provides free M1 runners soon...
2020-04-20 03:06:51 +00:00
- { os: macos-latest , target: x86_64-apple-darwin , features : feat_os_macos }
2020-01-28 01:59:40 +00:00
- { os: windows-latest , target: i686-pc-windows-msvc , features : feat_os_windows }
2023-11-12 12:41:29 +00:00
- { os: windows-latest , target: x86_64-pc-windows-gnu , features : feat_os_windows }
2020-01-28 01:59:40 +00:00
- { os: windows-latest , target: x86_64-pc-windows-msvc , features : feat_os_windows }
steps :
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2023-04-22 14:49:49 +00:00
- uses : dtolnay/rust-toolchain@master
with :
toolchain : ${{ env.RUST_MIN_SRV }}
targets : ${{ matrix.job.target }}
2023-03-10 15:41:05 +00:00
- uses : Swatinem/rust-cache@v2
2023-04-15 09:55:40 +00:00
with :
key : "${{ matrix.job.os }}_${{ matrix.job.target }}"
2023-03-08 21:39:39 +00:00
- name : Run sccache-cache
2023-03-23 09:29:03 +00:00
uses : mozilla-actions/sccache-action@v0.0.3
2020-01-28 01:59:40 +00:00
- name : Initialize workflow variables
id : vars
shell : bash
run : |
## VARs setup
2023-01-18 17:34:08 +00:00
outputs() { step_id="${{ github.action }}"; for var in "$@" ; do echo steps.${step_id}.outputs.${var}="${!var}"; echo "${var}=${!var}" >> $GITHUB_OUTPUT; done; }
2020-01-28 01:59:40 +00:00
# toolchain
TOOLCHAIN="stable" ## default to "stable" toolchain
# * specify alternate/non-default TOOLCHAIN for *-pc-windows-gnu targets; gnu targets on Windows are broken for the standard *-pc-windows-msvc toolchain (refs: GH:rust-lang/rust#47048, GH:rust-lang/rust#53454, GH:rust-lang/cargo#6754)
case ${{ matrix.job.target }} in *-pc-windows-gnu) TOOLCHAIN="stable-${{ matrix.job.target }}" ;; esac;
# * use requested TOOLCHAIN if specified
if [ -n "${{ matrix.job.toolchain }}" ]; then TOOLCHAIN="${{ matrix.job.toolchain }}" ; fi
2021-05-31 21:01:54 +00:00
outputs TOOLCHAIN
2020-01-28 01:59:40 +00:00
# staging directory
STAGING='_staging'
2021-05-31 21:01:54 +00:00
outputs STAGING
2020-01-28 01:59:40 +00:00
# determine EXE suffix
EXE_suffix="" ; case '${{ matrix.job.target }}' in *-pc-windows-*) EXE_suffix=".exe" ;; esac;
2021-05-31 21:01:54 +00:00
outputs EXE_suffix
2020-01-28 01:59:40 +00:00
# parse commit reference info
2020-04-10 13:40:41 +00:00
echo GITHUB_REF=${GITHUB_REF}
echo GITHUB_SHA=${GITHUB_SHA}
2020-01-28 01:59:40 +00:00
REF_NAME=${GITHUB_REF#refs/*/}
2020-04-10 13:40:41 +00:00
unset REF_BRANCH ; case "${GITHUB_REF}" in refs/heads/*) REF_BRANCH=${GITHUB_REF#refs/heads/} ;; esac;
unset REF_TAG ; case "${GITHUB_REF}" in refs/tags/*) REF_TAG=${GITHUB_REF#refs/tags/} ;; esac;
2022-02-22 23:12:12 +00:00
REF_SHAS=${GITHUB_SHA:0:10}
2021-05-31 21:01:54 +00:00
outputs REF_NAME REF_BRANCH REF_TAG REF_SHAS
2020-01-28 01:59:40 +00:00
# parse target
2020-05-28 21:01:24 +00:00
unset TARGET_ARCH
case '${{ matrix.job.target }}' in
aarch64-*) TARGET_ARCH=arm64 ;;
arm-*-*hf) TARGET_ARCH=armhf ;;
i586-*) TARGET_ARCH=i586 ;;
i686-*) TARGET_ARCH=i686 ;;
x86_64-*) TARGET_ARCH=x86_64 ;;
esac;
2020-01-28 01:59:40 +00:00
unset TARGET_OS ; case '${{ matrix.job.target }}' in *-linux-*) TARGET_OS=linux ;; *-apple-*) TARGET_OS=macos ;; *-windows-*) TARGET_OS=windows ;; esac;
2021-05-31 21:01:54 +00:00
outputs TARGET_ARCH TARGET_OS
2020-01-28 01:59:40 +00:00
# package name
PKG_suffix=".tar.gz" ; case '${{ matrix.job.target }}' in *-pc-windows-*) PKG_suffix=".zip" ;; esac;
PKG_BASENAME=${PROJECT_NAME}-${REF_TAG:-$REF_SHAS}-${{ matrix.job.target }}
PKG_NAME=${PKG_BASENAME}${PKG_suffix}
2021-05-31 21:01:54 +00:00
outputs PKG_suffix PKG_BASENAME PKG_NAME
2020-01-28 01:59:40 +00:00
# deployable tag? (ie, leading "vM" or "M"; M == version number)
2020-05-28 21:01:24 +00:00
unset DEPLOY ; if [[ $REF_TAG =~ ^[vV]?[0-9].* ]]; then DEPLOY='true' ; fi
2021-05-31 21:01:54 +00:00
outputs DEPLOY
2020-05-28 21:01:24 +00:00
# DPKG architecture?
unset DPKG_ARCH
case ${{ matrix.job.target }} in
x86_64-*-linux-*) DPKG_ARCH=amd64 ;;
*-linux-*) DPKG_ARCH=${TARGET_ARCH} ;;
esac
2021-05-31 21:01:54 +00:00
outputs DPKG_ARCH
2020-05-28 21:01:24 +00:00
# DPKG version?
unset DPKG_VERSION ; if [[ $REF_TAG =~ ^[vV]?[0-9].* ]]; then DPKG_VERSION=${REF_TAG/#[vV]/} ; fi
2021-05-31 21:01:54 +00:00
outputs DPKG_VERSION
2020-05-28 21:01:24 +00:00
# DPKG base name/conflicts?
DPKG_BASENAME=${PROJECT_NAME}
DPKG_CONFLICTS=${PROJECT_NAME}-musl
case ${{ matrix.job.target }} in *-musl) DPKG_BASENAME=${PROJECT_NAME}-musl ; DPKG_CONFLICTS=${PROJECT_NAME} ;; esac;
2021-05-31 21:01:54 +00:00
outputs DPKG_BASENAME DPKG_CONFLICTS
2020-05-28 21:01:24 +00:00
# DPKG name
unset DPKG_NAME;
if [[ -n $DPKG_ARCH && -n $DPKG_VERSION ]]; then DPKG_NAME="${DPKG_BASENAME}_${DPKG_VERSION}_${DPKG_ARCH}.deb" ; fi
2021-05-31 21:01:54 +00:00
outputs DPKG_NAME
2020-01-28 01:59:40 +00:00
# target-specific options
2020-03-10 19:23:15 +00:00
# * CARGO_FEATURES_OPTION
CARGO_FEATURES_OPTION='' ;
2022-03-18 18:40:26 +00:00
if [ -n "${{ matrix.job.features }}" ]; then CARGO_FEATURES_OPTION='--features=${{ matrix.job.features }}' ; fi
2021-05-31 21:01:54 +00:00
outputs CARGO_FEATURES_OPTION
2022-11-18 06:20:22 +00:00
# * CARGO_CMD
CARGO_CMD='cross' ; case '${{ matrix.job.use-cross }}' in ''|0|f|false|n|no) CARGO_CMD='cargo' ;; esac;
outputs CARGO_CMD
2020-06-14 00:38:24 +00:00
# ** pass needed environment into `cross` container (iff `cross` not already configured via "Cross.toml")
2022-11-18 06:20:22 +00:00
if [ "${CARGO_CMD}" = 'cross' ] && [ ! -e "Cross.toml" ] ; then
2023-04-22 14:49:49 +00:00
printf "[build.env]\npassthrough = [\"CI\", \"RUST_BACKTRACE\", \"CARGO_TERM_COLOR\"]\n" > Cross.toml
2020-06-14 00:38:24 +00:00
fi
2020-05-28 21:01:24 +00:00
# * test only library and/or binaries for arm-type targets
unset CARGO_TEST_OPTIONS ; case '${{ matrix.job.target }}' in aarch64-* | arm-*) CARGO_TEST_OPTIONS="--bins" ;; esac;
2021-05-31 21:01:54 +00:00
outputs CARGO_TEST_OPTIONS
2020-05-28 21:01:24 +00:00
# * executable for `strip`?
STRIP="strip"
case ${{ matrix.job.target }} in
aarch64-*-linux-gnu) STRIP="aarch64-linux-gnu-strip" ;;
arm-*-linux-gnueabihf) STRIP="arm-linux-gnueabihf-strip" ;;
*-pc-windows-msvc) STRIP="" ;;
esac;
2021-05-31 21:01:54 +00:00
outputs STRIP
2023-04-22 14:25:37 +00:00
- uses : taiki-e/install-action@v2
if : steps.vars.outputs.CARGO_CMD == 'cross'
with :
2023-11-11 17:53:15 +00:00
tool : cross@0.2.5
2020-01-28 01:59:40 +00:00
- name : Create all needed build/work directories
shell : bash
run : |
2021-06-12 18:46:37 +00:00
## Create build/work space
2020-01-28 01:59:40 +00:00
mkdir -p '${{ steps.vars.outputs.STAGING }}'
mkdir -p '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}'
2020-05-28 21:01:24 +00:00
mkdir -p '${{ steps.vars.outputs.STAGING }}/dpkg'
2021-11-14 22:24:18 +00:00
- name : Install/setup prerequisites
shell : bash
run : |
## Install/setup prerequisites
case '${{ matrix.job.target }}' in
arm-unknown-linux-gnueabihf) sudo apt-get -y update ; sudo apt-get -y install gcc-arm-linux-gnueabihf ;;
aarch64-unknown-linux-gnu) sudo apt-get -y update ; sudo apt-get -y install gcc-aarch64-linux-gnu ;;
esac
case '${{ matrix.job.os }}' in
macos-latest) brew install coreutils ;; # needed for testing
esac
2022-02-22 22:35:16 +00:00
case '${{ matrix.job.os }}' in
ubuntu-*)
# pinky is a tool to show logged-in users from utmp, and gecos fields from /etc/passwd.
# In GitHub Action *nix VMs, no accounts log in, even the "runner" account that runs the commands. The account also has empty gecos fields.
# To work around this for pinky tests, we create a fake login entry for the GH runner account...
FAKE_UTMP='[7] [999999] [tty2] [runner] [tty2] [] [0.0.0.0] [2022-02-22T22:22:22,222222+00:00]'
# ... by dumping the login records, adding our fake line, then reverse dumping ...
(utmpdump /var/run/utmp ; echo $FAKE_UTMP) | sudo utmpdump -r -o /var/run/utmp
# ... and add a full name to each account with a gecos field but no full name.
sudo sed -i 's/:,/:runner name,/' /etc/passwd
# We also create a couple optional files pinky looks for
touch /home/runner/.project
echo "foo" > /home/runner/.plan
;;
esac
2020-08-03 15:08:15 +00:00
- name : Initialize toolchain-dependent workflow variables
id : dep_vars
shell : bash
run : |
## Dependent VARs setup
2023-01-18 17:34:08 +00:00
outputs() { step_id="${{ github.action }}"; for var in "$@" ; do echo steps.${step_id}.outputs.${var}="${!var}"; echo "${var}=${!var}" >> $GITHUB_OUTPUT; done; }
2020-08-03 15:08:15 +00:00
# * determine sub-crate utility list
2022-03-18 18:40:26 +00:00
UTILITY_LIST="$(./util/show-utils.sh ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }})"
2021-05-31 21:01:54 +00:00
echo UTILITY_LIST=${UTILITY_LIST}
2022-10-20 06:59:00 +00:00
CARGO_UTILITY_LIST_OPTIONS="$(for u in ${UTILITY_LIST}; do echo -n "-puu_${u} "; done;)"
2021-05-31 21:01:54 +00:00
outputs CARGO_UTILITY_LIST_OPTIONS
2020-01-28 01:59:40 +00:00
- name : Info
shell : bash
run : |
2021-06-12 18:46:37 +00:00
## Info
# commit info
2020-04-08 19:52:03 +00:00
echo "## commit"
echo GITHUB_REF=${GITHUB_REF}
echo GITHUB_SHA=${GITHUB_SHA}
2021-06-12 18:46:37 +00:00
# environment
2020-06-14 00:38:24 +00:00
echo "## environment"
echo "CI='${CI}'"
2021-06-12 18:46:37 +00:00
# tooling info display
2020-04-08 16:30:31 +00:00
echo "## tooling"
2020-01-28 01:59:40 +00:00
which gcc >/dev/null 2>&1 && (gcc --version | head -1) || true
2021-06-23 15:05:49 +00:00
rustup -V 2>/dev/null
2020-04-08 16:30:31 +00:00
rustup show active-toolchain
2020-01-28 01:59:40 +00:00
cargo -V
rustc -V
2022-09-12 11:22:33 +00:00
cargo tree -V
2021-06-12 18:46:37 +00:00
# dependencies
2020-04-08 16:30:31 +00:00
echo "## dependency list"
2020-10-23 15:25:18 +00:00
cargo fetch --locked --quiet
2022-09-12 11:22:33 +00:00
cargo tree --locked --target=${{ matrix.job.target }} ${{ matrix.job.cargo-options }} ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} --all --no-dev-dependencies --no-indent | grep -vE "$PWD" | sort --unique
2020-01-28 01:59:40 +00:00
- name : Build
2022-11-18 06:20:22 +00:00
shell : bash
run : |
2023-01-18 17:41:39 +00:00
## Build
2022-11-18 06:20:22 +00:00
${{ steps.vars.outputs.CARGO_CMD }} +${{ env.RUST_MIN_SRV }} build --release \
--target=${{ matrix.job.target }} ${{ matrix.job.cargo-options }} ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }}
2020-01-28 01:59:40 +00:00
- name : Test
2023-11-11 17:53:15 +00:00
if : matrix.job.skip-tests != true
2022-11-18 06:20:22 +00:00
shell : bash
run : |
2023-01-18 17:41:39 +00:00
## Test
2022-11-18 06:20:22 +00:00
${{ steps.vars.outputs.CARGO_CMD }} +${{ env.RUST_MIN_SRV }} test --target=${{ matrix.job.target }} \
${{ steps.vars.outputs.CARGO_TEST_OPTIONS}} ${{ matrix.job.cargo-options }} ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }}
2023-01-01 13:07:59 +00:00
env :
RUST_BACKTRACE : "1"
2020-08-03 15:08:15 +00:00
- name : Test individual utilities
2023-11-11 17:53:15 +00:00
if : matrix.job.skip-tests != true
2022-11-18 06:20:22 +00:00
shell : bash
run : |
2023-01-18 17:41:39 +00:00
## Test individual utilities
2022-11-18 06:20:22 +00:00
${{ steps.vars.outputs.CARGO_CMD }} +${{ env.RUST_MIN_SRV }} test --target=${{ matrix.job.target }} \
${{ steps.vars.outputs.CARGO_TEST_OPTIONS}} ${{ matrix.job.cargo-options }} ${{ steps.dep_vars.outputs.CARGO_UTILITY_LIST_OPTIONS }}
2023-01-01 13:07:59 +00:00
env :
RUST_BACKTRACE : "1"
2020-01-28 01:59:40 +00:00
- name : Archive executable artifacts
2022-05-06 06:38:13 +00:00
uses : actions/upload-artifact@v3
2020-01-28 01:59:40 +00:00
with :
name : ${{ env.PROJECT_NAME }}-${{ matrix.job.target }}
path : target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}
- name : Package
shell : bash
run : |
2021-06-12 18:46:37 +00:00
## Package artifact(s)
2020-01-28 01:59:40 +00:00
# binary
cp 'target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/'
# `strip` binary (if needed)
if [ -n "${{ steps.vars.outputs.STRIP }}" ]; then "${{ steps.vars.outputs.STRIP }}" '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' ; fi
# README and LICENSE
2020-03-18 05:05:58 +00:00
# * spell-checker:ignore EADME ICENSE
(shopt -s nullglob; for f in [R]"EADME"{,.*}; do cp $f '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/' ; done)
(shopt -s nullglob; for f in [L]"ICENSE"{-*,}{,.*}; do cp $f '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/' ; done)
2020-01-28 01:59:40 +00:00
# core compressed package
pushd '${{ steps.vars.outputs.STAGING }}/' >/dev/null
case '${{ matrix.job.target }}' in
*-pc-windows-*) 7z -y a '${{ steps.vars.outputs.PKG_NAME }}' '${{ steps.vars.outputs.PKG_BASENAME }}'/* | tail -2 ;;
*) tar czf '${{ steps.vars.outputs.PKG_NAME }}' '${{ steps.vars.outputs.PKG_BASENAME }}'/* ;;
esac
popd >/dev/null
2020-05-28 21:01:24 +00:00
# dpkg
if [ -n "${{ steps.vars.outputs.DPKG_NAME }}" ]; then
DPKG_DIR="${{ steps.vars.outputs.STAGING }}/dpkg"
# binary
install -Dm755 'target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' "${DPKG_DIR}/usr/bin/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}"
if [ -n "${{ steps.vars.outputs.STRIP }}" ]; then "${{ steps.vars.outputs.STRIP }}" "${DPKG_DIR}/usr/bin/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}" ; fi
# README and LICENSE
(shopt -s nullglob; for f in [R]"EADME"{,.*}; do install -Dm644 "$f" "${DPKG_DIR}/usr/share/doc/${{ env.PROJECT_NAME }}/$f" ; done)
(shopt -s nullglob; for f in [L]"ICENSE"{-*,}{,.*}; do install -Dm644 "$f" "${DPKG_DIR}/usr/share/doc/${{ env.PROJECT_NAME }}/$f" ; done)
# control file
mkdir -p "${DPKG_DIR}/DEBIAN"
printf "Package: ${{ steps.vars.outputs.DPKG_BASENAME }}\nVersion: ${{ steps.vars.outputs.DPKG_VERSION }}\nSection: utils\nPriority: optional\nMaintainer: ${{ env.PROJECT_AUTH }}\nArchitecture: ${{ steps.vars.outputs.DPKG_ARCH }}\nProvides: ${{ env.PROJECT_NAME }}\nConflicts: ${{ steps.vars.outputs.DPKG_CONFLICTS }}\nDescription: ${{ env.PROJECT_DESC }}\n" > "${DPKG_DIR}/DEBIAN/control"
# build dpkg
fakeroot dpkg-deb --build "${DPKG_DIR}" "${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.DPKG_NAME }}"
fi
2020-01-28 01:59:40 +00:00
- name : Publish
uses : softprops/action-gh-release@v1
2020-05-28 21:01:24 +00:00
if : steps.vars.outputs.DEPLOY
2020-01-28 01:59:40 +00:00
with :
files : |
${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_NAME }}
2020-05-28 21:01:24 +00:00
${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.DPKG_NAME }}
2020-01-28 01:59:40 +00:00
env :
GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
2021-06-12 18:46:37 +00:00
test_busybox :
name : Tests/BusyBox test suite
2021-11-10 19:37:00 +00:00
needs : [ min_version, deps ]
2021-06-12 18:46:37 +00:00
runs-on : ${{ matrix.job.os }}
2023-03-08 21:39:39 +00:00
env :
SCCACHE_GHA_ENABLED : "true"
RUSTC_WRAPPER : "sccache"
2021-06-12 18:46:37 +00:00
strategy :
fail-fast : false
matrix :
job :
- { os : ubuntu-latest }
steps :
2022-12-04 16:19:44 +00:00
- name : Initialize workflow variables
id : vars
shell : bash
run : |
## VARs setup
echo "TEST_SUMMARY_FILE=busybox-result.json" >> $GITHUB_OUTPUT
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2023-03-10 15:41:05 +00:00
- uses : Swatinem/rust-cache@v2
2023-03-08 21:39:39 +00:00
- name : Run sccache-cache
2023-03-23 09:29:03 +00:00
uses : mozilla-actions/sccache-action@v0.0.3
2021-11-14 22:24:18 +00:00
- name : Install/setup prerequisites
shell : bash
run : |
## Install/setup prerequisites
make prepare-busytest
2023-01-18 17:41:39 +00:00
- name : Run BusyBox test suite
2022-12-04 16:19:44 +00:00
id : summary
2021-06-12 18:46:37 +00:00
shell : bash
run : |
2023-01-18 17:41:39 +00:00
## Run BusyBox test suite
2022-12-04 16:19:44 +00:00
set -v
2022-12-03 16:57:37 +00:00
cp .busybox-config target/debug/.config
2021-06-12 18:46:37 +00:00
## Run BusyBox test suite
bindir=$(pwd)/target/debug
cd tmp/busybox-*/testsuite
output=$(bindir=$bindir ./runtest 2>&1 || true)
printf "%s\n" "${output}"
2022-12-04 16:19:44 +00:00
FAIL=$(echo "$output" | grep "^FAIL:\s" | wc --lines)
PASS=$(echo "$output" | grep "^PASS:\s" | wc --lines)
2022-12-06 09:45:28 +00:00
SKIP=$(echo "$output" | grep "^SKIPPED:\s" | wc --lines)
TOTAL=`expr $FAIL + $PASS + $SKIP`
2022-12-04 16:19:44 +00:00
echo "FAIL $FAIL"
2022-12-06 09:45:28 +00:00
echo "SKIP $SKIP"
2022-12-04 16:19:44 +00:00
echo "PASS $PASS"
echo "TOTAL $TOTAL"
cd -
2022-12-06 07:52:05 +00:00
output="Busybox tests summary = TOTAL: $TOTAL / PASS: $PASS / FAIL: $FAIL / SKIP: $SKIP"
echo "${output}"
if [[ "$FAIL" -gt 0 || "$ERROR" -gt 0 ]]; then echo "::warning ::${output}" ; fi
2022-12-04 16:19:44 +00:00
jq -n \
--arg date "$(date --rfc-email)" \
--arg sha "$GITHUB_SHA" \
--arg total "$TOTAL" \
--arg pass "$PASS" \
2022-12-06 09:45:28 +00:00
--arg skip "$SKIP" \
2022-12-04 16:19:44 +00:00
--arg fail "$FAIL" \
'{($date): { sha: $sha, total: $total, pass: $pass, skip: $skip, fail: $fail, }}' > '${{ steps.vars.outputs.TEST_SUMMARY_FILE }}'
HASH=$(sha1sum '${{ steps.vars.outputs.TEST_SUMMARY_FILE }}' | cut --delim=" " -f 1)
echo "HASH=${HASH}" >> $GITHUB_OUTPUT
- name : Reserve SHA1/ID of 'test-summary'
uses : actions/upload-artifact@v3
with :
name : "${{ steps.summary.outputs.HASH }}"
path : "${{ steps.vars.outputs.TEST_SUMMARY_FILE }}"
- name : Reserve test results summary
uses : actions/upload-artifact@v3
with :
name : test-summary
path : "${{ steps.vars.outputs.TEST_SUMMARY_FILE }}"
- name : Upload json results
uses : actions/upload-artifact@v3
with :
name : busybox-result.json
path : ${{ steps.vars.outputs.TEST_SUMMARY_FILE }}
2021-06-12 18:46:37 +00:00
2022-12-07 08:19:27 +00:00
test_toybox :
name : Tests/Toybox test suite
needs : [ min_version, deps ]
runs-on : ${{ matrix.job.os }}
2023-03-08 21:39:39 +00:00
env :
SCCACHE_GHA_ENABLED : "true"
RUSTC_WRAPPER : "sccache"
2022-12-07 08:19:27 +00:00
strategy :
fail-fast : false
matrix :
job :
- { os : ubuntu-latest }
steps :
- name : Initialize workflow variables
id : vars
shell : bash
run : |
## VARs setup
2023-01-18 17:34:08 +00:00
outputs() { step_id="${{ github.action }}"; for var in "$@" ; do echo steps.${step_id}.outputs.${var}="${!var}"; echo "${var}=${!var}" >> $GITHUB_OUTPUT; done; }
2023-01-18 17:43:07 +00:00
TEST_SUMMARY_FILE="toybox-result.json"
outputs TEST_SUMMARY_FILE
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2023-04-22 14:49:49 +00:00
- uses : dtolnay/rust-toolchain@master
with :
toolchain : ${{ env.RUST_MIN_SRV }}
components : rustfmt
2023-04-15 09:55:40 +00:00
- uses : Swatinem/rust-cache@v2
- name : Run sccache-cache
uses : mozilla-actions/sccache-action@v0.0.3
2023-01-18 17:41:39 +00:00
- name : Build coreutils as multiple binaries
2022-12-07 08:19:27 +00:00
shell : bash
run : |
2023-01-18 17:41:39 +00:00
## Build individual uutil binaries
2022-12-07 08:19:27 +00:00
set -v
make
- name : Install/setup prerequisites
shell : bash
run : |
## Install/setup prerequisites
make toybox-src
2023-01-18 17:41:39 +00:00
- name : Run Toybox test suite
2022-12-07 08:19:27 +00:00
id : summary
shell : bash
run : |
## Run Toybox test suite
2023-01-18 17:41:39 +00:00
set -v
2022-12-07 08:19:27 +00:00
cd tmp/toybox-*/
make defconfig
make tests &> tmp.log || true
cat tmp.log
FAIL=$(grep "FAIL" tmp.log | wc --lines)
PASS=$(grep "PASS:" tmp.log| wc --lines)
SKIP=$(grep " disabled$" tmp.log| wc --lines)
TOTAL=`expr $FAIL + $PASS + $SKIP`
echo "FAIL $FAIL"
echo "SKIP $SKIP"
echo "PASS $PASS"
echo "TOTAL $TOTAL"
cd -
jq -n \
--arg date "$(date --rfc-email)" \
--arg sha "$GITHUB_SHA" \
--arg total "$TOTAL" \
--arg pass "$PASS" \
--arg skip "$SKIP" \
--arg fail "$FAIL" \
'{($date): { sha: $sha, total: $total, pass: $pass, skip: $skip, fail: $fail, }}' > '${{ steps.vars.outputs.TEST_SUMMARY_FILE }}'
output="Toybox tests summary = TOTAL: $TOTAL / PASS: $PASS / FAIL: $FAIL / SKIP: $SKIP"
echo "${output}"
if [[ "$FAIL" -gt 0 || "$ERROR" -gt 0 ]]; then echo "::warning ::${output}" ; fi
HASH=$(sha1sum '${{ steps.vars.outputs.TEST_SUMMARY_FILE }}' | cut --delim=" " -f 1)
echo "HASH=${HASH}" >> $GITHUB_OUTPUT
- name : Reserve SHA1/ID of 'test-summary'
uses : actions/upload-artifact@v3
with :
name : "${{ steps.summary.outputs.HASH }}"
path : "${{ steps.vars.outputs.TEST_SUMMARY_FILE }}"
- name : Reserve test results summary
uses : actions/upload-artifact@v3
with :
name : test-summary
path : "${{ steps.vars.outputs.TEST_SUMMARY_FILE }}"
- name : Upload json results
uses : actions/upload-artifact@v3
with :
name : toybox-result.json
path : ${{ steps.vars.outputs.TEST_SUMMARY_FILE }}
2020-01-28 01:59:40 +00:00
coverage :
name : Code Coverage
runs-on : ${{ matrix.job.os }}
2022-08-20 17:29:25 +00:00
timeout-minutes : 90
2023-03-08 21:39:39 +00:00
env :
SCCACHE_GHA_ENABLED : "true"
RUSTC_WRAPPER : "sccache"
2020-01-28 01:59:40 +00:00
strategy :
2022-06-06 19:21:19 +00:00
fail-fast : false
2020-01-28 01:59:40 +00:00
matrix :
2020-04-08 19:52:03 +00:00
job :
2023-04-15 09:55:40 +00:00
- { os: ubuntu-latest , features: unix, toolchain : nightly }
- { os: macos-latest , features: macos, toolchain : nightly }
- { os: windows-latest , features: windows, toolchain : nightly-x86_64-pc-windows-gnu }
2020-01-28 01:59:40 +00:00
steps :
2023-09-04 15:42:41 +00:00
- uses : actions/checkout@v4
2023-04-22 14:49:49 +00:00
- uses : dtolnay/rust-toolchain@master
with :
toolchain : ${{ matrix.job.toolchain }}
components : rustfmt
2023-04-14 17:19:57 +00:00
- uses : taiki-e/install-action@nextest
2023-04-22 14:25:37 +00:00
- uses : taiki-e/install-action@grcov
2023-03-10 15:41:05 +00:00
- uses : Swatinem/rust-cache@v2
2023-03-08 21:39:39 +00:00
- name : Run sccache-cache
2023-03-23 09:29:03 +00:00
uses : mozilla-actions/sccache-action@v0.0.3
2020-01-28 01:59:40 +00:00
# - name: Reattach HEAD ## may be needed for accurate code coverage info
# run: git checkout ${{ github.head_ref }}
- name : Initialize workflow variables
id : vars
shell : bash
run : |
2021-05-31 21:01:54 +00:00
## VARs setup
2023-01-18 17:34:08 +00:00
outputs() { step_id="${{ github.action }}"; for var in "$@" ; do echo steps.${step_id}.outputs.${var}="${!var}"; echo "${var}=${!var}" >> $GITHUB_OUTPUT; done; }
2020-04-08 19:52:03 +00:00
# toolchain
2022-04-13 08:55:35 +00:00
TOOLCHAIN="nightly" ## default to "nightly" toolchain (required for certain required unstable compiler flags) ## !maint: refactor when stable channel has needed support
2020-05-02 21:52:28 +00:00
# * specify gnu-type TOOLCHAIN for windows; `grcov` requires gnu-style code coverage data files
case ${{ matrix.job.os }} in windows-*) TOOLCHAIN="$TOOLCHAIN-x86_64-pc-windows-gnu" ;; esac;
2020-04-08 19:52:03 +00:00
# * use requested TOOLCHAIN if specified
if [ -n "${{ matrix.job.toolchain }}" ]; then TOOLCHAIN="${{ matrix.job.toolchain }}" ; fi
2021-05-31 21:01:54 +00:00
outputs TOOLCHAIN
2020-01-28 01:59:40 +00:00
# staging directory
STAGING='_staging'
2021-05-31 21:01:54 +00:00
outputs STAGING
2020-04-08 19:52:03 +00:00
# target-specific options
# * CARGO_FEATURES_OPTION
CARGO_FEATURES_OPTION='--all-features' ; ## default to '--all-features' for code coverage
2022-03-19 21:21:28 +00:00
if [ -n "${{ matrix.job.features }}" ]; then CARGO_FEATURES_OPTION='--features=${{ matrix.job.features }}' ; fi
2021-05-31 21:01:54 +00:00
outputs CARGO_FEATURES_OPTION
2020-04-08 19:52:03 +00:00
# * CODECOV_FLAGS
CODECOV_FLAGS=$( echo "${{ matrix.job.os }}" | sed 's/[^[:alnum:]]/_/g' )
2021-05-31 21:01:54 +00:00
outputs CODECOV_FLAGS
2021-11-14 22:24:18 +00:00
- name : Install/setup prerequisites
shell : bash
run : |
## Install/setup prerequisites
case '${{ matrix.job.os }}' in
macos-latest) brew install coreutils ;; # needed for testing
esac
2022-02-22 22:35:16 +00:00
case '${{ matrix.job.os }}' in
ubuntu-latest)
# pinky is a tool to show logged-in users from utmp, and gecos fields from /etc/passwd.
# In GitHub Action *nix VMs, no accounts log in, even the "runner" account that runs the commands. The account also has empty gecos fields.
# To work around this for pinky tests, we create a fake login entry for the GH runner account...
FAKE_UTMP='[7] [999999] [tty2] [runner] [tty2] [] [0.0.0.0] [2022-02-22T22:22:22,222222+00:00]'
# ... by dumping the login records, adding our fake line, then reverse dumping ...
(utmpdump /var/run/utmp ; echo $FAKE_UTMP) | sudo utmpdump -r -o /var/run/utmp
# ... and add a full name to each account with a gecos field but no full name.
sudo sed -i 's/:,/:runner name,/' /etc/passwd
# We also create a couple optional files pinky looks for
touch /home/runner/.project
echo "foo" > /home/runner/.plan
;;
esac
2020-08-09 04:38:41 +00:00
- name : Initialize toolchain-dependent workflow variables
id : dep_vars
shell : bash
run : |
## Dependent VARs setup
2023-01-18 17:34:08 +00:00
outputs() { step_id="${{ github.action }}"; for var in "$@" ; do echo steps.${step_id}.outputs.${var}="${!var}"; echo "${var}=${!var}" >> $GITHUB_OUTPUT; done; }
2020-08-09 04:38:41 +00:00
# * determine sub-crate utility list
2022-03-18 18:40:26 +00:00
UTILITY_LIST="$(./util/show-utils.sh ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }})"
2022-10-20 06:59:00 +00:00
CARGO_UTILITY_LIST_OPTIONS="$(for u in ${UTILITY_LIST}; do echo -n "-puu_${u} "; done;)"
2021-05-31 21:01:54 +00:00
outputs CARGO_UTILITY_LIST_OPTIONS
2021-04-05 15:16:00 +00:00
- name : Test uucore
2023-04-14 17:19:57 +00:00
run : cargo nextest run --profile ci --hide-progress-bar -p uucore
2021-04-05 15:16:00 +00:00
env :
2021-11-17 03:31:15 +00:00
RUSTC_WRAPPER : ""
RUSTFLAGS : "-Zprofile -Ccodegen-units=1 -Copt-level=0 -Clink-dead-code -Coverflow-checks=off -Zpanic_abort_tests -Cpanic=abort"
RUSTDOCFLAGS : "-Cpanic=abort"
2023-01-01 13:07:59 +00:00
RUST_BACKTRACE : "1"
2021-04-05 15:16:00 +00:00
# RUSTUP_TOOLCHAIN: ${{ steps.vars.outputs.TOOLCHAIN }}
2020-04-08 19:52:03 +00:00
- name : Test
2023-04-14 17:19:57 +00:00
run : cargo nextest run --profile ci --hide-progress-bar ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }}
2020-01-28 01:59:40 +00:00
env :
2021-11-17 03:31:15 +00:00
RUSTC_WRAPPER : ""
RUSTFLAGS : "-Zprofile -Ccodegen-units=1 -Copt-level=0 -Clink-dead-code -Coverflow-checks=off -Zpanic_abort_tests -Cpanic=abort"
RUSTDOCFLAGS : "-Cpanic=abort"
2023-01-01 13:07:59 +00:00
RUST_BACKTRACE : "1"
2020-04-08 19:52:03 +00:00
# RUSTUP_TOOLCHAIN: ${{ steps.vars.outputs.TOOLCHAIN }}
2020-08-09 04:38:41 +00:00
- name : Test individual utilities
2023-04-14 17:19:57 +00:00
run : cargo nextest run --profile ci --hide-progress-bar ${{ steps.dep_vars.outputs.CARGO_UTILITY_LIST_OPTIONS }}
2020-08-09 04:38:41 +00:00
env :
2021-11-17 03:31:15 +00:00
RUSTC_WRAPPER : ""
RUSTFLAGS : "-Zprofile -Ccodegen-units=1 -Copt-level=0 -Clink-dead-code -Coverflow-checks=off -Zpanic_abort_tests -Cpanic=abort"
RUSTDOCFLAGS : "-Cpanic=abort"
2023-01-01 13:07:59 +00:00
RUST_BACKTRACE : "1"
2020-08-09 04:38:41 +00:00
# RUSTUP_TOOLCHAIN: ${{ steps.vars.outputs.TOOLCHAIN }}
2020-04-08 19:52:03 +00:00
- name : Generate coverage data (via `grcov`)
id : coverage
shell : bash
2020-01-28 01:59:40 +00:00
run : |
2021-06-12 18:46:37 +00:00
## Generate coverage data
2020-04-08 19:52:03 +00:00
COVERAGE_REPORT_DIR="target/debug"
COVERAGE_REPORT_FILE="${COVERAGE_REPORT_DIR}/lcov.info"
2022-01-01 23:50:11 +00:00
# GRCOV_IGNORE_OPTION='--ignore build.rs --ignore "vendor/*" --ignore "/*" --ignore "[a-zA-Z]:/*"' ## `grcov` ignores these params when passed as an environment variable (why?)
2020-08-10 06:06:54 +00:00
# GRCOV_EXCLUDE_OPTION='--excl-br-line "^\s*((debug_)?assert(_eq|_ne)?!|#\[derive\()"' ## `grcov` ignores these params when passed as an environment variable (why?)
2020-04-08 19:52:03 +00:00
mkdir -p "${COVERAGE_REPORT_DIR}"
2020-08-10 06:06:54 +00:00
# display coverage files
2022-11-19 08:54:44 +00:00
~/.cargo/bin/grcov . --output-type files --ignore build.rs --ignore "vendor/*" --ignore "/*" --ignore "[a-zA-Z]:/*" --excl-br-line "^\s*((debug_)?assert(_eq|_ne)?!|#\[derive\()" | sort --unique
2020-08-10 06:06:54 +00:00
# generate coverage report
2022-11-19 08:54:44 +00:00
~/.cargo/bin/grcov . --output-type lcov --output-path "${COVERAGE_REPORT_FILE}" --branch --ignore build.rs --ignore "vendor/*" --ignore "/*" --ignore "[a-zA-Z]:/*" --excl-br-line "^\s*((debug_)?assert(_eq|_ne)?!|#\[derive\()"
2022-10-20 06:59:00 +00:00
echo "report=${COVERAGE_REPORT_FILE}" >> $GITHUB_OUTPUT
2020-04-08 19:52:03 +00:00
- name : Upload coverage results (to Codecov.io)
2023-09-15 07:25:04 +00:00
uses : codecov/codecov-action@v3
2020-04-08 19:52:03 +00:00
# if: steps.vars.outputs.HAS_CODECOV_TOKEN
with :
# token: ${{ secrets.CODECOV_TOKEN }}
file : ${{ steps.coverage.outputs.report }}
## flags: IntegrationTests, UnitTests, ${{ steps.vars.outputs.CODECOV_FLAGS }}
flags : ${{ steps.vars.outputs.CODECOV_FLAGS }}
name : codecov-umbrella
2020-05-25 20:47:42 +00:00
fail_ci_if_error : false