Merge rust-bitcoin/rust-secp256k1#632: CI: test with commited lock files

3da39c6fb6 Run test with recent/minimal lock files (Tobin C. Harding)
4b9168ca25 Run WASM tests from test wrapper script (Tobin C. Harding)
637d08f1fe Add a layer of indirection to the test script (Tobin C. Harding)
d9b70d27b0 Remove trailing whitespace (Tobin C. Harding)
461bae9244 Move recent/minimal lock files (Tobin C. Harding)

Pull request description:

  A while back we added two lock files, one for testing with recent dependency versions and one for testing with minimal dependency versions but at the time we never used them in CI.

  Move the two current lock files and use them in CI (mirroring what is done in `rust-bitcoin`).

ACKs for top commit:
  apoelstra:
    ACK 3da39c6fb6

Tree-SHA512: 5d293689e8a67373cbf0d6b04894c38e636bb7da19db62ac2cc1b83f1dc8184e92169a834d9adf4de3c61c34d5f6f443a1be1d0c2503bb03f08fc486d68beb71

contrib/_test.sh

@@ -0,0 +1,129 @@
+#!/usr/bin/env bash
+
+set -ex
+
+REPO_DIR=$(git rev-parse --show-toplevel)
+FEATURES="bitcoin-hashes global-context lowmemory rand recovery serde std alloc bitcoin-hashes-std rand-std"
+
+cargo --version
+rustc --version
+
+# Work out if we are using a nightly toolchain.
+NIGHTLY=false
+if cargo --version | grep nightly; then
+    NIGHTLY=true
+fi
+
+# Pin dependencies as required if we are using MSRV toolchain.
+if cargo --version | grep "1\.48"; then
+    cargo update -p wasm-bindgen-test --precise 0.3.34
+    cargo update -p serde_test --precise 1.0.175
+fi
+
+# Test if panic in C code aborts the process (either with a real panic or with SIGILL)
+cargo test -- --ignored --exact 'tests::test_panic_raw_ctx_should_terminate_abnormally' 2>&1 \
+    | tee /dev/stderr \
+    | grep "SIGILL\\|\[libsecp256k1] illegal argument. !rustsecp256k1_v0_._._fe_is_zero(&ge->x)"
+
+# Make all cargo invocations verbose
+export CARGO_TERM_VERBOSE=true
+
+# Defaults / sanity checks
+cargo build --locked --all
+cargo test --locked --all
+
+if [ "$DO_FEATURE_MATRIX" = true ]; then
+    cargo build --locked --all --no-default-features
+    cargo test --locked --all --no-default-features
+
+    # All features
+    cargo build --locked --all --no-default-features --features="$FEATURES"
+    cargo test --locked --all --no-default-features --features="$FEATURES"
+    # Single features
+    for feature in ${FEATURES}
+    do
+        cargo build --locked --all --no-default-features --features="$feature"
+        cargo test --locked --all --no-default-features --features="$feature"
+    done
+    # Features tested with 'std' feature enabled.
+    for feature in ${FEATURES}
+    do
+        cargo build --locked --all --no-default-features --features="std,$feature"
+        cargo test --locked --all --no-default-features --features="std,$feature"
+    done
+    # Other combos
+    RUSTFLAGS='--cfg=secp256k1_fuzz' RUSTDOCFLAGS='--cfg=secp256k1_fuzz' cargo test --locked --all
+    RUSTFLAGS='--cfg=secp256k1_fuzz' RUSTDOCFLAGS='--cfg=secp256k1_fuzz' cargo test --locked --all --features="$FEATURES"
+    cargo test --locked --all --features="rand serde"
+
+    if [ "$NIGHTLY" = true ]; then
+        cargo test --locked --all --all-features
+        RUSTFLAGS='--cfg=secp256k1_fuzz' RUSTDOCFLAGS='--cfg=secp256k1_fuzz' cargo test --locked --all --all-features
+    fi
+
+    # Examples
+    cargo run --locked --example sign_verify --features=bitcoin-hashes-std
+    cargo run --locked --example sign_verify_recovery --features=recovery,bitcoin-hashes-std
+    cargo run --locked --example generate_keys --features=rand-std
+fi
+
+if [ "$DO_LINT" = true ]
+then
+    cargo clippy --locked --all-features --all-targets -- -D warnings
+    cargo clippy --locked --example sign_verify --features=bitcoin-hashes-std -- -D warnings
+    cargo clippy --locked --example sign_verify_recovery --features=recovery,bitcoin-hashes-std -- -D warnings
+    cargo clippy --locked --example generate_keys --features=rand-std -- -D warnings
+fi
+
+# Build the docs if told to (this only works with the nightly toolchain)
+if [ "$DO_DOCSRS" = true ]; then
+    RUSTDOCFLAGS="--cfg docsrs -D warnings -D rustdoc::broken-intra-doc-links" cargo +nightly doc --all-features
+fi
+
+# Build the docs with a stable toolchain, in unison with the DO_DOCSRS command
+# above this checks that we feature guarded docs imports correctly.
+if [ "$DO_DOCS" = true ]; then
+    RUSTDOCFLAGS="-D warnings" cargo +stable doc --all-features
+fi
+
+# Address Sanitizer
+if [ "$DO_ASAN" = true ]; then
+    clang --version
+    cargo clean
+    CC='clang -fsanitize=address -fno-omit-frame-pointer'                                        \
+    RUSTFLAGS='-Zsanitizer=address -Clinker=clang -Cforce-frame-pointers=yes'                    \
+    ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' \
+    cargo test --lib --all --features="$FEATURES" -Zbuild-std --target x86_64-unknown-linux-gnu
+    cargo clean
+    # The -Cllvm-args=-msan-eager-checks=0 flag was added to overcome this issue:
+    # https://github.com/rust-bitcoin/rust-secp256k1/pull/573#issuecomment-1399465995
+    CC='clang -fsanitize=memory -fno-omit-frame-pointer'                                                                        \
+    RUSTFLAGS='-Zsanitizer=memory -Zsanitizer-memory-track-origins -Cforce-frame-pointers=yes -Cllvm-args=-msan-eager-checks=0' \
+    cargo test --lib --all --features="$FEATURES" -Zbuild-std --target x86_64-unknown-linux-gnu
+
+    pushd "$REPO_DIR/no_std_test" > /dev/null || exit 1
+    # See https://github.com/rust-bitcoin/rust-secp256k1/pull/641#issuecomment-1671598914
+    cargo update -p cc --precise 1.0.79
+    popd > /dev/null || exit 1
+
+    cargo run --release --manifest-path=./no_std_test/Cargo.toml | grep -q "Verified Successfully"
+    cargo run --release --features=alloc --manifest-path=./no_std_test/Cargo.toml | grep -q "Verified alloc Successfully"
+fi
+
+# Run formatter if told to.
+if [ "$DO_FMT" = true ]; then
+    if [ "$NIGHTLY" = false ]; then
+        echo "DO_FMT requires a nightly toolchain (consider using RUSTUP_TOOLCHAIN)"
+        exit 1
+    fi
+    rustup component add rustfmt
+    cargo fmt --check || exit 1
+fi
+
+# Bench if told to, only works with non-stable toolchain (nightly, beta).
+if [ "$DO_BENCH" = true ]
+then
+    RUSTFLAGS='--cfg=bench' cargo bench --features=recovery,rand-std
+fi
+
+exit 0

contrib/test.sh

@@ -3,136 +3,38 @@
 set -ex
 
 REPO_DIR=$(git rev-parse --show-toplevel)
-FEATURES="bitcoin-hashes global-context lowmemory rand recovery serde std alloc bitcoin-hashes-std rand-std"
+DEPS="recent minimal"
-
-cargo --version
-rustc --version
-
-# Work out if we are using a nightly toolchain.
-NIGHTLY=false
-if cargo --version | grep nightly; then
-    NIGHTLY=true
-fi
-
-# Pin dependencies as required if we are using MSRV toolchain.
-if cargo --version | grep "1\.48"; then
-    cargo update -p wasm-bindgen-test --precise 0.3.34
-    cargo update -p serde_test --precise 1.0.175
-fi
-
-# Test if panic in C code aborts the process (either with a real panic or with SIGILL)
-cargo test -- --ignored --exact 'tests::test_panic_raw_ctx_should_terminate_abnormally' 2>&1 \
-    | tee /dev/stderr \
-    | grep "SIGILL\\|\[libsecp256k1] illegal argument. !rustsecp256k1_v0_._._fe_is_zero(&ge->x)"
-
-# Make all cargo invocations verbose
-export CARGO_TERM_VERBOSE=true
-
-# Defaults / sanity checks
-cargo build --all
-cargo test --all
-
-if [ "$DO_FEATURE_MATRIX" = true ]; then
-    cargo build --all --no-default-features
-    cargo test --all --no-default-features
-
-    # All features
-    cargo build --all --no-default-features --features="$FEATURES"
-    cargo test --all --no-default-features --features="$FEATURES"
-    # Single features
-    for feature in ${FEATURES}
-    do
-        cargo build --all --no-default-features --features="$feature"
-        cargo test --all --no-default-features --features="$feature"
-    done
-    # Features tested with 'std' feature enabled.
-    for feature in ${FEATURES}
-    do
-        cargo build --all --no-default-features --features="std,$feature"
-        cargo test --all --no-default-features --features="std,$feature"
-    done
-    # Other combos 
-    RUSTFLAGS='--cfg=secp256k1_fuzz' RUSTDOCFLAGS='--cfg=secp256k1_fuzz' cargo test --all
-    RUSTFLAGS='--cfg=secp256k1_fuzz' RUSTDOCFLAGS='--cfg=secp256k1_fuzz' cargo test --all --features="$FEATURES"
-    cargo test --all --features="rand serde"
-
-    if [ "$NIGHTLY" = true ]; then
-        cargo test --all --all-features
-        RUSTFLAGS='--cfg=secp256k1_fuzz' RUSTDOCFLAGS='--cfg=secp256k1_fuzz' cargo test --all --all-features
-    fi
-
-    # Examples
-    cargo run --example sign_verify --features=bitcoin-hashes-std
-    cargo run --example sign_verify_recovery --features=recovery,bitcoin-hashes-std
-    cargo run --example generate_keys --features=rand-std
-fi
-
-if [ "$DO_LINT" = true ]
-then
-    cargo clippy --all-features --all-targets -- -D warnings
-    cargo clippy --example sign_verify --features=bitcoin-hashes-std -- -D warnings
-    cargo clippy --example sign_verify_recovery --features=recovery,bitcoin-hashes-std -- -D warnings
-    cargo clippy --example generate_keys --features=rand-std -- -D warnings
-fi
-
-# Build the docs if told to (this only works with the nightly toolchain)
-if [ "$DO_DOCSRS" = true ]; then
-    RUSTDOCFLAGS="--cfg docsrs -D warnings -D rustdoc::broken-intra-doc-links" cargo +nightly doc --all-features
-fi
-
-# Build the docs with a stable toolchain, in unison with the DO_DOCSRS command
-# above this checks that we feature guarded docs imports correctly.
-if [ "$DO_DOCS" = true ]; then
-    RUSTDOCFLAGS="-D warnings" cargo +stable doc --all-features
-fi
 
 # Webassembly stuff
+#
+# The wasm-pack command does not correctly pass args to cargo so we cannot use --locked and test
+# with per-commited lockfiles (recent/minimal). Just run the WASM tests from here instead.
 if [ "$DO_WASM" = true ]; then
     clang --version
     CARGO_TARGET_DIR=wasm cargo install --force wasm-pack
     printf '\n[lib]\ncrate-type = ["cdylib", "rlib"]\n' >> Cargo.toml
     CC=clang wasm-pack build
     CC=clang wasm-pack test --node
+
+    exit 0
 fi
 
-# Address Sanitizer
+for dep in $DEPS
-if [ "$DO_ASAN" = true ]; then
+do
-    clang --version
+    cp "Cargo-$dep.lock" Cargo.lock
-    cargo clean
+    $REPO_DIR/contrib/_test.sh
-    CC='clang -fsanitize=address -fno-omit-frame-pointer'                                        \
-    RUSTFLAGS='-Zsanitizer=address -Clinker=clang -Cforce-frame-pointers=yes'                    \
-    ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' \
-    cargo test --lib --all --features="$FEATURES" -Zbuild-std --target x86_64-unknown-linux-gnu
-    cargo clean
-    # The -Cllvm-args=-msan-eager-checks=0 flag was added to overcome this issue:
-    # https://github.com/rust-bitcoin/rust-secp256k1/pull/573#issuecomment-1399465995
-    CC='clang -fsanitize=memory -fno-omit-frame-pointer'                                                                        \
-    RUSTFLAGS='-Zsanitizer=memory -Zsanitizer-memory-track-origins -Cforce-frame-pointers=yes -Cllvm-args=-msan-eager-checks=0' \
-    cargo test --lib --all --features="$FEATURES" -Zbuild-std --target x86_64-unknown-linux-gnu
 
-    pushd "$REPO_DIR/no_std_test" > /dev/null || exit 1
+    if [ "$dep" = recent ];
-    # See https://github.com/rust-bitcoin/rust-secp256k1/pull/641#issuecomment-1671598914
+    then
-    cargo update -p cc --precise 1.0.79
+        # We always test committed dependencies but we want to warn if they could've been updated
-    popd > /dev/null || exit 1
+        cargo update
-
+        if diff Cargo-recent.lock Cargo.lock;
-    cargo run --release --manifest-path=./no_std_test/Cargo.toml | grep -q "Verified Successfully"
+        then
-    cargo run --release --features=alloc --manifest-path=./no_std_test/Cargo.toml | grep -q "Verified alloc Successfully"
+            echo "Dependencies are up to date"
-fi
+        else
-
+            echo "::warning file=Cargo-recent.lock::Dependencies could be updated"
-# Run formatter if told to.
+        fi
-if [ "$DO_FMT" = true ]; then
-    if [ "$NIGHTLY" = false ]; then
-        echo "DO_FMT requires a nightly toolchain (consider using RUSTUP_TOOLCHAIN)"
-        exit 1
     fi
-    rustup component add rustfmt
+done
-    cargo fmt --check || exit 1
-fi
-
-# Bench if told to, only works with non-stable toolchain (nightly, beta).
-if [ "$DO_BENCH" = true ]
-then
-    RUSTFLAGS='--cfg=bench' cargo bench --features=recovery,rand-std
-fi
 
 exit 0