Run security rules from PSRule by default, and exclude repeated rules #277

VeraBE · 2022-08-18T18:20:39Z

Description

Added a baseline to run the PSRule rules under the Security pillar by default, except the ones already present in TemplateAnalyzer; and another one to exclude those repeated rules when using --run-all-rules

Documentation on PSRule baselines: https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Baseline/

This checklist is used to make sure that common guidelines for a pull request are followed.

I have read the contribution guidelines.
The pull request does not introduce breaking changes.

General Guidelines

Title of the pull request is clear and informative.
Description of the pull request is clear and informative.
I have added myself to the 'assignees'.
I have added 'linked issues' if relevant.

Testing Guidelines

Pull request includes test coverage for the included changes.

… run all of them

Reference baseline

…ecurity baseline

… validate security related rules

… as it is needed to run the security rules in PSRule, and fix related tests

… the config file

…e related errors

…ges when running tests in Linux

README.md

docs/customizing-evaluation-outputs.md

src/Analyzer.Core.UnitTests/TemplateAnalyzerTests.cs

src/Analyzer.PowerShellRuleEngine.UnitTests/Analyzer.PowerShellRuleEngine.UnitTests.csproj

src/Analyzer.PowerShellRuleEngine.UnitTests/PowerShellRuleEngineTests.cs

src/Analyzer.PowerShellRuleEngine/PowerShellRuleEngine.cs

src/Analyzer.Reports.UnitTests/SarifReportWriterE2ETests.cs

Co-authored-by: Johnathon Mohr <[email protected]>

…ure/template-analyzer into verabe/securityRulesByDefault

BernieWhite

@VeraBE Just one additional comments otherwise all good.

docs/built-in-bpa-rules.md

Co-authored-by: Bernie White <[email protected]>

docs/customizing-evaluation-outputs.md

src/Analyzer.Cli.FunctionalTests/CommandLineParserTests.cs

src/Analyzer.Cli/CommandLineParser.cs

README.md

src/Analyzer.Core/TemplateAnalyzer.cs

src/Analyzer.PowerShellRuleEngine.UnitTests/PowerShellRuleEngineTests.cs

…dRules

Co-authored-by: Anais Miller <[email protected]>

…iter e2e tests

… test case for the CLI

src/Analyzer.Core/TemplateAnalyzer.cs

src/Analyzer.PowerShellRuleEngine/PowerShellRuleEngine.cs

src/Analyzer.PowerShellRuleEngine/Analyzer.PowerShellRuleEngine.csproj

VeraBE and others added 10 commits August 16, 2022 14:02

Run security rules from PSRule by default, and use a CLI parameter to…

a9b90ba

… run all of them

Reference baseline

6a69aa0

Merge pull request #276 from BernieWhite/bewhite/ref-baseline

c42349f

Reference baseline

Add a PSRule option to avoid a not processed warning when using the s…

7e91d17

…ecurity baseline

Add test case to validate that the PowerShellRuleEngine can also only…

0cdc93f

… validate security related rules

Make the template file path a required parameter of TemplateAnalyzer,…

ef1408b

… as it is needed to run the security rules in PSRule, and fix related tests

Fix parameters order for TemplateAnalyzer in CommandLineParser

bf7837c

Adapt CLI test considering PSRule rules are not currently filtered by…

0ddfba4

… the config file

Fix Reports unit tests now that the test files used also return PSRul…

89eed8a

…e related errors

Exclude rules from PSRule that are already in TemplateAnalyzer

0d7bad8

VeraBE self-assigned this Aug 18, 2022

VeraBE requested a review from a team as a code owner August 18, 2022 18:20

VeraBE requested a review from BernieWhite August 18, 2022 18:22

Specify a culture format for the PSRule output to avoid warning messa…

3488ac9

…ges when running tests in Linux

VeraBE marked this pull request as draft August 18, 2022 18:38

Consider that PSRule evaluations can change order depending on the OS

efb33b6

VeraBE marked this pull request as ready for review August 18, 2022 19:13