ci: windows support (#185)

Co-authored-by: Cijo Thomas <[email protected]>

Author: psandana

.github/workflows/ci.yml

@@ -8,14 +8,29 @@ on:
     - main
     paths-ignore:
     - '**.md'
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 jobs:
   test:
     strategy:
       matrix:
+        # test both stable and beta versions of Rust on ubuntu-latest
+        os: [ubuntu-latest]
         rust: [stable, beta]
-    runs-on: ubuntu-latest
+        # test only stable version of Rust on Windows and MacOS
+        include:
+          - rust: stable
+            os: windows-latest
+          - rust: stable
+            os: macos-latest
+          - rust: stable
+            os: ubuntu-22.04-arm
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.rust == 'beta' }}
     steps:
     - name: Free disk space
+      if: ${{ matrix.os == 'ubuntu-latest'}}
       run: |
         df -h
         sudo rm -rf /usr/local/lib/android
@@ -31,34 +46,51 @@ jobs:
         profile: minimal
     - uses: arduino/setup-protoc@v3
       with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-    - name: Test
-      run: ./scripts/test.sh
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+    - name: Test (Windows)
+      if: ${{ matrix.os == 'windows-latest'}}
+      run: ./scripts/test.ps1
+      shell: pwsh
+    - name: Test (Unix)
+      if: ${{ matrix.os != 'windows-latest'}}
+      run: bash ./scripts/test.sh
   lint:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # clippy must be run in every OS to lint platform-specific code 
+        os: [ubuntu-latest, windows-latest, macos-latest, ubuntu-22.04-arm]
+    runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
       with:
         submodules: true
     - uses: actions-rs/toolchain@v1
       with:
         toolchain: stable
-        components: rustfmt
-        profile: minimal
+        components: rustfmt, clippy
     - uses: arduino/setup-protoc@v3
       with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
     - uses: actions-rs/cargo@v1
       with:
         command: fmt
         args: --all -- --check
-    - name: Lint
+    - name: Lint (Windows)
+      if: ${{ matrix.os == 'windows-latest'}}
+      run: ./scripts/lint.ps1
+      shell: pwsh
+    - name: Lint (Unix)
+      if: ${{ matrix.os != 'windows-latest'}}
       run: ./scripts/lint.sh
   msrv:
     strategy:
       matrix:
         rust: ["1.75.0"]
-    runs-on: ubuntu-latest
+        os: [
+          ubuntu-latest,
+          # windows-latest # Disabled due bug in `cargo-msrv` on Windows( https://github.com/foresterre/cargo-msrv/issues/1102 )
+        ]
+    runs-on: ${{ matrix.os }}
     continue-on-error: true
     steps:
       - uses: actions/checkout@v4
@@ -72,10 +104,15 @@ jobs:
       - uses: taiki-e/install-action@v2
         with:
           tool: cargo-msrv
-      - name: Patch dependencies versions
+      - name: Patch dependencies versions (Unix)
+        if: ${{ matrix.os != 'windows-latest'}}
         run: bash ./scripts/patch_dependencies.sh
-      - name: Check MSRV for all crates
+      - name: Check MSRV for all crates (Unix)
+        if: ${{ matrix.os != 'windows-latest'}}
         run: bash ./scripts/msrv.sh ${{ matrix.rust }}
+      - name: Check MSRV for all crates (Windows)
+        if: ${{ matrix.os == 'windows-latest'}}
+        run: ./scripts/msrv.ps1 ${{ matrix.rust }}
   cargo-deny:
     runs-on: ubuntu-latest
     continue-on-error: true # Prevent sudden announcement of a new advisory from failing ci

opentelemetry-datadog/Cargo.toml

@@ -51,10 +51,12 @@ criterion = "0.5"
 rand = "0.9"
 hyper = "1"
 hyper-util = { version = "0.1.6", features = ["client", "full"] }
-hyperlocal = "0.9.1"
 http-body-util = "0.1.2"
 temp-env = "0.3"
 
+[target.'cfg(unix)'.dev-dependencies]
+hyperlocal = "0.9.1"
+
 [[bench]]
 name = "datadog_exporter"
 harness = false

scripts/lint.ps1

@@ -0,0 +1,23 @@
+$ErrorActionPreference = "Stop"
+$PSNativeCommandUseErrorActionPreference = $True
+
+function cargo_feature {
+    param (
+        $crate,
+        $features
+    )
+    Write-Host "checking '$crate' with features '$features'"
+    cargo clippy --manifest-path=$crate/Cargo.toml --all-targets --features "$features" --no-default-features -- -Dwarnings
+    if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
+}
+
+# Exit with a nonzero code if there are clippy warnings
+cargo clippy --workspace --all-targets --all-features -- -Dwarnings
+if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
+
+cargo_feature opentelemetry-etw-logs "default"
+cargo_feature opentelemetry-etw-logs "logs_level_enabled"
+
+cargo_feature opentelemetry-etw-metrics ""
+
+exit $LASTEXITCODE

scripts/lint.sh

@@ -9,35 +9,33 @@ cargo_feature() {
     -Dwarnings
 }
 
-if rustup component add clippy; then
-  # Exit with a nonzero code if there are clippy warnings
-  cargo clippy --workspace --all-targets --all-features -- -Dwarnings
+# Exit with a nonzero code if there are clippy warnings
+cargo clippy --workspace --all-targets --all-features -- -Dwarnings
 
-  cargo_feature opentelemetry-aws "default"
+cargo_feature opentelemetry-aws "default"
 
-  cargo_feature opentelemetry-datadog "reqwest-blocking-client,intern-std"
-  cargo_feature opentelemetry-datadog "reqwest-client,intern-std"
+cargo_feature opentelemetry-datadog "reqwest-blocking-client,intern-std"
+cargo_feature opentelemetry-datadog "reqwest-client,intern-std"
 # TODO: Clippy doesn't seem to like surf client.
 #  cargo_feature opentelemetry-datadog "surf-client,intern-std"
 
-  cargo_feature opentelemetry-contrib "default"
-  cargo_feature opentelemetry-contrib "api"
-  cargo_feature opentelemetry-contrib "base64_format"
-  cargo_feature opentelemetry-contrib "binary_propagator"
-  cargo_feature opentelemetry-contrib "jaeger_json_exporter"
-  cargo_feature opentelemetry-contrib "rt-tokio"
-  cargo_feature opentelemetry-contrib "rt-tokio-current-thread"
-  cargo_feature opentelemetry-contrib "rt-async-std"
+cargo_feature opentelemetry-contrib "default"
+cargo_feature opentelemetry-contrib "api"
+cargo_feature opentelemetry-contrib "base64_format"
+cargo_feature opentelemetry-contrib "binary_propagator"
+cargo_feature opentelemetry-contrib "jaeger_json_exporter"
+cargo_feature opentelemetry-contrib "rt-tokio"
+cargo_feature opentelemetry-contrib "rt-tokio-current-thread"
+cargo_feature opentelemetry-contrib "rt-async-std"
 
-  cargo_feature opentelemetry-stackdriver "default"
-  cargo_feature opentelemetry-stackdriver "gcp-authorizer"
-  cargo_feature opentelemetry-stackdriver "tls-native-roots"
-  cargo_feature opentelemetry-stackdriver "tls-webpki-roots"
+cargo_feature opentelemetry-stackdriver "default"
+cargo_feature opentelemetry-stackdriver "gcp-authorizer"
+cargo_feature opentelemetry-stackdriver "tls-native-roots"
+cargo_feature opentelemetry-stackdriver "tls-webpki-roots"
 
-  cargo_feature opentelemetry-user-events-logs "default"
-  cargo_feature opentelemetry-user-events-logs "spec_unstable_logs_enabled"
+cargo_feature opentelemetry-user-events-logs "default"
+cargo_feature opentelemetry-user-events-logs "spec_unstable_logs_enabled"
 
-  cargo_feature opentelemetry-user-events-metrics ""
+cargo_feature opentelemetry-user-events-metrics ""
 
-  cargo_feature opentelemetry-resource-detectors ""
-fi
+cargo_feature opentelemetry-resource-detectors ""

scripts/msrv.ps1

@@ -0,0 +1,59 @@
+[CmdletBinding()]
+param(
+    [Parameter(Mandatory = $true)]
+    $version
+)
+
+$ErrorActionPreference = "Stop"
+$PSNativeCommandUseErrorActionPreference = $True
+
+# function to check if specified toolchain is installed
+function check_rust_toolchain_installed {
+    param (
+        $version
+    )
+
+    if (!(rustup toolchain list | Select-String -Pattern $version -Quiet)) {
+        Write-Host "Rust toolchain $version is not installed. Please install it using 'rustup toolchain install $version'."
+        exit 1
+    }
+}
+
+$RUST_VERSION = $version
+
+# Determine the directory containing the script
+$SCRIPT_DIR = $PSScriptRoot
+
+# Path to the configuration file
+$CONFIG_FILE="$SCRIPT_DIR/msrv_config.json"
+
+if (-not (Test-Path $CONFIG_FILE)) {
+    Write-Host "Configuration file $CONFIG_FILE not found."
+    exit 1
+}
+
+# check if specified toolchain is installed
+check_rust_toolchain_installed "$RUST_VERSION"
+if ($LASTEXITCODE -ne 0) {
+    exit $LASTEXITCODE
+}
+
+# Extract the exact installed rust version string
+$installed_version = $(rustup toolchain list | Select-String -pattern 1.75.0).ToString().Split(" ")[0]
+
+# Read the configuration file and get the packages for the specified version
+$packages = $(Get-Content "$CONFIG_FILE" | ConvertFrom-Json )."$RUST_VERSION"
+if (-not $packages) {
+    Write-Host "No packages found for Rust version $RUST_VERSION in the configuration file."
+    exit 1
+}
+
+# Check MSRV for the packages
+foreach ($package in $packages) {
+    Write-Host "Verifying MSRV version $installed_version for $package"
+    rustup run $installed_version cargo msrv verify --path $package --output-format json
+    if ($LASTEXITCODE -ne 0) {
+        exit $LASTEXITCODE
+    }
+    Write-Host "" # just for nicer separation between packages
+}

scripts/test.ps1

@@ -0,0 +1,10 @@
+$ErrorActionPreference = "Stop"
+$PSNativeCommandUseErrorActionPreference = $True
+
+cargo test --manifest-path=opentelemetry-etw-logs/Cargo.toml --all-features
+if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
+
+cargo test --manifest-path=opentelemetry-etw-metrics/Cargo.toml --all-features
+if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
+
+exit $LASTEXITCODE