Merge rust-bitcoin/rust-miniscript#405: Improve the test script and CI pipeline

ed51323a0bb3257b09abfb5eb51ca21815b815af Rename and simplify integration test job (Tobin C. Harding)
27df8630e5c7f419d5f1a3d0d7b2095f3731ab82 Run feature matrix tests (Tobin C. Harding)
ca9988de6cb441c5b4293d78fc0b3b10920d5333 Add additional information to nightly job (Tobin C. Harding)
a5718f76a9885a1e2c0d51992527bc3ed115fb94 Explicitly exit test script with 0 (Tobin C. Harding)
3913a08dfb3d55fd7b0153f66bb8c6d36fca0f6f Improve test coverage (Tobin C. Harding)
04577224f72bf66e24de7c5d0d0137797a706ed3 Do not run formatter in subprocess (Tobin C. Harding)
b072a5f8122fdc0ed162fb61b4cb748b46286d24 Do not run fuzzer in subprocess (Tobin C. Harding)
62d5169f210907d1bfe11085f1601fde50ede304 Fail script if command fails (Tobin C. Harding)

Pull request description:

  Make an effort to improve the test script, taking inspiration for the test script in `rust-secp256k1`. Since Bash can, at times, be a bit obscure, I made extra effort to do very simple discreet patches.

  First part of the PR is fixes to the test script, second part is improvements to the CI pipeline.

ACKs for top commit:
  sanket1729:
    ACK ed51323a0bb3257b09abfb5eb51ca21815b815af
  apoelstra:
    ACK ed51323a0bb3257b09abfb5eb51ca21815b815af

Tree-SHA512: 9e150b1faebc0d5ae73f7779129c1e8ec5c48bb5e73380793266f02b73636427a45aa378db6cbab8f815f655fd3ead2fffab6000bdb92cf7c443de507c72d261

Author: heap-coder

.github/workflows/rust.yml

@@ -27,7 +27,7 @@ jobs:
         run: ./contrib/test.sh
 
   Nightly:
-    name: Bench + Docs + Fmt
+    name: Nightly - Bench + Docs + Fmt
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Crate
@@ -51,14 +51,12 @@ jobs:
           DO_FMT: true
         run: ./contrib/test.sh
 
-  UnitTests:
+  Tests:
     name: Tests
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rust:
-          - 1.41.1
-          - beta
+        rust: [stable, beta, nightly, 1.41.1]
     steps:
       - name: Checkout Crate
         uses: actions/checkout@v2
@@ -69,23 +67,21 @@ jobs:
           toolchain: ${{ matrix.rust }}
           override: true
       - name: Running cargo
+        env:
+          DO_FEATURE_MATRIX: true
         run: ./contrib/test.sh
 
-  AllTests:
-    name: Unit + Int tests
+  IntTests:
+    name: Integration tests
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        rust:
-          - stable
     steps:
       - name: Checkout Crate
         uses: actions/checkout@v2
       - name: Checkout Toolchain
         uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: ${{ matrix.rust }}
+          toolchain: stable
           override: true
       - name: Running cargo
         env:

contrib/test.sh

@@ -1,5 +1,7 @@
 #!/bin/sh -ex
 
+set -e
+
 FEATURES="compiler use-serde rand"
 
 # Use toolchain if explicitly specified
@@ -8,41 +10,50 @@ then
     alias cargo="cargo +$TOOLCHAIN"
 fi
 
+cargo --version
+rustc --version
+
 # Format if told to
 if [ "$DO_FMT" = true ]
 then
-    (
-        rustup component add rustfmt
-        cargo fmt --all -- --check
-    )
+    rustup component add rustfmt
+    cargo fmt --all -- --check
 fi
 
 # Fuzz if told to
 if [ "$DO_FUZZ" = true ]
 then
-    (
-        cd fuzz
-        cargo test --verbose
-        ./travis-fuzz.sh
-        # Exit out of the fuzzer,
-        # run stable tests in other CI vms
-        exit 0
-    )
+    cd fuzz
+    cargo test --verbose
+    ./travis-fuzz.sh
+
+    # Exit out of the fuzzer, do not run other tests.
+    exit 0
 fi
 
-# Test without any features first
-cargo test --verbose
+# Defaults / sanity checks
+cargo test
 
-# Test each feature
-for feature in ${FEATURES}
-do
-    cargo test --verbose --features="$feature"
-done
+if [ "$DO_FEATURE_MATRIX" = true ]
+then
+    # All features
+    cargo test --features="$FEATURES"
+
+    # Single features
+    for feature in ${FEATURES}
+    do
+        cargo test --features="$feature"
+    done
 
-# Also build and run each example to catch regressions
-cargo build --examples
-# run all examples
-run-parts ./target/debug/examples
+    # Run all the examples
+    cargo build --examples
+    cargo run --example htlc --features=compiler 
+    cargo run --example parse
+    cargo run --example sign_multisig
+    cargo run --example verify_tx > /dev/null
+    cargo run --example psbt
+    cargo run --example xpub_descriptors
+fi
 
 # Bench if told to (this only works with the nightly toolchain)
 if [ "$DO_BENCH" = true ]
@@ -67,3 +78,5 @@ if [ -n "$BITCOINVERSION" ]; then
     rm -rf bitcoin-$BITCOINVERSION
     exit 0
 fi
+
+exit 0