* Major add of unit tests for most commands.  Some fixes as a resulting benefit of these new tests to improve the core functionality and handle outlier behavior.

* Minor cleanup of unnecessary test dll's in Commands project and update of readme, justrunt docs.
This commit is contained in:
Guy Acosta 2020-03-30 05:18:36 -07:00 коммит произвёл GitHub
Родитель be818656c4
Коммит d13d4b99d8
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 18 добавлений и 9 удалений

Просмотреть файл

@ -55,8 +55,6 @@
<ItemGroup>
<PackageReference Include="CommandLineParser" Version="2.7.82" />
<PackageReference Include="DotLiquid" Version="2.0.314" />
<PackageReference Include="MSTest.TestAdapter" Version="2.1.0" />
<PackageReference Include="MSTest.TestFramework" Version="2.1.0" />
<PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
<PackageReference Include="NLog" Version="4.6.8" />
<PackageReference Include="SharpZipLib" Version="1.2.0" />

Просмотреть файл

@ -49,7 +49,7 @@ namespace Microsoft.ApplicationInspector.Commands
[Option('d', "allow-dup-tags", Required = false, HelpText = "Output contains unique and non-unique tag matches", Default = false)]
public bool AllowDupTags { get; set; }
[Option('b', "suppress-browser-open", Required = false, HelpText = "Suppress automatic open to HTML output using default browser", Default = false)]
[Option('b', "suppress-browser-open", Required = false, HelpText = "Suppress automatically opening HTML output using default browser", Default = false)]
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")]
@ -139,6 +139,7 @@ namespace Microsoft.ApplicationInspector.Commands
{
[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; }

Просмотреть файл

@ -17,14 +17,17 @@ using the decompression utility of choice e.g. WinZip, 7zip, Gzip etc. Or if you
That's it. Start using the application by selecting and downloading the source code you want to scan to a local directory then run Application Inspector against it either from the source code directory or the Application Inspector install directory using the instructions found on this site on the home page or Readme.md file.
Note there are two main components for invoking the application, the ApplicationInspector.Commands.dll containing the core logic and ApplicationInspector.CLI.dll and .exe (Windows) containing the launch entry point for command line use which uses the other.
The ApplicationInspector.Commands.dll is most likely of help in using the functionaly programmatically and can most easily be installed via www.nuget.com. See the project wiki for more on use. To just use the application as-is, follow the help below.
## Getting Help
You can also get help directly from the application by simply typing in the application name without a command
or with a command to get the required and optional arguments for a given command.
Windows: just run the .exe i.e. applicationinspector.exe
Other: run as dotnet applicationinspector.dll
Windows: just run the .exe i.e. applicationinspector.cli.exe
Other: run as dotnet applicationinspector.cli.dll
* applicationinspector <no arguments> - to get a list of available top level commands
* applicationinspector [command] < no arguments> - to get a list of required and optional arguments to supply with the selected command
* applicationinspector [command] [arguments] -to run a given command with the required or optional parameters
* applicationinspector.cli <no arguments> - to get a list of available top level commands
* applicationinspector.cli [command] < no arguments> - to get a list of required and optional arguments to supply with the selected command
* applicationinspector.cli [command] [arguments] -to run a given command with the required or optional parameters

Просмотреть файл

@ -100,7 +100,7 @@ ERROR(S):
-d, --allow-dup-tags Output contains unique and non-unique tag matches
-b, --suppress-browser-open Suppress automatic open to HTML output using default browser
-b, --suppress-browser-open Suppress automatically opening HTML output using default browser
-c, --confidence-filters Output only matches with specified confidence <value>,<value> [high|medium|low]
@ -150,6 +150,8 @@ Use to analyze and report on differences in tags (features) between two project
-o, --output-file-path Output file path
-k, --file-path-exclusions Exclude source files (none|default: sample,example,test,docs,.vs,.git)
-x, --console-verbosity Console verbosity [high|medium|low|none]
-l, --log-file-path Log file path
@ -192,6 +194,8 @@ will likely yield a false or fail result in most cases.
-o, --output-file-path Output file path
-k, --file-path-exclusions Exclude source files (none|default: sample,example,test,docs,.vs,.git)
-x, --console-verbosity Console verbosity [high|medium|low|none]
-l, --log-file-path Log file path
@ -251,6 +255,9 @@ verified as part of the Build process and does not normally require a separate v
Usage: dotnet ApplicationInspector.CLI.dll verifyrules [arguments]
Arguments:
-d, --verify-default-rules Verify default rules
-r, --custom-rules-path Custom rules file or directory path
-o, --output-file-path Output file path