pact_broker 2.88.0 → 2.89.0

data/lib/pact_broker/pacts/sort_content.rb

@@ -6,6 +6,7 @@ module PactBroker
     class SortContent
       extend OrderHashKeys
 
+      # TODO handle interactions and messages at the same time
       def self.call pact_hash
         key = verifiable_content_key_for(pact_hash)
 

data/lib/pact_broker/verifications/required_verification.rb

@@ -1,7 +1,7 @@
 module PactBroker
   module Verifications
     class RequiredVerification
-      attr_reader :provider_version, :provider_version_descriptions
+      attr_reader :provider_version, :provider_version_selectors, :provider_version_descriptions
 
       def initialize(attributes = {})
         attributes.each do | (name, value) |
@@ -10,7 +10,9 @@ module PactBroker
       end
 
       def == other
-        provider_version == other.provider_version && provider_version_descriptions == other.provider_version_descriptions
+        provider_version == other.provider_version &&
+          provider_version_selectors == other.provider_version_selectors &&
+          provider_version_descriptions == other.provider_version_descriptions
       end
 
       def + other
@@ -20,6 +22,7 @@ module PactBroker
 
         RequiredVerification.new(
           provider_version: provider_version,
+          provider_version_selectors: provider_version_selectors + other.provider_version_selectors,
           provider_version_descriptions: (provider_version_descriptions + other.provider_version_descriptions).uniq
         )
       end

data/lib/pact_broker/verifications/service.rb

@@ -6,6 +6,8 @@ require "pact_broker/logging"
 require "pact_broker/hash_refinements"
 require "pact_broker/events/publisher"
 require "pact_broker/verifications/required_verification"
+require "pact_broker/versions/selector"
+require "pact_broker/versions/selectors"
 
 module PactBroker
   module Verifications
@@ -101,7 +103,7 @@ module PactBroker
 
       def calculate_required_verifications_for_pact(pact)
         pact_version = PactBroker::Pacts::PactVersion.for_pact_domain(pact)
-        required_verifications =  required_verifications_for_main_branch(pact_version) +
+        required_verifications =  required_verifications_for_main_branch(pact_version, pact.provider.main_branch) +
                                   required_verifications_for_deployed_versions(pact_version) +
                                   required_verifications_for_released_versions(pact_version)
         required_verifications
@@ -126,19 +128,24 @@ module PactBroker
       end
       private :broadcast_events
 
-      def identify_required_verification(pact_version, provider_version, description)
+      def identify_required_verification(pact_version, provider_version, description, provider_version_selector)
         any_verifications = PactBroker::Domain::Verification.where(pact_version_id: pact_version.id, provider_version_id: provider_version.id).any?
         if !any_verifications
-          RequiredVerification.new(provider_version: provider_version, provider_version_descriptions: [description])
+          RequiredVerification.new(
+            provider_version: provider_version,
+            provider_version_selectors: PactBroker::Versions::Selectors.new(provider_version_selector),
+            provider_version_descriptions: [description]
+          )
         end
       end
       private :identify_required_verification
 
-      def required_verifications_for_main_branch(pact_version)
+      def required_verifications_for_main_branch(pact_version, main_branch_name)
         latest_version_from_main_branch = [version_service.find_latest_version_from_main_branch(pact_version.provider)].compact
 
         latest_version_from_main_branch.collect do | main_branch_version |
-          identify_required_verification(pact_version, main_branch_version, "latest from main branch")
+          selector = PactBroker::Versions::Selector.for_main_branch.resolve_for_branch(main_branch_version, main_branch_name)
+          identify_required_verification(pact_version, main_branch_version, "latest from main branch", selector)
         end.compact
       end
       private :required_verifications_for_main_branch
@@ -148,7 +155,7 @@ module PactBroker
           unscoped_service.find_currently_deployed_versions_for_pacticipant(pact_version.provider)
         end
         deployed_versions.collect do | deployed_version |
-          identify_required_verification(pact_version, deployed_version.version, "deployed in #{deployed_version.environment_name}")
+          identify_required_verification(pact_version, deployed_version.version, "deployed in #{deployed_version.environment_name}", PactBroker::Versions::Selector.for_currently_deployed)
         end.compact
       end
       private :required_verifications_for_deployed_versions
@@ -158,7 +165,7 @@ module PactBroker
           unscoped_service.find_currently_supported_versions_for_pacticipant(pact_version.provider)
         end
         released_versions.collect do | released_version |
-          identify_required_verification(pact_version, released_version.version, "released in #{released_version.environment_name}")
+          identify_required_verification(pact_version, released_version.version, "released in #{released_version.environment_name}", PactBroker::Versions::Selector.for_currently_supported)
         end.compact
       end
       private :required_verifications_for_released_versions

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = "2.88.0"
+  VERSION = "2.89.0"
 end

data/lib/pact_broker/versions/selector.rb

@@ -0,0 +1,32 @@
+require "pact_broker/pacts/selector"
+require "pact_broker/hash_refinements"
+
+module PactBroker
+  module Versions
+    class Selector < PactBroker::Pacts::Selector
+      def resolve_for_branch(consumer_version, resolved_branch_name)
+        # Need to rename branch to branch_name
+        ResolvedSelector.new(self.to_h.merge({ resolved_branch_name: resolved_branch_name }.compact), consumer_version)
+      end
+    end
+
+    class ResolvedSelector < PactBroker::Pacts::ResolvedSelector
+      using PactBroker::HashRefinements
+
+      PROPERTY_NAMES = PactBroker::Pacts::Selector::PROPERTY_NAMES + [:version, :resolved_branch_name]
+
+      def initialize(properties = {}, version)
+        properties.without(*PROPERTY_NAMES).tap { |it| warn("WARN: Unsupported property for #{self.class.name}: #{it.keys.join(", ")} at #{caller[0..3]}") if it.any? }
+        merge!(properties.merge(version: version))
+      end
+
+      def resolved_branch_name
+        self[:resolved_branch_name]
+      end
+
+      def version
+        self[:version]
+      end
+    end
+  end
+end

data/lib/pact_broker/versions/selectors.rb

@@ -0,0 +1,20 @@
+require "pact_broker/pacts/selector"
+require "pact_broker/versions/selector"
+
+module PactBroker
+  module Versions
+    class Selectors < Array
+      def initialize *selectors
+        super([*selectors].flatten)
+      end
+
+      def + other
+        Selectors.new(super)
+      end
+
+      def sort
+        Selectors.new(super)
+      end
+    end
+  end
+end

data/lib/pact_broker/webhooks/pact_and_verification_parameters.rb

@@ -171,8 +171,8 @@ module PactBroker
       end
 
       def provider_version_branch
-        if webhook_context[:provider_version_branch]
-          webhook_context[:provider_version_branch]
+        if webhook_context.key?(:provider_version_branch)
+          webhook_context[:provider_version_branch] || ""
         else
           verification&.provider_version&.branch || ""
         end

data/lib/pact_broker/webhooks/trigger_service.rb

@@ -135,13 +135,21 @@ module PactBroker
           required_verifications = verification_service.calculate_required_verifications_for_pact(pact)
           event_contexts.flat_map do | event_context |
             required_verifications.collect do | required_verification |
-              event_context.merge(provider_version_number: required_verification.provider_version.number, provider_version_descriptions: required_verification.provider_version_descriptions.uniq)
+              event_context.merge(
+                provider_version_number: required_verification.provider_version.number,
+                provider_version_branch: provider_version_branch_for_required_verification(required_verification, ),
+                provider_version_descriptions: required_verification.provider_version_descriptions.uniq
+              )
             end
           end
         else
           event_contexts
         end
       end
+
+      def provider_version_branch_for_required_verification(required_verification)
+        required_verification.provider_version_selectors.find(&:latest_for_main_branch?)&.resolved_branch_name || required_verification.provider_version.branch_versions.last&.branch_name
+      end
     end
   end
 end

data/script/docs/generate-configuration-docs.rb

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
 INTRO = <<EOM
-<!-- This is a generated file. Please do not edit it directly. -->
+<!-- This is a generated file. Please do not edit it directly. The source is https://github.com/pact-foundation/pact_broker/blob/master/docs/configuration.yml -->
 
-The Pact Broker supports configuration via environment variables or a YAML file.
+The Pact Broker supports configuration via environment variables or a YAML file from version 2.87.0.1 of the Docker images.
 
 To configure the application using a YAML file, place it in the location `config/pact_broker.yml`,
 relative to the working directory of the application, or set the environment
@@ -94,14 +94,14 @@ end
 
 File.open(configuration_doc_path, "w") { |file| file << $stream.string }
 
-required_env_vars = []
-
-doc["groups"].each do | group |
-  group["vars"].each do | name, metadata |
-    required_env_vars << name if metadata["required"] && !metadata["default"]
-  end
+required_env_vars = doc["groups"].flat_map do | group |
+  group["vars"].collect do | name, _metadata |
+    if name != "port"
+      "env PACT_BROKER_#{name.upcase};"
+    end
+  end.compact
 end
 
-puts "Required:"
+puts "Env vars for https://github.com/DiUS/pact_broker-docker/blob/master/container/etc/nginx/main.d/pactbroker-env.conf :"
 puts required_env_vars
 puts configuration_doc_path

data/script/github-issues/add-branch-support/issue-text.txt

@@ -0,0 +1,7 @@
+Add branch support
+
+The Pact Broker now supports branches as first class entities. You can read more about this here: https://github.com/pact-foundation/docs.pact.io/blob/feat/deployments-and-releases/website/blog/2021-07-04-why-we-are-getting-rid-of-tags.md
+
+Please add support for branches in the following way (depending on how you publish pacts and verifications):
+
+* If this

data/script/github-issues/add-branch-support/raise-issue-in-client-repos.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+repos="pact-js pact-jvm pact-net pact-python scala-pact pact-php pact-go pact pact-reference pact4s"
+
+issue_text_file=$(realpath $(dirname "$0")/issue-text.txt)
+
+for repo in $repos; do
+  cd "../${repo}"
+  hub issue create --file "${issue_text_file}" --labels "help wanted,good first issue,enhancement"
+done

data/script/github-issues/add-branch-support-for-provider-versions/issue-text.txt

@@ -0,0 +1,9 @@
+Add support for publishing verification results with a branch using the pact-ruby-standalone
+
+The Pact Broker now supports branches as first class entities. You can read more about this here: https://github.com/pact-foundation/docs.pact.io/blob/feat/deployments-and-releases/website/blog/2021-07-04-why-we-are-getting-rid-of-tags.md
+
+To allow users to use this feature:
+
+* Upgrade the pact-ruby-standalone to at least version `1.88.70`
+* Add an appropriately prefixed "branch" property to the user facing interface (make it match the existing provider name, tag, and version properties)
+* Pass the branch through to the pact provider verifier CLI using the parameter `--provider-version-branch`

data/script/github-issues/add-branch-support-for-provider-versions/issues.txt

@@ -0,0 +1,6 @@
+https://github.com/pact-foundation/pact-js/issues/750
+https://github.com/pact-foundation/pact-net/issues/327
+https://github.com/pact-foundation/pact-python/issues/267
+https://github.com/pact-foundation/pact-php/issues/223
+https://github.com/pact-foundation/pact-go/issues/180
+https://github.com/DiUS/pact-consumer-swift/issues/127

data/script/github-issues/add-branch-support-for-provider-versions/raise-issue-in-client-repos.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+repos="pact-js pact-net pact-python pact-php pact-go pact-consumer-swift"
+
+issue_text_file=$(realpath $(dirname "$0")/issue-text.txt)
+
+for repo in $repos; do
+  cd "../${repo}"
+  hub issue create --file "${issue_text_file}" --labels "help wanted,enhancement"
+done

data/script/github-issues/branch-consumer-version-selector/issue-text.txt

@@ -0,0 +1,52 @@
+Add support for branches in consumer version selectors
+
+The Pact Broker now supports branches as first class entities. You can read more about this here: https://docs.pact.io/pact_broker/branches
+
+## Description
+
+Please add support for specifying branch related properties in the consumer version selectors that are sent to the Pact Broker when requesting pacts to verify. Please do not do any verification of the consumer version selectors on the client side - the validation rules are subject to change. Just ensure that any error response is displayed to the user.
+
+* For implementations that wrap the pact-ruby-standalone, update to the latest standalone version
+* For implementations that use the rust implementation, update to the latest rust version.
+* Add a String `branch` property to the consumer version selector (if there is a domain model for this).
+* Add a Boolean `mainBranch` (or `main_branch` for snake case languages) property consumer version selector (if there is a domain model for this).
+* Add a Boolean `matchingBranch` (or `matching_branch` for snake case languages) property consumer version selector (if there is a domain model for this).
+* Expose and document the `branch`, `mainBranch` (or `main_branch` for snake case languages) and `matchingBranch` (or `matching_branch`) properties in the user facing API.
+* Pass the `branch`, `mainBranch` and `matchingBranch` (must be camelcase) through to the relevant implementation (ruby and/or rust)
+
+## Verifying the changes
+
+* Publish test pacts to the test broker
+
+```
+export PACT_BROKER_BASE_URL="https://test.pact.dius.com.au"
+export PACT_BROKER_USERNAME="dXfltyFMgNOFZAxr8io9wJ37iUpY42M"
+export PACT_BROKER_PASSWORD="O5AIZWxelWbLvqMd8PkAVycBJh2Psyg1"
+
+docker run --rm  \
+  -e PACT_BROKER_BASE_URL  \
+  -e PACT_BROKER_USERNAME  \
+  -e PACT_BROKER_PASSWORD  \
+  pactfoundation/pact-cli:0.50.0.14 \
+  publish \
+  /pact/example/pacts \
+  --consumer-app-version fake-git-sha-for-demo-$(date +%s) \
+  --branch main
+
+docker run --rm  \
+  -e PACT_BROKER_BASE_URL  \
+  -e PACT_BROKER_USERNAME  \
+  -e PACT_BROKER_PASSWORD  \
+  pactfoundation/pact-cli:0.50.0.14 \
+  publish \
+  /pact/example/pacts \
+  --consumer-app-version fake-git-sha-for-demo-$(date +%s) \
+  --branch feat/x
+```
+
+* Using your pact client library, verify `{ "mainBranch": true }`
+  * You should receive the main pact
+* Using your pact client library, verify `{ "branch": "feat/x" }`
+  * You should receive the feat/x pact
+* Using your pact client library, verify `{ "matchingBranch": true }` with the provider branch set to `feat/x`
+  * You should receive the feat/x pact

data/script/github-issues/branch-consumer-version-selector/issues.txt

@@ -0,0 +1,9 @@
+https://github.com/pact-foundation/pact-js/issues/757
+https://github.com/pact-foundation/pact-jvm/issues/1465
+https://github.com/pact-foundation/pact-net/issues/336
+https://github.com/pact-foundation/pact-python/issues/272
+https://github.com/pact-foundation/pact-php/issues/226
+https://github.com/pact-foundation/pact-go/issues/184
+https://github.com/pact-foundation/pact-reference/issues/158
+https://github.com/jbwheatley/pact4s/issues/89
+https://github.com/ITV/scala-pact/issues/230

data/script/github-issues/branch-consumer-version-selector/raise-issue-in-client-repos.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+repos="pact-js pact-jvm pact-net pact-python pact-php pact-go pact-reference pact4s scala-pact" #pact_elixir
+
+issue_text_file=$(realpath $(dirname "$0")/issue-text.txt)
+
+for repo in $repos; do
+  cd "../${repo}"
+  hub issue create --file "${issue_text_file}" --labels "help wanted,enhancement"
+done

data/script/github-issues/deployed-and-released-selectors-docs/issue-text.txt

@@ -0,0 +1,26 @@
+Add support for consumer version selectors for deployed and released versions
+
+Please add support for the following keys to be used in the consumer version selectors when fetching pacts for verification:
+
+```
+{ "deployedOrReleased": true }
+
+{ "deployed": true }
+
+{ "released": true }
+
+{ "environment": "<env name>" }
+
+{ "deployed": true }
+
+{ "released": true }
+
+```
+
+These keys can be used in various combinations ( eg. `{ "environment": "prod", released: true, consumer: "Foo" }` ). Please allow any combination of keys, and do not validate them locally, as the validation rules can change over time as support is added for new selectors - just ensure that any errors returned from the API are displayed clearly to the user.
+
+See https://github.com/pact-foundation/pact_broker/blob/master/lib/pact_broker/doc/views/provider-pacts-for-verification.markdown for the usage docs of each selector.
+
+As more selectors will be added over time, it's my preference that the consumer version selectors are not strongly typed, and are just passed through straight from the configuration object to the API, so that we don't have to make code changes to the Pact clients each time we add new selectors. (eg. there will be new selectors coming for branch support very soon). I understand that this is not compatible with the idioms of every Pact client language however, so do whatever you need to do to make the new selectors work elegantly within your language.
+
+Please update https://docs.pact.io/pact_broker/advanced_topics/consumer_version_selectors/ for your language once the selectors have been released.

data/script/github-issues/deployed-and-released-selectors-docs/issues.txt

@@ -0,0 +1,9 @@
+https://github.com/pact-foundation/pact-js/issues/715
+https://github.com/pact-foundation/pact-jvm/issues/1407
+https://github.com/pact-foundation/pact-net/issues/311
+https://github.com/pact-foundation/pact-python/issues/246
+https://github.com/ITV/scala-pact/issues/224
+https://github.com/pact-foundation/pact-php/issues/206
+https://github.com/pact-foundation/pact-go/issues/172
+https://github.com/pact-foundation/pact-ruby/issues/243
+https://github.com/pact-foundation/pact-reference/issues/125

data/script/github-issues/deployed-and-released-selectors-docs/raise-issue-in-client-repos.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+repos="pact-js pact-jvm pact-net pact-python scala-pact pact-php pact-go pact pact-reference"
+
+issue_text_file=$(realpath $(dirname "$0")/issue-text.txt)
+
+for repo in $repos; do
+  cd "../${repo}"
+  hub issue create --file "${issue_text_file}" --labels "help wanted,good first issue,enhancement"
+done

data/script/github-issues/include-pending-by-default/issue-text.txt

@@ -0,0 +1,5 @@
+Set "enable pending" to true by default
+
+The [pending](https://docs.pact.io/pending) feature has been used for long enough now to show that it works, and that there is little reason to ever have it turned off any more. The Pact Broker now defaults to `true` if the `includePendingStatus` field is not set, however, this will not take effect if the client side has it set to false by default. Please set `enablePending` to true by default now, to ensure it is turned on for all older and future versions of the Pact Broker.
+
+Consider printing a warning message if the user does set it to false explicitly, along the lines of "We recommend setting enablePending to true. For more information, please see https://docs.pact.io/pending"

data/script/github-issues/include-pending-by-default/issues.txt

@@ -0,0 +1,10 @@
+https://github.com/pact-foundation/pact-js/issues/740
+https://github.com/pact-foundation/pact-jvm/issues/1440
+https://github.com/pact-foundation/pact-net/issues/322
+https://github.com/pact-foundation/pact-python/issues/264
+https://github.com/ITV/scala-pact/issues/228
+https://github.com/pact-foundation/pact-php/issues/221
+https://github.com/pact-foundation/pact-go/issues/178
+https://github.com/pact-foundation/pact-ruby/issues/246
+https://github.com/pact-foundation/pact-reference/issues/143
+https://github.com/jbwheatley/pact4s/issues/69

data/script/github-issues/include-pending-by-default/raise-issue-in-client-repos.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+repos="pact-js pact-jvm pact-net pact-python scala-pact pact-php pact-go pact pact-reference pact4s"
+
+issue_text_file=$(realpath $(dirname "$0")/issue-text.txt)
+
+for repo in $repos; do
+  cd "../${repo}"
+  hub issue create --file "${issue_text_file}" --labels "help wanted,good first issue,enhancement"
+done

data/spec/features/get_currently_deployed_versions_for_environment_spec.rb

@@ -29,9 +29,8 @@ RSpec.describe "Get currently deployed versions for environment" do
   end
 
   context "with query params" do
-
-    context "with a pacticipant name and target" do
-      let(:query_params) { { pacticipant: "Bar", target: "customer-1" } }
+    context "with a pacticipant name and applicationInstance" do
+      let(:query_params) { { pacticipant: "Bar", applicationInstance: "customer-1" } }
 
       it "returns a list of matching deployed versions" do
         expect(response_body_hash[:_embedded][:deployedVersions].size).to eq 1
@@ -39,8 +38,8 @@ RSpec.describe "Get currently deployed versions for environment" do
       end
     end
 
-    context "with pacticipant name and a blank target" do
-      let(:query_params) { { pacticipant: "Bar", target: "" } }
+    context "with pacticipant name and a blank applicationInstance" do
+      let(:query_params) { { pacticipant: "Bar", applicationInstance: "" } }
 
       it "returns a list of matching deployed versions" do
         expect(response_body_hash[:_embedded][:deployedVersions].size).to eq 1
@@ -48,12 +47,30 @@ RSpec.describe "Get currently deployed versions for environment" do
       end
     end
 
-    context "with pacticipant name and no target" do
+    context "with pacticipant name and no target or applicationInstance" do
       let(:query_params) { { pacticipant: "Bar" } }
 
       it "returns a list of matching deployed versions" do
         expect(response_body_hash[:_embedded][:deployedVersions].size).to eq 2
       end
     end
+
+    context "with a pacticipant name and target (deprecated)" do
+      let(:query_params) { { pacticipant: "Bar", target: "customer-1" } }
+
+      it "returns a list of matching deployed versions" do
+        expect(response_body_hash[:_embedded][:deployedVersions].size).to eq 1
+        expect(response_body_hash[:_embedded][:deployedVersions].first[:_embedded][:version][:number]).to eq "4"
+      end
+    end
+
+    context "with pacticipant name and a blank target (deprecated)" do
+      let(:query_params) { { pacticipant: "Bar", target: "" } }
+
+      it "returns a list of matching deployed versions" do
+        expect(response_body_hash[:_embedded][:deployedVersions].size).to eq 1
+        expect(response_body_hash[:_embedded][:deployedVersions].first[:_embedded][:version][:number]).to eq "5"
+      end
+    end
   end
 end

data/spec/features/publish_pact_all_in_one_spec.rb

@@ -39,4 +39,23 @@ RSpec.describe "publishing a pact using the all in one endpoint" do
 
     it { is_expected.to be_a_json_error_response("missing") }
   end
+
+  context "with a conflicting pact" do
+    before do
+      allow(PactBroker.configuration).to receive(:allow_dangerous_contract_modification).and_return(false)
+      td.create_pact_with_hierarchy("Foo", "1", "Bar")
+    end
+
+    its(:status) { is_expected.to eq 409 }
+
+    it "returns notices" do
+      expect(JSON.parse(subject.body)["notices"]).to be_a(Array)
+    end
+
+    it "returns errors" do
+      contract_errors = JSON.parse(subject.body)["errors"]["contracts"]
+      expect(contract_errors).to be_a(Array)
+      expect(contract_errors.size).to eq 1
+    end
+  end
 end

data/spec/features/record_deployment_spec.rb

@@ -14,13 +14,13 @@ describe "Record deployment" do
   let(:response_body) { JSON.parse(subject.body, symbolize_names: true) }
   let(:version_path) { "/pacticipants/Foo/versions/2" }
   let(:version_response) { get(version_path, nil, { "HTTP_ACCEPT" => "application/hal+json" } ) }
-  let(:target) { nil }
+  let(:application_instance) { nil }
   let(:path) do
     JSON.parse(version_response.body)["_links"]["pb:record-deployment"]
       .find{ |relation| relation["name"] == "test" }
       .fetch("href")
   end
-  let(:request_body) { { target: target }.to_json }
+  let(:request_body) { { applicationInstance: application_instance }.to_json }
 
   subject { post(path, request_body, headers) }
 
@@ -33,6 +33,7 @@ describe "Record deployment" do
   it "returns the newly created deployment" do
     expect(response_body[:currentlyDeployed]).to be true
     expect(response_body).to_not have_key(:target)
+    expect(response_body).to_not have_key(:application_instance)
   end
 
   it "creates a new deployed version" do
@@ -79,8 +80,20 @@ describe "Record deployment" do
     it { is_expected.to be_a_hal_json_created_response }
   end
 
-  context "when the deployment is to a different target" do
-    let(:target) { "foo" }
+  context "when the deployment is to a different application instance" do
+    let(:application_instance) { "foo" }
+
+    it "creates a new deployed version" do
+      expect { subject }.to change { PactBroker::Deployments::DeployedVersion.currently_deployed.count }.by(1)
+    end
+
+    it "sets the applicationInstance" do
+      expect(response_body).to have_key(:applicationInstance)
+    end
+  end
+
+  context "when the deployment is to a different target (deprecated)" do
+    let(:request_body) { { target: "foo" }.to_json }
 
     it "creates a new deployed version" do
       expect { subject }.to change { PactBroker::Deployments::DeployedVersion.currently_deployed.count }.by(1)

data/spec/lib/pact_broker/api/contracts/pacts_for_verification_json_query_schema_combinations_spec.rb

@@ -6,6 +6,7 @@ module PactBroker
       describe PactsForVerificationJSONQuerySchema do
         ALL_PROPERTIES = {
           mainBranch: true,
+          matchingBranch: true,
           tag: "tag",
           branch: "branch",
           latest: true,
@@ -20,6 +21,7 @@ module PactBroker
 
         VALID_KEY_COMBINATIONS = [
           [:mainBranch],
+          [:matchingBranch],
           [:tag],
           [:tag, :latest],
           [:tag, :latest, :fallbackTag],
@@ -45,7 +47,7 @@ module PactBroker
             end
 
             it "is valid" do
-              params = { consumerVersionSelectors: [selector] }
+              params = { consumerVersionSelectors: [selector], providerVersionBranch: "main" }
               expect(PactsForVerificationJSONQuerySchema.(params)).to be_empty
             end
 
@@ -53,7 +55,7 @@ module PactBroker
             extra_keys.each do | extra_key |
               selector_with_extra_key = selector.merge(extra_key => ALL_PROPERTIES[extra_key])
               expect_to_be_valid = !!VALID_KEY_COMBINATIONS.find{ | k | k.sort == selector_with_extra_key.keys.sort }
-              params = { consumerVersionSelectors: [selector_with_extra_key] }
+              params = { consumerVersionSelectors: [selector_with_extra_key], providerVersionBranch: "main"  }
 
               describe "with #{selector_with_extra_key}" do
                 if expect_to_be_valid
@@ -71,7 +73,7 @@ module PactBroker
 
               describe "with #{selector_with_consumer}" do
                 it "is valid" do
-                  params = { consumerVersionSelectors: [selector_with_consumer] }
+                  params = { consumerVersionSelectors: [selector_with_consumer], providerVersionBranch: "main" }
 
                   expect(PactsForVerificationJSONQuerySchema.(params).empty?).to be true
                 end

data/spec/lib/pact_broker/api/contracts/pacts_for_verification_json_query_schema_spec.rb

@@ -342,6 +342,16 @@ module PactBroker
 
           its([:consumerVersionSelectors, 0]) { is_expected.to eq "environment with name 'prod' does not exist at index 0" }
         end
+
+        context "when matchingBranch is true, but the providerVersionBranch is not set" do
+          let(:consumer_version_selectors) do
+            [{
+              matchingBranch: true
+            }]
+          end
+
+          its([:consumerVersionSelectors, 0]) { is_expected.to include "the providerVersionBranch must be specified"}
+        end
       end
     end
   end