X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=.github%2Fworkflows%2Fbuild.yml;h=ad5e1fc517bf4e5a706cbc90070ef407407e9cb5;hb=5aeb6c5167b42a151b25e27308c9efda7b46b2e9;hp=100441d2be200cb85e6e70b296691851f9edb818;hpb=2d213a47bffe2f3d9b744fe64e0001d90a4bf8fa;p=rust-lightning diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 100441d2..ad5e1fc5 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,274 +1,72 @@ 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.41.1 is MSRV for Rust-Lightning, lightning-invoice, and lightning-persister - 1.41.1, - # 1.45.2 is MSRV for lightning-net-tokio, lightning-block-sync, lightning-background-processor - 1.45.2, - # 1.47.0 will be the MSRV for no-std builds using hashbrown once core2 is updated - 1.47.0] - include: - - toolchain: stable - build-net-tokio: true - build-no-std: true - build-futures: true - build-tx-sync: true - coverage: true - - toolchain: stable - platform: macos-latest - build-net-tokio: true - build-no-std: true - build-futures: true - build-tx-sync: true - - toolchain: stable - test-custom-message: true - - toolchain: beta - platform: macos-latest - build-net-tokio: true - build-no-std: true - build-futures: true - build-tx-sync: true - - toolchain: stable - platform: windows-latest - build-net-tokio: true - build-no-std: true - build-futures: true - build-tx-sync: false - - toolchain: beta - platform: windows-latest - build-net-tokio: true - build-no-std: true - build-futures: true - build-tx-sync: false - - toolchain: beta - build-net-tokio: true - build-no-std: true - build-futures: true - build-tx-sync: true - - toolchain: beta - test-custom-message: true - - toolchain: 1.41.1 - build-no-std: false - test-log-variants: true - build-futures: false - build-tx-sync: false - - toolchain: 1.45.2 - build-net-old-tokio: true - build-net-tokio: true - build-no-std: false - build-futures: true - build-tx-sync: false - - toolchain: 1.47.0 - build-futures: true - build-no-std: true - build-tx-sync: false + platform: [ ubuntu-latest, windows-latest, macos-latest ] + toolchain: [ stable, beta, 1.63.0 ] # 1.63.0 is the MSRV for all crates. runs-on: ${{ matrix.platform }} steps: - name: Checkout source code uses: actions/checkout@v3 - name: Install Rust ${{ matrix.toolchain }} toolchain - uses: actions-rs/toolchain@v1 - with: - toolchain: ${{ matrix.toolchain }} - override: true - profile: minimal - - name: Pin tokio to 1.14 for Rust 1.45 - if: "matrix.build-net-old-tokio" - run: cargo update -p tokio --precise "1.14.0" --verbose - env: - CARGO_NET_GIT_FETCH_WITH_CLI: "true" - - name: Pin tokio to 1.26 for Windows - if: "matrix.platform == 'windows-latest'" - run: cargo update -p tokio --precise "1.26.0" --verbose - env: - CARGO_NET_GIT_FETCH_WITH_CLI: "true" - - 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 - cargo build --verbose --color always -p lightning-invoice - cargo build --verbose --color always -p lightning-persister - - name: Build on Rust ${{ matrix.toolchain }} with all Log-Limiting features - if: matrix.test-log-variants - run: | - cd lightning - for FEATURE in $(cat Cargo.toml | grep '^max_level_' | awk '{ print $1 }'); do - cargo build --verbose --color always --features $FEATURE - done - - 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 - - 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 - - name: Build Transaction Sync Clients on Rust ${{ matrix.toolchain }} with features - if: "matrix.build-tx-sync && !matrix.coverage" - run: | - cd lightning-transaction-sync - cargo build --verbose --color always --features esplora-blocking - cargo build --verbose --color always --features esplora-async - cargo build --verbose --color always --features esplora-async-https - - name: Build transaction sync clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation - if: "matrix.build-tx-sync && matrix.coverage" - run: | - cd lightning-transaction-sync - RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features esplora-blocking - RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features esplora-async - RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features esplora-async-https - - name: Test transaction sync clients on Rust ${{ matrix.toolchain }} with features - if: "matrix.build-tx-sync" - run: | - cd lightning-transaction-sync - cargo test --verbose --color always --features esplora-blocking - cargo test --verbose --color always --features esplora-async - cargo test --verbose --color always --features esplora-async-https - - name: Test backtrace-debug builds on Rust ${{ matrix.toolchain }} - if: "matrix.toolchain == 'stable'" - shell: bash # Default on Winblows is powershell - run: | - cd lightning && RUST_BACKTRACE=1 cargo test --verbose --color always --features backtrace - - 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 no-std builds on Rust ${{ matrix.toolchain }} - if: "matrix.build-no-std && !matrix.coverage" - shell: bash # Default on Winblows is powershell run: | - for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do - cd $DIR - cargo test --verbose --color always --no-default-features --features no-std - # check if there is a conflict between no-std and the default std feature - cargo test --verbose --color always --features no-std - # check that things still pass without grind_signatures - # note that outbound_commitment_test only runs in this mode, because of hardcoded signature values - cargo test --verbose --color always --no-default-features --features std - # check if there is a conflict between no-std and the c_bindings cfg - RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std - cd .. - done - # check no-std compatibility across dependencies - cd no-std-check - cargo check --verbose --color always --features lightning-transaction-sync - - name: Build no-std-check on Rust ${{ matrix.toolchain }} for ARM Embedded - if: "matrix.build-no-std && matrix.platform == 'ubuntu-latest'" + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ matrix.toolchain }} + rustup override set ${{ matrix.toolchain }} + - name: Install no-std-check dependencies for ARM Embedded + if: "matrix.platform == 'ubuntu-latest'" run: | - cd no-std-check rustup target add thumbv7m-none-eabi sudo apt-get -y install gcc-arm-none-eabi - cargo build --target=thumbv7m-none-eabi - - name: Test on no-std builds Rust ${{ matrix.toolchain }} and full code-linking for coverage generation - if: "matrix.build-no-std && matrix.coverage" - run: | - cd lightning - RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --no-default-features --features no-std - - name: Test futures builds on Rust ${{ matrix.toolchain }} - if: "matrix.build-futures && !matrix.coverage" + - name: Check for unknown cfg tags + run: ci/check-cfg-flags.py + - name: shellcheck the CI script + if: "matrix.platform == 'ubuntu-latest'" + run: | + sudo apt-get -y install shellcheck + shellcheck ci/ci-tests.sh + - name: Set RUSTFLAGS to deny warnings + if: "matrix.toolchain == '1.63.0'" + run: echo "RUSTFLAGS=-D warnings" >> "$GITHUB_ENV" + - name: Run CI script shell: bash # Default on Winblows is powershell + run: CI_MINIMIZE_DISK_USAGE=1 ./ci/ci-tests.sh + + coverage: + strategy: + fail-fast: false + runs-on: ubuntu-latest + steps: + - name: Checkout source code + uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Install Rust stable toolchain run: | - cd lightning-background-processor - cargo test --verbose --color always --no-default-features --features futures - - name: Test futures builds on Rust ${{ matrix.toolchain }} and full code-linking for coverage generation - if: "matrix.build-futures && matrix.coverage" - shell: bash # Default on Winblows is powershell - run: | - cd lightning-background-processor - RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --no-default-features --features futures - - name: Test on Rust ${{ matrix.toolchain }} - if: "! matrix.build-net-tokio" - run: | - cargo test --verbose --color always -p lightning - cargo test --verbose --color always -p lightning-invoice - cargo test --verbose --color always -p lightning-rapid-gossip-sync - cargo test --verbose --color always -p lightning-persister - cargo test --verbose --color always -p lightning-background-processor - - name: Test C Bindings Modifications on Rust ${{ matrix.toolchain }} - if: "! matrix.build-net-tokio" - run: | - RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always -p lightning - RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always -p lightning-invoice - RUSTFLAGS="--cfg=c_bindings" cargo build --verbose --color always -p lightning-persister - RUSTFLAGS="--cfg=c_bindings" cargo build --verbose --color always -p lightning-background-processor - - 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 - - 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 - - name: Test Custom Message Macros on Rust ${{ matrix.toolchain }} - if: "matrix.test-custom-message" - run: | - cd lightning-custom-message - cargo test --verbose --color always - - name: Install deps for kcov - if: matrix.coverage - run: | - sudo apt-get update - sudo apt-get -y install binutils-dev libcurl4-openssl-dev zlib1g-dev libdw-dev libiberty-dev - - name: Install kcov - if: matrix.coverage - run: | - wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz - tar xzf master.tar.gz - cd kcov-master && mkdir build && cd build - cmake .. - make - make install DESTDIR=../../kcov-build - cd ../.. && rm -rf kcov-master master.tar.gz - - name: Generate coverage report - if: matrix.coverage + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal + - name: Run tests with coverage generation run: | - 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@v3 - with: + cargo install cargo-llvm-cov + export RUSTFLAGS="-Clink-dead-code -Coverflow-checks=off" + cargo llvm-cov --features rest-client,rpc-client,tokio,futures,serde --codecov --hide-instantiations --output-path=target/codecov.json # 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 + bash <(curl -s https://codecov.io/bash) -f target/codecov.json -t "f421b687-4dc2-4387-ac3d-dc3b2528af57" benchmark: runs-on: ubuntu-latest @@ -278,11 +76,9 @@ jobs: - name: Checkout source code uses: actions/checkout@v3 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain - uses: actions-rs/toolchain@v1 - with: - toolchain: ${{ env.TOOLCHAIN }} - override: true - profile: minimal + run: | + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }} + rustup override set ${{ env.TOOLCHAIN }} - name: Cache routing graph snapshot id: cache-graph uses: actions/cache@v3 @@ -318,23 +114,26 @@ jobs: cd .. - name: Run benchmarks on Rust ${{ matrix.toolchain }} run: | - RUSTC_BOOTSTRAP=1 cargo bench --features _bench_unstable + cd bench + RUSTFLAGS="--cfg=ldk_bench --cfg=require_route_graph_test" cargo bench + - name: Run benchmarks with hashbrown on Rust ${{ matrix.toolchain }} + run: | + cd bench + RUSTFLAGS="--cfg=ldk_bench --cfg=require_route_graph_test" cargo bench --features hashbrown check_commits: runs-on: ubuntu-latest env: - TOOLCHAIN: 1.57.0 + 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 + run: | + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }} + rustup override set ${{ env.TOOLCHAIN }} - name: Fetch full tree and rebase on upstream run: | git remote add upstream https://github.com/lightningdevkit/rust-lightning @@ -355,31 +154,36 @@ jobs: with: fetch-depth: 0 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain - uses: actions-rs/toolchain@v1 - with: - toolchain: ${{ env.TOOLCHAIN }} - override: true - profile: minimal + run: | + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }} + rustup override set ${{ env.TOOLCHAIN }} - 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 check --no-default-features --features=futures,std --release + 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,std --release cargo doc --release + env: + RUSTFLAGS: '--cfg=taproot' + RUSTDOCFLAGS: '--cfg=taproot' fuzz: runs-on: ubuntu-latest env: - TOOLCHAIN: stable + TOOLCHAIN: 1.58 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 Rust ${{ env.TOOLCHAIN }} toolchain + run: | + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }} + rustup override set ${{ env.TOOLCHAIN }} - name: Install dependencies for honggfuzz run: | sudo apt-get update @@ -399,11 +203,9 @@ jobs: - name: Checkout source code uses: actions/checkout@v3 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain - uses: actions-rs/toolchain@v1 - with: - toolchain: ${{ env.TOOLCHAIN }} - override: true - profile: minimal + run: | + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }} + rustup override set ${{ env.TOOLCHAIN }} - name: Install clippy run: | rustup component add clippy