_ Git - rust-lightning/blob - .github/workflows/build.yml

   1 name: Continuous Integration Checks
   2
   3 on: [push, pull_request]
   4
   5 jobs:
   6   build:
   7     strategy:
   8       fail-fast: false
   9       matrix:
  10         platform: [ ubuntu-latest ]
  11         toolchain: [ stable,
  12                      beta,
  13                      # 1.41.1 is MSRV for Rust-Lightning, lightning-invoice, and lightning-persister
  14                      1.41.1,
  15                      # 1.45.2 is MSRV for lightning-net-tokio, lightning-block-sync, and coverage generation
  16                      1.45.2,
  17                      # 1.47.0 will be the MSRV for no-std builds using hashbrown once core2 is updated
  18                      1.47.0]
  19         include:
  20           - toolchain: stable
  21             build-net-tokio: true
  22             build-no-std: true
  23           - toolchain: stable
  24             platform: macos-latest
  25             build-net-tokio: true
  26             build-no-std: true
  27           - toolchain: beta
  28             platform: macos-latest
  29             build-net-tokio: true
  30             build-no-std: true
  31           - toolchain: stable
  32             platform: windows-latest
  33             build-net-tokio: true
  34             build-no-std: true
  35           - toolchain: beta
  36             platform: windows-latest
  37             build-net-tokio: true
  38             build-no-std: true
  39           - toolchain: beta
  40             build-net-tokio: true
  41             build-no-std: true
  42           - toolchain: 1.41.1
  43             build-no-std: false
  44             test-log-variants: true
  45           - toolchain: 1.45.2
  46             build-net-old-tokio: true
  47             build-net-tokio: true
  48             build-no-std: false
  49             coverage: true
  50           - toolchain: 1.47.0
  51             build-no-std: true
  52     runs-on: ${{ matrix.platform }}
  53     steps:
  54       - name: Checkout source code
  55         uses: actions/checkout@v3
  56       - name: Install Rust ${{ matrix.toolchain }} toolchain
  57         uses: actions-rs/toolchain@v1
  58         with:
  59           toolchain: ${{ matrix.toolchain }}
  60           override: true
  61           profile: minimal
  62       - name: Pin tokio to 1.14 for Rust 1.45
  63         if: "matrix.build-net-old-tokio"
  64         run: cargo update -p tokio --precise "1.14.0" --verbose
  65         env:
  66           CARGO_NET_GIT_FETCH_WITH_CLI: "true"
  67       - name: Build on Rust ${{ matrix.toolchain }} with net-tokio
  68         if: "matrix.build-net-tokio && !matrix.coverage"
  69         run: cargo build --verbose --color always
  70       - name: Build on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
  71         if: matrix.coverage
  72         run: RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always
  73       - name: Build on Rust ${{ matrix.toolchain }}
  74         if: "! matrix.build-net-tokio"
  75         run: |
  76           cargo build --verbose  --color always -p lightning
  77           cargo build --verbose  --color always -p lightning-invoice
  78           cargo build --verbose  --color always -p lightning-persister
  79       - name: Build on Rust ${{ matrix.toolchain }} with all Log-Limiting features
  80         if: matrix.test-log-variants
  81         run: |
  82           cd lightning
  83           for FEATURE in $(cat Cargo.toml | grep '^max_level_' | awk '{ print $1 }'); do
  84             cargo build --verbose --color always --features $FEATURE
  85           done
  86       - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features
  87         if: "matrix.build-net-tokio && !matrix.coverage"
  88         run: |
  89           cd lightning-block-sync
  90           cargo build --verbose --color always --features rest-client
  91           cargo build --verbose --color always --features rpc-client
  92           cargo build --verbose --color always --features rpc-client,rest-client
  93           cargo build --verbose --color always --features rpc-client,rest-client,tokio
  94       - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
  95         if: matrix.coverage
  96         run: |
  97           cd lightning-block-sync
  98           RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rest-client
  99           RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client
 100           RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client
 101           RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client,tokio
 102       - name: Test backtrace-debug builds on Rust ${{ matrix.toolchain }}
 103         if: "matrix.build-no-std"
 104         run: |
 105           cd lightning && cargo test --verbose --color always --features backtrace
 106       - name: Test on Rust ${{ matrix.toolchain }} with net-tokio
 107         if: "matrix.build-net-tokio && !matrix.coverage"
 108         run: cargo test --verbose --color always
 109       - name: Test on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
 110         if: matrix.coverage
 111         run: RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always
 112       - name: Test on no-std bullds Rust ${{ matrix.toolchain }}
 113         if: "matrix.build-no-std && !matrix.coverage"
 114         shell: bash # Default on Winblows is powershell
 115         run: |
 116           cd lightning
 117           cargo test --verbose --color always --no-default-features --features no-std
 118           # check if there is a conflict between no-std and the default std feature
 119           cargo test --verbose --color always --features no-std
 120           # check that things still pass without grind_signatures
 121           # note that outbound_commitment_test only runs in this mode, because of hardcoded signature values
 122           cargo test --verbose --color always --no-default-features --features std
 123           # check if there is a conflict between no-std and the c_bindings cfg
 124           RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
 125           cd ..
 126           cd lightning-invoice
 127           cargo test --verbose --color always --no-default-features --features no-std
 128           # check if there is a conflict between no-std and the default std feature
 129           cargo test --verbose --color always --features no-std
 130           # check no-std compatibility across dependencies
 131           cd ..
 132           cd no-std-check
 133           cargo check --verbose --color always
 134           cd ..
 135       - name: Test on no-std builds Rust ${{ matrix.toolchain }} and full code-linking for coverage generation
 136         if: "matrix.build-no-std && matrix.coverage"
 137         run: |
 138           cd lightning
 139           RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --no-default-features --features no-std
 140           cd ..
 141       - name: Test on Rust ${{ matrix.toolchain }}
 142         if: "! matrix.build-net-tokio"
 143         run: |
 144           cargo test --verbose --color always  -p lightning
 145           cargo test --verbose --color always  -p lightning-invoice
 146           cargo test --verbose --color always  -p lightning-rapid-gossip-sync
 147           cargo build --verbose  --color always -p lightning-persister
 148           cargo build --verbose  --color always -p lightning-background-processor
 149       - name: Test C Bindings Modifications on Rust ${{ matrix.toolchain }}
 150         if: "! matrix.build-net-tokio"
 151         run: |
 152           RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always  -p lightning
 153           RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always  -p lightning-invoice
 154           RUSTFLAGS="--cfg=c_bindings" cargo build --verbose  --color always -p lightning-persister
 155           RUSTFLAGS="--cfg=c_bindings" cargo build --verbose  --color always -p lightning-background-processor
 156       - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features
 157         if: "matrix.build-net-tokio && !matrix.coverage"
 158         run: |
 159           cd lightning-block-sync
 160           cargo test --verbose --color always --features rest-client
 161           cargo test --verbose --color always --features rpc-client
 162           cargo test --verbose --color always --features rpc-client,rest-client
 163           cargo test --verbose --color always --features rpc-client,rest-client,tokio
 164       - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
 165         if: matrix.coverage
 166         run: |
 167           cd lightning-block-sync
 168           RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rest-client
 169           RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client
 170           RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client
 171           RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client,tokio
 172       - name: Install deps for kcov
 173         if: matrix.coverage
 174         run: |
 175           sudo apt-get update
 176           sudo apt-get -y install binutils-dev libcurl4-openssl-dev zlib1g-dev libdw-dev libiberty-dev
 177       - name: Install kcov
 178         if: matrix.coverage
 179         run: |
 180           wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz
 181           tar xzf master.tar.gz
 182           cd kcov-master && mkdir build && cd build
 183           cmake ..
 184           make
 185           make install DESTDIR=../../kcov-build
 186           cd ../.. && rm -rf kcov-master master.tar.gz
 187       - name: Generate coverage report
 188         if: matrix.coverage
 189         run: |
 190           for file in target/debug/deps/lightning*; do
 191             [ -x "${file}" ] || continue;
 192             mkdir -p "target/cov/$(basename $file)";
 193             ./kcov-build/usr/local/bin/kcov --exclude-pattern=/.cargo,/usr/lib --verify "target/cov/$(basename $file)" "$file";
 194           done
 195       - name: Upload coverage
 196         if: matrix.coverage
 197         uses: codecov/codecov-action@v3
 198         with:
 199           # Could you use this to fake the coverage report for your PR? Sure.
 200           # Will anyone be impressed by your amazing coverage? No
 201           # Maybe if codecov wasn't broken we wouldn't need to do this...
 202           token: f421b687-4dc2-4387-ac3d-dc3b2528af57
 203           fail_ci_if_error: true
 204
 205   benchmark:
 206     runs-on: ubuntu-latest
 207     env:
 208       TOOLCHAIN: nightly
 209     steps:
 210       - name: Checkout source code
 211         uses: actions/checkout@v3
 212       - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 213         uses: actions-rs/toolchain@v1
 214         with:
 215           toolchain: ${{ env.TOOLCHAIN }}
 216           override: true
 217           profile: minimal
 218       - name: Cache routing graph snapshot
 219         id: cache-graph
 220         uses: actions/cache@v3
 221         with:
 222           path: lightning/net_graph-2021-05-31.bin
 223           key: ldk-net_graph-v0.0.15-2021-05-31.bin
 224       - name: Fetch routing graph snapshot
 225         if: steps.cache-graph.outputs.cache-hit != 'true'
 226         run: |
 227           curl --verbose -L -o lightning/net_graph-2021-05-31.bin https://bitcoin.ninja/ldk-net_graph-v0.0.15-2021-05-31.bin
 228           echo "Sha sum: $(sha256sum lightning/net_graph-2021-05-31.bin | awk '{ print $1 }')"
 229           if [ "$(sha256sum lightning/net_graph-2021-05-31.bin | awk '{ print $1 }')" != "${EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM}" ]; then
 230             echo "Bad hash"
 231             exit 1
 232           fi
 233         env:
 234           EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM: 05a5361278f68ee2afd086cc04a1f927a63924be451f3221d380533acfacc303
 235       - name: Fetch rapid graph sync reference input
 236         run: |
 237           curl --verbose -L -o lightning-rapid-gossip-sync/res/full_graph.lngossip https://bitcoin.ninja/ldk-compressed_graph-285cb27df79-2022-07-21.bin
 238           echo "Sha sum: $(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')"
 239           if [ "$(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')" != "${EXPECTED_RAPID_GOSSIP_SHASUM}" ]; then
 240             echo "Bad hash"
 241             exit 1
 242           fi
 243         env:
 244           EXPECTED_RAPID_GOSSIP_SHASUM: e0f5d11641c11896d7af3a2246d3d6c3f1720b7d2d17aab321ecce82e6b7deb8
 245       - name: Test with Network Graph on Rust ${{ matrix.toolchain }}
 246         run: |
 247           cd lightning
 248           RUSTFLAGS="--cfg=require_route_graph_test" cargo test
 249           RUSTFLAGS="--cfg=require_route_graph_test" cargo test --features hashbrown
 250           cd ..
 251       - name: Run benchmarks on Rust ${{ matrix.toolchain }}
 252         run: |
 253           cargo bench --features _bench_unstable
 254
 255   check_commits:
 256     runs-on: ubuntu-latest
 257     env:
 258       TOOLCHAIN: 1.57.0
 259     steps:
 260       - name: Checkout source code
 261         uses: actions/checkout@v3
 262         with:
 263           fetch-depth: 0
 264       - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 265         uses: actions-rs/toolchain@v1
 266         with:
 267           toolchain: ${{ env.TOOLCHAIN }}
 268           override: true
 269           profile: minimal
 270       - name: Fetch full tree and rebase on upstream
 271         run: |
 272           git remote add upstream https://github.com/lightningdevkit/rust-lightning
 273           git fetch upstream
 274           export GIT_COMMITTER_EMAIL="rl-ci@example.com"
 275           export GIT_COMMITTER_NAME="RL CI"
 276           git rebase upstream/main
 277       - name: For each commit, run cargo check (including in fuzz)
 278         run: ci/check-each-commit.sh upstream/main
 279
 280   check_release:
 281     runs-on: ubuntu-latest
 282     env:
 283       TOOLCHAIN: stable
 284     steps:
 285       - name: Checkout source code
 286         uses: actions/checkout@v3
 287         with:
 288           fetch-depth: 0
 289       - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 290         uses: actions-rs/toolchain@v1
 291         with:
 292           toolchain: ${{ env.TOOLCHAIN }}
 293           override: true
 294           profile: minimal
 295       - name: Run cargo check for release build.
 296         run: |
 297           cargo check --release
 298           cargo check --no-default-features --features=no-std --release
 299           cargo doc --release
 300
 301   fuzz:
 302     runs-on: ubuntu-latest
 303     env:
 304       TOOLCHAIN: stable
 305     steps:
 306       - name: Checkout source code
 307         uses: actions/checkout@v3
 308       - name: Install Rust 1.58 toolchain
 309         uses: actions-rs/toolchain@v1
 310         with:
 311           toolchain: 1.58
 312           override: true
 313           profile: minimal
 314       - name: Install dependencies for honggfuzz
 315         run: |
 316           sudo apt-get update
 317           sudo apt-get -y install build-essential binutils-dev libunwind-dev
 318       - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
 319         run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always
 320       - name: Run fuzzers
 321         run: cd fuzz && ./ci-fuzz.sh && cd ..
 322       - name: Run lightning-invoice fuzzers
 323         run: cd lightning-invoice/fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose && ./ci-fuzz.sh
 324
 325   linting:
 326     runs-on: ubuntu-latest
 327     env:
 328       TOOLCHAIN: 1.47.0
 329     steps:
 330       - name: Checkout source code
 331         uses: actions/checkout@v3
 332       - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 333         uses: actions-rs/toolchain@v1
 334         with:
 335           toolchain: ${{ env.TOOLCHAIN }}
 336           override: true
 337           profile: minimal
 338       - name: Install clippy
 339         run: |
 340           rustup component add clippy
 341       - name: Run default clippy linting
 342         run: |
 343           cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err