Skip to content

[AzureRT] Disk RP cmdlets #3471

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 50 commits into from
Feb 8, 2017
Merged

Conversation

hyonholee
Copy link
Contributor

@hyonholee hyonholee commented Feb 7, 2017

Description


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.

hyonholee and others added 30 commits February 2, 2017 22:50
Powershell tests for VMSS with managed disks
Copy link
Member

@cormacpayne cormacpayne left a comment

Choose a reason for hiding this comment

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

@hyonholee a lot of the comments I left have been addressed in the email containing the csv files

I just wanted to go through and finish the review in case there was anything that wasn't caught by those files

@@ -1,68 +0,0 @@
// ----------------------------------------------------------------------------------
Copy link
Member

Choose a reason for hiding this comment

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

@hyonholee why is this cmdlet being removed? This is a breaking change

@@ -0,0 +1,97 @@
// ----------------------------------------------------------------------------------
Copy link
Member

Choose a reason for hiding this comment

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

@hyonholee there is a typo in the name of this file - Updat instead of Update

{
[Cmdlet(VerbsData.Update, ProfileNouns.AvailabilitySet)]
[OutputType(typeof(PSAvailabilitySet))]
public class UpdateAzureAvailabilitySetCommand : AvailabilitySetBaseCmdlet
Copy link
Member

Choose a reason for hiding this comment

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

@hyonholee should this cmdlet implement SupportShouldProcess since it is making changes?

@@ -49,7 +49,7 @@ public class AddAzureRmContainerServiceAgentPoolProfileCommand : Microsoft.Azure
Mandatory = false,
Position = 2,
ValueFromPipelineByPropertyName = true)]
public int? Count { get; set; }
public int Count { get; set; }
Copy link
Member

Choose a reason for hiding this comment

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

@hyonholee why was this change made?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is changed because the base client library is changed. The base Swagger spec is the same, but AutoRest generates a different type after we updated AutoRest version. Now the client library has int type instead of int?

@@ -54,55 +54,79 @@ public class NewAzureRmContainerServiceConfigCommand : Microsoft.Azure.Commands.
Mandatory = false,
Position = 3,
ValueFromPipelineByPropertyName = true)]
public int? MasterCount { get; set; }
public string CustomProfileOrchestrator { get; set; }
Copy link
Member

Choose a reason for hiding this comment

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

@hyonholee changing the positions of existing parameters is a breaking change - these changes need to be reverted in this file. The new parameters should be at the end of the position list.

Mandatory = false,
Position = 8,
ValueFromPipelineByPropertyName = true)]
public string Id { get; set; }
Copy link
Member

Choose a reason for hiding this comment

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

@hyonholee removing this parameter is a breaking change

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The reason of removal of this parameter is this parameter (ID) is read-only in VMSS. This was a bug in Swagger spec and this was fixed.

@@ -42,67 +42,100 @@ public class NewAzureRmVmssConfigCommand : Microsoft.Azure.Commands.ResourceMana
Mandatory = false,
Position = 1,
ValueFromPipelineByPropertyName = true)]
public string Location { get; set; }
Copy link
Member

Choose a reason for hiding this comment

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

@hyonholee changing the position of existing parameters is a breaking change

{
[Cmdlet("Remove", "AzureRmVmssDataDisk")]
[OutputType(typeof(VirtualMachineScaleSet))]
public class RemoveAzureRmVmssDataDiskCommand : Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet
Copy link
Member

Choose a reason for hiding this comment

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

@hyonholee same comment about output type and SupportShouldProcess

Position = 1,
ParameterSetName = "IdParameterSet",
ValueFromPipelineByPropertyName = true)]
public string Id { get; set; }
Copy link
Member

Choose a reason for hiding this comment

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

@hyonholee removing a parameter is a breaking change

@@ -67,38 +67,56 @@ public class SetAzureRmVmssStorageProfileCommand : Microsoft.Azure.Commands.Reso
Mandatory = false,
Position = 5,
ValueFromPipelineByPropertyName = true)]
public string Name { get; set; }
public string ImageReferenceId { get; set; }
Copy link
Member

Choose a reason for hiding this comment

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

@hyonholee changing positions of parameters is a breaking change

@cormacpayne
Copy link
Member

@cormacpayne cormacpayne merged commit 838fb6e into Azure:release-3.5.0 Feb 8, 2017
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.

7 participants