pulumi/sdk/dotnet/Pulumi.Automation/PulumiFn.cs
Josh Studt 963b5ab710
[Automation API] - C# Implementation (#5761)
* Init Workspace interface for C# Automation API

* fleshing out workspace interface and beginning of local workspace implementation

* initial run pulumi cmd implementation

* resolve issue with pulumi cmd cleanup wrapper task after testing

* flesh out local workspace implementation, flesh out stack implementation, cleanup run pulumi cmd implementation and make it an instance so it is mockable/testable, separate serialization in prep for custom converters

* project settings json serialization implemented

* Initial commit of language server

* Add deployment from language server

* Cleanup

* finish json serialization

* project runtime yaml serialization completed. just need stack config value yaml serialization

* Remove typed argument

* Limit concurrency

* Rename file for consistency

* final commit of a semi-working project settings & stack settings serialization so that it is in the commit history

* modify workspace API so that settings accessors aren't fully exposed since we are defering a complete serialization implementation until a later date

* yaml converters wrap any outgoing exceptions so resolve that

* getting the beginning of inline program GRPC communication set up

* stack lifecycle operations implemented, and switched to newtonsoft for JSON serialization

* change back to system.text.json with a custom object converter

* local workspace tests written, working on getting them passing

* fix the encoding on the GO files used for testing

* all tests passing except inline program, pulumi engine not available with inline

* inline program engine is now running as expecting, but inline program is not recognizing local stack config

* All tests passing, but no concurrency capability because of the singleton DeploymentInstance.

* cleanup unnecessary usings

* minor cleanup / changes after a quick review. Make sure ConfigureAwait is used where needed. Remove newtonsoft dependency from testing. Update workspace API to use existing PluginKind enum. Modify LanguageRuntimeService so that its semaphore operates process-wide.

* support for parallel execution of inline program, test included

* Update LocalWorkspaceTests.cs

remove some redundancy from the inline program parallel execution text

* flesh out some comments and make asynclocal instance readonly

* Strip out instance locking since it is no longer necessary with AsyncLocal wrapping the Deployment.Instance. Modify CreateRunner method such that we are ensuring there isn't a chance of delayed synchronous execution polluting the value of Deployment.Instance across calls to Deployment.RunAsync

* resolve conflicts with changes made to Deployment.TestAsync entrypoints

* update changelog

* write a test that fails if the CreateRunnerAndRunAsync method on Deployment is not marked async and fix test project data file ref

* make resource package state share the lifetime of the deployment so that their isn't cross deployment issues with resource packages, add support and tests for external resource packages (resource packages that aren't referenced by the executing assembly)

* enable parallel test collection execution in test suite, add some additional tests for deployment instance protection and ensuring that our first class stack exceptions are thrown when expected

* minor inline project name arg change, and re-add xunit json to build output (whoops)

* strip out concurrency changes since they are now in #6139, split automation into separate assembly, split automation tests into separate assembly

* add copyright to the top of each new file

* resolve some PR remarks

* inline program exception is now properly propagated to the caller on UpAsync and PreviewAsync

* modify PulumiFn to allow TStack and other delegate overloads without needing multiple first class delegates.

* whoops missing a copyright

* resolve getting TStack into IRunner so that outputs are registered correctly and so that there isn't 2 instances of Pulumi.Stack instantiated.

* resolve issue with propagation of TStack exceptions and add a test

* add support for a TStack PulumiFn resolved via IServiceProvider

* update automation API description

* fix comment and remove unnecessary TODOs

* disable packaging of automation api assembly

* re-name automation api documentation file appropriately

* add --limit support to dotnet automation api for stack history per #6257

* re-name XStack as WorkspaceStack

* replace --limit usage with --page-size and --page in dotnet automation api per #6292

Co-authored-by: evanboyle <evan@pulumi.com>
Co-authored-by: Josh Studt <josh.studt@figmarketing.com>
Co-authored-by: Dan Friedman <dan@thefriedmans.org>
Co-authored-by: David Ferretti <David.Ferretti@figmarketing.com>
Co-authored-by: Mikhail Shilkov <github@mikhail.io>
2021-02-18 11:36:21 +01:00

124 lines
5.2 KiB
C#

// Copyright 2016-2021, Pulumi Corporation
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Runtime.ExceptionServices;
using System.Threading;
using System.Threading.Tasks;
namespace Pulumi.Automation
{
/// <summary>
/// A Pulumi program as an inline function (in process).
/// </summary>
public abstract class PulumiFn
{
internal PulumiFn()
{
}
internal abstract Task<ExceptionDispatchInfo?> InvokeAsync(IRunner runner, CancellationToken cancellationToken);
/// <summary>
/// Creates an asynchronous inline (in process) pulumi program.
/// </summary>
/// <param name="program">An asynchronous pulumi program that takes in a <see cref="CancellationToken"/> and returns an output.</param>
public static PulumiFn Create(Func<CancellationToken, Task<IDictionary<string, object?>>> program)
=> new PulumiFnInline(program);
/// <summary>
/// Creates an asynchronous inline (in process) pulumi program.
/// </summary>
/// <param name="program">An asynchronous pulumi program that returns an output.</param>
public static PulumiFn Create(Func<Task<IDictionary<string, object?>>> program)
=> new PulumiFnInline(cancellationToken => program());
/// <summary>
/// Creates an asynchronous inline (in process) pulumi program.
/// </summary>
/// <param name="program">An asynchronous pulumi program that takes in a <see cref="CancellationToken"/>.</param>
public static PulumiFn Create(Func<CancellationToken, Task> program)
{
Func<CancellationToken, Task<IDictionary<string, object?>>> wrapper = async cancellationToken =>
{
await program(cancellationToken).ConfigureAwait(false);
return ImmutableDictionary<string, object?>.Empty;
};
return new PulumiFnInline(wrapper);
}
/// <summary>
/// Creates an asynchronous inline (in process) pulumi program.
/// </summary>
/// <param name="program">An asynchronous pulumi program.</param>
public static PulumiFn Create(Func<Task> program)
{
Func<CancellationToken, Task<IDictionary<string, object?>>> wrapper = async cancellationToken =>
{
await program().ConfigureAwait(false);
return ImmutableDictionary<string, object?>.Empty;
};
return new PulumiFnInline(wrapper);
}
/// <summary>
/// Creates an inline (in process) pulumi program.
/// </summary>
/// <param name="program">A pulumi program that returns an output.</param>
public static PulumiFn Create(Func<IDictionary<string, object?>> program)
{
Func<CancellationToken, Task<IDictionary<string, object?>>> wrapper = cancellationToken =>
{
var output = program();
return Task.FromResult(output);
};
return new PulumiFnInline(wrapper);
}
/// <summary>
/// Creates an inline (in process) pulumi program.
/// </summary>
/// <param name="program">A pulumi program.</param>
public static PulumiFn Create(Action program)
=> Create(() => { program(); return ImmutableDictionary<string, object?>.Empty; });
/// <summary>
/// Creates an inline (in process) pulumi program via a traditional <see cref="Pulumi.Stack"/> implementation.
/// </summary>
/// <typeparam name="TStack">The <see cref="Pulumi.Stack"/> type.</typeparam>
public static PulumiFn Create<TStack>()
where TStack : Pulumi.Stack, new()
=> new PulumiFn<TStack>(() => new TStack());
/// <summary>
/// Creates an inline (in process) pulumi program via a traditional <see cref="Pulumi.Stack"/> implementation.
/// <para/>
/// When invoked, a new stack instance will be resolved based
/// on the provided <typeparamref name="TStack"/> type parameter
/// using the <paramref name="serviceProvider"/>.
/// </summary>
/// <typeparam name="TStack">The <see cref="Pulumi.Stack"/> type.</typeparam>
public static PulumiFn Create<TStack>(IServiceProvider serviceProvider)
where TStack : Pulumi.Stack
{
if (serviceProvider is null)
throw new ArgumentNullException(nameof(serviceProvider));
return new PulumiFn<TStack>(
() =>
{
if (serviceProvider is null)
throw new ArgumentNullException(nameof(serviceProvider), $"The provided service provider was null by the time this {nameof(PulumiFn)} was invoked.");
return serviceProvider.GetService(typeof(TStack)) as TStack
?? throw new ApplicationException(
$"Failed to resolve instance of type {typeof(TStack)} from service provider. Register the type with the service provider before this {nameof(PulumiFn)} is invoked.");
});
}
}
}