Include guid in build artifacts directory when --keepFiles is specified.

timcassell · timcassell · commit 180311fd3f6e · 2023-09-02T11:11:56.000-04:00
diff --git a/src/BenchmarkDotNet/Running/BuildPartition.cs b/src/BenchmarkDotNet/Running/BuildPartition.cs
@@ -19,7 +19,10 @@ public BuildPartition(BenchmarkBuildInfo[] benchmarks, IResolver resolver)
             Resolver = resolver;
             RepresentativeBenchmarkCase = benchmarks[0].BenchmarkCase;
             Benchmarks = benchmarks;
-            ProgramName = benchmarks[0].Config.Options.IsSet(ConfigOptions.KeepBenchmarkFiles) ? RepresentativeBenchmarkCase.Job.FolderInfo : Guid.NewGuid().ToString();
+            var keepBenchmarkFiles = benchmarks[0].Config.Options.IsSet(ConfigOptions.KeepBenchmarkFiles);
+            var guid = Guid.NewGuid().ToString();
+            ProgramName = keepBenchmarkFiles ? RepresentativeBenchmarkCase.Job.FolderInfo : guid;
+            ProgramDirectory = keepBenchmarkFiles ? Path.Combine(RepresentativeBenchmarkCase.Job.FolderInfo, guid) : guid;
             LogBuildOutput = benchmarks[0].Config.Options.IsSet(ConfigOptions.LogBuildOutput);
             GenerateMSBuildBinLog = benchmarks[0].Config.Options.IsSet(ConfigOptions.GenerateMSBuildBinLog);
         }
@@ -28,6 +31,8 @@ public BuildPartition(BenchmarkBuildInfo[] benchmarks, IResolver resolver)
 
         public string ProgramName { get; }
 
+        public string ProgramDirectory { get; }
+
         /// <summary>
         /// the benchmarks are grouped by the build settings
         /// so you can use this benchmark to get the runtime settings
diff --git a/src/BenchmarkDotNet/Toolchains/DotNetCli/DotNetCliGenerator.cs b/src/BenchmarkDotNet/Toolchains/DotNetCli/DotNetCliGenerator.cs
@@ -36,19 +36,19 @@ protected DotNetCliGenerator(string targetFrameworkMoniker, string cliPath, stri
         /// we are limited by xprojs (by default compiles all .cs files in all subfolders, Program.cs could be doubled and fail the build)
         /// and also by NuGet internal implementation like looking for global.json file in parent folders
         /// </summary>
-        protected override string GetBuildArtifactsDirectoryPath(BuildPartition buildPartition, string programName)
+        protected override string GetBuildArtifactsDirectoryPath(BuildPartition buildPartition, string programDirectory)
         {
             if (GetSolutionRootDirectory(out var directoryInfo))
             {
-                return Path.Combine(directoryInfo.FullName, programName);
+                return Path.Combine(directoryInfo.FullName, programDirectory);
             }
 
             // we did not find global.json or any Visual Studio solution file?
             // let's return it in the old way and hope that it works ;)
             var parent = new DirectoryInfo(Directory.GetCurrentDirectory()).Parent;
             if (parent == null)
                 throw new DirectoryNotFoundException("Parent directory for current directory");
-            return Path.Combine(parent.FullName, programName);
+            return Path.Combine(parent.FullName, programDirectory);
         }
 
         internal static bool GetSolutionRootDirectory(out DirectoryInfo directoryInfo)
diff --git a/src/BenchmarkDotNet/Toolchains/GeneratorBase.cs b/src/BenchmarkDotNet/Toolchains/GeneratorBase.cs
@@ -40,7 +40,7 @@ public GenerateResult GenerateProject(BuildPartition buildPartition, ILogger log
         /// <summary>
         /// returns a path to the folder where auto-generated project and code are going to be placed
         /// </summary>
-        [PublicAPI] protected abstract string GetBuildArtifactsDirectoryPath(BuildPartition assemblyLocation, string programName);
+        [PublicAPI] protected abstract string GetBuildArtifactsDirectoryPath(BuildPartition assemblyLocation, string programDirectory);
 
         /// <summary>
         /// returns a path where executable should be found after the build
@@ -118,10 +118,10 @@ private ArtifactsPaths GetArtifactsPaths(BuildPartition buildPartition, string r
             // its not ".cs" in order to avoid VS from displaying and compiling it with xprojs/csprojs that include all *.cs by default
             const string codeFileExtension = ".notcs";
 
-            string programName = buildPartition.ProgramName;
-            string buildArtifactsDirectoryPath = GetBuildArtifactsDirectoryPath(buildPartition, programName);
+            string buildArtifactsDirectoryPath = GetBuildArtifactsDirectoryPath(buildPartition, buildPartition.ProgramDirectory);
             string binariesDirectoryPath = GetBinariesDirectoryPath(buildArtifactsDirectoryPath, buildPartition.BuildConfiguration);
 
+            string programName = buildPartition.ProgramName;
             string executablePath = GetExecutablePath(binariesDirectoryPath, programName);
 
             return new ArtifactsPaths(
diff --git a/src/BenchmarkDotNet/Toolchains/NativeAot/Generator.cs b/src/BenchmarkDotNet/Toolchains/NativeAot/Generator.cs
@@ -57,10 +57,10 @@ internal Generator(string ilCompilerVersion,
 
         protected override string GetExecutableExtension() => RuntimeInformation.ExecutableExtension;
 
-        protected override string GetBuildArtifactsDirectoryPath(BuildPartition buildPartition, string programName)
+        protected override string GetBuildArtifactsDirectoryPath(BuildPartition buildPartition, string programDirectory)
             => useTempFolderForRestore
-                ? Path.Combine(Path.GetTempPath(), programName) // store everything in temp to avoid collisions with IDE
-                : base.GetBuildArtifactsDirectoryPath(buildPartition, programName);
+                ? Path.Combine(Path.GetTempPath(), programDirectory) // store everything in temp to avoid collisions with IDE
+                : base.GetBuildArtifactsDirectoryPath(buildPartition, programDirectory);
 
         protected override string GetBinariesDirectoryPath(string buildArtifactsDirectoryPath, string configuration)
             => Path.Combine(buildArtifactsDirectoryPath, "bin", configuration, TargetFrameworkMoniker, runtimeIdentifier, "publish");
diff --git a/src/BenchmarkDotNet/Toolchains/Roslyn/Generator.cs b/src/BenchmarkDotNet/Toolchains/Roslyn/Generator.cs
@@ -12,7 +12,7 @@ namespace BenchmarkDotNet.Toolchains.Roslyn
     [PublicAPI]
     public class Generator : GeneratorBase
     {
-        protected override string GetBuildArtifactsDirectoryPath(BuildPartition buildPartition, string programName)
+        protected override string GetBuildArtifactsDirectoryPath(BuildPartition buildPartition, string programDirectory)
             => Path.GetDirectoryName(buildPartition.AssemblyLocation);
 
         [PublicAPI]
diff --git a/tests/BenchmarkDotNet.Tests/CsProjGeneratorTests.cs b/tests/BenchmarkDotNet.Tests/CsProjGeneratorTests.cs
@@ -208,9 +208,9 @@ public void TestAssemblyFilePathIsUsedWhenTheAssemblyLocationIsNotEmpty()
 
         private class SteamLoadedBuildPartition : CsProjGenerator
         {
-            internal string ResolvePathForBinaries(BuildPartition buildPartition, string programName)
+            internal string ResolvePathForBinaries(BuildPartition buildPartition, string programDirectory)
             {
-                return base.GetBuildArtifactsDirectoryPath(buildPartition, programName);
+                return base.GetBuildArtifactsDirectoryPath(buildPartition, programDirectory);
             }
 
             public SteamLoadedBuildPartition(string targetFrameworkMoniker, string cliPath, string packagesPath, string runtimeFrameworkVersion, bool isNetCore)

Original file line number	Diff line number	Diff line change
`@@ -36,19 +36,19 @@ protected DotNetCliGenerator(string targetFrameworkMoniker, string cliPath, stri`
`36`	`36`	`/// we are limited by xprojs (by default compiles all .cs files in all subfolders, Program.cs could be doubled and fail the build)`
`37`	`37`	`/// and also by NuGet internal implementation like looking for global.json file in parent folders`
`38`	`38`	`/// </summary>`
`39`		`- protected override string GetBuildArtifactsDirectoryPath(BuildPartition buildPartition, string programName)`
	`39`	`+ protected override string GetBuildArtifactsDirectoryPath(BuildPartition buildPartition, string programDirectory)`
`40`	`40`	`{`
`41`	`41`	`if (GetSolutionRootDirectory(out var directoryInfo))`
`42`	`42`	`{`
`43`		`- return Path.Combine(directoryInfo.FullName, programName);`
	`43`	`+ return Path.Combine(directoryInfo.FullName, programDirectory);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`// we did not find global.json or any Visual Studio solution file?`
`47`	`47`	`// let's return it in the old way and hope that it works ;)`
`48`	`48`	`var parent = new DirectoryInfo(Directory.GetCurrentDirectory()).Parent;`
`49`	`49`	`if (parent == null)`
`50`	`50`	`throw new DirectoryNotFoundException("Parent directory for current directory");`
`51`		`- return Path.Combine(parent.FullName, programName);`
	`51`	`+ return Path.Combine(parent.FullName, programDirectory);`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`internal static bool GetSolutionRootDirectory(out DirectoryInfo directoryInfo)`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ namespace BenchmarkDotNet.Toolchains.Roslyn`
`12`	`12`	`[PublicAPI]`
`13`	`13`	`public class Generator : GeneratorBase`
`14`	`14`	`{`
`15`		`- protected override string GetBuildArtifactsDirectoryPath(BuildPartition buildPartition, string programName)`
	`15`	`+ protected override string GetBuildArtifactsDirectoryPath(BuildPartition buildPartition, string programDirectory)`
`16`	`16`	`=> Path.GetDirectoryName(buildPartition.AssemblyLocation);`
`17`	`17`
`18`	`18`	`[PublicAPI]`
Original file line number	Diff line number	Diff line change
`@@ -208,9 +208,9 @@ public void TestAssemblyFilePathIsUsedWhenTheAssemblyLocationIsNotEmpty()`
`208`	`208`
`209`	`209`	`private class SteamLoadedBuildPartition : CsProjGenerator`
`210`	`210`	`{`
`211`		`- internal string ResolvePathForBinaries(BuildPartition buildPartition, string programName)`
	`211`	`+ internal string ResolvePathForBinaries(BuildPartition buildPartition, string programDirectory)`
`212`	`212`	`{`
`213`		`- return base.GetBuildArtifactsDirectoryPath(buildPartition, programName);`
	`213`	`+ return base.GetBuildArtifactsDirectoryPath(buildPartition, programDirectory);`
`214`	`214`	`}`
`215`	`215`
`216`	`216`	`public SteamLoadedBuildPartition(string targetFrameworkMoniker, string cliPath, string packagesPath, string runtimeFrameworkVersion, bool isNetCore)`