feat(UnitTests): Added validation unit tests

Signed-off-by: Charles d'Avernas <[email protected]>

Author: cdavernas

src/ServerlessWorkflow.Sdk.Builders/DoTaskDefinitionBuilder.cs

@@ -39,10 +39,10 @@ public virtual IDoTaskDefinitionBuilder Do(Action<ITaskDefinitionMapBuilder> set
     public override DoTaskDefinition Build()
     {
         if (this.Tasks == null || this.Tasks.Count < 2) throw new NullReferenceException("The execution strategy must define at least two subtasks");
-        return new()
+        return this.Configure(new()
         {
             Do = this.Tasks
-        };
+        });
     }
 
 }

src/ServerlessWorkflow.Sdk.Builders/EmitTaskDefinitionBuilder.cs

@@ -48,13 +48,13 @@ public virtual IEmitTaskDefinitionBuilder Event(Action<IEventDefinitionBuilder>
     public override EmitTaskDefinition Build()
     {
         if (this.EventDefinition == null) throw new NullReferenceException("The event to emit must be defined");
-        return new() 
+        return this.Configure(new() 
         { 
             Emit = new() 
             { 
                 Event = this.EventDefinition 
             } 
-        };
+        });
     }
 
 }

src/ServerlessWorkflow.Sdk.Builders/ForTaskDefinitionBuilder.cs

@@ -80,7 +80,7 @@ public override ForTaskDefinition Build()
         if (string.IsNullOrWhiteSpace(this.EachVariableName)) throw new NullReferenceException("The variable name used to store the iterated items must be set");
         if (string.IsNullOrWhiteSpace(this.InExpression)) throw new NullReferenceException("The runtime expression used to resolve the collection to iterate must be set");
         if (this.Tasks == null || this.Tasks.Count < 1) throw new NullReferenceException("The task to perform at each iteration must be set");
-        return new()
+        return this.Configure(new()
         {
             For = new()
             {
@@ -89,7 +89,7 @@ public override ForTaskDefinition Build()
                 At = this.AtVariableName
             },
             Do = this.Tasks
-        };
+        });
     }
 
 }

src/ServerlessWorkflow.Sdk.Builders/ForkTaskDefinitionBuilder.cs

@@ -51,14 +51,14 @@ public virtual IForkTaskDefinitionBuilder Compete()
     public override ForkTaskDefinition Build()
     {
         if (this.Tasks == null || this.Tasks.Count < 2) throw new NullReferenceException("The execution strategy must define at least two subtasks");
-        return new()
+        return this.Configure(new()
         {
             Fork = new() 
             {
                 Branches = this.Tasks,
                 Compete = this.ShouldCompete
             }
-        };
+        });
     }
 
 }

src/ServerlessWorkflow.Sdk.Builders/Interfaces/ITaskDefinitionBuilder.cs

@@ -43,6 +43,27 @@ public interface ITaskDefinitionBuilder<TBuilder>
     /// <returns>The configured <see cref="ITaskDefinitionBuilder{TBuilder}"/></returns>
     TBuilder If(string condition);
 
+    /// <summary>
+    /// Sets the workflow's timeout
+    /// </summary>
+    /// <param name="name">The name of the workflow's timeout</param>
+    /// <returns>The configured <see cref="ITaskDefinitionBuilder{TBuilder}"/></returns>
+    TBuilder WithTimeout(string name);
+
+    /// <summary>
+    /// Sets the workflow's timeout
+    /// </summary>
+    /// <param name="timeout">The workflow's timeout</param>
+    /// <returns>The configured <see cref="ITaskDefinitionBuilder{TBuilder}"/></returns>
+    TBuilder WithTimeout(TimeoutDefinition timeout);
+
+    /// <summary>
+    /// Sets the workflow's timeout
+    /// </summary>
+    /// <param name="setup">An <see cref="Action{T}"/> used to setup the workflow's timeout</param>
+    /// <returns>The configured <see cref="ITaskDefinitionBuilder{TBuilder}"/></returns>
+    TBuilder WithTimeout(Action<ITimeoutDefinitionBuilder> setup);
+
     /// <summary>
     /// Configures the task to build to then execute the specified flow directive
     /// </summary>

src/ServerlessWorkflow.Sdk.Builders/Interfaces/ITimeoutDefinitionBuilder.cs

@@ -0,0 +1,42 @@
+// Copyright © 2024-Present The Serverless Workflow Specification Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"),
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace ServerlessWorkflow.Sdk.Builders;
+
+/// <summary>
+/// Defines the fundamentals of a service used to build <see cref="TimeoutDefinition"/>s
+/// </summary>
+public interface ITimeoutDefinitionBuilder
+{
+
+    /// <summary>
+    /// Configures the <see cref="TimeoutDefinition"/> to timeout after the specified duration
+    /// </summary>
+    /// <param name="duration">The ISO 8601 duration after which to timeout</param>
+    /// <returns>The configured <see cref="ITimeoutDefinitionBuilder"/></returns>
+    ITimeoutDefinitionBuilder After(string duration);
+
+    /// <summary>
+    /// Configures the <see cref="TimeoutDefinition"/> to timeout after the specified duration
+    /// </summary>
+    /// <param name="duration">The duration after which to timeout</param>
+    /// <returns>The configured <see cref="ITimeoutDefinitionBuilder"/></returns>
+    ITimeoutDefinitionBuilder After(Duration duration);
+
+    /// <summary>
+    /// Builds the configured <see cref="TimeoutDefinition"/>
+    /// </summary>
+    /// <returns>A new <see cref="TimeoutDefinition"/></returns>
+    TimeoutDefinition Build();
+
+}

src/ServerlessWorkflow.Sdk.Builders/Interfaces/IWorkflowDefinitionBuilder.cs

@@ -20,6 +20,13 @@ public interface IWorkflowDefinitionBuilder
     : ITaskDefinitionMapBuilder<IWorkflowDefinitionBuilder>
 {
 
+    /// <summary>
+    /// Sets the semantic version of the Serverless Workflow DSL used to define the workflow
+    /// </summary>
+    /// <param name="version">The semantic version of the Serverless Workflow DSL used to define the workflow</param>
+    /// <returns>The configured <see cref="IWorkflowDefinitionBuilder"/></returns>
+    IWorkflowDefinitionBuilder UseDsl(string version);
+
     /// <summary>
     /// Sets the workflow's namespace
     /// </summary>
@@ -60,16 +67,37 @@ public interface IWorkflowDefinitionBuilder
     /// </summary>
     /// <param name="name">The tag's name</param>
     /// <param name="value">The tag's value</param>
-    /// <returns>The configured <see cref="ICallTaskDefinitionBuilder"/></returns>
+    /// <returns>The configured <see cref="IWorkflowDefinitionBuilder"/></returns>
     IWorkflowDefinitionBuilder WithTag(string name, string value);
 
     /// <summary>
     /// Sets the tags of the workflow
     /// </summary>
     /// <param name="arguments">A name/value mapping of the workflow's tags</param>
-    /// <returns>The configured <see cref="ICallTaskDefinitionBuilder"/></returns>
+    /// <returns>The configured <see cref="IWorkflowDefinitionBuilder"/></returns>
     IWorkflowDefinitionBuilder WithTag(IDictionary<string, string> arguments);
 
+    /// <summary>
+    /// Sets the workflow's timeout
+    /// </summary>
+    /// <param name="name">The name of the workflow's timeout</param>
+    /// <returns>The configured <see cref="IWorkflowDefinitionBuilder"/></returns>
+    IWorkflowDefinitionBuilder WithTimeout(string name);
+
+    /// <summary>
+    /// Sets the workflow's timeout
+    /// </summary>
+    /// <param name="timeout">The workflow's timeout</param>
+    /// <returns>The configured <see cref="IWorkflowDefinitionBuilder"/></returns>
+    IWorkflowDefinitionBuilder WithTimeout(TimeoutDefinition timeout);
+
+    /// <summary>
+    /// Sets the workflow's timeout
+    /// </summary>
+    /// <param name="setup">An <see cref="Action{T}"/> used to setup the workflow's timeout</param>
+    /// <returns>The configured <see cref="IWorkflowDefinitionBuilder"/></returns>
+    IWorkflowDefinitionBuilder WithTimeout(Action<ITimeoutDefinitionBuilder> setup);
+
     /// <summary>
     /// Uses the specified authentication policy
     /// </summary>

src/ServerlessWorkflow.Sdk.Builders/ListenTaskDefinitionBuilder.cs

@@ -42,10 +42,10 @@ public virtual IListenTaskDefinitionBuilder To(Action<IListenerTargetDefinitionB
     public override ListenTaskDefinition Build()
     {
         if (this.Listener == null) throw new NullReferenceException("The listener must be set");
-        return new()
+        return this.Configure(new()
         {
             Listen = this.Listener
-        };
+        });
     }
 
 }

src/ServerlessWorkflow.Sdk.Builders/RaiseTaskDefinitionBuilder.cs

@@ -47,13 +47,13 @@ public virtual IRaiseTaskDefinitionBuilder Error(Action<IErrorDefinitionBuilder>
     public override RaiseTaskDefinition Build()
     {
         if (this.ErrorDefinition == null) throw new NullReferenceException("The error to raise must be set");
-        return new() 
+        return this.Configure(new() 
         { 
             Raise = new() 
             { 
                 Error = this.ErrorDefinition 
             } 
-        };
+        });
     }
 
 }

src/ServerlessWorkflow.Sdk.Builders/RunTaskDefinitionBuilder.cs

@@ -64,7 +64,7 @@ public override RunTaskDefinition Build()
     {
         if (this.ProcessBuilder == null) throw new NullReferenceException("The process to run must be set");
         var process = this.ProcessBuilder.Build();
-        return new()
+        return this.Configure(new()
         {
             Run = new()
             {
@@ -73,7 +73,7 @@ public override RunTaskDefinition Build()
                 Shell = process is ShellProcessDefinition shell ? shell : null,
                 Workflow = process is WorkflowProcessDefinition workflow ? workflow : null
             }
-        };
+        });
     }
 
 }

src/ServerlessWorkflow.Sdk.Builders/SetTaskDefinitionBuilder.cs

@@ -45,9 +45,9 @@ public virtual ISetTaskDefinitionBuilder Set(IDictionary<string, object> variabl
     }
 
     /// <inheritdoc/>
-    public override SetTaskDefinition Build() => new()
+    public override SetTaskDefinition Build() => this.Configure(new()
     {
         Set = this.Variables
-    };
+    });
 
 }

src/ServerlessWorkflow.Sdk.Builders/SwitchTaskDefinitionBuilder.cs

@@ -38,9 +38,9 @@ public ISwitchTaskDefinitionBuilder Case(string name, Action<ISwitchCaseDefiniti
     }
 
     /// <inheritdoc/>
-    public override SwitchTaskDefinition Build() => new()
+    public override SwitchTaskDefinition Build() => this.Configure(new()
     {
         Switch = this.Cases
-    };
+    });
 
 }

src/ServerlessWorkflow.Sdk.Builders/TaskDefinitionBuilder.cs

@@ -29,6 +29,11 @@ public abstract class TaskDefinitionBuilder<TBuilder, TDefinition>
     /// </summary>
     protected string? IfExpression { get; set; }
 
+    /// <summary>
+    /// Gets/sets the task's timeout, if any
+    /// </summary>
+    protected OneOf<TimeoutDefinition, string>? Timeout { get; set; }
+
     /// <summary>
     /// Gets/sets the flow directive, if any, used to then execute
     /// </summary>
@@ -42,6 +47,32 @@ public virtual TBuilder If(string condition)
         return (TBuilder)(object)this;
     }
 
+    /// <inheritdoc/>
+    public virtual TBuilder WithTimeout(string name)
+    {
+        ArgumentException.ThrowIfNullOrWhiteSpace(name);
+        this.Timeout = name;
+        return (TBuilder)(object)this;
+    }
+
+    /// <inheritdoc/>
+    public virtual TBuilder WithTimeout(TimeoutDefinition timeout)
+    {
+        ArgumentNullException.ThrowIfNull(timeout);
+        this.Timeout = timeout;
+        return (TBuilder)(object)this;
+    }
+
+    /// <inheritdoc/>
+    public virtual TBuilder WithTimeout(Action<ITimeoutDefinitionBuilder> setup)
+    {
+        ArgumentNullException.ThrowIfNull(setup);
+        var builder = new TimeoutDefinitionBuilder();
+        setup(builder);
+        this.Timeout = builder.Build();
+        return (TBuilder)(object)this;
+    }
+
     /// <inheritdoc/>
     public virtual TBuilder Then(string directive)
     {
@@ -58,6 +89,11 @@ public virtual TBuilder Then(string directive)
     protected virtual TDefinition Configure(TDefinition definition)
     {
         definition.If = this.IfExpression;
+        if (this.Timeout != null)
+        {
+            if (this.Timeout.T1Value != null) definition.Timeout = this.Timeout.T1Value;
+            else definition.TimeoutReference = this.Timeout.T2Value;
+        }
         definition.Then = this.ThenDirective;
         return definition;
     }

src/ServerlessWorkflow.Sdk.Builders/TimeoutDefinitionBuilder.cs

@@ -0,0 +1,56 @@
+// Copyright © 2024-Present The Serverless Workflow Specification Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"),
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System.Xml;
+
+namespace ServerlessWorkflow.Sdk.Builders;
+
+/// <summary>
+/// Represents the default implementation of the <see cref="ITimeoutDefinitionBuilder"/> interface
+/// </summary>
+public class TimeoutDefinitionBuilder
+    : ITimeoutDefinitionBuilder
+{
+
+    /// <summary>
+    /// Gets/sets the duration after which to timeout
+    /// </summary>
+    protected Duration? AfterValue { get; set; }
+
+    /// <inheritdoc/>
+    public virtual ITimeoutDefinitionBuilder After(string duration)
+    {
+        ArgumentException.ThrowIfNullOrWhiteSpace(duration);
+        this.AfterValue = XmlConvert.ToTimeSpan(duration);
+        return this;
+    }
+
+    /// <inheritdoc/>
+    public virtual ITimeoutDefinitionBuilder After(Duration duration)
+    {
+        ArgumentNullException.ThrowIfNull(duration);
+        this.AfterValue = duration;
+        return this;
+    }
+
+    /// <inheritdoc/>
+    public virtual TimeoutDefinition Build()
+    {
+        if (this.AfterValue == null) throw new NullReferenceException("The duration after which to timeout must be set");
+        return new()
+        {
+            After = this.AfterValue
+        };
+    }
+
+}

src/ServerlessWorkflow.Sdk.Builders/TryTaskDefinitionBuilder.cs

@@ -54,11 +54,11 @@ public override TryTaskDefinition Build()
     {
         if (this.TryTasks == null || this.TryTasks.Count < 1) throw new NullReferenceException("The task to try must be set");
         if (this.ErrorCatcher == null) throw new NullReferenceException("The catch clause must be set");
-        return new()
+        return this.Configure(new()
         {
             Try = this.TryTasks,
             Catch = this.ErrorCatcher
-        };
+        });
     }
 
 }