pact_broker 2.66.0 → 2.67.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ded381f9c89732b48d2d27f1f9dc7c26708a54c407c6a777a0f698c221d03b5
-  data.tar.gz: 9ac73a1fde0c35b5cc5870e8006556bcc74a5c3765d86ba373b9a91040657b14
+  metadata.gz: 2874fe6ca6f552e6cba4d848f56998d0473d860ec4aa47530ccf883d9f189cfe
+  data.tar.gz: b8e28ffebc86a0f28251489edb9cd92407a4f2758e4fdc519f1d47d7c32cbf2d
 SHA512:
-  metadata.gz: 15667e1349e7ff6a2484016659d1eee0a26d95471ea6f0f959135f72b2fcf68714a550421a1ff239efa089514ef0064a07602cd84c22f60fedfc82b30a2337a0
-  data.tar.gz: e1c836e2cc3b82096ee5d03c9fe215e5010a7b0eef2aad43781a8713e5e8f8b987fbc86c19d5b5c95c819831a6d07f953a3b8b552d6104b3daddc5a1e62680d0
+  metadata.gz: f6bae75159d6ed6b50e0c96f71cd0931d52b94e6fb251d21e31153d67ce892dfaecdf64932f0bca27f06418fb61c67b9348129a5f662590c528d401a2a2df27d
+  data.tar.gz: 31b4370cd7d1e4c9b4b7825f013a58c327a1b3766f62ce59380bd878160dde2725cee60a2401625772b88378cb258ca8d5ebfa927131cdaf66ac1636352e4cda

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+<a name="v2.67.0"></a>
+### v2.67.0 (2020-10-16)
+
+#### Features
+
+* **wip pacts**
+  * if a pact was successfully verified because it was included as a WIP pact, keep it as WIP	 ([16cae55d](/../../commit/16cae55d))
+  * add 'wip' column to verification results	 ([34f98592](/../../commit/34f98592))
+
+#### Bug Fixes
+
+* typo when rendering created webhook for old webhooks path	 ([1e6a06a0](/../../commit/1e6a06a0))
+* include can-i-deploy badge in is_badge_path? logic	 ([31ea5f34](/../../commit/31ea5f34))
+
+* **pacts for verification**
+  * gracefully log empty request body	 ([0e48d13a](/../../commit/0e48d13a))
+
+* **can-i-deploy**
+  * gracefully handle pacticipant not found	 ([f6903b23](/../../commit/f6903b23))
+
 <a name="v2.66.0"></a>
 ### v2.66.0 (2020-10-01)
 

data/Gemfile

@@ -25,6 +25,7 @@ group :test do
   gem 'timecop', '~> 0.9'
   gem 'faraday', '~>0.15'
   gem 'docker-api', '~>1.34'
+  gem 'approvals', '~>0.0.1', '< 1'
 end
 
 if ENV['INSTALL_MYSQL'] == "true"

data/db/migrations/20201006_add_wip_to_verification.rb

@@ -0,0 +1,5 @@
+Sequel.migration do
+  change do
+    add_column(:verifications, :wip, TrueClass, default: false, null: false)
+  end
+end

data/lib/db.rb

@@ -27,7 +27,9 @@ module DB
   def self.connect db_credentials
     # Keep this conifiguration in sync with lib/pact_broker/app.rb#configure_database_connection
     Sequel.datetime_class = DateTime
-    # logger = Logger.new($stdout)
+    if ENV['DEBUG'] == 'true'
+      logger = Logger.new($stdout)
+    end
     con = Sequel.connect(db_credentials.merge(:logger => logger, :pool_class => Sequel::ThreadedConnectionPool, :encoding => 'utf8'))
     con.extension(:connection_validator)
     con.extension(:pagination)

data/lib/pact_broker/api/decorators/verifiable_pact_decorator.rb

@@ -20,14 +20,16 @@ module PactBroker
             getter: -> (context) { context[:decorator].notices(context[:options][:user_options]) }
 
           def notices(user_options)
-            pact_url = pact_version_url(represented, user_options[:base_url])
+            metadata = represented.wip ? { wip: true } : nil
+            pact_url = pact_version_url_with_metadata(represented, metadata, user_options[:base_url])
             PactBroker::Pacts::BuildVerifiablePactNotices.call(represented, pact_url, user_options)
           end
         end
 
         link :self do | user_options |
+          metadata = represented.wip ? { wip: true } : nil
           {
-            href: pact_version_url(represented, user_options[:base_url]),
+            href: pact_version_url_with_metadata(represented, metadata, user_options[:base_url]),
             name: represented.name
           }
         end

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -58,19 +58,23 @@ module PactBroker
         "#{pactigration_base_url(base_url, pact)}/pact-version/#{pact.pact_version_sha}"
       end
 
-      def pact_version_url_with_metadata pact, base_url = ''
-        "#{pactigration_base_url(base_url, pact)}/pact-version/#{pact.pact_version_sha}/metadata/#{build_webhook_metadata(pact)}"
+      def pact_version_url_with_metadata pact, metadata, base_url = ''
+        if metadata && metadata.any?
+          "#{pact_version_url(pact, base_url)}/metadata/#{encode_metadata(metadata)}"
+        else
+          pact_version_url(pact, base_url)
+        end
       end
 
-      def build_webhook_metadata(pact)
-        encode_webhook_metadata(build_metadata_for_webhook_triggered_by_pact_publication(pact))
+      def pact_version_url_with_webhook_metadata pact, base_url = ''
+        pact_version_url_with_metadata(pact, build_metadata_for_webhook_triggered_by_pact_publication(pact), base_url)
       end
 
-      def encode_webhook_metadata(metadata)
+      def encode_metadata(metadata)
         Base64.strict_encode64(Rack::Utils.build_nested_query(metadata))
       end
 
-      def decode_webhook_metadata(metadata)
+      def decode_pact_metadata(metadata)
         if metadata
           begin
             Rack::Utils.parse_nested_query(Base64.strict_decode64(metadata)).each_with_object({}) do | (k, v), new_hash |

data/lib/pact_broker/api/paths.rb

@@ -1,14 +1,15 @@
 module PactBroker
   module Api
     module Paths
-      PACT_BADGE_PATH = %r{^/pacts/provider/[^/]+/consumer/.*/badge(?:\.[A-Za-z]+)?$}.freeze
-      MATRIX_BADGE_PATH = %r{^/matrix/provider/[^/]+/latest/[^/]+/consumer/[^/]+/latest/[^/]+/badge(?:\.[A-Za-z]+)?$}.freeze
+      PACT_BADGE_PATH =         %r{^/pacts/provider/[^/]+/consumer/.*/badge(?:\.[A-Za-z]+)?$}.freeze
+      MATRIX_BADGE_PATH =       %r{^/matrix/provider/[^/]+/latest/[^/]+/consumer/[^/]+/latest/[^/]+/badge(?:\.[A-Za-z]+)?$}.freeze
+      CAN_I_DEPLOY_BADGE_PATH = %r{^/pacticipants/[^/]+/latest-version/[^/]+/can-i-deploy/to/[^/]+/badge(?:\.[A-Za-z]+)?$}.freeze
 
       extend self
 
       def is_badge_path?(path)
         # Optimise by checking include? first - regexp slow
-        path.include?('/badge') && (path =~ PACT_BADGE_PATH || path =~ MATRIX_BADGE_PATH)
+        path.include?('/badge') && (path =~ PACT_BADGE_PATH || path =~ MATRIX_BADGE_PATH || path =~ CAN_I_DEPLOY_BADGE_PATH)
       end
     end
   end

data/lib/pact_broker/api/resources/can_i_deploy.rb

@@ -1,11 +1,14 @@
 require 'pact_broker/api/resources/matrix'
 require 'pact_broker/matrix/can_i_deploy_query_schema'
 require 'pact_broker/matrix/parse_can_i_deploy_query'
+require 'pact_broker/messages'
 
 module PactBroker
   module Api
     module Resources
       class CanIDeploy < Matrix
+        include PactBroker::Messages
+
         def initialize
           super
           @query_params = JSON.parse(Rack::Utils.parse_nested_query(request.uri.query).to_json, symbolize_names: true)
@@ -16,6 +19,9 @@ module PactBroker
           if (errors = query_schema.call(query_params)).any?
             set_json_validation_error_messages(errors)
             true
+          elsif !pacticipant
+            set_json_validation_error_messages(pacticipant: [message('errors.validation.pacticipant_not_found', name: pacticipant_name)])
+            true
           else
             false
           end
@@ -32,6 +38,14 @@ module PactBroker
         def query_schema
           PactBroker::Api::Contracts::CanIDeployQuerySchema
         end
+
+        def pacticipant
+          @pacticipant ||= pacticipant_service.find_pacticipant_by_name(pacticipant_name)
+        end
+
+        def pacticipant_name
+          selectors.first.pacticipant_name
+        end
       end
     end
   end

data/lib/pact_broker/api/resources/group.rb

@@ -5,7 +5,6 @@ module PactBroker
   module Api
     module Resources
       class Group < BaseResource
-
         def content_types_provided
           [["text/csv", :to_csv]]
         end

data/lib/pact_broker/api/resources/latest_pact.rb

@@ -50,7 +50,7 @@ module PactBroker
         end
 
         def metadata
-          @metadata ||= encode_webhook_metadata(PactBroker::Pacts::Metadata.build_metadata_for_latest_pact(pact, identifier_from_path))
+          @metadata ||= encode_metadata(PactBroker::Pacts::Metadata.build_metadata_for_latest_pact(pact, identifier_from_path))
         end
       end
     end

data/lib/pact_broker/api/resources/pact.rb

@@ -92,6 +92,14 @@ module PactBroker
           :'pacts::pact'
         end
 
+        def policy_pacticipant
+          if resource_exists?
+            consumer
+          else
+            nil
+          end
+        end
+
         private
 
         def pact

data/lib/pact_broker/api/resources/pact_versions.rb

@@ -34,6 +34,10 @@ module PactBroker
         def policy_name
           :'pacts::pacts'
         end
+
+        def policy_pacticipant
+          consumer
+        end
       end
     end
   end

data/lib/pact_broker/api/resources/pact_webhooks.rb

@@ -52,7 +52,7 @@ module PactBroker
 
         def from_json
           saved_webhook = webhook_service.create next_uuid, webhook, consumer, provider
-          response.body = Decorators::WebhookDecorator.new(saved_webhook).to_json(decoractor_options)
+          response.body = Decorators::WebhookDecorator.new(saved_webhook).to_json(decorator_options)
         end
 
         def to_json

data/lib/pact_broker/api/resources/provider_pacts_for_verification.rb

@@ -85,8 +85,7 @@ module PactBroker
         end
 
         def log_request
-          parameters = request.get? ? nested_query : params
-          logger.info "Fetching pacts for verification by #{provider_name}", provider_name: provider_name, params: parameters
+          logger.info "Fetching pacts for verification by #{provider_name}", provider_name: provider_name, params: query
         end
 
         def nested_query

data/lib/pact_broker/api/resources/tag.rb

@@ -48,6 +48,5 @@ module PactBroker
         end
       end
     end
-
   end
 end

data/lib/pact_broker/api/resources/tagged_pact_versions.rb

@@ -34,6 +34,10 @@ module PactBroker
         def policy_name
           :'pacts::pacts'
         end
+
+        def policy_pacticipant
+          consumer
+        end
       end
     end
   end

data/lib/pact_broker/api/resources/verification.rb

@@ -49,6 +49,10 @@ module PactBroker
           :'verifications::verification'
         end
 
+        def policy_pacticipant
+          provider
+        end
+
         private
 
         def verification

data/lib/pact_broker/api/resources/verifications.rb

@@ -48,7 +48,7 @@ module PactBroker
         end
 
         def from_json
-          verification = verification_service.create(next_verification_number, params(symbolize_names: false), pact, webhook_options)
+          verification = verification_service.create(next_verification_number, verification_params, pact, webhook_options)
           response.body = decorator_for(verification).to_json(decorator_options)
           true
         end
@@ -57,6 +57,10 @@ module PactBroker
           :'verifications::verifications'
         end
 
+        def policy_pacticipant
+          provider
+        end
+
         private
 
         def pact
@@ -72,7 +76,11 @@ module PactBroker
         end
 
         def metadata
-          PactBrokerUrls.decode_webhook_metadata(identifier_from_path[:metadata])
+          PactBrokerUrls.decode_pact_metadata(identifier_from_path[:metadata])
+        end
+
+        def wip?
+          metadata[:wip] == 'true'
         end
 
         def webhook_options
@@ -82,6 +90,10 @@ module PactBroker
                                       .with_webhook_context(metadata)
           }
         end
+
+        def verification_params
+          params(symbolize_names: false).merge('wip' => wip?)
+        end
       end
     end
   end

data/lib/pact_broker/groups/service.rb

@@ -2,12 +2,9 @@ require 'pact_broker/repositories'
 require 'pact_broker/relationships/groupify'
 
 module PactBroker
-
   module Groups
     module Service
-
       extend self
-
       extend PactBroker::Repositories
       extend PactBroker::Services
 

data/lib/pact_broker/locale/en.yml

@@ -45,6 +45,7 @@ en:
         pacticipant_name_mismatch: "in pact ('%{name_in_pact}') does not match %{pacticipant} name in path ('%{name}')."
         connection_encoding_not_utf8: "The Sequel connection encoding (%{encoding}) is strongly recommended to be \"utf8\". If you need to set it to %{encoding} for some particular reason, then disable this check by setting config.validate_database_connection_config = false"
         invalid_webhook_uuid: The UUID can only contain the characters A-Z, a-z, 0-9, _ and -, and must be 16 or more characters.
+        pacticipant_not_found: No pacticipant with name '%{name}' found
       duplicate_pacticipant: |
         This is the first time a pact has been published for "%{new_name}".
         The name "%{new_name}" is very similar to the following existing consumers/providers:

data/lib/pact_broker/matrix/aggregated_row.rb

@@ -1,3 +1,4 @@
+require 'forwardable'
 require 'pact_broker/verifications/repository'
 
 # A collection of matrix rows with the same pact publication id

data/lib/pact_broker/matrix/query_results_with_deployment_status_summary.rb

@@ -1,3 +1,4 @@
+require 'forwardable'
 require 'pact_broker/matrix/query_results'
 
 module PactBroker

data/lib/pact_broker/pacts/all_pact_publications.rb

@@ -1,3 +1,4 @@
+require 'forwardable'
 require 'pact_broker/domain/tag'
 require 'pact_broker/domain/pacticipant'
 require 'pact_broker/domain/version'

data/lib/pact_broker/pacts/pact_publication.rb

@@ -1,3 +1,4 @@
+require 'forwardable'
 require 'pact_broker/domain/pact'
 require 'pact_broker/pacts/pact_version'
 require 'pact_broker/repositories/helpers'

data/lib/pact_broker/pacts/repository.rb

@@ -559,6 +559,7 @@ module PactBroker
           verifications_join = {
             pact_version_id: :pact_version_id,
             Sequel[:verifications][:success] => true,
+            Sequel[:verifications][:wip] => false,
             Sequel[:verifications][:provider_id] => provider_id
           }
           tags_join = {

data/lib/pact_broker/pacts/verifiable_pact_messages.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 module PactBroker
   module Pacts
     class VerifiablePactMessages

data/lib/pact_broker/test/test_data_builder.rb

@@ -316,7 +316,7 @@ module PactBroker
         parameters.delete(:comment)
         tag_names = [parameters.delete(:tag_names), parameters.delete(:tag_name)].flatten.compact
         provider_version_number = parameters[:provider_version] || '4.5.6'
-        default_parameters = {success: true, number: 1, test_results: {some: 'results'}}
+        default_parameters = { success: true, number: 1, test_results: {some: 'results'}, wip: false }
         default_parameters[:execution_date] = @now if @now
         parameters = default_parameters.merge(parameters)
         parameters.delete(:provider_version)

data/lib/pact_broker/verifications/service.rb

@@ -21,10 +21,11 @@ module PactBroker
       end
 
       def create next_verification_number, params, pact, webhook_options
-        logger.info "Creating verification #{next_verification_number} for pact_id=#{pact.id} from params #{params.reject{ |k,_| k == "testResults"}}"
+        logger.info "Creating verification #{next_verification_number} for pact_id=#{pact.id}", payload: params.reject{ |k,_| k == "testResults"}
         verification = PactBroker::Domain::Verification.new
         provider_version_number = params.fetch('providerApplicationVersion')
         PactBroker::Api::Decorators::VerificationDecorator.new(verification).from_hash(params)
+        verification.wip = params.fetch('wip')
         verification.number = next_verification_number
         verification = verification_repository.create(verification, provider_version_number, pact)
 

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.66.0'
+  VERSION = '2.67.0'
 end

data/lib/pact_broker/webhooks/pact_and_verification_parameters.rb

@@ -38,7 +38,7 @@ module PactBroker
 
       def to_hash
         @hash ||= {
-          PACT_URL => pact ? PactBroker::Api::PactBrokerUrls.pact_version_url_with_metadata(pact, base_url) : "",
+          PACT_URL => pact ? PactBroker::Api::PactBrokerUrls.pact_version_url_with_webhook_metadata(pact, base_url) : "",
           VERIFICATION_RESULT_URL => verification_url,
           CONSUMER_VERSION_NUMBER => consumer_version_number,
           PROVIDER_VERSION_NUMBER => verification ? verification.provider_version_number : "",

data/spec/features/create_webhook_spec.rb

@@ -123,4 +123,22 @@ describe "Creating a webhook" do
       expect(PactBroker::Webhooks::Webhook.first.provider).to_not be nil
     end
   end
+
+  context "with the old path" do
+    let(:path) { "/pacts/provider/Some%20Provider/consumer/Some%20Consumer/webhooks" }
+
+    its(:status) { is_expected.to be 201 }
+
+    it "returns the Location header" do
+      expect(subject.headers['Location']).to match(%r{http://example.org/webhooks/.+})
+    end
+
+    it "returns a JSON Content Type" do
+      expect(subject.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
+    end
+
+    it "returns the newly created webhook" do
+      expect(response_body).to include webhook_hash
+    end
+  end
 end

data/spec/features/wip_pacts_spec.rb

@@ -1,26 +1,9 @@
 RSpec.describe "the lifecycle of a WIP pact" do
-  before do
-    td.set_now(DateTime.now - 100)
-      .create_provider("Bar")
-      .create_provider_version("1")
-      .create_provider_version_tag("master")
-  end
   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(:failed_verification_results) do
-    {
-      providerApplicationVersion: provider_version_number,
-      success: false
-    }.to_json
-  end
-  let(:successful_verification_results) do
-    {
-      providerApplicationVersion: provider_version_number,
-      success: true
-    }.to_json
-  end
   let(:pacts_for_verification_request_body) do
     {
       consumerVersionSelectors: [ { tag: "master", latest: true } ],
@@ -28,20 +11,48 @@ RSpec.describe "the lifecycle of a WIP pact" do
       includeWipPactsSince: start_date
     }.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
-    put("/pacts/provider/Bar/consumer/Foo/version/2", pact_content_2, request_headers)
-    put("/pacticipants/Foo/versions/2/tags/feat-x", nil, request_headers)
+  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/2/tags/master", nil, request_headers)
   end
 
-  def get_pacts_for_verification
-    post("/pacts/provider/Bar/for-verification", pacts_for_verification_request_body, request_headers)
+  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)
@@ -49,16 +60,21 @@ RSpec.describe "the lifecycle of a WIP pact" do
   end
 
   def get_pact(pact_url)
-    get pact_url, nil, request_headers
+    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, results)
-    post(verification_results_url, results, request_headers)
-    put("/pacticipants/Bar/versions/#{provider_version_number}/tags/master", nil, request_headers)
+  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)
@@ -71,10 +87,20 @@ RSpec.describe "the lifecycle of a WIP pact" do
     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
+    }.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
+          create_initial_provider_version_on_master
+
           publish_pact_with_master_tag
           publish_pact_with_feature_tag
 
@@ -85,6 +111,8 @@ RSpec.describe "the lifecycle of a WIP pact" do
 
       describe "when it is verified unsuccessfully" do
         it "is still included as a WIP pact" do
+          create_initial_provider_version_on_master
+
           # CONSUMER BUILD
           # publish pact
           publish_pact_with_master_tag
@@ -100,7 +128,7 @@ RSpec.describe "the lifecycle of a WIP pact" do
 
           # publish failure verification results
           verification_results_url = verification_results_url_from(pact_response)
-          publish_verification_results_with_tag_master(verification_results_url, failed_verification_results)
+          publish_verification_results_with_tag_master(verification_results_url, false)
 
           # ANOTHER PROVIDER BUILD
           # get pacts for verification
@@ -110,8 +138,10 @@ RSpec.describe "the lifecycle of a WIP pact" do
         end
       end
 
-      describe "when it is verified successfully" do
-        it "is no longer included in the list of pacts to verify" do
+      describe "when it is verified successfully while included as a WIP pact" do
+        it "is still included as a WIP pact" do
+          create_initial_provider_version_on_master
+
           # CONSUMER BUILD
           publish_pact_with_master_tag
           publish_pact_with_feature_tag
@@ -124,18 +154,213 @@ RSpec.describe "the lifecycle of a WIP pact" do
 
           # verify pact... success!
 
-          # publish failure verification results
+          # publish success verification results
           verification_results_url = verification_results_url_from(pact_response)
-          publish_verification_results_with_tag_master(verification_results_url, successful_verification_results)
+          publish_verification_results_with_tag_master(verification_results_url, true)
 
           # ANOTHER PROVIDER BUILD 2
           # get pacts for verification
           # publish successful verification results
           pacts_for_verification_response = get_pacts_for_verification
-          # not wip any more
+          # still wip
+          expect(wip_pacts_from(pacts_for_verification_response).size).to eq 1
+        end
+      end
+
+      describe "when it is verified successfully when included explicitly" do
+        it "is no longer included as a WIP pact" do
+          create_initial_provider_version_on_master
+
+          # 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
+          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
+          create_initial_provider_version_on_master
+
+          # 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 nil
+
+          # 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 matching feature branches" do
+        it "stays wip on master even after it has been successfully verified on the provider's feature branch" do
+          create_initial_provider_version_on_master
+
+          # CONSUMER BUILD - master
+          publish_pact_with_master_tag
+
+          # 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"))
+          # 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 previously created WIP pacts because every single pact is pending for this new branch, and we don't want to verify the world" do
+          create_initial_provider_version_on_master
+
+          # 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 0
+
+          # verify master 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
+          create_initial_provider_version_on_master
+
+          # 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 0
+          # 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 - brand 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