Zaria.Calabash.DevHost 2.6.7

Instructions

Version 2.0.0

=========================== In the latest build the individual Startxxxx methods have been consolidated into one method that will start the dev hosting environment as a Blazor app. While it can techically be started from a console, you will need to configure the project SDK as a web project Microsoft.NET.Sdk.Web.
The following code demonstrates using it in this way

var configuration = new ConfigurationBuilder()
                    .SetBasePath(AppContext.BaseDirectory)
                    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
                    .AddEnvironmentVariables()
                    .AddCommandLine(args)
                    .Build();

var host = new CalabashDevHost();
await host.InitializeAI<SampleHost>(new HostSettings
{
    AIDeploymentName = "<The deployment name>",
    AIEndpoint = "<The AI endpoing>",
    AIKey = "<The AI key>",
    LogCategory = "<A string for the log category you want>",
    Username = "<anything you want to tbe passed as the username>",
    BasePath = "api",
    Configuration = builder.Configuration,
    SessionID = <A guid to represent the session id>,
    Profile = new Zaria.Calabash.Data.UserProfile
    {
        User = new Zaria.Calabash.Data.User
        {
            FirstName = "<Anything you want to be passed as the first name>",
            LastName = "<Anything you want to be passed as the last name>",
        },
        EffectiveRoles = "<The roles you want to emulate>"
    },
});

host.StartCalabashHost();

Note that to get this to work properly you will have to add a blank .razor file to the console project. This file does not need to contain anything but is needed to properly run the devhost.

A much better approach is to simply create a new blazor application and use it as the devhost. The following steps demonstrate the approach.

1. Create a blazor application
2. Add a reference to this nuget package
3. Delete the wwwroot and any blazor related items like the Components folder from the project. Leave Program.cs and appsettings.json
4. Reference the calabash .NET plugin you want to test
5. In Program.cs remove all the blazor configuration boilerplate except for var builder = WebApplication.CreateBuilder(args);
6. Now add the following code

// Add services to the container.
await builder.RunCalabash<SampleHost>(new HostSettings
{
    AIDeploymentName = "<The deployment name>",
    AIEndpoint = "<The AI endpoing>",
    AIKey = "<The AI key>",
    LogCategory = "<A string for the log category you want>",
    Username = "<anything you want to tbe passed as the username>",
    BasePath = "api",
    Configuration = builder.Configuration,
    SessionID = <A guid to represent the session id>,
    Profile = new Zaria.Calabash.Data.UserProfile
    {
        User = new Zaria.Calabash.Data.User
        {
            FirstName = "<Anything you want to be passed as the first name>",
            LastName = "<Anything you want to be passed as the last name>",
        },
        EffectiveRoles = "<The roles you want to emulate>"
    },
});

SampleHost here represents the SolutionHost from the plugin library. This method allows you to test all scenarios in a real world manner. A web page is opened that points to an isolated instance of Calabash. You have access to the chatbox in the Calabash dashboard, your time triggered jobs run as background workers, and your http triggered workers can be called via rest.

Version 1.*

===========================

To use this dev host do th following:

1. Create a console applicaiton
2. Reference the calabash .NET plugin you want to test
3. Create a new instance of the CalabashDevHost class
4. Call InitializeAI passing in a class that inherits from SolutionHost as the type argument and a populated HostSettings argument
5. Call StartREPL to start a REPL loop for testing your AI skills
6. To test your HTTP triggers you can alternatively call StartHTTP
7. To test your time triggered workers you can alternatively call StartBackgroundWorker

The following sample code illustrates:

namespace Calabash.AgentTestHarness
{
    internal class Program
    {
        async static Task Main(string[] args)
        {
            var host = new CalabashDevHost();
            await host.InitializeAI<SampleHost>(new HostSettings
            {
                AIDeploymentName = "<ai deployment name>",
                AIEndpoint = "<ai url>",
                AIKey = "<ai key>",
                LogCategory = "test",
                Username = "<some email>",
                HttpListenPort = 5000,
                BasePath = "/api",
            });

            //await host.StartHTTP();  //Starts an http listener that can be used to test your http triggers
            //await host.StartREPL();  //Starts a console repl for testing your AI skills
            //await host.StartBackgroundWorker();  //Starts background workers for testing your time triggers. 
        }
    }
}