pact_broker 2.77.0 → 2.80.0

data/spec/features/get_pact_version.rb

@@ -21,7 +21,7 @@ RSpec.describe "retrieving a pact" do
     let(:path) { PactBroker::Api::PactBrokerUrls.pact_version_url(pact) }
 
     it "returns the latest" do
-      expect(JSON.parse(subject.body)['_links']['pb:consumer-version']['name']).to eq "2"
+      expect(JSON.parse(subject.body)["_links"]["pb:consumer-version"]["name"]).to eq "2"
     end
 
     context "when there is metadata specifying the consumer version number" do
@@ -29,7 +29,7 @@ RSpec.describe "retrieving a pact" do
       let(:path) { PactBroker::Api::PactBrokerUrls.pact_version_url_with_webhook_metadata(pact) }
 
       it "returns the pact with the matching consumer version number" do
-        expect(JSON.parse(subject.body)['_links']['pb:consumer-version']['name']).to eq "1"
+        expect(JSON.parse(subject.body)["_links"]["pb:consumer-version"]["name"]).to eq "1"
       end
     end
   end

data/spec/features/get_pact_versions_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/support/test_data_builder'
+require "spec/support/test_data_builder"
 
 describe "Get pact versions" do
   let(:path) { "/pacts/provider/Provider/consumer/Consumer/versions" }

data/spec/features/get_previous_distinct_version.rb

@@ -1,4 +1,4 @@
-require 'spec/support/test_data_builder'
+require "spec/support/test_data_builder"
 
 describe "Get previous distinct version of pact" do
 
@@ -7,10 +7,10 @@ describe "Get previous distinct version of pact" do
 
   subject { get path; last_response }
 
-  let(:pact_content_version_1) { load_fixture('consumer-provider.json') }
+  let(:pact_content_version_1) { load_fixture("consumer-provider.json") }
   let(:pact_content_version_2) do
-    hash = load_json_fixture('consumer-provider.json')
-    hash['interactions'].first['request']['method'] = 'post'
+    hash = load_json_fixture("consumer-provider.json")
+    hash["interactions"].first["request"]["method"] = "post"
     hash.to_json
   end
   let(:pact_content_version_3) { pact_content_version_2 }
@@ -34,7 +34,7 @@ describe "Get previous distinct version of pact" do
     end
 
     it "returns the JSON representation of the version" do
-      expect(last_response_body[:_links][:self][:href]).to end_with '/1'
+      expect(last_response_body[:_links][:self][:href]).to end_with "/1"
     end
 
   end

data/spec/features/get_provider_pacts_for_verification_spec.rb

@@ -15,11 +15,11 @@ describe "Get provider pacts for verification" do
         .create_provider("Provider")
         .create_consumer("Consumer")
         .create_consumer_version("0.0.1")
-        .create_pact
+        .create_pact(json_content: { some: "content" }.to_json)
         .create_consumer("Consumer 2")
         .create_consumer_version("4.5.6")
         .create_consumer_version_tag("prod")
-        .create_pact
+        .create_pact(json_content: { some: "other content" }.to_json)
     end
 
     let(:path) { "/pacts/provider/Provider/for-verification" }
@@ -49,19 +49,30 @@ describe "Get provider pacts for verification" do
     context "when using POST" do
       let(:request_body) do
         {
-          consumerVersionSelectors: [ { tag: "prod", latest: true }]
+          consumerVersionSelectors: [ { tag: "prod", latest: true }],
+          includePendingStatus: false,
+          providerVersionTags: ["main"]
         }
       end
 
       let(:request_headers) do
         {
-          'CONTENT_TYPE' => 'application/json',
-          'HTTP_ACCEPT' => 'application/hal+json'
+          "CONTENT_TYPE" => "application/json",
+          "HTTP_ACCEPT" => "application/hal+json"
+        }
+      end
+
+      let(:fixture) do
+        {
+          request: { path: path, headers: rack_env_to_http_headers(request_headers), body: request_body },
+          response: { status: subject.status, headers: determinate_headers(subject.headers), body: JSON.parse(subject.body)}
         }
       end
 
       subject { post(path, request_body.to_json, request_headers) }
 
+      it { Approvals.verify(fixture, :name => "get_provider_pacts_for_verification", format: :json) }
+
       it "returns a list of links to the pacts" do
         expect(pacts.size).to eq 1
       end

data/spec/features/get_released_versions_for_version_and_environment.rb

@@ -0,0 +1,27 @@
+RSpec.describe "Get released versions for version and environment" do
+  let!(:version) { td.create_consumer("Foo").create_consumer_version("1").and_return(:consumer_version) }
+  let!(:test_environment) { td.create_environment("test").and_return(:environment) }
+  let!(:prod_environment) { td.create_environment("prod").and_return(:environment) }
+  let!(:deployed_version) do
+    td.create_released_version_for_consumer_version(environment_name: "test", created_at: DateTime.now - 2)
+      .create_deployed_version_for_consumer_version(environment_name: "prod", created_at: DateTime.now - 1)
+  end
+
+  let(:path) do
+    PactBroker::Api::PactBrokerUrls.released_versions_for_version_and_environment_url(
+      version,
+      test_environment
+    )
+  end
+
+  let(:response_body_hash) { JSON.parse(subject.body, symbolize_names: true) }
+
+  subject { get(path, nil, { "HTTP_ACCEPT" => "application/hal+json" }) }
+
+  it "returns a list of released versions" do
+    expect(response_body_hash[:_embedded][:releasedVersions]).to be_a(Array)
+    expect(response_body_hash[:_embedded][:releasedVersions].size).to eq 1
+    expect(response_body_hash[:_links][:self][:title]).to eq "Released versions for Foo version 1 in Test"
+    expect(response_body_hash[:_links][:self][:href]).to end_with(path)
+  end
+end

data/spec/features/get_tagged_pact_versions_spec.rb

@@ -21,6 +21,6 @@ describe "retrieving tagged pact versions" do
   end
 
   it "returns the list of tagged pact versions" do
-    expect(json_response_body['_links']['pb:pact-versions']).to be_a Array
+    expect(json_response_body["_links"]["pb:pact-versions"]).to be_a Array
   end
 end

data/spec/features/get_triggered_webhooks_for_pact_spec.rb

@@ -15,6 +15,6 @@ RSpec.describe "Get triggered webhooks for pact" do
   it { is_expected.to be_a_hal_json_success_response }
 
   it "contains a list of triggered webhooks" do
-    expect(json_response_body['_embedded']['triggeredWebhooks'].size).to be 1
+    expect(json_response_body["_embedded"]["triggeredWebhooks"].size).to be 1
   end
 end

data/spec/features/get_triggered_webhooks_for_verification_spec.rb

@@ -16,6 +16,6 @@ RSpec.describe "Get triggered webhooks for verification" do
   it { is_expected.to be_a_hal_json_success_response }
 
   it "contains a list of triggered webhooks" do
-    expect(json_response_body['_embedded']['triggeredWebhooks'].size).to be 1
+    expect(json_response_body["_embedded"]["triggeredWebhooks"].size).to be 1
   end
 end

data/spec/features/get_verifications_for_consumer_version_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/support/test_data_builder'
+require "spec/support/test_data_builder"
 
 describe "Get verifications for consumer version" do
 

data/spec/features/get_version_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/support/test_data_builder'
+require "spec/support/test_data_builder"
 
 describe "Get version" do
 
@@ -23,7 +23,7 @@ describe "Get version" do
     end
 
     it "returns the JSON representation of the version" do
-      expect(last_response_body).to include number: '1.2.3'
+      expect(last_response_body).to include number: "1.2.3"
     end
 
   end

data/spec/features/get_versions_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/support/test_data_builder'
+require "spec/support/test_data_builder"
 
 describe "Get versions" do
   let(:path) { "/pacticipants/Consumer/versions" }
@@ -23,7 +23,7 @@ describe "Get versions" do
     end
 
     context "with pagination options" do
-      subject { get(path, { 'pageSize' => '1', 'pageNumber' => '1' }) }
+      subject { get(path, { "pageSize" => "1", "pageNumber" => "1" }) }
 
       it "paginates the response" do
         expect(last_response_body[:_links][:"versions"].size).to eq 1

data/spec/features/label_pacticipant_spec.rb

@@ -2,9 +2,9 @@ describe "Labelling a pacticipant" do
 
   let(:path) { "/pacticipants/foo/labels/ios" }
   let(:response_body_hash) { JSON.parse(subject.body, symbolize_names: true) }
-  let(:expected_response_body) { {name: 'ios'} }
+  let(:expected_response_body) { {name: "ios"} }
 
-  subject { put path, nil, {'CONTENT_TYPE' => 'application/json'}; last_response  }
+  subject { put path, nil, {"CONTENT_TYPE" => "application/json"}; last_response  }
 
   context "when the pacticipant exists" do
     it "returns a 201 Created" do
@@ -12,7 +12,7 @@ describe "Labelling a pacticipant" do
     end
 
     it "returns a json body" do
-      expect(subject.headers['Content-Type']).to eq "application/hal+json;charset=utf-8"
+      expect(subject.headers["Content-Type"]).to eq "application/hal+json;charset=utf-8"
     end
 
     it "returns the label in the body" do

data/spec/features/merge_pact_spec.rb

@@ -1,13 +1,13 @@
-require 'spec/support/test_data_builder'
+require "spec/support/test_data_builder"
 
 describe "Merging a pact" do
 
-  let(:pact_content) { load_fixture('a_consumer-a_provider.json') }
+  let(:pact_content) { load_fixture("a_consumer-a_provider.json") }
   let(:path) { "/pacts/provider/A%20Provider/consumer/A%20Consumer/version/1.2.3" }
   let(:response_body_json) { JSON.parse(subject.body) }
 
   subject do
-    patch path, pact_content, {'CONTENT_TYPE' => 'application/json' }; last_response
+    patch path, pact_content, {"CONTENT_TYPE" => "application/json" }; last_response
   end
 
   context "when a pact for this consumer version does not exist" do
@@ -16,7 +16,7 @@ describe "Merging a pact" do
     end
 
     it "returns a json body" do
-      expect(subject.headers['Content-Type']).to eq "application/hal+json;charset=utf-8"
+      expect(subject.headers["Content-Type"]).to eq "application/hal+json;charset=utf-8"
     end
 
     it "returns the pact in the body" do
@@ -25,8 +25,8 @@ describe "Merging a pact" do
   end
 
   context "when a pact for this consumer version does exist" do
-    let(:existing_pact_content) { load_fixture('a_consumer-a_provider-3.json') }
-    let(:merged_pact_content) { load_fixture('a_consumer-a_provider-merged.json') }
+    let(:existing_pact_content) { load_fixture("a_consumer-a_provider-3.json") }
+    let(:merged_pact_content) { load_fixture("a_consumer-a_provider-merged.json") }
 
     before do
       TestDataBuilder.new.create_pact_with_hierarchy("A Consumer", "1.2.3", "A Provider", existing_pact_content)
@@ -37,7 +37,7 @@ describe "Merging a pact" do
     end
 
     it "returns an application/json Content-Type" do
-      expect(subject.headers['Content-Type']).to eq "application/hal+json;charset=utf-8"
+      expect(subject.headers["Content-Type"]).to eq "application/hal+json;charset=utf-8"
     end
 
     it "returns the merged pact in the response body" do
@@ -45,7 +45,7 @@ describe "Merging a pact" do
     end
 
     context "with a conflicting request" do
-      let(:existing_pact_content) { load_fixture('a_consumer-a_provider-conflict.json') }
+      let(:existing_pact_content) { load_fixture("a_consumer-a_provider-conflict.json") }
 
       it "returns a 409 Conflict" do
         expect(subject.status).to be 409

data/spec/features/pending_pacts_with_tags_spec.rb

@@ -0,0 +1,138 @@
+RSpec.describe "the pending lifecycle of a pact (with tags)" do
+  let(:pact_content_1) { { some: "interactions" }.to_json }
+  let(:pact_content_2) { { some: "other interactions" }.to_json }
+  let(:request_headers) { { "CONTENT_TYPE" => "application/json", "HTTP_ACCEPT" => "application/hal+json"} }
+  let(:failed_verification_results) do
+    {
+      providerApplicationVersion: "2",
+      success: false
+    }.to_json
+  end
+  let(:successful_verification_results) do
+    {
+      providerApplicationVersion: "2",
+      success: true
+    }.to_json
+  end
+
+  def publish_pact
+    put("/pacts/provider/Bar/consumer/Foo/version/1", pact_content_1, request_headers)
+  end
+
+  def get_pacts_for_verification(provider_version_tag = "main")
+    post("/pacts/provider/Bar/for-verification", { includePendingStatus: true, providerVersionTags: [*provider_version_tag] }.to_json, request_headers)
+  end
+
+  def pact_url_from(pacts_for_verification_response)
+    JSON.parse(pacts_for_verification_response.body)["_embedded"]["pacts"][0]["_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(verification_results_url, results)
+    put("/pacticipants/Bar/versions/#{JSON.parse(results)["providerApplicationVersion"]}/tags/main", nil, { "CONTENT_TYPE" => "application/json" })
+    post(verification_results_url, results, request_headers)
+  end
+
+  def pending_status_from(pacts_for_verification_response)
+    JSON.parse(pacts_for_verification_response.body)["_embedded"]["pacts"][0]["verificationProperties"]["pending"]
+  end
+
+
+  context "a pact" do
+    describe "when it is first published" do
+      it "is pending" do
+        publish_pact
+        pacts_for_verification_response = get_pacts_for_verification
+        expect(pending_status_from(pacts_for_verification_response)).to be true
+      end
+    end
+
+    describe "when it is verified unsuccessfully" do
+      it "is still pending" do
+        # CONSUMER BUILD
+        # publish pact
+        publish_pact
+
+        # PROVIDER BUILD
+        # fetch pacts to verify
+        pacts_for_verification_response = get_pacts_for_verification
+        pact_url = 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(verification_results_url, failed_verification_results)
+
+        # ANOTHER PROVIDER BUILD
+        # get pacts for verification
+        pacts_for_verification_response = get_pacts_for_verification
+        # still pending
+        expect(pending_status_from(pacts_for_verification_response)).to be true
+      end
+    end
+
+    describe "when it is verified successfully" do
+      it "is no longer pending" do
+        # CONSUMER BUILD
+        publish_pact
+
+        # PROVIDER BUILD
+        pacts_for_verification_response = get_pacts_for_verification
+
+        # fetch pact
+        pact_url = pact_url_from(pacts_for_verification_response)
+        pact_response = get_pact(pact_url)
+
+        # verify pact... success!
+
+        # publish failure verification results
+        verification_results_url = verification_results_url_from(pact_response)
+        publish_verification_results(verification_results_url, successful_verification_results)
+
+        # ANOTHER PROVIDER BUILD 2
+        # get pacts for verification
+        # publish successful verification results
+        pacts_for_verification_response = get_pacts_for_verification
+        # not pending any more
+        expect(pending_status_from(pacts_for_verification_response)).to be false
+      end
+    end
+
+
+    describe "when it is verified successfully by one branch, and then another branch of the provider is created" do
+      it "is not pending for the new branch" do
+        # CONSUMER BUILD
+        publish_pact
+
+        # PROVIDER BUILD
+        pacts_for_verification_response = get_pacts_for_verification
+
+        # fetch pact
+        pact_url = pact_url_from(pacts_for_verification_response)
+        pact_response = get_pact(pact_url)
+
+        # verify pact... success!
+
+        # publish failure verification results
+        verification_results_url = verification_results_url_from(pact_response)
+        publish_verification_results(verification_results_url, successful_verification_results)
+
+        # ANOTHER PROVIDER BUILD 2 from another branch
+        # get pacts for verification
+        # publish successful verification results
+        pacts_for_verification_response = get_pacts_for_verification("feat/foo")
+        # not pending
+        expect(pending_status_from(pacts_for_verification_response)).to be false
+      end
+    end
+  end
+end

data/spec/features/publish_not_a_pact_spec.rb

@@ -3,27 +3,27 @@ describe "Publishing a contract that is not a pact" do
   let(:path) { "/pacts/provider/A%20Provider/consumer/A%20Consumer/versions/1.2.3" }
   let(:parsed_response_body) { JSON.parse(subject.body) }
 
-  subject { put path, pact_content, {'CONTENT_TYPE' => 'application/json' }; last_response  }
+  subject { put path, pact_content, {"CONTENT_TYPE" => "application/json" }; last_response  }
 
   context "when the pact is another type of CDC that doesn't have the Consumer or Provider names in the expected places" do
-    let(:pact_content) { {a: 'not pact'}.to_json }
+    let(:pact_content) { {a: "not pact"}.to_json }
 
     it "accepts the un-pact Pact" do
       expect(subject.status).to be 201
     end
 
     it "returns the content" do
-      expect(parsed_response_body).to include 'a' => 'not pact'
+      expect(parsed_response_body).to include "a" => "not pact"
     end
 
     it "returns _links" do
-      expect(parsed_response_body).to have_key '_links'
+      expect(parsed_response_body).to have_key "_links"
     end
   end
 
   context "when the content is an array" do
 
-    let(:pact_content) { '[1]' }
+    let(:pact_content) { "[1]" }
 
     it "accepts the un-pact Pact" do
       expect(subject.status).to be 201

data/spec/features/publish_pact_all_in_one_approval_spec.rb

@@ -0,0 +1,72 @@
+RSpec.describe "publishing a pact using the all in one endpoint" do
+  # TODO merge branches
+  let(:request_body_hash) do
+    {
+      :pacticipantName => "Foo",
+      :pacticipantVersionNumber => "1",
+      :branch => branch,
+      :tags => ["a", "b"],
+      :buildUrl => "http://ci/builds/1234",
+      :contracts => [
+        {
+          :consumerName => "Foo",
+          :providerName => "Bar",
+          :specification => "pact",
+          :contentType => "application/json",
+          :content => encoded_contract,
+          :onConflict => "overwrite",
+        }
+      ]
+    }
+  end
+  let(:rack_headers) { { "CONTENT_TYPE" => "application/json", "HTTP_ACCEPT" => "application/hal+json" } }
+  let(:contract) { { consumer: { name: "Foo" }, provider: { name: "Bar" }, interactions: [] }.to_json }
+  let(:branch) { "main" }
+  let(:encoded_contract) { Base64.strict_encode64(contract) }
+  let(:path) { "/contracts/publish" }
+  let(:fixture) do
+    {
+      request: { path: path, headers: rack_env_to_http_headers(rack_headers), body: request_body_hash },
+      response: { status: subject.status, headers: determinate_headers(subject.headers), body: JSON.parse(subject.body)}
+    }
+  end
+
+  subject { post(path, request_body_hash.to_json, rack_headers) }
+
+  it { is_expected.to be_a_hal_json_success_response }
+
+  context "with no webhooks" do
+    it { Approvals.verify(fixture, :name => "publish_contract_nothing_exists", format: :json) }
+  end
+
+  context "with a webhooks that gets triggered" do
+    before do
+      allow(PactBroker::Webhooks::TriggerService).to receive(:next_uuid).and_return("1234")
+      td.create_global_webhook(description: "foo webhook")
+    end
+
+    it { Approvals.verify(fixture, :name => "publish_contract_nothing_exists_with_webhook", format: :json) }
+  end
+
+  context "with a validation error" do
+    before do
+      request_body_hash.delete(:pacticipantVersionNumber)
+    end
+
+    it { Approvals.verify(fixture, :name => "publish_contract_with_validation_error", format: :json) }
+  end
+
+  context "when a verification already exists for the consumer/provider" do
+    before do
+      td.create_pact_with_verification("Foo", "1", "Bar", "2")
+    end
+
+    it { Approvals.verify(fixture, :name => "publish_contract_verification_already_exists", format: :json) }
+  end
+
+  context "with no branch set" do
+    let(:branch) { nil }
+
+    it { Approvals.verify(fixture, :name => "publish_contract_no_branch", format: :json) }
+  end
+end