1 name: Continuous Integration Checks
3 on: [push, pull_request]
10 platform: [ ubuntu-latest ]
13 # 1.36.0 is MSRV for Rust-Lightning, lightning-invoice, and lightning-persister
15 # 1.41.0 is Debian stable
17 # 1.45.2 is MSRV for lightning-net-tokio, lightning-block-sync, and coverage generation
19 # 1.47.0 will be the MSRV for no-std builds using hashbrown once core2 is updated
26 platform: macos-latest
30 platform: macos-latest
34 platform: windows-latest
38 platform: windows-latest
46 test-log-variants: true
50 build-net-old-tokio: true
56 runs-on: ${{ matrix.platform }}
58 - name: Checkout source code
59 uses: actions/checkout@v2
60 - name: Install Rust ${{ matrix.toolchain }} toolchain
61 uses: actions-rs/toolchain@v1
63 toolchain: ${{ matrix.toolchain }}
66 - name: Pin tokio to 1.14 for Rust 1.45
67 if: "matrix.build-net-old-tokio"
68 run: cargo update -p tokio --precise "1.14.0" --verbose
69 - name: Build on Rust ${{ matrix.toolchain }} with net-tokio
70 if: "matrix.build-net-tokio && !matrix.coverage"
71 run: cargo build --verbose --color always
72 - name: Build on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
74 run: RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always
75 - name: Build on Rust ${{ matrix.toolchain }}
76 if: "! matrix.build-net-tokio"
78 cargo build --verbose --color always -p lightning
79 cargo build --verbose --color always -p lightning-invoice
80 cargo build --verbose --color always -p lightning-persister
81 - name: Build on Rust ${{ matrix.toolchain }} with all Log-Limiting features
82 if: matrix.test-log-variants
85 for FEATURE in $(cat Cargo.toml | grep '^max_level_' | awk '{ print $1 }'); do
86 cargo build --verbose --color always --features $FEATURE
88 - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features
89 if: "matrix.build-net-tokio && !matrix.coverage"
91 cd lightning-block-sync
92 cargo build --verbose --color always --features rest-client
93 cargo build --verbose --color always --features rpc-client
94 cargo build --verbose --color always --features rpc-client,rest-client
95 cargo build --verbose --color always --features rpc-client,rest-client,tokio
96 - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
99 cd lightning-block-sync
100 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rest-client
101 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client
102 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client
103 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client,tokio
104 - name: Test on Rust ${{ matrix.toolchain }} with net-tokio
105 if: "matrix.build-net-tokio && !matrix.coverage"
106 run: cargo test --verbose --color always
107 - name: Test on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
109 run: RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always
110 - name: Test on no-std bullds Rust ${{ matrix.toolchain }}
111 if: "matrix.build-no-std && !matrix.coverage"
114 cargo test --verbose --color always --no-default-features --features no-std
115 # check if there is a conflict between no-std and the default std feature
116 cargo test --verbose --color always --features no-std
119 cargo test --verbose --color always --no-default-features --features no-std
120 # check if there is a conflict between no-std and the default std feature
121 cargo test --verbose --color always --features no-std
123 - name: Test on no-std builds Rust ${{ matrix.toolchain }} and full code-linking for coverage generation
124 if: "matrix.build-no-std && matrix.coverage"
127 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --no-default-features --features no-std
129 - name: Test on Rust ${{ matrix.toolchain }}
130 if: "! matrix.build-net-tokio"
132 cargo test --verbose --color always -p lightning
133 cargo test --verbose --color always -p lightning-invoice
134 cargo build --verbose --color always -p lightning-persister
135 cargo build --verbose --color always -p lightning-background-processor
136 - name: Test C Bindings Modifications on Rust ${{ matrix.toolchain }}
137 if: "! matrix.build-net-tokio"
139 RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always -p lightning
140 RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always -p lightning-invoice
141 RUSTFLAGS="--cfg=c_bindings" cargo build --verbose --color always -p lightning-persister
142 RUSTFLAGS="--cfg=c_bindings" cargo build --verbose --color always -p lightning-background-processor
143 - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features
144 if: "matrix.build-net-tokio && !matrix.coverage"
146 cd lightning-block-sync
147 cargo test --verbose --color always --features rest-client
148 cargo test --verbose --color always --features rpc-client
149 cargo test --verbose --color always --features rpc-client,rest-client
150 cargo test --verbose --color always --features rpc-client,rest-client,tokio
151 - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
154 cd lightning-block-sync
155 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rest-client
156 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client
157 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client
158 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client,tokio
159 - name: Install deps for kcov
163 sudo apt-get -y install binutils-dev libcurl4-openssl-dev zlib1g-dev libdw-dev libiberty-dev
167 wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz
168 tar xzf master.tar.gz
169 cd kcov-master && mkdir build && cd build
172 make install DESTDIR=../../kcov-build
173 cd ../.. && rm -rf kcov-master master.tar.gz
174 - name: Generate coverage report
177 for file in target/debug/deps/lightning*; do
178 [ -x "${file}" ] || continue;
179 mkdir -p "target/cov/$(basename $file)";
180 ./kcov-build/usr/local/bin/kcov --exclude-pattern=/.cargo,/usr/lib --verify "target/cov/$(basename $file)" "$file";
182 - name: Upload coverage
184 uses: codecov/codecov-action@v2
186 # Could you use this to fake the coverage report for your PR? Sure.
187 # Will anyone be impressed by your amazing coverage? No
188 # Maybe if codecov wasn't broken we wouldn't need to do this...
189 token: f421b687-4dc2-4387-ac3d-dc3b2528af57
190 fail_ci_if_error: true
193 runs-on: ubuntu-latest
197 - name: Checkout source code
198 uses: actions/checkout@v2
199 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
200 uses: actions-rs/toolchain@v1
202 toolchain: ${{ env.TOOLCHAIN }}
205 - name: Cache routing graph snapshot
207 uses: actions/cache@v2
209 path: lightning/net_graph-2021-05-31.bin
210 key: ldk-net_graph-v0.0.15-2021-05-31.bin
211 - name: Fetch routing graph snapshot
212 if: steps.cache-graph.outputs.cache-hit != 'true'
214 wget -O lightning/net_graph-2021-05-31.bin https://bitcoin.ninja/ldk-net_graph-v0.0.15-2021-05-31.bin
215 if [ "$(sha256sum lightning/net_graph-2021-05-31.bin | awk '{ print $1 }')" != "05a5361278f68ee2afd086cc04a1f927a63924be451f3221d380533acfacc303" ]; then
219 - name: Test with Network Graph on Rust ${{ matrix.toolchain }}
222 RUSTFLAGS="--cfg=require_route_graph_test" cargo test
223 RUSTFLAGS="--cfg=require_route_graph_test" cargo test --features hashbrown
225 - name: Run benchmarks on Rust ${{ matrix.toolchain }}
227 cargo bench --features unstable
230 runs-on: ubuntu-latest
232 # rustc 1.53 regressed and panics when building our (perfectly fine) docs.
233 # See https://github.com/rust-lang/rust/issues/84738
236 - name: Checkout source code
237 uses: actions/checkout@v2
240 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
241 uses: actions-rs/toolchain@v1
243 toolchain: ${{ env.TOOLCHAIN }}
246 - name: Fetch full tree and rebase on upstream
248 git remote add upstream https://github.com/rust-bitcoin/rust-lightning
250 export GIT_COMMITTER_EMAIL="rl-ci@example.com"
251 export GIT_COMMITTER_NAME="RL CI"
252 git rebase upstream/main
253 - name: For each commit, run cargo check (including in fuzz)
254 run: ci/check-each-commit.sh upstream/main
257 runs-on: ubuntu-latest
261 - name: Checkout source code
262 uses: actions/checkout@v2
263 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
264 uses: actions-rs/toolchain@v1
266 toolchain: ${{ env.TOOLCHAIN }}
269 - name: Install dependencies for honggfuzz
272 sudo apt-get -y install build-essential binutils-dev libunwind-dev
273 - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
274 run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always
276 run: cd fuzz && ./ci-fuzz.sh && cd ..
277 - name: Run lightning-invoice fuzzers
278 run: cd lightning-invoice/fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose && ./ci-fuzz.sh
281 runs-on: ubuntu-latest
285 - name: Checkout source code
286 uses: actions/checkout@v2
287 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
288 uses: actions-rs/toolchain@v1
290 toolchain: ${{ env.TOOLCHAIN }}
293 - name: Install clippy
295 rustup component add clippy
296 - name: Run default clippy linting
298 cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err