1.2 dev branch

.gitignore

@@ -261,12 +261,6 @@ __pycache__/
 *.pyc
 
 # App Inspector artifacts
-/AppInspector/htmlReport
-/AppInspectorLog.txt
-/AppInspector/Log.txt
-/AppInspector/LogB4.txt
-/AppInspector/wip.txt
-/AppInspector/linux/ApplicationInspector
-/Microsoft.DevSkim/linux/ApplicationInspector
-/AppInspector/Resources/defaultRules.json
+/AppInspector/Resources/defaultRulesPkd.json
 /UnitTest.Commands/output
+/RulesPacker/log.txt

AppInspector.CLI/AppInspector.CLI.csproj

@@ -33,6 +33,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\AppInspector\AppInspector.Commands.csproj" />
+    <ProjectReference Include="..\RulesEngine\AppInspector.RulesEngine.csproj" />
   </ItemGroup>
 
   <ItemGroup>
@@ -147,9 +148,6 @@
     <None Update="html\resources\webfonts\fa-solid-900.woff2">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
-    <None Update="preferences\tagcounters.json">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
     <None Update="preferences\tagreportgroups.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
@@ -159,4 +157,10 @@
     <None Include="..\LICENSE.txt" Pack="true" PackagePath="" />
     <None Include="..\icon-128.png" Pack="true" PackagePath="" />
   </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="DotLiquid" Version="2.0.325" />
+    <PackageReference Include="NLog" Version="4.7.0" />
+  </ItemGroup>
+
 </Project>

AppInspector/Commands/AllCommandOptions.cs → AppInspector.CLI/CLICmdOptions.cs

@@ -2,46 +2,37 @@
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 using CommandLine;
-using NLog;
+using Microsoft.ApplicationInspector.Commands;
 
-namespace Microsoft.ApplicationInspector.Commands
+namespace Microsoft.ApplicationInspector.CLI
 {
-    public class AllCommandOptions
+    /// <summary>
+    /// CLI command option classes add output arguments to common properties for each command verb
+    /// </summary>
+    ///
+    public class CLICommandOptions : CommandOptions
     {
-        public Logger Log { get; set; }
-
-        [Option('l', "log-file-path", Required = false, HelpText = "Log file path")]
-        public string LogFilePath { get; set; }
-        [Option('v', "log-file-level", Required = false, HelpText = "Log file level [Debug|Info|Warn|Error|Trace|Fatal|Off]", Default = "Error")]
-        public string LogFileLevel { get; set; }
-
-        public bool CloseLogOnCommandExit { get; set; }
+        [Option('o', "output-file-path", Required = false, HelpText = "Output file path")]
+        public string OutputFilePath { get; set; }
 
+        [Option('f', "output-file-format", Required = false, HelpText = "Output format [json|text]", Default = "text")]
+        public string OutputFileFormat { get; set; } = "text";
     }
+
     /// <summary>
-    /// Command option classes for each command verb
+    /// CLI command distinct arguments
     /// </summary>
-
     [Verb("analyze", HelpText = "Inspect source directory/file/compressed file (.tgz|zip) against defined characteristics")]
-    public class AnalyzeCommandOptions : AllCommandOptions
+    public class CLIAnalyzeCmdOptions : CLICommandOptions
     {
         [Option('s', "source-path", Required = true, HelpText = "Source file or directory to inspect")]
         public string SourcePath { get; set; }
 
-        [Option('o', "output-file-path", Required = false, HelpText = "Output file path")]
-        public string OutputFilePath { get; set; }
-
-        [Option('f', "output-file-format", Required = false, HelpText = "Output format [html|json|text]", Default = "html")]
-        public string OutputFileFormat { get; set; }
-
-        [Option('e', "text-format", Required = false, HelpText = "Match text format specifiers", Default = "Tag:%T,Rule:%N,Ruleid:%R,Confidence:%X,File:%F,Sourcetype:%t,Line:%L,Sample:%m")]
-        public string TextOutputFormat { get; set; }
-
         [Option('r', "custom-rules-path", Required = false, HelpText = "Custom rules file or directory path")]
         public string CustomRulesPath { get; set; }
 
-        [Option('t', "tag-output-only", Required = false, HelpText = "Output only identified tags", Default = false)]
-        public bool SimpleTagsOnly { get; set; }
+        [Option('h', "match-depth", Required = false, HelpText = "First match or best match based on confidence level (first|best)", Default = "best")]
+        public string MatchDepth { get; set; } = "best";
 
         [Option('i', "ignore-default-rules", Required = false, HelpText = "Exclude default rules bundled with application", Default = false)]
         public bool IgnoreDefaultRules { get; set; }
@@ -53,19 +44,23 @@ public class AnalyzeCommandOptions : AllCommandOptions
         public bool SuppressBrowserOpen { get; set; }
 
         [Option('c', "confidence-filters", Required = false, HelpText = "Output only matches with specified confidence <value>,<value> [high|medium|low]", Default = "high,medium")]
-        public string ConfidenceFilters { get; set; }
+        public string ConfidenceFilters { get; set; } = "high,medium";
 
         [Option('k', "file-path-exclusions", Required = false, HelpText = "Exclude source files (none|default: sample,example,test,docs,.vs,.git)", Default = "sample,example,test,docs,.vs,.git")]
-        public string FilePathExclusions { get; set; }
+        public string FilePathExclusions { get; set; } = "sample,example,test,docs,.vs,.git";
 
-        [Option('x', "console-verbosity", Required = false, HelpText = "Console verbosity [high|medium|low|none]", Default = "medium")]
-        public string ConsoleVerbosityLevel { get; set; }
+        [Option('f', "output-file-format", Required = false, HelpText = "Output format [html|json|text]", Default = "html")]
+        public new string OutputFileFormat { get; set; } = "html";
 
-    }
+        [Option('e', "text-format", Required = false, HelpText = "Match text format specifiers", Default = "Tag:%T,Rule:%N,Ruleid:%R,Confidence:%X,File:%F,Sourcetype:%t,Line:%L,Sample:%m")]
+        public string TextOutputFormat { get; set; } = "Tag:%T,Rule:%N,Ruleid:%R,Confidence:%X,File:%F,Sourcetype:%t,Line:%L,Sample:%m";
 
+        [Option('t', "tag-output-only", Required = false, HelpText = "Output only identified tags", Default = false)]
+        public bool SimpleTagsOnly { get; set; }
+    }
 
     [Verb("tagdiff", HelpText = "Compares unique tag values between two source paths")]
-    public class TagDiffCommandOptions : AllCommandOptions
+    public class CLITagDiffCmdOptions : CLICommandOptions
     {
         [Option("src1", Required = true, HelpText = "Source 1 to compare")]
         public string SourcePath1 { get; set; }
@@ -74,102 +69,70 @@ public class TagDiffCommandOptions : AllCommandOptions
         public string SourcePath2 { get; set; }
 
         [Option('t', "test-type", Required = false, HelpText = "Type of test to run [equality|inequality]", Default = "equality")]
-        public string TestType { get; set; }
+        public string TestType { get; set; } = "equality";
 
         [Option('k', "file-path-exclusions", Required = false, HelpText = "Exclude source files (none|default: sample,example,test,docs,.vs,.git)", Default = "sample,example,test,docs,.vs,.git")]
-        public string FilePathExclusions { get; set; }
+        public string FilePathExclusions { get; set; } = "sample,example,test,docs,.vs,.git";
 
         [Option('r', "custom-rules-path", Required = false, HelpText = "Custom rules file or directory path")]
         public string CustomRulesPath { get; set; }
 
         [Option('i', "ignore-default-rules", Required = false, HelpText = "Exclude default rules bundled with application", Default = false)]
         public bool IgnoreDefaultRules { get; set; }
-
-        [Option('o', "output-file-path", Required = false, HelpText = "Output file path")]
-        public string OutputFilePath { get; set; }
-
-        [Option('x', "console-verbosity", Required = false, HelpText = "Console verbosity [high|medium|low|none]", Default = "medium")]
-        public string ConsoleVerbosityLevel { get; set; }
-
     }
 
-
     [Verb("tagtest", HelpText = "Test (T/F) for presence of custom rule set in source")]
-    public class TagTestCommandOptions : AllCommandOptions
+    public class CLITagTestCmdOptions : CLICommandOptions
     {
         [Option('s', "source-path", Required = true, HelpText = "Source file or directory to inspect")]
         public string SourcePath { get; set; }
 
         [Option('t', "test-type", Required = false, HelpText = "Test to perform [rulespresent|rulesnotpresent] ", Default = "rulespresent")]
-        public string TestType { get; set; }
+        public string TestType { get; set; } = "rulespresent";
 
         [Option('r', "custom-rules-path", Required = false, HelpText = "Custom rules file or directory path")]
         public string CustomRulesPath { get; set; }
 
         [Option('k', "file-path-exclusions", Required = false, HelpText = "Exclude source files (none|default: sample,example,test,docs,.vs,.git)", Default = "sample,example,test,docs,.vs,.git")]
-        public string FilePathExclusions { get; set; }
-
-        [Option('o', "output-file-path", Required = false, HelpText = "Output file path")]
-        public string OutputFilePath { get; set; }
-
-        [Option('x', "console-verbosity", Required = false, HelpText = "Console verbosity [high|medium|low|none]", Default = "medium")]
-        public string ConsoleVerbosityLevel { get; set; }
-
+        public string FilePathExclusions { get; set; } = "sample,example,test,docs,.vs,.git";
     }
 
     [Verb("exporttags", HelpText = "Export unique rule tags to view what code features may be detected")]
-    public class ExportTagsCommandOptions : AllCommandOptions
+    public class CLIExportTagsCmdOptions : CLICommandOptions
     {
         [Option('r', "custom-rules-path", Required = false, HelpText = "Custom rules file or directory path")]
         public string CustomRulesPath { get; set; }
 
         [Option('i', "ignore-default-rules", Required = false, HelpText = "Exclude default rules bundled with application", Default = false)]
         public bool IgnoreDefaultRules { get; set; }
-
-        [Option('o', "output-file-path", Required = false, HelpText = "Output file path")]
-        public string OutputFilePath { get; set; }
-
-        [Option('x', "console-verbosity", Required = false, HelpText = "Console verbosity [high|medium|low|none]", Default = "medium")]
-        public string ConsoleVerbosityLevel { get; set; }
     }
 
-
     [Verb("verifyrules", HelpText = "Verify custom rules syntax is valid")]
-    public class VerifyRulesCommandOptions : AllCommandOptions
+    public class CLIVerifyRulesCmdOptions : CLICommandOptions
     {
         [Option('d', "verify-default-rules", Required = false, HelpText = "Verify default rules")]
         public bool VerifyDefaultRules { get; set; }
 
         [Option('r', "custom-rules-path", Required = false, HelpText = "Custom rules file or directory path")]
         public string CustomRulesPath { get; set; }
 
-        [Option('o', "output-file-path", Required = false, HelpText = "Output file path")]
-        public string OutputFilePath { get; set; }
-
-        [Option('x', "console-verbosity", Required = false, HelpText = "Console verbosity [high|medium|low|none]", Default = "medium")]
-        public string ConsoleVerbosityLevel { get; set; }
-
-
+        [Option('a', "fail-fast", Required = false, HelpText = "Fail fast", Default = false)]
+        public bool Failfast { get; set; }
     }
 
     [Verb("packrules", HelpText = "Combine multiple rule files into one file for ease in distribution")]
-    public class PackRulesCommandOptions : AllCommandOptions
+    public class CLIPackRulesCmdOptions : CLICommandOptions
     {
         [Option('d', "pack-default-rules", Required = false, HelpText = "Repack default rules. Automatic on Application Inspector build")]
         public bool RepackDefaultRules { get; set; }
 
         [Option('r', "custom-rules-path", Required = false, HelpText = "Custom rules file or directory path")]
         public string CustomRulesPath { get; set; }
 
-        [Option('o', "output-file-path", Required = false, HelpText = "Output file path")]
-        public string OutputFilePath { get; set; }
+        [Option('f', "output-file-format", Required = false, HelpText = "Output format [json|text]", Default = "json")]
+        public new string OutputFileFormat { get; set; } = "json";
 
         [Option('i', "not-indented", Required = false, HelpText = "Remove indentation from json output", Default = false)]
         public bool NotIndented { get; set; }
-
-        [Option('x', "console-verbosity", Required = false, HelpText = "Console verbosity [high|medium|low|none]", Default = "medium")]
-        public string ConsoleVerbosityLevel { get; set; }
-
     }
-
-}
+}