pact_broker-client 1.33.0 → 1.37.1

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -186,6 +186,112 @@
         }
       }
     },
+    {
+      "description": "a request for the index resource",
+      "providerState": "the pb:pacticipant-version relation 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:pacticipant-version": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:pacticipant-version.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*{pacticipant}.*{version}"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a pacticipant version",
+      "providerState": "version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does not exist",
+      "request": {
+        "method": "put",
+        "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "branch": "main",
+          "buildUrl": "http://my-ci/builds/1"
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "number": "26f353580936ad3b9baddb17b00e84f33c69e7cb",
+          "branch": "main",
+          "buildUrl": "http://my-ci/builds/1",
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a pacticipant version",
+      "providerState": "version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does exist",
+      "request": {
+        "method": "put",
+        "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "branch": "main",
+          "buildUrl": "http://my-ci/builds/1"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "number": "26f353580936ad3b9baddb17b00e84f33c69e7cb",
+          "branch": "main",
+          "buildUrl": "http://my-ci/builds/1",
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
     {
       "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",
@@ -221,7 +327,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -271,7 +382,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -321,7 +437,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -418,7 +539,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -439,7 +565,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -492,7 +623,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -542,7 +678,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -592,7 +733,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -1404,6 +1550,187 @@
         }
       }
     },
+    {
+      "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/pact_broker_client_create_version_spec.rb

@@ -0,0 +1,89 @@
+require_relative 'pact_helper'
+require 'pact_broker/client'
+require 'pact_broker/client/publish_pacts'
+
+describe PactBroker::Client::Versions, pact: true do
+
+  include_context "pact broker"
+
+
+  describe "creating a pacticipant version" do
+    before do
+      allow(publish_pacts).to receive(:consumer_names).and_return(["Foo"])
+      allow($stdout).to receive(:puts)
+    end
+    let(:version_path) { "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-{pacticipant}-{version}" }
+    let(:version_url) { pact_broker.mock_service_base_url + version_path }
+    let(:number) { "26f353580936ad3b9baddb17b00e84f33c69e7cb" }
+    let(:branch) { "main" }
+    let(:build_url) { "http://my-ci/builds/1" }
+    let(:consumer_version_params) { { number: number, branch: branch, build_url: build_url } }
+    let(:publish_pacts) { PactBroker::Client::PublishPacts.new(pact_broker.mock_service_base_url, ["some-pact.json"], consumer_version_params, {}) }
+    let(:provider_state) { "version #{number} of pacticipant Foo does not exist" }
+    let(:expected_response_status) { 201 }
+
+    subject { publish_pacts.send(:create_consumer_versions) }
+
+    before do
+      pact_broker
+        .given("the pb:pacticipant-version 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:pacticipant-version' => {
+                  href: Pact.term(version_url, /http:\/\/.*{pacticipant}.*{version}/)
+                }
+              }
+            }
+          )
+
+      pact_broker
+        .given(provider_state)
+        .upon_receiving("a request to create a pacticipant version")
+        .with(
+            method: :put,
+            path: "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-#{number}",
+            headers: put_request_headers,
+            body: {
+              branch: branch,
+              buildUrl: build_url
+            }).
+          will_respond_with(
+            status: expected_response_status,
+            headers: pact_broker_response_headers,
+            body: {
+              number: number,
+              branch: branch,
+              buildUrl: build_url,
+              _links: {
+                self: {
+                  href: Pact.term('http://localhost:1234/some-url', %r{http://.*})
+                }
+              }
+            }
+          )
+    end
+
+    context "when the version does not already exist" do
+      it "returns true" do
+        expect(subject).to be true
+      end
+    end
+
+    context "when the version does exist" do
+      let(:provider_state) { "version #{number} of pacticipant Foo does exist" }
+      let(:expected_response_status) { 200 }
+
+      it "returns true" do
+        expect(subject).to be true
+      end
+    end
+  end
+end