Skip to content

Commit 686c84c

Browse files
IISResetMeIISResetMe
authored
Add new parameter to Start-Sleep: [-Duration] <timespan> (PowerShell#16185)
1 parent da7c52a commit 686c84c

File tree

4 files changed

+235
-0
lines changed

4 files changed

+235
-0
lines changed

‎src/Microsoft.PowerShell.Commands.Utility/commands/utility/StartSleepCommand.cs

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,15 @@ public void Dispose()
5555
[Alias("ms")]
5656
public int Milliseconds { get; set; }
5757

58+
/// <summary>
59+
/// Allows sleep time to be specified as a TimeSpan.
60+
/// </summary>
61+
[Parameter(Position = 0, Mandatory = true, ParameterSetName = "FromTimeSpan", ValueFromPipeline = true,
62+
ValueFromPipelineByPropertyName = true)]
63+
[ValidateRange(ValidateRangeKind.NonNegative)]
64+
[Alias("ts")]
65+
public TimeSpan Duration { get; set; }
66+
5867
#endregion
5968

6069
#region methods
@@ -104,6 +113,26 @@ protected override void ProcessRecord()
104113
case "Milliseconds":
105114
sleepTime = Milliseconds;
106115
break;
116+
117+
case "FromTimeSpan":
118+
if (Duration.TotalMilliseconds > int.MaxValue)
119+
{
120+
PSArgumentException argumentException = PSTraceSource.NewArgumentException(
121+
nameof(Duration),
122+
StartSleepStrings.MaximumDurationExceeded,
123+
TimeSpan.FromMilliseconds(int.MaxValue),
124+
Duration);
125+
126+
ThrowTerminatingError(
127+
new ErrorRecord(
128+
argumentException,
129+
"MaximumDurationExceeded",
130+
ErrorCategory.InvalidArgument,
131+
targetObject: null));
132+
}
133+
134+
sleepTime = (int)Math.Floor(Duration.TotalMilliseconds);
135+
break;
107136

108137
default:
109138
Dbg.Diagnostics.Assert(false, "Only one of the specified parameter sets should be called.");

‎src/Microsoft.PowerShell.Commands.Utility/resources/StartSleepStrings.resx

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="MaximumDurationExceeded" xml:space="preserve">
121+
<value>The '-Duration' parameter value must not exceed '{0}', provided value was '{1}'.</value>
122+
</data>
123+
</root>

‎src/System.Management.Automation/engine/Attributes.cs

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1088,6 +1088,12 @@ public ValidateRangeAttribute(ValidateRangeKind kind) : base()
10881088

10891089
private static void ValidateRange(object element, ValidateRangeKind rangeKind)
10901090
{
1091+
if (element is TimeSpan ts)
1092+
{
1093+
ValidateTimeSpanRange(ts, rangeKind);
1094+
return;
1095+
}
1096+
10911097
Type commonType = GetCommonType(typeof(int), element.GetType());
10921098
if (commonType == null)
10931099
{
@@ -1212,6 +1218,59 @@ private void ValidateRange(object element)
12121218
}
12131219
}
12141220

1221+
private static void ValidateTimeSpanRange(TimeSpan element, ValidateRangeKind rangeKind)
1222+
{
1223+
TimeSpan zero = TimeSpan.Zero;
1224+
1225+
switch (rangeKind)
1226+
{
1227+
case ValidateRangeKind.Positive:
1228+
if (zero.CompareTo(element) >= 0)
1229+
{
1230+
throw new ValidationMetadataException(
1231+
"ValidateRangePositiveFailure",
1232+
null,
1233+
Metadata.ValidateRangePositiveFailure,
1234+
element.ToString());
1235+
}
1236+
1237+
break;
1238+
case ValidateRangeKind.NonNegative:
1239+
if (zero.CompareTo(element) > 0)
1240+
{
1241+
throw new ValidationMetadataException(
1242+
"ValidateRangeNonNegativeFailure",
1243+
null,
1244+
Metadata.ValidateRangeNonNegativeFailure,
1245+
element.ToString());
1246+
}
1247+
1248+
break;
1249+
case ValidateRangeKind.Negative:
1250+
if (zero.CompareTo(element) <= 0)
1251+
{
1252+
throw new ValidationMetadataException(
1253+
"ValidateRangeNegativeFailure",
1254+
null,
1255+
Metadata.ValidateRangeNegativeFailure,
1256+
element.ToString());
1257+
}
1258+
1259+
break;
1260+
case ValidateRangeKind.NonPositive:
1261+
if (zero.CompareTo(element) < 0)
1262+
{
1263+
throw new ValidationMetadataException(
1264+
"ValidateRangeNonPositiveFailure",
1265+
null,
1266+
Metadata.ValidateRangeNonPositiveFailure,
1267+
element.ToString());
1268+
}
1269+
1270+
break;
1271+
}
1272+
}
1273+
12151274
private static Type GetCommonType(Type minType, Type maxType)
12161275
{
12171276
Type resultType = null;

‎test/powershell/Modules/Microsoft.PowerShell.Utility/Start-Sleep.Tests.ps1

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ Describe "Start-Sleep DRT Unit Tests" -Tags "CI" {
2323
$watch.ElapsedMilliseconds | Should -BeLessThan $maxTime
2424
}
2525

26+
It "Should work properly when sleeping with a [TimeSpan]" {
27+
$duration = [timespan]::FromMilliseconds(1500)
28+
$watch = [System.Diagnostics.Stopwatch]::StartNew()
29+
Start-Sleep -Duration $duration
30+
$watch.Stop()
31+
$watch.ElapsedMilliseconds | Should -BeGreaterThan $minTime
32+
$watch.ElapsedMilliseconds | Should -BeLessThan $maxTime
33+
}
34+
2635
It "Should work properly when sleeping with ms alias" {
2736
$watch = [System.Diagnostics.Stopwatch]::StartNew()
2837
Start-Sleep -ms 1500
@@ -38,6 +47,21 @@ Describe "Start-Sleep DRT Unit Tests" -Tags "CI" {
3847
$watch.ElapsedMilliseconds | Should -BeGreaterThan $minTime
3948
$watch.ElapsedMilliseconds | Should -BeLessThan $maxTime
4049
}
50+
51+
It "Should work properly when sleeping without parameters from [timespan]" {
52+
$duration = [timespan]::FromMilliseconds(1500)
53+
$watch = [System.Diagnostics.Stopwatch]::StartNew()
54+
Start-Sleep $duration
55+
$watch.Stop()
56+
$watch.ElapsedMilliseconds | Should -BeGreaterThan $minTime
57+
$watch.ElapsedMilliseconds | Should -BeLessThan $maxTime
58+
}
59+
60+
It "Should validate [timespan] parameter values" {
61+
{ Start-Sleep -Duration '0:00:01' } | Should -Not -Throw
62+
{ Start-Sleep -Duration '-0:00:01' } | Should -Throw -ErrorId 'ParameterArgumentValidationError,Microsoft.PowerShell.Commands.StartSleepCommand'
63+
{ Start-Sleep -Duration '30.0:00:00' } | Should -Throw -ErrorId 'MaximumDurationExceeded,Microsoft.PowerShell.Commands.StartSleepCommand'
64+
}
4165
}
4266

4367
Describe "Start-Sleep" -Tags "CI" {

0 commit comments

Comments
 (0)