[Azure.Storage] Fix a null reference issue in New-AzureRMStorageAccount #5220

blueww · 2018-01-04T09:25:12Z

Description

This PR fix a null reference issue : https://msazure.visualstudio.com/One/XStore-XClient/_workitems?id=1869771

As feature team required, we should remove -EnableEncryptionService and -DisableEncryptionService support in New/set-AzureRMstorageAccount. The detail is in discussion, and I will raise a PR to set the related parameters to obsolete when the discussion with feature team finish.

I have manual test the fix works, and if the parameters are removed, add test case will be no need.

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.

I have read the contribution guidelines.
If changes were made to any cmdlet, the XML help was regenerated using the platyPSHelp module.
If any large changes are made to a service, they are reflected in the respective change log.

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.

markcowl · 2018-01-05T18:02:20Z

...ResourceManager/Storage/Commands.Management.Storage/StorageAccount/NewAzureStorageAccount.cs

@@ -176,7 +176,10 @@ public override void ExecuteCmdlet()
            if (this.EnableEncryptionService != null)
            {
                createParameters.Encryption = ParseEncryption(EnableEncryptionService);
-                createParameters.Encryption.KeySource = "Microsoft.Storage";
+                if (createParameters.Encryption != null)


Covering test? Also, rather than checking this way, you can add a ValidateNotNullOrEmpty attribute to this parameter and here check for MyInvocation.BoundParameters.ContainsKey('Encryption') which is the recommended pattern if you want to see if a parameter was bouynd from either user input or the pipeline

Hi Mark,
As you know, generally we will not cover the data plan cmldets in PowerShell unit test framework since XSCL request can't be record in unit test. I have added cases to test Encryption as none in our team regression test. (let me know if you would like to see the CR for the test).

ValidateNotNullOrEmpty or MyInvocation.BoundParameters.ContainsKey() not work for this issue, since when set "-EnableEncryptionService None" it can pass both check, so will still get the issue.

We will make the "-EnableEncryptionService" as obsolete very soon as feature team requested. I will send a PR for this soon after get the detail requirement from feature team. But before that, would like to fix this issue first.

@blueww The problem there is that people wanting to contribute to these cmdlets sdo not have access to these tests, and so cann't tell if there is a regression. Please add a covering test here for this issue

@markcowl
Unit test is added. please check.
I have verified, without the fix, the unit test can repro the issue. With the fix, the Unit test can pass.

blueww · 2018-01-09T09:13:39Z

on demand: https://azuresdkci.westus2.cloudapp.azure.com/job/powershell-demand/329/

blueww · 2018-01-15T10:40:08Z

@markcowl
Since the Code complete is near, would you please help to take a look at the PR to reduce the risk?
Let me know if anything still need change.
Hope we can make it in ASAP.

markcowl · 2018-01-17T00:47:19Z

...ResourceManager/Storage/Commands.Management.Storage/StorageAccount/NewAzureStorageAccount.cs

+                if (createParameters.Encryption != null)
+                {
+                    createParameters.Encryption.KeySource = "Microsoft.Storage";
+                }


Can you please update the changelog for the AzureRM.Storage module here: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/Storage/ChangeLog.md

@markcowl
Change log is updated in the PR.

markcowl · 2018-01-17T00:49:34Z

@blueww - since there is only a changelog change needed, kicked off an on-demand run here: https://azuresdkci.westus2.cloudapp.azure.com/view/PowerShell/job/powershell-demand/355/

Once you have made the changelog change and this passes, we can merge.

…count

blueww · 2018-01-17T07:43:45Z

Change log added.
rerun on-demand in : https://azuresdkci.westus2.cloudapp.azure.com/view/PowerShell/job/powershell-demand/359/

fixed

azuresdkci added the needs-review label Jan 4, 2018

azuresdkci assigned cormacpayne Jan 4, 2018

markcowl requested changes Jan 5, 2018

View reviewed changes

markcowl added needs-revision and removed needs-review labels Jan 5, 2018

markcowl assigned blueww and unassigned cormacpayne Jan 5, 2018

maddieclayton assigned markcowl and unassigned blueww Jan 8, 2018

maddieclayton added needs-review and removed needs-revision labels Jan 8, 2018

markcowl assigned blueww and unassigned markcowl Jan 8, 2018

markcowl added needs-revision and removed needs-review labels Jan 8, 2018

Fix a null reference issue in New-AzureRmStorageAccount

fc344d1

blueww force-pushed the encryption branch from 18f2fdb to fc344d1 Compare January 9, 2018 09:10

maddieclayton assigned markcowl and unassigned blueww Jan 9, 2018

maddieclayton added needs-review and removed needs-revision labels Jan 9, 2018

markcowl previously requested changes Jan 17, 2018

View reviewed changes

markcowl added needs-revision and removed needs-review labels Jan 17, 2018

markcowl assigned blueww and unassigned markcowl Jan 17, 2018

Add change log for fix a null reference issue in New-AzureRMStorageAc…

50be9f4

…count

blueww force-pushed the encryption branch from 4934535 to 50be9f4 Compare January 17, 2018 06:31

Merge branch 'preview' into encryption

b0d0477

maddieclayton unassigned blueww Jan 17, 2018

maddieclayton added Waiting for On Demand and removed needs-revision labels Jan 17, 2018

maddieclayton approved these changes Jan 17, 2018

View reviewed changes

maddieclayton merged commit 4b28374 into Azure:preview Jan 17, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Azure.Storage] Fix a null reference issue in New-AzureRMStorageAccount #5220

[Azure.Storage] Fix a null reference issue in New-AzureRMStorageAccount #5220

Uh oh!

blueww commented Jan 4, 2018 •

edited by azuresdkci

Loading

Uh oh!

markcowl Jan 5, 2018

Uh oh!

blueww Jan 8, 2018

Uh oh!

markcowl Jan 8, 2018

Uh oh!

blueww Jan 9, 2018 •

edited

Loading

Uh oh!

blueww commented Jan 9, 2018

Uh oh!

blueww commented Jan 15, 2018

Uh oh!

markcowl Jan 17, 2018

Uh oh!

blueww Jan 17, 2018

Uh oh!

markcowl commented Jan 17, 2018

Uh oh!

blueww commented Jan 17, 2018

Uh oh!

Uh oh!

[Azure.Storage] Fix a null reference issue in New-AzureRMStorageAccount #5220

[Azure.Storage] Fix a null reference issue in New-AzureRMStorageAccount #5220

Uh oh!

Conversation

blueww commented Jan 4, 2018 • edited by azuresdkci Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blueww Jan 9, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blueww commented Jan 9, 2018

Uh oh!

blueww commented Jan 15, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

markcowl commented Jan 17, 2018

Uh oh!

blueww commented Jan 17, 2018

Uh oh!

Uh oh!

blueww commented Jan 4, 2018 •

edited by azuresdkci

Loading

blueww Jan 9, 2018 •

edited

Loading