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