name: Continuous Integration Checks
-on:
- push:
+on: [push, pull_request]
jobs:
build:
strategy:
matrix:
+ platform: [ ubuntu-latest ]
toolchain: [ stable,
beta,
- # 1.22.0 is MSRV for rust-lightning in general:
- 1.22.0,
+ # 1.30.0 is MSRV for Rust-Lightning
+ 1.30.0,
# 1.34.2 is Debian stable
1.34.2,
- # 1.39.0 is MSRV for lightning-net-tokio and generates coverage
- 1.39.0]
+ # 1.45.2 is MSRV for lightning-net-tokio, lightning-block-sync, and coverage generation
+ 1.45.2]
include:
- toolchain: stable
build-net-tokio: true
+ - toolchain: stable
+ platform: macos-latest
+ build-net-tokio: true
+ - toolchain: stable
+ platform: windows-latest
+ build-net-tokio: true
- toolchain: beta
build-net-tokio: true
- - toolchain: 1.39.0
+ - toolchain: 1.45.2
build-net-tokio: true
coverage: true
- runs-on: ubuntu-latest
+ runs-on: ${{ matrix.platform }}
steps:
- name: Checkout source code
uses: actions/checkout@v2
override: true
profile: minimal
- name: Build on Rust ${{ matrix.toolchain }} with net-tokio
- if: matrix.build-net-tokio
+ if: "matrix.build-net-tokio && !matrix.coverage"
+ run: cargo build --verbose --color always
+ - name: Build on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
+ if: matrix.coverage
run: RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always
- name: Build on Rust ${{ matrix.toolchain }}
if: "! matrix.build-net-tokio"
- run: RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always -p lightning
+ run: cargo build --verbose --color always -p lightning
+ - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features
+ if: "matrix.build-net-tokio && !matrix.coverage"
+ run: |
+ cd lightning-block-sync
+ cargo build --verbose --color always --features rest-client
+ cargo build --verbose --color always --features rpc-client
+ cargo build --verbose --color always --features rpc-client,rest-client
+ cargo build --verbose --color always --features rpc-client,rest-client,tokio
+ cd ..
+ - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
+ if: matrix.coverage
+ run: |
+ cd lightning-block-sync
+ RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rest-client
+ RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client
+ RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client
+ RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client,tokio
+ cd ..
- name: Test on Rust ${{ matrix.toolchain }} with net-tokio
- if: matrix.build-net-tokio
+ if: "matrix.build-net-tokio && !matrix.coverage"
+ run: cargo test --verbose --color always
+ - name: Test on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
+ if: matrix.coverage
run: RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always
- name: Test on Rust ${{ matrix.toolchain }}
if: "! matrix.build-net-tokio"
- run: RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always -p lightning
+ run: cargo test --verbose --color always -p lightning
+ - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features
+ if: "matrix.build-net-tokio && !matrix.coverage"
+ run: |
+ cd lightning-block-sync
+ cargo test --verbose --color always --features rest-client
+ cargo test --verbose --color always --features rpc-client
+ cargo test --verbose --color always --features rpc-client,rest-client
+ cargo test --verbose --color always --features rpc-client,rest-client,tokio
+ cd ..
+ - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
+ if: matrix.coverage
+ run: |
+ cd lightning-block-sync
+ RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rest-client
+ RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client
+ RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client
+ RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client,tokio
+ cd ..
- name: Install deps for kcov
if: matrix.coverage
run: |
- name: Generate coverage report
if: matrix.coverage
run: |
- for file in target/debug/lightning-*; do
+ for file in target/debug/deps/lightning*; do
[ -x "${file}" ] || continue;
mkdir -p "target/cov/$(basename $file)";
./kcov-build/usr/local/bin/kcov --exclude-pattern=/.cargo,/usr/lib --verify "target/cov/$(basename $file)" "$file";
if: matrix.coverage
uses: codecov/codecov-action@v1
with:
+ # Could you use this to fake the coverage report for your PR? Sure.
+ # Will anyone be impressed by your amazing coverage? No
+ # Maybe if codecov wasn't broken we wouldn't need to do this...
+ token: f421b687-4dc2-4387-ac3d-dc3b2528af57
fail_ci_if_error: true
+ benchmark:
+ runs-on: ubuntu-latest
+ env:
+ TOOLCHAIN: nightly
+ steps:
+ - name: Checkout source code
+ uses: actions/checkout@v2
+ - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
+ uses: actions-rs/toolchain@v1
+ with:
+ toolchain: ${{ env.TOOLCHAIN }}
+ override: true
+ profile: minimal
+ - name: Cache routing graph snapshot
+ id: cache-graph
+ uses: actions/cache@v2
+ with:
+ path: lightning/net_graph-2021-02-12.bin
+ key: net_graph-2021-02-12
+ - name: Fetch routing graph snapshot
+ if: steps.cache-graph.outputs.cache-hit != 'true'
+ run: |
+ wget -O lightning/net_graph-2021-02-12.bin https://bitcoin.ninja/ldk-net_graph-879e309c128-2020-02-12.bin
+ if [ "$(sha256sum lightning/net_graph-2021-02-12.bin | awk '{ print $1 }')" != "890a1f80dfb6ef674a1e4ff0f23cd73d740731c395f99d85abbede0cfbb701ab" ]; then
+ echo "Bad hash"
+ exit 1
+ fi
+ - name: Test with Network Graph on Rust ${{ matrix.toolchain }}
+ run: |
+ cd lightning
+ RUSTFLAGS="--cfg=require_route_graph_test" cargo test
+ cd ..
+ - name: Run benchmarks on Rust ${{ matrix.toolchain }}
+ run: |
+ cd lightning
+ cargo bench --features unstable
+ cd ..
+
+ check_commits:
+ runs-on: ubuntu-latest
+ env:
+ TOOLCHAIN: stable
+ steps:
+ - name: Checkout source code
+ uses: actions/checkout@v2
+ with:
+ fetch-depth: 0
+ - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
+ uses: actions-rs/toolchain@v1
+ with:
+ toolchain: ${{ env.TOOLCHAIN }}
+ override: true
+ profile: minimal
+ - name: Fetch full tree and rebase on upstream
+ run: |
+ git remote add upstream https://github.com/rust-bitcoin/rust-lightning
+ git fetch upstream
+ export GIT_COMMITTER_EMAIL="rl-ci@example.com"
+ export GIT_COMMITTER_NAME="RL CI"
+ git rebase upstream/main
+ - name: For each commit, run cargo check (including in fuzz)
+ run: ci/check-each-commit.sh upstream/main
+
fuzz:
runs-on: ubuntu-latest
env:
run: |
sudo apt-get update
sudo apt-get -y install build-essential binutils-dev libunwind-dev
- - name: Fuzz test on Rust ${{ matrix.TOOLCHAIN }}
- run: cd fuzz && cargo test --verbose --color always
- - name: Generate fuzz report
+ - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
+ run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always
+ - name: Run fuzzers
run: cd fuzz && ./ci-fuzz.sh
+
+ linting:
+ runs-on: ubuntu-latest
+ env:
+ TOOLCHAIN: 1.45.2
+ steps:
+ - name: Checkout source code
+ uses: actions/checkout@v2
+ - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
+ uses: actions-rs/toolchain@v1
+ with:
+ toolchain: ${{ env.TOOLCHAIN }}
+ override: true
+ profile: minimal
+ - name: Install clippy
+ run: |
+ rustup component add clippy
+ - name: Run default clippy linting
+ run: |
+ cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else