pact_broker 2.89.1 → 2.93.0

data/spec/features/wip_pacts_spec.rb

@@ -1,387 +0,0 @@
-RSpec.describe "the lifecycle of a WIP pact" do
-  let(:pact_content_1) { { interactions: [{ some: "interaction"}] }.to_json }
-  let(:pact_content_2) { { interactions: [{ some: "other interaction"}] }.to_json }
-  let(:pact_content_3) { { interactions: [{ some: "other other interaction"}] }.to_json }
-  let(:request_headers) { { "CONTENT_TYPE" => "application/json", "HTTP_ACCEPT" => "application/hal+json"} }
-  let(:provider_version_number) { "2" }
-  let(:pacts_for_verification_request_body) do
-    {
-      consumerVersionSelectors: [ { tag: "master", latest: true } ],
-      providerVersionTags: ["master"],
-      includeWipPactsSince: start_date,
-      includePendingStatus: true
-    }.to_json
-  end
-
-  let(:start_date) { (Date.today - 1).to_datetime }
-
-  def create_initial_provider_version_on_master
-    td.set_now(DateTime.now - 100)
-      .create_provider("Bar")
-      .create_provider_version("1")
-      .create_provider_version_tag("master")
-  end
-
-  def can_i_merge(consumer_version)
-    can_i_deploy(consumer_version, "master")
-  end
-
-  def can_i_deploy(consumer_version, provider_tag)
-    can_i_deploy_response = get("/can-i-deploy", { pacticipant: "Foo", version: consumer_version, to: provider_tag })
-    JSON.parse(can_i_deploy_response.body)["summary"]["deployable"]
-  end
-
-  def publish_pact_with_master_tag
-    put("/pacts/provider/Bar/consumer/Foo/version/1", pact_content_1, request_headers)
-    put("/pacticipants/Foo/versions/1/tags/master", nil, request_headers)
-  end
-
-  def publish_pact_with_feature_tag(version = "2", tag = "feat-x", pact_content = nil)
-    put("/pacts/provider/Bar/consumer/Foo/version/#{version}", pact_content || pact_content_2, request_headers)
-    put("/pacticipants/Foo/versions/#{version}/tags/#{tag}", nil, request_headers)
-  end
-
-  def publish_new_pact_with_master_tag_after_merging_in_feature_branch
-    put("/pacts/provider/Bar/consumer/Foo/version/3", pact_content_2, request_headers)
-    put("/pacticipants/Foo/versions/3/tags/master", nil, request_headers)
-  end
-
-  def get_pacts_for_verification(request_body = nil)
-    post("/pacts/provider/Bar/for-verification", request_body || pacts_for_verification_request_body, request_headers)
-  end
-
-  def pact_urls_from(pacts_for_verification_response)
-    JSON.parse(pacts_for_verification_response.body)["_embedded"]["pacts"].collect do | pact |
-      pact["_links"]["self"]["href"]
-    end
-  end
-
-  def wip_pact_url_from(pacts_for_verification_response)
-    wip_pacts_from(pacts_for_verification_response).first["_links"]["self"]["href"]
-  end
-
-  def get_pact(pact_url)
-    get(pact_url, nil, request_headers)
-  end
-
-  def verification_results_url_from(pact_response)
-    JSON.parse(pact_response.body)["_links"]["pb:publish-verification-results"]["href"]
-  end
-
-  def publish_verification_results_with_tag_master(verification_results_url, success)
-    publish_verification_results(provider_version_number, "master", verification_results_url, success)
-  end
-
-  def publish_verification_results(provider_version_number, tag, verification_results_url, success)
-    request_body = { success: success, providerApplicationVersion: provider_version_number}.to_json
-    post(verification_results_url, request_body, request_headers)
-    put("/pacticipants/Bar/versions/#{provider_version_number}/tags/#{tag}", nil, request_headers)
-  end
-
-  def pending_status_from(pacts_for_verification_response)
-    JSON.parse(pacts_for_verification_response.body)["_embedded"]["pacts"][0]["verificationProperties"]["pending"]
-  end
-
-  def wip_pacts_from(pacts_for_verification_response)
-    JSON.parse(pacts_for_verification_response.body)["_embedded"]["pacts"].select do | pact |
-      pact["verificationProperties"]["wip"]
-    end
-  end
-
-  def build_pacts_for_verification_request_body(provider_version_tag, consumer_version_tag = nil)
-    {
-      consumerVersionSelectors: [ { tag: consumer_version_tag || provider_version_tag, latest: true, fallbackTag: "master" } ],
-      providerVersionTags: [provider_version_tag],
-      includeWipPactsSince: start_date,
-      includePendingStatus: true
-    }.to_json
-  end
-
-  context "when the includeWipPactsSince date is specified" do
-    context "a pact published afer the specified date, with a tag that is not specified explictly in the 'pacts for verification' request" do
-      describe "when it is first published" do
-        it "is included in the list of pacts to verify as a WIP pact" do
-          publish_pact_with_master_tag
-          publish_pact_with_feature_tag
-
-          pacts_for_verification_response = get_pacts_for_verification
-          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 1
-        end
-      end
-
-      describe "when it is verified unsuccessfully" do
-        it "is still included as a WIP pact" do
-          # CONSUMER BUILD
-          # publish pact
-          publish_pact_with_master_tag
-          publish_pact_with_feature_tag
-
-          # PROVIDER BUILD
-          # fetch pacts to verify
-          pacts_for_verification_response = get_pacts_for_verification
-          pact_url = wip_pact_url_from(pacts_for_verification_response)
-          pact_response = get_pact(pact_url)
-
-          # verify pact... failure...
-
-          # publish failure verification results
-          verification_results_url = verification_results_url_from(pact_response)
-          publish_verification_results_with_tag_master(verification_results_url, false)
-
-          # ANOTHER PROVIDER BUILD
-          # get pacts for verification
-          pacts_for_verification_response = get_pacts_for_verification
-          # still pending
-          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 1
-        end
-      end
-
-      describe "when it is verified successfully while included as a WIP pact" do
-        it "is still included as a WIP pact" do
-          # CONSUMER BUILD
-          publish_pact_with_master_tag
-          publish_pact_with_feature_tag
-
-          # PROVIDER BUILD - master
-          # fetch pacts to verify
-          pacts_for_verification_response = get_pacts_for_verification
-          pact_url = wip_pact_url_from(pacts_for_verification_response)
-          pact_response = get_pact(pact_url)
-          expect(wip_pacts_from(pacts_for_verification_response).first["verificationProperties"]["pending"]).to be true
-
-          # verify pact... success!
-
-          # publish success verification results
-          verification_results_url = verification_results_url_from(pact_response)
-          publish_verification_results_with_tag_master(verification_results_url, true)
-
-          # ANOTHER PROVIDER BUILD 2 - master
-          # get pacts for verification
-          # publish successful verification results
-          pacts_for_verification_response = get_pacts_for_verification
-          # still wip
-          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 1
-          # still pending - but maybe it should not be?
-          expect(wip_pacts_from(pacts_for_verification_response).first["verificationProperties"]["pending"]).to be true
-        end
-      end
-
-      describe "when it is verified successfully when included explicitly" do
-        it "is no longer included as a WIP pact" do
-          # CONSUMER BUILD
-          publish_pact_with_master_tag
-          publish_pact_with_feature_tag
-
-          # PROVIDER BUILD
-          # fetch pacts to verify
-          pacts_for_verification_response = get_pacts_for_verification
-          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 1
-          pact_url = wip_pact_url_from(pacts_for_verification_response)
-          pact_response = get_pact(pact_url)
-
-          # verify pact... success!
-
-          # publish success verification results
-          verification_results_url = verification_results_url_from(pact_response)
-          publish_verification_results_with_tag_master(verification_results_url, true)
-
-          # CONSUMER BUILD
-          # merge feature branch into master
-          publish_new_pact_with_master_tag_after_merging_in_feature_branch
-
-          # ANOTHER PROVIDER BUILD 3
-          # get pacts for verification
-          # publish successful verification results
-          pacts_for_verification_response = get_pacts_for_verification
-          # no longer wip
-          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 0
-        end
-      end
-
-      describe "a feature branching scenario" do
-        it "keeps being WIP until the branch is merged" do
-          # CONSUMER BUILD - master
-          publish_pact_with_master_tag
-
-          # CONSUMER BUILD - feature branch
-          publish_pact_with_feature_tag
-          expect(can_i_merge("2")).to_not be true
-
-          # PROVIDER BUILD
-          # fetch pacts to verify
-          pacts_for_verification_response = get_pacts_for_verification
-          pact_url = wip_pact_url_from(pacts_for_verification_response)
-          pact_response = get_pact(pact_url)
-
-          # verify pact... success!
-
-          # publish success verification results
-          verification_results_url = verification_results_url_from(pact_response)
-          publish_verification_results("1", "master", verification_results_url, true)
-
-          # CONSUMER
-          expect(can_i_merge("2")).to be true
-
-          # ANOTHER PROVIDER BUILD before the consumer build runs again
-          # fetch pacts to verify
-          pacts_for_verification_response = get_pacts_for_verification
-          # feat-x pact is still wip
-          pact_url = wip_pact_url_from(pacts_for_verification_response)
-          pact_response = get_pact(pact_url)
-
-          # however feat-x pact is no longer pending because it has a successful verification from master!!!
-          # Question: do we want this behaviour? Or should pending use the same logic?
-          expect(wip_pacts_from(pacts_for_verification_response).first["verificationProperties"]["wip"]).to be true
-          expect(wip_pacts_from(pacts_for_verification_response).first["verificationProperties"]["pending"]).to be true
-
-          # verify pact... success!
-
-          # publish success verification results
-          verification_results_url = verification_results_url_from(pact_response)
-          publish_verification_results("2", "master", verification_results_url, true)
-
-          # CONSUMER BUILD
-          # merge feature branch into master
-          expect(can_i_merge("2")).to be true
-          publish_new_pact_with_master_tag_after_merging_in_feature_branch
-          expect(can_i_deploy("3", "master")).to be true
-
-          # ANOTHER PROVIDER BUILD 3
-          # get pacts for verification
-          # publish successful verification results
-          pacts_for_verification_response = get_pacts_for_verification
-          # no longer wip
-          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 0
-        end
-      end
-
-      describe "a feature branching scenario with multiple provider feature branches" do
-        it "is WIP on a second feature branch even if the first feature branch successfully verified it" do
-          # CONSUMER BUILD - feature branch
-          publish_pact_with_feature_tag
-
-          # PROVIDER BUILD for feature branch 1
-          # fetch pacts to verify
-          pacts_for_verification_response = get_pacts_for_verification(build_pacts_for_verification_request_body("feat-1", "master"))
-          pact_response = get_pact(wip_pact_url_from(pacts_for_verification_response))
-
-          # verify pact... success!
-
-          # publish success verification results
-          publish_verification_results("1", "feat-1", verification_results_url_from(pact_response), true)
-
-          # ANOTHER PROVIDER BUILD on a different new feature branch
-          # fetch pacts to verify
-          sleep 1 if ::DB.mysql?
-          pacts_for_verification_response = get_pacts_for_verification(build_pacts_for_verification_request_body("feat-2", "master"))
-          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 1
-        end
-      end
-
-      describe "a feature branching scenario with matching feature branches" do
-        it "stays wip on master even after it has been successfully verified on the provider's feature branch" do
-          # CONSUMER BUILD - feature branch
-          publish_pact_with_feature_tag
-
-          # PROVIDER BUILD - master
-          # fetch pacts to verify
-          pacts_for_verification_response = get_pacts_for_verification(build_pacts_for_verification_request_body("master"))
-          pact_url = wip_pact_url_from(pacts_for_verification_response)
-          pact_response = get_pact(pact_url)
-
-          # verify pact... failure (not implemented on master yet)
-
-          # publish failure verification results
-          verification_results_url = verification_results_url_from(pact_response)
-          publish_verification_results("1", "master", verification_results_url, false)
-
-          # PROVIDER BUILD - on a matching feature branch
-          # fetch pacts to verify
-          pacts_for_verification_response = get_pacts_for_verification(build_pacts_for_verification_request_body("feat-x", "feat-x"))
-          # pact is not WIP because it has been explicitly included
-          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 0
-          pact_url = pact_urls_from(pacts_for_verification_response).first
-          pact_response = get_pact(pact_url)
-
-          # verify pact - success on feature branch!
-
-          # publish successful results from feature branch
-          verification_results_url = verification_results_url_from(pact_response)
-          publish_verification_results("2", "feat-x", verification_results_url, true)
-
-          # PROVIDER BUILD - back on master
-          pacts_for_verification_response = get_pacts_for_verification(build_pacts_for_verification_request_body("master"))
-          # still wip for master
-          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 1
-        end
-      end
-
-      describe "when a brand new provider branch is created" do
-        it "does not include any pacts already successfully verified by another branch before this branch was created" do
-          # CONSUMER BUILD - master
-          publish_pact_with_master_tag
-
-          # PROVIDER BUILD - master
-          pacts_for_verification_response = get_pacts_for_verification(build_pacts_for_verification_request_body("master", "master"))
-
-          # verify master pact successfully from provider master branch
-          pact_url = pact_urls_from(pacts_for_verification_response).first
-          pact_response = get_pact(pact_url)
-          verification_results_url = verification_results_url_from(pact_response)
-          publish_verification_results("1", "master", verification_results_url, true)
-          sleep 1 if ::DB.mysql?
-
-          # CONSUMER BUILD - feature branch
-          publish_pact_with_feature_tag
-
-          # PROVIDER BUILD - brand new feature branch
-          pacts_for_verification_response = get_pacts_for_verification(build_pacts_for_verification_request_body("feat-y", "master"))
-          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 1
-
-          # verify feature pact successfully
-          # pact_url = pact_urls_from(pacts_for_verification_response).first
-          # pact_response = get_pact(pact_url)
-
-          # # publish successful results from feature branch
-          # verification_results_url = verification_results_url_from(pact_response)
-          # publish_verification_results("2", "feat-y", verification_results_url, true)
-
-          # # PROVIDER BUILD 2 - feature branch
-          # pacts_for_verification_response = get_pacts_for_verification(build_pacts_for_verification_request_body("feat-y", "master"))
-          # # still no wip pacts
-          # expect(wip_pacts_from(pacts_for_verification_response).size).to eq 0
-        end
-
-        it "does include any subsequently created new pacts" do
-          # CONSUMER BUILD - master
-          publish_pact_with_master_tag
-
-          # CONSUMER BUILD - feature branch
-          publish_pact_with_feature_tag
-
-          # PROVIDER BUILD - brand new feature branch
-          pacts_for_verification_response = get_pacts_for_verification(build_pacts_for_verification_request_body("feat-y", "master"))
-          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 1
-
-          # verify master pact successfully (creates a new provider version with tag feat-y)
-          pact_url = pact_urls_from(pacts_for_verification_response).first
-          pact_response = get_pact(pact_url)
-          verification_results_url = verification_results_url_from(pact_response)
-          publish_verification_results("2", "feat-y", verification_results_url, true)
-          sleep 1 if ::DB.mysql? # time resolution is lower on MySQL, need to make sure the next pacts are created after the above provider version
-
-          # CONSUMER BUILD - feature branch again
-          # republish same pact content with new version
-          publish_pact_with_feature_tag("3")
-
-          # CONSUMER BUILD - another feature branch
-          publish_pact_with_feature_tag("4", "feat-z", pact_content_3)
-
-          # PROVIDER BUILD - new feature branch again
-          pacts_for_verification_response = get_pacts_for_verification(build_pacts_for_verification_request_body("feat-y", "master"))
-          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 2
-        end
-      end
-    end
-  end
-end

data/spec/fixtures/a_consumer-a_provider-2.json

@@ -1,22 +0,0 @@
-{
-  "consumer": {
-    "name": "A Consumer"
-  },
-  "provider": {
-    "name": "A Provider"
-  },
-  "interactions": [
-    {
-      "description" : "a request for something",
-      "providerState": null,
-      "request": {
-        "method": "post",
-        "path" : "/something"
-      },
-      "response": {
-        "status": 200,
-        "body" : "something"
-      }
-    }
-  ]
-}

data/spec/fixtures/a_consumer-a_provider-3.json

@@ -1,22 +0,0 @@
-{
-  "consumer": {
-    "name": "A Consumer"
-  },
-  "provider": {
-    "name": "A Provider"
-  },
-  "interactions": [
-    {
-      "description" : "another request for something",
-      "providerState": null,
-      "request": {
-        "method": "get",
-        "path" : "/something_else"
-      },
-      "response": {
-        "status": 200,
-        "body" : "something"
-      }
-    }
-  ]
-}

data/spec/fixtures/a_consumer-a_provider-conflict.json

@@ -1,22 +0,0 @@
-{
-  "consumer": {
-    "name": "A Consumer"
-  },
-  "provider": {
-    "name": "A Provider"
-  },
-  "interactions": [
-    {
-      "description" : "a request for something",
-      "providerState": null,
-      "request": {
-        "method": "post",
-        "path" : "/something"
-      },
-      "response": {
-        "status": 200,
-        "body" : "something"
-      }
-    }
-  ]
-}

data/spec/fixtures/a_consumer-a_provider-merged.json

@@ -1,34 +0,0 @@
-{
-  "consumer": {
-    "name": "A Consumer"
-  },
-  "provider": {
-    "name": "A Provider"
-  },
-  "interactions": [
-    {
-      "description" : "another request for something",
-      "providerState": null,
-      "request": {
-        "method": "get",
-        "path" : "/something_else"
-      },
-      "response": {
-        "status": 200,
-        "body" : "something"
-      }
-    },
-    {
-      "description" : "a request for something",
-      "providerState": null,
-      "request": {
-        "method": "get",
-        "path" : "/something"
-      },
-      "response": {
-        "status": 200,
-        "body" : "something"
-      }
-    }
-  ]
-}

data/spec/fixtures/a_consumer-a_provider.json

@@ -1,22 +0,0 @@
-{
-  "consumer": {
-    "name": "A Consumer"
-  },
-  "provider": {
-    "name": "A Provider"
-  },
-  "interactions": [
-    {
-      "description" : "a request for something",
-      "providerState": null,
-      "request": {
-        "method": "get",
-        "path" : "/something"
-      },
-      "response": {
-        "status": 200,
-        "body" : "something"
-      }
-    }
-  ]
-}

data/spec/fixtures/approvals/clean_incremental_dry_run.approved.json

@@ -1,100 +0,0 @@
-{
-  "counts": {
-    "totalVersions": 9,
-    "versionsToDelete": 3,
-    "versionsNotToKeep": 6,
-    "versionsToKeep": 3,
-    "versionsToKeepBySelector": [
-      {
-        "selector": {
-          "tag": "prod"
-        },
-        "count": 2
-      },
-      {
-        "selector": {
-          "tag": "dev",
-          "latest": true
-        },
-        "count": 1
-      }
-    ]
-  },
-  "versionSummary": {
-    "Bar": {
-      "toDelete": {
-        "count": 0
-      },
-      "toKeep": {
-        "count": 0
-      }
-    },
-    "Foo": {
-      "toDelete": {
-        "count": 3,
-        "fromVersion": {
-          "number": "2",
-          "created": "1 day ago",
-          "tags": [
-
-          ]
-        },
-        "toVersion": {
-          "number": "6",
-          "created": "5 days ago",
-          "tags": [
-            "foo"
-          ]
-        }
-      },
-      "toKeep": {
-        "count": 4,
-        "latestVersion": {
-          "number": "1",
-          "created": "less than a minute ago",
-          "tags": [
-            "dev",
-            "prod"
-          ]
-        },
-        "firstVersion": {
-          "number": "7",
-          "created": "6 days ago",
-          "tags": [
-
-          ]
-        }
-      }
-    },
-    "Meep": {
-      "toDelete": {
-        "count": 0
-      },
-      "toKeep": {
-        "count": 2,
-        "latestVersion": {
-          "number": "2",
-          "created": "6 days ago",
-          "tags": [
-            "foop"
-          ]
-        },
-        "firstVersion": {
-          "number": "3",
-          "created": "6 days ago",
-          "tags": [
-            "blah"
-          ]
-        }
-      }
-    },
-    "Moop": {
-      "toDelete": {
-        "count": 0
-      },
-      "toKeep": {
-        "count": 0
-      }
-    }
-  }
-}

data/spec/fixtures/approvals/docs_webhooks_executing_a_saved_webhook_options.approved.json

@@ -1,20 +0,0 @@
-{
-  "category": "Webhooks",
-  "name": "Executing a saved webhook",
-  "order": 33,
-  "request": {
-    "method": "OPTIONS",
-    "path_template": "/webhooks/:uuid/execute",
-    "path": "/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac/execute",
-    "headers": {
-      "Accept": "application/hal+json"
-    }
-  },
-  "response": {
-    "status": 200,
-    "headers": {
-      "Access-Control-Allow-Methods": "POST, OPTIONS"
-    },
-    "body": ""
-  }
-}

data/spec/fixtures/approvals/docs_webhooks_executing_a_saved_webhook_post.approved.json

@@ -1,43 +0,0 @@
-{
-  "category": "Webhooks",
-  "name": "Executing a saved webhook",
-  "order": 35,
-  "request": {
-    "method": "POST",
-    "path_template": "/webhooks/:uuid/execute",
-    "path": "/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac/execute",
-    "headers": {
-      "Content-Type": "application/json",
-      "Accept": "application/hal+json"
-    }
-  },
-  "response": {
-    "status": 200,
-    "headers": {
-      "Content-Type": "application/hal+json;charset=utf-8"
-    },
-    "body": {
-      "request": {
-        "headers": {
-          "accept": "*/*",
-          "user-agent": "Pact Broker v2.87.0",
-          "content-type": "application/json"
-        },
-        "body": {
-          "pactUrl": "http://example.org/pacts/provider/Bar/consumer/Foo/pact-version/3e193ecb37ad04b43ce974a38352c704b2e0ed6b/metadata/Y3ZuPTImdz10cnVl"
-        },
-        "url": "/example"
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-        },
-        "body": ""
-      },
-      "logs": "[2021-09-01T10:07:21Z] DEBUG: Webhook context {\"base_url\":\"http://example.org\",\"event_name\":\"test\"}\n[2021-09-01T10:07:21Z] INFO: HTTP/1.1 POST https://example.org/example\n[2021-09-01T10:07:21Z] INFO: accept: */*\n[2021-09-01T10:07:21Z] INFO: user-agent: Pact Broker v2.87.0\n[2021-09-01T10:07:21Z] INFO: content-type: application/json\n[2021-09-01T10:07:21Z] INFO: {\"pactUrl\":\"http://example.org/pacts/provider/Bar/consumer/Foo/pact-version/3e193ecb37ad04b43ce974a38352c704b2e0ed6b/metadata/Y3ZuPTImdz10cnVl\"}\n[2021-09-01T10:07:21Z] INFO: HTTP/1.0 200 \n[2021-09-01T10:07:21Z] INFO: \n",
-      "success": true,
-      "_links": {
-      }
-    }
-  }
-}