Add Assert assertions to Pester

.gitignore

@@ -5,6 +5,7 @@ vendor/packages/
 .vscode/
 # But don't exclude settings.json
 !.vscode/settings.json
+!.vscode/launch.json
 
 coverage.xml
 testResults.xml

.vscode/launch.json

@@ -0,0 +1,32 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "PowerShell: Launch Current File",
+            "type": "PowerShell",
+            "request": "launch",
+            "script": "${file}",
+            "args": []
+        },
+        {
+            "name": "Pester: Tests from current file",
+            "type": "PowerShell",
+            "request": "launch",
+            "script": "${workspaceFolder}/test.ps1",
+            "args": [
+                "-File",
+                "${file}"
+            ]
+        },
+        {
+            "name": "Pester: All tests",
+            "type": "PowerShell",
+            "request": "launch",
+            "script": "${workspaceFolder}/test.ps1",
+            "args": []
+        }
+    ]
+}

src/Module.ps1

@@ -41,6 +41,7 @@ $script:SafeCommands['Set-DynamicParameterVariable'] = $ExecutionContext.Session
 & $SafeCommands['Set-Alias'] 'Should-BeFasterThan'         'Assert-Faster'
 & $SafeCommands['Set-Alias'] 'Should-BeSlowerThan'         'Assert-Slower'
 & $SafeCommands['Set-Alias'] 'Should-BeBefore'         'Assert-Before'
+& $SafeCommands['Set-Alias'] 'Should-BeAfter'         'Assert-After'
 
 
 
@@ -109,6 +110,7 @@ $script:SafeCommands['Set-DynamicParameterVariable'] = $ExecutionContext.Session
     'Assert-Faster'
     'Assert-Slower'
     'Assert-Before'
+    'Assert-After'
 
     # export
     'Export-NUnitReport'
@@ -168,4 +170,5 @@ $script:SafeCommands['Set-DynamicParameterVariable'] = $ExecutionContext.Session
     'Should-BeFasterThan'
     'Should-BeSlowerThan'
     'Should-BeBefore'
+    'Should-BeAfter'
 )

src/Pester.psd1

@@ -97,6 +97,7 @@
         'Assert-Faster'
         'Assert-Slower'
         'Assert-Before'
+        'Assert-After'
 
         # legacy
         'Assert-VerifiableMock'
@@ -158,6 +159,7 @@
         'Should-BeFasterThan'
         'Should-BeSlowerThan'
         'Should-BeBefore'
+        'Should-BeAfter'
     )
 
 

src/functions/assert/Time/Assert-After.ps1

@@ -0,0 +1,51 @@
+function Assert-After {
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseProcessBlockForPipelineCommand', '')]
+    [CmdletBinding(DefaultParameterSetName = "Now")]
+    param (
+        [Parameter(Position = 2, ValueFromPipeline = $true)]
+        $Actual,
+
+        [Parameter(Position = 0, ParameterSetName = "Now")]
+        [switch] $Now,
+
+        [Parameter(Position = 0, ParameterSetName = "Fluent")]
+        $Time,
+
+        [Parameter(Position = 1, ParameterSetName = "Fluent")]
+        [switch] $Ago,
+
+        [Parameter(Position = 1, ParameterSetName = "Fluent")]
+        [switch] $FromNow,
+
+        [Parameter(Position = 0, ParameterSetName = "Expected")]
+        [DateTime] $Expected
+    )
+
+    # Now is just a syntax marker, we don't need to do anything with it.
+    $Now = $Now
+
+    $currentTime = [datetime]::UtcNow.ToLocalTime()
+    if ($PSCmdlet.ParameterSetName -eq "Expected") {
+        # do nothing we already have expected value
+    }
+    elseif ($PSCmdlet.ParameterSetName -eq "Now") {
+        $Expected = $currentTime
+    }
+    else {
+        if ($Ago -and $FromNow -or (-not $Ago -and -not $FromNow)) {
+            throw "You must provide either -Ago or -FromNow switch, but not both or none."
+        }
+
+        if ($Ago) {
+            $Expected = $currentTime - (Get-TimeSpanFromStringWithUnits -Value $Time)
+        }
+        else {
+            $Expected = $currentTime + (Get-TimeSpanFromStringWithUnits -Value $Time)
+        }
+    }
+
+    if ($Actual -le $Expected) {
+        $Message = Get-AssertionMessage -Expected $Expected -Actual $Actual -CustomMessage $CustomMessage -Data @{ ago = $Ago } -DefaultMessage "Expected the provided [datetime] to be after <expectedType> <expected> (<ago> ago),<because> but it was before: <actual>"
+        throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
+    }
+}

src/functions/assert/Time/Assert-Before.ps1

@@ -1,41 +1,51 @@
 function Assert-Before {
     [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseProcessBlockForPipelineCommand', '')]
+    [CmdletBinding(DefaultParameterSetName = "Now")]
     param (
-        [Parameter(Position = 1, ValueFromPipeline = $true)]
+        [Parameter(Position = 2, ValueFromPipeline = $true)]
         $Actual,
-        [Parameter(Position = 0, ParameterSetName = "Expected")]
-        [DateTime] $Expected,
 
-        [Parameter(Position = 0, ParameterSetName = "Ago")]
-        $TimeAgo,
+        [Parameter(Position = 0, ParameterSetName = "Now")]
+        [switch] $Now,
+
+        [Parameter(Position = 0, ParameterSetName = "Fluent")]
+        $Time,
+
+        [Parameter(Position = 1, ParameterSetName = "Fluent")]
+        [switch] $Ago,
+
+        [Parameter(Position = 1, ParameterSetName = "Fluent")]
+        [switch] $FromNow,
 
-        [Parameter(Position = 0, ParameterSetName = "FromNow")]
-        $TimeFromNow
+        [Parameter(Position = 0, ParameterSetName = "Expected")]
+        [DateTime] $Expected
     )
 
-    $now = [datetime]::UtcNow.ToLocalTime()
+    # Now is just a syntax marker, we don't need to do anything with it.
+    $Now = $Now
+
+    $currentTime = [datetime]::UtcNow.ToLocalTime()
     if ($PSCmdlet.ParameterSetName -eq "Expected") {
-        if ($Actual -ge $Expected) {
-            $Message = Get-AssertionMessage -Expected $Expected -Actual $Actual -CustomMessage $CustomMessage -DefaultMessage "The provided [datetime] should be before <expectedType> <expected>,<because> but it was after: <actual>"
-            throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
-        }
-        return
+        # do nothing we already have expected value
     }
-
-    if ($PSCmdlet.ParameterSetName -eq "Ago") {
-        $Expected = $now - (Get-TimeSpanFromStringWithUnits -Value $TimeAgo)
-        if ($Actual -ge $Expected) {
-            $Message = Get-AssertionMessage -Expected $Expected -Actual $Actual -CustomMessage $CustomMessage -Data @{ ago = $TimeAgo } -DefaultMessage "The provided [datetime] should be before <expectedType> <expected> (<ago> ago),<because> but it was after: <actual>"
-            throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
-        }
-        return
+    elseif ($PSCmdlet.ParameterSetName -eq "Now") {
+        $Expected = $currentTime
     }
     else {
-        $Expected = $now - (Get-TimeSpanFromStringWithUnits -Value $TimeFromNow)
-        if ($Actual -ge $Expected) {
-            $Message = Get-AssertionMessage -Expected $Expected -Actual $Actual -CustomMessage $CustomMessage -Data @{ fromNow = $TimeFromNow } -DefaultMessage "The provided [datetime] should be before <expectedType> <expected> (<fromNow> from now),<because> but it was after: <actual>"
-            throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
+        if ($Ago -and $FromNow -or (-not $Ago -and -not $FromNow)) {
+            throw "You must provide either -Ago or -FromNow switch, but not both or none."
+        }
+
+        if ($Ago) {
+            $Expected = $currentTime - (Get-TimeSpanFromStringWithUnits -Value $Time)
         }
-        return
+        else {
+            $Expected = $currentTime + (Get-TimeSpanFromStringWithUnits -Value $Time)
+        }
+    }
+
+    if ($Actual -ge $Expected) {
+        $Message = Get-AssertionMessage -Expected $Expected -Actual $Actual -CustomMessage $CustomMessage -Data @{ ago = $Ago } -DefaultMessage "Expected the provided [datetime] to be before <expectedType> <expected> (<ago> ago),<because> but it was after: <actual>"
+        throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
     }
 }

src/functions/assert/Time/Assert-Faster.ps1

@@ -39,7 +39,7 @@ function Assert-Faster {
         $sw.Stop()
 
         if ($sw.Elapsed -ge $Expected) {
-            $Message = Get-AssertionMessage -Expected $Expected -Actual $sw.Elapsed -CustomMessage $CustomMessage -Data @{ scriptblock = $Actual } -DefaultMessage "The provided [scriptblock] should execute faster than <expectedType> <expected>,<because> but it took <actual> to run.`nActual: <scriptblock>"
+            $Message = Get-AssertionMessage -Expected $Expected -Actual $sw.Elapsed -CustomMessage $CustomMessage -Data @{ scriptblock = $Actual } -DefaultMessage "Expected the provided [scriptblock] to execute faster than <expectedType> <expected>,<because> but it took <actual> to run.`nScriptBlock: <scriptblock>"
             throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
         }
         return

src/functions/assert/Time/Assert-Slower.ps1

@@ -20,7 +20,7 @@
         $sw.Stop()
 
         if ($sw.Elapsed -le $Expected) {
-            $Message = Get-AssertionMessage -Expected $Expected -Actual $sw.Elapsed -CustomMessage $CustomMessage -Data @{ scriptblock = $Actual } -DefaultMessage "The provided [scriptblock] should execute slower than <expectedType> <expected>,<because> but it took <actual> to run.`nActual: <scriptblock>"
+            $Message = Get-AssertionMessage -Expected $Expected -Actual $sw.Elapsed -CustomMessage $CustomMessage -Data @{ scriptblock = $Actual } -DefaultMessage "The provided [scriptblock] should execute slower than <expectedType> <expected>,<because> but it took <actual> to run.`nScriptBlock: <scriptblock>"
             throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
         }
         return

test.ps1

@@ -49,8 +49,18 @@ $ErrorView = "NormalView"
 "Using PS: $($PsVersionTable.PSVersion)"
 "In path: $($pwd.Path)"
 
-if ($CI -and ($SkipPTests -or $SkipPesterTests)) {
-    throw "Cannot skip tests in CI mode!"
+# Detect which tests to skip from the filenames.
+$anyPesterTests = [bool]@($File | Where-Object { $_ -like "*.Tests.ps1" })
+$anyPTests = [bool]@($File | Where-Object { $_ -like "*.ts.ps1" })
+
+if ($anyPTests -and $anyPesterTests) {
+    # Don't skip P or Pester tests, use the parameters user provided.
+}
+elseif (-not $SkipPTests.IsPresent -and (-not $anyPTests)) {
+    $SkipPTests = $true
+}
+elseif (-not $SkipPesterTests.IsPresent -and (-not $anyPesterTests)) {
+    $SkipPesterTests = $true
 }
 
 if (-not $NoBuild) {
@@ -62,6 +72,10 @@ if (-not $NoBuild) {
     }
 }
 
+if ($CI -and ($SkipPTests -or $SkipPesterTests)) {
+    throw "Cannot skip tests in CI mode!"
+}
+
 # remove pester because we will be reimporting it in multiple other places
 Get-Module Pester | Remove-Module
 

tst/functions/assert/Time/Should-BeAfter.Tests.ps1

@@ -1,15 +1,59 @@
 Set-StrictMode -Version Latest
 
-Describe "Should-BeSlowerThan" {
-    It "Does not throw when actual is slower than expected" -ForEach @(
-        @{ Actual = { Start-Sleep -Milliseconds 10 }; Expected = "1ms" }
+Describe "Should-BeAfter" {
+    It "Does not throw when actual date is before expected date" -ForEach @(
+        @{ Actual = [DateTime]::Now.AddDays(1); Expected = [DateTime]::Now }
     ) {
-        $Actual | Should-BeSlowerThan -Expected $Expected
+        $Actual | Should-BeAfter -Expected $Expected
     }
 
-    It "Does not throw when actual is slower than expected taking TimeSpan" -ForEach @(
-        @{ Actual = [timespan]::FromMilliseconds(999); Expected = "1ms" }
+    It "Does not throw when actual date is before expected date using ago" {
+        [DateTime]::Now.AddMinutes(11) | Should-BeAfter 10minutes -Ago
+    }
+
+    It "Does not throw when actual date is before expected date using fromNow" {
+        [DateTime]::Now.Add([timespan]::FromMinutes(20)) | Should-BeAfter 10minutes -FromNow
+    }
+
+    It "Does not throw when actual date is before expected date using Now" {
+        [DateTime]::Now.Add([timespan]::FromMinutes(20)) | Should-BeAfter -Now
+    }
+
+    It "Does not throw when actual date is before expected date using Now parameter set but not providing any switch" {
+        [DateTime]::Now.Add([timespan]::FromMinutes(20)) | Should-BeAfter
+    }
+
+    It "Throws when actual date is before expected date" -ForEach @(
+        @{ Actual = [DateTime]::Now.AddDays(-1); Expected = [DateTime]::Now }
     ) {
-        $Actual | Should-BeSlowerThan -Expected $Expected
+        { $Actual | Should-BeAfter -Expected $Expected } | Verify-AssertionFailed
+    }
+
+    It "Throws when actual date is before expected date using ago" {
+        { [DateTime]::Now.AddMinutes(-11) | Should-BeAfter 10minutes -Ago } | Verify-AssertionFailed
+    }
+
+    It "Throws when actual date is before expected date using fromNow" {
+        { [DateTime]::Now.Add([timespan]::FromMinutes(9)) | Should-BeAfter 10minutes -FromNow } | Verify-AssertionFailed
+    }
+
+    It "Throws when actual date is before expected date using Now" {
+        { [DateTime]::Now.Add([timespan]::FromMinutes(-1)) | Should-BeAfter -Now } | Verify-AssertionFailed
+    }
+
+    It "Throws when actual date is before expected date using Now parameter set but not providing any switch" {
+        { [DateTime]::Now.Add([timespan]::FromMinutes(-1)) | Should-BeAfter } | Verify-AssertionFailed
+    }
+
+    It "Throws when both -Ago and -FromNow are used" -ForEach @(
+    ) {
+        { $Actual | Should-BeAfter 10minutes -Ago -FromNow } | Verify-Throw
+    }
+
+    It "Can check file creation date" {
+        New-Item -ItemType Directory -Path "TestDrive:\MyFolder" -Force | Out-Null
+        $path = "TestDrive:\MyFolder\test.txt"
+        "hello" | Set-Content $path
+        (Get-Item $path).CreationTime | Should-BeAfter 1s -Ago
     }
 }

tst/functions/assert/Time/Should-BeBefore.Tests.ps1

@@ -8,11 +8,19 @@ Describe "Should-BeBefore" {
     }
 
     It "Does not throw when actual date is before expected date using ago" {
-        [DateTime]::Now.AddMinutes(-11) | Should-BeBefore -TimeAgo 10minutes
+        [DateTime]::Now.AddMinutes(-11) | Should-BeBefore 10minutes -Ago
     }
 
     It "Does not throw when actual date is before expected date using fromNow" {
-        [datetime]::now.Add([timespan]::FromMinutes(-20)) | Should-BeBefore -TimeFromNow 10minutes
+        [DateTime]::Now.Add([timespan]::FromMinutes(-20)) | Should-BeBefore 10minutes -FromNow
+    }
+
+    It "Does not throw when actual date is before expected date using Now" {
+        [DateTime]::Now.Add([timespan]::FromMinutes(-20)) | Should-BeBefore -Now
+    }
+
+    It "Does not throw when actual date is before expected date using Now parameter set but not providing any switch" {
+        [DateTime]::Now.Add([timespan]::FromMinutes(-20)) | Should-BeBefore
     }
 
     It "Throws when actual date is after expected date" -ForEach @(
@@ -21,11 +29,31 @@ Describe "Should-BeBefore" {
         { $Actual | Should-BeBefore -Expected $Expected } | Verify-AssertionFailed
     }
 
-    It "Throw when actual date is after expected date using ago" {
-        { [DateTime]::Now.AddMinutes(-9) | Should-BeBefore -TimeAgo 10minutes } | Verify-AssertionFailed
+    It "Throws when actual date is after expected date using ago" {
+        { [DateTime]::Now.AddMinutes(-9) | Should-BeBefore 10minutes -Ago } | Verify-AssertionFailed
     }
 
     It "Throws when actual date is after expected date using fromNow" {
-        { [datetime]::now.Add([timespan]::FromMinutes(11)) | Should-BeBefore -TimeFromNow 10minutes } | Verify-AssertionFailed
+        { [DateTime]::Now.Add([timespan]::FromMinutes(11)) | Should-BeBefore 10minutes -FromNow } | Verify-AssertionFailed
+    }
+
+    It "Throws when actual date is after expected date using Now" {
+        { [DateTime]::Now.Add([timespan]::FromMinutes(20)) | Should-BeBefore -Now } | Verify-AssertionFailed
+    }
+
+    It "Throws when actual date is after expected date using Now parameter set but not providing any switch" {
+        { [DateTime]::Now.Add([timespan]::FromMinutes(20)) | Should-BeBefore } | Verify-AssertionFailed
+    }
+
+    It "Throws when both -Ago and -FromNow are used" -ForEach @(
+    ) {
+        { $Actual | Should-BeBefore 10minutes -Ago -FromNow } | Verify-Throw
+    }
+
+    It "Can check file creation date" {
+        New-Item -ItemType Directory -Path "TestDrive:\MyFolder" -Force | Out-Null
+        $path = "TestDrive:\MyFolder\test.txt"
+        "hello" | Set-Content $path
+        (Get-Item $path).CreationTime | Should-BeBefore -Now
     }
 }