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