feat: adding wasm coverage

.github/workflows/coverage-examples.yml

@@ -0,0 +1,67 @@
+name: Coverage examples
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+env:
+  RUSTFLAGS: "-D warnings"
+
+jobs:
+  coverage:
+    runs-on: ${{ matrix.platform }}
+    name: "${{ matrix.example }} - ${{ matrix.platform }}"
+    strategy:
+      matrix:
+        platform: [macos-latest]
+        toolchain: [nightly-2024-05-01-aarch64-apple-darwin]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Homebrew
+        run: |
+          /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+      - name: Install LLVM
+        run: brew install llvm
+      - name: Add LLVM to PATH
+        run: echo "/opt/homebrew/opt/llvm/bin" >> $GITHUB_PATH
+      - name: Llvm version
+        run: llvm-config --version
+      - name: Clang version
+        run: clang --version
+      - name: "${{ matrix.toolchain }} with rustfmt, and wasm32"
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: ${{ matrix.toolchain }}
+          target: wasm32-unknown-unknown
+      - name: Set Default Toolchain
+        run: rustup override set ${{ matrix.toolchain }}
+      - name: Rust version
+        run: rustc --version --verbose
+      - name: Verify Rust Toolchain
+        run: rustup show
+      - name: Add rust-src component
+        run: rustup component add rust-src --toolchain ${{ matrix.toolchain }}
+      - name: Install wasmcov
+        run: cargo +${{ matrix.toolchain }} install wasmcov
+      - name: Create wasmcov directory
+        run: mkdir -p ${{ github.workspace }}/wasmcov
+      - name: Set WASMCOV_DIR environment variable
+        run: echo "WASMCOV_DIR=${{ github.workspace }}/wasmcov" >> $GITHUB_ENV
+      - name: Set up cache for near_sandbox directory
+        uses: actions/cache@v3
+        with:
+          path: ${{ github.workspace }}/wasmcov/near_sandbox
+          key: ${{ runner.os }}-near-sandbox-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-near-sandbox-${{ github.sha }}
+      - name: time version
+        run: cargo tree | grep time
+      - name: Build examples
+        env:
+          RUSTFLAGS: '-C link-arg=-s'
+        run: cd ./examples && ./build_wasm_test_all.sh
+      - name: Merge profdata files
+        env:
+          RUSTFLAGS: '-C link-arg=-s'
+        run: cd ./examples && ./merge_profdata.sh

examples/adder/Cargo.toml

@@ -9,6 +9,7 @@ crate-type = ["cdylib"]
 
 [dependencies]
 near-sdk = { path = "../../near-sdk" }
+wasmcov = { version = "0.2", optional = true }
 
 [dev-dependencies]
 near-workspaces = "0.11.1"
@@ -18,6 +19,9 @@ near-abi = "0.4.0"
 zstd = "0.13"
 near-sdk = { path = "../../near-sdk", features = ["unit-testing"] }
 
+[features]
+wasmcov = ["dep:wasmcov"]
+
 [profile.release]
 codegen-units = 1
 # Tell `rustc` to optimize for small code size.

examples/adder/build.sh

@@ -1,8 +1,15 @@
 #!/bin/bash
-TARGET="${CARGO_TARGET_DIR:-../../target}"
+
+if [ -n "$WASMCOV_DIR" ]; then
+    TARGET="${WASMCOV_DIR}/target"
+    BUILD_COMMAND="cargo wasmcov build -- --features wasmcov"
+else
+    TARGET="${CARGO_TARGET_DIR:-../../target}"
+    BUILD_COMMAND="cargo build"
+fi
+
 set -e
 cd "$(dirname $0)"
-
-cargo build --target wasm32-unknown-unknown --release
+$BUILD_COMMAND --target wasm32-unknown-unknown --release
 cp $TARGET/wasm32-unknown-unknown/release/adder.wasm ./res/
-#wasm-opt -Oz --output ./res/status_message.wasm ./res/status_message.wasm
+#wasm-opt -Oz --output ./res/status_message.wasm ./res/status_message.wasm

examples/adder/src/lib.rs

@@ -1,5 +1,8 @@
 use near_sdk::near;
 
+#[cfg(all(feature = "wasmcov", target_family = "wasm"))]
+wasmcov::near::add_coverage!();
+
 #[near(serializers=[borsh, json])]
 pub struct Pair(u32, u32);
 
@@ -88,4 +91,4 @@ mod tests {
 
         Ok(())
     }
-}
+}

examples/build_wasm_test_all.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+for d in "status-message"  $(ls -d */ | grep -v -e "status-message\/$"); do
+    if [ -d "$d" ]; then
+      echo "Processing directory $d"
+      echo "Building"
+      cd $d;
+      pwd
+      ./build.sh
+      echo "Testing"
+      cargo wasmcov test --near=1.40.0
+      cd ..
+      echo "End of processing of directory $d"
+    fi
+done
+
+
+
+

examples/callback-results/Cargo.toml

@@ -9,13 +9,17 @@ crate-type = ["cdylib"]
 
 [dependencies]
 near-sdk = { path = "../../near-sdk" }
+wasmcov = { version = "0.2", optional = true }
 
 [dev-dependencies]
 near-workspaces = "0.11.1"
 tokio = { version = "1.14", features = ["full"] }
 anyhow = "1.0"
 near-sdk = { path = "../../near-sdk", features = ["unit-testing"] }
 
+[features]
+wasmcov = ["dep:wasmcov"]
+
 [profile.release]
 codegen-units = 1
 # Tell `rustc` to optimize for small code size.

examples/callback-results/build.sh

@@ -1,6 +1,14 @@
 #!/bin/bash
-TARGET="${CARGO_TARGET_DIR:-../../target}"
+
+if [ -n "$WASMCOV_DIR" ]; then
+    TARGET="${WASMCOV_DIR}/target"
+    BUILD_COMMAND="cargo wasmcov build -- --features wasmcov"
+else
+    TARGET="${CARGO_TARGET_DIR:-../../target}"
+    BUILD_COMMAND="cargo build"
+fi
+
 set -e
 cd "$(dirname $0)"
-cargo build --target wasm32-unknown-unknown --release
-cp $TARGET/wasm32-unknown-unknown/release/callback_results.wasm ./res/
+$BUILD_COMMAND --target wasm32-unknown-unknown --release
+cp $TARGET/wasm32-unknown-unknown/release/callback_results.wasm ./res/

examples/callback-results/src/lib.rs

@@ -1,6 +1,9 @@
 use near_sdk::require;
 use near_sdk::{env, near, Promise, PromiseError};
 
+#[cfg(all(feature = "wasmcov", target_family = "wasm"))]
+wasmcov::near::add_coverage!();
+
 const A_VALUE: u8 = 8;
 
 #[near(contract_state)]
@@ -122,4 +125,4 @@ mod tests {
 
         Ok(())
     }
-}
+}

examples/cross-contract-calls/Cargo.toml

@@ -4,6 +4,9 @@ version = "0.1.0"
 authors = ["Near Inc <[email protected]>"]
 edition = "2021"
 
+[dependencies]
+wasmcov = { version = "0.2", optional = true }
+
 [dev-dependencies]
 anyhow = "1.0"
 near-sdk = { path = "../../near-sdk", features = ["default", "unit-testing"] }
@@ -22,5 +25,8 @@ lto = true
 debug = false
 panic = "abort"
 
+[features]
+wasmcov = ["dep:wasmcov"]
+
 [workspace]
 members = ["high-level", "low-level"]

examples/cross-contract-calls/build.sh

@@ -1,8 +1,15 @@
 #!/bin/bash
-TARGET="${CARGO_TARGET_DIR:-../../target}"
+
+if [ -n "$WASMCOV_DIR" ]; then
+    TARGET="${WASMCOV_DIR}/target"
+    BUILD_COMMAND="cargo wasmcov build -- --features wasmcov"
+else
+    TARGET="${CARGO_TARGET_DIR:-../../target}"
+    BUILD_COMMAND="cargo build"
+fi
+
 set -e
 cd "$(dirname $0)"
-
-cargo build --all --target wasm32-unknown-unknown --release
+$BUILD_COMMAND --all --target wasm32-unknown-unknown --release
 cp $TARGET/wasm32-unknown-unknown/release/cross_contract_high_level.wasm ./res/
-cp $TARGET/wasm32-unknown-unknown/release/cross_contract_low_level.wasm ./res/
+cp $TARGET/wasm32-unknown-unknown/release/cross_contract_low_level.wasm ./res/

examples/cross-contract-calls/high-level/Cargo.toml

@@ -9,3 +9,7 @@ crate-type = ["cdylib"]
 
 [dependencies]
 near-sdk = { path = "../../../near-sdk" , features = ["default", "unit-testing"] }
+wasmcov = { version = "0.2", optional = true }
+
+[features]
+wasmcov = ["dep:wasmcov"]

examples/cross-contract-calls/high-level/src/lib.rs

@@ -1,6 +1,9 @@
 use near_sdk::env;
 use near_sdk::{log, near, PromiseOrValue};
 
+#[cfg(all(feature = "wasmcov", target_family = "wasm"))]
+wasmcov::near::add_coverage!();
+
 #[derive(Default)]
 #[near(contract_state)]
 pub struct CrossContract {}

examples/cross-contract-calls/low-level/Cargo.toml

@@ -9,3 +9,7 @@ crate-type = ["cdylib"]
 
 [dependencies]
 near-sdk = { path = "../../../near-sdk" , features = ["default", "unit-testing"] }
+wasmcov = { version = "0.2", optional = true }
+
+[features]
+wasmcov = ["dep:wasmcov"]

examples/cross-contract-calls/low-level/src/lib.rs

@@ -1,6 +1,9 @@
 use near_sdk::serde_json;
 use near_sdk::{env, near, require, Gas, NearToken, PromiseResult};
 
+#[cfg(all(feature = "wasmcov", target_family = "wasm"))]
+wasmcov::near::add_coverage!();
+
 // Prepaid gas for a single (not inclusive of recursion) `factorial` call.
 const FACTORIAL_CALL_GAS: Gas = Gas::from_tgas(20);
 

examples/factory-contract/Cargo.toml

@@ -4,13 +4,19 @@ version = "0.1.0"
 authors = ["Near Inc <[email protected]>"]
 edition = "2021"
 
+[dependencies]
+wasmcov = { version = "0.2", optional = true }
+
 [dev-dependencies]
 anyhow = "1.0"
 test-case = "2.0"
 tokio = { version = "1.14", features = ["full"] }
 near-workspaces = "0.11.1"
 near-sdk = { path = "../../near-sdk", features = ["unit-testing"] }
 
+[features]
+wasmcov = ["dep:wasmcov"]
+
 [profile.release]
 codegen-units = 1
 # Tell `rustc` to optimize for small code size.

examples/factory-contract/build.sh

@@ -1,8 +1,16 @@
 #!/bin/bash
-TARGET="${CARGO_TARGET_DIR:-../../target}"
+
+if [ -n "$WASMCOV_DIR" ]; then
+    TARGET="${WASMCOV_DIR}/target"
+    BUILD_COMMAND="cargo wasmcov build -- --features wasmcov"
+else
+    TARGET="${CARGO_TARGET_DIR:-../../target}"
+    BUILD_COMMAND="cargo build"
+fi
+
 set -e
 cd "$(dirname $0)"
 
-cargo build --all --target wasm32-unknown-unknown --release
+$BUILD_COMMAND --all --target wasm32-unknown-unknown --release
 cp $TARGET/wasm32-unknown-unknown/release/factory_contract_high_level.wasm ./res/
-cp $TARGET/wasm32-unknown-unknown/release/factory_contract_low_level.wasm ./res/
+cp $TARGET/wasm32-unknown-unknown/release/factory_contract_low_level.wasm ./res/

examples/factory-contract/high-level/Cargo.toml

@@ -9,6 +9,10 @@ crate-type = ["cdylib"]
 
 [dependencies]
 near-sdk = { path = "../../../near-sdk" }
+wasmcov = { version = "0.2", optional = true }
 
 [dev-dependencies]
 near-sdk = { path = "../../../near-sdk", features = ["unit-testing"] }
+
+[features]
+wasmcov = ["dep:wasmcov"]

examples/factory-contract/high-level/src/lib.rs

@@ -1,6 +1,9 @@
 use near_sdk::PromiseError;
 use near_sdk::{env, ext_contract, near, AccountId, NearToken, Promise};
 
+#[cfg(all(feature = "wasmcov", target_family = "wasm"))]
+wasmcov::near::add_coverage!();
+
 #[derive(Default)]
 #[near(contract_state)]
 pub struct FactoryContract {}

examples/factory-contract/low-level/Cargo.toml

@@ -9,6 +9,10 @@ crate-type = ["cdylib"]
 
 [dependencies]
 near-sdk = { path = "../../../near-sdk" }
+wasmcov = { version = "0.2", optional = true }
 
 [dev-dependencies]
 near-sdk = { path = "../../../near-sdk", features = ["unit-testing"] }
+
+[features]
+wasmcov = ["dep:wasmcov"]

examples/factory-contract/low-level/src/lib.rs

@@ -2,6 +2,9 @@ use near_sdk::json_types::U128;
 use near_sdk::serde_json;
 use near_sdk::{env, near, AccountId, Gas, NearToken, PromiseResult};
 
+#[cfg(all(feature = "wasmcov", target_family = "wasm"))]
+wasmcov::near::add_coverage!();
+
 // Prepaid gas for making a single simple call.
 const SINGLE_CALL_GAS: Gas = Gas::from_tgas(20);
 

examples/fungible-token/Cargo.toml

@@ -4,12 +4,18 @@ version = "0.0.2"
 authors = ["Near Inc <[email protected]>"]
 edition = "2021"
 
+[dependencies]
+wasmcov = { version = "0.2", optional = true }
+
 [dev-dependencies]
 anyhow = "1.0"
 near-sdk = { path = "../../near-sdk", features = ["unit-testing"] }
 tokio = { version = "1.14", features = ["full"] }
 near-workspaces = "0.11.1"
 
+[features]
+wasmcov = ["dep:wasmcov"]
+
 [profile.release]
 codegen-units = 1
 # Tell `rustc` to optimize for small code size.

examples/fungible-token/build.sh

@@ -1,8 +1,16 @@
 #!/bin/bash
-TARGET="${CARGO_TARGET_DIR:-../../target}"
+
+if [ -n "$WASMCOV_DIR" ]; then
+    TARGET="${WASMCOV_DIR}/target"
+    BUILD_COMMAND="cargo wasmcov build -- --features wasmcov"
+else
+    TARGET="${CARGO_TARGET_DIR:-../../target}"
+    BUILD_COMMAND="cargo build"
+fi
+
 set -e
 cd "$(dirname $0)"
 
-cargo build --all --target wasm32-unknown-unknown --release
+$BUILD_COMMAND --all --target wasm32-unknown-unknown --release
 cp $TARGET/wasm32-unknown-unknown/release/defi.wasm ./res/
-cp $TARGET/wasm32-unknown-unknown/release/fungible_token.wasm ./res/
+cp $TARGET/wasm32-unknown-unknown/release/fungible_token.wasm ./res/