pact_broker 2.79.1 → 2.80.0

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

@@ -1,4 +1,4 @@
-require 'pact_broker/api/contracts/put_pact_params_contract'
+require "pact_broker/api/contracts/put_pact_params_contract"
 
 module PactBroker
   module Api
@@ -8,7 +8,7 @@ module PactBroker
           allow(PactBroker.configuration).to receive(:order_versions_by_date).and_return(order_versions_by_date)
         end
 
-        let(:json_content) { {'some' => 'json' }.to_json }
+        let(:json_content) { {"some" => "json" }.to_json }
         let(:pact_params) { Pacts::PactParams.new(attributes) }
         let(:order_versions_by_date) { false }
 
@@ -16,7 +16,7 @@ module PactBroker
           {
             consumer_name: "consumer",
             provider_name: "provider",
-            consumer_version_number: '1.2.3',
+            consumer_version_number: "1.2.3",
             json_content: json_content,
             consumer_name_in_pact: "consumer",
             provider_name_in_pact: "provider"
@@ -51,7 +51,7 @@ module PactBroker
 
           context "with an empty consumer version number" do
             let(:attributes) do
-              valid_attributes.merge(consumer_version_number: '')
+              valid_attributes.merge(consumer_version_number: "")
             end
 
             it "returns an error" do
@@ -61,7 +61,7 @@ module PactBroker
 
           context "with an invalid version number" do
             let(:attributes) do
-              valid_attributes.merge(consumer_version_number: 'blah')
+              valid_attributes.merge(consumer_version_number: "blah")
             end
 
             it "returns an error" do
@@ -74,7 +74,7 @@ module PactBroker
 
             context "with an invalid version number" do
               let(:attributes) do
-                valid_attributes.merge(consumer_version_number: 'blah')
+                valid_attributes.merge(consumer_version_number: "blah")
               end
 
               it "does not return an error" do

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

@@ -0,0 +1,76 @@
+require "pact_broker/api/contracts/verifiable_pacts_json_query_schema"
+
+module PactBroker
+  module Api
+    module Contracts
+      describe VerifiablePactsJSONQuerySchema do
+        ALL_PROPERTIES = {
+          tag: "tag",
+          branch: "branch",
+          latest: true,
+          fallbackTag: "fallbackTag",
+          fallbackBranch: "fallbackBranch",
+          environment: "environment",
+          deployed: true,
+          released: true,
+          consumer: "consumer"
+        }
+
+        VALID_KEY_COMBINATIONS = [
+          [:tag],
+          [:tag, :latest],
+          [:tag, :latest, :fallbackTag],
+          [:branch],
+          [:branch, :latest],
+          [:branch, :latest, :fallbackBranch],
+          [:branch, :fallbackBranch],
+          [:environment],
+          [:environment, :deployed],
+          [:environment, :released],
+          [:deployed],
+          [:released],
+        ]
+
+        VALID_KEY_COMBINATIONS.each do | valid_key_combination |
+          selector = ALL_PROPERTIES.slice(*valid_key_combination)
+
+          describe "with #{selector}" do
+            it "is valid" do
+              params = { consumerVersionSelectors: [selector] }
+              expect(VerifiablePactsJSONQuerySchema.(params)).to be_empty
+            end
+
+            extra_keys = ALL_PROPERTIES.keys - valid_key_combination - [:consumer]
+            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] }
+
+              describe "with #{selector_with_extra_key}" do
+                if expect_to_be_valid
+                  it "is valid" do
+                    expect(VerifiablePactsJSONQuerySchema.(params)).to be_empty
+                  end
+                else
+                  it "is not valid" do
+                    expect(VerifiablePactsJSONQuerySchema.(params)).to_not be_empty
+                  end
+                end
+              end
+
+              selector_with_consumer = selector.merge(consumer: ALL_PROPERTIES[:consumer])
+
+              describe "with #{selector_with_consumer}" do
+                it "is valid" do
+                  params = { consumerVersionSelectors: [selector_with_consumer] }
+
+                  expect(VerifiablePactsJSONQuerySchema.(params).empty?).to be true
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-require 'pact_broker/api/contracts/verifiable_pacts_json_query_schema'
+require "pact_broker/api/contracts/verifiable_pacts_json_query_schema"
 
 module PactBroker
   module Api
@@ -52,7 +52,7 @@ module PactBroker
             end
 
             it "has an error" do
-              expect(subject[:consumerVersionSelectors].first).to match /can only be set.*index 0/
+              expect(subject[:consumerVersionSelectors].first).to match(/can only be set.*index 0/)
             end
 
             context "when there are multiple errors" do
@@ -104,13 +104,13 @@ module PactBroker
           it { is_expected.to have_key(:consumerVersionSelectors) }
         end
 
-        context "when the consumer_version_selector is missing a tag" do
+        context "when the consumer_version_selector is empty" do
           let(:consumer_version_selectors) do
             [{}]
           end
 
           it "flattens the messages" do
-            expect(subject[:consumerVersionSelectors].first).to eq "latest must be true, or a tag must be provided (at index 0)"
+            expect(subject[:consumerVersionSelectors].first).to match(/must specify a value.*at index 0/)
           end
         end
 
@@ -173,6 +173,160 @@ module PactBroker
 
           it { is_expected.to be_empty }
         end
+
+        context "when deployed is specified" do
+          let(:consumer_version_selectors) do
+            [{
+              deployed: true
+            }]
+          end
+
+          it { is_expected.to be_empty }
+        end
+
+        context "when released is specified" do
+          let(:consumer_version_selectors) do
+            [{
+              released: true
+            }]
+          end
+
+          it { is_expected.to be_empty }
+        end
+
+
+        context "when the environment is specified" do
+          let(:consumer_version_selectors) do
+            [{
+              environment: "test"
+            }]
+          end
+
+          it { is_expected.to be_empty }
+        end
+
+        context "when deployed with an environment is specified" do
+          let(:consumer_version_selectors) do
+            [{
+              environment: "feat",
+              deployed: true
+            }]
+          end
+
+          it { is_expected.to be_empty }
+        end
+
+        context "when deployed=false with an environment is specified" do
+          let(:consumer_version_selectors) do
+            [{
+              environment: "feat",
+              deployed: false
+            }]
+          end
+
+          its([:consumerVersionSelectors, 0]) { is_expected.to eq "deployed must be one of: true at index 0" }
+        end
+
+        context "when the environment is specified and deployed is nil" do
+          let(:consumer_version_selectors) do
+            [{
+              environment: "feat",
+              deployed: nil
+            }]
+          end
+
+          its([:consumerVersionSelectors, 0]) { is_expected.to eq "deployed can't be blank at index 0" }
+        end
+
+        context "when deployed is nil" do
+          let(:consumer_version_selectors) do
+            [{
+              deployed: nil
+            }]
+          end
+
+          its([:consumerVersionSelectors, 0]) { is_expected.to eq "deployed can't be blank at index 0" }
+        end
+
+        context "when latest=true and an environment is specified" do
+          let(:consumer_version_selectors) do
+            [{
+              environment: "feat",
+              latest: true
+            }]
+          end
+
+          its([:consumerVersionSelectors, 0]) { is_expected.to eq "cannot specify the field latest with the field environment (at index 0)" }
+        end
+
+        context "when latest=true, tag and an environment and deployed are specified" do
+          let(:consumer_version_selectors) do
+            [{
+              environment: "feat",
+              latest: true,
+              tag: "foo",
+              deployed: true
+            }]
+          end
+
+          its([:consumerVersionSelectors, 0]) { is_expected.to eq "cannot specify the fields latest/tag with the fields deployed/environment (at index 0)" }
+        end
+
+        context "when a tag and a branch are specified" do
+          let(:consumer_version_selectors) do
+            [{
+              branch: "foo",
+              tag: "foo",
+              latest: true
+            }]
+          end
+
+          its([:consumerVersionSelectors, 0]) { is_expected.to eq "cannot specify both a tag and a branch (at index 0)" }
+        end
+
+        context "when a fallbackTag is specified without a tag" do
+          let(:consumer_version_selectors) do
+            [{
+              fallbackTag: "foo",
+              latest: true,
+              branch: "foo"
+            }]
+          end
+
+          its([:consumerVersionSelectors, 0]) { is_expected.to eq "a tag must be specified when a fallbackTag is specified (at index 0)" }
+        end
+
+        context "when a fallbackBranch is specified without a branch" do
+          let(:consumer_version_selectors) do
+            [{
+              fallbackBranch: "foo",
+              tag: "foo"
+            }]
+          end
+
+          its([:consumerVersionSelectors, 0]) { is_expected.to eq "a branch must be specified when a fallbackBranch is specified (at index 0)" }
+        end
+
+        context "when a branch is specified with no latest=true" do
+          let(:consumer_version_selectors) do
+            [{
+              branch: "foo"
+            }]
+          end
+
+          it { is_expected.to be_empty }
+        end
+
+        context "when a branch is specified with latest=false" do
+          let(:consumer_version_selectors) do
+            [{
+              branch: "foo",
+              latest: false
+            }]
+          end
+
+          its([:consumerVersionSelectors, 0]) { is_expected.to eq "cannot specify a branch with latest=false (at index 0)" }
+        end
       end
     end
   end

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

@@ -1,4 +1,4 @@
-require 'pact_broker/api/contracts/verifiable_pacts_query_schema'
+require "pact_broker/api/contracts/verifiable_pacts_query_schema"
 
 module PactBroker
   module Api

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

@@ -1,6 +1,6 @@
-require 'pact_broker/api/contracts/verification_contract'
-require 'pact_broker/api/decorators/verification_decorator'
-require 'pact_broker/domain/verification'
+require "pact_broker/api/contracts/verification_contract"
+require "pact_broker/api/decorators/verification_decorator"
+require "pact_broker/domain/verification"
 
 module PactBroker
   module Api
@@ -14,7 +14,7 @@ module PactBroker
 
         let(:success) { true }
         let(:provider_version) { "4.5.6" }
-        let(:build_url) { 'http://foo' }
+        let(:build_url) { "http://foo" }
         let(:order_versions_by_date) { false }
 
         def modify hash, options

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

@@ -1,20 +1,20 @@
-require 'pact_broker/api/contracts/webhook_contract'
-require 'pact_broker/api/decorators/webhook_decorator'
+require "pact_broker/api/contracts/webhook_contract"
+require "pact_broker/api/decorators/webhook_decorator"
 
 module PactBroker
   module Api
     module Contracts
       describe WebhookContract do
-        let(:json) { load_fixture 'webhook_valid_with_pacticipants.json' }
+        let(:json) { load_fixture "webhook_valid_with_pacticipants.json" }
         let(:hash) { JSON.parse(json) }
         let(:webhook) { PactBroker::Api::Decorators::WebhookDecorator.new(Domain::Webhook.new).from_json(json) }
         let(:subject) { WebhookContract.new(webhook) }
-        let(:matching_hosts) { ['foo'] }
+        let(:matching_hosts) { ["foo"] }
         let(:consumer) { double("consumer") }
         let(:provider) { double("provider") }
 
         def valid_webhook_with
-          hash = load_json_fixture 'webhook_valid_with_pacticipants.json'
+          hash = load_json_fixture "webhook_valid_with_pacticipants.json"
           yield hash
           hash.to_json
         end
@@ -29,8 +29,8 @@ module PactBroker
             subject.validate(hash)
           end
 
-          let(:webhook_http_method_whitelist) { ['POST'] }
-          let(:whitelist_matches) { ['foo'] }
+          let(:webhook_http_method_whitelist) { ["POST"] }
+          let(:whitelist_matches) { ["foo"] }
           let(:webhook_host_whitelist) { [] }
 
           context "with valid fields" do
@@ -42,7 +42,7 @@ module PactBroker
           context "with a nil consumer name" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['consumer']['name'] = nil
+                hash["consumer"]["name"] = nil
               end
             end
 
@@ -54,7 +54,7 @@ module PactBroker
           context "with no consumer name key" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['consumer'].delete('name')
+                hash["consumer"].delete("name")
               end
             end
 
@@ -68,7 +68,7 @@ module PactBroker
           context "with no consumer" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash.delete('consumer')
+                hash.delete("consumer")
               end
             end
 
@@ -88,7 +88,7 @@ module PactBroker
           context "with a nil provider name" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['provider']['name'] = nil
+                hash["provider"]["name"] = nil
               end
             end
 
@@ -100,7 +100,7 @@ module PactBroker
           context "with no provider name key" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['provider'].delete('name')
+                hash["provider"].delete("name")
               end
             end
 
@@ -114,7 +114,7 @@ module PactBroker
           context "with no provider" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash.delete('provider')
+                hash.delete("provider")
               end
             end
 
@@ -150,7 +150,7 @@ module PactBroker
           context "with empty events" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['events'] = []
+                hash["events"] = []
               end
             end
 
@@ -162,7 +162,7 @@ module PactBroker
           context "with an event with an invalid name" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['events'].first['name'] = 'foo'
+                hash["events"].first["name"] = "foo"
               end
             end
 
@@ -174,7 +174,7 @@ module PactBroker
           context "with no method" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['request'].delete('method')
+                hash["request"].delete("method")
               end
             end
 
@@ -186,7 +186,7 @@ module PactBroker
           context "with an invalid method" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['request']['method'] = 'blah'
+                hash["request"]["method"] = "blah"
               end
             end
 
@@ -198,7 +198,7 @@ module PactBroker
           context "with an invalid scheme" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['request']['url'] = 'ftp://foo'
+                hash["request"]["url"] = "ftp://foo"
               end
             end
 
@@ -210,7 +210,7 @@ module PactBroker
           context "with an HTTP method that is not whitelisted" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['request']['method'] = 'DELETE'
+                hash["request"]["method"] = "DELETE"
               end
             end
 
@@ -221,7 +221,7 @@ module PactBroker
             end
 
             context "when there is more than one allowed HTTP method", pending: "need to work out how to dynamically create this message" do
-              let(:webhook_http_method_whitelist) { ['POST', 'GET'] }
+              let(:webhook_http_method_whitelist) { ["POST", "GET"] }
 
               it "contains an error for invalid method" do
                 expect(subject.errors[:"request.http_method"]).to include "must be one of POST, GET"
@@ -254,7 +254,7 @@ module PactBroker
           context "with no URL" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['request'].delete('url')
+                hash["request"].delete("url")
               end
             end
 
@@ -266,7 +266,7 @@ module PactBroker
           context "with an invalid URL" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['request']['url'] = 'bl ah'
+                hash["request"]["url"] = "bl ah"
               end
             end
 
@@ -278,7 +278,7 @@ module PactBroker
           context "with an URL missing a scheme" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['request']['url'] = 'blah'
+                hash["request"]["url"] = "blah"
               end
             end
 
@@ -290,7 +290,7 @@ module PactBroker
           context "with a URL that has templated parameters in it" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['request']['url'] = 'https://foo/commits/${pactbroker.consumerVersionNumber}'
+                hash["request"]["url"] = "https://foo/commits/${pactbroker.consumerVersionNumber}"
               end
             end
 
@@ -302,7 +302,7 @@ module PactBroker
           context "with a URL that has templated parameters in the host" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['request']['url'] = 'https://${pactbroker.consumerVersionNumber}/commits'
+                hash["request"]["url"] = "https://${pactbroker.consumerVersionNumber}/commits"
               end
             end
 
@@ -314,7 +314,7 @@ module PactBroker
           context "when enabled is not a boolean", pending: "I can't work out why this doesn't work" do
             let(:json) do
               valid_webhook_with do |hash|
-                hash['enabled'] = 'foo'
+                hash["enabled"] = "foo"
               end
             end