[ci] Add Rust CI and coverage build

Author: tobe2098

.github/workflows/linux.yml

@@ -122,6 +122,16 @@ jobs:
         git -c protocol.version=2 fetch --no-tags --prune --progress --no-recurse-submodules origin main
         echo "cache-key=$( git merge-base origin/main ${{ github.sha }} )" >> $GITHUB_OUTPUT
 
+    - name: Set up Rust
+      uses: dtolnay/rust-toolchain@stable
+
+    - name: Rust Cache
+      uses: swatinem/rust-cache@v2
+      with:
+        # This ensures that if you have a workspace,
+        # all crates are indexed in the cache.
+        workspaces: "$GITHUB_WORKSPACE/rxx"
+
     - name: CCache
       uses: actions/cache@v5
       with:
@@ -138,6 +148,9 @@ jobs:
         mkdir --parents ${MULTIPASS_PART}
         /snap/bin/lxc profile device add default build disk source=${MULTIPASS_PART} path=/root/parts/multipass
         echo "build=${MULTIPASS_PART}/build" >> $GITHUB_OUTPUT
+        if ! command -v cargo-tarpaulin &> /dev/null; then
+          cargo install cargo-tarpaulin
+        fi
 
     - name: Configure
       run: |
@@ -182,10 +195,11 @@ jobs:
         /snap/bin/lxc --project snapcraft exec $instance_name -- bash -c 'mkdir -p /coredump'
         # Enable coredumps by setting the core dump size to "unlimited", and run the tests.
         /snap/bin/lxc --project snapcraft exec $instance_name -- bash -c "\
+           cd /root/parts/multipass/build && \
            ulimit -c unlimited &&        \
            env CTEST_OUTPUT_ON_FAILURE=1 \
-           LD_LIBRARY_PATH=/root/stage/usr/lib/x86_64-linux-gnu/:/root/stage/lib/:/root/parts/multipass/build/lib/ \
-           /root/parts/multipass/build/bin/multipass_tests"
+            LD_LIBRARY_PATH=/root/stage/usr/lib/x86_64-linux-gnu/:/root/stage/lib/:/root/parts/multipass/build/lib/ \
+            ctest"
 
     - name: Measure coverage
       id: measure-coverage
@@ -249,6 +263,10 @@ jobs:
         # Pull the coredump folder
         /snap/bin/lxc --project snapcraft file pull -p -r "$instance_name/coredump" /tmp/coredump
         echo "Pulled the coredumps folder."
+        mapfile -t BINS < <(cargo test --workspace --no-run --message-format=json | jq -r 'select(.reason == "compiler-artifact" and .executable != null) | .executable')
+        export TEST_BINARIES="${BINS[*]}"
+        for bin $TEST_BINARIES; do /snap/bin/lxc --project snapcraft file pull -p -r "$instance_name/$bin" /tmp/coredump/$bin
+        echo "Pulled the rust executables"
         set +o xtrace
 
     - name: Upload test coredump

.github/workflows/windows-macos.yml

@@ -123,6 +123,9 @@ jobs:
         mkdir -p ~/.pip
         echo -e "[install]\nbreak-system-packages = true" > ~/.pip/pip.conf
 
+    - name: Set up Rust
+      uses: dtolnay/rust-toolchain@stable
+
     - name: Install dependencies from brew
       if: ${{ runner.os == 'macOS' }}
       run: |
@@ -278,7 +281,7 @@ jobs:
     - name: Test
       working-directory: ${{ env.BUILD_DIR }}
       run: |
-        bin/multipass_tests
+        ctest
 
     - name: Package
       id: cmake-package

CMakeLists.txt

@@ -394,7 +394,7 @@ if(cmake_build_type_lower MATCHES "coverage")
     endif()
 
     add_custom_target(covreport
-      DEPENDS multipass_tests
+      DEPENDS multipass_tests rust_coverage_tarpaulin
       WORKING_DIRECTORY ${CMAKE_BUILD_DIR}
       COMMAND ${LCOV} --directory . --zerocounters
       COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR} --target test
@@ -407,7 +407,9 @@ if(cmake_build_type_lower MATCHES "coverage")
         ${CMAKE_BINARY_DIR}'/*'
         --output-file coverage.cleaned
       COMMAND ${CMAKE_COMMAND} -E remove coverage.info
-      COMMAND ${GENHTML} -o coverage coverage.cleaned
+      COMMAND ${CMAKE_COMMAND} -E remove coverage.info
+      COMMAND ${LCOV} -a coverage.cleaned -a lcov.info -o total_coverage.info
+      COMMAND ${GENHTML} -o coverage total_coverage.info
     )
   endif()
 endif()

rxx/CMakeLists.txt

@@ -67,6 +67,7 @@ foreach(crate_name ${CRATES})
     set(bridge_source "${CMAKE_CURRENT_SOURCE_DIR}/target/cxxbridge/${crate_name}/src")
     set(bridge_cc "${bridge_source}/lib.rs.cc")
 
+    set(ACTIVE_FEATURES "default")
     #Library creation to compile the CXX glue source
     add_library(${crate_name} STATIC ${bridge_cc})
     #Here we can place the crate-wise dependencies
@@ -78,17 +79,33 @@ foreach(crate_name ${CRATES})
 
     add_custom_command(
       OUTPUT ${bridge_cc} ${rust_out}
-      COMMAND ${CARGO_EXECUTABLE} build -p ${crate_name} ${rust_build_flag} --lib
+      COMMAND ${CARGO_EXECUTABLE} build -p ${crate_name} ${rust_build_flag} --lib --features "${ACTIVE_FEATURES}"
       WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
       COMMENT "Building Rust crates and generating C++ glue..."
     )
 
-    add_test(
-          NAME      ${crate_name}_tests
-          COMMAND   cargo test -p ${crate_name} --manifest-path ${CMAKE_CURRENT_SOURCE_DIR}/Cargo.toml
-    --no-fail-fast
-    )
   endif()
 endforeach()
 
+add_test(
+      NAME      multipass_rust_tests
+      COMMAND   cargo test --manifest-path ${CMAKE_CURRENT_SOURCE_DIR}/Cargo.toml
+--no-fail-fast --workspace --all-features
+)
 set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${CMAKE_CURRENT_SOURCE_DIR}/target")
+
+if(cmake_build_type_lower MATCHES "coverage")
+  find_program(CARGO_TARPAULIN cargo-tarpaulin)
+
+  if(CARGO_TARPAULIN)
+    add_custom_target(rust_coverage_tarpaulin
+      WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+      COMMAND ${CARGO_TARPAULIN}
+        --out Lcov
+        --output-dir ${CMAKE_BUILD_DIR}
+        --exclude-files '../*'
+      COMMAND
+      COMMENT "Running Rust coverage with Tarpaulin"
+    )
+  endif()
+endif()

rxx/petname/Cargo.toml

@@ -23,6 +23,9 @@ rust-version.workspace = true
 [lib]
 crate-type = ["staticlib"]
 
+[features]
+default = []
+
 [dependencies]
 cxx.workspace = true
 macros.workspace = true