Add support to persist pip reports (#1224)

* add support to persist pip report * pr feedback
microsoft · Aug 12, 2024 · f27fe8e · f27fe8e
1 parent 924c4ea
commit f27fe8e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/src/Microsoft.ComponentDetection.Detectors/pip/PipCommandService.cs b/src/Microsoft.ComponentDetection.Detectors/pip/PipCommandService.cs
@@ -131,7 +131,7 @@ private async Task<CommandLineExecutionResult> ExecuteCommandAsync(
         var workingDir = new DirectoryInfo(this.pathUtilityService.GetParentDirectory(formattedPath));
 
         CommandLineExecutionResult command;
-        var reportName = Path.GetRandomFileName();
+        var reportName = Path.GetFileNameWithoutExtension(Path.GetRandomFileName()) + ".component-detection-pip-report.json";
         var reportFile = new FileInfo(Path.Combine(workingDir.FullName, reportName));
 
         string pipReportCommand;

diff --git a/src/Microsoft.ComponentDetection.Detectors/pip/PipReportComponentDetector.cs b/src/Microsoft.ComponentDetection.Detectors/pip/PipReportComponentDetector.cs
@@ -22,6 +22,7 @@ public class PipReportComponentDetector : FileComponentDetector
     private const string PipReportOverrideBehaviorEnvVar = "PipReportOverrideBehavior";
     private const string PipReportSkipFallbackOnFailureEnvVar = "PipReportSkipFallbackOnFailure";
     private const string PipReportFileLevelTimeoutSecondsEnvVar = "PipReportFileLevelTimeoutSeconds";
+    private const string PipReportPersistReportsEnvVar = "PipReportPersistReports";
 
     private static readonly IList<string> PipReportPreGeneratedFilePatterns = new List<string> { "*.component-detection-pip-report.json", "component-detection-pip-report.json" };
 
@@ -300,11 +301,14 @@ protected override async Task OnFileFoundAsync(ProcessRequest processRequest, ID
         finally
         {
             // Clean up the report output JSON file so it isn't left on the machine.
-            foreach (var reportFile in reportFiles)
+            if (!this.envVarService.IsEnvironmentVariableValueTrue(PipReportPersistReportsEnvVar))
             {
-                if (reportFile is not null && reportFile.Exists)
+                foreach (var reportFile in reportFiles)
                 {
-                    reportFile.Delete();
+                    if (reportFile is not null && reportFile.Exists)
+                    {
+                        reportFile.Delete();
+                    }
                 }
             }
         }