[rust] init multipass cargo workspace & oxidize petname

.github/workflows/dynamic-ci.yml

@@ -60,6 +60,9 @@ jobs:
               - "CMakeLists.txt"
               - "vcpkg-configuration.json"
               - "vcpkg.json"
+              - "Cargo.toml"
+              - "Cargo.lock"
+              - "crates/**"
             hooks:
               - "git-hooks/**"
 

.github/workflows/lint.yml

@@ -77,3 +77,21 @@ jobs:
             echo "Run '3rd-party/flutter/bin/dart format' to fix formatting."
             exit 1
           fi
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+
+      - name: Run Rust format check
+        shell: bash
+        run: |
+          if [ -f "Cargo.toml" ]; then
+            if ! cargo fmt --all --check; then
+              echo -n "##[error] Rust code is not properly formatted. "
+              echo "Run 'cargo fmt --all' to fix formatting."
+              exit 1
+            fi
+          else
+            echo "No Cargo.toml found, skipping Rust format check"
+          fi

.github/workflows/linux.yml

@@ -198,12 +198,13 @@ jobs:
         /snap/bin/lxc --project snapcraft exec $instance_name -- bash -c 'cat /proc/sys/kernel/core_pattern'
         # Create the directory for the coredumps
         /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.
+        # Enable coredumps by setting the core dump size to "unlimited", and run the unified test target.
         /snap/bin/lxc --project snapcraft exec $instance_name -- bash -c "\
-           ulimit -c unlimited &&        \
+           source /root/.cargo/env && \
+           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"
+           ctest --test-dir /root/parts/multipass/build --output-on-failure"
 
     - name: Measure coverage
       id: measure-coverage
@@ -231,18 +232,38 @@ jobs:
         /snap/bin/lxc --project snapcraft exec $instance_name -- \
            sh -c "sudo sed -i \"s/use JSON::PP/use JSON::XS/\" \`which geninfo\`"
 
+        # Install cargo-llvm-cov for Rust coverage
+        /snap/bin/lxc --project snapcraft exec $instance_name -- bash -c "\
+          source /root/.cargo/env && \
+          cargo install cargo-llvm-cov"
+
         # Create the directory for the coredumps
         /snap/bin/lxc --project snapcraft exec $instance_name -- bash -c 'mkdir -p /coredump'
+
+        # Generate C++ coverage
         /snap/bin/lxc --project snapcraft exec $instance_name -- bash -c "\
           ulimit -c unlimited && \
           env CTEST_OUTPUT_ON_FAILURE=1 \
             cmake --build /root/parts/multipass/build --target covreport"
 
+        # Generate Rust coverage in lcov format
+        /snap/bin/lxc --project snapcraft exec $instance_name -- bash -c "\
+          source /root/.cargo/env && \
+          cargo llvm-cov --manifest-path /root/parts/multipass/src/Cargo.toml \
+            --lcov --output-path /root/parts/multipass/build/rust-coverage.lcov"
+
+        # Merge C++ and Rust coverage reports
+        /snap/bin/lxc --project snapcraft exec $instance_name -- bash -c "\
+          lcov -a /root/parts/multipass/build/coverage.cleaned \
+               -a /root/parts/multipass/build/rust-coverage.lcov \
+               -o /root/parts/multipass/build/combined-coverage.info"
+
     - name: Upload coverage
       if: ${{ matrix.build-type == 'Coverage' }}
       uses: codecov/codecov-action@v5
       with:
         directory: ${{ steps.coverage-setup.outputs.build }}
+        files: ./combined-coverage.info
       env:
         CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 

.github/workflows/windows-macos.yml

@@ -137,7 +137,8 @@ jobs:
           pixman \
           pkg-config \
           python \
-          wget
+          wget \
+          rustup-init
 
     - name: Install dependencies from pip
       if: ${{ runner.os == 'macOS' }}
@@ -154,7 +155,7 @@ jobs:
       if: ${{ runner.os == 'Windows' }}
       uses: crazy-max/ghaction-chocolatey@v3
       with:
-        args: install --yes wget unzip
+        args: install --yes wget unzip rustup.install
 
     - name: Set up vcpkg
       id: setup-vcpkg
@@ -255,6 +256,31 @@ jobs:
       if: ${{ runner.os == 'Windows' }}
       uses: ilammy/msvc-dev-cmd@v1
 
+    - name: Initialize Rust toolchain
+      shell: bash
+      run: |
+        if [[ "${{ runner.os }}" == "Windows" ]]; then
+          # On Windows, rustup.install from chocolatey should be available
+          if command -v rustup >/dev/null 2>&1; then
+            rustup default stable
+            rustup update
+          else
+            echo "Error: rustup not found. Please ensure it is installed and in the PATH."
+            exit 1
+          fi
+        elif [[ "${{ runner.os }}" == "macOS" ]]; then
+          # On macOS, initialize rustup-init
+          if command -v rustup-init >/dev/null 2>&1; then
+            rustup-init -y --default-toolchain stable
+            source ~/.cargo/env
+          else
+            echo "Error: rustup-init not found. Please ensure it is installed and in the PATH."
+            exit 1
+          fi
+        fi
+        # Add cargo bin to PATH for subsequent steps
+        echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+
     - name: Configure
       run: >
         ${{ env.ARCH_WRAPPER }}
@@ -276,9 +302,8 @@ jobs:
       run: ccache --show-stats --zero-stats
 
     - name: Test
-      working-directory: ${{ env.BUILD_DIR }}
-      run: |
-        ${{ env.ARCH_WRAPPER }} bin/multipass_tests
+      run: |\
+        ${{ env.ARCH_WRAPPER }} ctest --test-dir ${{ env.BUILD_DIR }} --output-on-failure
 
     - name: Package
       id: cmake-package

.gitignore

@@ -24,3 +24,8 @@ packaging/windows/custom-actions/x64/*
 
 # Python artifacts
 *.pyc
+
+
+# Added by cargo
+
+/target

BUILD.linux.md

@@ -10,6 +10,10 @@ sudo apt install devscripts equivs
 mk-build-deps -s sudo -i
 ```
 
+### Rust toolchain
+
+Multipass requires Rust for building. Install the Rust toolchain from: https://rustup.rs/
+
 ## Building
 
 First, go into the repository root and get all the submodules:

BUILD.macOS.md

@@ -42,6 +42,10 @@ means to obtain these dependencies is with Homebrew <https://brew.sh/>.
 
     brew install cmake openssl@3
 
+### Rust toolchain
+
+Multipass requires Rust for building. Install the Rust toolchain from: https://rustup.rs/
+
 Building
 ---------------------------------------
 

BUILD.windows.md

@@ -19,7 +19,7 @@ choco install cmake ninja qemu openssl git wget unzip -yfd
 ```
 
 ```[pwsh]
-choco install visualstudio2022buildtools visualstudio2022-workload-vctools -yfd
+choco install visualstudio2022buildtools visualstudio2022-workload-vctools rustup.install -yfd
 ```
 
 NOTE: visualcpp-build-tools is only the installer package. For this reason, choco cannot detect any
@@ -43,6 +43,10 @@ For Windows 11:
 1. Go to "Developer Settings"
 2. Enable "Developer mode"
 
+### Rust toolchain
+
+Multipass requires Rust for building. You can install it via Chocolatey (included in the command above) or from: https://rustup.rs/
+
 ### Qt6
 
 To install Qt6, use `aqt`. First install it with chocolatey:

CMakeLists.txt

@@ -180,6 +180,29 @@ find_package(gRPC CONFIG REQUIRED)
 find_package(fmt CONFIG REQUIRED)
 # targets: fmt::fmt, fmt::fmt-header-only
 
+# Corrosion for Rust + CMake integration
+include(FetchContent)
+
+FetchContent_Declare(
+    Corrosion
+    GIT_REPOSITORY https://github.com/corrosion-rs/corrosion.git
+    GIT_TAG v0.5 # Use stable version
+)
+FetchContent_MakeAvailable(Corrosion)
+
+# Register Rust build directories for cleaning
+set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_CLEAN_FILES
+    "${CMAKE_BINARY_DIR}/cargo"
+    "${CMAKE_BINARY_DIR}/corrosion"
+)
+
+# Add custom target to also run cargo clean when needed
+add_custom_target(clean-rust
+    COMMAND cargo clean --manifest-path ${CMAKE_SOURCE_DIR}/Cargo.toml
+    COMMENT "Cleaning Cargo workspace artifacts"
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+)
+
 # Needs to be here before we set further compilation options
 add_subdirectory(3rd-party)
 
@@ -391,6 +414,20 @@ add_subdirectory(src)
 if(MULTIPASS_ENABLE_TESTS)
   enable_testing()
   add_subdirectory(tests)
+
+  # Add convenience targets for running tests
+  add_custom_target(test-all
+    COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR} --target all_tests
+    COMMENT "Running all tests (C++ and Rust) via convenience target"
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+  )
+
+  # Add alias for compatibility
+  add_custom_target(check
+    COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR} --target all_tests
+    COMMENT "Running all tests (alias for test-all)"
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+  )
 endif()
 
 include(packaging/cpack.cmake OPTIONAL)