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