Implement new echo behavior and command (#139)

* Remove controlling echoing by command

* Add 'echo on' and 'echo off' action commands

* PR feedback and add L0 tests

* Register new command

* Eric's PR feedback

* Tweak logging a bit

* Rename EchoOnActionCommandSuccess -> EchoOnActionCommand

* More PR reaction

* Make warning messages in Action Commands not rely on context from echo commands

src/Test/L0/Worker/ActionCommandManagerL0.cs

@@ -5,6 +5,7 @@ using GitHub.DistributedTask.WebApi;
 using GitHub.Runner.Worker;
 using Moq;
 using Xunit;
+using Pipelines = GitHub.DistributedTask.Pipelines;
 
 namespace GitHub.Runner.Common.Tests.Worker
 {
@@ -146,5 +147,159 @@ namespace GitHub.Runner.Common.Tests.Worker
                 Assert.True(commandManager.TryProcessCommand(_ec.Object, "##[set-env name=foo]bar"));
             }
         }
+
+        [Fact]
+        [Trait("Level", "L0")]
+        [Trait("Category", "Worker")]
+        public void EchoProcessCommand()
+        {
+            using (TestHostContext _hc = new TestHostContext(this))
+            {
+                var extensionManager = new Mock<IExtensionManager>();
+                var echoCommand = new EchoCommandExtension();
+                echoCommand.Initialize(_hc);
+
+                extensionManager.Setup(x => x.GetExtensions<IActionCommandExtension>())
+                               .Returns(new List<IActionCommandExtension>() { echoCommand });
+                _hc.SetSingleton<IExtensionManager>(extensionManager.Object);
+
+                Mock<IExecutionContext> _ec = new Mock<IExecutionContext>();
+                _ec.Setup(x => x.Write(It.IsAny<string>(), It.IsAny<string>()))
+                   .Returns((string tag, string line) =>
+                            {
+                                _hc.GetTrace().Info($"{tag} {line}");
+                                return 1;
+                            });
+
+                _ec.SetupAllProperties();
+
+                ActionCommandManager commandManager = new ActionCommandManager();
+                commandManager.Initialize(_hc);
+
+                Assert.False(_ec.Object.EchoOnActionCommand);
+
+                Assert.True(commandManager.TryProcessCommand(_ec.Object, "::echo::on"));
+                Assert.True(_ec.Object.EchoOnActionCommand);
+
+                Assert.True(commandManager.TryProcessCommand(_ec.Object, "::echo::off"));
+                Assert.False(_ec.Object.EchoOnActionCommand);
+
+                Assert.True(commandManager.TryProcessCommand(_ec.Object, "::echo::ON"));
+                Assert.True(_ec.Object.EchoOnActionCommand);
+
+                Assert.True(commandManager.TryProcessCommand(_ec.Object, "::echo::Off   "));
+                Assert.False(_ec.Object.EchoOnActionCommand);
+            }
+        }
+
+        [Fact]
+        [Trait("Level", "L0")]
+        [Trait("Category", "Worker")]
+        public void EchoProcessCommandDebugOn()
+        {
+            using (TestHostContext _hc = new TestHostContext(this))
+            {
+                // Set up a few things
+                // 1. Job request message (with ACTIONS_STEP_DEBUG = true)
+                TaskOrchestrationPlanReference plan = new TaskOrchestrationPlanReference();
+                TimelineReference timeline = new TimelineReference();
+                JobEnvironment environment = new JobEnvironment();
+                environment.SystemConnection = new ServiceEndpoint();
+                List<TaskInstance> tasks = new List<TaskInstance>();
+                Guid JobId = Guid.NewGuid();
+                string jobName = "some job name";
+                var jobRequest = Pipelines.AgentJobRequestMessageUtil.Convert(new AgentJobRequestMessage(plan, timeline, JobId, jobName, jobName, environment, tasks));
+                jobRequest.Resources.Repositories.Add(new Pipelines.RepositoryResource()
+                {
+                    Alias = Pipelines.PipelineConstants.SelfAlias,
+                    Id = "github",
+                    Version = "sha1"
+                });
+                jobRequest.ContextData["github"] = new Pipelines.ContextData.DictionaryContextData();
+                jobRequest.Variables["ACTIONS_STEP_DEBUG"] = "true";
+
+                // Some service dependencies
+                var jobServerQueue = new Mock<IJobServerQueue>();
+                jobServerQueue.Setup(x => x.QueueTimelineRecordUpdate(It.IsAny<Guid>(), It.IsAny<TimelineRecord>()));
+
+                _hc.SetSingleton(jobServerQueue.Object);
+
+                var extensionManager = new Mock<IExtensionManager>();
+                var echoCommand = new EchoCommandExtension();
+                echoCommand.Initialize(_hc);
+
+                extensionManager.Setup(x => x.GetExtensions<IActionCommandExtension>())
+                               .Returns(new List<IActionCommandExtension>() { echoCommand });
+                _hc.SetSingleton<IExtensionManager>(extensionManager.Object);
+
+                var configurationStore = new Mock<IConfigurationStore>();
+                configurationStore.Setup(x => x.GetSettings()).Returns(new RunnerSettings());
+                _hc.SetSingleton(configurationStore.Object);
+
+                var pagingLogger = new Mock<IPagingLogger>();
+                _hc.EnqueueInstance(pagingLogger.Object);
+
+                ActionCommandManager commandManager = new ActionCommandManager();
+                commandManager.Initialize(_hc);
+
+                var _ec = new Runner.Worker.ExecutionContext();
+                _ec.Initialize(_hc);
+
+                // Initialize the job (to exercise logic that sets EchoOnActionCommand)
+                _ec.InitializeJob(jobRequest, System.Threading.CancellationToken.None);
+
+                _ec.Complete();
+
+                Assert.True(_ec.EchoOnActionCommand);
+
+                Assert.True(commandManager.TryProcessCommand(_ec, "::echo::off"));
+                Assert.False(_ec.EchoOnActionCommand);
+
+                Assert.True(commandManager.TryProcessCommand(_ec, "::echo::on"));
+                Assert.True(_ec.EchoOnActionCommand);
+            }
+        }
+
+
+        [Fact]
+        [Trait("Level", "L0")]
+        [Trait("Category", "Worker")]
+        public void EchoProcessCommandInvalid()
+        {
+            using (TestHostContext _hc = new TestHostContext(this))
+            {
+                var extensionManager = new Mock<IExtensionManager>();
+                var echoCommand = new EchoCommandExtension();
+                echoCommand.Initialize(_hc);
+
+                extensionManager.Setup(x => x.GetExtensions<IActionCommandExtension>())
+                               .Returns(new List<IActionCommandExtension>() { echoCommand });
+                _hc.SetSingleton<IExtensionManager>(extensionManager.Object);
+
+                Mock<IExecutionContext> _ec = new Mock<IExecutionContext>();
+                _ec.Setup(x => x.Write(It.IsAny<string>(), It.IsAny<string>()))
+                   .Returns((string tag, string line) =>
+                            {
+                                _hc.GetTrace().Info($"{tag} {line}");
+                                return 1;
+                            });
+
+                _ec.SetupAllProperties();
+
+                ActionCommandManager commandManager = new ActionCommandManager();
+                commandManager.Initialize(_hc);
+
+                // Echo commands below are considered "processed", but are invalid
+                // 1. Invalid echo value
+                Assert.True(commandManager.TryProcessCommand(_ec.Object, "::echo::invalid"));
+                Assert.Equal(TaskResult.Failed, _ec.Object.CommandResult);
+                Assert.False(_ec.Object.EchoOnActionCommand);
+
+                // 2. No value
+                Assert.True(commandManager.TryProcessCommand(_ec.Object, "::echo::"));
+                Assert.Equal(TaskResult.Failed, _ec.Object.CommandResult);
+                Assert.False(_ec.Object.EchoOnActionCommand);
+            }
+        }
     }
 }