Merge pull request #116 from holochain/fix/integration-wasmer-wamr

Improve CI for wasmer_wamr feature

.github/workflows/test.yml

@@ -6,15 +6,31 @@ on:
       - develop
   pull_request: {}
 
+concurrency: 
+  group: test-${{ github.workflow }}-${{ github.ref || github.run_id }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
 jobs:
-  test:
+  test-and-bench:
     strategy:
       fail-fast: false
       matrix:
-        script: ["./test.sh", "./bench.sh"]
+        script: ["test", "bench"]
         os: ["ubuntu-latest", "macos-latest"]
+        wasmer-feature: ["wasmer_sys", "wasmer_wamr"]
+        exclude:
+          # TODO bench suite on macos-latest is killed by system due to running out of swap space
+          # All benches run fine individually
+          - script: bench
+            os: macos-latest
+            wasmer-feature: wasmer_wamr
     runs-on: ${{ matrix.os }}
     steps:
+      - name: increase swap space
+        if: matrix.os == 'ubuntu-latest'
+        uses: actionhippie/swap-space@v1
+        with:
+          size: 15G
       - uses: actions/checkout@v4
       - name: Install nix
         uses: cachix/install-nix-action@v26
@@ -24,4 +40,24 @@ jobs:
         with:
           name: holochain-ci
           authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
-      - run: nix develop --command ${{ matrix.script }}
+      - run: nix develop --command ./scripts/${{ matrix.script }}-${{ matrix.wasmer-feature }}.sh
+
+  test-windows:
+    strategy:
+      fail-fast: false
+      matrix:
+        wasmer-feature: 
+          - "wasmer_sys" 
+          # TODO Building with wasmer_wamr feature flag on windows is not currently working.
+          # See https://github.com/holochain/holochain-wasmer/issues/117
+          # - "wasmer_wamr"
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: wasm32-unknown-unknown
+      - name: test root
+        run: cargo test --release --no-default-features --features error_as_host,${{ matrix.wasmer-feature }} -- --nocapture
+      - name: test
+        run: cargo test --release --manifest-path test/Cargo.toml --no-default-features --features ${{ matrix.wasmer-feature }} -- --nocapture

README.md

@@ -103,7 +103,7 @@ very reasonable overhead for the host to build a completely fresh instance.
 Calling a function with `holochain_wasmer_host::guest::call()` takes several `us`
 for small input/output values and some `ms` for ~1mb of input/output data.
 
-To see benchmarks on your system run `nix-shell --run ./bench.sh`.
+To see benchmarks on your system run `nix-shell --run ./scripts/bench.sh`.
 
 With low overhead like this, core is relatively free to decide when it wants to
 re-instantiate an already-in-memory module.

bench.sh → scripts/bench-wasmer_sys.sh

@@ -1,7 +1,7 @@
 #! /usr/bin/env bash
 (
  cd test && \
- cargo bench
+ cargo bench --no-default-features --features wasmer_sys
 )
 
 # it's possible to flamegraph the benchmarks like this:

scripts/bench-wasmer_wamr.sh

@@ -0,0 +1,10 @@
+#! /usr/bin/env bash
+(
+ cd test && \
+ cargo bench --no-default-features --features wasmer_wamr
+)
+
+# it's possible to flamegraph the benchmarks like this:
+#
+# cd test
+# flamegraph cargo bench --bench bench -- --profile-time 10

scripts/bench.sh

@@ -0,0 +1,4 @@
+#! /usr/bin/env bash
+
+./bench-wasmer_sys.sh && \
+./bench-wasmer_wamr.sh

fuzz.sh → scripts/fuzz-wasmer_sys.sh

@@ -2,4 +2,4 @@
 cargo test
 cargo test --manifest-path test/Cargo.toml
 
-cargo test-fuzz "$FUZZ_TARGET"
+cargo test-fuzz "$FUZZ_TARGET" --no-default-features --features wasmer_sys

scripts/fuzz-wasmer_wamr.sh

@@ -0,0 +1,5 @@
+#! /usr/bin/env bash
+cargo test
+cargo test --manifest-path test/Cargo.toml
+
+cargo test-fuzz "$FUZZ_TARGET" --no-default-features --features wasmer_wamr

scripts/fuzz.sh

@@ -0,0 +1,4 @@
+#! /usr/bin/env bash
+
+./fuzz-wasmer_sys.sh && \
+./fuzz-wasmer_wamr.sh

test.sh → scripts/test-wasmer_sys.sh

@@ -3,24 +3,21 @@ set -euxo pipefail
 
 export RUST_BACKTRACE=full
 export WASMER_BACKTRACE=1
+
+# static tests
 cargo fmt
-( cd test && cargo fmt )
-( cd crates/guest && cargo fmt )
+( cd test && cargo fmt --check )
+( cd crates/guest && cargo fmt --check )
 
 cargo clippy
 ( cd test && cargo clippy )
 ( cd crates/guest && cargo clippy --target wasm32-unknown-unknown )
-cargo clippy --no-default-features --features wasmer_wamr
-( cd test && cargo clippy --no-default-features --features wasmer_wamr )
 
 # tests the root workspace that doesn't include any wasm code
-cargo test ${1-} -- --nocapture
+cargo test --no-default-features --features error_as_host,wasmer_sys ${1-} -- --nocapture
 
 # test that everything builds
 cargo build --release --manifest-path test/test_wasm/Cargo.toml --target wasm32-unknown-unknown
 
 # build wasm and run the "full" tests for wasmer_sys
-cargo test --release --manifest-path test/Cargo.toml ${1-} -- --nocapture 
-
-# build wasm and run the "full" tests for wasmer_wamr
-cargo test --release --manifest-path test/Cargo.toml --no-default-features --features wasmer_wamr ${1-} -- --nocapture
+cargo test --release --manifest-path test/Cargo.toml --no-default-features --features wasmer_sys ${1-} -- --nocapture 

scripts/test-wasmer_wamr.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+set -euxo pipefail
+
+export RUST_BACKTRACE=full
+export WASMER_BACKTRACE=1
+
+
+# tests the root workspace that doesn't include any wasm code
+cargo test --no-default-features --features error_as_host,wasmer_wamr ${1-} -- --nocapture
+
+# build wasm and run the "full" tests for wasmer_wamr
+cargo test --release --manifest-path test/Cargo.toml --no-default-features --features wasmer_wamr ${1-} -- --nocapture

scripts/test.sh

@@ -0,0 +1,4 @@
+#! /usr/bin/env bash
+
+./test-wasmer_sys.sh && \
+./test-wasmer_wamr.sh

test/Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 
 [dependencies]
 holochain_wasmer_common = { path = "../crates/common" }
-holochain_wasmer_host = { path = "../crates/host", default-features = false }
+holochain_wasmer_host = { path = "../crates/host", default-features = false, features = ["error_as_host"] }
 holochain_serialized_bytes = "=0.0.55"
 serde = "1"
 test_common = { path = "./common", default-features = false }

test/benches/bench.rs

@@ -1,3 +1,7 @@
+// Temporarily include a fork of wasmer from the git branch 'wamr', until it is officially released in wasmer v5
+#[cfg(feature = "wasmer_wamr")]
+extern crate hc_wasmer as wasmer;
+
 use criterion::BenchmarkId;
 use criterion::Throughput;
 use criterion::{criterion_group, criterion_main, Criterion};

test/src/test.rs

@@ -1,6 +1,7 @@
 pub mod import;
 pub mod wasms;
 
+// Temporarily include a fork of wasmer from the git branch 'wamr', until it is officially released in wasmer v5
 #[cfg(feature = "wasmer_wamr")]
 extern crate hc_wasmer as wasmer;