Skip to content

Start-Sleep: add 'ms' alias #4039

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.

Sign up for GitHub

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
daxian-dbw merged 2 commits into from
Jun 19, 2017
Merged

Start-Sleep: add 'ms' alias #4039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e75fee1
Start-Sleep: add 'ms' alias
Tadas Jun 17, 2017
2a42f0b
Add BeLessThan tests
Tadas Jun 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Microsoft.PowerShell.Commands.Utility/commands/utility/StartSleepCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ public void Dispose()
/// </summary>
[Parameter(Mandatory = true, ParameterSetName = "Milliseconds", ValueFromPipelineByPropertyName = true)]
[ValidateRangeAttribute(0, int.MaxValue)]
[Alias("ms")]
public int Milliseconds { get; set; }

#endregion
Expand Down
10 changes: 10 additions & 0 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/Start-Sleep.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,23 @@ Describe "Start-Sleep DRT Unit Tests" -Tags "CI" {
Start-Sleep -Seconds 1
$watch.Stop()
$watch.ElapsedMilliseconds | Should BeGreaterThan 950
$watch.ElapsedMilliseconds | Should BeLessThan 1050
}

It "Should work properly when sleeping with Milliseconds" {
$watch = [System.Diagnostics.Stopwatch]::StartNew()
Start-Sleep -Milliseconds 1000
$watch.Stop()
$watch.ElapsedMilliseconds | Should BeGreaterThan 950
$watch.ElapsedMilliseconds | Should BeLessThan 1050
}

It "Should work properly when sleeping with ms alias" {
$watch = [System.Diagnostics.Stopwatch]::StartNew()
Start-Sleep -ms 1000
$watch.Stop()
$watch.ElapsedMilliseconds | Should BeGreaterThan 950
Copy link
Member

@SteveL-MSFT SteveL-MSFT Jun 17, 2017

Choose a reason for hiding this comment

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

Seems like you should also make sure it's less than 1050

Copy link
Collaborator

@iSazonov iSazonov Jun 17, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Should we test parameter aliases? It seems it is a general feature and we should test the feature in special tests but not every cmdlet and every alias.

Copy link
Member

@SteveL-MSFT SteveL-MSFT Jun 17, 2017

Choose a reason for hiding this comment

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

In general, we should validate the alias is correct, but shouldn't repeat every test for the parameter and its alias. -ms is a pretty simple case, so it's hard to not repeat the test (using -TestCases is probably better here). For parameters with more complex behavior, I think it would be sufficient if some cases used the parameter while others used the alias.

Copy link
Contributor

@lzybkr lzybkr Jun 18, 2017

Choose a reason for hiding this comment

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

@iSazonov - As a matter of principle - we avoid testing the parameter binder in cmdlet specific tests.

Personally I don't ask for any tests for an alias - the test isn't covering any new code, but I understand the concerns of those asking for the test, so I don't complain about it either.

Copy link
Collaborator

@iSazonov iSazonov Jun 19, 2017

Choose a reason for hiding this comment

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

If we're worried about parameter's aliases, we could make a common test for all of them, just like we did for the cmdlets and their aliases as < cmdlet, parameter, alias, platform(?) >.

Copy link
Contributor

@lzybkr lzybkr Jun 19, 2017

Choose a reason for hiding this comment

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

It's not a big problem, people mostly never remove code anyway and if they did, it should be caught during the PR, but it's a nice idea.

$watch.ElapsedMilliseconds | Should BeLessThan 1050
}
}

Expand Down