Reimplement backwards-compatibility

Matthias Koch · Matthias Koch · commit 9885956bd2d7 · 2021-04-04T20:33:04.000+02:00
diff --git a/source/Nuke.Common/Constants.cs b/source/Nuke.Common/Constants.cs
@@ -27,6 +27,7 @@ internal static class Constants
             "GitLab"
         };
 
+        internal const string NukeFileName = NukeDirectoryName;
         internal const string NukeDirectoryName = ".nuke";
         internal const string NukeCommonPackageId = nameof(Nuke) + "." + nameof(Common);
         internal const string BuildSchemaFileName = "build.schema.json";
@@ -50,9 +51,13 @@ internal static AbsolutePath TryGetRootDirectoryFrom(string startDirectory, bool
             return (AbsolutePath) FileSystemTasks.FindParentDirectory(
                 startDirectory,
                 predicate: x =>
-                    includeLegacy
-                        ? x.GetFileSystemInfos(NukeDirectoryName).Any()
-                        : x.GetDirectories(NukeDirectoryName).Any());
+                    x.GetDirectories(NukeDirectoryName).Any() ||
+                    includeLegacy && x.GetFiles(NukeFileName).Any());
+        }
+
+        internal static bool IsLegacy(AbsolutePath rootDirectory)
+        {
+            return File.Exists(rootDirectory / NukeFileName);
         }
 
         internal static AbsolutePath GetNukeDirectory(AbsolutePath rootDirectory)
@@ -62,7 +67,9 @@ internal static AbsolutePath GetNukeDirectory(AbsolutePath rootDirectory)
 
         internal static AbsolutePath GetTemporaryDirectory(AbsolutePath rootDirectory)
         {
-            return GetNukeDirectory(rootDirectory) / "temp";
+            return !IsLegacy(rootDirectory)
+                ? GetNukeDirectory(rootDirectory) / "temp"
+                : rootDirectory / ".tmp";
         }
 
         internal static AbsolutePath GetCompletionFile(AbsolutePath rootDirectory)
diff --git a/source/Nuke.Common/Execution/ArgumentsFromParametersFileAttribute.cs b/source/Nuke.Common/Execution/ArgumentsFromParametersFileAttribute.cs
@@ -25,6 +25,9 @@ public class ArgumentsFromParametersFileAttribute : BuildExtensionAttributeBase,
 
         public void OnBuildCreated(NukeBuild build, IReadOnlyCollection<ExecutableTarget> executableTargets)
         {
+            if (!Directory.Exists(Constants.GetNukeDirectory(NukeBuild.RootDirectory)))
+                return;
+
             var parameterMembers = ValueInjectionUtility.GetParameterMembers(build.GetType(), includeUnlisted: true);
             var passwords = new Dictionary<string, byte[]>();
 
diff --git a/source/Nuke.Common/Execution/HandleShellCompletionAttribute.cs b/source/Nuke.Common/Execution/HandleShellCompletionAttribute.cs
@@ -5,6 +5,8 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Nuke.Common.IO;
+using Nuke.Common.ValueInjection;
 using static Nuke.Common.Constants;
 
 namespace Nuke.Common.Execution
@@ -13,11 +15,40 @@ internal class HandleShellCompletionAttribute : BuildExtensionAttributeBase, IOn
     {
         public void OnBuildCreated(NukeBuild build, IReadOnlyCollection<ExecutableTarget> executableTargets)
         {
-            SchemaUtility.WriteBuildSchemaFile(build);
-            SchemaUtility.WriteDefaultParametersFile();
+            if (IsLegacy(NukeBuild.RootDirectory))
+            {
+                WriteCompletionFile(build);
+            }
+            else
+            {
+                SchemaUtility.WriteBuildSchemaFile(build);
+                SchemaUtility.WriteDefaultParametersFile();
+            }
 
             if (EnvironmentInfo.GetParameter<bool>(CompletionParameterName))
                 Environment.Exit(exitCode: 0);
         }
+
+        private static void WriteCompletionFile(NukeBuild build)
+        {
+            var completionItems = new SortedDictionary<string, string[]>();
+
+            var targets = build.ExecutableTargets.OrderBy(x => x.Name).ToList();
+            completionItems[InvokedTargetsParameterName] = targets.Where(x => x.Listed).Select(x => x.Name).ToArray();
+            completionItems[SkippedTargetsParameterName] = targets.Select(x => x.Name).ToArray();
+
+            var parameters = ValueInjectionUtility.GetParameterMembers(build.GetType(), includeUnlisted: false);
+            foreach (var parameter in parameters)
+            {
+                var parameterName = ParameterService.GetParameterMemberName(parameter);
+                if (completionItems.ContainsKey(parameterName))
+                    continue;
+
+                var subItems = ParameterService.GetParameterValueSet(parameter, build)?.Select(x => x.Text);
+                completionItems[parameterName] = subItems?.ToArray();
+            }
+
+            SerializationTasks.YamlSerializeToFile(completionItems, GetCompletionFile(NukeBuild.RootDirectory));
+        }
     }
 }
diff --git a/source/Nuke.Common/Execution/UpdateNotificationAttribute.cs b/source/Nuke.Common/Execution/UpdateNotificationAttribute.cs
@@ -0,0 +1,52 @@
+﻿// Copyright 2021 Maintainers of NUKE.
+// Distributed under the MIT License.
+// https://github.com/nuke-build/nuke/blob/master/LICENSE
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using Nuke.Common.Utilities;
+using static Nuke.Common.Constants;
+
+namespace Nuke.Common.Execution
+{
+    internal class UpdateNotificationAttribute : BuildExtensionAttributeBase,
+        IOnBuildCreated,
+        IOnBuildFinished
+    {
+        public void OnBuildCreated(NukeBuild build, IReadOnlyCollection<ExecutableTarget> executableTargets)
+        {
+            if (NukeBuild.IsLocalBuild && ShouldNotify)
+            {
+                Notify();
+                Logger.Info("Press any key to continue...");
+                Console.ReadKey();
+            }
+        }
+
+        public void OnBuildFinished(NukeBuild build)
+        {
+            if (NukeBuild.IsServerBuild && ShouldNotify)
+                Notify();
+        }
+
+        private bool ShouldNotify => !Directory.Exists(GetNukeDirectory(NukeBuild.RootDirectory));
+
+        private static void Notify()
+        {
+            Logger.Warn(
+                new[]
+                {
+                    "--- UPDATE RECOMMENDED FROM 5.1.0 ---",
+                    "1. Update your global tool",
+                    "   dotnet tool update Nuke.GlobalTool -g",
+                    "2. Update your build",
+                    "   nuke :update",
+                    "3. Confirm on update for configuration file and build scripts",
+                    "   (Others are be optional)",
+                    string.Empty
+                }.JoinNewLine());
+        }
+    }
+}
diff --git a/source/Nuke.Common/NukeBuild.Statics.cs b/source/Nuke.Common/NukeBuild.Statics.cs
@@ -22,6 +22,7 @@ static NukeBuild()
             RootDirectory = GetRootDirectory();
             TemporaryDirectory = GetTemporaryDirectory(RootDirectory);
             FileSystemTasks.EnsureExistingDirectory(TemporaryDirectory);
+
             BuildAssemblyDirectory = GetBuildAssemblyDirectory();
             BuildProjectFile = GetBuildProjectFile(BuildAssemblyDirectory);
             BuildProjectDirectory = BuildProjectFile?.Parent;
@@ -100,8 +101,8 @@ private static AbsolutePath GetRootDirectory()
             return TryGetRootDirectoryFrom(EnvironmentInfo.WorkingDirectory)
                 .NotNull(new[]
                          {
-                             $"Could not locate '{NukeDirectoryName}' directory while walking up from '{EnvironmentInfo.WorkingDirectory}'.",
-                             "Either create the directory to mark the root directory, or use the --root parameter to use the working directory."
+                             $"Could not locate '{NukeDirectoryName}' directory/file while walking up from '{EnvironmentInfo.WorkingDirectory}'.",
+                             "Either create a directory/file to mark the root directory, or add '--root [path]' to the invocation."
                          }.JoinNewLine());
         }
 
diff --git a/source/Nuke.Common/NukeBuild.cs b/source/Nuke.Common/NukeBuild.cs
@@ -59,6 +59,7 @@ namespace Nuke.Common
     [HandleVisualStudioDebugging]
     [InjectNonParameterValues(Priority = -100)]
     // After finish
+    [UpdateNotification]
     [SerializeBuildServerState]
     public abstract partial class NukeBuild : INukeBuild
     {
diff --git a/source/Nuke.Common/ProjectModel/SolutionAttribute.cs b/source/Nuke.Common/ProjectModel/SolutionAttribute.cs
@@ -3,6 +3,7 @@
 // https://github.com/nuke-build/nuke/blob/master/LICENSE
 
 using System;
+using System.IO;
 using System.Linq;
 using System.Reflection;
 using JetBrains.Annotations;
@@ -49,25 +50,37 @@ public SolutionAttribute(string relativePath)
 
         public override object GetValue(MemberInfo member, object instance)
         {
+            var solutionFile = TryGetSolutionFileFromNukeFile() ??
+                               GetSolutionFileFromParametersFile(member);
             var deserializer = typeof(SolutionSerializer).GetMethod(nameof(SolutionSerializer.DeserializeFromFile)).NotNull()
                 .MakeGenericMethod(member.GetMemberType());
-            return deserializer.Invoke(obj: null, new object[] { GetSolutionFile(member) });
+            return deserializer.Invoke(obj: null, new object[] { solutionFile });
         }
 
         // TODO: allow wildcard matching? [Solution("nuke-*.sln")] -- no globbing?
         // TODO: for just [Solution] without parameter being passed, do wildcard search?
-        private string GetSolutionFile(MemberInfo member)
+        private string GetSolutionFileFromParametersFile(MemberInfo member)
         {
-            if (_relativePath != null)
-                return PathConstruction.Combine(NukeBuild.RootDirectory, _relativePath);
+            return _relativePath != null
+                ? PathConstruction.Combine(NukeBuild.RootDirectory, _relativePath)
+                : EnvironmentInfo.GetParameter<AbsolutePath>(member).NotNull($"No solution file defined for '{member.Name}'.");
+        }
+
+        private string TryGetSolutionFileFromNukeFile()
+        {
+            var nukeFile = Path.Combine(NukeBuild.RootDirectory, Constants.NukeFileName);
+            if (!File.Exists(nukeFile))
+                return null;
+
+            var solutionFileRelative = File.ReadAllLines(nukeFile).ElementAtOrDefault(0);
+            ControlFlow.Assert(solutionFileRelative != null && !solutionFileRelative.Contains(value: '\\'),
+                $"First line of {Constants.NukeFileName} must provide solution path using UNIX separators");
+
+            var solutionFile = Path.GetFullPath(Path.Combine(NukeBuild.RootDirectory, solutionFileRelative));
+            ControlFlow.Assert(File.Exists(solutionFile),
+                $"Solution file '{solutionFile}' provided via {Constants.NukeFileName} does not exist.");
 
-            var solutionFile = EnvironmentInfo.GetParameter<AbsolutePath>(member);
-            return solutionFile.NotNull(
-                new[]
-                {
-                    $"No solution file defined for '{member.Name}'.",
-                    $"Invoke: nuke --save-profile --{ParameterService.GetParameterDashedName(member)} <value>"
-                }.JoinNewLine());
+            return (AbsolutePath) solutionFile;
         }
     }
 }
diff --git a/source/Nuke.GlobalTool/Program.Complete.cs b/source/Nuke.GlobalTool/Program.Complete.cs
@@ -3,6 +3,7 @@
 // https://github.com/nuke-build/nuke/blob/master/LICENSE
 
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using JetBrains.Annotations;
@@ -31,15 +32,17 @@ public static int Complete(string[] args, [CanBeNull] AbsolutePath rootDirectory
             words = words.Substring(CommandName.Length).TrimStart();
 
             var buildSchemaFile = GetBuildSchemaFile(rootDirectory);
-            if (!File.Exists(buildSchemaFile))
+            var completionFile = GetCompletionFile(rootDirectory);
+            if (!File.Exists(buildSchemaFile) && !File.Exists(completionFile))
             {
                 Build(buildScript.NotNull(), $"--{CompletionParameterName}");
                 return 1;
             }
 
             var position = EnvironmentInfo.GetParameter<int?>("position");
-            var profileNames = GetProfileNames(rootDirectory);
-            var completionItems = SchemaUtility.GetCompletionItems(buildSchemaFile, profileNames);
+            var completionItems = IsLegacy(rootDirectory)
+                ? SerializationTasks.YamlDeserializeFromFile<Dictionary<string, string[]>>(completionFile)
+                : SchemaUtility.GetCompletionItems(buildSchemaFile, GetProfileNames(rootDirectory));
             foreach (var item in CompletionUtility.GetRelevantCompletionItems(words, completionItems))
                 Console.WriteLine(item);
 
diff --git a/source/Nuke.GlobalTool/Program.cs b/source/Nuke.GlobalTool/Program.cs
@@ -89,7 +89,7 @@ private static int Handle(string[] args, [CanBeNull] AbsolutePath rootDirectory,
             if (rootDirectory == null || buildScript == null)
             {
                 var missingItem = rootDirectory == null
-                    ? $"{Constants.NukeDirectoryName} directory"
+                    ? $"{Constants.NukeDirectoryName} directory/file"
                     : "build.ps1/sh files";
 
                 return UserConfirms($"Could not find {missingItem}. Do you want to setup a build?")

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,9 @@ public class ArgumentsFromParametersFileAttribute : BuildExtensionAttributeBase,`
`25`	`25`
`26`	`26`	`public void OnBuildCreated(NukeBuild build, IReadOnlyCollection<ExecutableTarget> executableTargets)`
`27`	`27`	`{`
	`28`	`+ if (!Directory.Exists(Constants.GetNukeDirectory(NukeBuild.RootDirectory)))`
	`29`	`+ return;`
	`30`	`+`
`28`	`31`	`var parameterMembers = ValueInjectionUtility.GetParameterMembers(build.GetType(), includeUnlisted: true);`
`29`	`32`	`var passwords = new Dictionary<string, byte[]>();`
`30`	`33`
Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,7 @@ namespace Nuke.Common`
`59`	`59`	`[HandleVisualStudioDebugging]`
`60`	`60`	`[InjectNonParameterValues(Priority = -100)]`
`61`	`61`	`// After finish`
	`62`	`+ [UpdateNotification]`
`62`	`63`	`[SerializeBuildServerState]`
`63`	`64`	`public abstract partial class NukeBuild : INukeBuild`
`64`	`65`	`{`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ private static int Handle(string[] args, [CanBeNull] AbsolutePath rootDirectory,`
`89`	`89`	`if (rootDirectory == null \|\| buildScript == null)`
`90`	`90`	`{`
`91`	`91`	`var missingItem = rootDirectory == null`
`92`		`- ? $"{Constants.NukeDirectoryName} directory"`
	`92`	`+ ? $"{Constants.NukeDirectoryName} directory/file"`
`93`	`93`	`: "build.ps1/sh files";`
`94`	`94`
`95`	`95`	`return UserConfirms($"Could not find {missingItem}. Do you want to setup a build?")`