Skip to content

Added ReachabilityProviderList and ReachabilityReport cmdlets + tests #4880

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 5 commits into from
Oct 31, 2017
Merged

Added ReachabilityProviderList and ReachabilityReport cmdlets + tests #4880

merged 5 commits into from
Oct 31, 2017

Conversation

irrogozh
Copy link
Member

@irrogozh irrogozh commented Oct 28, 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.

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.

@irrogozh a couple of minor comments. In addition:

  1. Please update the Network change log to reflect the changes that are being made in this cmdlet.

  2. Please generate and commit the markdown files associated with the new cmdlets you are adding so there is help content available for users.

Mandatory = false,
HelpMessage = "Optional Azure regions to scope the query to.",
ValueFromPipelineByPropertyName = true)]
public List<string> AzureLocations { 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.

@irrogozh please rename this parameter to AzureLocation to avoid using a plural noun. I would go ahead and just rename this parameter to Location to be consistent with all other cmdlets that have a parameter that accepts Azure locations.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

Mandatory = true,
HelpMessage = "The name of the network watcher resource group.",
ParameterSetName = "SetByName",
ValueFromPipelineByPropertyName = true)]
Copy link
Member

Choose a reason for hiding this comment

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

@irrogozh please remove the ValueFromPipelineByPropertyName attribute from this parameter- ResourceId should be the only parameter that has this attribute

Copy link
Member Author

Choose a reason for hiding this comment

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

done

HelpMessage = "The name of network watcher.",
ParameterSetName = "SetByName",
ValueFromPipeline = true,
ValueFromPipelineByPropertyName = true)]
Copy link
Member

Choose a reason for hiding this comment

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

@irrogozh please remove both the ValueFromPipeline and ValueFromPipelineByPropertyName attributes from this parameter - ResourceId should be the only parameter that has the ValueFromPipelineByPropertyName attribute

Copy link
Member Author

Choose a reason for hiding this comment

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

done


namespace Microsoft.Azure.Commands.Network.Automation
{
[Cmdlet(VerbsCommon.Get, "AzureRmNetworkWatcherReachabilityProvidersList", DefaultParameterSetName = "SetByResource"), OutputType(typeof(PSAvailableProvidersList))]
Copy link
Member

Choose a reason for hiding this comment

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

@irrogozh I think the default parameter set should be SetByName, so we prompt the user to provide a NetworkWatcherName and ResourceGroupName rather than the NetworkWatcher object

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed


namespace Microsoft.Azure.Commands.Network.Automation
{
[Cmdlet(VerbsCommon.Get, "AzureRMNetworkWatcherReachabilityReport", DefaultParameterSetName = "SetByResource"), OutputType(typeof(PSAzureReachabilityReport))]
Copy link
Member

Choose a reason for hiding this comment

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

@irrogozh same comment about using the SetByName parameter set as the default parameter set for this cmdlet

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed

HelpMessage = "The name of network watcher.",
ParameterSetName = "SetByName",
ValueFromPipeline = true,
ValueFromPipelineByPropertyName = true)]
Copy link
Member

Choose a reason for hiding this comment

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

@irrogozh same comment about removing ValueFromPipeline and ValueFromPipelineByPropertyName attributes from this parameter

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

Mandatory = true,
HelpMessage = "The name of the network watcher resource group.",
ParameterSetName = "SetByName",
ValueFromPipelineByPropertyName = true)]
Copy link
Member

Choose a reason for hiding this comment

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

@irrogozh same comment about removing the ValueFromPipelineByPropertyName attribute from this parameter

Copy link
Member Author

Choose a reason for hiding this comment

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

done

Mandatory = false,
HelpMessage = "List of Internet service providers.",
ValueFromPipelineByPropertyName = true)]
public List<string> Providers { 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.

@irrogozh please rename this parameter to Provider to avoid using a plural noun

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

Mandatory = false,
HelpMessage = "Optional Azure regions to scope the query to.",
ValueFromPipelineByPropertyName = true)]
public List<string> AzureLocations { 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.

@irrogozh same comment about renaming this parameter to Location

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

@cormacpayne
Copy link
Member

@irrogozh please make sure to pull in the latest changes from the preview branch before pushing your commits. We just merged a fix for CI failures.

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.

@irrogozh a few minor comments, otherwise LGTM

@@ -20,6 +20,10 @@
## Current Release

## Version 4.4.1
* Added cmdlet to list available internet service providers for a specified Azure region
Copy link
Member

Choose a reason for hiding this comment

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

@irrogozh please move this snippet you added to be under the ## Current Release header ☺️

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

[Parameter(
Mandatory = false,
HelpMessage = "The name of the state.",
ValueFromPipelineByPropertyName = true)]
Copy link
Member

Choose a reason for hiding this comment

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

@irrogozh please remove ValueFromPipelineByPropertyName from this parameter for consistency with other parameters.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

# Get-AzureRMNetworkWatcherReachabilityReport

## SYNOPSIS
{{Fill in the Synopsis}}
Copy link
Member

Choose a reason for hiding this comment

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

@irrogozh please fill in any templates in the markdown files you've added

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

]
}
]

Copy link
Member

Choose a reason for hiding this comment

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

@irrogozh it looks like you're missing ending ``` in this example

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed

@cormacpayne
Copy link
Member

@cormacpayne
Copy link
Member

@cormacpayne cormacpayne merged commit 832c591 into Azure:preview Oct 31, 2017
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.

4 participants