diff --git a/src/AzureDataFactory.TestingFramework/Models/TestFramework.cs b/src/AzureDataFactory.TestingFramework/Models/TestFramework.cs index af01b549..ea4f3e7b 100644 --- a/src/AzureDataFactory.TestingFramework/Models/TestFramework.cs +++ b/src/AzureDataFactory.TestingFramework/Models/TestFramework.cs @@ -46,7 +46,7 @@ public ActivityEnumerator EvaluateWithEnumerator(Pipeline pipeline, List /// The pipeline to evaluate. /// The global and regular parameters to be used for evaluating expressions. - /// + /// A list of evaluated pipeline activities /// Thrown if a required pipeline parameter is not required /// Thrown if a pipeline parameter is provided more than once public List EvaluateAll(Pipeline pipeline, List parameters) @@ -54,11 +54,23 @@ public List EvaluateAll(Pipeline pipeline, List return Evaluate(pipeline, parameters).ToList(); } + /// + /// Evaluates a single activity given a state. Any expression part of the activity is evaluated based on the state of the pipeline. + /// + /// The activity to evaluate + /// The state which will be used to evaluate the expressions + /// A list of evaluated pipelines, which can be more than 1 due to possible child activities. public IEnumerable Evaluate(PipelineActivity activity, PipelineRunState state) { return Evaluate(new List { activity }, state); } + /// + /// Evaluates all given activities using the provided parameters. The order of activity execution is simulated based on the dependencies. Any expression part of the activity is evaluated based on the state of the pipeline. + /// + /// The activities to evaluate + /// The state which will be used to evaluate the expressions + /// A list of evaluated pipelines public IEnumerable Evaluate(List activities, PipelineRunState state) { while (state.ScopedPipelineActivityResults.Count != activities.Count)