Microsoft.Forge.TreeWalker
System.Collections.Concurrent
System.Threading.Tasks
Microsoft.CodeAnalysis.Scripting
Microsoft.Forge.Attributes
Microsoft.Forge.DataContracts
Microsoft.Forge.TreeWalker
Newtonsoft.Json
//
// This Linqpad script is a bare-bones application that integrates Microsoft.Forge.TreeWalker.
// It is intended to give users a quick, hands-on experience with Forge from the
// various contributors perspective: application owner, ForgeTree author, ForgeAction author.
//
// Note: Look for "More details here" links throughout the file for more in-depth details.
//
// More details here: https://github.com/microsoft/Forge/wiki/Forge-QuickStart-Guide
//
void Main()
{
this.HandleRequest();
}
public void HandleRequest()
{
// Initialize a TreeWalkerSession, walk the provided ForgeTree schema starting at the "Root" node, and print the results.
Console.WriteLine("OnBeforeWalkTree - TreeNodeKey: Root");
TreeWalkerSession session = this.InitializeSession(jsonSchema: TestForgeSchema);
string result = session.WalkTree("Root").GetAwaiter().GetResult();
Console.WriteLine($"OnAfterWalkTree - TreeNodeKey: {session.GetCurrentTreeNode().Result}, TreeWalkerStatus: {result}");
}
//
// Instantiate a TreeWalkerParameters object with required and any optional parameters you desire.
//
// More details here: https://github.com/microsoft/Forge/wiki/How-To:-Use-Forge-in-my-Application#TreeWalkerParameters
//
public TreeWalkerSession InitializeSession(string jsonSchema)
{
// Initialize required properties.
Guid sessionId = Guid.NewGuid();
ForgeTree forgeTree = JsonConvert.DeserializeObject(jsonSchema);
IForgeDictionary forgeState = new ForgeDictionary(new Dictionary(), sessionId, sessionId);
ITreeWalkerCallbacksV2 callbacks = new TreeWalkerCallbacks();
CancellationToken token = new CancellationTokenSource().Token;
// Initialize optional properties
ForgeUserContext userContext = new ForgeUserContext("Container");
Assembly forgeActionsAssembly = typeof(TardigradeAction).Assembly;
ConcurrentDictionary> scriptCache = new ConcurrentDictionary>();
TreeWalkerParameters parameters = new TreeWalkerParameters(
sessionId,
forgeTree,
forgeState,
callbacks,
token)
{
UserContext = userContext,
ForgeActionsAssembly = forgeActionsAssembly,
ScriptCache = scriptCache
};
return new TreeWalkerSession(parameters);
}
//
// The UserContext is created in your application and passed into the TreeWalkerSession, connecting the 3 components: application, ForgeTree, ForgeActions.
// It is accessible in the schema via Roslyn, e.g. "C#|UserContext.ResourceType == \"Container\""
// It is accessible from ForgeActions via ActionContext.UserContext.
//
public class ForgeUserContext
{
public string ResourceType { get; set; }
public ForgeUserContext(string resourceType)
{
this.ResourceType = resourceType;
}
public string GetResourceType()
{
return this.ResourceType;
}
}
//
// A simple ForgeTree schema.
// The tree walker will visit the Root node and execute the ForgeAction.
// In the child selector, a Roslyn snippet is used to get the persisted ActionResponse from the Action.
// If the Status is "Success," then tree walker will visit the TardigradeSuccess TreeNode.
// Otherwise, the TardigradeFail TreeNode will be visited.
// Both of these TreeNodes are Leaf-type nodes. These are used to clearly represent the tree walking session has completed successfully.
//
// More details here: https://github.com/microsoft/Forge/wiki/How-To:-Author-a-ForgeTree
//
public const string TestForgeSchema = @"
{
""Tree"":
{
""Root"": {
""Type"": ""Action"",
""Actions"": {
""Tardigrade_TardigradeAction"": {
""Action"": ""TardigradeAction"",
""Input"": {
""Reason"": ""Testing Input""
}
}
},
""ChildSelector"": [
{
""ShouldSelect"": ""C#|Session.GetLastActionResponse().Status == \""Success\"" && UserContext.ResourceType == \""Container\"""",
""Child"": ""TardigradeSuccess""
},
{
""Child"": ""TardigradeFail""
}
]
},
""TardigradeSuccess"": {
""Type"": ""Leaf""
},
""TardigradeFail"": {
""Type"": ""Leaf""
}
}
}";
//
// ForgeActions are easily created with the [ForgeAction] Attribute and inheriting from BaseAction.
// InputType can be optionally specified, allowing you to add Input to your ForgeAction on the schema.
//
// More details here: https://github.com/microsoft/Forge/wiki/How-To:-Author-a-ForgeAction
//
[ForgeAction(InputType: typeof(TardigradeInput))]
public class TardigradeAction : BaseAction
{
public override Task RunAction(ActionContext actionContext)
{
TardigradeInput input = (TardigradeInput)actionContext.ActionInput ?? new TardigradeInput();
Console.WriteLine($"OnExecuteAction - TreeNodeKey: {actionContext.TreeNodeKey}, ActionName: {actionContext.ActionName}, ActionInput: {input.Reason}");
return Task.FromResult(new ActionResponse() { Status = "Success" });
}
}
public class TardigradeInput
{
public string Reason { get; set; } = "DefaultValue";
}
//
// Forge calls these callback methods while walking the tree.
// BeforeVisitNode is called before visiting each node, offering a convenient global hook into all TreeNodes.
// Similar for AfterVisitNode.
//
// More details here: https://github.com/microsoft/Forge/wiki/How-To:-Use-Forge-in-my-Application#ITreeWalkerCallbacks-Callbacks
//
public class TreeWalkerCallbacks : ITreeWalkerCallbacksV2
{
public async Task BeforeVisitNode(TreeNodeContext treeNodeContext)
{
Console.WriteLine($"OnBeforeVisitNode - TreeNodeKey: {treeNodeContext.TreeNodeKey}");
}
public async Task AfterVisitNode(TreeNodeContext treeNodeContext)
{
Console.WriteLine($"OnAfterVisitNode - TreeNodeKey: {treeNodeContext.TreeNodeKey}");
}
}