Fixes from NUKE upgrades

Perksey · Perksey · commit 5db82a924252 · 2022-03-26T11:48:32.000Z
diff --git a/.editorconfig b/.editorconfig
@@ -40,7 +40,7 @@ dotnet_diagnostic.RS0016.severity = error
 dotnet_diagnostic.RS0017.severity = error
 
 # we should care more about this one day
-dotnet_diagnostic.RS0041.severity = warn
+dotnet_diagnostic.RS0041.severity = error
 
 # public api warnings silk.net doesn't care about
 dotnet_diagnostic.RS0026.severity = none  # Don't add multiple public overloads with optional parameters
diff --git a/global.json b/global.json
@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "6.0.100-preview.6.21355.2",
+    "version": "6.0.201",
     "rollForward": "major"
   }
 }
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -18,6 +18,7 @@
     <PropertyGroup>
         <Nullable>enable</Nullable>
         <SilkDocumentationWarningsAsErrors>CS1591;CS1573</SilkDocumentationWarningsAsErrors>
+        <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     </PropertyGroup>
     <!-- NuGet -->
     <PropertyGroup>
diff --git a/src/benchmarks/Directory.Build.props b/src/benchmarks/Directory.Build.props
@@ -0,0 +1,6 @@
+<Project>
+    <PropertyGroup>
+        <NoWarn>1591</NoWarn>
+    </PropertyGroup>
+    <Import Project="$(MSBuildThisFileDirectory)../Directory.Build.props" />
+</Project>
diff --git a/src/infrastructure/Silk.NET.NUKE/Build.CodeSigning.cs b/src/infrastructure/Silk.NET.NUKE/Build.CodeSigning.cs
@@ -14,8 +14,8 @@
 
 partial class Build
 {
-    [Parameter("Code-signing service username")] readonly string SignUsername;
-    [Parameter("Code-signing service password")] readonly string SignPassword;
+    [Parameter("Code-signing service username")] readonly string? SignUsername;
+    [Parameter("Code-signing service password")] readonly string? SignPassword;
     bool CanCodeSign => !string.IsNullOrWhiteSpace(SignUsername) && !string.IsNullOrWhiteSpace(SignPassword);
 
     Target SignPackages => CommonTarget
@@ -29,7 +29,7 @@ partial class Build
                 {
                     if (!CanCodeSign)
                     {
-                        ControlFlow.Fail("SignClient username and/or password not specified.");
+                        Assert.Fail("SignClient username and/or password not specified.");
                     }
 
                     var outputs = Enumerable.Empty<Output>();
diff --git a/src/infrastructure/Silk.NET.NUKE/Build.Core.cs b/src/infrastructure/Silk.NET.NUKE/Build.Core.cs
@@ -7,6 +7,7 @@
 using Nuke.Common;
 using Nuke.Common.Tooling;
 using Nuke.Common.Tools.DotNet;
+using Serilog;
 using static Nuke.Common.IO.FileSystemTasks;
 using static Nuke.Common.Tools.DotNet.DotNetTasks;
 using static Nuke.Common.Tooling.ProcessTasks;
@@ -57,7 +58,7 @@ partial class Build
                     }
                     else
                     {
-                        Logger.Warn("Skipping gradlew clean as the \"native\" feature-set has not been specified.");
+                        Log.Warning("Skipping gradlew clean as the \"native\" feature-set has not been specified.");
                     }
 
                     return outputs;
diff --git a/src/infrastructure/Silk.NET.NUKE/Build.Generation.cs b/src/infrastructure/Silk.NET.NUKE/Build.Generation.cs
@@ -3,7 +3,9 @@
 
 using System.IO;
 using Nuke.Common;
+using Nuke.Common.Tooling;
 using Nuke.Common.Tools.DotNet;
+using Serilog;
 using static Nuke.Common.Tools.DotNet.DotNetTasks;
 
 partial class Build
@@ -16,18 +18,18 @@ partial class Build
             (
                 () =>
                 {
-                    var project = OriginalSolution.GetProject("Silk.NET.BuildTools");
+                    var project = OriginalSolution.NotNull()!.GetProject("SilkTouch");
                     if (project == default)
                     {
-                        Logger.Error("Couldn't find BuildTools in the solution file.");
+                        Log.Error("Couldn't find SilkTouch in the solution file.");
                         return;
                     }
 
                     DotNetRun
                     (
                         s => s.SetProjectFile(project)
                             .SetConfiguration("Release")
-                            .SetApplicationArguments(Path.Combine(RootDirectory, "generator.json"))
+                            .SetProcessWorkingDirectory(RootDirectory)
                     );
                 }
             )
diff --git a/src/infrastructure/Silk.NET.NUKE/Build.Native.cs b/src/infrastructure/Silk.NET.NUKE/Build.Native.cs
@@ -17,6 +17,7 @@
 using Nuke.Common.Tools.Git;
 using Octokit;
 using Octokit.Internal;
+using Serilog;
 using static Nuke.Common.IO.CompressionTasks;
 using static Nuke.Common.IO.FileSystemTasks;
 using static Nuke.Common.IO.HttpTasks;
@@ -29,7 +30,7 @@ partial class Build
 {
     [Nuke.Common.Parameter("Build native code")] readonly bool Native;
 
-    [CanBeNull] string AndroidHomeValue;
+    string? AndroidHomeValue;
 
     static string JobsArg => string.IsNullOrWhiteSpace(GitHubActions.Instance?.Job)
         ? $" -j{Environment.ProcessorCount}"
@@ -47,7 +48,7 @@ string AndroidHome
             var utils = RootDirectory / "build" / "utilities";
             DotNet($"build \"{utils / "android_probe.proj"}\" /t:GetAndroidJar");
             AndroidHomeValue = (AbsolutePath) File.ReadAllText(utils / "android.jar.gen.txt") / ".." / ".." / "..";
-            Logger.Info($"Android Home: {AndroidHomeValue}");
+            Log.Information($"Android Home: {AndroidHomeValue}");
             return AndroidHomeValue;
         }
     }
@@ -62,7 +63,7 @@ string AndroidHome
                 {
                     if (!Native)
                     {
-                        Logger.Warn("Skipping gradlew build as the --native parameter has not been specified.");
+                        Log.Warning("Skipping gradlew build as the --native parameter has not been specified.");
                         return Enumerable.Empty<Output>();
                     }
 
@@ -79,7 +80,7 @@ string AndroidHome
                     {
                         if (!Directory.Exists(from))
                         {
-                            ControlFlow.Fail
+                            Assert.Fail
                                 ($"\"{from}\" does not exist (did you forget to recursively clone the repo?)");
                         }
 
@@ -498,13 +499,13 @@ void PrUpdatedNativeBinary(string name)
             Git("reset --hard", RootDirectory);
             if (GitCurrentCommit(RootDirectory) != curCommit) // might get "nothing to commit", you never know...
             {
-                Logger.Info("Checking for existing branch...");
+                Log.Information("Checking for existing branch...");
                 var exists = StartProcess("git", $"checkout \"{newBranch}\"", RootDirectory)
                     .AssertWaitForExit()
                     .ExitCode == 0;
                 if (!exists)
                 {
-                    Logger.Info("None found, creating a new one...");
+                    Log.Information("None found, creating a new one...");
                     Git($"checkout -b \"{newBranch}\"");
                 }
 
diff --git a/src/infrastructure/Silk.NET.NUKE/Build.NuGet.cs b/src/infrastructure/Silk.NET.NUKE/Build.NuGet.cs
@@ -9,15 +9,16 @@
 using Nuke.Common;
 using Nuke.Common.Tooling;
 using Nuke.Common.Tools.DotNet;
+using Serilog;
 using static Nuke.Common.Tools.DotNet.DotNetTasks;
 
 partial class Build
 {
-    [Parameter("The API key used to push packages and symbols packages to NuGet")] readonly string NugetApiKey;
+    [Parameter("The API key used to push packages and symbols packages to NuGet")] readonly string? NugetApiKey;
     [Parameter("NuGet -NoServiceEndpoint")] readonly bool NugetNoServiceEndpoint;
     [Parameter("NuGet feed")] readonly string NugetFeed = "https://api.nuget.org/v3/index.json";
-    [Parameter("NuGet username")] readonly string NugetUsername;
-    [Parameter("NuGet password")] readonly string NugetPassword;
+    [Parameter("NuGet username")] readonly string? NugetUsername;
+    [Parameter("NuGet password")] readonly string? NugetPassword;
     static string PackageDirectory => RootDirectory / "build" / "output_packages";
 
     static IEnumerable<string> Packages => Directory.GetFiles(PackageDirectory, "*.nupkg")
@@ -40,7 +41,7 @@ async Task<IEnumerable<Output>> PushPackages()
             .Select(x => x.Select(v => v.Value).ToList())
             .ToList();
         var first = true;
-        Logger.Info($"Searching for packages in \"{RootDirectory / "build" / "output_packages"}\"...");
+        Log.Information($"Searching for packages in \"{RootDirectory / "build" / "output_packages"}\"...");
         foreach (var files in allFiles)
         {
             if (first)
@@ -60,7 +61,7 @@ async Task<IEnumerable<Output>> PushPackages()
                 {
                     if (NugetUsername is null || NugetPassword is null)
                     {
-                        ControlFlow.Fail
+                        Assert.Fail
                         (
                             "Both \"NugetUsername\" and \"NugetPassword\" must be specified if either are used."
                         );
diff --git a/src/infrastructure/Silk.NET.NUKE/Build.PublicApi.cs b/src/infrastructure/Silk.NET.NUKE/Build.PublicApi.cs
@@ -10,6 +10,7 @@
 using Nuke.Common.Tooling;
 using Octokit;
 using Octokit.Internal;
+using Serilog;
 using static Nuke.Common.Tools.Git.GitTasks;
 using static Nuke.Common.Tooling.ProcessTasks;
 using static Nuke.Common.Tools.DotNet.DotNetTasks;
@@ -136,13 +137,13 @@ void MakePr()
             Git("reset --hard", RootDirectory);
             if (GitCurrentCommit(RootDirectory) != curCommit) // might get "nothing to commit", you never know...
             {
-                Logger.Info("Checking for existing branch...");
+                Log.Information("Checking for existing branch...");
                 var exists = StartProcess("git", $"checkout \"{newBranch}\"", RootDirectory)
                     .AssertWaitForExit()
                     .ExitCode == 0;
                 if (!exists)
                 {
-                    Logger.Info("None found, creating a new one...");
+                    Log.Information("None found, creating a new one...");
                     Git($"checkout -b \"{newBranch}\"");
                 }
 
diff --git a/src/infrastructure/Silk.NET.NUKE/Build.ReviewHelpers.cs b/src/infrastructure/Silk.NET.NUKE/Build.ReviewHelpers.cs
@@ -6,6 +6,7 @@
 using System.Linq;
 using Nuke.Common;
 using Nuke.Common.IO;
+using Serilog;
 
 partial class Build
 {
@@ -21,7 +22,7 @@ partial class Build
             () =>
             {
                 var files = SourceDirectory.GlobFiles("**/*.csproj").ToArray();
-                Logger.Info($"Found {files.Length} csproj files in \"{SourceDirectory}\"");
+                Log.Information($"Found {files.Length} csproj files in \"{SourceDirectory}\"");
                 var missedOut = new List<string>();
                 foreach (var file in files)
                 {
@@ -37,7 +38,7 @@ partial class Build
 
                     if (!found && !AllowedExclusions.Contains(Path.GetFileNameWithoutExtension(file)))
                     {
-                        Logger.Error
+                        Log.Error
                         (
                             "A project has not been included in the solution and will not be shipped! " +
                             $"\"{file}\" if this is acceptable please add the project name (excluding the path and " +
@@ -50,13 +51,13 @@ partial class Build
 
                 if (missedOut.Any())
                 {
-                    Logger.Warn("Commands to add these for your convenience:");
+                    Log.Warning("Commands to add these for your convenience:");
                     foreach (var file in missedOut)
                     {
-                        Logger.Warn($"dotnet sln \"{Path.GetFileName(Solution.FileName)}\" add \"{file}\"");
+                        Log.Warning($"dotnet sln \"{Path.GetFileName(Solution.FileName)}\" add \"{file}\"");
                     }
 
-                    ControlFlow.Fail("Action required.");
+                    Assert.Fail("Action required.");
                 }
             }
         )
diff --git a/src/infrastructure/Silk.NET.NUKE/Build.SolutionGenerator.cs b/src/infrastructure/Silk.NET.NUKE/Build.SolutionGenerator.cs
@@ -12,6 +12,7 @@
 using Nuke.Common.IO;
 using Nuke.Common.ProjectModel;
 using Nuke.Common.Utilities;
+using Serilog;
 using static Nuke.Common.IO.FileSystemTasks;
 using static Nuke.Common.ProjectModel.ProjectModelTasks;
 
@@ -27,19 +28,19 @@ partial class Build
         "include project dependencies. The solution will be regenerated whenever you run a NUKE build with this " +
         "specified, but if you don't want to run a build just use \"nuke sln --projects ...\" to run a dummy target."
     )]
-    readonly string[] Projects;
+    readonly string[]? Projects;
 
-    Solution GeneratedSolution;
+    Solution? GeneratedSolution;
 
     Solution Solution => GeneratedSolution ?? (File.Exists(RootDirectory / "Silk.NET.gen.sln")
         ? ParseSolution(RootDirectory / "Silk.NET.gen.sln")
-        : OriginalSolution);
+        : OriginalSolution.NotNull()!);
 
     void GenerateSolution()
     {
         if (Projects is not { Length: > 0 })
         {
-            Logger.Trace("Nothing to do for GenerateSolution.");
+            Log.Verbose("Nothing to do for GenerateSolution.");
             return;
         }
 
@@ -66,7 +67,8 @@ AbsolutePath Concat(AbsolutePath path, string next)
             return path / next;
         }
 
-        var include = OriginalSolution.GetProjects("*")
+        var include = OriginalSolution.NotNull()!
+            .GetProjects("*")
             .Where
             (
                 project => Projects.Any
@@ -88,7 +90,8 @@ AbsolutePath Concat(AbsolutePath path, string next)
             var projPath = include[i];
             include.AddRange
             (
-                OriginalSolution.GetProjects("*")
+                OriginalSolution.NotNull()!
+                    .GetProjects("*")
                     .First(x => x.Path == projPath)
                     .GetItems("ProjectReference")
                     .Select(x => Path.GetFullPath(x, ((AbsolutePath) projPath).Parent))
@@ -97,7 +100,7 @@ AbsolutePath Concat(AbsolutePath path, string next)
         }
 
         // make a new Solution object to prevent us mutating the OriginalSolution
-        var genSln = ParseSolution(OriginalSolution.Path);
+        var genSln = ParseSolution(OriginalSolution.NotNull()!.Path);
         
         // remove irrelevant projects
         foreach (var project in genSln.GetProjects("*"))
@@ -109,7 +112,7 @@ AbsolutePath Concat(AbsolutePath path, string next)
         }
 
         genSln.SaveAs(RootDirectory / "Silk.NET.gen.sln");
-        Logger.Info($"Generated solution containing {genSln.AllProjects.Count} projects");
+        Log.Information($"Generated solution containing {genSln.AllProjects.Count} projects");
     }
     
     Target Sln => CommonTarget();
diff --git a/src/infrastructure/Silk.NET.NUKE/Build.Support.cs b/src/infrastructure/Silk.NET.NUKE/Build.Support.cs
diff --git a/src/infrastructure/Silk.NET.NUKE/NukeLoggerAdapter.cs b/src/infrastructure/Silk.NET.NUKE/NukeLoggerAdapter.cs
diff --git a/src/infrastructure/Silk.NET.NUKE/Projects.cs b/src/infrastructure/Silk.NET.NUKE/Projects.cs
diff --git a/tests/Directory.Build.props b/tests/Directory.Build.props

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"sdk": {`
`3`		`- "version": "6.0.100-preview.6.21355.2",`
	`3`	`+ "version": "6.0.201",`
`4`	`4`	`"rollForward": "major"`
`5`	`5`	`}`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,8 @@`
`14`	`14`
`15`	`15`	`partial class Build`
`16`	`16`	`{`
`17`		`- [Parameter("Code-signing service username")] readonly string SignUsername;`
`18`		`- [Parameter("Code-signing service password")] readonly string SignPassword;`
	`17`	`+ [Parameter("Code-signing service username")] readonly string? SignUsername;`
	`18`	`+ [Parameter("Code-signing service password")] readonly string? SignPassword;`
`19`	`19`	`bool CanCodeSign => !string.IsNullOrWhiteSpace(SignUsername) && !string.IsNullOrWhiteSpace(SignPassword);`
`20`	`20`
`21`	`21`	`Target SignPackages => CommonTarget`
`@@ -29,7 +29,7 @@ partial class Build`
`29`	`29`	`{`
`30`	`30`	`if (!CanCodeSign)`
`31`	`31`	`{`
`32`		`- ControlFlow.Fail("SignClient username and/or password not specified.");`
	`32`	`+ Assert.Fail("SignClient username and/or password not specified.");`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`var outputs = Enumerable.Empty<Output>();`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`using Nuke.Common;`
`8`	`8`	`using Nuke.Common.Tooling;`
`9`	`9`	`using Nuke.Common.Tools.DotNet;`
	`10`	`+using Serilog;`
`10`	`11`	`using static Nuke.Common.IO.FileSystemTasks;`
`11`	`12`	`using static Nuke.Common.Tools.DotNet.DotNetTasks;`
`12`	`13`	`using static Nuke.Common.Tooling.ProcessTasks;`
`@@ -57,7 +58,7 @@ partial class Build`
`57`	`58`	`}`
`58`	`59`	`else`
`59`	`60`	`{`
`60`		`- Logger.Warn("Skipping gradlew clean as the \"native\" feature-set has not been specified.");`
	`61`	`+ Log.Warning("Skipping gradlew clean as the \"native\" feature-set has not been specified.");`
`61`	`62`	`}`
`62`	`63`
`63`	`64`	`return outputs;`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,9 @@`
`3`	`3`
`4`	`4`	`using System.IO;`
`5`	`5`	`using Nuke.Common;`
	`6`	`+using Nuke.Common.Tooling;`
`6`	`7`	`using Nuke.Common.Tools.DotNet;`
	`8`	`+using Serilog;`
`7`	`9`	`using static Nuke.Common.Tools.DotNet.DotNetTasks;`
`8`	`10`
`9`	`11`	`partial class Build`
`@@ -16,18 +18,18 @@ partial class Build`
`16`	`18`	`(`
`17`	`19`	`() =>`
`18`	`20`	`{`
`19`		`- var project = OriginalSolution.GetProject("Silk.NET.BuildTools");`
	`21`	`+ var project = OriginalSolution.NotNull()!.GetProject("SilkTouch");`
`20`	`22`	`if (project == default)`
`21`	`23`	`{`
`22`		`- Logger.Error("Couldn't find BuildTools in the solution file.");`
	`24`	`+ Log.Error("Couldn't find SilkTouch in the solution file.");`
`23`	`25`	`return;`
`24`	`26`	`}`
`25`	`27`
`26`	`28`	`DotNetRun`
`27`	`29`	`(`
`28`	`30`	`s => s.SetProjectFile(project)`
`29`	`31`	`.SetConfiguration("Release")`
`30`		`- .SetApplicationArguments(Path.Combine(RootDirectory, "generator.json"))`
	`32`	`+ .SetProcessWorkingDirectory(RootDirectory)`
`31`	`33`	`);`
`32`	`34`	`}`
`33`	`35`	`)`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`using Nuke.Common.Tools.Git;`
`18`	`18`	`using Octokit;`
`19`	`19`	`using Octokit.Internal;`
	`20`	`+using Serilog;`
`20`	`21`	`using static Nuke.Common.IO.CompressionTasks;`
`21`	`22`	`using static Nuke.Common.IO.FileSystemTasks;`
`22`	`23`	`using static Nuke.Common.IO.HttpTasks;`
`@@ -29,7 +30,7 @@ partial class Build`
`29`	`30`	`{`
`30`	`31`	`[Nuke.Common.Parameter("Build native code")] readonly bool Native;`
`31`	`32`
`32`		`- [CanBeNull] string AndroidHomeValue;`
	`33`	`+ string? AndroidHomeValue;`
`33`	`34`
`34`	`35`	`static string JobsArg => string.IsNullOrWhiteSpace(GitHubActions.Instance?.Job)`
`35`	`36`	`? $" -j{Environment.ProcessorCount}"`
`@@ -47,7 +48,7 @@ string AndroidHome`
`47`	`48`	`var utils = RootDirectory / "build" / "utilities";`
`48`	`49`	`DotNet($"build \"{utils / "android_probe.proj"}\" /t:GetAndroidJar");`
`49`	`50`	`AndroidHomeValue = (AbsolutePath) File.ReadAllText(utils / "android.jar.gen.txt") / ".." / ".." / "..";`
`50`		`- Logger.Info($"Android Home: {AndroidHomeValue}");`
	`51`	`+ Log.Information($"Android Home: {AndroidHomeValue}");`
`51`	`52`	`return AndroidHomeValue;`
`52`	`53`	`}`
`53`	`54`	`}`
`@@ -62,7 +63,7 @@ string AndroidHome`
`62`	`63`	`{`
`63`	`64`	`if (!Native)`
`64`	`65`	`{`
`65`		`- Logger.Warn("Skipping gradlew build as the --native parameter has not been specified.");`
	`66`	`+ Log.Warning("Skipping gradlew build as the --native parameter has not been specified.");`
`66`	`67`	`return Enumerable.Empty<Output>();`
`67`	`68`	`}`
`68`	`69`
`@@ -79,7 +80,7 @@ string AndroidHome`
`79`	`80`	`{`
`80`	`81`	`if (!Directory.Exists(from))`
`81`	`82`	`{`
`82`		`- ControlFlow.Fail`
	`83`	`+ Assert.Fail`
`83`	`84`	`($"\"{from}\" does not exist (did you forget to recursively clone the repo?)");`
`84`	`85`	`}`
`85`	`86`
`@@ -498,13 +499,13 @@ void PrUpdatedNativeBinary(string name)`
`498`	`499`	`Git("reset --hard", RootDirectory);`
`499`	`500`	`if (GitCurrentCommit(RootDirectory) != curCommit) // might get "nothing to commit", you never know...`
`500`	`501`	`{`
`501`		`- Logger.Info("Checking for existing branch...");`
	`502`	`+ Log.Information("Checking for existing branch...");`
`502`	`503`	`var exists = StartProcess("git", $"checkout \"{newBranch}\"", RootDirectory)`
`503`	`504`	`.AssertWaitForExit()`
`504`	`505`	`.ExitCode == 0;`
`505`	`506`	`if (!exists)`
`506`	`507`	`{`
`507`		`- Logger.Info("None found, creating a new one...");`
	`508`	`+ Log.Information("None found, creating a new one...");`
`508`	`509`	`Git($"checkout -b \"{newBranch}\"");`
`509`	`510`	`}`
`510`	`511`