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