Biosero Orchestrator Dev Tools

Biosero Orchestrator DevTools is a suite of developer tools (packages, examples, etc.) to help you implement and manage your Orchestrator environment.

Scripting Tools

The Scripting Tools package is designed to improve the developer experience when writing Orchestrator Workflow scripts. The driving motivation here is BYOIDE (Bring Your Own Integrated Development Environment). All from inside Visual Studio or VS Code, you can code, debug, and test your Orchestrator Workflow scripts. Then when you are ready, just copy them into the Biosero Designer application. The Scripting Tools NuGet package will provide you with mock classes that can be used to simulate running a script during an Orchestrator Workflow.

Getting started

Biosero Orchestrator Scripting Tools is installed via NuGet from the nuget.org package feed.

dotnet add package Biosero.Orchestrator.ScriptingTools

Writing Orchestrator Scripts

Orchestartor Workflow scripts must be contained within a class with a parameterless constructor and a RunAsync method matching the below signature.

using System;
using System.Threading;
using System.Threading.Tasks;
using Biosero.DataServices.Client;
using Biosero.Orchestrator.WorkflowService;

namespace Acme.Orchestrator.Scripting
{
    public class MyNewScript
    {
        public Task RunAsync(DataServicesClient client, WorkflowContext context, CancellationToken cancellationToken)
        {
            return Task.CompletedTask;
        }
    }
}

The DataServicesClient class is a strongly typed HTTP client for the Data Services API. The actual class is auto generated from our Open API (Swagger) documentation. A mock version of the class exists in the Scripting Tools package. The mock version is an abstract class with all abstract methods that mirror the signatures of the actual version. This allows a matching contract while easily enabling the mocking of the abstract methods with unit testing tools like Moq.

var client = new Mock<DataServicesClient>().Object;

The WorkflowContext class provides access to reading and writing global variables associated with the running workflow. The mock version provided by the Scripting Tools package is backed by a simple Parameter collection. This makes it easy to arrange and assert against it in unit tests.

var context = new WorkflowContext(
    new Parameter
    {
        Name = "StringVariableName",
        ValueType = ParameterValueType.String,
        Value = "A string value"
    },
    new Parameter
    {
        Name = "IntegerVariableName",
        ValueType = ParameterValueType.Integer,
        Value = "1"
    },
    new Parameter
    {
        Name = "DoubleVariableName",
        ValueType = ParameterValueType.Double,
        Value = "0.5"
    },
    new Parameter
    {
        Name = "BooleanVariableName",
        ValueType = ParameterValueType.Boolean,
        Value = "true"
    });

Testing Orchestrator Scripts

The Scripting Tools package provides a ScriptHelper to simulate how the Orchestrator Workflow Engine would compile and run your script. The Compile and RunAsync methods could help with writing unit tests against your scripts.

[TestMethod]
public void Compile_As_Script()
{
    var scriptText = File.ReadAllText("Script1_DoesNothing.cs");

    ScriptHelper.Compile(scriptText);
}

[TestMethod]
public async Task Execute_As_Script()
{
    var scriptText = File.ReadAllText("Script1_DoesNothing.cs");
    var client = new Mock<DataServicesClient>().Object;
    var context = new WorkflowContext();

    await ScriptHelper.RunAsync(scriptText, client, context);
}

If you are interested in further recommendations on how to organization your scripting solution, checkout our examples/Scripting/ directory in the repository.

Kubernetes Example Manifest Files

Under the kube/ directory, you will find examples of Kubernetes manifest files very similar to the ones we use at Biosero to deploy Orchestrator to our cloud test environment. You can use these as a reference when building out your own Kubernetes infrastructure.