Remove Get-EquivalencyOptions (#2502)

pester · Jun 17, 2024 · baccd01 · baccd01
1 parent ec55e36
commit baccd01
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 32 deletions.
diff --git a/src/Module.ps1 b/src/Module.ps1
@@ -89,8 +89,6 @@ $script:SafeCommands['Set-DynamicParameterVariable'] = $ExecutionContext.Session
     'Should-BeBefore'
     'Should-BeAfter'
 
-    'Get-EquivalencyOption'
-
     # export
     'Export-NUnitReport'
     'ConvertTo-NUnitReport'

diff --git a/src/Pester.psd1 b/src/Pester.psd1
@@ -111,8 +111,6 @@
         'Should-BeBefore'
         'Should-BeAfter'
 
-        'Get-EquivalencyOption'
-
         # helpers
         'New-MockObject'
         'New-Fixture'

diff --git a/src/functions/assert/Equivalence/Should-BeEquivalent.ps1 b/src/functions/assert/Equivalence/Should-BeEquivalent.ps1
@@ -531,7 +531,7 @@ function Compare-Equivalent {
     )
 
     if (-not $PSBoundParameters.ContainsKey('Options')) {
-        throw [System.ArgumentException]::new('-Options must be provided. If you see this and you are not developing Pester, please file issue at https://github.com/pester/Pester/issues','Options')
+        throw [System.ArgumentException]::new('-Options must be provided. If you see this and you are not developing Pester, please file issue at https://github.com/pester/Pester/issues', 'Options')
     }
 
     if ($null -ne $Options.ExcludedPaths -and $Options.ExcludedPaths -contains $Path) {
@@ -628,11 +628,26 @@ function Should-BeEquivalent {
     .PARAMETER Because
     The reason why the input should be the expected value.
 
-    .PARAMETER Options
-    Options for the comparison. Get-EquivalencyOption function is called to get the default options.
+    .PARAMETER ExcludePath
+    An array of strings specifying the paths to exclude from the comparison. Each path should correspond to a property name or a chain of property names separated by dots for nested properties. The paths use dot notation to navigate to a child property, such as "user.name".
+
+    .PARAMETER ExcludePathsNotOnExpected
+    A switch parameter that, when set, excludes any paths from the comparison that are not present on the expected object. This is useful for ignoring extra properties on the actual object that are not relevant to the comparison.
+
+    .PARAMETER Comparator
+    Specifies the comparison strategy to use. The options are 'Equivalency' for a deep comparison that considers the structure and values of objects, and 'Equality' for a simple equality comparison. The default is 'Equivalency'.
+
+    .EXAMPLE
+    ```powershell
+        Should-BeEquivalent ...  -ExcludePath 'Id', 'Timestamp' -Comparator 'Equality'
+    ```
+    This example generates an equivalency option object that excludes the 'Id' and 'Timestamp' properties from the comparison and uses a simple equality comparison strategy.
 
-    .PARAMETER StrictOrder
-    If set, the order of items in collections will be compared.
+    .EXAMPLE
+    ```powereshell
+        Should-BeEquivalent ... -ExcludePathsNotOnExpected
+    ```
+    This example generates an equivalency option object that excludes any paths not present on the expected object from the comparison, using the default deep comparison strategy.
 
     .EXAMPLE
     ```powershell
@@ -678,11 +693,16 @@ function Should-BeEquivalent {
         [Parameter(Position = 0, Mandatory)]
         $Expected,
         [String]$Because,
-        $Options = (Get-EquivalencyOption)
+        [string[]] $ExcludePath = @(),
+        [switch] $ExcludePathsNotOnExpected,
+        [ValidateSet('Equivalency', 'Equality')]
+        [string] $Comparator = 'Equivalency'
         # TODO: I am not sure this works.
         # [Switch] $StrictOrder
     )
 
+    $options = Get-EquivalencyOption -ExcludePath:$ExcludePath -ExcludePathsNotOnExpected:$ExcludePathsNotOnExpected -Comparator:$Comparator
+
     $collectedInput = Collect-Input -ParameterInput $Actual -PipelineInput $local:Input -IsPipelineInput $MyInvocation.ExpectingInput -UnrollInput
     $Actual = $collectedInput.Actual
 

diff --git a/tst/functions/assert/Equivalence/Should-BeEquivalent.Options.Tests.ps1 b/tst/functions/assert/Equivalence/Should-BeEquivalent.Options.Tests.ps1
@@ -203,8 +203,7 @@ InPesterModuleScope {
                     Name = "Jakub"
                 }
 
-                $options = Get-EquivalencyOption -ExcludePath "Age", "NonExisting"
-                $err = { Should-BeEquivalent -Actual $actual -Expected $expected -Options $options } | Verify-AssertionFailed
+                $err = { Should-BeEquivalent -Actual $actual -Expected $expected -ExcludePath "Age", "NonExisting" } | Verify-AssertionFailed
 
                 $err.Exception.Message | Verify-Like "*Expected has property 'Location'*"
                 $err.Exception.Message | Verify-Like "*Exclude path 'Age'*"
@@ -222,8 +221,7 @@ InPesterModuleScope {
                     Name = "Jakub"
                 }
 
-                $options = Get-EquivalencyOption -ExcludePath Loc*
-                Should-BeEquivalent -Actual $actual -Expected $expected -Options $Options
+                Should-BeEquivalent -Actual $actual -Expected $expected -ExcludePath Loc*
             }
 
             It "Given wildcarded path it ignores it on the actual object" {
@@ -236,8 +234,7 @@ InPesterModuleScope {
                     Location = "Prague"
                 }
 
-                $options = Get-EquivalencyOption -ExcludePath Loc*
-                Should-BeEquivalent -Actual $actual -Expected $expected -Options $Options
+                Should-BeEquivalent -Actual $actual -Expected $expected -ExcludePath Loc*
             }
 
             It "Given wildcarded path it ignores it on the expected hashtable" {
@@ -250,8 +247,7 @@ InPesterModuleScope {
                     Name = "Jakub"
                 }
 
-                $options = Get-EquivalencyOption -ExcludePath Loc*
-                Should-BeEquivalent -Actual $actual -Expected $expected -Options $Options
+                Should-BeEquivalent -Actual $actual -Expected $expected -ExcludePath Loc*
             }
 
             It "Given wildcarded path it ignores it on the actual hashtable" {
@@ -264,8 +260,7 @@ InPesterModuleScope {
                     Location = "Prague"
                 }
 
-                $options = Get-EquivalencyOption -ExcludePath Loc*
-                Should-BeEquivalent -Actual $actual -Expected $expected -Options $Options
+                Should-BeEquivalent -Actual $actual -Expected $expected -ExcludePath Loc*
             }
 
             It "Given wildcarded path it ignores it on the expected dictionary" {
@@ -278,8 +273,7 @@ InPesterModuleScope {
                     Name = "Jakub"
                 }
 
-                $options = Get-EquivalencyOption -ExcludePath Loc*
-                Should-BeEquivalent -Actual $actual -Expected $expected -Options $Options
+                Should-BeEquivalent -Actual $actual -Expected $expected -ExcludePath Loc*
             }
 
             It "Given wildcarded path it ignores it on the actual dictionary" {
@@ -292,8 +286,7 @@ InPesterModuleScope {
                     Location = "Prague"
                 }
 
-                $options = Get-EquivalencyOption -ExcludePath Loc*
-                Should-BeEquivalent -Actual $actual -Expected $expected -Options $Options
+                Should-BeEquivalent -Actual $actual -Expected $expected -ExcludePath Loc*
             }
         }
 
@@ -309,8 +302,7 @@ InPesterModuleScope {
                     Age      = 30
                 }
 
-                $options = Get-EquivalencyOption -ExcludePathsNotOnExpected
-                Should-BeEquivalent -Actual $actual -Expected $expected -Options $Options
+                Should-BeEquivalent -Actual $actual -Expected $expected -ExcludePathsNotOnExpected
             }
 
             It "Given actual hashtable that has more keys that expected it skips them" {
@@ -324,8 +316,7 @@ InPesterModuleScope {
                     Age      = 30
                 }
 
-                $options = Get-EquivalencyOption -ExcludePathsNotOnExpected
-                Should-BeEquivalent -Actual $actual -Expected $expected -Options $Options
+                Should-BeEquivalent -Actual $actual -Expected $expected -ExcludePathsNotOnExpected
             }
 
             It "Given actual dictionary that has more keys that expected it skips them" {
@@ -339,8 +330,7 @@ InPesterModuleScope {
                     Age      = 30
                 }
 
-                $options = Get-EquivalencyOption -ExcludePathsNotOnExpected
-                Should-BeEquivalent -Actual $actual -Expected $expected -Options $Options
+                Should-BeEquivalent -Actual $actual -Expected $expected -ExcludePathsNotOnExpected
             }
         }
     }
@@ -355,8 +345,7 @@ InPesterModuleScope {
                 LikesIfsInMocks = "False"
             }
 
-            $options = Get-EquivalencyOption -Comparator Equality
-            { Should-BeEquivalent -Actual $actual -Expected $expected -Options $options } | Verify-AssertionFailed
+            { Should-BeEquivalent -Actual $actual -Expected $expected -Comparator Equality } | Verify-AssertionFailed
         }
     }