Assert-False.ps1
|
# Copyright 2012 - 2015 Aaron Jensen # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. function Assert-False { <# .SYNOPSIS Asserts an object is false. .DESCRIPTION Uses PowerShell's rules for determinig truthiness. The following objects evaluate to `$false`: * `0` * `$false` * '' (i.e. `[String]::Empty`) * `$null` * `@()` (i.e. empty arrays) All other values are true. .EXAMPLE Assert-False $true Demonstrates how to fail a test. .EXAMPLE Assert-False (Invoke-SomethingThatShouldFail) Demonstrates how to check that a function returns a true object/value. .EXAMPLE Assert-False $true 'The fladoozle didn't dooflaple.' Demonstrates how to use the `Message` parameter to describe why the assertion might have failed. #> [CmdletBinding()] param( [Parameter(Position=0)] [object] # The value to check. $InputObject, [Parameter(Position=1)] [string] # A description about why the assertion might fail. $Message ) Set-StrictMode -Version 'Latest' if( $InputObject ) { Fail "Expected false, but was true. $Message" } } |