Add a build mode for "release optimizations with leaks checks", handle a jar in CI
[ldk-java] / .github / workflows / build.yml
1 name: Continuous Integration Checks
2
3 on: [push, pull_request]
4
5 jobs:
6   check_bindings:
7     runs-on: ubuntu-latest
8     # Ubuntu's version of rustc uses its own LLVM instead of being a real native package.
9     # This leaves us with an incompatible LLVM version when linking. Instead, use a real OS.
10     container: debian:bullseye
11     env:
12       TOOLCHAIN: stable
13     strategy:
14       fail-fast: false
15     steps:
16       - name: Install native Rust toolchain, Valgrind, and build utilitis
17         run: |
18           apt-get update
19           apt-get -y dist-upgrade
20           apt-get -y install cargo libstd-rust-dev-wasm32 valgrind lld git g++ clang openjdk-11-jdk maven faketime zip unzip llvm
21       - name: Checkout source code
22         uses: actions/checkout@v2
23         with:
24           fetch-depth: 0
25       - name: Install cbindgen
26         run: cargo install --force cbindgen
27       - name: Checkout Rust-Lightning and LDK-C-Bindings git
28         run: |
29           git config --global user.email "ldk-ci@example.com"
30           git config --global user.name "LDK CI"
31           # Note this is a different endpoint, as we need one non-upstream commit!
32           git clone https://git.bitcoin.ninja/rust-lightning
33           cd rust-lightning
34           git checkout origin/2021-03-java-bindings-base
35           cd ..
36           git clone https://github.com/lightningdevkit/ldk-c-bindings
37           cd ldk-c-bindings
38           git checkout 0.0.100
39       - name: Rebuild C bindings without STD for WASM
40         run: |
41           cd ldk-c-bindings
42           ./genbindings.sh ../rust-lightning false
43           mv lightning-c-bindings/target/wasm32-wasi ./
44           cd ..
45       - name: Rebuild C bindings, and check the sample app builds + links
46         run: |
47           cd ldk-c-bindings
48           # Reset the Cargo.toml file so that git describe doesn't think we're "-dirty"
49           git checkout lightning-c-bindings/Cargo.toml
50           ./genbindings.sh ../rust-lightning true
51           mv wasm32-wasi lightning-c-bindings/target/
52           cd ..
53       - name: Build Java/TS Debug Bindings
54         run: ./genbindings.sh ./ldk-c-bindings/ "-I/usr/lib/jvm/java-11-openjdk-amd64/include/ -I/usr/lib/jvm/java-11-openjdk-amd64/include/linux/" true false
55       - name: Run Java Tests against Debug Bindings
56         run: |
57           mv liblightningjni_debug_Linux-amd64.so liblightningjni.so
58           export ASAN_OPTIONS=detect_leaks=0
59           LD_PRELOAD=/usr/lib/llvm-11/lib/clang/11.0.1/lib/linux/libclang_rt.asan-x86_64.so LD_LIBRARY_PATH=. mvn test
60       - name: Detect current git version
61         run: |
62           # We assume the top commit is just a bindings update commit, so we
63           # check out the previous commit to use as the commit we git describe.
64           # If the top commit is a merge commit, we need to get the last merge
65           # head and assume the latest bindings are built against its parent.
66           COMMIT_PARENTS=$(git show -s --pretty=format:%P HEAD)
67           if [ "${#COMMIT_PARENTS}" = 40 ]; then
68             export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(git describe --tag HEAD^1)"
69           else
70             MERGE_HEAD=$(git show --pretty=format:%P HEAD | ( for last in $(cat /dev/stdin); do true; done; echo $last ))
71             export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(git describe --tag $MERGE_HEAD^1)"
72           fi
73           echo "Using $LDK_GARBAGECOLLECTED_GIT_OVERRIDE as git version"
74           echo "$LDK_GARBAGECOLLECTED_GIT_OVERRIDE" > .git_ver
75       - name: Checkout latest MacOS binaries
76         run: |
77           export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(cat .git_ver)"
78           git clone --depth 1 https://git.bitcoin.ninja/ldk-java-bins
79           mkdir -p src/main/resources/
80           cp "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/liblightningjni_MacOSX-"* src/main/resources/
81       - name: Build Java/TS Release Bindings
82         run: |
83           export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(cat .git_ver)"
84           ./genbindings.sh ./ldk-c-bindings/ "-I/usr/lib/jvm/java-11-openjdk-amd64/include/ -I/usr/lib/jvm/java-11-openjdk-amd64/include/linux/" false false
85       - name: Build deterministic release jar
86         run: ./build-release-jar.sh
87       - name: Check latest headers are in git
88         run: |
89           git diff --exit-code
90       - name: Check latest library and jars are in bins repo
91         run: |
92           export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(cat .git_ver)"
93           rm "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"*.jar
94           rm "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"liblightningjni_Linux*.nativelib
95           cp src/main/resources/liblightningjni_Linux-amd64.nativelib "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"
96           cp ldk-java-sources.jar "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"
97           cp ldk-java.jar "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"
98           cp ldk-java-classes.jar "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"
99           cp ldk-java-javadoc.jar "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"
100           cd ldk-java-bins
101           # ldk-java-leaktracking is only for debug purposes and we don't bother with determinism
102           git checkout "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/ldk-java-leaktracking.jar"
103           if ! git diff --exit-code; then
104             mv "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"* ./
105             git checkout "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"
106             apt-get -y install diffoscope
107             diffoscope ldk-java-sources.jar "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/ldk-java-sources.jar" || echo
108             diffoscope ldk-java-javadoc.jar "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/ldk-java-javadoc.jar" || echo
109             diffoscope ldk-java-classes.jar "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/ldk-java-classes.jar" || echo
110             diffoscope ldk-java.jar "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/ldk-java.jar" || echo
111             exit 1
112           fi
113       - name: Run Java Tests against built release jar
114         run: |
115           mvn install:install-file -Dfile=ldk-java.jar -DgroupId=org.lightningdevkit -DartifactId=ldk-java -Dversion=1.0-SNAPSHOT -Dpackaging=jar
116           cd javatester
117           mvn package
118           java -ea -jar target/ldk-java-tests-1.0-SNAPSHOT-jar-with-dependencies.jar
119           cd ..
120
121   android:
122     runs-on: ubuntu-latest
123     # Frankly, I'm not really sure why debian and ubuntu differ in the results here, they really shouldn't
124     container: debian:bullseye
125     env:
126       TOOLCHAIN: stable
127     strategy:
128       fail-fast: false
129     steps:
130       - name: Install rust targets
131         run: |
132           apt-get update
133           apt-get -y dist-upgrade
134           apt-get -y install git g++ clang faketime zip unzip curl openjdk-11-jdk
135           curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs > rustup.sh
136           chmod +x ./rustup.sh
137           ./rustup.sh -y
138           . $HOME/.cargo/env
139           rustup target add armv7-linux-androideabi
140           rustup target add aarch64-linux-android
141           rustup target add i686-linux-android
142           rustup target add x86_64-linux-android
143       - name: Checkout source code
144         uses: actions/checkout@v2
145         with:
146           fetch-depth: 0
147       - name: Install android NDK compilers
148         run: |
149           curl https://dl.google.com/android/repository/android-ndk-r22b-linux-x86_64.zip > android-ndk-r22b-linux-x86_64.zip
150           if [ "$(sha256sum android-ndk-r22b-linux-x86_64.zip | awk '{ print $1 }')" != "ac3a0421e76f71dd330d0cd55f9d99b9ac864c4c034fc67e0d671d022d4e806b" ]; then
151             echo "Bad hash"
152             exit 1
153           fi
154           unzip android-ndk-r22b-linux-x86_64.zip
155       - name: Install cbindgen
156         run: |
157           . $HOME/.cargo/env
158           cargo install --force cbindgen
159       - name: Checkout Rust-Lightning and LDK-C-Bindings git
160         run: |
161           git config --global user.email "ldk-ci@example.com"
162           git config --global user.name "LDK CI"
163           # Note this is a different endpoint, as we need one non-upstream commit!
164           git clone https://git.bitcoin.ninja/rust-lightning
165           cd rust-lightning
166           git checkout origin/2021-03-java-bindings-base
167           cd ..
168           git clone https://github.com/lightningdevkit/ldk-c-bindings
169           cd ldk-c-bindings
170           git checkout 0.0.100
171       - name: Detect current git version
172         run: |
173           # We assume the top commit is just a bindings update commit, so we
174           # check out the previous commit to use as the commit we git describe.
175           # If the top commit is a merge commit, we need to get the last merge
176           # head and assume the latest bindings are built against its parent.
177           COMMIT_PARENTS=$(git show -s --pretty=format:%P HEAD)
178           if [ "${#COMMIT_PARENTS}" = 40 ]; then
179             export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(git describe --tag HEAD^1)"
180           else
181             MERGE_HEAD=$(git show --pretty=format:%P HEAD | ( for last in $(cat /dev/stdin); do true; done; echo $last ))
182             export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(git describe --tag $MERGE_HEAD^1)"
183           fi
184           echo "Using $LDK_GARBAGECOLLECTED_GIT_OVERRIDE as git version"
185           echo "$LDK_GARBAGECOLLECTED_GIT_OVERRIDE" > .git_ver
186       - name: Checkout Android AAR binaries and artifacts
187         run: git clone --depth 1 https://git.bitcoin.ninja/ldk-java-bins
188       - name: Build Android aar
189         run: |
190           . $HOME/.cargo/env
191           export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(cat .git_ver)"
192           cp "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/ldk-java-classes.jar" ./
193           export ANDROID_TOOLCHAIN="$(pwd)/android-ndk-r22b/toolchains/llvm/prebuilt/linux-x86_64"
194           export PATH="$PATH:$ANDROID_TOOLCHAIN/bin"
195           ./android-build.sh ./rust-lightning ./ldk-c-bindings/ ./ldk-java-bins/android-artifacts
196       - name: Check latest library and jars are in bins repo
197         run: |
198           export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(cat .git_ver)"
199           rm "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/LDK-release.aar"
200           cp LDK-release.aar "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"
201           cd ldk-java-bins
202           if ! git diff --exit-code; then
203             mv "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/LDK-release.aar" ./
204             git checkout "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/LDK-release.aar"
205             apt-get -y install diffoscope
206             diffoscope LDK-release.aar "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/LDK-release.aar"
207             exit 1
208           fi
209
210   osx:
211     strategy:
212       matrix:
213         include:
214           - platform: macos-10.15
215           - platform: macos-11
216       fail-fast: false
217     runs-on: ${{ matrix.platform }}
218     env:
219       TOOLCHAIN: stable
220     steps:
221       - name: Install other Rust platforms
222         run: rustup target install aarch64-apple-darwin
223       - name: Fetch upstream LLVM/clang snapshot
224         run: |
225           wget -O clang+llvm-12.0.0-x86_64-apple-darwin.tar.xz https://github.com/llvm/llvm-project/releases/download/llvmorg-12.0.0/clang+llvm-12.0.0-x86_64-apple-darwin.tar.xz
226           if [ "$(shasum -a 256 clang+llvm-12.0.0-x86_64-apple-darwin.tar.xz | awk '{ print $1 }')" != "7bc2259bf75c003f644882460fc8e844ddb23b27236fe43a2787870a4cd8ab50" ]; then
227             echo "Bad hash"
228             exit 1
229           fi
230       - name: Unpack upstream LLVM+clang and use it by default
231         run: |
232           tar xvvf clang+llvm-12.0.0-x86_64-apple-darwin.tar.xz
233       - name: Checkout source code
234         uses: actions/checkout@v2
235         with:
236           fetch-depth: 0
237       - name: Install cbindgen
238         run: cargo install --force cbindgen
239       - name: Checkout Rust-Lightning and LDK-C-Bindings git
240         run: |
241           git config --global user.email "ldk-ci@example.com"
242           git config --global user.name "LDK CI"
243           # Note this is a different endpoint, as we need one non-upstream commit!
244           git clone https://git.bitcoin.ninja/rust-lightning
245           cd rust-lightning
246           git checkout origin/2021-03-java-bindings-base
247           cd ..
248           git clone https://github.com/lightningdevkit/ldk-c-bindings
249           cd ldk-c-bindings
250           git checkout 0.0.100
251       - name: Rebuild C bindings with upstream clang, and check the sample app builds + links
252         run: |
253           cd ldk-c-bindings
254           export PATH=`pwd`/clang+llvm-12.0.0-x86_64-apple-darwin/bin:$PATH
255           CC=clang ./genbindings.sh ../rust-lightning true
256           cd ..
257       - name: Fetch OpenJDK 16
258         run: |
259           wget -O openjdk-16.0.1_osx-x64_bin.tar.gz https://download.java.net/java/GA/jdk16.0.1/7147401fd7354114ac51ef3e1328291f/9/GPL/openjdk-16.0.1_osx-x64_bin.tar.gz
260           if [ "$(shasum -a 256 openjdk-16.0.1_osx-x64_bin.tar.gz | awk '{ print $1 }')" != "6098f839954439d4916444757c542c1b8778a32461706812d41cc8bbefce7f2f" ]; then
261             echo "Bad hash"
262             exit 1
263           fi
264           tar xvvf openjdk-16.0.1_osx-x64_bin.tar.gz
265           export JAVA_HOME=`pwd`/jdk-16.0.1.jdk/Contents/Home
266           export PATH=$JAVA_HOME/bin:$PATH
267       - name: Detect current git version
268         run: |
269           # We assume the top commit is just a bindings update commit, so we
270           # check out the previous commit to use as the commit we git describe.
271           # If the top commit is a merge commit, we need to get the last merge
272           # head and assume the latest bindings are built against its parent.
273           COMMIT_PARENTS=$(git show -s --pretty=format:%P HEAD)
274           if [ "${#COMMIT_PARENTS}" = 40 ]; then
275             export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(git describe --tag HEAD^1)"
276           else
277             MERGE_HEAD=$(git show --pretty=format:%P HEAD | ( for last in $(cat /dev/stdin); do true; done; echo $last ))
278             export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(git describe --tag $MERGE_HEAD^1)"
279           fi
280           echo "Using $LDK_GARBAGECOLLECTED_GIT_OVERRIDE as git version"
281           echo "$LDK_GARBAGECOLLECTED_GIT_OVERRIDE" > .git_ver
282       - name: Checkout latest Linux binaries
283         run: |
284           export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(cat .git_ver)"
285           git clone --depth 1 https://git.bitcoin.ninja/ldk-java-bins
286           mkdir -p src/main/resources/
287           cp "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/liblightningjni_Linux-"* src/main/resources/
288       - name: Build Java/TS Release Bindings
289         run: |
290           export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(cat .git_ver)"
291           # genbindings.sh always fails as there is no wasm32-wasi library
292           # available, so instead we check that the expected JNI library
293           # is created.
294           export PATH=`pwd`/clang+llvm-12.0.0-x86_64-apple-darwin/bin:$PATH
295           ./genbindings.sh ./ldk-c-bindings/ "-I$JAVA_HOME/include/ -I$JAVA_HOME/include/darwin -isysroot$(xcrun --show-sdk-path)" false false || echo
296           cat src/main/resources/liblightningjni_MacOSX-x86_64.nativelib > /dev/null
297           if [ "${{ matrix.platform }}" = "macos-11" ]; then
298             export CC="clang --target=aarch64-apple-darwin"
299             export LDK_TARGET=aarch64-apple-darwin
300             export LDK_TARGET_CPU=apple-a14
301             ./genbindings.sh ./ldk-c-bindings/ "-I$JAVA_HOME/include/ -I$JAVA_HOME/include/darwin -isysroot$(xcrun --show-sdk-path)" false false || echo
302             cat src/main/resources/liblightningjni_MacOSX-aarch64.nativelib > /dev/null
303           fi
304       - name: Fetch Maven 3.8.1
305         run: |
306           wget -O apache-maven-3.8.1-bin.tar.gz https://apache.osuosl.org/maven/maven-3/3.8.1/binaries/apache-maven-3.8.1-bin.tar.gz
307           if [ "$(shasum -a 256 apache-maven-3.8.1-bin.tar.gz | awk '{ print $1 }')" != "b98a1905eb554d07427b2e5509ff09bd53e2f1dd7a0afa38384968b113abef02" ]; then
308             echo "Bad hash"
309             exit 1
310           fi
311           tar xvvf apache-maven-3.8.1-bin.tar.gz
312           export PATH=apache-maven-3.8.1/bin:$PATH
313       - name: Run Java Tests against built jar
314         run: |
315           mvn -DskipTests=true package
316           export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(cat .git_ver)"
317           JAR_VERSION=${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}
318           mvn install:install-file -Dfile=target/ldk-java-${JAR_VERSION}.jar -DgroupId=org.lightningdevkit -DartifactId=ldk-java -Dversion=1.0-SNAPSHOT -Dpackaging=jar
319           cd javatester
320           mvn package
321           java -ea -jar target/ldk-java-tests-1.0-SNAPSHOT-jar-with-dependencies.jar
322           cd ..
323       - name: Check latest release libs are in git
324         run: |
325           if [ "${{ matrix.platform }}" = "macos-11" ]; then
326             export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(cat .git_ver)"
327             rm "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"liblightningjni_MacOSX-{x86_64,aarch64}.nativelib
328             cp src/main/resources/liblightningjni_MacOSX-*.nativelib "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"
329             cd ldk-java-bins
330             # Sadly, OSX binaries are not currently deterministic, more debugging is needed.
331             #git diff --exit-code
332           fi
333       - name: Run Java Tests against release bins
334         run: |
335           if [ "${{ matrix.platform }}" != "macos-11" ]; then
336             export LDK_GARBAGECOLLECTED_GIT_OVERRIDE="$(cat .git_ver)"
337             cp "ldk-java-bins/${LDK_GARBAGECOLLECTED_GIT_OVERRIDE}/"liblightningjni_MacOSX-{x86_64,aarch64}.nativelib src/main/resources/
338             mvn clean
339             mvn -DskipTests=true package
340             JAR_VERSION=${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}
341             mvn install:install-file -Dfile=target/ldk-java-${JAR_VERSION}.jar -DgroupId=org.lightningdevkit -DartifactId=ldk-java -Dversion=1.0-SNAPSHOT -Dpackaging=jar
342             cd javatester
343             mvn package
344             java -ea -jar target/ldk-java-tests-1.0-SNAPSHOT-jar-with-dependencies.jar
345             cd ..
346           fi