Enable export rules in multitool

src/Sarif.Driver/Sdk/CompositionUtilities.cs

@@ -9,7 +9,7 @@
 
 namespace Microsoft.CodeAnalysis.Sarif.Driver
 {
-    internal static class CompositionUtilities
+    public static class CompositionUtilities
     {
         public static ImmutableArray<T> GetExports<T>(IEnumerable<Assembly> assemblies)
         {

src/Sarif.Multitool/ExportRuleDocumentationCommand.cs

@@ -0,0 +1,66 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+using System.Text;
+
+using Microsoft.CodeAnalysis.Sarif.Driver;
+using Microsoft.CodeAnalysis.Sarif.Multitool.Rules;
+
+namespace Microsoft.CodeAnalysis.Sarif.Multitool
+{
+    public class ExportRuleDocumentationCommand : CommandBase
+    {
+        private readonly IFileSystem _fileSystem;
+
+        public ExportRuleDocumentationCommand(IFileSystem fileSystem = null)
+        {
+            _fileSystem = fileSystem ?? new FileSystem();
+        }
+
+        public int Run(ExportRuleDocumentationOptions options)
+        {
+            try
+            {
+                var rules = CompositionUtilities.GetExports<SarifValidationSkimmerBase>(
+                    new Assembly[] { Assembly.GetExecutingAssembly() }).ToList();
+
+                var sb = new StringBuilder();
+                sb.AppendLine($"# Rules{Environment.NewLine}");
+
+                foreach (SarifValidationSkimmerBase rule in rules)
+                {
+                    BuildRule(rule, sb);
+                }
+
+                _fileSystem.WriteAllText(options.OutputFilePath, sb.ToString());
+            }
+            catch (Exception ex)
+            {
+                Console.WriteLine(ex);
+                return FAILURE;
+            }
+
+            return SUCCESS;
+        }
+
+        internal void BuildRule(SarifValidationSkimmerBase rule, StringBuilder sb)
+        {
+            sb.AppendLine($"## Rule `{rule.Moniker}`{Environment.NewLine}");
+            sb.AppendLine($"### Description{Environment.NewLine}");
+            sb.AppendLine($"{rule.FullDescription.Text}{Environment.NewLine}");
+            sb.AppendLine($"### Messages{Environment.NewLine}");
+
+            foreach (KeyValuePair<string, MultiformatMessageString> message in rule.MessageStrings)
+            {
+                sb.AppendLine($"#### `{message.Key.Split('_').Last()}`: {rule.DefaultLevel}{Environment.NewLine}");
+                sb.AppendLine($"{message.Value.Text}{Environment.NewLine}");
+            }
+
+            sb.AppendLine($"---{Environment.NewLine}");
+        }
+    }
+}

src/Sarif.Multitool/ExportRuleDocumentationOptions.cs

@@ -0,0 +1,17 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using CommandLine;
+
+namespace Microsoft.CodeAnalysis.Sarif.Multitool
+{
+    [Verb("export-rule-documentation", HelpText = "Export the documentation for the validation rules to a Markdown file.")]
+    public class ExportRuleDocumentationOptions
+    {
+        [Option(
+               'o',
+               "output-file-path",
+               HelpText = "Path to the generated Markdown file. Default: ValidationRules.md in the current directory.")]
+        public string OutputFilePath { get; internal set; }
+    }
+}

src/Sarif.Multitool/Program.cs

@@ -13,6 +13,7 @@ internal static class Program
         public static int Main(string[] args)
         {
             return Parser.Default.ParseArguments<
+                ExportRuleDocumentationOptions,
                 ValidateOptions,
                 ConvertOptions,
                 RewriteOptions,
@@ -26,6 +27,7 @@ public static int Main(string[] args)
                 ResultMatchSetOptions,
                 FileWorkItemsOptions>(args)
                 .MapResult(
+                (ExportRuleDocumentationOptions options) => new ExportRuleDocumentationCommand().Run(options),
                 (ValidateOptions validateOptions) => new ValidateCommand().Run(validateOptions),
                 (ConvertOptions convertOptions) => new ConvertCommand().Run(convertOptions),
                 (RewriteOptions rewriteOptions) => new RewriteCommand().Run(rewriteOptions),

src/Test.UnitTests.Sarif.Multitool/ExportRuleDocumentationCommandTests.cs

@@ -0,0 +1,40 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Collections.Generic;
+using System.Text;
+using FluentAssertions;
+using Microsoft.CodeAnalysis.Sarif.Multitool.Rules;
+using Xunit;
+
+namespace Microsoft.CodeAnalysis.Sarif.Multitool
+{
+    public class ExportRuleDocumentationCommandTests
+    {
+        [Fact]
+        public void BuildRule_GeneratesExpectedMarkdown()
+        {
+            var resourceExtractor = new ResourceExtractor(this.GetType());
+            var sb = new StringBuilder();
+            var testRule = new TestRule();
+            var command = new ExportRuleDocumentationCommand();
+            command.BuildRule(testRule, sb);
+
+            string expectedMarkdown = resourceExtractor.GetResourceText("Test.md");
+
+            sb.ToString().Should().Be(expectedMarkdown);
+        }
+
+        private class TestRule : SarifValidationSkimmerBase
+        {
+            public override string Id => "TEST0001";
+            public override string Name => "TEST";
+            public override FailureLevel DefaultLevel => FailureLevel.Note;
+            public override MultiformatMessageString FullDescription => new MultiformatMessageString { Text = "full description text" };
+            public override IDictionary<string, MultiformatMessageString> MessageStrings => new Dictionary<string, MultiformatMessageString>
+            {
+                { "TEST0001_TEST_Note_Default", new MultiformatMessageString{ Text="default text"} }
+            };
+        }
+    }
+}

src/Test.UnitTests.Sarif.Multitool/Test.UnitTests.Sarif.Multitool.csproj

@@ -15,6 +15,7 @@
 
   <ItemGroup>
     <None Remove="TestData\ConvertCommand\SemmleQlSample.csv" />
+    <None Remove="TestData\ExportRuleDocumentationCommand\ExpectedOutputs\Test.md" />
     <None Remove="TestData\MergeCommand\ExpectedOutputs\NoInputFiles.sarif" />
     <None Remove="TestData\PageCommand\elfie-arriba - Copy.sarif" />
     <None Remove="TestData\PageCommand\elfie-arriba.sarif" />
@@ -24,6 +25,7 @@
 
   <ItemGroup>
     <EmbeddedResource Include="TestData\ConvertCommand\SemmleQlSample.csv" />
+    <EmbeddedResource Include="TestData\ExportRuleDocumentationCommand\ExpectedOutputs\Test.md" />
     <EmbeddedResource Include="TestData\MergeCommand\ExpectedOutputs\NoInputFiles.sarif" />
     <EmbeddedResource Include="TestData\QueryCommand\elfie-arriba.CSCAN0020.sarif" />
     <EmbeddedResource Include="TestData\PageCommand\elfie-arriba.sarif" />

src/Test.UnitTests.Sarif.Multitool/TestData/ExportRuleDocumentationCommand/ExpectedOutputs/Test.md

@@ -0,0 +1,14 @@
+## Rule `TEST0001.TEST`
+
+### Description
+
+full description text
+
+### Messages
+
+#### `Default`: Note
+
+default text
+
+---
+