pact_broker-client 1.39.0 → 1.44.0

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -292,6 +292,94 @@
         }
       }
     },
+    {
+      "description": "a request to determine if Bar can be deployed with all Foo tagged prod, ignoring the verification for Foo version 3.4.5",
+      "providerState": "provider Bar version 4.5.6 has a successful verification for Foo version 1.2.3 tagged prod and a failed verification for version 3.4.5 tagged prod",
+      "request": {
+        "method": "get",
+        "path": "/matrix",
+        "query": "q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Bversion%5D=4.5.6&q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Btag%5D=prod&latestby=cvpv&ignore%5B%5D%5Bpacticipant%5D=Foo&ignore%5B%5D%5Bversion%5D=3.4.5"
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "summary": {
+            "deployable": true,
+            "ignored": 1
+          },
+          "notices": [
+            {
+              "text": "some notice",
+              "type": "info"
+            }
+          ],
+          "matrix": [
+            {
+              "consumer": {
+                "name": "Foo",
+                "version": {
+                  "number": "1.2.3"
+                }
+              },
+              "provider": {
+                "name": "Bar",
+                "version": {
+                  "number": "4.5.6"
+                }
+              },
+              "verificationResult": {
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
+              }
+            },
+            {
+              "consumer": {
+                "name": "Foo",
+                "version": {
+                  "number": "3.4.5"
+                }
+              },
+              "provider": {
+                "name": "Bar",
+                "version": {
+                  "number": "4.5.6"
+                }
+              },
+              "verificationResult": {
+                "success": false,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
+              },
+              "ignored": true
+            }
+          ]
+        },
+        "matchingRules": {
+          "$.body.notices": {
+            "min": 1
+          },
+          "$.body.notices[*].*": {
+            "match": "type"
+          },
+          "$.body.matrix[0].verificationResult._links.self.href": {
+            "match": "type"
+          },
+          "$.body.matrix[1].verificationResult._links.self.href": {
+            "match": "type"
+          }
+        }
+      }
+    },
     {
       "description": "a request for the compatibility matrix for Foo version 1.2.3 and Bar version 4.5.6",
       "providerState": "the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6",
@@ -1550,293 +1638,6 @@
         }
       }
     },
-    {
-      "description": "a request for the index resource",
-      "providerState": "the pb:publish-contracts relations exists in the index resource",
-      "request": {
-        "method": "GET",
-        "path": "/",
-        "headers": {
-          "Accept": "application/hal+json"
-        }
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "_links": {
-            "pb:publish-contracts": {
-              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS"
-            }
-          }
-        },
-        "matchingRules": {
-          "$.body._links.pb:publish-contracts.href": {
-            "match": "regex",
-            "regex": "http:\\/\\/.*"
-          }
-        }
-      }
-    },
-    {
-      "description": "a request to publish contracts",
-      "request": {
-        "method": "POST",
-        "path": "/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS",
-        "headers": {
-          "Content-Type": "application/json",
-          "Accept": "application/hal+json"
-        },
-        "body": {
-          "pacticipantName": "Foo",
-          "pacticipantVersionNumber": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-          "branch": "main",
-          "tags": [
-            "dev"
-          ],
-          "buildUrl": "http://build",
-          "contracts": [
-            {
-              "consumerName": "Foo",
-              "providerName": "Bar",
-              "specification": "pact",
-              "contentType": "application/json",
-              "content": "eyJjb25zdW1lciI6eyJuYW1lIjoiRm9vIn0sInByb3ZpZGVyIjp7Im5hbWUiOiJCYXIifSwiaW50ZXJhY3Rpb25zIjpbeyJkZXNjcmlwdGlvbiI6ImFuIGV4YW1wbGUgcmVxdWVzdCIsInByb3ZpZGVyU3RhdGUiOiJhIHByb3ZpZGVyIHN0YXRlIiwicmVxdWVzdCI6eyJtZXRob2QiOiJHRVQiLCJwYXRoIjoiLyIsImhlYWRlcnMiOnt9fSwicmVzcG9uc2UiOnsic3RhdHVzIjoyMDAsImhlYWRlcnMiOnsiQ29udGVudC1UeXBlIjoiYXBwbGljYXRpb24vaGFsK2pzb24ifX19XSwibWV0YWRhdGEiOnsicGFjdFNwZWNpZmljYXRpb24iOnsidmVyc2lvbiI6IjIuMC4wIn19fQ==",
-              "writeMode": "overwrite"
-            }
-          ]
-        }
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "_embedded": {
-            "pacticipant": {
-              "name": "Foo"
-            },
-            "version": {
-              "number": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-              "buildUrl": "http://build"
-            }
-          },
-          "logs": [
-            {
-              "level": "info",
-              "message": "some message"
-            }
-          ],
-          "_links": {
-            "pb:pacticipant-version-tags": [
-              {
-                "name": "dev"
-              }
-            ],
-            "pb:contracts": [
-              {
-                "href": "http://some-pact"
-              }
-            ]
-          }
-        },
-        "matchingRules": {
-          "$.body.logs": {
-            "min": 1
-          },
-          "$.body.logs[*].*": {
-            "match": "type"
-          },
-          "$.body._links.pb:contracts[0].href": {
-            "match": "type"
-          }
-        }
-      }
-    },
-    {
-      "description": "a request for the index resource",
-      "providerState": "the pb:pacticipant-version and pb:environments relations exist in the index resource",
-      "request": {
-        "method": "GET",
-        "path": "/",
-        "headers": {
-          "Accept": "application/hal+json"
-        }
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "_links": {
-            "pb:pacticipant-version": {
-              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
-            },
-            "pb:environments": {
-              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS"
-            }
-          }
-        },
-        "matchingRules": {
-          "$.body._links.pb:pacticipant-version.href": {
-            "match": "regex",
-            "regex": "http:\\/\\/.*{pacticipant}.*{version}"
-          },
-          "$.body._links.pb:environments.href": {
-            "match": "regex",
-            "regex": "http:\\/\\/.*"
-          }
-        }
-      }
-    },
-    {
-      "description": "a request for a pacticipant version",
-      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment",
-      "request": {
-        "method": "GET",
-        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-        "headers": {
-          "Accept": "application/hal+json"
-        }
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "_links": {
-            "pb:record-deployment": [
-              {
-                "name": "test",
-                "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST"
-              }
-            ]
-          }
-        },
-        "matchingRules": {
-          "$.body._links.pb:record-deployment[0].href": {
-            "match": "regex",
-            "regex": "http:\\/\\/.*"
-          }
-        }
-      }
-    },
-    {
-      "description": "a request to record a deployment",
-      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment",
-      "request": {
-        "method": "POST",
-        "path": "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
-        "headers": {
-          "Content-Type": "application/json",
-          "Accept": "application/hal+json"
-        },
-        "body": {
-          "replacedPreviousDeployedVersion": true
-        }
-      },
-      "response": {
-        "status": 201,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "replacedPreviousDeployedVersion": true
-        }
-      }
-    },
-    {
-      "description": "a request for a pacticipant version",
-      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist",
-      "request": {
-        "method": "GET",
-        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-        "headers": {
-          "Accept": "application/hal+json"
-        }
-      },
-      "response": {
-        "status": 404,
-        "headers": {
-        }
-      }
-    },
-    {
-      "description": "a request for a pacticipant version",
-      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with 2 environments that aren't test available for deployment",
-      "request": {
-        "method": "GET",
-        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-        "headers": {
-          "Accept": "application/hal+json"
-        }
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "_links": {
-            "pb:record-deployment": [
-              {
-                "name": "prod",
-                "href": "href"
-              },
-              {
-                "name": "dev",
-                "href": "href"
-              }
-            ]
-          }
-        },
-        "matchingRules": {
-          "$.body._links.pb:record-deployment[0]": {
-            "match": "type"
-          },
-          "$.body._links.pb:record-deployment[1]": {
-            "match": "type"
-          }
-        }
-      }
-    },
-    {
-      "description": "a request for the environments",
-      "providerState": "an environment with name test exists",
-      "request": {
-        "method": "GET",
-        "path": "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
-        "headers": {
-          "Accept": "application/hal+json"
-        }
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "_links": {
-            "pb:environments": [
-              {
-                "name": "test",
-                "href": "href"
-              }
-            ]
-          }
-        },
-        "matchingRules": {
-          "$.body._links.pb:environments[0].href": {
-            "match": "type"
-          }
-        }
-      }
-    },
     {
       "description": "a request to create a webhook with a JSON body for a consumer and provider",
       "providerState": "the 'Pricing Service' and 'Condor' already exist in the pact-broker",

data/spec/service_providers/create_environment_spec.rb

@@ -0,0 +1,78 @@
+require 'service_providers/pact_helper'
+require 'pact_broker/client/environments/create_environment'
+
+RSpec.describe "create an environment", pact: true, skip: true do
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:params) do
+    {
+      name: "test",
+      display_name: "Test",
+      production: false,
+      contact_name: "Foo team",
+      contact_email_address: "foo@bar.com"
+
+    }
+  end
+  let(:pact_broker_client_options) { {} }
+  let(:request_body) do
+    {
+      name: "test",
+      displayName: "Test",
+      production: false,
+      contacts: [{
+        name: "Foo team",
+        details: {
+          emailAddress: "foo@bar.com"
+        }
+      }]
+    }
+  end
+
+  subject { PactBroker::Client::Environments::CreateEnvironment.call(params, broker_base_url, pact_broker_client_options) }
+
+  def mock_index
+    pact_broker
+      .given("the pb:environments relation exists in the index resource")
+      .upon_receiving("a request for the index resource")
+      .with(
+        method: "GET",
+        path: '/',
+        headers: get_request_headers).
+      will_respond_with(
+        status: 200,
+        headers: pact_broker_response_headers,
+        body: {
+          _links: {
+            :'pb:environments' => {
+              href: placeholder_url_term("pb:environments")
+            }
+          }
+        }
+      )
+  end
+
+  def mock_environment_creation_request
+    pact_broker
+      .upon_receiving("a request to create an environment")
+      .with(
+        method: "POST",
+        path: "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
+        headers: post_request_headers,
+        body: request_body
+      )
+      .will_respond_with(
+        status: 201,
+        headers: pact_broker_response_headers,
+        body: request_body.merge("uuid" => Pact.like("ffe683ef-dcd7-4e4f-877d-f6eb3db8e86e"))
+      )
+  end
+
+  it "returns a success result" do
+    mock_index
+    mock_environment_creation_request
+    expect(subject.success).to be true
+    expect(subject.message).to include "Created test environment in the Pact Broker with UUID ffe683ef-dcd7-4e4f-877d-f6eb3db8e86e"
+  end
+end