actions · ethanchewy · Jul 13, 2020 · Jun 18, 2020 · Jun 18, 2020 · Jun 18, 2020
diff --git a/src/Runner.Worker/ActionManager.cs b/src/Runner.Worker/ActionManager.cs
@@ -398,8 +398,10 @@ public Definition LoadAction(IExecutionContext executionContext, Pipelines.Actio
                     else if (definition.Data.Execution.ExecutionType == ActionExecutionType.Composite && !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("TESTING_COMPOSITE_ACTIONS_ALPHA")))
                     {
                         var compositeAction = definition.Data.Execution as CompositeActionExecutionData;
-                        Trace.Info($"Load {compositeAction.Steps.Count} action steps.");
-                        Trace.Verbose($"Details: {StringUtil.ConvertToJson(compositeAction.Steps)}");
+                        Trace.Info($"Load {compositeAction.Steps?.Count ?? 0} action steps.");
+                        Trace.Verbose($"Details: {StringUtil.ConvertToJson(compositeAction?.Steps)}");
+                        Trace.Info($"Load: {compositeAction.Outputs?.Count ?? 0} number of outputs");
+                        Trace.Info($"Details: {StringUtil.ConvertToJson(compositeAction?.Outputs)}");
                     }
                     else
                     {
@@ -1222,6 +1224,7 @@ public sealed class CompositeActionExecutionData : ActionExecutionData
         public override bool HasPre => false;
         public override bool HasPost => false;
         public List<Pipelines.ActionStep> Steps { get; set; }
+        public MappingToken Outputs { get; set; }
     }
 
     public abstract class ActionExecutionData

diff --git a/src/Runner.Worker/ActionManifestManager.cs b/src/Runner.Worker/ActionManifestManager.cs
@@ -23,11 +23,15 @@ public interface IActionManifestManager : IRunnerService
     {
         ActionDefinitionData Load(IExecutionContext executionContext, string manifestFile);
 
+        DictionaryContextData EvaluateCompositeOutputs(IExecutionContext executionContext, TemplateToken token, IDictionary<string, PipelineContextData> extraExpressionValues);
+
         List<string> EvaluateContainerArguments(IExecutionContext executionContext, SequenceToken token, IDictionary<string, PipelineContextData> extraExpressionValues);
 
         Dictionary<string, string> EvaluateContainerEnvironment(IExecutionContext executionContext, MappingToken token, IDictionary<string, PipelineContextData> extraExpressionValues);
 
         string EvaluateDefaultInput(IExecutionContext executionContext, string inputName, TemplateToken token);
+
+        void SetAllCompositeOutputs(IExecutionContext parentExecutionContext, DictionaryContextData actionOutputs);
     }
 
     public sealed class ActionManifestManager : RunnerService, IActionManifestManager
@@ -89,6 +93,9 @@ public ActionDefinitionData Load(IExecutionContext executionContext, string mani
                 }
 
                 var actionMapping = token.AssertMapping("action manifest root");
+                var actionOutputs = default(MappingToken);
+                var actionRunValueToken = default(TemplateToken);
+
                 foreach (var actionPair in actionMapping)
                 {
                     var propertyName = actionPair.Key.AssertString($"action.yml property key");
@@ -99,6 +106,15 @@ public ActionDefinitionData Load(IExecutionContext executionContext, string mani
                             actionDefinition.Name = actionPair.Value.AssertString("name").Value;
                             break;
 
+                        case "outputs":
+                            if (!string.IsNullOrEmpty(Environment.GetEnvironmentVariable("TESTING_COMPOSITE_ACTIONS_ALPHA")))
+                            {
+                                actionOutputs = actionPair.Value.AssertMapping("outputs");
+                                break;
+                            }
+                            Trace.Info($"Ignore action property outputs. Outputs for a whole action is not supported yet.");
+                            break;
+
                         case "description":
                             actionDefinition.Description = actionPair.Value.AssertString("description").Value;
                             break;
@@ -108,13 +124,21 @@ public ActionDefinitionData Load(IExecutionContext executionContext, string mani
                             break;
 
                         case "runs":
-                            actionDefinition.Execution = ConvertRuns(executionContext, templateContext, actionPair.Value);
+                            // Defer runs token evaluation to after for loop to ensure that order of outputs doesn't matter.
+                            actionRunValueToken = actionPair.Value;
                             break;
+
                         default:
                             Trace.Info($"Ignore action property {propertyName}.");
                             break;
                     }
                 }
+
+                // Evaluate Runs Last
+                if (actionRunValueToken != null)
+                {
+                    actionDefinition.Execution = ConvertRuns(executionContext, templateContext, actionRunValueToken, actionOutputs);
+                }
             }
             catch (Exception ex)
             {
@@ -146,6 +170,61 @@ public ActionDefinitionData Load(IExecutionContext executionContext, string mani
             return actionDefinition;
         }
 
+        public void SetAllCompositeOutputs(
+            IExecutionContext parentExecutionContext,
+            DictionaryContextData actionOutputs)
+        {
+            // Each pair is structured like this
+            // We ignore "description" for now
+            // {
+            //   "the-output-name": {
+            //     "description": "",
+            //     "value": "the value"
+            //   },
+            //   ...
+            // }
+            foreach (var pair in actionOutputs)
+            {
+                var outputsName = pair.Key;
+                var outputsAttributes = pair.Value as DictionaryContextData;
+                outputsAttributes.TryGetValue("value", out var val);
+                var outputsValue = val as StringContextData;
+
+                // Set output in the whole composite scope. 
+                if (!String.IsNullOrEmpty(outputsName) && !String.IsNullOrEmpty(outputsValue))
+                {
+                    parentExecutionContext.SetOutput(outputsName, outputsValue, out _);
+                }
+            }
+        }
+
+        public DictionaryContextData EvaluateCompositeOutputs(
+            IExecutionContext executionContext,
+            TemplateToken token,
+            IDictionary<string, PipelineContextData> extraExpressionValues)
+        {
+            var result = default(DictionaryContextData);
+
+            if (token != null)
+            {
+                var context = CreateContext(executionContext, extraExpressionValues);
+                try
+                {
+                    token = TemplateEvaluator.Evaluate(context, "outputs", token, 0, null, omitHeader: true);
+                    context.Errors.Check();
+                    result = token.ToContextData().AssertDictionary("composite outputs");
+                }
+                catch (Exception ex) when (!(ex is TemplateValidationException))
+                {
+                    context.Errors.Add(ex);
+                }
+
+                context.Errors.Check();
+            }
+
+            return result ?? new DictionaryContextData();
+        }
+
         public List<string> EvaluateContainerArguments(
             IExecutionContext executionContext,
             SequenceToken token,
@@ -309,7 +388,8 @@ private TemplateContext CreateContext(
         private ActionExecutionData ConvertRuns(
             IExecutionContext executionContext,
             TemplateContext context,
-            TemplateToken inputsToken)
+            TemplateToken inputsToken,
+            MappingToken outputs = null)
         {
             var runsMapping = inputsToken.AssertMapping("runs");
             var usingToken = default(StringToken);
@@ -439,6 +519,7 @@ private ActionExecutionData ConvertRuns(
                         return new CompositeActionExecutionData()
                         {
                             Steps = stepsLoaded,
+                            Outputs = outputs
                         };
                     }
                 }

diff --git a/src/Runner.Worker/ExecutionContext.cs b/src/Runner.Worker/ExecutionContext.cs
@@ -6,6 +6,7 @@
 using System.IO;
 using System.Linq;
 using System.Text;
+using System.Text.RegularExpressions;
 using System.Threading;
 using System.Threading.Tasks;
 using System.Web;
@@ -52,7 +53,6 @@ public interface IExecutionContext : IRunnerService
         IDictionary<String, IDictionary<String, String>> JobDefaults { get; }
         Dictionary<string, VariableValue> JobOutputs { get; }
         IDictionary<String, String> EnvironmentVariables { get; }
-        IDictionary<String, ContextScope> Scopes { get; }
         IList<String> FileTable { get; }
         StepsContext StepsContext { get; }
         DictionaryContextData ExpressionValues { get; }
@@ -70,6 +70,8 @@ public interface IExecutionContext : IRunnerService
 
         bool EchoOnActionCommand { get; set; }
 
+        IExecutionContext FinalizeContext { get; set; }
+
         // Initialize
         void InitializeJob(Pipelines.AgentJobRequestMessage message, CancellationToken token);
         void CancelToken();
@@ -105,7 +107,7 @@ public interface IExecutionContext : IRunnerService
         // others
         void ForceTaskComplete();
         void RegisterPostJobStep(IStep step);
-        void RegisterNestedStep(IStep step, DictionaryContextData inputsData, int location, Dictionary<string, string> envData);
+        IStep RegisterNestedStep(IActionRunner step, DictionaryContextData inputsData, int location, Dictionary<string, string> envData, bool cleanUp = false);
     }
 
     public sealed class ExecutionContext : RunnerService, IExecutionContext
@@ -120,6 +122,9 @@ public sealed class ExecutionContext : RunnerService, IExecutionContext
 
         private event OnMatcherChanged _onMatcherChanged;
 
+        // Regex used for checking if ScopeName meets the condition that shows that its id is null.
+        private readonly static Regex _generatedContextNamePattern = new Regex("^__[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", RegexOptions.Compiled | RegexOptions.CultureInvariant | RegexOptions.IgnoreCase);
+
         private IssueMatcherConfig[] _matchers;
 
         private IPagingLogger _logger;
@@ -149,7 +154,6 @@ public sealed class ExecutionContext : RunnerService, IExecutionContext
         public IDictionary<String, IDictionary<String, String>> JobDefaults { get; private set; }
         public Dictionary<string, VariableValue> JobOutputs { get; private set; }
         public IDictionary<String, String> EnvironmentVariables { get; private set; }
-        public IDictionary<String, ContextScope> Scopes { get; private set; }
         public IList<String> FileTable { get; private set; }
         public StepsContext StepsContext { get; private set; }
         public DictionaryContextData ExpressionValues { get; } = new DictionaryContextData();
@@ -170,6 +174,8 @@ public sealed class ExecutionContext : RunnerService, IExecutionContext
 
         public bool EchoOnActionCommand { get; set; }
 
+        public IExecutionContext FinalizeContext { get; set; }
+
         public TaskResult? Result
         {
             get
@@ -270,17 +276,36 @@ public void RegisterPostJobStep(IStep step)
         /// Helper function used in CompositeActionHandler::RunAsync to
         /// add a child node, aka a step, to the current job to the Root.JobSteps based on the location. 
         /// </summary>
-        public void RegisterNestedStep(IStep step, DictionaryContextData inputsData, int location, Dictionary<string, string> envData)
+        public IStep RegisterNestedStep(
+            IActionRunner step,
+            DictionaryContextData inputsData,
+            int location,
+            Dictionary<string, string> envData,
+            bool cleanUp = false)
         {
             // TODO: For UI purposes, look at figuring out how to condense steps in one node => maybe use the same previous GUID
             var newGuid = Guid.NewGuid();
-            step.ExecutionContext = Root.CreateChild(newGuid, step.DisplayName, newGuid.ToString("N"), null, null);
+
+            // If the context name is empty and the scope name is empty, we would generate a unique scope name for this child in the following format:
+            // "__<GUID>"
+            var safeContextName = !string.IsNullOrEmpty(ContextName) ? ContextName : $"__{newGuid}";
+
+            // Set Scope Name. Note, for our design, we consider each step in a composite action to have the same scope
+            // This makes it much simpler to handle their outputs at the end of the Composite Action
+            var childScopeName = !string.IsNullOrEmpty(ScopeName) ? $"{ScopeName}.{safeContextName}" : safeContextName;
+
+            var childContextName = !string.IsNullOrEmpty(step.Action.ContextName) ? step.Action.ContextName : $"__{Guid.NewGuid()}";
+
+            step.ExecutionContext = Root.CreateChild(newGuid, step.DisplayName, newGuid.ToString("N"), childScopeName, childContextName);
             step.ExecutionContext.ExpressionValues["inputs"] = inputsData;
 
+            // Set Parent Attribute for Clean Up Step
+            if (cleanUp)
+            {
+                step.ExecutionContext.FinalizeContext = this;
+            }
+
             // Add the composite action environment variables to each step.
-            // If the key already exists, we override it since the composite action env variables will have higher precedence
-            // Note that for each composite action step, it's environment variables will be set in the StepRunner automatically
-            // step.ExecutionContext.SetEnvironmentVariables(envData);
 #if OS_WINDOWS
             var envContext = new DictionaryContextData();
 #else
@@ -293,6 +318,8 @@ public void RegisterNestedStep(IStep step, DictionaryContextData inputsData, int
             step.ExecutionContext.ExpressionValues["env"] = envContext;
 
             Root.JobSteps.Insert(location, step);
+
+            return step;
         }
 
         public IExecutionContext CreateChild(Guid recordId, string displayName, string refName, string scopeName, string contextName, Dictionary<string, string> intraActionState = null, int? recordOrder = null)
@@ -317,7 +344,6 @@ public IExecutionContext CreateChild(Guid recordId, string displayName, string r
             }
             child.EnvironmentVariables = EnvironmentVariables;
             child.JobDefaults = JobDefaults;
-            child.Scopes = Scopes;
             child.FileTable = FileTable;
             child.StepsContext = StepsContext;
             foreach (var pair in ExpressionValues)
@@ -466,7 +492,8 @@ public void SetOutput(string name, string value, out string reference)
         {
             ArgUtil.NotNullOrEmpty(name, nameof(name));
 
-            if (String.IsNullOrEmpty(ContextName))
+            // if the ContextName follows the __GUID format which is set as the default value for ContextName if null for Composite Actions. 
+            if (String.IsNullOrEmpty(ContextName) || _generatedContextNamePattern.IsMatch(ContextName))
             {
                 reference = null;
                 return;
@@ -633,16 +660,6 @@ public void InitializeJob(Pipelines.AgentJobRequestMessage message, Cancellation
             // Steps context (StepsRunner manages adding the scoped steps context)
             StepsContext = new StepsContext();
 
-            // Scopes
-            Scopes = new Dictionary<String, ContextScope>(StringComparer.OrdinalIgnoreCase);
-            if (message.Scopes?.Count > 0)
-            {
-                foreach (var scope in message.Scopes)
-                {
-                    Scopes[scope.Name] = scope;
-                }
-            }
-
             // File table
             FileTable = new List<String>(message.FileTable ?? new string[0]);
 

diff --git a/src/Runner.Worker/Handlers/CompositeActionHandler.cs b/src/Runner.Worker/Handlers/CompositeActionHandler.cs
@@ -47,6 +47,7 @@ public Task RunAsync(ActionRunStage stage)
 
             // Add each composite action step to the front of the queue
             int location = 0;
+
             foreach (Pipelines.ActionStep aStep in actionSteps)
             {
                 // Ex: 
@@ -85,12 +86,35 @@ public Task RunAsync(ActionRunStage stage)
                 actionRunner.Condition = aStep.Condition;
                 actionRunner.DisplayName = aStep.DisplayName;
 
-                ExecutionContext.RegisterNestedStep(actionRunner, inputsData, location, Environment);
+                var step = ExecutionContext.RegisterNestedStep(actionRunner, inputsData, location, Environment);
+
+                InitializeScope(step);
+
                 location++;
             }
 
+            // Create a step that handles all the composite action steps' outputs
+            Pipelines.ActionStep cleanOutputsStep = new Pipelines.ActionStep();
+            cleanOutputsStep.ContextName = ExecutionContext.ContextName;
+            cleanOutputsStep.DisplayName = "Composite Action Steps Cleanup";
+            // Use the same reference type as our composite steps.
+            cleanOutputsStep.Reference = Action;
+
+            var actionRunner2 = HostContext.CreateService<IActionRunner>();
+            actionRunner2.Action = cleanOutputsStep;
+            actionRunner2.Stage = ActionRunStage.Main;
+            actionRunner2.Condition = "always()";
+            actionRunner2.DisplayName = "Composite Action Steps Cleanup";
+            ExecutionContext.RegisterNestedStep(actionRunner2, inputsData, location, Environment, true);
+
             return Task.CompletedTask;
         }
 
+        private void InitializeScope(IStep step)
+        {
+            var stepsContext = step.ExecutionContext.StepsContext;
+            var scopeName = step.ExecutionContext.ScopeName;
+            step.ExecutionContext.ExpressionValues["steps"] = stepsContext.GetScope(scopeName);
+        }
     }
 }