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