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

#ApplicationGateway Introduce SecureString to cmdlets. #4898

Merged
merged 7 commits into from
Nov 2, 2017

Conversation

jobatzil
Copy link
Contributor

@jobatzil jobatzil commented Oct 31, 2017

Description

Change type of -Password parameter of ApplciationGatewaySslCertitificate cmdlets to SecureString.


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 PassThru 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.

@jobatzil jobatzil changed the title Hotfix/secure string #ApplicationGateway Introduce SecureString to cmdlets. Oct 31, 2017
@maddieclayton
Copy link
Contributor

@jobatzil in order to fix the build, you need to add the breaking change errors here to the breaking change file here. Let me know if you have any questions or if this doesn't fix your build.

Copy link
Contributor

@maddieclayton maddieclayton left a comment

Choose a reason for hiding this comment

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

Some initial comments


public PSApplicationGatewaySslCertificate NewObject()
{
var sslCertificate = new PSApplicationGatewaySslCertificate();

sslCertificate.Name = this.Name;
sslCertificate.Data = Convert.ToBase64String(File.ReadAllBytes(CertificateFile));
sslCertificate.Data = Convert.ToBase64String(File.ReadAllBytes(this.CertificateFile));
#pragma warning disable 0618
Copy link
Contributor

Choose a reason for hiding this comment

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

You can get rid of the pragma warnings here because it was suppressing the Obsolete warning. Please also get rid of the pragma warnings in Set-AzureRmApplicationGatewaySslCertificate.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okay

@@ -38,4 +38,19 @@
https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
-->

## Current Breaking Changes
Copy link
Contributor

Choose a reason for hiding this comment

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

Please revert all changes here - we will automatically move upcoming breaking changes to current breaking changes when we release.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay, good to know.

@@ -25,18 +25,4 @@
https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
-->

# Upcoming Breaking Changes
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment

@jobatzil
Copy link
Contributor Author

jobatzil commented Nov 1, 2017

@maddieclayton Wasn't aware that there is a StaticAnalysis exceptions file for Breaking Changes as well. Good to know, thanks for the comment :)

@jobatzil
Copy link
Contributor Author

jobatzil commented Nov 1, 2017

I added the entries to the BreakingChangeIssues.csv with the whole path (d:\workspace\...). I saw a lot of entries with equivalent formats. In case this fails I'll change it.

@maddieclayton
Copy link
Contributor

@jobatzil Please fix the merge conflict and push again.

@maddieclayton
Copy link
Contributor

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

Successfully merging this pull request may close these issues.

5 participants