Use Debian experimental in CI to match LLVM between rustc and clang

[rust-lightning] / .github / workflows / build.yml

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 64627bf087a3f9bc3d1cf4ca51b7b368ef4ea4c8..a7a62041745992f48cf506faa43ac0b385f16a8d 100644 (file)
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -8,8 +8,8 @@ jobs:
       matrix:
         toolchain: [ stable,
                      beta,
-                     # 1.22.0 is MSRV for rust-lightning in general:
-                     1.22.0,
+                     # 1.30.0 is MSRV for Rust-Lightning
+                     1.30.0,
                      # 1.34.2 is Debian stable
                      1.34.2,
                      # 1.39.0 is MSRV for lightning-net-tokio and generates coverage
@@ -17,11 +17,16 @@ jobs:
         include:
           - toolchain: stable
             build-net-tokio: true
+            build-bindings: true
           - toolchain: beta
             build-net-tokio: true
+            build-bindings: true
           - toolchain: 1.39.0
             build-net-tokio: true
+            build-bindings: true
             coverage: true
+          - toolchain: 1.34.2
+            build-bindings: true
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source code
@@ -38,6 +43,9 @@ jobs:
       - name: Build on Rust ${{ matrix.toolchain }}
         if: "! matrix.build-net-tokio"
         run: RUSTFLAGS="-C link-dead-code" cargo build --verbose  --color always -p lightning
+      - name: Build bindings on Rust ${{ matrix.toolchain }}
+        if: matrix.build-bindings
+        run: RUSTFLAGS="-C link-dead-code" cargo build --verbose  --color always -p lightning-c-bindings
       - name: Test on Rust ${{ matrix.toolchain }} with net-tokio
         if: matrix.build-net-tokio
         run: RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always
@@ -71,6 +79,10 @@ jobs:
         if: matrix.coverage
         uses: codecov/codecov-action@v1
         with:
+          # 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
 
   fuzz:
@@ -90,7 +102,52 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get -y install build-essential binutils-dev libunwind-dev
-      - name: Fuzz test on Rust ${{ matrix.TOOLCHAIN }}
+      - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
         run: cd fuzz && cargo test --verbose --color always
-      - name: Generate fuzz report
+      - name: Run fuzzers
         run: cd fuzz && ./ci-fuzz.sh
+
+  check_bindings:
+    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: 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
+        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 | sort > lightning-c-bindings/include/lightning.h.sorted
+            cat lightning-c-bindings/include/lightning.h.new | 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
+            #
+            mv lightning-c-bindings/include/lightningpp.hpp lightning-c-bindings/include/lightningpp.hpp.new
+            git checkout lightning-c-bindings/include/lightningpp.hpp
+            cat lightning-c-bindings/include/lightningpp.hpp | sort > lightning-c-bindings/include/lightningpp.hpp.sorted
+            cat lightning-c-bindings/include/lightningpp.hpp.new | sort > lightning-c-bindings/include/lightningpp.hpp.new.sorted
+            diff lightning-c-bindings/include/lightningpp.hpp.sorted lightning-c-bindings/include/lightningpp.hpp.new.sorted
+            #
+            [ "$(diff lightning-c-bindings/include/lightning.h.sorted lightning-c-bindings/include/lightning.h.new.sorted)" != "" ] && exit 2
+            [ "$(diff lightning-c-bindings/include/lightningpp.hpp.sorted lightning-c-bindings/include/lightningpp.hpp.new.sorted)" != "" ] && exit 3
+            git diff --exit-code
+          fi