Add data model for DotNetListPackage result

Author: Marusyk

src/Cake.Common.Tests/Fixtures/Tools/DotNet/Package/List/DotNetPackageListerFixture.cs

@@ -9,11 +9,41 @@ namespace Cake.Common.Tests.Fixtures.Tools.DotNet.Package.List
     internal sealed class DotNetPackageListerFixture : DotNetFixture<DotNetPackageListSettings>
     {
         public string Project { get; set; }
+        public DotNetPackageList Result { get; set; }
+
+        public void GivenPackgeListResult()
+        {
+            ProcessRunner.Process.SetStandardOutput(new string[]
+            {
+                "{",
+                "  \"version\": 1,",
+                "  \"parameters\": \"\",",
+                "  \"projects\": [",
+                "    {",
+                "      \"path\": \"src/lib/MyProject.csproj\",",
+                "      \"frameworks\": [",
+                "        {",
+                "          \"framework\": \"netstandard2.0\",",
+                "          \"topLevelPackages\": [",
+                "            {",
+                "              \"id\": \"NETStandard.Library\",",
+                "              \"requestedVersion\": \"[2.0.3, )\",",
+                "              \"resolvedVersion\": \"2.0.3\",",
+                "              \"autoReferenced\": \"true\"",
+                "            }",
+                "          ]",
+                "        }",
+                "      ]",
+                "    }",
+                "  ]",
+                "}"
+            });
+        }
 
         protected override void RunTool()
         {
             var tool = new DotNetPackageLister(FileSystem, Environment, ProcessRunner, Tools);
-            tool.List(Project, Settings);
+            Result = tool.List(Project, Settings);
         }
     }
 }

src/Cake.Common.Tests/Unit/Tools/DotNet/Package/List/DotNetPackageListerTests.cs

@@ -4,7 +4,6 @@
 
 using Cake.Common.Tests.Fixtures.Tools.DotNet.Package.List;
 using Cake.Common.Tools.DotNet;
-using Cake.Common.Tools.DotNet.Package.List;
 using Cake.Testing;
 using Xunit;
 
@@ -88,8 +87,6 @@ public void Should_Add_Additional_Arguments()
                 fixture.Settings.Source.Add("http://www.nuget.org/api/v2/package");
                 fixture.Settings.Source.Add("http://www.symbolserver.org/");
                 fixture.Settings.Vulnerable = true;
-                fixture.Settings.Format = DotNetPackageListFormat.Json;
-                fixture.Settings.OutputVersion = 1;
                 fixture.Settings.Verbosity = DotNetVerbosity.Diagnostic;
 
                 // When
@@ -100,6 +97,21 @@ public void Should_Add_Additional_Arguments()
                 expected += "--source \"http://www.nuget.org/api/v2/package\" --source \"http://www.symbolserver.org/\" --vulnerable --format Json --output-version 1 --verbosity diagnostic";
                 Assert.Equal(expected, result.Args);
             }
+
+            [Fact]
+            public void Should_Return_Correct_Result()
+            {
+                // Given
+                var fixture = new DotNetPackageListerFixture();
+                fixture.GivenPackgeListResult();
+
+                // When
+                var result = fixture.Run();
+
+                // Then
+                Assert.Equal(1, fixture.Result.Version);
+                Assert.Contains(fixture.Result.Projects, item => item.Path == "src/lib/MyProject.csproj");
+            }
         }
     }
 }

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

@@ -2391,35 +2391,37 @@ public static void DotNetAddPackage(this ICakeContext context, string packageNam
         /// Lists the package references for a project or solution.
         /// </summary>
         /// <param name="context">The context.</param>
+        /// <returns>The the package references.</returns>
         /// <example>
         /// <code>
-        /// DotNetListPackage();
+        /// DotNetPackageList output = DotNetListPackage();
         /// </code>
         /// </example>
         [CakeMethodAlias]
         [CakeAliasCategory("Package")]
         [CakeNamespaceImport("Cake.Common.Tools.DotNet.Package.List")]
-        public static void DotNetListPackage(this ICakeContext context)
+        public static DotNetPackageList DotNetListPackage(this ICakeContext context)
         {
-            context.DotNetListPackage(null);
+            return context.DotNetListPackage(null);
         }
 
         /// <summary>
         /// Lists the package references for a project or solution.
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="project">The project or solution file to operate on. If not specified, the command searches the current directory for one. If more than one solution or project is found, an error is thrown.</param>
+        /// <returns>The the package references.</returns>
         /// <example>
         /// <code>
-        /// DotNetListPackage("./src/MyProject/MyProject.csproj");
+        /// DotNetPackageList output = DotNetListPackage("./src/MyProject/MyProject.csproj");
         /// </code>
         /// </example>
         [CakeMethodAlias]
         [CakeAliasCategory("Package")]
         [CakeNamespaceImport("Cake.Common.Tools.DotNet.Package.List")]
-        public static void DotNetListPackage(this ICakeContext context, string project)
+        public static DotNetPackageList DotNetListPackage(this ICakeContext context, string project)
         {
-            context.DotNetListPackage(project, null);
+            return context.DotNetListPackage(project, null);
         }
 
         /// <summary>
@@ -2428,6 +2430,7 @@ public static void DotNetListPackage(this ICakeContext context, string project)
         /// <param name="context">The context.</param>
         /// <param name="project">The project or solution file to operate on. If not specified, the command searches the current directory for one. If more than one solution or project is found, an error is thrown.</param>
         /// <param name="settings">The settings.</param>
+        /// <returns>The the package references.</returns>
         /// <example>
         /// <code>
         /// var settings = new DotNetPackageListSettings
@@ -2436,13 +2439,13 @@ public static void DotNetListPackage(this ICakeContext context, string project)
         ///     Format = DotNetPackageListFormat.Json
         /// };
         ///
-        /// DotNetListPackage("./src/MyProject/MyProject.csproj", settings);
+        /// DotNetPackageList output = DotNetListPackage("./src/MyProject/MyProject.csproj", settings);
         /// </code>
         /// </example>
         [CakeMethodAlias]
         [CakeAliasCategory("Package")]
         [CakeNamespaceImport("Cake.Common.Tools.DotNet.Package.List")]
-        public static void DotNetListPackage(this ICakeContext context, string project, DotNetPackageListSettings settings)
+        public static DotNetPackageList DotNetListPackage(this ICakeContext context, string project, DotNetPackageListSettings settings)
         {
             if (context is null)
             {
@@ -2454,8 +2457,8 @@ public static void DotNetListPackage(this ICakeContext context, string project,
                 settings = new DotNetPackageListSettings();
             }
 
-            var adder = new DotNetPackageLister(context.FileSystem, context.Environment, context.ProcessRunner, context.Tools);
-            adder.List(project, settings);
+            var lister = new DotNetPackageLister(context.FileSystem, context.Environment, context.ProcessRunner, context.Tools);
+            return lister.List(project, settings);
         }
     }
 }

src/Cake.Common/Tools/DotNet/Package/List/DotNetPackageList.cs

@@ -0,0 +1,45 @@
+// 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 System.Text.Json.Serialization;
+
+namespace Cake.Common.Tools.DotNet.Package.List
+{
+    /// <summary>
+    /// An result as returned by <see cref="DotNetPackageLister"/>.
+    /// </summary>
+    public sealed class DotNetPackageList
+    {
+        /// <summary>
+        /// Gets the output version.
+        /// </summary>
+        [JsonInclude]
+        public int Version { get; private set; }
+
+        /// <summary>
+        /// Gets the specified parameters.
+        /// </summary>
+        [JsonInclude]
+        public string Parameters { get; private set; }
+
+        /// <summary>
+        /// Gets the problems.
+        /// </summary>
+        [JsonInclude]
+        public IEnumerable<DotNetPackageListProblemItem> Problems { get; private set; }
+
+        /// <summary>
+        /// Gets the used sources.
+        /// </summary>
+        [JsonInclude]
+        public IEnumerable<string> Sources { get; private set; }
+
+        /// <summary>
+        /// Gets the projects.
+        /// </summary>
+        [JsonInclude]
+        public IEnumerable<DotNetPackageListProjectItem> Projects { get; private set; }
+    }
+}

src/Cake.Common/Tools/DotNet/Package/List/DotNetPackageListAlternativePackageItem.cs

@@ -0,0 +1,26 @@
+// 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.Text.Json.Serialization;
+
+namespace Cake.Common.Tools.DotNet.Package.List
+{
+    /// <summary>
+    /// The alternative package information.
+    /// </summary>
+    public sealed class DotNetPackageListAlternativePackageItem
+    {
+        /// <summary>
+        /// Gets the alternative package id.
+        /// </summary>
+        [JsonInclude]
+        public string Id { get; private set; }
+
+        /// <summary>
+        /// Gets the alternative package versions.
+        /// </summary>
+        [JsonInclude]
+        public string VersionRange { get; private set; }
+    }
+}

src/Cake.Common/Tools/DotNet/Package/List/DotNetPackageListFrameworkItem.cs

@@ -0,0 +1,33 @@
+// 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 System.Text.Json.Serialization;
+
+namespace Cake.Common.Tools.DotNet.Package.List
+{
+    /// <summary>
+    /// The framework information.
+    /// </summary>
+    public sealed class DotNetPackageListFrameworkItem
+    {
+        /// <summary>
+        /// Gets the framework name.
+        /// </summary>
+        [JsonInclude]
+        public string Framework { get; private set; }
+
+        /// <summary>
+        /// Gets the top-level packages.
+        /// </summary>
+        [JsonInclude]
+        public IEnumerable<DotNetPackageListPackageItem> TopLevelPackages { get; private set; }
+
+        /// <summary>
+        /// Gets transitive packages.
+        /// </summary>
+        [JsonInclude]
+        public IEnumerable<DotNetPackageListPackageItem> TransitivePackages { get; private set; }
+    }
+}

src/Cake.Common/Tools/DotNet/Package/List/DotNetPackageListPackageItem.cs

@@ -0,0 +1,63 @@
+// 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 System.Text.Json.Serialization;
+
+namespace Cake.Common.Tools.DotNet.Package.List
+{
+    /// <summary>
+    /// The package information.
+    /// </summary>
+    public sealed class DotNetPackageListPackageItem
+    {
+        /// <summary>
+        /// Gets the package id.
+        /// </summary>
+        [JsonInclude]
+        public string Id { get; private set; }
+
+        /// <summary>
+        /// Gets the requested version.
+        /// </summary>
+        [JsonInclude]
+        public string RequestedVersion { get; private set; }
+
+        /// <summary>
+        /// Gets the resolved version.
+        /// </summary>
+        [JsonInclude]
+        public string ResolvedVersion { get; private set; }
+
+        /// <summary>
+        /// Gets a value indicating whether the package is auto-referenced.
+        /// </summary>
+        [JsonInclude]
+        public string AutoReferenced { get; private set; }
+
+        /// <summary>
+        /// Gets the latest version.
+        /// </summary>
+        [JsonInclude]
+        public string LatestVersion { get; private set; }
+
+        /// <summary>
+        /// Gets the deprecation reasons.
+        /// </summary>
+        [JsonInclude]
+        public IEnumerable<string> DeprecationReasons { get; private set; }
+
+        /// <summary>
+        /// Gets the alternative package.
+        /// </summary>
+        [JsonInclude]
+        public DotNetPackageListAlternativePackageItem AlternativePackage { get; private set; }
+
+        /// <summary>
+        /// Gets the vulnerabilities list.
+        /// </summary>
+        [JsonInclude]
+        public IEnumerable<DotNetPackageListVulnerabilityItem> Vulnerabilities { get; private set; }
+    }
+}

src/Cake.Common/Tools/DotNet/Package/List/DotNetPackageListProblemItem.cs

@@ -0,0 +1,32 @@
+// 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.Text.Json.Serialization;
+
+namespace Cake.Common.Tools.DotNet.Package.List
+{
+    /// <summary>
+    /// The problem information.
+    /// </summary>
+    public sealed class DotNetPackageListProblemItem
+    {
+        /// <summary>
+        /// Gets the problem level.
+        /// </summary>
+        [JsonInclude]
+        public DotNetPackageListProblemType? Level { get; private set; }
+
+        /// <summary>
+        /// Gets the problem text.
+        /// </summary>
+        [JsonInclude]
+        public string Text { get; private set; }
+
+        /// <summary>
+        /// Gets the project path.
+        /// </summary>
+        [JsonInclude]
+        public string Project { get; private set; }
+    }
+}

src/Cake.Common/Tools/DotNet/Package/List/DotNetPackageListFormat.cs src/Cake.Common/Tools/DotNet/Package/List/DotNetPackageListProblemType.cs

@@ -5,18 +5,18 @@
 namespace Cake.Common.Tools.DotNet.Package.List
 {
     /// <summary>
-    /// Formats of dotnet list package.
+    /// The problem types.
     /// </summary>
-    public enum DotNetPackageListFormat
+    public enum DotNetPackageListProblemType
     {
         /// <summary>
-        /// Console.
+        /// Warning.
         /// </summary>
-        Console,
+        Warning,
 
         /// <summary>
-        /// Json.
+        /// Error.
         /// </summary>
-        Json
+        Error
     }
 }