Merge pull request github#15063 from hvitved/csharp/use-scratch-dir

C#: Use `CODEQL_EXTRACTOR_CSHARP_SCRATCH_DIR` instead of `Path.GetTempPath`

Author: hvitved

cpp/autobuilder/Semmle.Autobuild.Cpp.Tests/BuildScripts.cs

@@ -326,7 +326,7 @@ public void TestDefaultCppAutobuilder()
         public void TestCppAutobuilderSuccess()
         {
             Actions.RunProcess[@"cmd.exe /C nuget restore C:\Project\test.sln -DisableParallelProcessing"] = 1;
-            Actions.RunProcess[@"cmd.exe /C C:\Project\.nuget\nuget.exe restore C:\Project\test.sln -DisableParallelProcessing"] = 0;
+            Actions.RunProcess[@"cmd.exe /C scratch\.nuget\nuget.exe restore C:\Project\test.sln -DisableParallelProcessing"] = 0;
             Actions.RunProcess[@"cmd.exe /C CALL ^""C:\Program^ Files^ ^(x86^)\Microsoft^ Visual^ Studio^ 14.0\VC\vcvarsall.bat^"" && set Platform=&& type NUL && msbuild C:\Project\test.sln /t:rebuild /p:Platform=""x86"" /p:Configuration=""Release"""] = 0;
             Actions.RunProcessOut[@"C:\Program Files (x86)\Microsoft Visual Studio\Installer\vswhere.exe -prerelease -legacy -property installationPath"] = "";
             Actions.RunProcess[@"C:\Program Files (x86)\Microsoft Visual Studio\Installer\vswhere.exe -prerelease -legacy -property installationPath"] = 1;
@@ -337,10 +337,11 @@ public void TestCppAutobuilderSuccess()
             Actions.FileExists[@"C:\Program Files (x86)\Microsoft Visual Studio 11.0\VC\vcvarsall.bat"] = true;
             Actions.FileExists[@"C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\vcvarsall.bat"] = true;
             Actions.FileExists[@"C:\Program Files (x86)\Microsoft Visual Studio\Installer\vswhere.exe"] = true;
+            Actions.GetEnvironmentVariable["CODEQL_EXTRACTOR_CPP_SCRATCH_DIR"] = "scratch";
             Actions.EnumerateFiles[@"C:\Project"] = "foo.cs\ntest.slx";
             Actions.EnumerateDirectories[@"C:\Project"] = "";
-            Actions.CreateDirectories.Add(@"C:\Project\.nuget");
-            Actions.DownloadFiles.Add(("https://dist.nuget.org/win-x86-commandline/latest/nuget.exe", @"C:\Project\.nuget\nuget.exe"));
+            Actions.CreateDirectories.Add(@"scratch\.nuget");
+            Actions.DownloadFiles.Add(("https://dist.nuget.org/win-x86-commandline/latest/nuget.exe", @"scratch\.nuget\nuget.exe"));
 
             var autobuilder = CreateAutoBuilder(true);
             var solution = new TestSolution(@"C:\Project\test.sln");

csharp/autobuilder/Semmle.Autobuild.CSharp.Tests/BuildScripts.cs

@@ -81,7 +81,7 @@ public BuildScript Analyse(IAutobuilder<CSharpAutobuildOptions> builder, bool au
         /// </summary>
         public static BuildScript WithDotNet(IAutobuilder<AutobuildOptionsShared> builder, Func<string?, IDictionary<string, string>?, BuildScript> f)
         {
-            var installDir = builder.Actions.PathCombine(builder.Options.RootDirectory, ".dotnet");
+            var installDir = builder.Actions.PathCombine(FileUtils.GetTemporaryWorkingDirectory(builder.Actions.GetEnvironmentVariable, builder.Options.Language.UpperCaseName, out var _), ".dotnet");
             var installScript = DownloadDotNet(builder, installDir);
             return BuildScript.Bind(installScript, installed =>
             {

csharp/autobuilder/Semmle.Autobuild.CSharp/DotNetRule.cs

@@ -60,7 +60,7 @@ public BuildScript Analyse(IAutobuilder<AutobuildOptionsShared> builder, bool au
             // Use `nuget.exe` from source code repo, if present, otherwise first attempt with global
             // `nuget` command, and if that fails, attempt to download `nuget.exe` from nuget.org
             var nuget = builder.GetFilename("nuget.exe").Select(t => t.Item1).FirstOrDefault() ?? "nuget";
-            var nugetDownload = builder.Actions.PathCombine(builder.Options.RootDirectory, ".nuget", "nuget.exe");
+            var nugetDownloadPath = builder.Actions.PathCombine(FileUtils.GetTemporaryWorkingDirectory(builder.Actions.GetEnvironmentVariable, builder.Options.Language.UpperCaseName, out var _), ".nuget", "nuget.exe");
             var nugetDownloaded = false;
 
             var ret = BuildScript.Success;
@@ -96,13 +96,13 @@ BuildScript GetNugetRestoreScript() =>
                         // If `nuget restore` fails, and we have not already attempted to download `nuget.exe`,
                         // download it and reattempt `nuget restore`.
                         var nugetDownloadAndRestore =
-                            BuildScript.Bind(DownloadNugetExe(builder, nugetDownload), exitCode =>
+                            BuildScript.Bind(DownloadNugetExe(builder, nugetDownloadPath), exitCode =>
                             {
                                 nugetDownloaded = true;
                                 if (exitCode != 0)
                                     return BuildScript.Failure;
 
-                                nuget = nugetDownload;
+                                nuget = nugetDownloadPath;
                                 return GetNugetRestoreScript();
                             });
                         ret &= BuildScript.Try(nugetRestore | nugetDownloadAndRestore | msbuildRestoreCommand.Script);

csharp/autobuilder/Semmle.Autobuild.Shared/MsBuildRule.cs

@@ -479,7 +479,7 @@ private static string ComputeTempDirectory(string srcDir, string packages = "pac
             foreach (var b in sha.Take(8))
                 sb.AppendFormat("{0:x2}", b);
 
-            return Path.Combine(Path.GetTempPath(), "GitHub", packages, sb.ToString());
+            return Path.Combine(FileUtils.GetTemporaryWorkingDirectory(out var _), "GitHub", packages, sb.ToString());
         }
 
         /// <summary>

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/DependencyManager.cs

@@ -3,6 +3,7 @@
 using System.IO;
 using System.Text;
 using System.Linq;
+using Semmle.Util;
 
 namespace Semmle.Extraction.CSharp.DependencyFetching
 {
@@ -51,7 +52,7 @@ private static void GenerateAnalyzerConfig(IEnumerable<string> cshtmls, string a
         public IEnumerable<string> GenerateFiles(IEnumerable<string> cshtmls, IEnumerable<string> references, string workingDirectory)
         {
             var name = Guid.NewGuid().ToString("N").ToUpper();
-            var tempPath = Path.GetTempPath();
+            var tempPath = FileUtils.GetTemporaryWorkingDirectory(out var _);
             var analyzerConfig = Path.Combine(tempPath, $"{name}.txt");
             var dllPath = Path.Combine(tempPath, $"{name}.dll");
             var cscArgsPath = Path.Combine(tempPath, $"{name}.rsp");

csharp/extractor/Semmle.Extraction.CSharp.DependencyFetching/Razor.cs

@@ -48,7 +48,7 @@ public TrapWriter(ILogger logger, PathTransformer.ITransformedPath outputfile, s
 
             writerLazy = new Lazy<StreamWriter>(() =>
             {
-                var tempPath = trap ?? Path.GetTempPath();
+                var tempPath = trap ?? FileUtils.GetTemporaryWorkingDirectory(out var _);
 
                 do
                 {

csharp/extractor/Semmle.Extraction/TrapWriter.cs

@@ -7,8 +7,6 @@ public class EnvironmentVariables
         public static string? GetExtractorOption(string name) =>
             Environment.GetEnvironmentVariable($"CODEQL_EXTRACTOR_CSHARP_OPTION_{name.ToUpper()}");
 
-        public static string? GetScratchDirectory() => Environment.GetEnvironmentVariable("CODEQL_EXTRACTOR_CSHARP_SCRATCH_DIR");
-
         public static int GetDefaultNumberOfThreads()
         {
             if (!int.TryParse(Environment.GetEnvironmentVariable("CODEQL_THREADS"), out var threads) || threads == -1)

csharp/extractor/Semmle.Util/EnvironmentVariables.cs

@@ -144,10 +144,10 @@ public static string NestPaths(ILogger logger, string? outerpath, string innerpa
             return nested;
         }
 
-        public static string GetTemporaryWorkingDirectory(out bool shouldCleanUp)
+        public static string GetTemporaryWorkingDirectory(Func<string, string?> getEnvironmentVariable, string lang, out bool shouldCleanUp)
         {
             shouldCleanUp = false;
-            var tempFolder = EnvironmentVariables.GetScratchDirectory();
+            var tempFolder = getEnvironmentVariable($"CODEQL_EXTRACTOR_{lang}_SCRATCH_DIR");
 
             if (string.IsNullOrEmpty(tempFolder))
             {
@@ -160,6 +160,9 @@ public static string GetTemporaryWorkingDirectory(out bool shouldCleanUp)
             return tempFolder;
         }
 
+        public static string GetTemporaryWorkingDirectory(out bool shouldCleanUp) =>
+            GetTemporaryWorkingDirectory(Environment.GetEnvironmentVariable, "CSHARP", out shouldCleanUp);
+
         public static FileInfo CreateTemporaryFile(string extension, out bool shouldCleanUpContainingFolder)
         {
             var tempFolder = GetTemporaryWorkingDirectory(out shouldCleanUpContainingFolder);