AutomationIoC 1.1.0-alpha2

AutomationIoC

Dependency Injection Framework for C# PowerShell Cmdlets

Requirements

• Visual Studio Code
• .NET 6
• PowerShell 7

Getting Started

Installation

dotnet add package AutomationIoC

Development

See Sample Project for a full sample solution

Add the following to your .csproj file

<PropertyGroup>
    
    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
</PropertyGroup>

Add a PowerShell Startup Command

[Cmdlet(VerbsLifecycle.Install, "Dependencies")]
public class Startup : AutomationStartup
{
    // Add any configuration sources or data needed
    public override void Configure(IConfigurationBuilder configurationBuilder)
    {
        var appSettings = new Dictionary<string, string>()
        {
            ["TestOptionsConfig:TestProperty"] = "This is an example",
        };

        configurationBuilder.AddInMemoryCollection(appSettings);
    }

    // Configure services/lifetimes
    public override void ConfigureServices(IServiceCollection services)
    {
        services.Configure<TestOptions>(Configuration.GetSection("TestOptionsConfig"));

        services.AddSingleton<TestService>();

        // other services, client, etc.
    }
}

Add a PowerShell Command with Dependencies Injected

Synchronous process example

[Cmdlet(VerbsLifecycle.Submit, "TestData")]
public class SubmitTestData : IoCShell
{
    // Supports non-public properties
    [AutomationDependency]
    protected TestDependencyOne TestDependencyOne { get; set; }

    // Supports non-public fields
    [AutomationDependency]
    private readonly TestDependencyTwo testDependencyTwo;

    [AutomationDependency]
    private readonly ILogger<RequestCard> logger;

    protected override void ExecuteCmdlet()
    {
        string id = Guid.NewGuid();

        TestDependencyOne.PushTestId(id);

        TestData testData = testDependencyTwo.GetTestData(id);

        logger.LogInformation("Auto Generated Data: {Id} - {Name}", id, testData.Name);
    }
}

Asynchronous process example

[Cmdlet(VerbsLifecycle.Submit, "TestDataAsync")]
public class SubmitTestDataAsync : IoCShellAsync
{
    // Supports non-public properties
    [AutomationDependency]
    protected TestDependencyOne TestDependencyOne { get; set; }

    // Supports non-public fields
    [AutomationDependency]
    private readonly TestDependencyTwo testDependencyTwo;

    [AutomationDependency]
    private readonly ILogger<RequestCard> logger;

    protected override async Task ExecuteCmdletAsync()
    {
        string id = Guid.NewGuid();

        await TestDependencyOne.PushTestIdAsync(id);

        TestData testData = await testDependencyTwo.GetTestDataAsync(id);

        logger.LogInformation("Auto Generated Data: {Id} - {Name}", id, testData.Name);
    }
}

Execution

In PowerShell terminal run the following:

Import-Module <path-to-your-dll>/<your-assembly>.dll -V

You should see your custom commands listed in the verbose output (signaled by -v)

See Project - launch.json for a sample on launching your module through VS Code

Load the dependency injection (this will be the command you created for startup). The following example is based on command name from above startup example

Load-Dependencies

Now you are ready to run your own custom commands!

Testing

NOTE: If using a constructor to inject dependencies for testing purposes, be sure to add an empty default constructor as well

Test Example Coming Soon

Other Resources

• Microsoft Docs: Debug Compiled Cmdlets
• Microsoft Docs: VS Code PowerShell Development