pact_broker 2.60.1 → 2.61.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2af8e33b43adbd78dff9e58ae2c16ff69668694dc71b203487d789bd754f4e1a
-  data.tar.gz: 1cf9633412dd10faac7179cfd34ee84bf84738961d7c131d5660f1e3938fe21a
+  metadata.gz: 3495dd128672a4f4e614b7c60d93734cb3eee3799863af054963c503172d86f2
+  data.tar.gz: be415648babf90774ef011a0485835f386632768fb95b5a1f125ea9bddea2492
 SHA512:
-  metadata.gz: c02c5a85ba278137ad2c15022ecf055c74c59ddf9565617c9df8ca65dc83181d9ec444385bbec65f557de42e6686e837f3230825945cde1da6bb1bc5e20a6b01
-  data.tar.gz: '0386fc2e7a2fcb3c3f019bcdbb49e37861259408b1aadfe298368ece37bbbb363260e4a01df6746ca137dea0be0ba220abbf497065300084576bd62d1bcf76f1'
+  metadata.gz: aabedcd424d01dfa172424f99feac69d71ce2c55fe97f5c6b25dc1e29247168c14f0aa0d56c144c353a9444cd1cce99e14f7b677161f609ca829d00fdd2cf72c
+  data.tar.gz: a18db48c05cb2f3ae9ebc48b18673d45b4bafe19574633fef2d0ae6c21c2242a7b5cd80dab359eeccedb7044dcb1c2895b8290065fd4e7c7db5ba9c6686fefc4

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+<a name="v2.61.0"></a>
+### v2.61.0 (2020-09-12)
+
+#### Features
+
+* add back support for GET requests to the 'pacts for verification' API with a deprecation notice in the response	 ([8f45cc9f](/../../commit/8f45cc9f))
+
 <a name="v2.60.1"></a>
 ### v2.60.1 (2020-09-10)
 

data/lib/pact_broker/api/contracts/verifiable_pacts_query_schema.rb

@@ -0,0 +1,37 @@
+require 'dry-validation'
+require 'pact_broker/api/contracts/dry_validation_workarounds'
+require 'pact_broker/api/contracts/dry_validation_predicates'
+
+module PactBroker
+  module Api
+    module Contracts
+      class VerifiablePactsQuerySchema
+        extend DryValidationWorkarounds
+        using PactBroker::HashRefinements
+
+        SCHEMA = Dry::Validation.Schema do
+          configure do
+            predicates(DryValidationPredicates)
+            config.messages_file = File.expand_path("../../../locale/en.yml", __FILE__)
+          end
+          optional(:provider_version_tags).maybe(:array?)
+          optional(:consumer_version_selectors).each do
+            schema do
+              required(:tag).filled(:str?)
+              optional(:latest).filled(included_in?: ["true", "false"])
+              optional(:fallback_tag).filled(:str?)
+              optional(:consumer).filled(:str?, :not_blank?)
+            end
+          end
+          optional(:include_pending_status).filled(included_in?: ["true", "false"])
+          optional(:include_wip_pacts_since).filled(:date?)
+        end
+
+        def self.call(params)
+          select_first_message(flatten_indexed_messages(SCHEMA.call(params&.symbolize_keys).messages(full: true)))
+        end
+
+      end
+    end
+  end
+end

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

@@ -14,14 +14,14 @@ module PactBroker
 
           property :pending,
             if: ->(context) { context[:options][:user_options][:include_pending_status] }
-          property :wip, if: -> (context) { context[:represented].wip }
-
-          property :notices, getter: -> (context) { context[:decorator].notices(context[:options][:user_options]) }
-          property :noteToDevelopers, getter: -> (_) { "Please print out the text from the 'notices' rather than using the inclusionReason and the pendingReason fields. These will be removed when this API moves out of beta."}
+          property :wip,
+            if: -> (context) { context[:represented].wip }
+          property :notices,
+            getter: -> (context) { context[:decorator].notices(context[:options][:user_options]) }
 
           def notices(user_options)
             pact_url = pact_version_url(represented, user_options[:base_url])
-            PactBroker::Pacts::BuildVerifiablePactNotices.call(represented, pact_url, include_pending_status: user_options[:include_pending_status])
+            PactBroker::Pacts::BuildVerifiablePactNotices.call(represented, pact_url, user_options)
           end
         end
 

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

@@ -46,7 +46,7 @@ module PactBroker
         end
 
         def policy_name
-          :'webhooks::webooks'
+          :'webhooks::webhooks'
         end
 
         private

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

@@ -1,5 +1,6 @@
 require 'pact_broker/api/resources/provider_pacts'
 require 'pact_broker/api/decorators/verifiable_pacts_decorator'
+require 'pact_broker/api/contracts/verifiable_pacts_query_schema'
 require 'pact_broker/api/decorators/verifiable_pacts_query_decorator'
 require 'pact_broker/api/contracts/verifiable_pacts_json_query_schema'
 require 'pact_broker/hash_refinements'
@@ -11,7 +12,7 @@ module PactBroker
         using PactBroker::HashRefinements
 
         def allowed_methods
-          ["POST", "OPTIONS"]
+          ["GET", "POST", "OPTIONS"]
         end
 
         def content_types_accepted
@@ -51,11 +52,21 @@ module PactBroker
         end
 
         def to_json
-          PactBroker::Api::Decorators::VerifiablePactsDecorator.new(pacts).to_json(to_json_options)
+          PactBroker::Api::Decorators::VerifiablePactsDecorator.new(pacts).to_json(
+            decorator_options(
+              include_pending_status: parsed_query_params.include_pending_status,
+              title: "Pacts to be verified by provider #{provider_name}",
+              deprecated: request.get?
+            )
+          )
         end
 
         def query_schema
-          PactBroker::Api::Contracts::VerifiablePactsJSONQuerySchema
+          if request.get?
+            PactBroker::Api::Contracts::VerifiablePactsQuerySchema
+          else
+            PactBroker::Api::Contracts::VerifiablePactsJSONQuerySchema
+          end
         end
 
         def parsed_query_params
@@ -71,10 +82,6 @@ module PactBroker
             end
           end
         end
-
-        def to_json_options
-          super.deep_merge(user_options: { include_pending_status: parsed_query_params.include_pending_status })
-        end
       end
     end
   end

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

@@ -32,7 +32,7 @@ module PactBroker
         end
 
         def policy_name
-          :'pact::pacts'
+          :'pacts::pacts'
         end
       end
     end

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

@@ -25,7 +25,7 @@ module PactBroker
         end
 
         def policy_name
-          :'webhook::webhook'
+          :'webhooks::webhook'
         end
 
         private

data/lib/pact_broker/app.rb

@@ -227,7 +227,7 @@ module PactBroker
 
     def configure_sucker_punch
       SuckerPunch.exception_handler = -> (ex, klass, args) do
-        PactBroker.log_error(ex, "Unhandled Suckerpunch error for #{klass}.perform(#{args.inspect})")
+        PactBroker.logger.warn("Unhandled Suckerpunch error for #{klass}.perform(#{args.inspect})", ex)
       end
     end
 

data/lib/pact_broker/badges/service.rb

@@ -100,7 +100,7 @@ module PactBroker
           logger.warn "Timeout retrieving badge from #{uri} #{e.class} - #{e.message}"
           nil
         rescue StandardError => e
-          log_error e, "Error retrieving badge from #{uri}"
+          logger.warn("Error retrieving badge from #{uri}", e)
           nil
         end
       end

data/lib/pact_broker/certificates/service.rb

@@ -18,7 +18,7 @@ module PactBroker
             logger.debug("Loading certificate #{certificate.subject} in to cert store")
             cert_store.add_cert(certificate)
           rescue StandardError => e
-            log_error e, "Error adding certificate object #{certificate.to_s} to store"
+            logger.warn("Error adding certificate object #{certificate.to_s} to store", e)
           end
         end
         cert_store
@@ -31,7 +31,7 @@ module PactBroker
             begin
               OpenSSL::X509::Certificate.new(c)
             rescue StandardError => e
-              log_error e, "Error creating certificate object from certificate #{certificate.uuid} '#{certificate.description}'"
+              logger.warn("Error creating certificate object from certificate #{certificate.uuid} '#{certificate.description}'", e)
               nil
             end
           end

data/lib/pact_broker/pacts/build_verifiable_pact_notices.rb

@@ -7,10 +7,13 @@ module PactBroker
       def self.call(verifiable_pact, pact_url, options)
         messages = VerifiablePactMessages.new(verifiable_pact, pact_url)
 
-        notices = [{
-          when: 'before_verification',
-          text: messages.inclusion_reason
-        }]
+        notices = []
+
+        if options[:deprecated]
+          append_notice(notices, 'before_verification', 'WARNING - this version of the Pact library uses a beta version of the API which will be removed in the future. Please upgrade your Pact library. See https://docs.pact.io/pact_broker/advanced_topics/provider_verification_results/#pacts-for-verification for minimum required versions.')
+        end
+
+        append_notice(notices, 'before_verification', messages.inclusion_reason)
 
         if options[:include_pending_status]
           append_notice(notices, 'before_verification', messages.pending_reason)

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.60.1'
+  VERSION = '2.61.0'
 end

data/lib/pact_broker/webhooks/service.rb

@@ -143,7 +143,7 @@ module PactBroker
             # Delay slightly to make sure the request transaction has finished before we execute the webhook
             Job.perform_in(5, job_data)
           rescue StandardError => e
-            log_error e
+            logger.warn("Error scheduling webhook execution for webhook with uuid #{webhook.uuid}", e)
           end
         end
       end

data/script/seed.rb

@@ -46,24 +46,46 @@ webhook_body = {
 
 PactBroker.configuration.base_equality_only_on_content_that_affects_verification_results = false
 
-  # .create_global_webhook(
-  #   method: 'POST',
-  #   url: "http://localhost:9292/pact-changed-webhook",
-  #   body: webhook_body.to_json,
-  #   username: "foo",
-  #   password: "bar")
-TestDataBuilder.new
-  .create_global_verification_succeeded_webhook(
-    method: 'POST',
-    url: "http://localhost:9292/verification-published-webhook",
-    body: webhook_body.to_json)
-  .set_now(Date.today - 101)
-  .create_pact_with_hierarchy("Foo/Foo", "100", "Bar/Bar")
-  .create_pact_with_hierarchy("Foo", "1", "Bar")
-  .create_pact_with_hierarchy("<script>alert('hello')</script>", "<script>alert(\"version\")</script>", "Bar/Bar")
-  .create_consumer_version_tag("prod")
-  .create_verification(provider_version: "1", tag_names: "prod")
+json_content = <<-HEREDOC
+{
+  "consumer": {
+    "name": "Foo"
+  },
+  "provider": {
+    "name": "Bar"
+  },
+  "interactions": [
+    {
+      "description": "a retrieve thing request",
+      "request": {
+        "method": "get",
+        "path": "/thing"
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": {
+          "name": "Thing 1"
+        }
+      }
+    }
+  ],
+  "metadata": {
+    "pactSpecification": {
+      "version": "2.0.0"
+    }
+  }
+}
+HEREDOC
 
+TestDataBuilder.new
+  .create_pact_with_hierarchy("Foo", "1", "Bar", json_content)
+  .create_consumer_version_tag("master")
+  .create_verification(provider_version: "1", tag_name: "master")
+  .create_pact_with_hierarchy("Foo", "2", "Bar", json_content.gsub("200", "201"))
+  .create_consumer_version_tag("feat/x")
 
   # .create_certificate(path: 'spec/fixtures/certificates/self-signed.badssl.com.pem')
   # .create_consumer("Bethtest")

data/spec/features/get_provider_pacts_for_verification_spec.rb

@@ -24,6 +24,28 @@ describe "Get provider pacts for verification" do
 
     let(:path) { "/pacts/provider/Provider/for-verification" }
 
+    context "when using GET" do
+      it "returns a 200 HAL JSON response" do
+        expect(subject).to be_a_hal_json_success_response
+      end
+
+      it "returns a list of links to the pacts" do
+        expect(pacts.size).to eq 1
+      end
+
+      it "returns a deprecation notice" do
+        expect(last_response_body[:_embedded][:pacts].first[:verificationProperties][:notices].first[:text]).to start_with("WARNING")
+      end
+
+      context "when the provider does not exist" do
+        let(:path) { "/pacts/provider/ProviderThatDoesNotExist/for-verification" }
+
+        it "returns a 404 response" do
+          expect(subject).to be_a_404_response
+        end
+      end
+    end
+
     context "when using POST" do
       let(:request_body) do
         {
@@ -44,6 +66,10 @@ describe "Get provider pacts for verification" do
         expect(pacts.size).to eq 1
       end
 
+      it "does not include a deprecation notice" do
+        expect(last_response_body[:_embedded][:pacts].first[:verificationProperties][:notices].first[:text]).to_not start_with("WARNING")
+      end
+
       context "when the provider does not exist" do
         let(:path) { "/pacts/provider/ProviderThatDoesNotExist/for-verification" }
 

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

@@ -0,0 +1,97 @@
+require 'pact_broker/api/contracts/verifiable_pacts_query_schema'
+
+module PactBroker
+  module Api
+    module Contracts
+      describe VerifiablePactsQuerySchema do
+        let(:params) do
+          {
+            provider_version_tags: provider_version_tags,
+            consumer_version_selectors: consumer_version_selectors
+          }
+        end
+
+        let(:provider_version_tags) { %w[master] }
+
+        let(:consumer_version_selectors) do
+          [{
+            tag: "master",
+            latest: "true"
+          }]
+        end
+
+        subject { VerifiablePactsQuerySchema.(params) }
+
+        context "when the params are valid" do
+          it "has no errors" do
+            expect(subject).to eq({})
+          end
+        end
+
+        context "when provider_version_tags is not an array" do
+          let(:provider_version_tags) { "foo" }
+
+          it { is_expected.to have_key(:provider_version_tags) }
+        end
+
+        context "when the consumer_version_selector is missing a tag" do
+          let(:consumer_version_selectors) do
+            [{}]
+          end
+
+          it "flattens the messages" do
+            expect(subject[:consumer_version_selectors].first).to eq "tag is missing at index 0"
+          end
+        end
+
+        context "when the consumer_version_selectors is missing the latest" do
+          let(:consumer_version_selectors) do
+            [{
+              tag: "master"
+            }]
+          end
+
+          it { is_expected.to be_empty }
+        end
+
+        context "when include_wip_pacts_since key exists" do
+          let(:include_wip_pacts_since) { nil }
+          let(:params) do
+            {
+              include_wip_pacts_since: include_wip_pacts_since
+            }
+          end
+
+          context "when it is nil" do
+            it { is_expected.to have_key(:include_wip_pacts_since) }
+          end
+
+          context "when it is not a date" do
+            let(:include_wip_pacts_since) { "foo" }
+
+            it { is_expected.to have_key(:include_wip_pacts_since) }
+          end
+
+          context "when it is a valid date" do
+            let(:include_wip_pacts_since) { "2013-02-13T20:04:45.000+11:00" }
+
+            it { is_expected.to_not have_key(:include_wip_pacts_since) }
+          end
+        end
+
+        context "when a blank consumer name is specified" do
+          let(:consumer_version_selectors) do
+            [{
+              tag: "feat-x",
+              consumer: ""
+            }]
+          end
+
+          it "has an error" do
+            expect(subject[:consumer_version_selectors].first).to include "blank"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/api/resources/default_base_resource_spec.rb

@@ -155,7 +155,6 @@ module PactBroker
 
           it "has a policy_name method" do
             expect(resource).to respond_to(:policy_name)
-            puts resource.policy_name
           end
         end
       end

data/spec/lib/pact_broker/api/resources/provider_pacts_for_verification_spec.rb

@@ -23,7 +23,35 @@ module PactBroker
           }
         end
 
-        subject { post(path, request_body.to_json, request_headers) }
+        subject { get(path, query) }
+
+        describe "GET" do
+          it "finds the pacts for verification by the provider" do
+            # Naughty not mocking out the query parsing...
+            expect(PactBroker::Pacts::Service).to receive(:find_for_verification).with(
+              "Bar",
+              ["master"],
+              PactBroker::Pacts::Selectors.new([PactBroker::Pacts::Selector.latest_for_tag("dev")]),
+              {
+                include_wip_pacts_since: DateTime.parse('2018-01-01'),
+                include_pending_status: true
+              }
+            )
+            subject
+          end
+
+          context "when there are validation errors" do
+            let(:query) do
+              {
+                provider_version_tags: true,
+              }
+            end
+
+            it "returns the keys with the right case" do
+              expect(JSON.parse(subject.body)['errors']).to have_key('provider_version_tags')
+            end
+          end
+        end
 
         describe "POST" do
           let(:request_body) do
@@ -42,6 +70,8 @@ module PactBroker
             }
           end
 
+          subject { post(path, request_body.to_json, request_headers) }
+
           it "finds the pacts for verification by the provider" do
             # Naughty not mocking out the query parsing...
             expect(PactBroker::Pacts::Service).to receive(:find_for_verification).with(
@@ -67,14 +97,14 @@ module PactBroker
               expect(JSON.parse(subject.body)['errors']).to have_key('providerVersionTags')
             end
           end
+        end
 
-          it "uses the correct options for the decorator" do
-            expect(decorator).to receive(:to_json) do | options |
-              expect(options[:user_options][:title]).to eq "Pacts to be verified by provider Bar"
-              expect(options[:user_options][:include_pending_status]).to eq true
-            end
-            subject
+        it "uses the correct options for the decorator" do
+          expect(decorator).to receive(:to_json) do | options |
+            expect(options[:user_options][:title]).to eq "Pacts to be verified by provider Bar"
+            expect(options[:user_options][:include_pending_status]).to eq true
           end
+          subject
         end
       end
     end

data/spec/lib/pact_broker/badges/service_spec.rb

@@ -286,7 +286,7 @@ module PactBroker
           end
 
           it "logs the error" do
-            expect(logger).to receive(:error).with(/Error retrieving badge from.*shield.*an error/)
+            expect(logger).to receive(:warn).with(/Error retrieving badge from.*shield.*/, RuntimeError)
             subject
           end
 

data/spec/lib/pact_broker/certificates/service_spec.rb

@@ -30,8 +30,8 @@ module PactBroker
           it "logs the error" do
             subject
 
-            expect(logger).to have_received(:error)
-              .with(/Error adding certificate/).at_least(1).times
+            expect(logger).to have_received(:warn)
+              .with(/Error adding certificate/, StandardError).at_least(1).times
           end
 
           it "returns an OpenSSL::X509::Store" do
@@ -66,7 +66,7 @@ module PactBroker
           let(:certificate_content) { File.read('spec/fixtures/certificate-invalid.pem') }
 
           it "logs an error" do
-            expect(logger).to receive(:error).with(/Error.*1234/)
+            expect(logger).to receive(:warn).with(/Error.*1234/, StandardError)
             subject
           end
 

data/spec/lib/pact_broker/webhooks/service_spec.rb

@@ -233,8 +233,8 @@ module PactBroker
           end
 
           it "logs the error" do
-            allow(Service.logger).to receive(:error)
-            expect(Service.logger).to receive(:error).with(/an error/)
+            allow(Service.logger).to receive(:warn)
+            expect(Service.logger).to receive(:warn).with(/Error scheduling/, StandardError)
             subject
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.60.1
+  version: 2.61.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -581,6 +581,7 @@ files:
 - lib/pact_broker/api/contracts/put_pact_params_contract.rb
 - lib/pact_broker/api/contracts/request_validations.rb
 - lib/pact_broker/api/contracts/verifiable_pacts_json_query_schema.rb
+- lib/pact_broker/api/contracts/verifiable_pacts_query_schema.rb
 - lib/pact_broker/api/contracts/verification_contract.rb
 - lib/pact_broker/api/contracts/webhook_contract.rb
 - lib/pact_broker/api/decorators.rb
@@ -1120,6 +1121,7 @@ files:
 - spec/lib/pact/doc/markdown/index_renderer_spec.rb
 - spec/lib/pact_broker/api/contracts/put_pact_params_contract_spec.rb
 - spec/lib/pact_broker/api/contracts/verifiable_pacts_json_query_schema_spec.rb
+- spec/lib/pact_broker/api/contracts/verifiable_pacts_query_schema_spec.rb
 - spec/lib/pact_broker/api/contracts/verification_contract_spec.rb
 - spec/lib/pact_broker/api/contracts/webhook_contract_spec.rb
 - spec/lib/pact_broker/api/decorators/dashboard_decorator_spec.rb
@@ -1505,6 +1507,7 @@ test_files:
 - spec/lib/pact/doc/markdown/index_renderer_spec.rb
 - spec/lib/pact_broker/api/contracts/put_pact_params_contract_spec.rb
 - spec/lib/pact_broker/api/contracts/verifiable_pacts_json_query_schema_spec.rb
+- spec/lib/pact_broker/api/contracts/verifiable_pacts_query_schema_spec.rb
 - spec/lib/pact_broker/api/contracts/verification_contract_spec.rb
 - spec/lib/pact_broker/api/contracts/webhook_contract_spec.rb
 - spec/lib/pact_broker/api/decorators/dashboard_decorator_spec.rb