Skip to content

Add StaticAnalysis rule to fail cmdlets not using approved verbs #3089

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

Merged
merged 3 commits into from
Dec 6, 2016

Conversation

cormacpayne
Copy link
Member

@cormacpayne cormacpayne commented Oct 17, 2016

Description

Fix for issue #3004

  • Add list of approved PowerShell verbs
  • Add rule that will fail if a cmdlet is not using an approved verb
  • Add tests for the new rule

This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices here.

General Guidelines

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.
  • The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

  • Pull request includes test coverage for the included changes.
  • PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.

Cmdlet Signature Guidelines

  • New cmdlets that make changes or have side effects should implement ShouldProcess and have SupportShouldProcess=true specified in the cmdlet attribute. You can find more information on ShouldProcess here.
  • Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThrough parameter.

Cmdlet Parameter Guidelines

  • Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
  • Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
  • Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

@cormacpayne
Copy link
Member Author

@shahabhijeet any other comments?


#region ApprovedVerbs
private static readonly List<string> ApprovedVerbs = new List<string>
{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather can we dynamically get this list. Because when the list of approved verbs change, we will have to update this list manually.
How about hydrating the list as below
PowerShell ps = PowerShell.Create();
ps.AddCommand("get-verb");
var cmdletResult = ps.Invoke();

        foreach (PSObject result in cmdletResult)
        {
            Console.WriteLine(result.Members["Verb"].Value.ToString());
        }

@markcowl
Copy link
Member

On demand run here: http://azuresdkci.cloudapp.net/view/1-AzurePowerShell/job/powershell-demand/1254/

LGTM once the on-demand run passes.

@markcowl
Copy link
Member

@cormacpayne Looks like the on-demand run fails due to the new test. See the log for the on-demand run

@cormacpayne
Copy link
Member Author

cormacpayne commented Oct 27, 2016

@cormacpayne cormacpayne changed the title Add StaticAnalysis rule to fail cmdlets not using approved verbs [Do Not Merge] Add StaticAnalysis rule to fail cmdlets not using approved verbs Oct 27, 2016
@cormacpayne
Copy link
Member Author

@markcowl @shahabhijeet adding a "Do Not Merge" tag on this PR.

Previously, the test AddVerbWithoutSupportsShouldProcessParameter was failing on the on-demand job and every other test was passing.

Now, the test ForceParameterWithoutSupportsShouldProcess is failing on the on-demand job, so we need to investigate why this is happening next release.

@cormacpayne cormacpayne changed the title [Do Not Merge] Add StaticAnalysis rule to fail cmdlets not using approved verbs Add StaticAnalysis rule to fail cmdlets not using approved verbs Dec 5, 2016
@cormacpayne
Copy link
Member Author

@markcowl @shahabhijeet would you guys mind taking a look at this PR?

@markcowl
Copy link
Member

markcowl commented Dec 6, 2016

on demand run here: http://azuresdkci.cloudapp.net/view/1-AzurePowerShell/job/powershell-demand/1316/

LGTM once the build succeeds

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants