(#365) Update Guidelines to include Cake 5.0.0

nils-a · nils-a · commit fac56f884b19 · 2024-11-18T00:26:41.000+01:00
diff --git a/docs/input/guidelines/CakeInternalReferences.md b/docs/input/guidelines/CakeInternalReferences.md
@@ -12,6 +12,7 @@ Title: Target Frameworks
     - [Cake v2.0.0](#cake-v200)
     - [Cake v3.0.0](#cake-v300)
     - [Cake v4.0](#cake-v40)
+    - [Cake v5.0](#cake-v50)
 - [Related rules](#related-rules)
 - [Usage](#usage)
 - [Settings](#settings)
@@ -113,6 +114,31 @@ Also, the reference of the package in the addin/module should be set as private
 | System.Reflection.Metadata               | 8.0.0         |
 | xunit                                    | 2.6.1         |
 
+#### Cake v5.0
+
+| Reference                                | Version        |
+| ---------------------------------------- | -------------- |
+| Autofac                                  | 8.1.1          |
+| Microsoft.CodeAnalysis.CSharp.Scripting  | 4.12.0-3.final |
+| Microsoft.CSharp                         | 4.7.0          |
+| Microsoft.Extensions.DependencyInjection | 9.0.0          |
+| Microsoft.IdentityModel.JsonWebTokens    | 8.2.0          |
+| Microsoft.NETCore.Platforms              | 7.0.4          |
+| Microsoft.SourceLink.GitHub              | 8.0.0          |
+| Microsoft.Win32.Registry                 | 5.0.0          |
+| Newtonsoft.Json                          | 13.0.3         |
+| NuGet.Common                             | 6.11.1         |
+| NuGet.Frameworks                         | 6.11.1         |
+| NuGet.Packaging                          | 6.11.1         |
+| NuGet.Protocol                           | 6.11.1         |
+| NuGet.Resolver                           | 6.11.1         |
+| NuGet.Versioning                         | 6.11.1         |
+| StyleCop.Analyzers                       | 1.1.118        |
+| System.Collections.Immutable             | 9.0.0          |
+| System.Reflection.Metadata               | 9.0.0          |
+| System.Security.Cryptography.Pkcs        | 9.0.0          |
+| xunit                                    | 2.9.2          |
+
 ## Related rules
 
  * [CCG0010](../rules/ccg0010)
@@ -127,4 +153,4 @@ Using this package automatically enables this guideline.
 
 ### Cake Version
 
-<?! Include "../settings/fragments/OverrideCakeVersion.md" /?>
+<?! Include "../settings/fragments/OverrideCakeVersion.md" /?>
diff --git a/docs/input/guidelines/TargetFramework.md b/docs/input/guidelines/TargetFramework.md
@@ -48,6 +48,9 @@ while missing a suggested target version will raise [CCG0007](../rules/ccg0007)
     * Required: `net6.0`
     * Required: `net7.0`
     * Required: `net8.0`
+  * Cake.Core >= 5.0.0
+    * Required: `net8.0`
+    * Required: `net9.0`
 * Package type: module
   * Cake.Core < 2.0.0
     * Required: `netstandard2.0`
@@ -61,6 +64,9 @@ while missing a suggested target version will raise [CCG0007](../rules/ccg0007)
   * Cake.Core >= 4.0.0
     * Required: `net6.0`
     * No additional targets are allowed.
+  * Cake.Core >= 5.0.0
+    * Required: `net8.0`
+    * No additional targets are allowed.
 
 For package type recipe no framework reference is required or suggested.
 
diff --git a/src/Generators/Commands/PackageReferencesCommand.cs b/src/Generators/Commands/PackageReferencesCommand.cs
@@ -42,15 +42,35 @@ public class Settings : CommandSettings
 
     public override int Execute(CommandContext context, Settings settings)
     {
+        var opts = new EnumerationOptions { RecurseSubdirectories = true, MatchCasing = MatchCasing.CaseInsensitive };
+        var globals = Directory.GetFiles(
+            settings.CakeSourcePath,
+            "Directory.Packages.props",
+            opts);
         var projects = Directory.GetFiles(
             settings.CakeSourcePath,
             "*.csproj",
-            new EnumerationOptions { RecurseSubdirectories = true, MatchCasing = MatchCasing.CaseInsensitive });
+            opts);
 
         console.WriteLine($"Found {projects.Length} projects");
 
         var references = new Dictionary<string, PkgReference[]>();
 
+        var cpm = new CentralPackageManagement();
+        foreach (string global in globals)
+        {
+            var relativePath = Path.GetRelativePath(settings.CakeSourcePath, global);
+            console.MarkupLineInterpolated($"Processing CPM: {relativePath}");
+            var foo = ProcessCentralPackageManagement(global, settings.ReferencesToSkip);
+            if (foo is null)
+            {
+                continue;
+            }
+
+            cpm.GlobalReferences.AddRange(foo.GlobalReferences);
+            cpm.PackageVersions.AddRange(foo.PackageVersions);
+        }
+
         foreach (string proj in projects)
         {
             var file = Path.GetFileName(proj);
@@ -61,7 +81,7 @@ public override int Execute(CommandContext context, Settings settings)
             }
 
             console.MarkupLineInterpolated($"Processing {file}");
-            var refs = ProcessProject(proj, settings.ReferencesToSkip);
+            var refs = ProcessProject(proj, settings.ReferencesToSkip, cpm);
             if (refs.Length > 0)
             {
                 references.Add(file, refs);
@@ -71,7 +91,8 @@ public override int Execute(CommandContext context, Settings settings)
         console.MarkupLine("Flattening references");
         var allRefs = references
             .SelectMany(x => x.Value)
-            .DistinctBy(x => $"{x.Name}|{x.Version ?? "0"}")
+            .Where(x => x.Version != null)
+            .DistinctBy(x => $"{x.Name}|{x.Version}")
             .ToLookup(x => x.Name)
             .OrderBy(x => x.Key)
             .ToArray();
@@ -207,7 +228,8 @@ private void PrintFlatList(IReadOnlyDictionary<string, string?> refs, string? gi
 
     private PkgReference[] ProcessProject(
         string fullFile,
-        Predicate<PkgReference>[] referencesToSkip)
+        Predicate<PkgReference>[] referencesToSkip,
+        CentralPackageManagement cpm)
     {
         var project = ProjectRootElement.Open(fullFile);
         if (project == null)
@@ -216,12 +238,12 @@ private PkgReference[] ProcessProject(
             return Array.Empty<PkgReference>();
         }
 
-        var foo = project.ItemGroups
+        var packageReferences = project.ItemGroups
             .SelectMany(g => g.Children)
             .Where(c => c.ElementName.Equals("PackageReference", StringComparison.OrdinalIgnoreCase))
             .Cast<ProjectItemElement>()
             .ToArray();
-        var references = foo
+        var references = packageReferences
             .Select(x => new PkgReference
             {
                 Name = x.Include,
@@ -231,12 +253,75 @@ private PkgReference[] ProcessProject(
             .Where(x => !referencesToSkip.Any(p => p(x)))
             .ToArray();
 
-        return references;
+        var fromGlobals = references
+            .Where(x => x.Version == null)
+            .Select(x => cpm.PackageVersions.FirstOrDefault(y => y.Name == x.Name))
+            .Where(x => x != null)
+            .Cast<PkgReference>();
+
+        return references
+            .Where(x => x.Version != null)
+            .Concat(fromGlobals)
+            .Concat(cpm.GlobalReferences)
+            .ToArray();
+    }
+
+    private CentralPackageManagement? ProcessCentralPackageManagement(string filePath, Predicate<PkgReference>[] referencesToSkip)
+    {
+        var project = ProjectRootElement.Open(filePath);
+        if (project == null)
+        {
+            console.MarkupLineInterpolated($"[red]Failed to parse {Path.GetFileName(filePath)}[/]");
+            return null;
+        }
+
+        var globalPackageRefItems = project.ItemGroups
+            .SelectMany(g => g.Children)
+            .Where(c => c.ElementName.Equals("GlobalPackageReference", StringComparison.OrdinalIgnoreCase))
+            .Cast<ProjectItemElement>()
+            .ToArray();
+
+        var packageVersionItems = project.ItemGroups
+            .SelectMany(g => g.Children)
+            .Where(c => c.ElementName.Equals("PackageVersion", StringComparison.OrdinalIgnoreCase))
+            .Cast<ProjectItemElement>()
+            .ToArray();
+
+        var globalPackageRefs = globalPackageRefItems
+            .Select(x => new PkgReference
+            {
+                Name = x.Include,
+                Version = x.Metadata
+                    .FirstOrDefault(y => y.Name.Equals("Version", StringComparison.OrdinalIgnoreCase))?.Value,
+            })
+            .Where(x => !referencesToSkip.Any(p => p(x)))
+            .ToArray();
+        var packageVersions = packageVersionItems
+            .Select(x => new PkgReference
+            {
+                Name = x.Include,
+                Version = x.Metadata
+                    .FirstOrDefault(y => y.Name.Equals("Version", StringComparison.OrdinalIgnoreCase))?.Value,
+            })
+            .Where(x => !referencesToSkip.Any(p => p(x)))
+            .ToArray();
+
+        var ret = new CentralPackageManagement();
+        ret.GlobalReferences.AddRange(globalPackageRefs);
+        ret.PackageVersions.AddRange(packageVersions);
+
+        return ret;
     }
 
     public class PkgReference
     {
         public string Name { get; init; } = string.Empty;
         public string? Version { get; init; }
     }
+
+    public class CentralPackageManagement
+    {
+        public List<PkgReference> GlobalReferences { get; set; } = new();
+        public List<PkgReference> PackageVersions { get; set; } = new();
+    }
 }
diff --git a/src/Tasks.Tests/CheckCakeInternalReferencesTests.cs b/src/Tasks.Tests/CheckCakeInternalReferencesTests.cs
@@ -170,7 +170,25 @@ public void Should_Warn_If_Newtonsoft_Is_Wrong_For_Cake_4()
             // then
             fixture.BuildEngine.WarningEvents.Count.ShouldBe(1);
             fixture.BuildEngine.WarningEvents.First().Code.ShouldBe(CcgRule10);
-            fixture.BuildEngine.WarningEvents.First().Message.ShouldContain("13.0.3"); // the required version for NuGet.Common
+            fixture.BuildEngine.WarningEvents.First().Message.ShouldContain("13.0.3"); // the required version for Newtonsoft
+        }
+
+        [Fact]
+        public void Should_Warn_If_NuGet_Is_Wrong_For_Cake_5()
+        {
+            // given
+            var fixture = new CheckCakeInternalReferencesFixture();
+            fixture.WithReference("NuGet.Packaging", "6.7.0");
+            fixture.WithReference("Cake.Core", "5.0.0");
+            fixture.WithCakeVersion(string.Empty);
+
+            // when
+            fixture.Execute();
+
+            // then
+            fixture.BuildEngine.WarningEvents.Count.ShouldBe(1);
+            fixture.BuildEngine.WarningEvents.First().Code.ShouldBe(CcgRule10);
+            fixture.BuildEngine.WarningEvents.First().Message.ShouldContain("6.11.1"); // the required version for NuGet.Packaging
         }
     }
 }
diff --git a/src/Tasks.Tests/TargetFrameworkVersionsTests.cs b/src/Tasks.Tests/TargetFrameworkVersionsTests.cs
@@ -20,6 +20,7 @@ public class TargetFrameworkVersionsTests
         private const string Net60 = "net6.0";
         private const string Net70 = "net7.0";
         private const string Net80 = "net8.0";
+        private const string Net90 = "net9.0";
 
         [Fact]
         public void Should_Error_If_RequiredTargetFramework_Is_Not_Targeted()
@@ -369,6 +370,38 @@ public static IEnumerable<object[]> Should_Error_If_RequiredTargetFramework_Is_N
             yield return new object[] { new[] { Net60, Net70, Net80 }, false, string.Empty };
         }
 
+        [Theory]
+        [MemberData(nameof(Should_Error_If_RequiredTargetFramework_Is_Not_Targeted_Cake_5_Data))]
+        public void Should_Error_If_RequiredTargetFramework_Is_Not_Targeted_Cake_5(string[] targetFrameworks, bool expectedError, string missingTargetFramework)
+        {
+            // given
+            var fixture = new TargetFrameworkVersionsFixture();
+            fixture.WithCakeCoreReference(5);
+            fixture.WithTargetFrameworks(targetFrameworks);
+
+            // when
+            fixture.Execute();
+
+            // then
+            if (expectedError)
+            {
+                fixture.BuildEngine.ErrorEvents.Count.ShouldBe(1);
+                fixture.BuildEngine.ErrorEvents.First().Message.ShouldContain(missingTargetFramework);
+            }
+            else
+            {
+                fixture.BuildEngine.ErrorEvents.Count.ShouldBe(0);
+            }
+        }
+
+        public static IEnumerable<object[]> Should_Error_If_RequiredTargetFramework_Is_Not_Targeted_Cake_5_Data()
+        {
+            yield return new object[] { Array.Empty<string>(), true, Net80 };
+            yield return new object[] { new[] { Net80 }, true, Net90 };
+            yield return new object[] { new[] { Net90 }, true, Net80 };
+            yield return new object[] { new[] { Net80, Net90 }, false, string.Empty };
+        }
+
         [Fact]
         public void Should_Error_If_RequiredTargetFramework_Is_Not_Targeted_Cake_2_Module()
         {
@@ -417,6 +450,22 @@ public void Should_Error_If_RequiredTargetFramework_Is_Not_Targeted_Cake_4_Modul
             fixture.BuildEngine.ErrorEvents.First().Message.ShouldContain(Net60);
         }
 
+        [Fact]
+        public void Should_Error_If_RequiredTargetFramework_Is_Not_Targeted_Cake_5_Module()
+        {
+            // given
+            var fixture = new TargetFrameworkVersionsFixture();
+            fixture.WithProjectType("module");
+            fixture.WithCakeCoreReference("5.0.0");
+
+            // when
+            fixture.Execute();
+
+            // then
+            fixture.BuildEngine.ErrorEvents.Count.ShouldBe(1);
+            fixture.BuildEngine.ErrorEvents.First().Message.ShouldContain(Net80);
+        }
+
         [Fact]
         public void Should_Error_If_RequiredTargetFramework_Is_Not_Targeted_Module_Explicit_Version()
         {
diff --git a/src/Tasks/CakeVersions.cs b/src/Tasks/CakeVersions.cs
@@ -19,7 +19,10 @@ internal static class CakeVersions
         // Cake 4.0.0
         public static readonly Version V4 = new Version(4, 0, 0);
 
+        // Cake 5.0.0
+        public static readonly Version V5 = new Version(5, 0, 0);
+
         // The next, currently non-existing cake version
-        public static Version VNext = new Version(5, 0, 0);
+        public static Version VNext = new Version(6, 0, 0);
     }
 }
diff --git a/src/Tasks/CheckCakeInternalReferences.cs b/src/Tasks/CheckCakeInternalReferences.cs
@@ -128,6 +128,31 @@ public class CheckCakeInternalReferences : Task
             { "xunit", "2.6.1" },
         };
 
+        // parsed from Cake: v5.0
+        private static readonly Dictionary<string, string> CakeV50 = new Dictionary<string, string>
+        {
+            { "Autofac", "8.1.1" },
+            { "Microsoft.CodeAnalysis.CSharp.Scripting", "4.12.0-3.final" },
+            { "Microsoft.CSharp", "4.7.0" },
+            { "Microsoft.Extensions.DependencyInjection", "9.0.0" },
+            { "Microsoft.IdentityModel.JsonWebTokens", "8.2.0" },
+            { "Microsoft.NETCore.Platforms", "7.0.4" },
+            { "Microsoft.SourceLink.GitHub", "8.0.0" },
+            { "Microsoft.Win32.Registry", "5.0.0" },
+            { "Newtonsoft.Json", "13.0.3" },
+            { "NuGet.Common", "6.11.1" },
+            { "NuGet.Frameworks", "6.11.1" },
+            { "NuGet.Packaging", "6.11.1" },
+            { "NuGet.Protocol", "6.11.1" },
+            { "NuGet.Resolver", "6.11.1" },
+            { "NuGet.Versioning", "6.11.1" },
+            { "StyleCop.Analyzers", "1.1.118" },
+            { "System.Collections.Immutable", "9.0.0" },
+            { "System.Reflection.Metadata", "9.0.0" },
+            { "System.Security.Cryptography.Pkcs", "9.0.0" },
+            { "xunit", "2.9.2" },
+        };
+
         private readonly Dictionary<Predicate<Version>, Dictionary<string, string>> allInternalReferences =
             new Dictionary<Predicate<Version>, Dictionary<string, string>>
             {
@@ -148,9 +173,13 @@ public class CheckCakeInternalReferences : Task
                     CakeV30
                 },
                 {
-                    x => x.GreaterEqual(CakeVersions.V4) && x.LessThan(CakeVersions.VNext),
+                    x => x.GreaterEqual(CakeVersions.V4) && x.LessThan(CakeVersions.V5),
                     CakeV40
                 },
+                {
+                    x => x.GreaterEqual(CakeVersions.V5) && x.LessThan(CakeVersions.VNext),
+                    CakeV50
+                },
             };
 
         /// <summary>
diff --git a/src/Tasks/TargetFrameworkVersions.cs b/src/Tasks/TargetFrameworkVersions.cs

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,10 @@ internal static class CakeVersions`
`19`	`19`	`// Cake 4.0.0`
`20`	`20`	`public static readonly Version V4 = new Version(4, 0, 0);`
`21`	`21`
	`22`	`+ // Cake 5.0.0`
	`23`	`+ public static readonly Version V5 = new Version(5, 0, 0);`
	`24`	`+`
`22`	`25`	`// The next, currently non-existing cake version`
`23`		`- public static Version VNext = new Version(5, 0, 0);`
	`26`	`+ public static Version VNext = new Version(6, 0, 0);`
`24`	`27`	`}`
`25`	`28`	`}`