(local) Add C# SDK (Pulumi.Esc.Sdk) (#118)

Author: tehsis

.github/workflows/stage-publish-sdk.yml

@@ -126,3 +126,37 @@ jobs:
           "${{ github.workspace }}/sdk/python/bin/dist/*"
           --skip-existing
           --verbose
+
+  publish-csharp-sdk:
+    runs-on: ubuntu-latest
+    name: publish-csharp-sdk
+    steps:
+      - name: Fetch secrets from ESC
+        id: esc-secrets
+        uses: pulumi/esc-action@v1
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '6.0.x'
+      - id: version
+        name: Set SDK Version
+        uses: pulumi/provider-version-action@v1
+      - name: Generate SDKs
+        uses: ./.github/actions/generate_sdk
+        env:
+          VERSION: ${{ inputs.version }}
+          PULUMI_VERSION: ${{ inputs.version }}
+      - name: Build C# SDK
+        run: make build_csharp
+      - name: Pack NuGet
+        run: |
+          cd sdk/csharp/Pulumi.Esc.Sdk
+          dotnet pack -c Release -o nupkg /p:Version=${{ steps.version.outputs.version }}
+      - name: Publish NuGet
+        run: |
+          dotnet nuget push sdk/csharp/Pulumi.Esc.Sdk/nupkg/*.nupkg \
+            --api-key "${NUGET_PUBLISH_KEY}" \
+            --source https://api.nuget.org/v3/index.json \
+            --skip-duplicate

.github/workflows/stage-test.yml

@@ -97,3 +97,21 @@ jobs:
           if [ -f test-requirements.txt ]; then pip install -r test-requirements.txt; fi
       - name: Test with pytest
         run: make test_python
+  test_csharp:
+    name: Test C#
+    runs-on: ubuntu-latest
+    needs: test_python
+    steps:
+      - name: Fetch secrets from ESC
+        id: esc-secrets
+        uses: pulumi/esc-action@v1
+      - name: Checkout Repo
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ inputs.commit-ref }}
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '6.0.x'
+      - name: Test
+        run: make test_csharp

.gitignore

@@ -39,3 +39,7 @@ sdk/typescript/node_modules/*
 sdk/typescript/bin/*
 sdk/python/bin/*
 sdk/python/go.mod
+
+# C# / .NET
+sdk/csharp/**/bin/
+sdk/csharp/**/obj/

CHANGELOG_PENDING.md

@@ -1,5 +1,8 @@
 ### Improvements
 
+- Add C# SDK with generated client, hand-written wrappers (EscClient, EscAuth, ValueMapper,
+  EnvironmentDefinitionSerializer), and xUnit tests
+
 - Support proxy environment variables in Python SDK
   [#108](https://github.com/pulumi/esc-sdk/pull/108)
 

CONTRIBUTING.md

@@ -17,14 +17,17 @@ To build the autogenerated API clients, run:
 make generate_sdks
 ```
 
-Additionally, ESC SDK provides wrapper clients for TypeScript/JavaScript, Python, and Go. To build these packages, run:
+Additionally, ESC SDK provides wrapper clients for TypeScript/JavaScript, Python, Go, and C#. To build these packages, run:
 
 ```shell
 make build_typescript
 make build_python
 make build_go
+make build_csharp
 ```
 
+The C# SDK requires the .NET 6.0 SDK or later.
+
 ### Running tests
 
 First, make sure to set the following environment variables:
@@ -43,6 +46,8 @@ Now you can run the tests for the different sdks:
 make test_typescript
 make test_python
 make test_go
+make test_csharp                # Unit tests only
+make test_csharp_integration    # E2E tests (requires env vars above)
 ```
 
 ## Submitting a Pull Request

Makefile

@@ -74,5 +74,32 @@ generate_ts_client_sdk:
 generate_python_client_sdk:
 	PYTHON_POST_PROCESS_FILE="/usr/local/bin/yapf -i" openapi-generator-cli generate -i ./sdk/swagger.yaml -p packageName=pulumi_esc_sdk,httpUserAgent=esc-sdk/python/${VERSION},packageVersion=${PYTHON_SDK_VERSION} -t ./sdk/templates/python -g python -o ./sdk/python --git-repo-id esc --git-user-id pulumi
 
+.PHONY: generate_csharp_client_sdk
+generate_csharp_client_sdk:
+	openapi-generator-cli generate \
+		-i ./sdk/swagger.yaml \
+		-g csharp \
+		--library generichost \
+		--additional-properties packageName=Pulumi.Esc.Sdk \
+		--additional-properties targetFramework=net6.0 \
+		--additional-properties nullableReferenceTypes=true \
+		--additional-properties validatable=true \
+		--additional-properties hideGenerationTimestamp=false \
+		--additional-properties sourceFolder=. \
+		--additional-properties httpUserAgent=esc-sdk/csharp/${VERSION} \
+		-t ./sdk/templates/csharp \
+		-o ./sdk/csharp \
+		--git-repo-id esc \
+		--git-user-id pulumi
+
+build_csharp::
+	cd sdk/csharp/Pulumi.Esc.Sdk && dotnet build
+
+test_csharp::
+	cd sdk/csharp && dotnet test --filter "Category!=Integration"
+
+test_csharp_integration::
+	cd sdk/csharp && dotnet test --filter "Category=Integration"
+
 .phony: generate_sdks
-generate_sdks:: generate_go_client_sdk generate_ts_client_sdk generate_python_client_sdk
+generate_sdks:: generate_go_client_sdk generate_ts_client_sdk generate_python_client_sdk generate_csharp_client_sdk

README.md

@@ -45,8 +45,34 @@ go get github.com/pulumi/esc-sdk/sdk
 
 [Go examples](https://www.pulumi.com/docs/esc/development/languages-sdks/go/)
 
+### C#/.NET
+
+```shell
+dotnet add package Pulumi.Esc.Sdk
+```
+
+#### Quick Example
+
+```csharp
+using Pulumi.Esc.Sdk;
+
+// Create a client using default credentials (PULUMI_ACCESS_TOKEN or CLI login)
+using var client = EscClient.CreateDefault();
+
+// Or provide credentials explicitly
+// using var client = EscClient.Create("pul-abc123");
+
+// Open and read an environment
+var (env, values) = await client.OpenAndReadEnvironmentAsync("myorg", "myproject", "dev");
+Console.WriteLine(values["dbConnectionString"]);
+
+// Get the environment definition as parsed YAML
+var definition = await client.GetEnvironmentAsync("myorg", "myproject", "dev");
+```
+
 ## API Reference Documentation
 
 * [TypeScript/JavaScript](https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/esc-sdk/)
 * [Python](https://www.pulumi.com/docs/reference/pkg/python/pulumi_esc_sdk/)
 * [Go](https://pkg.go.dev/github.com/pulumi/esc-sdk/sdk/go)
+* C# — API docs coming soon

sdk/csharp/.gitignore

@@ -0,0 +1,5 @@
+.vs/
+bin/
+obj/
+*.user
+

sdk/csharp/.openapi-generator-ignore

@@ -0,0 +1,46 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
+
+git_push.sh
+.travis.yml
+.gitignore
+README.md
+Pulumi.Esc.Sdk/README.md
+test/*
+docs/**
+api/*
+appveyor.yml
+# Solution file has corrected project paths
+Pulumi.Esc.Sdk.sln
+Pulumi.Esc.Sdk.Test/**
+# Value.cs has a fix for varValue not being truly required (API returns Value without "value" when unknown=true)
+Pulumi.Esc.Sdk/Model/Value.cs
+
+# Hand-written extension files — DO NOT overwrite
+Pulumi.Esc.Sdk/EscClient.cs
+Pulumi.Esc.Sdk/EscAuth.cs
+Pulumi.Esc.Sdk/EscClientFactory.cs
+Pulumi.Esc.Sdk/ValueMapper.cs
+Pulumi.Esc.Sdk/EnvironmentDefinitionSerializer.cs
+Pulumi.Esc.Sdk/JsonDefaults.cs

sdk/csharp/.openapi-generator/FILES

@@ -0,0 +1,59 @@
+Pulumi.Esc.Sdk/Api/EscApi.cs
+Pulumi.Esc.Sdk/Api/IApi.cs
+Pulumi.Esc.Sdk/Client/ApiException.cs
+Pulumi.Esc.Sdk/Client/ApiFactory.cs
+Pulumi.Esc.Sdk/Client/ApiKeyToken.cs
+Pulumi.Esc.Sdk/Client/ApiResponseEventArgs.cs
+Pulumi.Esc.Sdk/Client/ApiResponse`1.cs
+Pulumi.Esc.Sdk/Client/ClientUtils.cs
+Pulumi.Esc.Sdk/Client/CookieContainer.cs
+Pulumi.Esc.Sdk/Client/DateOnlyJsonConverter.cs
+Pulumi.Esc.Sdk/Client/DateOnlyNullableJsonConverter.cs
+Pulumi.Esc.Sdk/Client/DateTimeJsonConverter.cs
+Pulumi.Esc.Sdk/Client/DateTimeNullableJsonConverter.cs
+Pulumi.Esc.Sdk/Client/ExceptionEventArgs.cs
+Pulumi.Esc.Sdk/Client/HostConfiguration.cs
+Pulumi.Esc.Sdk/Client/JsonSerializerOptionsProvider.cs
+Pulumi.Esc.Sdk/Client/Option.cs
+Pulumi.Esc.Sdk/Client/RateLimitProvider`1.cs
+Pulumi.Esc.Sdk/Client/TokenBase.cs
+Pulumi.Esc.Sdk/Client/TokenContainer`1.cs
+Pulumi.Esc.Sdk/Client/TokenProvider`1.cs
+Pulumi.Esc.Sdk/Extensions/IHostBuilderExtensions.cs
+Pulumi.Esc.Sdk/Extensions/IHttpClientBuilderExtensions.cs
+Pulumi.Esc.Sdk/Extensions/IServiceCollectionExtensions.cs
+Pulumi.Esc.Sdk/Model/Access.cs
+Pulumi.Esc.Sdk/Model/Accessor.cs
+Pulumi.Esc.Sdk/Model/CheckEnvironment.cs
+Pulumi.Esc.Sdk/Model/CloneEnvironment.cs
+Pulumi.Esc.Sdk/Model/CreateEnvironment.cs
+Pulumi.Esc.Sdk/Model/CreateEnvironmentRevisionTag.cs
+Pulumi.Esc.Sdk/Model/CreateEnvironmentTag.cs
+Pulumi.Esc.Sdk/Model/EnvironmentDefinition.cs
+Pulumi.Esc.Sdk/Model/EnvironmentDefinitionValues.cs
+Pulumi.Esc.Sdk/Model/EnvironmentDiagnostic.cs
+Pulumi.Esc.Sdk/Model/EnvironmentDiagnostics.cs
+Pulumi.Esc.Sdk/Model/EnvironmentRevision.cs
+Pulumi.Esc.Sdk/Model/EnvironmentRevisionTag.cs
+Pulumi.Esc.Sdk/Model/EnvironmentRevisionTags.cs
+Pulumi.Esc.Sdk/Model/EnvironmentTag.cs
+Pulumi.Esc.Sdk/Model/Error.cs
+Pulumi.Esc.Sdk/Model/EvaluatedExecutionContext.cs
+Pulumi.Esc.Sdk/Model/Expr.cs
+Pulumi.Esc.Sdk/Model/ExprBuiltin.cs
+Pulumi.Esc.Sdk/Model/Interpolation.cs
+Pulumi.Esc.Sdk/Model/ListEnvironmentTags.cs
+Pulumi.Esc.Sdk/Model/ModelEnvironment.cs
+Pulumi.Esc.Sdk/Model/OpenEnvironment.cs
+Pulumi.Esc.Sdk/Model/OrgEnvironment.cs
+Pulumi.Esc.Sdk/Model/OrgEnvironments.cs
+Pulumi.Esc.Sdk/Model/Pos.cs
+Pulumi.Esc.Sdk/Model/PropertyAccessor.cs
+Pulumi.Esc.Sdk/Model/Range.cs
+Pulumi.Esc.Sdk/Model/Reference.cs
+Pulumi.Esc.Sdk/Model/Trace.cs
+Pulumi.Esc.Sdk/Model/UpdateEnvironmentRevisionTag.cs
+Pulumi.Esc.Sdk/Model/UpdateEnvironmentTag.cs
+Pulumi.Esc.Sdk/Model/UpdateEnvironmentTagCurrentTag.cs
+Pulumi.Esc.Sdk/Model/UpdateEnvironmentTagNewTag.cs
+Pulumi.Esc.Sdk/Pulumi.Esc.Sdk.csproj