Test MSRV builds (without dev-dependencies) in CI
[rust-lightning] / 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 [ "$LDK_COVERAGE_BUILD" != "" ] && export RUSTFLAGS="-C link-dead-code"
33
34 export RUST_BACKTRACE=1
35
36 echo -e "\n\nBuilding and testing all workspace crates..."
37 cargo build --verbose --color always
38 cargo test --verbose --color always
39
40 echo -e "\n\nBuilding with all Log-Limiting features"
41 pushd lightning
42 grep '^max_level_' Cargo.toml | awk '{ print $1 }'| while read -r FEATURE; do
43         cargo build --verbose --color always --features "$FEATURE"
44 done
45 popd
46
47 if [ "$RUSTC_MINOR_VERSION" -gt 51 ]; then # Current `object` MSRV, subject to change
48         echo -e "\n\nTest backtrace-debug builds"
49         pushd lightning
50         cargo test --verbose --color always --features backtrace
51         popd
52 fi
53
54 echo -e "\n\nTesting no-std flags in various combinations"
55 for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do
56         pushd $DIR
57         cargo test --verbose --color always --no-default-features --features no-std
58         # check if there is a conflict between no-std and the default std feature
59         cargo test --verbose --color always --features no-std
60         # check if there is a conflict between no-std and the c_bindings cfg
61         RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
62         popd
63 done
64 # Note that outbound_commitment_test only runs in this mode because of hardcoded signature values
65 pushd lightning
66 cargo test --verbose --color always --no-default-features --features=std,_test_vectors
67 popd
68 # This one only works for lightning-invoice
69 pushd lightning-invoice
70 # check that compile with no-std and serde works in lightning-invoice
71 cargo test --verbose --color always --no-default-features --features no-std --features serde
72 popd
73
74 echo -e "\n\nTesting no-std build on a downstream no-std crate"
75 # check no-std compatibility across dependencies
76 pushd no-std-check
77 cargo check --verbose --color always --features lightning-transaction-sync
78 popd
79
80 # Test that we can build downstream code with only the "release pins".
81 pushd msrv-no-dev-deps-check
82 PIN_RELEASE_DEPS
83 cargo check
84 popd
85
86 if [ -f "$(which arm-none-eabi-gcc)" ]; then
87         pushd no-std-check
88         cargo build --target=thumbv7m-none-eabi
89         popd
90 fi
91
92 echo -e "\n\nBuilding and testing Block Sync Clients with features"
93 pushd lightning-block-sync
94 cargo build --verbose --color always --features rest-client
95 cargo test --verbose --color always --features rest-client
96 cargo build --verbose --color always --features rpc-client
97 cargo test --verbose --color always --features rpc-client
98 cargo build --verbose --color always --features rpc-client,rest-client
99 cargo test --verbose --color always --features rpc-client,rest-client
100 cargo build --verbose --color always --features rpc-client,rest-client,tokio
101 cargo test --verbose --color always --features rpc-client,rest-client,tokio
102 popd
103
104 if [[ $RUSTC_MINOR_VERSION -gt 67 && "$HOST_PLATFORM" != *windows* ]]; then
105         echo -e "\n\nBuilding and testing Transaction Sync Clients with features"
106         pushd lightning-transaction-sync
107         cargo build --verbose --color always --features esplora-blocking
108         cargo test --verbose --color always --features esplora-blocking
109         cargo build --verbose --color always --features esplora-async
110         cargo test --verbose --color always --features esplora-async
111         cargo build --verbose --color always --features esplora-async-https
112         cargo test --verbose --color always --features esplora-async-https
113         popd
114 fi
115
116 echo -e "\n\nTest futures builds"
117 pushd lightning-background-processor
118 cargo test --verbose --color always --features futures
119 popd
120
121 if [ "$RUSTC_MINOR_VERSION" -gt 55 ]; then
122         echo -e "\n\nTest Custom Message Macros"
123         pushd lightning-custom-message
124         cargo test --verbose --color always
125         popd
126 fi
127
128 echo -e "\n\nTest Taproot builds"
129 pushd lightning
130 RUSTFLAGS="$RUSTFLAGS --cfg=taproot" cargo test --verbose --color always -p lightning
131 popd