Make all Multitool command and options classes public, (#1988)

Co-authored-by: Larry Golding <lgolding@comcast.net>
microsoft · Jul 10, 2020 · 79588b5 · 79588b5
1 parent 3e6645f
commit 79588b5
Show file tree

Hide file tree

Showing 26 changed files with 32 additions and 29 deletions.
diff --git a/src/ReleaseHistory.md b/src/ReleaseHistory.md
@@ -1,5 +1,8 @@
 # SARIF Package Release History (SDK, Driver, Converters, and Multitool)
 
+## **v2.3.2** [Sdk](https://www.nuget.org/packages/Sarif.Sdk/2.3.2) | [Driver](https://www.nuget.org/packages/Sarif.Driver/2.3.2) | [Converters](https://www.nuget.org/packages/Sarif.Converters/2.3.2) | [Multitool](https://www.nuget.org/packages/Sarif.Multitool/2.3.2)
+* FEATURE: The `Sarif.Multitool` command line verbs are now exposed programmatically. For example, the `validate` verb is exposed through the classes `ValidateCommand` and `ValidateOptions`.
+
 ## **v2.3.1** [Sdk](https://www.nuget.org/packages/Sarif.Sdk/2.3.1) | [Driver](https://www.nuget.org/packages/Sarif.Driver/2.3.1) | [Converters](https://www.nuget.org/packages/Sarif.Converters/2.3.1) | [Multitool](https://www.nuget.org/packages/Sarif.Multitool/2.3.1)
 * FEATURE: Revised and improved validation rules in `Sarif.Multitool`.
 * FEATURE: Properties serialization performance improved (~20% faster load when Results use Properties).

diff --git a/src/Sarif.Multitool/AbsoluteUriCommand.cs b/src/Sarif.Multitool/AbsoluteUriCommand.cs
@@ -11,7 +11,7 @@
 
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
-    internal class AbsoluteUriCommand : CommandBase
+    public class AbsoluteUriCommand : CommandBase
     {
         private readonly IFileSystem _fileSystem;
 

diff --git a/src/Sarif.Multitool/AbsoluteUriOptions.cs b/src/Sarif.Multitool/AbsoluteUriOptions.cs
@@ -7,7 +7,7 @@
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
     [Verb("absoluteuri", HelpText = "Turn all relative Uris into absolute URIs (to be used after rebaseUri is run)")]
-    internal class AbsoluteUriOptions : MultipleFilesOptionsBase
+    public class AbsoluteUriOptions : MultipleFilesOptionsBase
     {
 
     }

diff --git a/src/Sarif.Multitool/ConvertCommand.cs b/src/Sarif.Multitool/ConvertCommand.cs
@@ -10,7 +10,7 @@
 
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
-    internal class ConvertCommand : CommandBase
+    public class ConvertCommand : CommandBase
     {
         public int Run(ConvertOptions convertOptions, IFileSystem fileSystem = null)
         {

diff --git a/src/Sarif.Multitool/ConvertOptions.cs b/src/Sarif.Multitool/ConvertOptions.cs
@@ -7,7 +7,7 @@
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
     [Verb("convert", HelpText = "Convert a tool output log to SARIF format.")]
-    internal class ConvertOptions : SingleFileOptionsBase
+    public class ConvertOptions : SingleFileOptionsBase
     {
         [Option(
             't',

diff --git a/src/Sarif.Multitool/FileWorkItemsCommand.cs b/src/Sarif.Multitool/FileWorkItemsCommand.cs
@@ -25,7 +25,7 @@ namespace Microsoft.CodeAnalysis.Sarif.Multitool
     /// configured options are valid, the command will instantiate an instance of 
     /// SarifWorkItemFiler in order to complete the work.
     /// </summary>
-    internal class FileWorkItemsCommand : CommandBase
+    public class FileWorkItemsCommand : CommandBase
     {
         [ThreadStatic]
         internal static bool s_validateOptionsOnly;

diff --git a/src/Sarif.Multitool/MergeCommand.cs b/src/Sarif.Multitool/MergeCommand.cs
@@ -11,7 +11,7 @@
 
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
-    internal class MergeCommand : CommandBase
+    public class MergeCommand : CommandBase
     {
         private readonly IFileSystem _fileSystem;
 

diff --git a/src/Sarif.Multitool/MergeOptions.cs b/src/Sarif.Multitool/MergeOptions.cs
@@ -7,7 +7,7 @@
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
     [Verb("merge", HelpText = "Merge multiple SARIF files into one.")]
-    internal class MergeOptions : MultipleFilesOptionsBase
+    public class MergeOptions : MultipleFilesOptionsBase
     {
         [Option(
             "output-file",

diff --git a/src/Sarif.Multitool/PageCommand.cs b/src/Sarif.Multitool/PageCommand.cs
@@ -13,7 +13,7 @@
 
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
-    internal class PageCommand : CommandBase
+    public class PageCommand : CommandBase
     {
         private readonly IFileSystem _fileSystem;
 

diff --git a/src/Sarif.Multitool/PageOptions.cs b/src/Sarif.Multitool/PageOptions.cs
@@ -16,7 +16,7 @@ namespace Microsoft.CodeAnalysis.Sarif.Multitool
     ///    inline: We build a map of the input, so we don't want to write inline and immediately invalidate it.
     /// </remarks>
     [Verb("page", HelpText = "Extract a subset of results from a source SARIF file.")]
-    internal class PageOptions
+    public class PageOptions
     {
         [Value(0,
             MetaName = "<inputFile>",

diff --git a/src/Sarif.Multitool/QueryCommand.cs b/src/Sarif.Multitool/QueryCommand.cs
@@ -13,7 +13,7 @@
 
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
-    internal class QueryCommand : CommandBase
+    public class QueryCommand : CommandBase
     {
         private const int TOO_MANY_RESULTS = 2;
 

diff --git a/src/Sarif.Multitool/QueryOptions.cs b/src/Sarif.Multitool/QueryOptions.cs
@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif.Multitool
     ///  and shows results.
     /// </summary>
     [Verb("query", HelpText = "Find the matching subset of a SARIF file and output it or log it.")]
-    internal class QueryOptions
+    public class QueryOptions
     {
         [Value(0,
             MetaName = "<inputFile>",

diff --git a/src/Sarif.Multitool/RebaseUriCommand.cs b/src/Sarif.Multitool/RebaseUriCommand.cs
@@ -13,7 +13,7 @@
 
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
-    internal class RebaseUriCommand : CommandBase
+    public class RebaseUriCommand : CommandBase
     {
         private readonly IFileSystem _fileSystem;
 

diff --git a/src/Sarif.Multitool/RebaseUriOptions.cs b/src/Sarif.Multitool/RebaseUriOptions.cs
@@ -7,7 +7,7 @@
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
     [Verb("rebaseuri", HelpText = "Rebase the URIs in one or more sarif files.")]
-    internal class RebaseUriOptions : MultipleFilesOptionsBase
+    public class RebaseUriOptions : MultipleFilesOptionsBase
     {
         [Option(
             'b',

diff --git a/src/Sarif.Multitool/ResultMatchSetCommand.cs b/src/Sarif.Multitool/ResultMatchSetCommand.cs
@@ -13,7 +13,7 @@
 
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
-    internal class ResultMatchSetCommand : CommandBase
+    public class ResultMatchSetCommand : CommandBase
     {
         private readonly IFileSystem _fileSystem;
 

diff --git a/src/Sarif.Multitool/ResultMatchSetOptions.cs b/src/Sarif.Multitool/ResultMatchSetOptions.cs
@@ -7,7 +7,7 @@
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
     [Verb("result-match-set", HelpText = "Match Results across runs in the same Group in a folder.")]
-    internal class ResultMatchSetOptions : CommonOptionsBase
+    public class ResultMatchSetOptions : CommonOptionsBase
     {
         [Value(0,
             MetaName = "folder-path",

diff --git a/src/Sarif.Multitool/ResultMatchingCommand.cs b/src/Sarif.Multitool/ResultMatchingCommand.cs
@@ -10,7 +10,7 @@
 
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
-    internal class ResultMatchingCommand : CommandBase
+    public class ResultMatchingCommand : CommandBase
     {
         private readonly IFileSystem _fileSystem;
 

diff --git a/src/Sarif.Multitool/ResultMatchingOptions.cs b/src/Sarif.Multitool/ResultMatchingOptions.cs
@@ -8,7 +8,7 @@
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
     [Verb("match-results-forward", HelpText = "Track results run over run by persisting IDs and then matching them forward")]
-    internal class ResultMatchingOptions : CommonOptionsBase
+    public class ResultMatchingOptions : CommonOptionsBase
     {
         [Option(
             'r',

diff --git a/src/Sarif.Multitool/RewriteCommand.cs b/src/Sarif.Multitool/RewriteCommand.cs
@@ -11,7 +11,7 @@
 
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
-    internal class RewriteCommand : CommandBase
+    public class RewriteCommand : CommandBase
     {
         private readonly IFileSystem _fileSystem;
 

diff --git a/src/Sarif.Multitool/RewriteOptions.cs b/src/Sarif.Multitool/RewriteOptions.cs
@@ -7,7 +7,7 @@
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
     [Verb("rewrite", HelpText = "Transform a SARIF file to a reformatted version.")]
-    internal class RewriteOptions : SingleFileOptionsBase
+    public class RewriteOptions : SingleFileOptionsBase
     {
 
     }

diff --git a/src/Sarif.Multitool/TransformCommand.cs b/src/Sarif.Multitool/TransformCommand.cs
@@ -12,7 +12,7 @@
 
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
-    internal class TransformCommand : CommandBase
+    public class TransformCommand : CommandBase
     {
         private readonly IFileSystem _fileSystem;
 

diff --git a/src/Sarif.Multitool/TransformOptions.cs b/src/Sarif.Multitool/TransformOptions.cs
@@ -7,7 +7,7 @@
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
     [Verb("transform", HelpText = "Transform a SARIF log to a different version.")]
-    internal class TransformOptions : SingleFileOptionsBase
+    public class TransformOptions : SingleFileOptionsBase
     {
     }
 }
diff --git a/src/Sarif.Multitool/ValidateCommand.cs b/src/Sarif.Multitool/ValidateCommand.cs
@@ -13,7 +13,7 @@
 
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
-    internal class ValidateCommand : AnalyzeCommandBase<SarifValidationContext, ValidateOptions>
+    public class ValidateCommand : AnalyzeCommandBase<SarifValidationContext, ValidateOptions>
     {
         private List<Assembly> _defaultPlugInAssemblies;
 
@@ -143,7 +143,7 @@ private void PerformSchemaValidation(
                 string schemaResource = "Microsoft.CodeAnalysis.Sarif.Multitool.sarif-2.1.0.json";
 
                 using (Stream stream = this.GetType().Assembly.GetManifestResourceStream(schemaResource))
-                using (StreamReader reader = new StreamReader(stream))
+                using (var reader = new StreamReader(stream))
                 {
                     schemaText = reader.ReadToEnd();
                 }

diff --git a/src/Sarif.Multitool/ValidateOptions.cs b/src/Sarif.Multitool/ValidateOptions.cs
@@ -7,7 +7,7 @@
 namespace Microsoft.CodeAnalysis.Sarif.Multitool
 {
     [Verb("validate", HelpText = "Validate a SARIF file against the schema and against additional correctness rules.")]
-    internal class ValidateOptions : AnalyzeOptionsBase
+    public class ValidateOptions : AnalyzeOptionsBase
     {
         [Option(
             'j',

diff --git a/src/Test.UnitTests.Sarif.Multitool/ValidateCommandTests.cs b/src/Test.UnitTests.Sarif.Multitool/ValidateCommandTests.cs
@@ -19,9 +19,9 @@ public class ValidateCommandTests
   ""type"": ""object""
 }";
         private const string SchemaFilePath = @"c:\schemas\SimpleSchemaForTest.json";
-        const string LogFileDirectory = @"C:\Users\John\logs";
-        const string LogFileName = "example.sarif";
-        const string OutputFilePath = @"C:\Users\John\output\example-validation.sarif";
+        private const string LogFileDirectory = @"C:\Users\John\logs";
+        private const string LogFileName = "example.sarif";
+        private const string OutputFilePath = @"C:\Users\John\output\example-validation.sarif";
 
         [Fact]
         [Trait(TestTraits.Bug, "/~https://github.com/microsoft/sarif-sdk/issues/1064")]

diff --git a/src/build.props b/src/build.props
@@ -20,8 +20,8 @@
     having all the relevant values in one place. This property is actually used by the PowerShell
     script that hides ("delists") the previous package versions on nuget.org.
     -->
-    <VersionPrefix>2.3.1</VersionPrefix>
-    <PreviousVersionPrefix>2.3.0</PreviousVersionPrefix>
+    <VersionPrefix>2.3.2</VersionPrefix>
+    <PreviousVersionPrefix>2.3.1</PreviousVersionPrefix>
 
      <!-- SchemaVersionAsPublishedToSchemaStoreOrg identifies the current published version on json schema store at https://schemastore.azurewebsites.net/schemas/json/ -->
     <SchemaVersionAsPublishedToSchemaStoreOrg>2.1.0-rtm.5</SchemaVersionAsPublishedToSchemaStoreOrg>