Merge pull request #358 from tienvx/each-value-matcher

feat: Add eachValue matcher
pact-foundation · Oct 31, 2023 · 0cfd132 · 0cfd132
2 parents 61a48bf + f08a32a
commit 0cfd132
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 0 deletions.
diff --git a/example/matchers/consumer/tests/Service/MatchersTest.php b/example/matchers/consumer/tests/Service/MatchersTest.php
@@ -79,6 +79,10 @@ public function testGetMatchers()
                     'c' => 'ccc',
                 ]),
                 'contentType' => $this->matcher->contentType('text/html'),
+                'eachValue' => $this->matcher->eachValue(
+                    ['vehicle 1' => 'car'],
+                    [$this->matcher->regex(null, 'car|bike|motorbike')]
+                ),
             ]);
 
         $config = new MockServerConfig();
@@ -147,6 +151,9 @@ public function testGetMatchers()
                 'ccc',
             ],
             'contentType' => 'text/html',
+            'eachValue' => [
+                'vehicle 1' => 'car',
+            ],
         ], $matchersResult);
     }
 }
diff --git a/example/matchers/pacts/matchersConsumer-matchersProvider.json b/example/matchers/pacts/matchersConsumer-matchersProvider.json
@@ -71,6 +71,9 @@
             "eachLike": [
               "item"
             ],
+            "eachValue": {
+              "vehicle 1": "car"
+            },
             "email": "[email protected]",
             "equal": "exact this value",
             "hexadecimal": "F7A16",
@@ -272,6 +275,21 @@
                 }
               ]
             },
+            "$.eachValue": {
+              "combine": "AND",
+              "matchers": [
+                {
+                  "match": "eachValue",
+                  "rules": [
+                    {
+                      "match": "regex",
+                      "regex": "car|bike|motorbike"
+                    }
+                  ],
+                  "value": "{\"vehicle 1\":\"car\"}"
+                }
+              ]
+            },
             "$.email": {
               "combine": "AND",
               "matchers": [

diff --git a/example/matchers/provider/public/index.php b/example/matchers/provider/public/index.php
@@ -65,6 +65,10 @@
             </body>
             </html>
             HTML,
+        'eachValue' => [
+            'item 1' => 'bike',
+            'item 2' => 'motorbike',
+        ],
     ]));
 
     return $response->withHeader('Content-Type', 'application/json');

diff --git a/src/PhpPact/Consumer/Matcher/Matcher.php b/src/PhpPact/Consumer/Matcher/Matcher.php
@@ -660,4 +660,21 @@ public function contentType(string $contentType): array
             'pact:matcher:type' => 'contentType',
         ];
     }
+
+    /**
+     * Allows defining matching rules to apply to the values in a collection. For maps, delgates to the Values matcher.
+     *
+     * @param array<string, mixed> $values
+     * @param array<mixed>         $rules
+     *
+     * @return array<string, mixed>
+     */
+    public function eachValue(array $values, array $rules): array
+    {
+        return [
+            'rules'             => $rules,
+            'value'             => $values,
+            'pact:matcher:type' => 'eachValue',
+        ];
+    }
 }
diff --git a/tests/PhpPact/Consumer/Matcher/MatcherTest.php b/tests/PhpPact/Consumer/Matcher/MatcherTest.php
@@ -887,4 +887,24 @@ public function testContentType()
 
         $this->assertEquals($expected, $actual);
     }
+
+    public function testEachValue()
+    {
+        $values = [
+            'vehicle 1' => 'car',
+            'vehicle 2' => 'bike',
+            'vehicle 3' => 'motorbike'
+        ];
+        $rules = [
+            $this->matcher->regex('car', 'car|bike|motorbike'),
+        ];
+        $expected = [
+            'rules'             => $rules,
+            'value'             => $values,
+            'pact:matcher:type' => 'eachValue',
+        ];
+        $actual = $this->matcher->eachValue($values, $rules);
+
+        $this->assertEquals($expected, $actual);
+    }
 }