Skip to content
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

New Parameter: Start-Sleep [-Duration] <timespan> #16185

Merged
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -55,6 +55,15 @@ public void Dispose()
[Alias("ms")]
public int Milliseconds { get; set; }

/// <summary>
/// Allows sleep time to be specified as a TimeSpan
/// </summary>
[Parameter(Position = 0, Mandatory = true, ParameterSetName = "FromTimeSpan", ValueFromPipeline = true,
ValueFromPipelineByPropertyName = true)]
[ValidateRange(ValidateRangeKind.NonNegative)]
[Alias("ts")]
public TimeSpan Duration { get; set; }

#endregion

#region methods
Expand Down Expand Up @@ -104,6 +113,24 @@ protected override void ProcessRecord()
case "Milliseconds":
sleepTime = Milliseconds;
break;

case "FromTimeSpan":
if (Duration.TotalMilliseconds > int.MaxValue)
{
PSArgumentException argumentException = PSTraceSource.NewArgumentException(
nameof(Duration),
StartSleepStrings.MaximumDurationExceeded,
TimeSpan.FromMilliseconds(int.MaxValue),
Duration);

ThrowTerminatingError(
new ErrorRecord(
argumentException,
"MaximumDurationExceeded",
ErrorCategory.InvalidArgument, null));
IISResetMe marked this conversation as resolved.
Show resolved Hide resolved
}
sleepTime = (int)Math.Floor(Duration.TotalMilliseconds);
daxian-dbw marked this conversation as resolved.
Show resolved Hide resolved
break;

default:
Dbg.Diagnostics.Assert(false, "Only one of the specified parameter sets should be called.");
Expand Down
@@ -0,0 +1,123 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema

Version 2.0

The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.

Example:

... ado.net/XML headers & schema ...
<resheader name="resmimetype">text/microsoft-resx</resheader>
<resheader name="version">2.0</resheader>
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>

There are any number of "resheader" rows that contain simple
name/value pairs.

Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.

The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:

Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.

mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.

mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.

mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true">
<xsd:complexType>
<xsd:choice maxOccurs="unbounded">
<xsd:element name="metadata">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="name" use="required" type="xsd:string" />
<xsd:attribute name="type" type="xsd:string" />
<xsd:attribute name="mimetype" type="xsd:string" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="assembly">
<xsd:complexType>
<xsd:attribute name="alias" type="xsd:string" />
<xsd:attribute name="name" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="data">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="resheader">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:complexType>
</xsd:element>
</xsd:schema>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="MaximumDurationExceeded" xml:space="preserve">
<value>The '-Duration' parameter value must not exceed '{0}', provided value was '{1}'.</value>
</data>
</root>
59 changes: 59 additions & 0 deletions src/System.Management.Automation/engine/Attributes.cs
Expand Up @@ -1088,6 +1088,12 @@ public ValidateRangeAttribute(ValidateRangeKind kind) : base()

private static void ValidateRange(object element, ValidateRangeKind rangeKind)
{
if (element is TimeSpan ts)
{
ValidateTimeSpanRange(ts, rangeKind);
return;
}

Type commonType = GetCommonType(typeof(int), element.GetType());
if (commonType == null)
{
Expand Down Expand Up @@ -1212,6 +1218,59 @@ private void ValidateRange(object element)
}
}

private static void ValidateTimeSpanRange(TimeSpan element, ValidateRangeKind rangeKind)
{
TimeSpan zero = TimeSpan.Zero;

switch (rangeKind)
{
case ValidateRangeKind.Positive:
if (zero.CompareTo(element) >= 0)
{
throw new ValidationMetadataException(
"ValidateRangePositiveFailure",
null,
Metadata.ValidateRangePositiveFailure,
element.ToString());
}

break;
case ValidateRangeKind.NonNegative:
if (zero.CompareTo(element) > 0)
{
throw new ValidationMetadataException(
"ValidateRangeNonNegativeFailure",
null,
Metadata.ValidateRangeNonNegativeFailure,
element.ToString());
}

break;
case ValidateRangeKind.Negative:
if (zero.CompareTo(element) <= 0)
{
throw new ValidationMetadataException(
"ValidateRangeNegativeFailure",
null,
Metadata.ValidateRangeNegativeFailure,
element.ToString());
}

break;
case ValidateRangeKind.NonPositive:
if (zero.CompareTo(element) < 0)
{
throw new ValidationMetadataException(
"ValidateRangeNonPositiveFailure",
null,
Metadata.ValidateRangeNonPositiveFailure,
element.ToString());
}

break;
}
}

private static Type GetCommonType(Type minType, Type maxType)
{
Type resultType = null;
Expand Down
Expand Up @@ -23,6 +23,15 @@ Describe "Start-Sleep DRT Unit Tests" -Tags "CI" {
$watch.ElapsedMilliseconds | Should -BeLessThan $maxTime
}

It "Should work properly when sleeping with a [TimeSpan]" {
IISResetMe marked this conversation as resolved.
Show resolved Hide resolved
$duration = [timespan]::FromMilliseconds(1500)
$watch = [System.Diagnostics.Stopwatch]::StartNew()
Start-Sleep -Duration $duration
$watch.Stop()
$watch.ElapsedMilliseconds | Should -BeGreaterThan $minTime
$watch.ElapsedMilliseconds | Should -BeLessThan $maxTime
}

It "Should work properly when sleeping with ms alias" {
$watch = [System.Diagnostics.Stopwatch]::StartNew()
Start-Sleep -ms 1500
Expand All @@ -38,6 +47,21 @@ Describe "Start-Sleep DRT Unit Tests" -Tags "CI" {
$watch.ElapsedMilliseconds | Should -BeGreaterThan $minTime
$watch.ElapsedMilliseconds | Should -BeLessThan $maxTime
}

It "Should work properly when sleeping without parameters from [timespan]" {
$duration = [timespan]::FromMilliseconds(1500)
$watch = [System.Diagnostics.Stopwatch]::StartNew()
Start-Sleep $duration
$watch.Stop()
$watch.ElapsedMilliseconds | Should -BeGreaterThan $minTime
$watch.ElapsedMilliseconds | Should -BeLessThan $maxTime
}

It "Should validate [timespan] parameter values" {
{ Start-Sleep -Duration '0:00:01' } | Should -Not -Throw
{ Start-Sleep -Duration '-0:00:01' } | Should -Throw -ErrorId 'ParameterArgumentValidationError,Microsoft.PowerShell.Commands.StartSleepCommand'
{ Start-Sleep -Duration '30.0:00:00' } | Should -Throw -ErrorId 'MaximumDurationExceeded,Microsoft.PowerShell.Commands.StartSleepCommand'
}
}

Describe "Start-Sleep" -Tags "CI" {
Expand Down