_ Git - rust-lightning/blob - ci/ci-tests.sh

   1 #!/bin/bash
   2 set -eox pipefail
   3
   4 RUSTC_MINOR_VERSION=$(rustc --version | awk '{ split($2,a,"."); print a[2] }')
   5 HOST_PLATFORM="$(rustc --version --verbose | grep "host:" | awk '{ print $2 }')"
   6
   7 # Some crates require pinning to meet our MSRV even for our downstream users,
   8 # which we do here.
   9 # Further crates which appear only as dev-dependencies are pinned further down.
  10 function PIN_RELEASE_DEPS {
  11         # Tokio MSRV on versions 1.17 through 1.26 is rustc 1.49. Above 1.26 MSRV is 1.56.
  12         [ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p tokio --precise "1.14.1" --verbose
  13         [[ "$RUSTC_MINOR_VERSION" -gt 48  &&  "$RUSTC_MINOR_VERSION" -lt 56 ]] && cargo update -p tokio --precise "1.25.1" --verbose
  14
  15         # Sadly the log crate is always a dependency of tokio until 1.20, and has no reasonable MSRV guarantees
  16         [ "$RUSTC_MINOR_VERSION" -lt 49 ] && cargo update -p log --precise "0.4.18" --verbose
  17
  18         # The serde_json crate switched to Rust edition 2021 starting with v1.0.101, i.e., has MSRV of 1.56
  19         [ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p serde_json --precise "1.0.100" --verbose
  20
  21         return 0 # Don't fail the script if our rustc is higher than the last check
  22 }
  23
  24 PIN_RELEASE_DEPS # pin the release dependencies in our main workspace
  25
  26 # The addr2line v0.20 crate (a dependency of `backtrace` starting with 0.3.68) relies on 1.55+
  27 [ "$RUSTC_MINOR_VERSION" -lt 55 ] && cargo update -p backtrace --precise "0.3.67" --verbose
  28
  29 # The quote crate switched to Rust edition 2021 starting with v1.0.31, i.e., has MSRV of 1.56
  30 [ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p quote --precise "1.0.30" --verbose
  31
  32 # The syn crate depends on too-new proc-macro2 starting with v2.0.33, i.e., has MSRV of 1.56
  33 if [ "$RUSTC_MINOR_VERSION" -lt 56 ]; then
  34         SYN_2_DEP=$(grep -o '"syn 2.*' Cargo.lock | tr -d '",' | tr ' ' ':')
  35         cargo update -p "$SYN_2_DEP" --precise "2.0.32" --verbose
  36 fi
  37
  38 # The proc-macro2 crate switched to Rust edition 2021 starting with v1.0.66, i.e., has MSRV of 1.56
  39 [ "$RUSTC_MINOR_VERSION" -lt 56 ] && cargo update -p proc-macro2 --precise "1.0.65" --verbose
  40
  41 # The memchr crate switched to an MSRV of 1.60 starting with v2.6.0
  42 [ "$RUSTC_MINOR_VERSION" -lt 60 ] && cargo update -p memchr --precise "2.5.0" --verbose
  43
  44 [ "$LDK_COVERAGE_BUILD" != "" ] && export RUSTFLAGS="-C link-dead-code"
  45
  46 export RUST_BACKTRACE=1
  47
  48 echo -e "\n\nBuilding and testing all workspace crates..."
  49 cargo test --verbose --color always
  50 cargo build --verbose --color always
  51
  52 echo -e "\n\nBuilding and testing Block Sync Clients with features"
  53 pushd lightning-block-sync
  54 cargo test --verbose --color always --features rest-client
  55 cargo build --verbose --color always --features rest-client
  56 cargo test --verbose --color always --features rpc-client
  57 cargo build --verbose --color always --features rpc-client
  58 cargo test --verbose --color always --features rpc-client,rest-client
  59 cargo build --verbose --color always --features rpc-client,rest-client
  60 cargo test --verbose --color always --features rpc-client,rest-client,tokio
  61 cargo build --verbose --color always --features rpc-client,rest-client,tokio
  62 popd
  63
  64 if [[ $RUSTC_MINOR_VERSION -gt 67 && "$HOST_PLATFORM" != *windows* ]]; then
  65         echo -e "\n\nBuilding and testing Transaction Sync Clients with features"
  66         pushd lightning-transaction-sync
  67         cargo test --verbose --color always --features esplora-blocking
  68         cargo build --verbose --color always --features esplora-blocking
  69         cargo test --verbose --color always --features esplora-async
  70         cargo build --verbose --color always --features esplora-async
  71         cargo test --verbose --color always --features esplora-async-https
  72         cargo build --verbose --color always --features esplora-async-https
  73         popd
  74 fi
  75
  76 echo -e "\n\nTest futures builds"
  77 pushd lightning-background-processor
  78 cargo test --verbose --color always --features futures
  79 popd
  80
  81 if [ "$RUSTC_MINOR_VERSION" -gt 55 ]; then
  82         echo -e "\n\nTest Custom Message Macros"
  83         pushd lightning-custom-message
  84         cargo test --verbose --color always
  85         popd
  86 fi
  87
  88 if [ "$RUSTC_MINOR_VERSION" -gt 51 ]; then # Current `object` MSRV, subject to change
  89         echo -e "\n\nTest backtrace-debug builds"
  90         pushd lightning
  91         cargo test --verbose --color always --features backtrace
  92         popd
  93 fi
  94
  95 echo -e "\n\nBuilding with all Log-Limiting features"
  96 pushd lightning
  97 grep '^max_level_' Cargo.toml | awk '{ print $1 }'| while read -r FEATURE; do
  98         cargo build --verbose --color always --features "$FEATURE"
  99 done
 100 popd
 101
 102 echo -e "\n\nTesting no-std flags in various combinations"
 103 for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do
 104         pushd $DIR
 105         cargo test --verbose --color always --no-default-features --features no-std
 106         # check if there is a conflict between no-std and the default std feature
 107         cargo test --verbose --color always --features no-std
 108         # check if there is a conflict between no-std and the c_bindings cfg
 109         RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
 110         popd
 111 done
 112 # Note that outbound_commitment_test only runs in this mode because of hardcoded signature values
 113 pushd lightning
 114 cargo test --verbose --color always --no-default-features --features=std,_test_vectors
 115 popd
 116 # This one only works for lightning-invoice
 117 pushd lightning-invoice
 118 # check that compile with no-std and serde works in lightning-invoice
 119 cargo test --verbose --color always --no-default-features --features no-std --features serde
 120 popd
 121
 122 echo -e "\n\nTesting no-std build on a downstream no-std crate"
 123 # check no-std compatibility across dependencies
 124 pushd no-std-check
 125 if [[ $RUSTC_MINOR_VERSION -gt 67 ]]; then
 126         # lightning-transaction-sync's MSRV is 1.67
 127         cargo check --verbose --color always --features lightning-transaction-sync
 128 else
 129         # The memchr crate switched to an MSRV of 1.60 starting with v2.6.0
 130         # This is currently only a release dependency via core2, which we intend to work with
 131         # rust-bitcoin to remove soon.
 132         [ "$RUSTC_MINOR_VERSION" -lt 60 ] && cargo update -p memchr --precise "2.5.0" --verbose
 133         cargo check --verbose --color always
 134 fi
 135 popd
 136
 137 # Test that we can build downstream code with only the "release pins".
 138 pushd msrv-no-dev-deps-check
 139 PIN_RELEASE_DEPS
 140 cargo check
 141 popd
 142
 143 if [ -f "$(which arm-none-eabi-gcc)" ]; then
 144         pushd no-std-check
 145         cargo build --target=thumbv7m-none-eabi
 146         popd
 147 fi
 148
 149 echo -e "\n\nTest Taproot builds"
 150 pushd lightning
 151 RUSTFLAGS="$RUSTFLAGS --cfg=taproot" cargo test --verbose --color always -p lightning
 152 popd