X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=.github%2Fworkflows%2Fbuild.yml;h=8e02ec9da75c803caa0dfd9b797ea6b892a13298;hb=c3de782a2baab0c742332bea4783c393edb83311;hp=e4fe497fa3b6d3d8307d6392f6c2847751bdd6d2;hpb=1c8401490f7950e7c6649a8ebd45414960337251;p=rust-lightning diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e4fe497f..8e02ec9d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,98 +1,65 @@ 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: - platform: [ ubuntu-latest ] - toolchain: [ stable, - beta, - # 1.30.0 is MSRV for Rust-Lightning - 1.30.0, - # 1.34.2 is Debian stable - 1.34.2, - # 1.45.2 is MSRV for lightning-net-tokio, lightning-block-sync, and coverage generation - 1.45.2] + platform: [ ubuntu-latest, windows-latest, macos-latest ] + toolchain: [ stable, beta ] 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.45.2 - build-net-tokio: true + platform: ubuntu-latest coverage: true + # 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 && !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: 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 + - name: Install no-std-check dependencies for ARM Embedded + if: "matrix.platform == 'ubuntu-latest'" 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 && !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: 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" + 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: | - 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 + sudo apt-get -y install shellcheck + shellcheck ci/ci-tests.sh + - name: Run CI script with 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 .. + 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: | @@ -118,7 +85,7 @@ jobs: 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 @@ -129,10 +96,10 @@ jobs: benchmark: runs-on: ubuntu-latest env: - TOOLCHAIN: nightly + 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: @@ -141,31 +108,48 @@ jobs: profile: minimal - name: Cache routing graph snapshot id: cache-graph - uses: actions/cache@v2 + uses: actions/cache@v3 with: - path: lightning/net_graph-2021-02-12.bin - key: net_graph-2021-02-12 + 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: | - 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 + 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 - - name: Run benchmarks on Rust ${{ matrix.toolchain }} + 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 - cargo bench --features unstable + 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: stable + TOOLCHAIN: 1.57.0 steps: - name: Checkout source code - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: fetch-depth: 0 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain @@ -176,7 +160,7 @@ jobs: profile: minimal - name: Fetch full tree and rebase on upstream run: | - git remote add upstream https://github.com/rust-bitcoin/rust-lightning + 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" @@ -184,75 +168,69 @@ jobs: - name: For each commit, run cargo check (including in fuzz) run: ci/check-each-commit.sh upstream/main - fuzz: + check_release: runs-on: ubuntu-latest env: TOOLCHAIN: stable steps: - name: Checkout source code - uses: actions/checkout@v2 + 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: Install dependencies for honggfuzz + - name: Run cargo check for release build. 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 - - name: Run fuzzers - run: cd fuzz && ./ci-fuzz.sh + 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' - check_bindings: + fuzz: 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. - # We further (temporarily) use Debian experimental since testing links rustc against the - # brand-new llvm-10, but clang/llvm still default to LLVM 9. - container: debian:experimental env: TOOLCHAIN: stable steps: - - name: Install native Rust toolchain, Valgrind, and build utilitis - run: | - echo 'Package: llvm llvm-runtime clang lld' > /etc/apt/preferences.d/99-llvm10 - echo 'Pin: release n=experimental' >> /etc/apt/preferences.d/99-llvm10 - echo 'Pin-Priority: 995' >> /etc/apt/preferences.d/99-llvm10 - 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: Sanity test bindings - working-directory: lightning-c-bindings - run: cargo check - - 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 1.58 toolchain + uses: actions-rs/toolchain@v1 + with: + toolchain: 1.58 + override: true + profile: minimal + - name: Install dependencies for honggfuzz 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 | grep -v "Generated with cbindgen:[0-9\.]*" | sort > lightning-c-bindings/include/lightning.h.sorted - cat lightning-c-bindings/include/lightning.h.new | grep -v "Generated with cbindgen:[0-9\.]*" | 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 - [ "$(diff lightning-c-bindings/include/lightning.h.sorted lightning-c-bindings/include/lightning.h.new.sorted)" != "" ] && exit 2 - git diff --exit-code - fi + 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 && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always + - name: Run fuzzers + 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 linting: runs-on: ubuntu-latest env: - TOOLCHAIN: 1.45.2 + 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: @@ -264,4 +242,4 @@ jobs: rustup component add clippy - name: Run default clippy linting run: | - cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else + cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err