name: Continuous Integration Checks
-on: [push, pull_request]
+on:
+ push:
+ branches-ignore:
+ - master
+ pull_request:
+ branches-ignore:
+ - master
+
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: true
jobs:
build:
strategy:
+ fail-fast: false
matrix:
- toolchain: [ stable,
- beta,
- # 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]
+ platform: [ ubuntu-latest, windows-latest, macos-latest ]
+ toolchain: [ stable, beta ]
include:
- toolchain: stable
- build-net-tokio: true
- build-bindings: true
- - toolchain: beta
- build-net-tokio: true
- build-bindings: true
- - toolchain: 1.39.0
- build-net-tokio: true
- build-bindings: true
+ platform: ubuntu-latest
coverage: true
- - toolchain: 1.34.2
- build-bindings: true
- runs-on: ubuntu-latest
+ # 1.48.0 is the MSRV for all crates except lightning-transaction-sync and Win/Mac
+ - toolchain: 1.48.0
+ platform: ubuntu-latest
+ # Windows requires 1.49.0 because that's the MSRV for supported Tokio
+ - toolchain: 1.49.0
+ platform: windows-latest
+ # MacOS-latest requires 1.54.0 because that's what's required for linking to work properly
+ - toolchain: 1.54.0
+ platform: macos-latest
+ runs-on: ${{ matrix.platform }}
steps:
- name: Checkout source code
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
- name: Install Rust ${{ matrix.toolchain }} toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: ${{ matrix.toolchain }}
override: true
profile: minimal
- - name: Build on Rust ${{ matrix.toolchain }} with net-tokio
- if: matrix.build-net-tokio
- 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
- - name: Build bindings on Rust ${{ matrix.toolchain }}
- if: matrix.build-bindings
- run: RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always -p lightning-c-bindings
- - name: Test on Rust ${{ matrix.toolchain }} with net-tokio
- if: matrix.build-net-tokio
- 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
+ - name: Install no-std-check dependencies for ARM Embedded
+ if: "matrix.platform == 'ubuntu-latest'"
+ run: |
+ rustup target add thumbv7m-none-eabi
+ sudo apt-get -y install gcc-arm-none-eabi
+ - name: shellcheck the CI script
+ if: "matrix.platform == 'ubuntu-latest'"
+ run: |
+ sudo apt-get -y install shellcheck
+ shellcheck ci/ci-tests.sh
+ - name: Run CI script with coverage generation
+ if: matrix.coverage
+ shell: bash # Default on Winblows is powershell
+ run: LDK_COVERAGE_BUILD=true ./ci/ci-tests.sh
+ - name: Run CI script
+ if: "!matrix.coverage"
+ shell: bash # Default on Winblows is powershell
+ run: ./ci/ci-tests.sh
- 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";
done
- name: Upload coverage
if: matrix.coverage
- uses: codecov/codecov-action@v1
+ uses: codecov/codecov-action@v3
with:
# Could you use this to fake the coverage report for your PR? Sure.
# Will anyone be impressed by your amazing coverage? No
token: f421b687-4dc2-4387-ac3d-dc3b2528af57
fail_ci_if_error: true
- fuzz:
+ benchmark:
runs-on: ubuntu-latest
env:
TOOLCHAIN: stable
steps:
- name: Checkout source code
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
- 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@v3
+ with:
+ path: lightning/net_graph-2023-01-18.bin
+ key: ldk-net_graph-v0.0.113-2023-01-18.bin
+ - name: Fetch routing graph snapshot
+ if: steps.cache-graph.outputs.cache-hit != 'true'
+ run: |
+ curl --verbose -L -o lightning/net_graph-2023-01-18.bin https://bitcoin.ninja/ldk-net_graph-v0.0.113-2023-01-18.bin
+ echo "Sha sum: $(sha256sum lightning/net_graph-2023-01-18.bin | awk '{ print $1 }')"
+ if [ "$(sha256sum lightning/net_graph-2023-01-18.bin | awk '{ print $1 }')" != "${EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM}" ]; then
+ echo "Bad hash"
+ exit 1
+ fi
+ env:
+ EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM: da6066f2bddcddbe7d8a6debbd53545697137b310bbb8c4911bc8c81fc5ff48c
+ - name: Fetch rapid graph sync reference input
+ run: |
+ curl --verbose -L -o lightning-rapid-gossip-sync/res/full_graph.lngossip https://bitcoin.ninja/ldk-compressed_graph-285cb27df79-2022-07-21.bin
+ echo "Sha sum: $(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')"
+ if [ "$(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')" != "${EXPECTED_RAPID_GOSSIP_SHASUM}" ]; then
+ echo "Bad hash"
+ exit 1
+ fi
+ env:
+ EXPECTED_RAPID_GOSSIP_SHASUM: e0f5d11641c11896d7af3a2246d3d6c3f1720b7d2d17aab321ecce82e6b7deb8
+ - name: Test with Network Graph on Rust ${{ matrix.toolchain }}
+ run: |
+ cd lightning
+ RUSTFLAGS="--cfg=require_route_graph_test" cargo test
+ RUSTFLAGS="--cfg=require_route_graph_test" cargo test --features hashbrown
+ cd ..
+ - name: Run benchmarks on Rust ${{ matrix.toolchain }}
+ run: |
+ RUSTC_BOOTSTRAP=1 cargo bench --features _bench_unstable
+
+ check_commits:
+ runs-on: ubuntu-latest
+ env:
+ TOOLCHAIN: 1.57.0
+ steps:
+ - name: Checkout source code
+ uses: actions/checkout@v3
+ 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/lightningdevkit/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
+
+ check_release:
+ runs-on: ubuntu-latest
+ env:
+ TOOLCHAIN: stable
+ steps:
+ - name: Checkout source code
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+ - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
+ uses: actions-rs/toolchain@v1
+ with:
+ toolchain: ${{ env.TOOLCHAIN }}
+ override: true
+ profile: minimal
+ - name: Run cargo check for release build.
+ run: |
+ cargo check --release
+ cargo check --no-default-features --features=no-std --release
+ cargo check --no-default-features --features=futures --release
+ cargo doc --release
+ RUSTDOCFLAGS="--cfg=anchors" cargo doc --release
+ - name: Run cargo check for Taproot build.
+ run: |
+ cargo check --release
+ cargo check --no-default-features --features=no-std --release
+ cargo check --no-default-features --features=futures --release
+ cargo doc --release
+ env:
+ RUSTFLAGS: '--cfg=anchors --cfg=taproot'
+ RUSTDOCFLAGS: '--cfg=anchors --cfg=taproot'
+
+ fuzz:
+ runs-on: ubuntu-latest
+ env:
+ TOOLCHAIN: stable
+ steps:
+ - name: Checkout source code
+ uses: actions/checkout@v3
+ - name: Install Rust 1.58 toolchain
+ uses: actions-rs/toolchain@v1
+ with:
+ toolchain: 1.58
+ override: true
+ profile: minimal
- name: Install dependencies for honggfuzz
run: |
sudo apt-get update
sudo apt-get -y install build-essential binutils-dev libunwind-dev
- name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
- run: cd fuzz && cargo test --verbose --color always
+ run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always
- name: Run fuzzers
- run: cd fuzz && ./ci-fuzz.sh
+ run: cd fuzz && ./ci-fuzz.sh && cd ..
+ - name: Run lightning-invoice fuzzers
+ run: cd lightning-invoice/fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose && ./ci-fuzz.sh
- check_bindings:
+ linting:
runs-on: ubuntu-latest
- # Ubuntu's version of rustc uses its own LLVM instead of being a real native package.
- # This leaves us with an incompatible LLVM version when linking. Instead, use a real OS.
- container: debian:testing
env:
TOOLCHAIN: stable
steps:
- - name: Install native Rust toolchain, Valgrind, and build utilitis
- run: |
- apt-get update
- apt-get -y dist-upgrade
- apt-get -y install cargo valgrind lld git g++ clang
- name: Checkout source code
- uses: actions/checkout@v2
- - name: Install cbindgen
- run: cargo install --force cbindgen
- - name: Rebuild bindings, and check the sample app builds + links
- run: ./genbindings.sh
- - name: Check that the latest bindings are in git
+ uses: actions/checkout@v3
+ - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
+ uses: actions-rs/toolchain@v1
+ with:
+ toolchain: ${{ env.TOOLCHAIN }}
+ override: true
+ profile: minimal
+ - name: Install clippy
run: |
- if [ "$(git diff)" != "" ]; then
- # cbindgen's bindings output order can be FS-dependant, so check that the lines are all the same:
- mv lightning-c-bindings/include/lightning.h lightning-c-bindings/include/lightning.h.new
- git checkout lightning-c-bindings/include/lightning.h
- cat lightning-c-bindings/include/lightning.h | sort > lightning-c-bindings/include/lightning.h.sorted
- cat lightning-c-bindings/include/lightning.h.new | sort > lightning-c-bindings/include/lightning.h.new.sorted
- diff lightning-c-bindings/include/lightning.h.sorted lightning-c-bindings/include/lightning.h.new.sorted
- #
- mv lightning-c-bindings/include/lightningpp.hpp lightning-c-bindings/include/lightningpp.hpp.new
- git checkout lightning-c-bindings/include/lightningpp.hpp
- cat lightning-c-bindings/include/lightningpp.hpp | sort > lightning-c-bindings/include/lightningpp.hpp.sorted
- cat lightning-c-bindings/include/lightningpp.hpp.new | sort > lightning-c-bindings/include/lightningpp.hpp.new.sorted
- diff lightning-c-bindings/include/lightningpp.hpp.sorted lightning-c-bindings/include/lightningpp.hpp.new.sorted
- #
- [ "$(diff lightning-c-bindings/include/lightning.h.sorted lightning-c-bindings/include/lightning.h.new.sorted)" != "" ] && exit 2
- [ "$(diff lightning-c-bindings/include/lightningpp.hpp.sorted lightning-c-bindings/include/lightningpp.hpp.new.sorted)" != "" ] && exit 3
- git diff --exit-code
- fi
+ rustup component add clippy
+ - name: Run default clippy linting
+ run: |
+ cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err