BlazorFocused.Automation.PowerShell 1.0.0-preview1

This is a prerelease version of BlazorFocused.Automation.PowerShell.
dotnet add package BlazorFocused.Automation.PowerShell --version 1.0.0-preview1                
NuGet\Install-Package BlazorFocused.Automation.PowerShell -Version 1.0.0-preview1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="BlazorFocused.Automation.PowerShell" Version="1.0.0-preview1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BlazorFocused.Automation.PowerShell --version 1.0.0-preview1                
#r "nuget: BlazorFocused.Automation.PowerShell, 1.0.0-preview1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install BlazorFocused.Automation.PowerShell as a Cake Addin
#addin nuget:?package=BlazorFocused.Automation.PowerShell&version=1.0.0-preview1&prerelease

// Install BlazorFocused.Automation.PowerShell as a Cake Tool
#tool nuget:?package=BlazorFocused.Automation.PowerShell&version=1.0.0-preview1&prerelease                

Nuget Version Nuget Downloads Continuous Integration

BlazorFocused.Automation.PowerShell

PowerShell PSCmdlet SDK utilities for Automation framework development

NuGet Packages

Package Description
BlazorFocused.Automation.PowerShell PowerShell PSCmdlet SDK utilities for Automation framework development

Documentation

Please visit the BlazorFocused.Automation Documentation Site for installation, getting started, and API documentation.

Samples

Please visit and/or download our BlazorFocused.Automation.PowerShell Sample Solution to get a more in-depth view of usage.

Requirements

Installation

.NET CLI


dotnet add package BlazorFocused.Automation.PowerShell

Development

Add the following to your .csproj file

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

Add a Startup class

public class Startup : AutomationStartup
{
    // Add any configuration sources or data needed
    public override void Configure(HostBuilderContext hostBuilderContext, IConfigurationBuilder configurationBuilder)
    {
        // AutomationEnvironment class allows retrieving global PowerShell
        // variables during service configuration.
        var environment =
            AutomationEnvironment.GetVariable<string>("AppEnvironment");

        var appSettings = new Dictionary<string, string>()
        {
            ["TestOptionsConfig:TestProperty"] = "This is an example",
            ["AppEnvironment"] = environment
        };

        configurationBuilder.AddInMemoryCollection(appSettings);
    }

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

        services.AddTransient<ITestDependencyOne, TestDependencyOne>();
        services.AddTransient<ITestDependencyTwo, TestDependencyTwo>();
        // ...
        // other services, client, etc.
    }
}

Add a PowerShell Command with Dependencies Injected

Synchronous process example

[Cmdlet(VerbsLifecycle.Submit, "Data")]
public class SubmitData : AutomationShell<Startup>
{
    [Parameter(Mandatory = true)]
    public string Id { get; set; }

    [AutomationDependency]
    protected ITestDependencyOne TestDependencyOne { get; set; }

    [AutomationDependency]
    protected ITestDependencyTwo testDependencyTwo { get; set; }

    [AutomationDependency]
    private ILogger<RequestCard> logger { get; set; }

    protected override void ProcessRecord()
    {
        base.ProcessRecord();

        TestDependencyOne.PushTestId(Id);

        TestData testData = testDependencyTwo.GetTestData(Id);

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

        WriteObject(testData);
    }
}

Asynchronous process example

[Cmdlet(VerbsLifecycle.Submit, "DataAsync")]
public class SubmitDataAsync : AutomationShellAsync<Startup>
{
    [Parameter(Mandatory = true)]
    public string Id { get; set; }

    [AutomationDependency]
    protected ITestDependencyOne TestDependencyOne { get; set; }

    [AutomationDependency]
    protected ITestDependencyTwo testDependencyTwo { get; set; }

    [AutomationDependency]
    private ILogger<RequestCard> logger { get; set; }

    protected override async Task ProcessRecordAsync()
    {
        await TestDependencyOne.PushTestIdAsync(Id);

        TestData testData = await testDependencyTwo.GetTestDataAsync(Id);

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

        WriteObject(testData);
    }
}

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).

Now you are ready to run your own custom commands!

The following example is based on command name from above:

Submit-Data -id "ThisIsATestId"

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

Resources

Package Description
BlazorFocused.Automation.Runtime Runtime services for BlazorFocused.Automation framework
BlazorFocused.Automation.CommandLine Dependency Injection Framework for C# Console Applications
BlazorFocused.Automation.PowerShell.Tools Development tools for running/testing PSCmdlets built with Automation framework
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on BlazorFocused.Automation.PowerShell:

Package Downloads
BlazorFocused.Automation.PowerShell.Tools

Development tools for running/testing PSCmdlets built with Automation framework

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0-preview1 60 2/27/2024
1.0.0-alpha1 83 9/29/2023