Merge pull request #4388 from Marusyk/rmarusyk/3817

Add DotNetSlnList alias for dotnet sln list command

src/Cake.Common.Tests/Fixtures/Tools/DotNet/Sln/List/DotNetSlnListerFixture.cs

@@ -0,0 +1,44 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Collections.Generic;
+using Cake.Common.Tools.DotNet.Sln.List;
+
+namespace Cake.Common.Tests.Fixtures.Tools.DotNet.Sln.List
+{
+    internal sealed class DotNetSlnListerFixture : DotNetFixture<DotNetSlnListSettings>
+    {
+        public string Solution { get; set; }
+
+        public string StandardError { get; set; }
+
+        public IEnumerable<string> Projects { get; private set; }
+
+        public void GivenProjectsResult()
+        {
+            ProcessRunner.Process.SetStandardOutput(new string[]
+            {
+                "Project(s)",
+                "--------------------",
+                "Common\\Common.AspNetCore\\Common.AspNetCore.csproj",
+                "Common\\Common.Messaging\\Common.Messaging.csproj",
+                "Common\\Common.Utilities\\Common.Utilities.csproj"
+            });
+        }
+
+        public void GivenErrorResult()
+        {
+            ProcessRunner.Process.SetStandardError(new string[]
+            {
+                StandardError
+            });
+        }
+
+        protected override void RunTool()
+        {
+            var tool = new DotNetSlnLister(FileSystem, Environment, ProcessRunner, Tools);
+            Projects = tool.List(Solution, Settings);
+        }
+    }
+}

src/Cake.Common.Tests/Unit/Tools/DotNet/Sln/List/DotNetSlnListerTests.cs

@@ -0,0 +1,147 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using Cake.Common.Tests.Fixtures.Tools.DotNet.Sln.List;
+using Cake.Common.Tools.DotNet;
+using Cake.Testing;
+using Xunit;
+
+namespace Cake.Common.Tests.Unit.Tools.DotNet.Sln.List
+{
+    public sealed class DotNetSlnListerTests
+    {
+        public sealed class TheListMethod
+        {
+            [Fact]
+            public void Should_Throw_If_Process_Was_Not_Started()
+            {
+                // Given
+                var fixture = new DotNetSlnListerFixture();
+                fixture.GivenProcessCannotStart();
+
+                // When
+                var result = Record.Exception(() => fixture.Run());
+
+                // Then
+                AssertEx.IsCakeException(result, ".NET CLI: Process was not started.");
+            }
+
+            [Fact]
+            public void Should_Throw_If_Process_Has_A_Non_Zero_Exit_Code()
+            {
+                // Given
+                var fixture = new DotNetSlnListerFixture();
+                fixture.GivenProcessExitsWithCode(1);
+
+                // When
+                var result = Record.Exception(() => fixture.Run());
+
+                // Then
+                AssertEx.IsCakeException(result, ".NET CLI: Process returned an error (exit code 1).");
+            }
+
+            [Fact]
+            public void Should_Throw_If_Settings_Are_Null()
+            {
+                // Given
+                var fixture = new DotNetSlnListerFixture();
+                fixture.Settings = null;
+                fixture.GivenDefaultToolDoNotExist();
+
+                // When
+                var result = Record.Exception(() => fixture.Run());
+
+                // Then
+                AssertEx.IsArgumentNullException(result, "settings");
+            }
+
+            [Fact]
+            public void Should_Not_Add_Solution_Argument()
+            {
+                // Given
+                var fixture = new DotNetSlnListerFixture();
+                fixture.Solution = null;
+
+                // When
+                var result = fixture.Run();
+
+                // Then
+                Assert.Equal("sln list", result.Args);
+            }
+
+            [Fact]
+            public void Should_Add_Solution_Argument()
+            {
+                // Given
+                var fixture = new DotNetSlnListerFixture();
+                fixture.Solution = "ToDo.sln";
+
+                // When
+                var result = fixture.Run();
+
+                // Then
+                Assert.Equal("sln \"/Working/ToDo.sln\" list", result.Args);
+            }
+
+            [Fact]
+            public void Should_Add_Additional_Arguments()
+            {
+                // Given
+                var fixture = new DotNetSlnListerFixture();
+                fixture.Solution = "ToDo.sln";
+                fixture.Settings.Verbosity = DotNetVerbosity.Diagnostic;
+
+                // When
+                var result = fixture.Run();
+
+                // Then
+                var expected = "sln \"/Working/ToDo.sln\" list --verbosity diagnostic";
+                Assert.Equal(expected, result.Args);
+            }
+
+            [Fact]
+            public void Should_Return_Correct_List_Of_Projects()
+            {
+                // Given
+                var fixture = new DotNetSlnListerFixture();
+                fixture.GivenProjectsResult();
+
+                // When
+                var result = fixture.Run();
+
+                // Then
+                Assert.Collection(fixture.Projects,
+                    item =>
+                    {
+                        Assert.Equal(item, "Common\\Common.AspNetCore\\Common.AspNetCore.csproj");
+                    },
+                    item =>
+                    {
+                        Assert.Equal(item, "Common\\Common.Messaging\\Common.Messaging.csproj");
+                    },
+                    item =>
+                    {
+                        Assert.Equal(item, "Common\\Common.Utilities\\Common.Utilities.csproj");
+                    });
+            }
+
+            [Fact]
+            public void Should_Return_StandardError_ExitCode()
+            {
+                const string expectedStandardError = "Specified solution file C:\\Cake\\Cake.Core\\ does not exist, or there is no solution file in the directory.";
+
+                // Given
+                var fixture = new DotNetSlnListerFixture();
+                fixture.StandardError = expectedStandardError;
+                fixture.GivenErrorResult();
+
+                // When
+                fixture.Run();
+
+                // Then
+                Assert.Equal(expectedStandardError, fixture.StandardError);
+            }
+        }
+    }
+}

src/Cake.Common/Tools/DotNet/DotNetAliases.cs

@@ -26,6 +26,7 @@
 using Cake.Common.Tools.DotNet.Restore;
 using Cake.Common.Tools.DotNet.Run;
 using Cake.Common.Tools.DotNet.SDKCheck;
+using Cake.Common.Tools.DotNet.Sln.List;
 using Cake.Common.Tools.DotNet.Test;
 using Cake.Common.Tools.DotNet.Tool;
 using Cake.Common.Tools.DotNet.VSTest;
@@ -2883,5 +2884,93 @@ public static DotNetPackageList DotNetListPackage(this ICakeContext context, str
             var lister = new DotNetPackageLister(context.FileSystem, context.Environment, context.ProcessRunner, context.Tools);
             return lister.List(project, settings);
         }
+
+        /// <summary>
+        /// Lists all projects in a solution file.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <returns>The list of projects.</returns>
+        /// <example>
+        /// <code>
+        /// var projects = DotNetSlnList();
+        ///
+        /// foreach (var project in projects)
+        /// {
+        ///      Information(project);
+        /// }
+        /// </code>
+        /// </example>
+        [CakeMethodAlias]
+        [CakeAliasCategory("Sln")]
+        [CakeNamespaceImport("Cake.Common.Tools.DotNet.Sln.List")]
+        public static IEnumerable<string> DotNetSlnList(this ICakeContext context)
+        {
+            return context.DotNetSlnList(null);
+        }
+
+        /// <summary>
+        /// Lists all projects in a solution file.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <param name="solution">The solution file to use. If this argument is omitted, the command searches the current directory for one. If it finds no solution file or multiple solution files, the command fails.</param>
+        /// <returns>The list of projects.</returns>
+        /// <example>
+        /// <code>
+        /// var projects = DotNetSlnList("./app/app.sln");
+        ///
+        /// foreach (var project in projects)
+        /// {
+        ///      Information(project);
+        /// }
+        /// </code>
+        /// </example>
+        [CakeMethodAlias]
+        [CakeAliasCategory("Sln")]
+        [CakeNamespaceImport("Cake.Common.Tools.DotNet.Sln.List")]
+        public static IEnumerable<string> DotNetSlnList(this ICakeContext context, FilePath solution)
+        {
+            return context.DotNetSlnList(solution, null);
+        }
+
+        /// <summary>
+        /// Lists all projects in a solution file.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <param name="solution">The solution file to use. If this argument is omitted, the command searches the current directory for one. If it finds no solution file or multiple solution files, the command fails.</param>
+        /// <param name="settings">The settings.</param>
+        /// <returns>The list of projects.</returns>
+        /// <example>
+        /// <code>
+        /// var settings = new DotNetSlnListSettings
+        /// {
+        ///     Verbosity = DotNetVerbosity.Diagnostic
+        /// };
+        ///
+        /// var projects = DotNetSlnList("./app/app.sln");
+        ///
+        /// foreach (var project in projects)
+        /// {
+        ///      Information(project);
+        /// }
+        /// </code>
+        /// </example>
+        [CakeMethodAlias]
+        [CakeAliasCategory("Sln")]
+        [CakeNamespaceImport("Cake.Common.Tools.DotNet.Sln.List")]
+        public static IEnumerable<string> DotNetSlnList(this ICakeContext context, FilePath solution, DotNetSlnListSettings settings)
+        {
+            if (context is null)
+            {
+                throw new ArgumentNullException(nameof(context));
+            }
+
+            if (settings is null)
+            {
+                settings = new DotNetSlnListSettings();
+            }
+
+            var lister = new DotNetSlnLister(context.FileSystem, context.Environment, context.ProcessRunner, context.Tools);
+            return lister.List(solution, settings);
+        }
     }
 }

src/Cake.Common/Tools/DotNet/Sln/List/DotNetSlnListSettings.cs

@@ -0,0 +1,13 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+namespace Cake.Common.Tools.DotNet.Sln.List
+{
+    /// <summary>
+    /// Contains settings used by <see cref="DotNetSlnLister" />.
+    /// </summary>
+    public sealed class DotNetSlnListSettings : DotNetSettings
+    {
+    }
+}