Add Assert assertions to Pester

build.ps1

@@ -279,9 +279,14 @@ $script = @(
     "$PSScriptRoot/src/Pester.Runtime.ps1"
     "$PSScriptRoot/src/TypeClass.ps1"
     "$PSScriptRoot/src/Format.ps1"
+    # TODO: the original version of Format2 from assert, because it does not format strings and other stuff in Pester specific way. I've used this regex (Format-Collection|Format-Object|Format-Null|Format-Boolean|Format-ScriptBlock|Format-Number|Format-Hashtable|Format-Dictionary|Format-Nicely|Get-DisplayProperty|Get-ShortType|Format-Type), '$12' to replace in VS Code.
+    "$PSScriptRoot/src/Format2.ps1"
     "$PSScriptRoot/src/Pester.RSpec.ps1"
     "$PSScriptRoot/src/Main.ps1"
 
+    # TODO:  Imports Compatibility.ps1, remove the code that is there, because it is for PowerShell 2.0 compatibility!
+    "$PSScriptRoot/src/functions/assert/*"
+    "$PSScriptRoot/src/functions/assert/*/*"
     "$PSScriptRoot/src/functions/assertions/*"
     "$PSScriptRoot/src/functions/*"
 

src/Format2.ps1

@@ -0,0 +1,156 @@
+function Format-Collection2 ($Value, [switch]$Pretty) {
+    $separator = ', '
+    if ($Pretty) {
+        $separator = ",`n"
+    }
+    ($Value | ForEach-Object { Format-Nicely2 -Value $_ -Pretty:$Pretty }) -join $separator
+}
+
+function Format-Object2 ($Value, $Property, [switch]$Pretty) {
+    if ($null -eq $Property) {
+        $Property = $Value.PSObject.Properties | Select-Object -ExpandProperty Name
+    }
+    $orderedProperty = $Property |
+        Sort-Object |
+        # force the values to be strings for powershell v2
+        ForEach-Object { "$_" }
+
+    $valueType = Get-ShortType $Value
+    $valueFormatted = [string]([PSObject]$Value | Select-Object -Property $orderedProperty)
+
+    if ($Pretty) {
+        $margin = "    "
+        $valueFormatted = $valueFormatted `
+            -replace '^@{', "@{`n$margin" `
+            -replace '; ', ";`n$margin" `
+            -replace '}$', "`n}" `
+
+    }
+
+    $valueFormatted -replace "^@", $valueType
+}
+
+function Format-Null2 {
+    '$null'
+}
+
+function Format-Boolean2 ($Value) {
+    '$' + $Value.ToString().ToLower()
+}
+
+function Format-ScriptBlock2 ($Value) {
+    '{' + $Value + '}'
+}
+
+function Format-Number2 ($Value) {
+    [string]$Value
+}
+
+function Format-Hashtable2 ($Value) {
+    $head = '@{'
+    $tail = '}'
+
+    $entries = $Value.Keys | Sort-Object | ForEach-Object {
+        $formattedValue = Format-Nicely2 $Value.$_
+        "$_=$formattedValue" }
+
+    $head + ( $entries -join '; ') + $tail
+}
+
+function Format-Dictionary2 ($Value) {
+    $head = 'Dictionary{'
+    $tail = '}'
+
+    $entries = $Value.Keys | Sort-Object | ForEach-Object {
+        $formattedValue = Format-Nicely2 $Value.$_
+        "$_=$formattedValue" }
+
+    $head + ( $entries -join '; ') + $tail
+}
+
+function Format-Nicely2 ($Value, [switch]$Pretty) {
+    if ($null -eq $Value) {
+        return Format-Null2 -Value $Value
+    }
+
+    if ($Value -is [bool]) {
+        return Format-Boolean2 -Value $Value
+    }
+
+    if ($value -is [type]) {
+        return Format-Type2 -Value $Value
+    }
+
+    if (Is-DecimalNumber -Value $Value) {
+        return Format-Number2 -Value $Value
+    }
+
+    if (Is-ScriptBlock -Value $Value) {
+        return Format-ScriptBlock2 -Value $Value
+    }
+
+    if (Is-Value -Value $Value) {
+        return $Value
+    }
+
+    if (Is-Hashtable -Value $Value) {
+        return Format-Hashtable2 -Value $Value
+    }
+
+    if (Is-Dictionary -Value $Value) {
+        return Format-Dictionary2 -Value $Value
+    }
+
+    if (Is-Collection -Value $Value) {
+        return Format-Collection2 -Value $Value -Pretty:$Pretty
+    }
+
+    Format-Object2 -Value $Value -Property (Get-DisplayProperty2 (Get-Type $Value)) -Pretty:$Pretty
+}
+
+function Get-DisplayProperty2 ([Type]$Type) {
+    # rename to Get-DisplayProperty?
+
+    <# some objects are simply too big to show all of their properties,
+    so we can create a list of properties to show from an object
+    maybe the default info from Get-FormatData could be utilized here somehow
+    so we show only stuff that would normally show in format-table view
+    leveraging the work PS team already did #>
+
+    # this will become more advanced, basically something along the lines of:
+    # foreach type, try constructing the type, and if it exists then check if the
+    # incoming type is assignable to the current type, if so then return the properties,
+    # this way I can specify the map from the most concrete type to the least concrete type
+    # and for types that do not exist
+
+    $propertyMap = @{
+        'System.Diagnostics.Process' = 'Id', 'Name'
+    }
+
+    $propertyMap[$Type.FullName]
+}
+
+function Get-ShortType2 ($Value) {
+    if ($null -ne $value) {
+        Format-Type2 (Get-Type $Value)
+    }
+    else {
+        Format-Type2 $null
+    }
+}
+
+function Format-Type2 ([Type]$Value) {
+    if ($null -eq $Value) {
+        return '<null>'
+    }
+
+    $type = [string]$Value
+
+    $type `
+        -replace "^System\." `
+        -replace "^Management\.Automation\.PSCustomObject$", "PSObject" `
+        -replace "^PSCustomObject$", "PSObject" `
+        -replace "^Object\[\]$", "collection" `
+
+}
+

src/Module.ps1

@@ -39,6 +39,32 @@ $script:SafeCommands['Set-DynamicParameterVariable'] = $ExecutionContext.Session
     'New-PesterContainer'
     'New-PesterConfiguration'
 
+    # assert
+    'Assert-False'
+    'Assert-True'
+    'Assert-All'
+    'Assert-Any'
+    'Assert-Contain'
+    'Assert-NotContain'
+    'Assert-Equivalent'
+    'Assert-Throw'
+    'Assert-Equal'
+    'Assert-GreaterThan'
+    'Assert-GreaterThanOrEqual'
+    'Assert-LessThan'
+    'Assert-LessThanOrEqual'
+    'Assert-NotEqual'
+    'Assert-NotNull'
+    'Assert-NotSame'
+    'Assert-NotType'
+    'Assert-Null'
+    'Assert-Same'
+    'Assert-Type'
+    'Assert-Like'
+    'Assert-NotLike'
+    'Assert-StringEqual'
+    'Assert-StringNotEqual'
+
     # export
     'Export-NUnitReport'
     'ConvertTo-NUnitReport'

src/Pester.psd1

@@ -66,6 +66,33 @@
         'New-PesterContainer'
         'New-PesterConfiguration'
 
+        # assert
+        'Assert-False'
+        'Assert-True'
+        'Assert-All'
+        'Assert-Any'
+        'Assert-Contain'
+        'Assert-NotContain'
+        'Assert-Equivalent'
+        'Assert-Throw'
+        'Assert-Equal'
+        'Assert-GreaterThan'
+        'Assert-GreaterThanOrEqual'
+        'Assert-LessThan'
+        'Assert-LessThanOrEqual'
+        'Assert-NotEqual'
+        'Assert-NotNull'
+        'Assert-NotSame'
+        'Assert-NotType'
+        'Assert-Null'
+        'Assert-Same'
+        'Assert-Type'
+        'Assert-Like'
+        'Assert-NotLike'
+        'Assert-StringEqual'
+        'Assert-StringNotEqual'
+
+
         # legacy
         'Assert-VerifiableMock'
         'Assert-MockCalled'

src/TypeClass.ps1

@@ -39,3 +39,11 @@ function Is-Object ($Value) {
 
     -not ($null -eq $Value -or (Is-Value -Value $Value) -or (Is-Collection -Value $Value))
 }
+
+function Is-DataRow ($Value) {
+    $Value -is [Data.DataRow] -or $Value.Psobject.TypeNames[0] -like '*System.Data.DataRow'
+}
+
+function Is-DataTable ($Value) {
+    $Value -is [Data.DataTable] -or $Value.Psobject.TypeNames[0] -like '*System.Data.DataTable'
+}

src/functions/assert/Boolean/Assert-False.ps1

@@ -0,0 +1,16 @@
+function Assert-False {
+    param (
+        [Parameter(ValueFromPipeline=$true)]
+        $Actual,
+        [String]$CustomMessage
+    )
+
+    $Actual = Collect-Input -ParameterInput $Actual -PipelineInput $local:Input
+    if ($Actual)
+    {
+        $Message = Get-AssertionMessage -Expected $false -Actual $Actual -CustomMessage $CustomMessage -DefaultMessage "Expected <actualType> '<actual>' to be <expectedType> '<expected>' or falsy value 0, """", `$null, @()."
+        throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
+    }
+
+    $Actual
+}

src/functions/assert/Boolean/Assert-True.ps1

@@ -0,0 +1,16 @@
+function Assert-True{
+    param (
+        [Parameter(ValueFromPipeline=$true)]
+        $Actual,
+        [String]$CustomMessage
+    )
+
+    $Actual = Collect-Input -ParameterInput $Actual -PipelineInput $local:Input
+    if (-not $Actual)
+    {
+        $Message = Get-AssertionMessage -Expected $true -Actual $Actual -CustomMessage $CustomMessage -DefaultMessage "Expected <actualType> '<actual>' to be <expectedType> '<expected>' or truthy value."
+        throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
+    }
+
+    $Actual
+}

src/functions/assert/Collection/Assert-All.ps1

@@ -0,0 +1,40 @@
+function Assert-All {
+    [CmdletBinding()]
+    param (
+        [Parameter(ValueFromPipeline = $true, Position = 1)]
+        $Actual,
+        [Parameter(Position = 0, Mandatory = $true)]
+        [scriptblock]$FilterScript,
+        [String]$CustomMessage
+    )
+
+
+    $Expected = $FilterScript
+    $Actual = Collect-Input -ParameterInput $Actual -PipelineInput $local:Input
+    # we are jumping between modules so I need to explicitly pass the _ variable
+    # simply using '&' won't work
+    # see: https://blogs.msdn.microsoft.com/sergey_babkins_blog/2014/10/30/calling-the-script-blocks-in-powershell/
+    $actualFiltered = $Actual | ForEach-Object {
+        # powershell v4 code where we have InvokeWithContext available
+        # $underscore = Get-Variable _
+        # $pass = $FilterScript.InvokeWithContext($null, $underscore, $null)
+
+        # polyfill for PowerShell v2
+        $PSCmdlet.SessionState.PSVariable.Set("_", $_)
+        $pass = & $FilterScript
+
+
+        if (-not $pass) { $_ }
+    }
+
+    if ($actualFiltered) {
+        $data = @{
+            actualFiltered      = $actualFiltered
+            actualFilteredCount = @($actualFiltered).Count
+        }
+        $Message = Get-AssertionMessage -Expected $Expected -Actual $Actual -Data $data -CustomMessage $CustomMessage -DefaultMessage "Expected all items in collection '<actual>' to pass filter '<expected>', but <actualFilteredCount> of them '<actualFiltered>' did not pass the filter."
+        throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
+    }
+
+    $Actual
+}

src/functions/assert/Collection/Assert-Any.ps1

@@ -0,0 +1,19 @@
+function Assert-Any {
+    param (
+        [Parameter(ValueFromPipeline=$true, Position=1)]
+        $Actual,
+        [Parameter(Position=0, Mandatory=$true)]
+        [scriptblock]$FilterScript,
+        [String]$CustomMessage
+    )
+
+    $Expected = $FilterScript
+    $Actual = Collect-Input -ParameterInput $Actual -PipelineInput $local:Input
+    if (-not ($Actual | Where-Object -FilterScript $FilterScript))
+    {
+        $Message = Get-AssertionMessage -Expected $Expected -Actual $Actual -CustomMessage $CustomMessage -DefaultMessage "Expected at least one item in collection '<actual>' to pass filter '<expected>', but none of the items passed the filter."
+        throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
+    }
+
+    $Actual
+}

src/functions/assert/Collection/Assert-Contain.ps1

@@ -0,0 +1,19 @@
+function Assert-Contain {
+    param (
+        [Parameter(Position=1, ValueFromPipeline=$true)]
+        $Actual,
+        [Parameter(Position=0)]
+        $Expected,
+        [String]$CustomMessage
+    )
+
+    $Actual = Collect-Input -ParameterInput $Actual -PipelineInput $local:Input
+    if ($Actual -notcontains $Expected)
+    {
+        $type = [string]$Expected
+        $Message = Get-AssertionMessage -Expected $Expected -Actual $Actual -CustomMessage $CustomMessage -DefaultMessage "Expected <expectedType> '<expected>' to be present in collection '<actual>', but it was not there."
+        throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
+    }
+
+    $Actual
+}

src/functions/assert/Collection/Assert-NotContain.ps1

@@ -0,0 +1,19 @@
+function Assert-NotContain {
+    param (
+        [Parameter(Position=1, ValueFromPipeline=$true)]
+        $Actual,
+        [Parameter(Position=0)]
+        $Expected,
+        [String]$CustomMessage
+    )
+
+    $Actual = Collect-Input -ParameterInput $Actual -PipelineInput $local:Input
+    if ($Actual -contains $Expected)
+    {
+        $type = [string]$Expected
+        $Message = Get-AssertionMessage -Expected $Expected -Actual $Actual -CustomMessage $CustomMessage -DefaultMessage "Expected <expectedType> '<expected>' to not be present in collection '<actual>', but it was there."
+        throw [Pester.Factory]::CreateShouldErrorRecord($Message, $MyInvocation.ScriptName, $MyInvocation.ScriptLineNumber, $MyInvocation.Line.TrimEnd([System.Environment]::NewLine), $true)
+    }
+
+    $Actual
+}