PSRule.Match.Tests.ps1

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

#
# Unit tests for the Match keyword
#

[CmdletBinding()]
param (

)

BeforeAll {
    # Setup error handling
    $ErrorActionPreference = 'Stop';
    Set-StrictMode -Version latest;

    # Setup tests paths
    $rootPath = $PWD;

    Import-Module (Join-Path -Path $rootPath -ChildPath out/modules/PSRule) -Force;
    $here = (Resolve-Path $PSScriptRoot).Path;
}

Describe 'PSRule -- Match keyword' -Tag 'Match' {
    BeforeAll {
        $ruleFilePath = (Join-Path -Path $here -ChildPath 'FromFile.Rule.ps1');
    }

    Context 'Match' {
        It 'With defaults' {
            # Test positive cases
            $goodObjects = @(
                [PSCustomObject]@{ PhoneNumber = '0400 000 000' }
                [PSCustomObject]@{ PhoneNumber = '000' }
                @{ PhoneNumber = '000' }
                @{ Value = @{ PhoneNumber = '0400 000 000' }}
            )
            $result = $goodObjects | Invoke-PSRule -Path $ruleFilePath -Name 'MatchTest';
            $result | Should -Not -BeNullOrEmpty;
            $result.Count | Should -Be 4;
            $result.Outcome | Should -BeIn 'Pass';
            $result.RuleName | Should -BeIn 'MatchTest';
            $result[0].Reason | Should -BeNullOrEmpty;

            # Test negative cases
            $badObjects = @(
                [PSCustomObject]@{ PhoneNo = '0400 000 000' }
                [PSCustomObject]@{ PhoneNumber = '0 000 000' }
                [PSCustomObject]@{ PhoneNumber = '100' }
                @{ PhoneNumber = '100' }
            )
            $result = $badObjects | Invoke-PSRule -Path $ruleFilePath -Name 'MatchTest';
            $result | Should -Not -BeNullOrEmpty;
            $result.Count | Should -Be 4;
            $result.Outcome | Should -BeIn 'Fail';
            $result.RuleName | Should -BeIn 'MatchTest';
            $result.Reason | Should -BeLike "None of the regex(s) matched: *";
        }

        It 'With -CaseSensitive' {
            # Test positive cases
            $goodObjects = @(
                [PSCustomObject]@{ Title = 'Mr' }
                [PSCustomObject]@{ tiTle = 'Miss' }
                @{ Title = 'Miss' }
            )
            $result = $goodObjects | Invoke-PSRule -Path $ruleFilePath -Name 'MatchTestCaseSensitive';
            $result | Should -Not -BeNullOrEmpty;
            $result.Count | Should -Be 3;
            $result.Outcome | Should -BeIn 'Pass';
            $result.RuleName | Should -BeIn 'MatchTestCaseSensitive';

            # Test negative cases
            $badObjects = @(
                [PSCustomObject]@{ Title = 'MR' }
                [PSCustomObject]@{ tiTle = 'miss' }
                @{ Title = 'miss' }
            )
            $result = $badObjects | Invoke-PSRule -Path $ruleFilePath -Name 'MatchTestCaseSensitive';
            $result | Should -Not -BeNullOrEmpty;
            $result.Count | Should -Be 3;
            $result.Outcome | Should -BeIn 'Fail';
            $result.RuleName | Should -BeIn 'MatchTestCaseSensitive';
        }

        It 'With -Not' {
            $testObject = @(
                [PSCustomObject]@{ Title = 'Miss' }
                [PSCustomObject]@{ Title = 'Mr' }
            )

            $result = $testObject | Invoke-PSRule -Path $ruleFilePath -Name 'MatchNot';
            $result | Should -Not -BeNullOrEmpty;
            $result.Count | Should -Be 2;
            $result.RuleName | Should -BeIn 'MatchNot';
            $result[0].IsSuccess() | Should -Be $True;
            $result[1].IsSuccess() | Should -Be $False;
            $result[1].Reason | Should -BeLike "The regex '*' matched.";
        }

        It 'If pre-condition' {
            $testObject = @(
                [PSCustomObject]@{
                    Name = 'TestObject1'
                }
                [PSCustomObject]@{
                    Name = 'TestObject2'
                }
            )
            $option = New-PSRuleOption -NotProcessedWarning $False
            $result = $testObject | Invoke-PSRule -Path $ruleFilePath -Name 'MatchCondition' -Outcome All -Option $option;

            # Test positive cases
            $filteredResult = $result | Where-Object { $_.TargetName -eq 'TestObject1' };
            $filteredResult | Should -Not -BeNullOrEmpty;
            $filteredResult.Outcome | Should -Be 'Pass';

            # Test negative cases
            $filteredResult = $result | Where-Object { $_.TargetName -eq 'TestObject2' };
            $filteredResult | Should -Not -BeNullOrEmpty;
            $filteredResult.Outcome | Should -Be 'None';
        }
    }
}