Functions/Assert-GreaterThan.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-GreaterThan { <# .SYNOPSIS Asserts that a value is greater than another object. .DESCRIPTION Uses PowerShell's `-gt` operator to determine if `$InputObject -gt $LowerBound`. .EXAMPLE Assert-GreaterThan 5 1 Demonstrates how to check if 5 is greater than 1, which it is, so this assertion passes. .EXAMPLE Assert-GreaterThan $Error.Count 5 'Not enough errors were thrown.' Demonstrates how to use the message parameter to give an explanation of why the assertion fails. #> [CmdletBinding()] param( [Parameter(Position=0)] [object] # The value to test. $InputObject, [Parameter(Position=1)] [object] # The lower bound for `InputObject`. $LowerBound, [Parameter(Position=2)] [string] # A description of why the assertion might fail. $Message ) Set-StrictMode -Version 'Latest' if( -not ($InputObject -gt $LowerBound ) ) { Fail "'$InputObject' is not greater than '$LowerBound': $message" } } |