Merge pull request #39 from Microsoft/users/kasubram/runasasync

Not running agent interactively if its configured as runasservice

Author: Kalyan-microsoft

src/Agent.Listener/Agent.cs

@@ -103,17 +103,37 @@ public async Task<int> ExecuteCommand(CommandLineParser parser)
 
                 if (parser.IsCommand("run") && !configManager.IsConfigured())
                 {
-                    throw new InvalidOperationException("Cannot run.  Must configure first.");
+                    throw new InvalidOperationException("CanNotRunAgent");
                 }
 
                 Trace.Info("Done evaluating commands");
+                bool alreadyConfigured = configManager.IsConfigured();
                 await configManager.EnsureConfiguredAsync();
 
                 _inConfigStage = false;
 
-                // TODO: If configured as runasservice return from here
-            
-                return await RunAsync(TokenSource.Token);
+                AgentSettings settings = configManager.LoadSettings();
+                if (parser.IsCommand("run") || !settings.RunAsService)
+                {
+                    // Run the agent interactively
+                    Trace.Verbose(
+                        StringUtil.Format(
+                            "Run command mentioned: {0}, run as service option mentioned:{1}",
+                            parser.IsCommand("run"),
+                            settings.RunAsService));
+
+                    return await RunAsync(TokenSource.Token, settings);
+                }
+
+                if (alreadyConfigured)
+                {
+                    // This is helpful if the user tries to start the agent.listener which is already configured or running as service
+                    // However user can execute the agent by calling the run command
+                    // TODO: Should we check if the service is running and prompt user to start the service if its not already running?
+                    _term.WriteLine(StringUtil.Loc("ConfiguredAsRunAsService", settings.ServiceName));
+                }
+
+                return 0;
             }
             finally
             {
@@ -127,13 +147,11 @@ void CtrlCHandler(object sender, EventArgs e)
         }
 
         //create worker manager, create message listener and start listening to the queue
-        private async Task<int> RunAsync(CancellationToken token)
+        private async Task<int> RunAsync(CancellationToken token, AgentSettings settings)
         {
             Trace.Info(nameof(RunAsync));
 
             // Load the settings.
-            var configManager = HostContext.GetService<IConfigurationManager>();
-            AgentSettings settings = configManager.LoadSettings();
             _poolId = settings.PoolId;
 
             var listener = HostContext.GetService<IMessageListener>();

src/Agent.Listener/Configuration/ConfigurationManager.cs

@@ -2,10 +2,11 @@
 using Microsoft.VisualStudio.Services.Agent.Util;
 using Microsoft.VisualStudio.Services.Client;
 using Microsoft.VisualStudio.Services.Common;
+
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Threading;
+using System.Linq;
 using System.Threading.Tasks;
 
 namespace Microsoft.VisualStudio.Services.Agent.Listener.Configuration
@@ -127,6 +128,7 @@ public async Task ConfigureAsync(Dictionary<string, string> args, HashSet<string
             Trace.Info("Read agent settings");
             var consoleWizard = HostContext.GetService<IConsoleWizard>();
 
+            // TODO: Check if its running with elevated permission and stop early if its not
             //
             // Loop getting url and creds until you can connect
             //
@@ -221,9 +223,7 @@ public async Task ConfigureAsync(Dictionary<string, string> args, HashSet<string
                 agentName = consoleWizard.ReadValue(CliArgs.Agent,
                                                 StringUtil.Loc("AgentName"),
                                                 false,
-                                                // TODO: coreCLR doesn't expose till very recently (Jan 15)
-                                                // Environment.MachineName,
-                                                "myagent",
+                                                Environment.MachineName ?? "myagent",
                                                 // can do better
                                                 Validators.NonEmptyValidator,
                                                 args,

src/Agent.Listener/Configuration/WindowsServiceControlManager.cs

@@ -192,7 +192,7 @@ public override void StopService(string serviceName)
             catch (Exception exception)
             {
                 Trace.Error(exception);
-                _term.WriteError(StringUtil.Loc("CanNotStopService"));
+                _term.WriteError(StringUtil.Loc("CanNotStopService", serviceName));
 
                 // Log the exception but do not report it as error. We can try uninstalling the service and then report it as error if something goes wrong.
             }

src/Misc/layoutbin/en-US/strings.json

@@ -27,12 +27,14 @@
   "CanNotFindSystemd": "Can not find if systemd is installed",
   "CanNotGrantPermission": "Can not grant LogonAsService permission to the user {0}",
   "CanNotInstallService": "Can not install the service, check the logs for more details ",
+  "CanNotRunAgent": "Cannot run. Must configure first",
   "CanNotSetPermissionForAccount": "Can not set permission for service account, check the logs for more details",
   "CanNotStartService": "Can not start the service, check the logs for more details",
   "CanNotStopService": "Can not stop the service {0} in a timely fashion, please stop the service and reconfigure again",
   "CanNotVerifyLogonAccountPassword": "Can not verify if the password entered is valid",
   "Cleanup": "Post Job Clean Up",
   "CommandNotFound": "Can't find command extension for ##vso[{0}.command]. TODO: DOC aka link",
+  "ConfiguredAsRunAsService": "Agent is configured to run as service {0}",
   "ConnectingToServer": "Connecting to server ...",
   "CouldNotRemoveService": "Could not delete service {0}",
   "CustomLogDoesNotExist": "Log file path is not provided or file doesn't exist: '{data}'",

src/Test/L0/Listener/AgentL0.cs

@@ -8,6 +8,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Xunit;
+using Xunit.Extensions;
 
 namespace Microsoft.VisualStudio.Services.Agent.Tests.Listener
 {
@@ -17,13 +18,15 @@ public sealed class AgentL0
         private Mock<IMessageListener> _messageListener;
         private Mock<IWorkerManager> _workerManager;
         private Mock<IAgentServer> _agentServer;
+        private Mock<ITerminal> _term;
 
         public AgentL0()
         {
             _configurationManager = new Mock<IConfigurationManager>();
             _messageListener = new Mock<IMessageListener>();
             _workerManager = new Mock<IWorkerManager>();
             _agentServer = new Mock<IAgentServer>();            
+            _term = new Mock<ITerminal>();
         }
 
         private JobRequestMessage CreateJobRequestMessage(string jobName)
@@ -53,7 +56,7 @@ public async void TestRunAsync()
             using (var tokenSource = new CancellationTokenSource())
             {
                 //Arrange
-                var agent = new Microsoft.VisualStudio.Services.Agent.Listener.Agent();
+                var agent = new Agent.Listener.Agent();
                 agent.TokenSource = tokenSource;
                 hc.SetSingleton<IConfigurationManager>(_configurationManager.Object);
                 hc.SetSingleton<IMessageListener>(_messageListener.Object);
@@ -171,5 +174,43 @@ public async void TestRunAsync()
                 }
             }
         }
+
+        public static TheoryData<string[], bool, Times> RunAsServiceTestData = new TheoryData<string[], bool, Times>()
+                                                                    {
+                                                                        // staring with run command, configured as run as service, should start the agent
+                                                                        { new [] { "run" }, true, Times.Once() },
+                                                                        // starting with no argument, configured as run as service, should not start agent
+                                                                        { new string[] { }, true, Times.Never() },
+                                                                        // starting with no argument, configured not to run as service, should start agent interactively
+                                                                        { new string[] { }, false, Times.Once() }
+                                                                    };
+        [Theory]
+        [MemberData("RunAsServiceTestData")]
+        [Trait("Level", "L0")]
+        [Trait("Category", "Agent")]
+        public async void TestExecuteCommandForRunAsService(string[] args, bool configureAsService, Times expectedTimes)
+        {
+            using (var hc = new TestHostContext(this))
+            {
+                hc.SetSingleton<IConfigurationManager>(_configurationManager.Object);
+                hc.SetSingleton<IMessageListener>(_messageListener.Object);
+
+                CommandLineParser clp = new CommandLineParser(hc);
+                clp.Parse(args);
+
+                _configurationManager.Setup(x => x.IsConfigured()).Returns(true);
+                _configurationManager.Setup(x => x.LoadSettings())
+                    .Returns(new AgentSettings { RunAsService = configureAsService });
+                _messageListener.Setup(x => x.CreateSessionAsync(It.IsAny<CancellationToken>()))
+                    .Returns(Task.FromResult(false));
+
+                var agent = new Agent.Listener.Agent();
+                agent.Initialize(hc);
+                agent.TokenSource = new CancellationTokenSource();
+                await agent.ExecuteCommand(clp);
+
+                _messageListener.Verify(x => x.CreateSessionAsync(It.IsAny<CancellationToken>()), expectedTimes);
+            }
+        }
     }
 }