Merge pull request #735 from tienvx/test-provider-state-generator-protobuf

test: Test provider state generator for protobuf

Author: tienvx

example/protobuf-sync-message/consumer/tests/ProtobufClientTest.php

@@ -31,6 +31,7 @@ public function testCalculateArea(): void
         $builder = new SyncMessageBuilder($config, new ProtobufSyncMessageDriverFactory());
         $builder
             ->expectsToReceive('request for calculate shape area')
+            ->given('a shape')
             ->withMetadata([])
             ->withContent(new Text(
                 json_encode([
@@ -40,6 +41,7 @@ public function testCalculateArea(): void
 
                     'request' => [
                         'created' => $matcher->fromProviderState($matcher->date(), '${created}'),
+                        'id' => $matcher->fromProviderState($matcher->uuid(), '${id}'),
                         'rectangle' => [
                             'length' => $matcher->number(3),
                             'width' => $matcher->number(4),
@@ -57,6 +59,7 @@ public function testCalculateArea(): void
         $rectangle = (new Rectangle())->setLength(3)->setWidth(4);
         $message = new ShapeMessage();
         $message->setCreated('2001-06-23');
+        $message->setId('eb87e331-81d6-43c2-b8e8-0574f8c30ab3');
         $message->setRectangle($rectangle);
         $response = $service->calculate($message);
 

example/protobuf-sync-message/library/proto/area_calculator.proto

@@ -15,6 +15,7 @@ message ShapeMessage {
     Parallelogram parallelogram = 5;
   }
   string created = 6;
+  string id = 7;
 }
 
 message Square {

example/protobuf-sync-message/library/src/GPBMetadata/Example/ProtobufSyncMessage/Library/Proto/AreaCalculator.php

@@ -12,13 +12,31 @@
       "pending": false,
       "pluginConfiguration": {
         "protobuf": {
-          "descriptorKey": "a5c44dacffef6eb096b88a6e0245cbd4",
+          "descriptorKey": "196d0b5be51f754cf2761bdb052e8ce6",
+          "expectations": {
+            "request": {
+              "created": "matching(date, 'yyyy-MM-dd', fromProviderState('${created}', ''))",
+              "id": "matching(regex, '^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$', fromProviderState('${id}', ''))",
+              "rectangle": {
+                "length": "matching(number, 3)",
+                "width": "matching(number, 4)"
+              }
+            },
+            "response": {
+              "value": "matching(number, 12)"
+            }
+          },
           "service": ".plugins.Calculator/calculate"
         }
       },
+      "providerStates": [
+        {
+          "name": "a shape"
+        }
+      ],
       "request": {
         "contents": {
-          "content": "EgoNAABAQBUAAIBAMgA=",
+          "content": "EgoNAABAQBUAAIBAMgA6AA==",
           "contentType": "application/protobuf;message=.plugins.ShapeMessage",
           "contentTypeHint": "BINARY",
           "encoded": "base64"
@@ -28,6 +46,10 @@
             "$.created": {
               "expression": "${created}",
               "type": "ProviderState"
+            },
+            "$.id": {
+              "expression": "${id}",
+              "type": "ProviderState"
             }
           }
         },
@@ -42,6 +64,15 @@
                 }
               ]
             },
+            "$.id": {
+              "combine": "AND",
+              "matchers": [
+                {
+                  "match": "regex",
+                  "regex": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$"
+                }
+              ]
+            },
             "$.rectangle.length": {
               "combine": "AND",
               "matchers": [
@@ -105,13 +136,13 @@
     "plugins": [
       {
         "configuration": {
-          "a5c44dacffef6eb096b88a6e0245cbd4": {
-            "protoDescriptors": "CusFChVhcmVhX2NhbGN1bGF0b3IucHJvdG8SB3BsdWdpbnMirAIKDFNoYXBlTWVzc2FnZRIpCgZzcXVhcmUYASABKAsyDy5wbHVnaW5zLlNxdWFyZUgAUgZzcXVhcmUSMgoJcmVjdGFuZ2xlGAIgASgLMhIucGx1Z2lucy5SZWN0YW5nbGVIAFIJcmVjdGFuZ2xlEikKBmNpcmNsZRgDIAEoCzIPLnBsdWdpbnMuQ2lyY2xlSABSBmNpcmNsZRIvCgh0cmlhbmdsZRgEIAEoCzIRLnBsdWdpbnMuVHJpYW5nbGVIAFIIdHJpYW5nbGUSPgoNcGFyYWxsZWxvZ3JhbRgFIAEoCzIWLnBsdWdpbnMuUGFyYWxsZWxvZ3JhbUgAUg1wYXJhbGxlbG9ncmFtEhgKB2NyZWF0ZWQYBiABKAlSB2NyZWF0ZWRCBwoFc2hhcGUiKQoGU3F1YXJlEh8KC2VkZ2VfbGVuZ3RoGAEgASgCUgplZGdlTGVuZ3RoIjkKCVJlY3RhbmdsZRIWCgZsZW5ndGgYASABKAJSBmxlbmd0aBIUCgV3aWR0aBgCIAEoAlIFd2lkdGgiIAoGQ2lyY2xlEhYKBnJhZGl1cxgBIAEoAlIGcmFkaXVzIk8KCFRyaWFuZ2xlEhUKBmVkZ2VfYRgBIAEoAlIFZWRnZUESFQoGZWRnZV9iGAIgASgCUgVlZGdlQhIVCgZlZGdlX2MYAyABKAJSBWVkZ2VDIkgKDVBhcmFsbGVsb2dyYW0SHwoLYmFzZV9sZW5ndGgYASABKAJSCmJhc2VMZW5ndGgSFgoGaGVpZ2h0GAIgASgCUgZoZWlnaHQiJAoMQXJlYVJlc3BvbnNlEhQKBXZhbHVlGAEgASgCUgV2YWx1ZTJJCgpDYWxjdWxhdG9yEjsKCWNhbGN1bGF0ZRIVLnBsdWdpbnMuU2hhcGVNZXNzYWdlGhUucGx1Z2lucy5BcmVhUmVzcG9uc2UiAGIGcHJvdG8z",
-            "protoFile": "syntax = \"proto3\";\n\npackage plugins;\n\nservice Calculator {\n    rpc calculate (ShapeMessage) returns (AreaResponse) {}\n}\n\nmessage ShapeMessage {\n  oneof shape {\n    Square square = 1;\n    Rectangle rectangle = 2;\n    Circle circle = 3;\n    Triangle triangle = 4;\n    Parallelogram parallelogram = 5;\n  }\n  string created = 6;\n}\n\nmessage Square {\n  float edge_length = 1;\n}\n\nmessage Rectangle {\n  float length = 1;\n  float width = 2;\n}\n\nmessage Circle {\n  float radius = 1;\n}\n\nmessage Triangle {\n  float edge_a = 1;\n  float edge_b = 2;\n  float edge_c = 3;\n}\n\nmessage Parallelogram {\n  float base_length = 1;\n  float height = 2;\n}\n\nmessage AreaResponse {\n    float value = 1;\n}\n"
+          "196d0b5be51f754cf2761bdb052e8ce6": {
+            "protoDescriptors": "CvsFChVhcmVhX2NhbGN1bGF0b3IucHJvdG8SB3BsdWdpbnMivAIKDFNoYXBlTWVzc2FnZRIpCgZzcXVhcmUYASABKAsyDy5wbHVnaW5zLlNxdWFyZUgAUgZzcXVhcmUSMgoJcmVjdGFuZ2xlGAIgASgLMhIucGx1Z2lucy5SZWN0YW5nbGVIAFIJcmVjdGFuZ2xlEikKBmNpcmNsZRgDIAEoCzIPLnBsdWdpbnMuQ2lyY2xlSABSBmNpcmNsZRIvCgh0cmlhbmdsZRgEIAEoCzIRLnBsdWdpbnMuVHJpYW5nbGVIAFIIdHJpYW5nbGUSPgoNcGFyYWxsZWxvZ3JhbRgFIAEoCzIWLnBsdWdpbnMuUGFyYWxsZWxvZ3JhbUgAUg1wYXJhbGxlbG9ncmFtEhgKB2NyZWF0ZWQYBiABKAlSB2NyZWF0ZWQSDgoCaWQYByABKAlSAmlkQgcKBXNoYXBlIikKBlNxdWFyZRIfCgtlZGdlX2xlbmd0aBgBIAEoAlIKZWRnZUxlbmd0aCI5CglSZWN0YW5nbGUSFgoGbGVuZ3RoGAEgASgCUgZsZW5ndGgSFAoFd2lkdGgYAiABKAJSBXdpZHRoIiAKBkNpcmNsZRIWCgZyYWRpdXMYASABKAJSBnJhZGl1cyJPCghUcmlhbmdsZRIVCgZlZGdlX2EYASABKAJSBWVkZ2VBEhUKBmVkZ2VfYhgCIAEoAlIFZWRnZUISFQoGZWRnZV9jGAMgASgCUgVlZGdlQyJICg1QYXJhbGxlbG9ncmFtEh8KC2Jhc2VfbGVuZ3RoGAEgASgCUgpiYXNlTGVuZ3RoEhYKBmhlaWdodBgCIAEoAlIGaGVpZ2h0IiQKDEFyZWFSZXNwb25zZRIUCgV2YWx1ZRgBIAEoAlIFdmFsdWUySQoKQ2FsY3VsYXRvchI7CgljYWxjdWxhdGUSFS5wbHVnaW5zLlNoYXBlTWVzc2FnZRoVLnBsdWdpbnMuQXJlYVJlc3BvbnNlIgBiBnByb3RvMw==",
+            "protoFile": "syntax = \"proto3\";\n\npackage plugins;\n\nservice Calculator {\n    rpc calculate (ShapeMessage) returns (AreaResponse) {}\n}\n\nmessage ShapeMessage {\n  oneof shape {\n    Square square = 1;\n    Rectangle rectangle = 2;\n    Circle circle = 3;\n    Triangle triangle = 4;\n    Parallelogram parallelogram = 5;\n  }\n  string created = 6;\n  string id = 7;\n}\n\nmessage Square {\n  float edge_length = 1;\n}\n\nmessage Rectangle {\n  float length = 1;\n  float width = 2;\n}\n\nmessage Circle {\n  float radius = 1;\n}\n\nmessage Triangle {\n  float edge_a = 1;\n  float edge_b = 2;\n  float edge_c = 3;\n}\n\nmessage Parallelogram {\n  float base_length = 1;\n  float height = 2;\n}\n\nmessage AreaResponse {\n    float value = 1;\n}\n"
           }
         },
         "name": "protobuf",
-        "version": "0.5.4"
+        "version": "0.6.2"
       }
     ]
   },

example/protobuf-sync-message/library/src/Plugins/ShapeMessage.php

@@ -11,6 +11,7 @@
 $app->post('/pact-change-state', function (ServerRequestInterface $request): ResponseInterface {
     return Response::json([
         'created' => date('Y-m-d'),
+        'id' => '3b46bf2c-fac7-47c3-8d0c-ff86f76c180c',
     ]);
 });
 

example/protobuf-sync-message/pacts/protobufSyncMessageConsumer-protobufSyncMessageProvider.json

@@ -20,6 +20,9 @@ public function calculate(ShapeMessage $request, ServerContext $serverContext):
         if (empty($request->getCreated())) {
             throw new Exception('Shape created date is required');
         }
+        if (empty($request->getId())) {
+            throw new Exception('Shape ID is required');
+        }
         switch ($request->getShape()) {
             case 'square':
                 $area = $this->calculateSquareArea($request->getSquare());

example/protobuf-sync-message/provider/proxy/index.php

@@ -7,11 +7,13 @@
 use PhpPact\Consumer\Matcher\Model\Expression;
 use PhpPact\Consumer\Matcher\Model\Matcher\ExpressionFormattableInterface;
 use PhpPact\Consumer\Matcher\Model\Matcher\JsonFormattableInterface;
+use PhpPact\Consumer\Matcher\Trait\ExpressionFormattableTrait;
 use PhpPact\Consumer\Matcher\Trait\JsonFormattableTrait;
 
 class Regex extends GeneratorAwareMatcher implements JsonFormattableInterface, ExpressionFormattableInterface
 {
     use JsonFormattableTrait;
+    use ExpressionFormattableTrait;
 
     /**
      * @param string|string[] $values
@@ -39,6 +41,6 @@ public function formatExpression(): Expression
             throw new InvalidValueException(sprintf("Regex matching expression doesn't support value of type %s", gettype($value)));
         }
 
-        return new Expression("matching(regex, %regex%, %value%)", ['regex' => $this->regex, 'value' => $value]);
+        return $this->mergeExpression(new Expression("matching(regex, %regex%, %value%)", ['regex' => $this->regex, 'value' => $value]));
     }
 }