_ 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       - name: Build on Rust ${{ matrix.toolchain }} with net-tokio
  66         if: "matrix.build-net-tokio && !matrix.coverage"
  67         run: cargo build --verbose --color always
  68       - name: Build on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
  69         if: matrix.coverage
  70         run: RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always
  71       - name: Build on Rust ${{ matrix.toolchain }}
  72         if: "! matrix.build-net-tokio"
  73         run: |
  74           cargo build --verbose  --color always -p lightning
  75           cargo build --verbose  --color always -p lightning-invoice
  76           cargo build --verbose  --color always -p lightning-persister
  77       - name: Build on Rust ${{ matrix.toolchain }} with all Log-Limiting features
  78         if: matrix.test-log-variants
  79         run: |
  80           cd lightning
  81           for FEATURE in $(cat Cargo.toml | grep '^max_level_' | awk '{ print $1 }'); do
  82             cargo build --verbose --color always --features $FEATURE
  83           done
  84       - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features
  85         if: "matrix.build-net-tokio && !matrix.coverage"
  86         run: |
  87           cd lightning-block-sync
  88           cargo build --verbose --color always --features rest-client
  89           cargo build --verbose --color always --features rpc-client
  90           cargo build --verbose --color always --features rpc-client,rest-client
  91           cargo build --verbose --color always --features rpc-client,rest-client,tokio
  92       - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
  93         if: matrix.coverage
  94         run: |
  95           cd lightning-block-sync
  96           RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rest-client
  97           RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client
  98           RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client
  99           RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client,tokio
 100       - name: Test backtrace-debug builds on Rust ${{ matrix.toolchain }}
 101         if: "matrix.build-no-std"
 102         run: |
 103           cd lightning && cargo test --verbose --color always --features backtrace
 104       - name: Test on Rust ${{ matrix.toolchain }} with net-tokio
 105         if: "matrix.build-net-tokio && !matrix.coverage"
 106         run: cargo test --verbose --color always
 107       - name: Test on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
 108         if: matrix.coverage
 109         run: RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always
 110       - name: Test on no-std bullds Rust ${{ matrix.toolchain }}
 111         if: "matrix.build-no-std && !matrix.coverage"
 112         shell: bash # Default on Winblows is powershell
 113         run: |
 114           cd lightning
 115           cargo test --verbose --color always --no-default-features --features no-std
 116           # check if there is a conflict between no-std and the default std feature
 117           cargo test --verbose --color always --features no-std
 118           # check if there is a conflict between no-std and the c_bindings cfg
 119           RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
 120           cd ..
 121           cd lightning-invoice
 122           cargo test --verbose --color always --no-default-features --features no-std
 123           # check if there is a conflict between no-std and the default std feature
 124           cargo test --verbose --color always --features no-std
 125           # check no-std compatibility across dependencies
 126           cd ..
 127           cd no-std-check
 128           cargo check --verbose --color always
 129           cd ..
 130       - name: Test on no-std builds Rust ${{ matrix.toolchain }} and full code-linking for coverage generation
 131         if: "matrix.build-no-std && matrix.coverage"
 132         run: |
 133           cd lightning
 134           RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --no-default-features --features no-std
 135           cd ..
 136       - name: Test on Rust ${{ matrix.toolchain }}
 137         if: "! matrix.build-net-tokio"
 138         run: |
 139           cargo test --verbose --color always  -p lightning
 140           cargo test --verbose --color always  -p lightning-invoice
 141           cargo build --verbose  --color always -p lightning-persister
 142           cargo build --verbose  --color always -p lightning-background-processor
 143       - name: Test C Bindings Modifications on Rust ${{ matrix.toolchain }}
 144         if: "! matrix.build-net-tokio"
 145         run: |
 146           RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always  -p lightning
 147           RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always  -p lightning-invoice
 148           RUSTFLAGS="--cfg=c_bindings" cargo build --verbose  --color always -p lightning-persister
 149           RUSTFLAGS="--cfg=c_bindings" cargo build --verbose  --color always -p lightning-background-processor
 150       - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features
 151         if: "matrix.build-net-tokio && !matrix.coverage"
 152         run: |
 153           cd lightning-block-sync
 154           cargo test --verbose --color always --features rest-client
 155           cargo test --verbose --color always --features rpc-client
 156           cargo test --verbose --color always --features rpc-client,rest-client
 157           cargo test --verbose --color always --features rpc-client,rest-client,tokio
 158       - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
 159         if: matrix.coverage
 160         run: |
 161           cd lightning-block-sync
 162           RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rest-client
 163           RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client
 164           RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client
 165           RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client,tokio
 166       - name: Install deps for kcov
 167         if: matrix.coverage
 168         run: |
 169           sudo apt-get update
 170           sudo apt-get -y install binutils-dev libcurl4-openssl-dev zlib1g-dev libdw-dev libiberty-dev
 171       - name: Install kcov
 172         if: matrix.coverage
 173         run: |
 174           wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz
 175           tar xzf master.tar.gz
 176           cd kcov-master && mkdir build && cd build
 177           cmake ..
 178           make
 179           make install DESTDIR=../../kcov-build
 180           cd ../.. && rm -rf kcov-master master.tar.gz
 181       - name: Generate coverage report
 182         if: matrix.coverage
 183         run: |
 184           for file in target/debug/deps/lightning*; do
 185             [ -x "${file}" ] || continue;
 186             mkdir -p "target/cov/$(basename $file)";
 187             ./kcov-build/usr/local/bin/kcov --exclude-pattern=/.cargo,/usr/lib --verify "target/cov/$(basename $file)" "$file";
 188           done
 189       - name: Upload coverage
 190         if: matrix.coverage
 191         uses: codecov/codecov-action@v2
 192         with:
 193           # Could you use this to fake the coverage report for your PR? Sure.
 194           # Will anyone be impressed by your amazing coverage? No
 195           # Maybe if codecov wasn't broken we wouldn't need to do this...
 196           token: f421b687-4dc2-4387-ac3d-dc3b2528af57
 197           fail_ci_if_error: true
 198
 199   benchmark:
 200     runs-on: ubuntu-latest
 201     env:
 202       TOOLCHAIN: nightly
 203     steps:
 204       - name: Checkout source code
 205         uses: actions/checkout@v3
 206       - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 207         uses: actions-rs/toolchain@v1
 208         with:
 209           toolchain: ${{ env.TOOLCHAIN }}
 210           override: true
 211           profile: minimal
 212       - name: Cache routing graph snapshot
 213         id: cache-graph
 214         uses: actions/cache@v3
 215         with:
 216           path: lightning/net_graph-2021-05-31.bin
 217           key: ldk-net_graph-v0.0.15-2021-05-31.bin
 218       - name: Fetch routing graph snapshot
 219         if: steps.cache-graph.outputs.cache-hit != 'true'
 220         run: |
 221           wget -O lightning/net_graph-2021-05-31.bin https://bitcoin.ninja/ldk-net_graph-v0.0.15-2021-05-31.bin
 222           if [ "$(sha256sum lightning/net_graph-2021-05-31.bin | awk '{ print $1 }')" != "05a5361278f68ee2afd086cc04a1f927a63924be451f3221d380533acfacc303" ]; then
 223             echo "Bad hash"
 224             exit 1
 225           fi
 226       - name: Test with Network Graph on Rust ${{ matrix.toolchain }}
 227         run: |
 228           cd lightning
 229           RUSTFLAGS="--cfg=require_route_graph_test" cargo test
 230           RUSTFLAGS="--cfg=require_route_graph_test" cargo test --features hashbrown
 231           cd ..
 232       - name: Run benchmarks on Rust ${{ matrix.toolchain }}
 233         run: |
 234           cargo bench --features _bench_unstable
 235
 236   check_commits:
 237     runs-on: ubuntu-latest
 238     env:
 239       # rustc 1.53 regressed and panics when building our (perfectly fine) docs.
 240       # See https://github.com/rust-lang/rust/issues/84738
 241       TOOLCHAIN: 1.52.1
 242     steps:
 243       - name: Checkout source code
 244         uses: actions/checkout@v3
 245         with:
 246           fetch-depth: 0
 247       - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 248         uses: actions-rs/toolchain@v1
 249         with:
 250           toolchain: ${{ env.TOOLCHAIN }}
 251           override: true
 252           profile: minimal
 253       - name: Fetch full tree and rebase on upstream
 254         run: |
 255           git remote add upstream https://github.com/lightningdevkit/rust-lightning
 256           git fetch upstream
 257           export GIT_COMMITTER_EMAIL="rl-ci@example.com"
 258           export GIT_COMMITTER_NAME="RL CI"
 259           git rebase upstream/main
 260       - name: For each commit, run cargo check (including in fuzz)
 261         run: ci/check-each-commit.sh upstream/main
 262
 263   fuzz:
 264     runs-on: ubuntu-latest
 265     env:
 266       TOOLCHAIN: stable
 267     steps:
 268       - name: Checkout source code
 269         uses: actions/checkout@v3
 270       - name: Install Rust 1.58 toolchain
 271         uses: actions-rs/toolchain@v1
 272         with:
 273           toolchain: 1.58
 274           override: true
 275           profile: minimal
 276       - name: Install dependencies for honggfuzz
 277         run: |
 278           sudo apt-get update
 279           sudo apt-get -y install build-essential binutils-dev libunwind-dev
 280       - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
 281         run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always
 282       - name: Run fuzzers
 283         run: cd fuzz && ./ci-fuzz.sh && cd ..
 284       - name: Run lightning-invoice fuzzers
 285         run: cd lightning-invoice/fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose && ./ci-fuzz.sh
 286
 287   linting:
 288     runs-on: ubuntu-latest
 289     env:
 290       TOOLCHAIN: 1.47.0
 291     steps:
 292       - name: Checkout source code
 293         uses: actions/checkout@v3
 294       - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
 295         uses: actions-rs/toolchain@v1
 296         with:
 297           toolchain: ${{ env.TOOLCHAIN }}
 298           override: true
 299           profile: minimal
 300       - name: Install clippy
 301         run: |
 302           rustup component add clippy
 303       - name: Run default clippy linting
 304         run: |
 305           cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err