Unit-testing C# with top-level program + docs
ADD
testing-unit-cs-top-level-program/README.md
+# C# Unit Testing with Top-Level Statements
+
+In this example project, we examine how to unit test C# Pulumi programs that are using top-level statements with dotnet SDK v6. These programs look like this
+
+```csharp
+using Pulumi;
+
+return await Deployment.RunAsync(() =>
+{
+ // Create resources here
+});
+```
+
+In order to unit test this piece of code, we have to do a bit of rewriting such that we don't run the `Deployment.RunAsync` function because it expects the program is being executed from the Pulumi CLI.
+
+Now, we take the lambda that is provided to `Deployment.RunAsync` and move it in a place where we can reference it later from our unit test project. The following snippet shows this
+
+```csharp
+using Pulumi;
+
+return await Deployment.RunAsync(Deploy.Infra);
+
+class Deploy
+{
+ public static Dictionary<string, object?> Infra()
+ {
+ // Create resources here
+ }
+}
+```
+Here, the code that creates resources and returns outputs is inside the `Deploy.Infra` function which we can reference from the test project.
+
+> The return type of `Deploy.Infra` could also have been any of the following
+> - `void` when we are not returning outputs
+> - `Task` when we want to `await` async code
+> - `Task<Dictionary<string, object?>>` when we want to `await` async code _and_ return outputs
+
+There is a catch before we can reference `Deploy.Infra` from the unit tests. Since we don't have an explicit namespace here, we need to add this property to the project file
+```xml
+<ItemGroup>
+ <InternalsVisibleTo Include="Tests"/>
+</ItemGroup>
+```
+Now we are ready to write unit tests. From a test project called `Tests`, add a reference to the project that contains the Pulumi program:
+```xml
+<ItemGroup>
+ <ProjectReference Include="..\infra\Infra.csproj" />
+</ItemGroup>
+```
+Now, only for the tests we can create a _test stack_ that uses `Deploy.Infra` as follows
+```csharp
+class TestStack : Stack
+{
+ public TestStack()
+ {
+ Outputs = Deploy.Infra();
+ }
+
+ public Dictionary<string, object?> Outputs { get; set; }
+}
+```
+Then, we can use this test stack to build resources and make assertions about them:
+```csharp
+[Test]
+public async Task StackExportsWebsiteUrl()
+{
+ var options = new TestOptions { IsPreview = false };
+ var resources = await Pulumi.Deployment.TestAsync<TestStack>(new Mocks(), options);
+ var stack = resources.OfType<TestStack>().First();
+ Assert.That(stack.Outputs.ContainsKey("endpoint"), "Stack should have an endpoint output");
+ if (stack.Outputs["endpoint"] is Output<string> endpoint)
+ {
+ var endpointValue = await endpoint.GetValueAsync();
+ endpointValue.Should().Be("https://wwwprodsa.web.core.windows.net");
+ }
+}
+```
+The rest of the unit testing constructs such as `Mocks` are covered in the blog post: [Unit Testing Cloud Deployments with .NET](https://www.pulumi.com/blog/unit-testing-cloud-deployments-with-dotnet/)
\ No newline at end of file

ADD
testing-unit-cs-top-level-program/infra/.gitignore
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+##
+## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+
+# User-specific files
+*.rsuser
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Mono auto generated files
+mono_crash.*
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Bb]in/
+[Oo]bj/
+[Ll]og/
+[Ll]ogs/
+
+# Visual Studio 2015/2017 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# Visual Studio 2017 auto generated files
+Generated\ Files/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUnit
+*.VisualState.xml
+TestResult.xml
+nunit-*.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# Benchmark Results
+BenchmarkDotNet.Artifacts/
+
+# .NET Core
+project.lock.json
+project.fragment.lock.json
+artifacts/
+
+# StyleCop
+StyleCopReport.xml
+
+# Files built by Visual Studio
+*_i.c
+*_p.c
+*_h.h
+*.ilk
+*.meta
+*.obj
+*.iobj
+*.pch
+*.pdb
+*.ipdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*_wpftmp.csproj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+*.VC.VC.opendb
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# Visual Studio Trace Files
+*.e2e
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# JustCode is a .NET coding add-in
+.JustCode
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# AxoCover is a Code Coverage Tool
+.axoCover/*
+!.axoCover/settings.json
+
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# Note: Comment the next line if you want to checkin your web deploy settings,
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
+# NuGet Packages
+*.nupkg
+# NuGet Symbol Packages
+*.snupkg
+# The packages folder can be ignored because of Package Restore
+**/[Pp]ackages/*
+# except build/, which is used as an MSBuild target.
+!**/[Pp]ackages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/[Pp]ackages/repositories.config
+# NuGet v3's project.json files produces more ignorable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directories and files
+AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+*.appx
+*.appxbundle
+*.appxupload
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!?*.[Cc]ache/
+
+# Others
+ClientBin/
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.jfm
+*.pfx
+*.publishsettings
+orleans.codegen.cs
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+#*.snk
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+#bower_components/
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+ServiceFabricBackup/
+*.rptproj.bak
+
+# SQL Server files
+*.mdf
+*.ldf
+*.ndf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+*.rptproj.rsuser
+*- [Bb]ackup.rdl
+*- [Bb]ackup ([0-9]).rdl
+*- [Bb]ackup ([0-9][0-9]).rdl
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+node_modules/
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+*.vbw
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# Paket dependency manager
+.paket/paket.exe
+paket-files/
+
+# FAKE - F# Make
+.fake/
+
+# CodeRush personal settings
+.cr/personal
+
+# Python Tools for Visual Studio (PTVS)
+__pycache__/
+*.pyc
+
+# Cake - Uncomment if you are using it
+# tools/**
+# !tools/packages.config
+
+# Tabs Studio
+*.tss
+
+# Telerik's JustMock configuration file
+*.jmconfig
+
+# BizTalk build output
+*.btp.cs
+*.btm.cs
+*.odx.cs
+*.xsd.cs
+
+# OpenCover UI analysis results
+OpenCover/
+
+# Azure Stream Analytics local run output
+ASALocalRun/
+
+# MSBuild Binary and Structured Log
+*.binlog
+
+# NVidia Nsight GPU debugger configuration file
+*.nvuser
+
+# MFractors (Xamarin productivity tool) working folder
+.mfractor/
+
+# Local History for Visual Studio
+.localhistory/
+
+# BeatPulse healthcheck temp database
+healthchecksdb
+
+# Backup folder for Package Reference Convert tool in Visual Studio 2017
+MigrationBackup/
+
+# Ionide (cross platform F# VS Code tools) working folder
+.ionide/

ADD
testing-unit-cs-top-level-program/infra/Pulumi.yaml
+name: infra
+runtime: dotnet
+description: A minimal C# Pulumi program

ADD
testing-unit-cs-top-level-program/infra/wwwroot/about.html
+<html>
+<body>
+About Page
+</body>
+</html>

ADD
testing-unit-cs-top-level-program/infra/wwwroot/index.html
+<html>
+<body>
+Home Page
+</body>
+</html>

ADD
testing-unit-cs-top-level-program/tests/Extensions.cs
+namespace Tests;
+
+using Pulumi;
+using System.Threading.Tasks;
+
+public static class TestingExtensions
+{
+ /// <summary>
+ /// Extract the value from an output. Only use for testing!
+ /// </summary>
+ public static Task<T> GetValueAsync<T>(this Output<T> output)
+ {
+ var tcs = new TaskCompletionSource<T>();
+ output.Apply(v =>
+ {
+ tcs.SetResult(v);
+ return v;
+ });
+ return tcs.Task;
+ }
+}
\ No newline at end of file

ADD
testing-unit-cs-top-level-program/tests/InfraTests.cs
+namespace Tests;
+
+using System.Collections.Immutable;
+using FluentAssertions;
+using Pulumi;
+using Pulumi.AzureNative.Resources;
+using Pulumi.AzureNative.Storage;
+using Pulumi.Testing;
+
+public class InfraTests
+{
+ class TestStack : Stack
+ {
+ public TestStack()
+ {
+ Outputs = Deploy.Infra();
+ }
+
+ public Dictionary<string, object?> Outputs { get; set; }
+ }
+
+ private static Task<ImmutableArray<Pulumi.Resource>> TestAsync()
+ {
+ return Pulumi.Deployment.TestAsync<TestStack>(new Mocks(), new TestOptions
+ {
+ IsPreview = false
+ });
+ }
+
+ [Test]
+ public async Task SingleResourceGroupExists()
+ {
+ var resources = await TestAsync();
+ var resourceGroups = resources.OfType<ResourceGroup>().ToList();
+ resourceGroups.Count.Should().Be(1, "a single resource group is expected");
+ }
+
+ [Test]
+ public async Task ResourceGroupHasEnvironmentTag()
+ {
+ var resources = await TestAsync();
+ var resourceGroup = resources.OfType<ResourceGroup>().First();
+
+ var tags = await resourceGroup.Tags.GetValueAsync();
+ tags.Should().NotBeNull("Tags must be defined");
+ tags.Should().ContainKey("Environment");
+ }
+
+ [Test]
+ public async Task StorageAccountExists()
+ {
+ var resources = await TestAsync();
+ var storageAccounts = resources.OfType<StorageAccount>();
+ var storageAccount = storageAccounts.SingleOrDefault();
+ storageAccount.Should().NotBeNull("Storage account not found");
+ }
+
+ [Test]
+ public async Task UploadsTwoFiles()
+ {
+ var resources = await TestAsync();
+ var files = resources.OfType<Blob>().ToList();
+ files.Count.Should().Be(2, "Should have uploaded files from `wwwroot`");
+ }
+
+ [Test]
+ public async Task StackExportsWebsiteUrl()
+ {
+ var resources = await TestAsync();
+ var stack = resources.OfType<TestStack>().First();
+ Assert.That(stack.Outputs.ContainsKey("endpoint"), "Stack should have an endpoint output");
+ if (stack.Outputs["endpoint"] is Output<string> endpoint)
+ {
+ var endpointValue = await endpoint.GetValueAsync();
+ endpointValue.Should().Be("https://wwwprodsa.web.core.windows.net");
+ }
+ }
+}
\ No newline at end of file

ADD
testing-unit-cs-top-level-program/tests/Mocks.cs
+namespace Tests;
+
+using System.Collections.Immutable;
+using System.Threading.Tasks;
+using Pulumi.Testing;
+
+class Mocks : IMocks
+{
+ public Task<(string? id, object state)> NewResourceAsync(MockResourceArgs args)
+ {
+ var outputs = ImmutableDictionary.CreateBuilder<string, object>();
+
+ // Forward all input parameters as resource outputs, so that we could test them.
+ outputs.AddRange(args.Inputs);
+
+ // Set the name to resource name if it's not set explicitly in inputs.
+ if (!args.Inputs.ContainsKey("name"))
+ {
+ outputs.Add("name", args.Name!);
+ }
+
+ if (args.Type == "azure-native:storage:Blob")
+ {
+ // Assets can't directly go through the engine.
+ // We don't need them in the test, so blank out the property for now.
+ outputs.Remove("source");
+ }
+
+ // For a Storage Account...
+ if (args.Type == "azure-native:storage:StorageAccount")
+ {
+ // ... set its web endpoint property.
+ // Normally this would be calculated by Azure, so we have to mock it.
+ outputs.Add("primaryEndpoints", new Dictionary<string, string>
+ {
+ { "web", $"https://{args.Name}.web.core.windows.net" },
+ }.ToImmutableDictionary());
+ }
+ // Default the resource ID to `{name}_id`.
+ // We could also format it as `/subscription/abc/resourceGroups/xyz/...` if that was important for tests.
+ args.Id ??= $"{args.Name}_id";
+ return Task.FromResult((args.Id, (object)outputs));
+ }
+
+ public Task<object> CallAsync(MockCallArgs args)
+ {
+ // We don't use this method in this particular test suite.
+ // Default to returning whatever we got as input.
+ return Task.FromResult((object)args.Args);
+ }
+}
\ No newline at end of file

ADD
testing-unit-cs-top-level-program/tests/Tests.csproj
+<Project Sdk="Microsoft.NET.Sdk">
+
+ <PropertyGroup>
+ <TargetFramework>net6.0</TargetFramework>
+ <ImplicitUsings>enable</ImplicitUsings>
+ <Nullable>enable</Nullable>
+
+ <IsPackable>false</IsPackable>
+ </PropertyGroup>
+
+ <ItemGroup>
+ <PackageReference Include="FluentAssertions" Version="6.7.0" />
+ <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
+ <PackageReference Include="NUnit" Version="3.13.3" />
+ <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
+ <PackageReference Include="NUnit.Analyzers" Version="3.3.0" />
+ <PackageReference Include="coverlet.collector" Version="3.1.2" />
+ </ItemGroup>
+
+ <ItemGroup>
+ <ProjectReference Include="..\infra\Infra.csproj" />
+ </ItemGroup>
+
+</Project>

ADD
testing-unit-cs-top-level-program/tests/Usings.cs
+global using NUnit.Framework;
\ No newline at end of file

Unit-testing C# with top-level program + docs