mirror of
https://github.com/wolfSSL/wolfssl.git
synced 2026-07-05 17:30:51 +02:00
Juliusz Sosinowicz
3a6c31a51e
Replace the one-runner-per-configuration matrices across the
make-check workflow family with a generic pooled runner,
.github/scripts/parallel-make-check.py. Each workflow keeps its
configuration list as JSON next to the invocation; one runner (or a
small fixed set of shards, balanced by measured per-config minutes)
builds every config in its own out-of-tree (VPATH) build directory off
a single checkout/autogen, on a pool of one-per-CPU worker threads,
longest first. Concurrent checks are isolated with bubblewrap network
namespaces, compilations are cached with ccache, the first failure
aborts the rest (fail-fast, with --no-fail-fast to run everything),
and per-config timings plus pool efficiency land in the step summary.
Failure logs upload as artifacts. smoke-test.yml is likewise reworked
into a single pooled job that runs its nine configs on one runner.
Converted workflows (runner jobs per full pass):
os-check.yml 101 -> 8 (92 Ubuntu configs -> 4 shards;
the macOS matrix, the user-settings jobs and
the standalone
macos-apple-native-cert-validation.yml fold
into one macOS runner; Windows unchanged)
pq-all.yml 21 -> 2 shards
disable-pk-algs.yml 15 -> 1
wolfCrypt-Wconversion.yml 11 -> 1
trackmemory.yml 7 -> 1
cryptocb-only.yml 8 -> 1 (incl. the two new SHA512 entries)
multi-compiler.yml 6 -> 1
smallStackSize.yml 6 -> 1
multi-arch.yml 6 -> 1
async.yml 5 -> 1
psk.yml 5 -> 1
no-malloc.yml 3 -> 1
wolfsm.yml 3 -> 1
opensslcoexist.yml 2 -> 1
Measured against current upstream passing runs (job execution time,
queue excluded): ~200 runner jobs / ~374 runner-minutes per full pass
become 23 jobs / ~168 runner-minutes, with more coverage than before.
multi-arch's old matrix combined an "include" list of four
architectures with an "opts" axis; GitHub's include-merge rules made
each arch entry overwrite the previous one, so only the armel
combinations actually ran. The pooled list restores the intended
aarch64/armhf/riscv64 coverage (23 combinations; riscv64 x sp-math is
omitted as invalid - configure rejects sp-math without SP, and
--enable-riscv-asm, unlike --enable-sp-asm, does not bring SP in).
Out-of-tree build fixes this depends on:
- Makefile.am: symlink the read-only test data (certs/, tests/ config
files, sniffer captures and helpers, examples/crypto_policies,
input, quit) into the build tree via a BUILT_SOURCES stamp, removed
again in distclean-local. ChangeToWolfRoot() and the script tests
resolve everything relative to the working directory, so out-of-tree
make check and make distcheck now pass.
- scripts/multi-msg-record.py: locate the client binary from the build
tree working directory rather than the script's source directory.
- configure.ac + wolfssl/include.am: run
support/gen-debug-trace-error-codes.sh from $srcdir; it reads the
error-code headers from the source tree and generates into the build
tree.
- tests/swdev: a WOLFBUILD variable points the sub-make at the build
tree for the configure-generated headers (wolfssl/options.h,
wolfssl/version.h); the in-tree-only guards are dropped.
Portions of PR #10649 are incorporated: the cross-platform
ccache-setup composite action, repository_owner gates on check-headers
and check-source-text, the docs-only paths-ignore on os-check, and the
libspdm timeout bumps.
110 lines
3.7 KiB
YAML
110 lines
3.7 KiB
YAML
name: Check Source Text
|
|
|
|
# Source-hygiene + shell-script lint. Runs on drafts too - fast feedback.
|
|
#
|
|
# Checks:
|
|
# * check-source-text.sh: trailing whitespace, hard tabs in C/H, CRLF,
|
|
# BOM / non-ASCII.
|
|
# * bash -n + shellcheck (warning level) on shell scripts.
|
|
#
|
|
# Scope:
|
|
# * pull_request: only files changed in the PR (catches new violations
|
|
# without failing on historical debt).
|
|
# * push: scan the full tree (baseline guard on master).
|
|
|
|
on:
|
|
push:
|
|
branches: [ master, main ]
|
|
pull_request:
|
|
types: [opened, synchronize, reopened, ready_for_review]
|
|
branches: [ master, main ]
|
|
|
|
concurrency:
|
|
group: check-source-text-${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
check:
|
|
# Only run from the wolfssl org to avoid burning forks' CI minutes.
|
|
if: github.repository_owner == 'wolfssl'
|
|
runs-on: ubuntu-24.04
|
|
timeout-minutes: 5
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Install shellcheck
|
|
uses: ./.github/actions/install-apt-deps
|
|
with:
|
|
packages: shellcheck
|
|
|
|
- name: Collect files to check
|
|
id: files
|
|
run: |
|
|
if [ "${{ github.event_name }}" = "pull_request" ]; then
|
|
BASE_SHA="${{ github.event.pull_request.base.sha }}"
|
|
HEAD_SHA="${{ github.event.pull_request.head.sha }}"
|
|
git diff --name-only --diff-filter=ACMR "$BASE_SHA" "$HEAD_SHA" \
|
|
> changed.txt || true
|
|
grep -E '\.sh$' changed.txt > changed-sh.txt || true
|
|
echo "Files changed in PR:"
|
|
cat changed.txt
|
|
echo "Shell scripts changed:"
|
|
cat changed-sh.txt
|
|
echo "count=$(wc -l < changed.txt)" >> "$GITHUB_OUTPUT"
|
|
echo "sh_count=$(wc -l < changed-sh.txt)" >> "$GITHUB_OUTPUT"
|
|
else
|
|
: > changed.txt
|
|
git ls-files '*.sh' > changed-sh.txt
|
|
echo "count=0" >> "$GITHUB_OUTPUT"
|
|
echo "sh_count=$(wc -l < changed-sh.txt)" >> "$GITHUB_OUTPUT"
|
|
fi
|
|
|
|
- name: Run check-source-text (PR changed files)
|
|
if: github.event_name == 'pull_request' && steps.files.outputs.count != '0'
|
|
run: |
|
|
# shellcheck disable=SC2046
|
|
./.github/scripts/check-source-text.sh $(cat changed.txt)
|
|
|
|
- name: Run check-source-text (full tree)
|
|
if: github.event_name != 'pull_request'
|
|
run: ./.github/scripts/check-source-text.sh
|
|
|
|
- name: bash -n (syntax check)
|
|
if: steps.files.outputs.sh_count != '0'
|
|
run: |
|
|
fail=0
|
|
while IFS= read -r f; do
|
|
[ -f "$f" ] || continue
|
|
if ! bash -n "$f"; then
|
|
echo "::error file=$f::bash -n syntax error"
|
|
fail=1
|
|
fi
|
|
done < changed-sh.txt
|
|
exit "$fail"
|
|
|
|
- name: shellcheck (warning level)
|
|
if: steps.files.outputs.sh_count != '0'
|
|
run: |
|
|
# Mirrors the internal multi-test check-shell-scripts subtest:
|
|
# --severity=warning
|
|
# -e SC2226,SC2166,SC2164,SC2046,SC2034,SC2188,SC2043
|
|
# SC2226 (no ln destination), SC2166 ([ p -a q ]), SC2164 (cd ||),
|
|
# SC2046 (word splitting), SC2034 (unused var), SC2188 (redirect
|
|
# w/o command), SC2043 (loop runs once) - common in this codebase,
|
|
# suppressed in the internal multi-test for the same reason.
|
|
fail=0
|
|
while IFS= read -r f; do
|
|
[ -f "$f" ] || continue
|
|
if ! shellcheck --severity=warning \
|
|
--exclude=SC2226,SC2166,SC2164,SC2046,SC2034,SC2188,SC2043 \
|
|
--format=gcc "$f"; then
|
|
fail=1
|
|
fi
|
|
done < changed-sh.txt
|
|
exit "$fail"
|