Skip to content

feat: add --PrintManifest option #457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 6, 2023
Merged

feat: add --PrintManifest option #457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02f9313
feat: add `--PrintManifest` option
melotic Mar 6, 2023
805c1bc
fix: only write to stderr if `--PrintManifest`
melotic Mar 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/Microsoft.ComponentDetection.Orchestrator/ArgumentSets/BcdeArguments.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ public class BcdeArguments : BaseArguments, IDetectionArguments
[Option("ManifestFile", Required = false, HelpText = "The file to write scan results to.")]
public FileInfo ManifestFile { get; set; }

[Option("PrintManifest", Required = false, HelpText = "Prints the manifest to standard output. Logging will be redirected to standard error.")]
public bool PrintManifest { get; set; }

public string ManifestFileSerialized => this.ManifestFile?.ToString();

[Option("DockerImagesToScan", Required = false, Separator = ',', HelpText = "Comma separated list of docker image names or hashes to execute container scanning on, ex: ubuntu:16.04, 56bab49eef2ef07505f6a1b0d5bd3a601dfc3c76ad4460f24c91d6fa298369ab")]
Expand Down
2 changes: 2 additions & 0 deletions src/Microsoft.ComponentDetection.Orchestrator/ArgumentSets/IDetectionArguments.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,7 @@ public interface IDetectionArguments : IScanArguments

FileInfo ManifestFile { get; set; }

public bool PrintManifest { get; set; }

IEnumerable<string> DockerImagesToScan { get; set; }
}
6 changes: 5 additions & 1 deletion src/Microsoft.ComponentDetection.Orchestrator/Orchestrator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,11 @@ public async Task<ScanResult> LoadAsync(string[] args, CancellationToken cancell
var reloadableLogger = (ReloadableLogger)Log.Logger;
reloadableLogger.Reload(configuration =>
configuration
.WriteTo.Console()
.WriteTo.Console(standardErrorFromLevel: args.Contains(
$"--{nameof(IDetectionArguments.PrintManifest)}",
StringComparer.InvariantCultureIgnoreCase)
? LogEventLevel.Debug
: null)
.WriteTo.Async(x => x.File(logFile))
.WriteTo.Providers(this.serviceProvider.GetRequiredService<LoggerProviderCollection>())
.MinimumLevel.Is(baseArguments.Verbosity switch
Expand Down
12 changes: 10 additions & 2 deletions src/Microsoft.ComponentDetection.Orchestrator/Services/BcdeScanCommandService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
namespace Microsoft.ComponentDetection.Orchestrator.Services;

using System;
using System.IO;
using System.Threading.Tasks;
using Microsoft.ComponentDetection.Common;
Expand Down Expand Up @@ -53,13 +54,20 @@ private void WriteComponentManifest(IDetectionArguments detectionArguments, Scan
this.logger.LogInformation("Scan Manifest file: {ManifestFile}", this.fileWritingService.ResolveFilePath(ManifestRelativePath));
}

var manifestJson = JsonConvert.SerializeObject(scanResult, Formatting.Indented);

if (userRequestedManifestPath == null)
{
this.fileWritingService.AppendToFile(ManifestRelativePath, JsonConvert.SerializeObject(scanResult, Formatting.Indented));
this.fileWritingService.AppendToFile(ManifestRelativePath, manifestJson);
}
else
{
this.fileWritingService.WriteFile(userRequestedManifestPath, JsonConvert.SerializeObject(scanResult, Formatting.Indented));
this.fileWritingService.WriteFile(userRequestedManifestPath, manifestJson);
}

if (detectionArguments.PrintManifest)
{
Console.WriteLine(manifestJson);
}
}
}