Provide MUSL-based build (#447)

Fixes #408

Author: cretz

.github/workflows/package.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, ubuntu-arm, macos-intel, macos-arm, windows-latest]
+        os: [ubuntu-latest, ubuntu-arm, alpine-latest, macos-intel, macos-arm, windows-latest]
         include:
           - os: ubuntu-latest
             out-file: libtemporal_sdk_bridge.so
@@ -25,6 +25,13 @@ jobs:
             # We use the Python manylinux image for glibc compatibility
             container: quay.io/pypa/manylinux2014_aarch64
             protobuf-url: https://github.com/protocolbuffers/protobuf/releases/download/v22.3/protoc-22.3-linux-aarch_64.zip
+          - os: alpine-latest
+            out-file: libtemporal_sdk_bridge.so
+            out-prefix: linux-musl-x64
+            # Need Alpine container since GH runner doesn't have one
+            container: mcr.microsoft.com/dotnet/sdk:8.0-alpine
+            protobuf-url: https://github.com/protocolbuffers/protobuf/releases/download/v22.3/protoc-22.3-linux-x86_64.zip
+            runsOn: ubuntu-latest
           - os: macos-intel
             out-file: libtemporal_sdk_bridge.dylib
             out-prefix: osx-x64
@@ -68,8 +75,8 @@ jobs:
         if: ${{ !matrix.container }}
         run: cargo build --manifest-path src/Temporalio/Bridge/Cargo.toml --release
 
-      - name: Build (Docker)
-        if: ${{ matrix.container }}
+      - name: Build (Docker non-Alpine)
+        if: ${{ matrix.container && matrix.os != 'alpine-latest' }}
         run: |
           docker run --rm -v "$(pwd):/workspace" -w /workspace \
             ${{ matrix.container }} \
@@ -82,11 +89,27 @@ jobs:
              && cargo build --manifest-path src/Temporalio/Bridge/Cargo.toml --release \
             '
 
+      - name: Build (Docker Alpine)
+        if: ${{ matrix.container && matrix.os == 'alpine-latest' }}
+        run: |
+          docker run --rm -v "$(pwd):/workspace" -w /workspace \
+            ${{ matrix.container }} \
+            sh -c ' \
+                curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain stable -y \
+             && . $HOME/.cargo/env \
+             && apk add --no-cache build-base \
+             && curl -LO ${{ matrix.protobuf-url }} \
+             && unzip protoc-*.zip -d /usr/local/protobuf \
+             && export PATH="$PATH:/usr/local/protobuf/bin" \
+             && RUSTFLAGS="-C target-feature=-crt-static" cargo build --manifest-path src/Temporalio/Bridge/Cargo.toml --release \
+            '
+
       - name: Upload bridge library
         uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.out-prefix }}-bridge
           path: src/Temporalio/Bridge/target/release/${{ matrix.out-file }}
+          if-no-files-found: error
 
   build-nuget-package:
     needs:
@@ -129,15 +152,19 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, ubuntu-arm, macos-intel, macos-arm, windows-latest]
+        os: [ubuntu-latest, ubuntu-arm, alpine-latest, macos-intel, macos-arm, windows-latest]
         include:
           - os: ubuntu-arm
             runsOn: buildjet-4vcpu-ubuntu-2204-arm
+          - os: alpine-latest
+            container: mcr.microsoft.com/dotnet/sdk:6.0-alpine
+            runsOn: ubuntu-latest
           - os: macos-intel
             runsOn: macos-13
           - os: macos-arm
             runsOn: macos-14
     runs-on: ${{ matrix.runsOn || matrix.os }}
+    container: ${{ matrix.container }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -148,18 +175,30 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: nuget-package
-          path: nuget-package
+          path: ${{ github.workspace }}/nuget-package
 
-      - name: Setup .NET
+      - name: Setup .NET (non-Alpine)
         uses: actions/setup-dotnet@v4
+        if: ${{ matrix.os != 'alpine-latest' }}
         with:
           # Specific .NET version required because GitHub macos ARM image has
           # bad pre-installed .NET version
           dotnet-version: 6.x
 
-      - name: Run smoke test
+      - name: Setup .NET (Alpine)
+        if: ${{ matrix.os == 'alpine-latest' }}
+        run: apk add dotnet6-sdk
+
+      - name: Run smoke test (non-Windows)
+        if: ${{ matrix.os != 'windows-latest' }}
+        run: |
+          dotnet add tests/Temporalio.SmokeTest package Temporalio -s "$GITHUB_WORKSPACE/nuget-package/Temporalio/bin/Release;https://api.nuget.org/v3/index.json" --prerelease
+          dotnet run --project tests/Temporalio.SmokeTest
+
+      - name: Run smoke test (Windows)
+        if: ${{ matrix.os == 'windows-latest' }}
         run: |
-          dotnet add tests/Temporalio.SmokeTest package Temporalio -s "${{ github.workspace }}/nuget-package/Temporalio/bin/Release;https://api.nuget.org/v3/index.json" --prerelease
+          dotnet add tests/Temporalio.SmokeTest package Temporalio -s "$env:GITHUB_WORKSPACE/nuget-package/Temporalio/bin/Release;https://api.nuget.org/v3/index.json" --prerelease
           dotnet run --project tests/Temporalio.SmokeTest
 
       - name: Setup msbuild (Windows only)
@@ -169,6 +208,6 @@ jobs:
       - name: Run .NET framework smoke test (Windows only)
         if: ${{ matrix.os == 'windows-latest' }}
         run: |
-          dotnet add tests/Temporalio.SmokeTestDotNetFramework package Temporalio -s "${{ github.workspace }}/nuget-package/Temporalio/bin/Release;https://api.nuget.org/v3/index.json" --prerelease
+          dotnet add tests/Temporalio.SmokeTestDotNetFramework package Temporalio -s "$env:GITHUB_WORKSPACE/nuget-package/Temporalio/bin/Release;https://api.nuget.org/v3/index.json" --prerelease
           msbuild tests/Temporalio.SmokeTestDotNetFramework -t:restore,build -p:Platform=x64
           tests/Temporalio.SmokeTestDotNetFramework/bin/x64/Debug/Temporalio.SmokeTestDotNetFramework.exe

README.md

@@ -815,6 +815,8 @@ reimplementation of the Temporal server with special time skipping capabilities.
 to run when first called. Note, this class is not thread safe nor safe for use with independent tests. It can be reused,
 but only for one test at a time because time skipping is locked/unlocked at the environment level.
 
+⚠️ WARNING - at this time, the time-skipping test server does not work on musl-based environments like Alpine.
+
 ##### Automatic Time Skipping
 
 Anytime a workflow result is waiting on, the time-skipping server automatically advances to the next event it can. To
@@ -1130,8 +1132,8 @@ included when using modern versions of .NET on a common platform. If you are usi
 explicitly set the platform to `x64` or `arm64` because `AnyCPU` will not choose the proper library.
 
 Currently we only support [RIDs](https://learn.microsoft.com/en-us/dotnet/core/rid-catalog) `linux-arm64`,
-`linux-x64`, `osx-arm64`, `osx-x64`, and `win-x64`. Any other platforms needed (e.g. `linux-musl-x64` on Alpine) will
-require a custom build.
+`linux-x64`, `linux-musl-x64`, `osx-arm64`, `osx-x64`, and `win-x64`. Any other platforms needed (e.g. `linux-musl-x64`
+on Alpine) will require a custom build.
 
 The native shared library on Windows does require a Visual C++ runtime. Some containers, such as Windows Nano Server, do
 not include this runtime. If not available, users may have to manually copy this runtime (usually just

src/Temporalio/Bridge/Cargo.toml

@@ -5,7 +5,7 @@ edition = "2021"
 
 [lib]
 name = "temporal_sdk_bridge"
-crate-type = ["cdylib", "rlib"]
+crate-type = ["cdylib"]
 
 [dependencies]
 anyhow = "1.0"

src/Temporalio/Temporalio.csproj

@@ -90,6 +90,9 @@
       <Content Include="$(BridgeLibraryRoot)/linux-arm64-bridge/libtemporal_sdk_bridge.so">
         <PackagePath>runtimes/linux-arm64/native/libtemporal_sdk_bridge.so</PackagePath>
       </Content>
+      <Content Include="$(BridgeLibraryRoot)/linux-musl-x64-bridge/libtemporal_sdk_bridge.so">
+        <PackagePath>runtimes/linux-musl-x64/native/libtemporal_sdk_bridge.so</PackagePath>
+      </Content>
       <Content Include="$(BridgeLibraryRoot)/osx-x64-bridge/libtemporal_sdk_bridge.dylib">
         <PackagePath>runtimes/osx-x64/native/libtemporal_sdk_bridge.dylib</PackagePath>
       </Content>

src/Temporalio/Testing/WorkflowEnvironment.cs

@@ -85,6 +85,20 @@ public static async Task<WorkflowEnvironment> StartTimeSkippingAsync(
             WorkflowEnvironmentStartTimeSkippingOptions? options = null)
         {
             options ??= new();
+
+            // If they did not provide a binary to use, eagerly fail on musl since musl
+            // time-skipping is not supported at this time. We can only do this check in .NET 5+,
+            // otherwise we assume it is not musl for now since this is just a temporary situation.
+            // TODO(cretz): Remove when musl-support for time-skipping test server is present.
+#if NET5_0_OR_GREATER
+            if (options.TestServer.ExistingPath == null &&
+                System.Runtime.InteropServices.RuntimeInformation.Contains("-musl", StringComparison.OrdinalIgnoreCase))
+            {
+                throw new InvalidOperationException(
+                    "Time-skipping test server not currently supported in musl-based environments");
+            }
+#endif
+
             var runtime = options.Runtime ?? TemporalRuntime.Default;
             var server = await Bridge.EphemeralServer.StartTestServerAsync(
                 runtime.Runtime,