pulumi/sdk/dotnet/Pulumi/Testing/IMocks.cs

// Copyright 2016-2020, Pulumi Corporation

using System.Collections.Immutable;
using System.Threading.Tasks;

namespace Pulumi.Testing
{
    /// <summary>
    /// Hooks to mock the engine that provide test doubles for offline unit testing of stacks.
    /// </summary>
    public interface IMocks
    {
        /// <summary>
        /// Invoked when a new resource is created by the program.
        /// </summary>
        /// <param name="args">MockResourceArgs</param>
        /// <returns>A tuple of a resource identifier and resource state. State can be either a POCO
        /// or a dictionary bag. The returned ID may be null for component resources.</returns>
        Task<(string? id, object state)> NewResourceAsync(MockResourceArgs args);

        /// <summary>
        /// Invoked when the program needs to call a provider to load data (e.g., to retrieve an existing
        /// resource).
        /// </summary>
        /// <param name="args">MockCallArgs</param>
        /// <returns>Invocation result, can be either a POCO or a dictionary bag.</returns>
        Task<object> CallAsync(MockCallArgs args);
    }
    
    /// <summary>
    /// MockResourceArgs for use in NewResourceAsync
    /// </summary>
    public class MockResourceArgs
    {
        /// <summary>
        /// Resource type name.
        /// </summary>
        public string? Type { get; set; }
        
        /// <summary>
        /// Resource Name.
        /// </summary>
        public string? Name { get; set; }   
        
        /// <summary>
        /// Dictionary of resource input properties.
        /// </summary>
        public ImmutableDictionary<string, object> Inputs { get; set; } = null!;

        /// <summary>
        /// Provider.
        /// </summary>
        public string? Provider { get; set; }
        
        /// <summary>
        /// Resource identifier.
        /// </summary>
        public string? Id { get; set; }
    }

    /// <summary>
    /// MockCallArgs for use in CallAsync
    /// </summary>
    public class MockCallArgs
    {
        /// <summary>
        /// Resource identifier.
        /// </summary>
        public string? Token { get; set; }
        
        /// <summary>
        /// Dictionary of input arguments.
        /// </summary>
        public ImmutableDictionary<string, object> Args { get; set; } = null!;
        
        /// <summary>
        /// Provider.
        /// </summary>
        public string? Provider { get; set; }
    }
}