Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UseSecurityBestPractices.psm1: Fix Custom DSC Resource Kit PSSA rule violations #483

Closed
mhendric opened this issue Jan 27, 2019 · 1 comment · Fixed by #526
Closed

UseSecurityBestPractices.psm1: Fix Custom DSC Resource Kit PSSA rule violations #483

mhendric opened this issue Jan 27, 2019 · 1 comment · Fixed by #526
Labels
enhancement The issue is an enhancement request. in progress The issue is being actively worked on by someone.

Comments

@mhendric
Copy link
Contributor

Details of the scenario you tried and the problem that is occurring

There's a number of script analyzer issues getting reported in UseSecurityBestPractices.psm1. These should be fixed.

Verbose logs showing the problem

[00:03:49]     Context UseSecurityBestPractices.psm1
[00:03:50]       [+] Should pass all error-level PS Script Analyzer rules 71ms
[00:03:50]       [+] Should pass all required PS Script Analyzer rules 336ms
[00:03:50]       [+] Should pass all flagged PS Script Analyzer rules 52ms
[00:03:50]       [+] Should pass any recently-added, error-level PS Script Analyzer rules 49ms
[00:03:50]       [+] Should not suppress any required PS Script Analyzer rules 86ms
[00:03:51] Custom DSC Resource Kit PSSA rule(s) did not pass.
[00:03:51] The following PSScriptAnalyzer rule 'DscResource.AnalyzerRules\Measure-ParameterBlockParameterAttribute' errors need to be fixed:
[00:03:51] UseSecurityBestPractices.psm1 (Line 17): A [Parameter()] attribute must be the first attribute of each parameter and be on its own line. See https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md#correct-format-for-parameter-block
[00:03:51] UseSecurityBestPractices.psm1 (Line 30): A [Parameter()] attribute must be the first attribute of each parameter and be on its own line. See https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md#correct-format-for-parameter-block
[00:03:51] For instructions on how to run PSScriptAnalyzer on your own machine, please go to https://github.com/powershell/PSScriptAnalyzer
[00:03:51] Common Tests - Custom Script Analyzer Rules will not fail unless you opt-in.
[00:03:51] To opt-in, create a '.MetaTestOptIn.json' at the root
[00:03:51] of the repo in the following format:
[00:03:51] [
[00:03:51]      "Common Tests - Custom Script Analyzer Rules"
[00:03:51] ]
[00:03:51]       [+] Should pass all custom DSC Resource Kit PSSA rules 601ms

Version of the DSC module that was used ('dev' if using current dev branch)

dev

@mhendric mhendric added enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community. labels Jan 27, 2019
@mhendric
Copy link
Contributor Author

mhendric commented Feb 4, 2019

I got this one.

@mhendric mhendric added in progress The issue is being actively worked on by someone. and removed help wanted The issue is up for grabs for anyone in the community. labels Feb 4, 2019
@mhendric mhendric changed the title UseSecurityBestPractices.psm1: Fix Script Analyzer Issues UseSecurityBestPractices.psm1: Fix Custom DSC Resource Kit PSSA rule violations Feb 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement The issue is an enhancement request. in progress The issue is being actively worked on by someone.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant