Implement Add/Remove Cmdlets for VMSS diagnostics extension, add rela… #2899

zhencui · 2016-09-06T18:16:40Z

Comments

This checklist is used to make sure that common issues in a pull request are covered by the creator. You can find a more complete discussion of PowerShell cmdlet best practices here.

Below in Overall Changes, check off the boxes that apply to your PR. For the categories that you did not check off, you can remove them from this body. Within each of the categories that you did select, make sure that you can check off all of the boxes.

For information on cleaning up the commits in your pull request, click here.

General

Title of the PR is clear and informative
There are a small number of commits that each have an informative message
If it applies, references the bug/issue that the PR fixes
All files have the Microsoft copyright header
Cmdlets refer to management libraries through nuget references - no dlls are checked in
The PR does not introduce breaking changes (unless a major version change occurs in the assembly and module)

Tests

PR includes test coverage for the included changes
Tests must use xunit, and should either use Moq to mock management client calls, or use the scenario test framework
PowerShell scripts used in tests must not use hard-coded values for location
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 existing resources
Tests should not use App.config files for settings
Tests should use the built-in PowerShell functions for generating random names when unique names are necessary - this will store names in the test recording
Tests should use Start-Sleep to pause rather than Thread.Sleep

Cmdlet Signature

Cmdlet name uses an approved PowerShell verb - use the enums for VerbsCommon, VerbsCommunication, VerbsLifecycle, VerbsOther whenever possible
Cmdlet noun name uses the AzureRm prefix for management cmdlets, and the Azure prefix for data plane cmdlets
Cmdlet specifies the OutputType attribute if any output is produced; if the cmdlet produces no output, it should implement a PassThrough parameter
If the cmdlet makes changes or has side effects, it should implement ShouldProcess and have SupportShouldProcess = true specified in the cmdlet attribute. See a discussion about correct ShouldProcess implementation here
Cmdlets should derive from AzureRmCmdlet for management cmdlets, and AzureDataCmdlet for data cmdlets
If multiple parameter sets are implemented, the cmdlet should specify a DefaultParameterSetName in its cmdlet attribute

Parameters

Cmdlets should have no more than four positional parameters
Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets
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
Parameters should be explicitly marked as Mandatory or not, and should contain a HelpMessage
No parameter is of type object.
- Management cmdlets should have the following parameters and aliases:
  - ResourceGroupName with (optional) alias to ResourceGroup type string marked as [ValueFromPipelineByPropertyName]
  - Name with alias to ResourceName type string marked as [ValueFromPipelineByPropertyName]
  - Location (if appropriate) type string
  - Tag, type HashTable

Parameters and the Pipeline

Complex parameters should take values from the pipeline when possible, and certainly when they match the output type of another cmdlet
Only one parameter should use ValueFromPipeline per parameter set; parameters from different parameter sets may have this attribute, but should not be convertible
No parameter is of type object
Each management cmdlet should have a parameter set that takes ResourceGroupName and Name from the pipeline by property value
For a given resource type, it should be possible to pipe the output of Get and New cmdlets to the input of Set, Update, Remove and other action cmdlets for that resource

…ted test case and scenario records

azurecla · 2016-09-06T18:16:47Z

Hi @zhencui, I'm your friendly neighborhood Azure Pull Request Bot (You can call me AZPRBOT). Thanks for your contribution!

It looks like you're working at Microsoft (zhencui). If you're full-time, we DON'T require a contribution license agreement.

If you are a vendor, DO please sign the electronic contribution license agreement. It will take 2 minutes and there's no faxing! https://cla.azure.com.

TTYL, AZPRBOT;

azuresdkci · 2016-09-06T18:20:36Z

Can one of the admins verify this patch?

cormacpayne · 2016-09-09T20:16:15Z

@zhencui Hey Zhenhua, please merge the latest changes from dev to fix the conflicts

markcowl · 2016-09-09T22:37:46Z

@zhencui There are merge conflicts, please update

zhencui · 2016-09-12T17:53:53Z

@cormacpayne @markcowl Conflicts have been resolved.

cormacpayne · 2016-09-13T16:54:20Z

@azuresdkci add to whitelist

shahabhijeet · 2016-09-15T17:58:53Z

@azuresdkci add to whitelist

shahabhijeet · 2016-09-16T20:24:17Z

...ager/Compute/Commands.Compute/Extension/Diagnostics/RemoveAzureRmVmssDiagnosticsExtension.cs

+            Mandatory = false,
+            Position = 1,
+            ValueFromPipelineByPropertyName = true)]
+        public string Name { get; set; }


Should the remove have an alias for Name property in order to be consistent with the Add-AzureRmVmssDiagnosticsExtension cmdlet Name property?

shahabhijeet · 2016-09-16T20:33:12Z

src/ResourceManager/Compute/Commands.Compute.Test/ScenarioTests/DiagnosticsExtensionTests.ps1

+            -ImageReferenceOffer $imgRef.Offer -ImageReferenceSku $imgRef.Skus -ImageReferenceVersion $imgRef.Version `
+            -ImageReferencePublisher $imgRef.PublisherName -VhdContainer $vhdContainer `
+            | Add-AzureRmVmssDiagnosticsExtension -Name $extname -SettingFilePath "$TestOutputRoot\ConfigFiles\DiagnosticsExtensionPublicConfig.json" `


Any reason, no tests have not been added for covering rest of the parameters for AddAzureRmVmssdianosticsExtension (e.g. VirtualMachineScaleSet, PrtectedSettingFilePath, TypeHandlerVersion)
If you are planning to add those test later, can you create an issue and link to this PR or if you think those tests are not needed, please mention in the PR.

cormacpayne · 2016-09-20T19:13:39Z

@azuresdkci retest this please

markcowl · 2016-09-21T00:18:12Z

@zhencui The PR is failing due to cmdlet signature issues for the two new cmdlets caught by the static analysis tools. I have placed comments in the two cmdlets that need to be changed. See http://azuresdkci.cloudapp.net/job/powershell/6512/artifact/src/Package/SignatureIssues.csv for the static analysis report.

cormacpayne · 2016-09-21T16:23:53Z

@zhencui the following test is failing:

Microsoft.Azure.Commands.Compute.Test.ScenarioTests.DiagnosticsExtensionTests.TestVmssDiagnosticsExtension

cormacpayne · 2016-09-21T21:17:05Z

@zhencui Hey Zhenhua, would you mind pulling from dev to get the latest changes that fix the on-demand build?

…ted test case and scenario records

cormacpayne · 2016-09-21T21:49:08Z

On-demand: http://azuresdkci.cloudapp.net/view/1-AzurePowerShell/job/powershell-demand/1203

markcowl · 2016-09-21T23:23:40Z

...ager/Compute/Commands.Compute/Extension/Diagnostics/RemoveAzureRmVmssDiagnosticsExtension.cs

+
+                    if (diagnosticsExtensions.Any())
+                    {
+                        if (Force.IsPresent ||


Is this really necessary? Seems liek the ShouldContinue is going to happen every time anythiung is deleted, so not much of a reason for the prompt or for the Force parameter. I would remove it.

markcowl · 2016-09-21T23:24:27Z

@zhencui One comment on the lack of need for Force parameter. Otherwise LGTM

cormacpayne · 2016-09-22T01:02:53Z

On-demand: http://azuresdkci.cloudapp.net/view/1-AzurePowerShell/job/powershell-demand/1217/

azurecla added the cla-not-required label Sep 6, 2016

zhencui force-pushed the dev branch from b1e475c to 0d371a1 Compare September 10, 2016 01:31

shahabhijeet reviewed Sep 16, 2016

View reviewed changes

zhencui force-pushed the dev branch 2 times, most recently from 39fcc34 to 7e2557e Compare September 19, 2016 22:04

zhencui force-pushed the dev branch from bdb3bb1 to cba4d96 Compare September 21, 2016 20:30

zhencui added 3 commits September 21, 2016 14:18

Implement Add/Remove Cmdlets for VMSS diagnostics extension, add rela…

8508914

…ted test case and scenario records

Add ShouldProcess support to Add/Remove AzureRmVmssDiagnosticsExtension

2d200fa

Update test vmss diag extension records after merge from main branch

52a55e6

zhencui force-pushed the dev branch from cba4d96 to 52a55e6 Compare September 21, 2016 21:24

markcowl reviewed Sep 21, 2016

View reviewed changes

Remove force parameter from Remove-AzureRmVmssDiagnosticsExtension

43cbf18

cormacpayne merged commit 11c5d20 into Azure:dev Sep 22, 2016

Implement Add/Remove Cmdlets for VMSS diagnostics extension, add rela… #2899

Implement Add/Remove Cmdlets for VMSS diagnostics extension, add rela… #2899

Uh oh!

Conversation

zhencui commented Sep 6, 2016

Comments

Overall Changes

General

Tests

Cmdlet Signature

Parameters

Parameters and the Pipeline

Uh oh!

azurecla commented Sep 6, 2016

Uh oh!

azuresdkci commented Sep 6, 2016

Uh oh!

cormacpayne commented Sep 9, 2016

Uh oh!

markcowl commented Sep 9, 2016

Uh oh!

zhencui commented Sep 12, 2016

Uh oh!

cormacpayne commented Sep 13, 2016

Uh oh!

shahabhijeet commented Sep 15, 2016

Uh oh!

shahabhijeet Sep 16, 2016

Choose a reason for hiding this comment

Uh oh!

shahabhijeet Sep 16, 2016

Choose a reason for hiding this comment

Uh oh!

cormacpayne commented Sep 20, 2016

Uh oh!

markcowl commented Sep 21, 2016

Uh oh!

cormacpayne commented Sep 21, 2016

Uh oh!

cormacpayne commented Sep 21, 2016

Uh oh!

cormacpayne commented Sep 21, 2016

Uh oh!

markcowl Sep 21, 2016

Choose a reason for hiding this comment

Uh oh!

markcowl commented Sep 21, 2016

Uh oh!

cormacpayne commented Sep 22, 2016

Uh oh!

Uh oh!