Add pwsh agent capability detection

Author: MJECloud

src/Microsoft.VisualStudio.Services.Agent/Capabilities/PwshCapabilitiesProvider.cs

@@ -0,0 +1,36 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.VisualStudio.Services.Agent.Util;
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Microsoft.VisualStudio.Services.Agent.Capabilities
+{
+    public sealed class PwshCapabilitiesProvider : AgentService, ICapabilitiesProvider
+    {
+        public Type ExtensionType => typeof(ICapabilitiesProvider);
+
+        public int Order => 2;
+
+        public Task<List<Capability>> GetCapabilitiesAsync(AgentSettings settings, CancellationToken cancellationToken)
+        {
+            Trace.Entering();
+            var capabilities = new List<Capability>();
+
+            try
+            {
+                string pwsh = HostContext.GetService<IPwshExeUtil>().GetPath();
+                capabilities.Add(new Capability("Pwsh", pwsh));
+            }
+            catch (Exception ex)
+            {
+                Trace.Info($"Pwsh capability not detected: {ex.Message}");
+            }
+
+            return Task.FromResult(capabilities);
+        }
+    }
+}

src/Microsoft.VisualStudio.Services.Agent/ExtensionManager.cs

@@ -46,6 +46,7 @@ private List<IExtension> LoadExtensions<T>() where T : class, IExtension
                 case "Microsoft.VisualStudio.Services.Agent.Capabilities.ICapabilitiesProvider":
                     Add<T>(extensions, "Microsoft.VisualStudio.Services.Agent.Capabilities.AgentCapabilitiesProvider, Microsoft.VisualStudio.Services.Agent");
                     Add<T>(extensions, "Microsoft.VisualStudio.Services.Agent.Capabilities.EnvironmentCapabilitiesProvider, Microsoft.VisualStudio.Services.Agent");
+                    Add<T>(extensions, "Microsoft.VisualStudio.Services.Agent.Capabilities.PwshCapabilitiesProvider, Microsoft.VisualStudio.Services.Agent");
                     if (PlatformUtil.RunningOnLinux || PlatformUtil.RunningOnMacOS)
                     {
                         Add<T>(extensions, "Microsoft.VisualStudio.Services.Agent.Capabilities.NixCapabilitiesProvider, Microsoft.VisualStudio.Services.Agent");
@@ -145,4 +146,4 @@ private void Add<T>(List<IExtension> extensions, string assemblyQualifiedName) w
             extensions.Add(extension);
         }
     }
-}
+}

src/Test/L0/ExtensionManagerL0.cs

@@ -48,6 +48,9 @@ public void LoadsTypes()
                 AssertContains<Microsoft.VisualStudio.Services.Agent.Capabilities.ICapabilitiesProvider>(
                     manager,
                     concreteType: typeof(Microsoft.VisualStudio.Services.Agent.Capabilities.AgentCapabilitiesProvider));
+                AssertContains<Microsoft.VisualStudio.Services.Agent.Capabilities.ICapabilitiesProvider>(
+                    manager,
+                    concreteType: typeof(Microsoft.VisualStudio.Services.Agent.Capabilities.PwshCapabilitiesProvider));
                 AssertContains<Microsoft.VisualStudio.Services.Agent.Worker.IJobExtension>(
                     manager,
                     concreteType: typeof(Microsoft.VisualStudio.Services.Agent.Worker.Build.BuildJobExtension));

src/Test/L0/Listener/Configuration/PwshCapabilitiesProviderTestL0.cs

@@ -0,0 +1,60 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.VisualStudio.Services.Agent.Capabilities;
+using Microsoft.VisualStudio.Services.Agent.Util;
+using Moq;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Xunit;
+
+namespace Microsoft.VisualStudio.Services.Agent.Tests.Listener
+{
+    public sealed class PwshCapabilitiesProviderTestL0
+    {
+        [Fact]
+        [Trait("Level", "L0")]
+        [Trait("Category", "Agent")]
+        public async Task AddsPwshCapabilityWhenPwshExists()
+        {
+            using var hc = new TestHostContext(this);
+            using var tokenSource = new CancellationTokenSource();
+
+            var pwshUtil = new Mock<IPwshExeUtil>();
+            pwshUtil.Setup(x => x.GetPath()).Returns("/usr/bin/pwsh");
+            hc.SetSingleton<IPwshExeUtil>(pwshUtil.Object);
+
+            var provider = new PwshCapabilitiesProvider();
+            provider.Initialize(hc);
+
+            List<Capability> capabilities = await provider.GetCapabilitiesAsync(new AgentSettings(), tokenSource.Token);
+
+            Capability pwshCapability = capabilities.SingleOrDefault(x => string.Equals(x.Name, "Pwsh", StringComparison.Ordinal));
+            Assert.NotNull(pwshCapability);
+            Assert.Equal("/usr/bin/pwsh", pwshCapability.Value);
+        }
+
+        [Fact]
+        [Trait("Level", "L0")]
+        [Trait("Category", "Agent")]
+        public async Task ReturnsNoPwshCapabilityWhenPwshIsUnavailable()
+        {
+            using var hc = new TestHostContext(this);
+            using var tokenSource = new CancellationTokenSource();
+
+            var pwshUtil = new Mock<IPwshExeUtil>();
+            pwshUtil.Setup(x => x.GetPath()).Throws(new InvalidOperationException("pwsh missing"));
+            hc.SetSingleton<IPwshExeUtil>(pwshUtil.Object);
+
+            var provider = new PwshCapabilitiesProvider();
+            provider.Initialize(hc);
+
+            List<Capability> capabilities = await provider.GetCapabilitiesAsync(new AgentSettings(), tokenSource.Token);
+
+            Assert.DoesNotContain(capabilities, x => string.Equals(x.Name, "Pwsh", StringComparison.Ordinal));
+        }
+    }
+}