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

xFileUpload.schema.psm1: Fix Custom DSC Resource Kit PSSA rule violations #497

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

xFileUpload.schema.psm1: Fix Custom DSC Resource Kit PSSA rule violations #497

mhendric opened this issue Jan 27, 2019 · 1 comment · Fixed by #558
Assignees
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 xFileUpload.schema.psm1. These should be fixed.

Verbose logs showing the problem

[00:05:13]     Context xFileUpload.schema.psm1
[00:05:13]       [+] Should pass all error-level PS Script Analyzer rules 82ms
[00:05:13]       [+] Should pass all required PS Script Analyzer rules 356ms
[00:05:14]       [+] Should pass all flagged PS Script Analyzer rules 63ms
[00:05:14]       [+] Should pass any recently-added, error-level PS Script Analyzer rules 63ms
[00:05:15]       [+] Should not suppress any required PS Script Analyzer rules 948ms
[00:05:15] Custom DSC Resource Kit PSSA rule(s) did not pass.
[00:05:15] The following PSScriptAnalyzer rule 'DscResource.AnalyzerRules\Measure-ParameterBlockParameterAttribute' errors need to be fixed:
[00:05:15] xFileUpload.schema.psm1 (Line 23): The [Parameter()] attribute must start with an upper case 'P'. See https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md#correct-format-for-parameter-block
[00:05:15] xFileUpload.schema.psm1 (Line 27): The [Parameter()] attribute must start with an upper case 'P'. See https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md#correct-format-for-parameter-block
[00:05:15] xFileUpload.schema.psm1 (Line 31): 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:05:15] xFileUpload.schema.psm1 (Line 33): 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:05:15] For instructions on how to run PSScriptAnalyzer on your own machine, please go to https://github.com/powershell/PSScriptAnalyzer
[00:05:15] Common Tests - Custom Script Analyzer Rules will not fail unless you opt-in.
[00:05:15] To opt-in, create a '.MetaTestOptIn.json' at the root
[00:05:15] of the repo in the following format:
[00:05:15] [
[00:05:15]      "Common Tests - Custom Script Analyzer Rules"
[00:05:15] ]
[00:05:15]       [+] Should pass all custom DSC Resource Kit PSSA rules 791ms

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 mhendric changed the title xFileUpload.schema.psm1: Fix Script Analyzer Issues xFileUpload.schema.psm1: Fix Custom DSC Resource Kit PSSA rule violations Feb 12, 2019
@PlagueHO PlagueHO 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 16, 2019
@PlagueHO PlagueHO self-assigned this Feb 16, 2019
@PlagueHO
Copy link
Member

Got this one.

mhendric added a commit that referenced this issue Feb 17, 2019
Fixed PSSA issues in xFileUpload and added Integration tests -Fixes #497
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
2 participants