Add cmdlet for Resolving Hyak and AutoRest errors #3984

markcowl · 2017-05-17T02:00:56Z

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.

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.

…rror

cormacpayne

@markcowl a few minor comments

Also, there should be an update to the change log

cormacpayne · 2017-05-17T18:50:59Z

src/ResourceManager/Profile/Commands.Profile/Errors/ResolveError.cs

+
+namespace Microsoft.Azure.Commands.Profile.Errors
+{
+    [Cmdlet(VerbsDiagnostic.Resolve, "AzureRmError", DefaultParameterSetName = ResolveError.AnyErrorParameterSet)]


@markcowl does it make sense to have an alias to Resolve-Error?

cormacpayne · 2017-05-17T18:51:33Z

src/ResourceManager/Profile/Commands.Profile/Errors/ResolveError.cs

+    {
+        public const string AnyErrorParameterSet = "AnyErrorParameterSet";
+        public const string LastErrorParameterSet = "LastErrorParameterSet";
+        [Parameter(Mandatory =false, Position =0, HelpMessage ="The error records to resolve", ValueFromPipeline =true, ParameterSetName = AnyErrorParameterSet)]


@markcowl nit: can we put an empty line between the last parameter set and the start of this parameter?

cormacpayne · 2017-05-17T18:52:10Z

src/ResourceManager/Profile/Commands.Profile/Errors/ResolveError.cs

+
+        [Parameter(Mandatory = true, HelpMessage = "The last error", ParameterSetName = LastErrorParameterSet)]
+        public SwitchParameter Last { get; set; }
+        protected override IAzureContext DefaultContext


@markcowl nit: can we put an empty line between the last parameter and this property?

cormacpayne · 2017-05-17T18:53:31Z

src/ResourceManager/Profile/Commands.Profile/Errors/ResolveError.cs

+            }
+        }
+
+        IEnumerable<ErrorRecord> GetErrorVariable()


@markcowl nit: should the below methods be private if they're only being used for this cmdlet?

methods with no visibility specified are automatically private

cormacpayne · 2017-05-17T18:55:58Z

src/ResourceManager/Profile/Commands.Profile/help/Resolve-AzureRmError.md

+
+## SYNOPSIS
+
+Display detailed information about Azure PowerShell errors.


@markcowl are the errors specific to Azure PowerShell?

No, we do special processing for azure powershell errors, but it is explained in the description that it applies to all errors as well

cormacpayne · 2017-05-17T18:59:23Z

src/ResourceManager/Profile/Commands.Profile/Errors/AzureErrorRecord.cs

+
+        public ErrorDetails ErrorDetails { get; set; }
+
+        public ErrorCategoryInfo ErrorCategory { get; set; }


@markcowl nit: can we put an empty line between ErrorCategory and InvocationInfo?

cormacpayne · 2017-05-17T18:59:48Z

src/ResourceManager/Profile/Commands.Profile/Errors/AzureExceptionRecord.cs

+            Exception = exception;
+        }
+
+        public bool InnerException { get; set; }


@markcowl nit: can we put an empty line between InnerException and Exception?

cormacpayne · 2017-05-17T19:00:42Z

src/ResourceManager/Profile/Commands.Profile/Errors/HttpRequestInfo.cs

+        }
+
+        public Uri Uri { get; set; }
+        public string Verb { get; set; }


@markcowl nit: can we put an empty line between Uri and Verb?

…, and explicit visibility modifiers

cormacpayne · 2017-05-17T20:45:30Z

@azuresdkci test this please

cormacpayne · 2017-05-17T22:51:14Z

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

Want to make sure there are no problems when generating help. LGTM once this succeeds.

markcowl · 2017-05-18T01:35:25Z

@cormacpayne Is this the whitespace issue again?

markcowl · 2017-05-19T01:47:33Z

new on-deemand run: http://azuresdkci.cloudapp.net/view/1-AzurePowerShell/job/powershell-demand/1599/

markcowl added 6 commits May 10, 2017 15:11

Adding in error handling cmdlet

8219c7c

Update formatting for errors

d0d4933

Refining format and adding additonal detail to exceptions

14b36c4

add additional test automation

7547ddf

Adding help and additional tests for resolve-error cmdlet [Azure#3648]

acc9734

Merge branch 'preview' of github.com:azure/azure-powershell into rese…

e80bf22

…rror

msftclas added the cla-not-required label May 17, 2017

azuresdkci added the needs-review label May 17, 2017

azuresdkci assigned shahabhijeet May 17, 2017

cormacpayne suggested changes May 17, 2017

View reviewed changes

cormacpayne unassigned shahabhijeet May 17, 2017

cormacpayne added needs-revision and removed needs-review labels May 17, 2017

cormacpayne assigned markcowl May 17, 2017

Resolving review comments for adding space, descriptive text, aliases…

40ec995

…, and explicit visibility modifiers

markcowl added needs-review and removed needs-revision labels May 17, 2017

markcowl assigned cormacpayne and unassigned markcowl May 17, 2017

Adding verrtical space

f2fdc9c

cormacpayne previously approved these changes May 17, 2017

View reviewed changes

cormacpayne removed their assignment May 17, 2017

cormacpayne added Waiting for On Demand and removed needs-review labels May 17, 2017

Adding additional examples

3e92457

markcowl dismissed cormacpayne’s stale review via 3e92457 May 18, 2017 02:38

Updating cmdlet verbs that require ShouldProcess list

2a3b85f

cormacpayne approved these changes May 19, 2017

View reviewed changes

markcowl merged commit 231a559 into Azure:preview May 19, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add cmdlet for Resolving Hyak and AutoRest errors #3984

Add cmdlet for Resolving Hyak and AutoRest errors #3984

Uh oh!

markcowl commented May 17, 2017 •

edited by azuresdkci

Loading

Uh oh!

cormacpayne left a comment

Uh oh!

cormacpayne May 17, 2017

Uh oh!

cormacpayne May 17, 2017

Uh oh!

cormacpayne May 17, 2017

Uh oh!

cormacpayne May 17, 2017

Uh oh!

markcowl May 17, 2017

Uh oh!

cormacpayne May 17, 2017

Uh oh!

markcowl May 17, 2017

Uh oh!

cormacpayne May 17, 2017

Uh oh!

cormacpayne May 17, 2017

Uh oh!

cormacpayne May 17, 2017

Uh oh!

cormacpayne commented May 17, 2017

Uh oh!

cormacpayne commented May 17, 2017 •

edited by markcowl

Loading

Uh oh!

markcowl commented May 18, 2017

Uh oh!

markcowl commented May 19, 2017

Uh oh!

Uh oh!


		## SYNOPSIS

		Display detailed information about Azure PowerShell errors.


		public ErrorDetails ErrorDetails { get; set; }

		public ErrorCategoryInfo ErrorCategory { get; set; }

Add cmdlet for Resolving Hyak and AutoRest errors #3984

Add cmdlet for Resolving Hyak and AutoRest errors #3984

Uh oh!

Conversation

markcowl commented May 17, 2017 • edited by azuresdkci Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

cormacpayne left a comment

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!

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cormacpayne commented May 17, 2017

Uh oh!

cormacpayne commented May 17, 2017 • edited by markcowl Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

markcowl commented May 18, 2017

Uh oh!

markcowl commented May 19, 2017

Uh oh!

Uh oh!

markcowl commented May 17, 2017 •

edited by azuresdkci

Loading

cormacpayne commented May 17, 2017 •

edited by markcowl

Loading