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 backtrace-debug builds on Rust ${{ matrix.toolchain }}
105 if: "matrix.build-no-std"
107 cd lightning && cargo test --verbose --color always --features backtrace
108 - name: Test on Rust ${{ matrix.toolchain }} with net-tokio
109 if: "matrix.build-net-tokio && !matrix.coverage"
110 run: cargo test --verbose --color always
111 - name: Test on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
113 run: RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always
114 - name: Test on no-std bullds Rust ${{ matrix.toolchain }}
115 if: "matrix.build-no-std && !matrix.coverage"
116 shell: bash # Default on Winblows is powershell
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
122 # check if there is a conflict between no-std and the c_bindings cfg
123 RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
125 - name: Test on no-std builds Rust ${{ matrix.toolchain }} and full code-linking for coverage generation
126 if: "matrix.build-no-std && matrix.coverage"
129 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --no-default-features --features no-std
131 - name: Test on Rust ${{ matrix.toolchain }}
132 if: "! matrix.build-net-tokio"
134 cargo test --verbose --color always -p lightning
135 cargo test --verbose --color always -p lightning-invoice
136 cargo build --verbose --color always -p lightning-persister
137 cargo build --verbose --color always -p lightning-background-processor
138 - name: Test C Bindings Modifications on Rust ${{ matrix.toolchain }}
139 if: "! matrix.build-net-tokio"
141 RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always -p lightning
142 RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always -p lightning-invoice
143 RUSTFLAGS="--cfg=c_bindings" cargo build --verbose --color always -p lightning-persister
144 RUSTFLAGS="--cfg=c_bindings" cargo build --verbose --color always -p lightning-background-processor
145 - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features
146 if: "matrix.build-net-tokio && !matrix.coverage"
148 cd lightning-block-sync
149 cargo test --verbose --color always --features rest-client
150 cargo test --verbose --color always --features rpc-client
151 cargo test --verbose --color always --features rpc-client,rest-client
152 cargo test --verbose --color always --features rpc-client,rest-client,tokio
153 - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
156 cd lightning-block-sync
157 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rest-client
158 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client
159 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client
160 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client,tokio
161 - name: Install deps for kcov
165 sudo apt-get -y install binutils-dev libcurl4-openssl-dev zlib1g-dev libdw-dev libiberty-dev
169 wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz
170 tar xzf master.tar.gz
171 cd kcov-master && mkdir build && cd build
174 make install DESTDIR=../../kcov-build
175 cd ../.. && rm -rf kcov-master master.tar.gz
176 - name: Generate coverage report
179 for file in target/debug/deps/lightning*; do
180 [ -x "${file}" ] || continue;
181 mkdir -p "target/cov/$(basename $file)";
182 ./kcov-build/usr/local/bin/kcov --exclude-pattern=/.cargo,/usr/lib --verify "target/cov/$(basename $file)" "$file";
184 - name: Upload coverage
186 uses: codecov/codecov-action@v2
188 # Could you use this to fake the coverage report for your PR? Sure.
189 # Will anyone be impressed by your amazing coverage? No
190 # Maybe if codecov wasn't broken we wouldn't need to do this...
191 token: f421b687-4dc2-4387-ac3d-dc3b2528af57
192 fail_ci_if_error: true
195 runs-on: ubuntu-latest
199 - name: Checkout source code
200 uses: actions/checkout@v2
201 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
202 uses: actions-rs/toolchain@v1
204 toolchain: ${{ env.TOOLCHAIN }}
207 - name: Cache routing graph snapshot
209 uses: actions/cache@v2
211 path: lightning/net_graph-2021-05-31.bin
212 key: ldk-net_graph-v0.0.15-2021-05-31.bin
213 - name: Fetch routing graph snapshot
214 if: steps.cache-graph.outputs.cache-hit != 'true'
216 wget -O lightning/net_graph-2021-05-31.bin https://bitcoin.ninja/ldk-net_graph-v0.0.15-2021-05-31.bin
217 if [ "$(sha256sum lightning/net_graph-2021-05-31.bin | awk '{ print $1 }')" != "05a5361278f68ee2afd086cc04a1f927a63924be451f3221d380533acfacc303" ]; then
221 - name: Test with Network Graph on Rust ${{ matrix.toolchain }}
224 RUSTFLAGS="--cfg=require_route_graph_test" cargo test
225 RUSTFLAGS="--cfg=require_route_graph_test" cargo test --features hashbrown
227 - name: Run benchmarks on Rust ${{ matrix.toolchain }}
229 cargo bench --features unstable
232 runs-on: ubuntu-latest
234 # rustc 1.53 regressed and panics when building our (perfectly fine) docs.
235 # See https://github.com/rust-lang/rust/issues/84738
238 - name: Checkout source code
239 uses: actions/checkout@v2
242 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
243 uses: actions-rs/toolchain@v1
245 toolchain: ${{ env.TOOLCHAIN }}
248 - name: Fetch full tree and rebase on upstream
250 git remote add upstream https://github.com/rust-bitcoin/rust-lightning
252 export GIT_COMMITTER_EMAIL="rl-ci@example.com"
253 export GIT_COMMITTER_NAME="RL CI"
254 git rebase upstream/main
255 - name: For each commit, run cargo check (including in fuzz)
256 run: ci/check-each-commit.sh upstream/main
259 runs-on: ubuntu-latest
263 - name: Checkout source code
264 uses: actions/checkout@v2
265 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
266 uses: actions-rs/toolchain@v1
268 toolchain: ${{ env.TOOLCHAIN }}
271 - name: Install dependencies for honggfuzz
274 sudo apt-get -y install build-essential binutils-dev libunwind-dev
275 - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
276 run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always
278 run: cd fuzz && ./ci-fuzz.sh && cd ..
279 - name: Run lightning-invoice fuzzers
280 run: cd lightning-invoice/fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose && ./ci-fuzz.sh
283 runs-on: ubuntu-latest
287 - name: Checkout source code
288 uses: actions/checkout@v2
289 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
290 uses: actions-rs/toolchain@v1
292 toolchain: ${{ env.TOOLCHAIN }}
295 - name: Install clippy
297 rustup component add clippy
298 - name: Run default clippy linting
300 cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err