pact_broker 1.18.0.beta.1 → 1.18.0

data/lib/pact_broker/webhooks/service.rb

@@ -1,6 +1,8 @@
 require 'pact_broker/repositories'
 require 'pact_broker/logging'
+require 'pact_broker/webhooks/job'
 require 'base64'
+require 'securerandom'
 
 module PactBroker
 
@@ -50,6 +52,7 @@ module PactBroker
 
       def self.execute_webhooks pact
         webhooks = webhook_repository.find_by_consumer_and_provider pact.consumer, pact.provider
+
         if webhooks.any?
           run_later(webhooks)
         else
@@ -57,15 +60,13 @@ module PactBroker
         end
       end
 
-      # TODO background job?
       def self.run_later webhooks
-        Thread.new do
-          webhooks.each do | webhook |
-            begin
-              webhook.execute
-            rescue StandardError => e
-              # Exceptions are already logged, no need to log again.
-            end
+        webhooks.each do | webhook |
+          begin
+            logger.info "Scheduling job for #{webhook.description} with uuid #{webhook.uuid}"
+            Job.perform_async webhook: webhook
+          rescue StandardError => e
+            log_error e
           end
         end
       end

data/lib/pact_broker/webhooks/webhook.rb

@@ -46,7 +46,7 @@ module PactBroker
       end
 
       def request_attributes
-        values.merge(headers: parsed_headers, body: parsed_body, password: plain_text_password)
+        values.merge(headers: parsed_headers, body: parsed_body, password: plain_text_password, uuid: uuid)
       end
 
       def plain_text_password

data/pact_broker.gemspec

@@ -35,9 +35,10 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'pact-support', '~>0.4', '>=0.4.2'
   gem.add_runtime_dependency 'padrino-core', '~>0.12.4'
   gem.add_runtime_dependency 'haml', '~>4.0'
+  gem.add_runtime_dependency 'sucker_punch', '~>2.0'
 
   gem.add_development_dependency 'sqlite3'
-  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-byebug'
   gem.add_development_dependency 'rake', '~>10.0'
   gem.add_development_dependency 'fakefs', '~>0.4'
   gem.add_development_dependency 'mysql2', '~>0.3.15'

data/pact_broker_client-pact_broker.json

@@ -35,7 +35,7 @@
   },
   {
     "description": "a request to publish a pact",
-    "provider_state": "an error occurs while publishing a pact",
+    "providerState": "an error occurs while publishing a pact",
     "request": {
       "method": "put",
       "path": "/pacticipant/Condor/versions/1.3.0/pacts/Pricing%20Service",
@@ -72,7 +72,7 @@
   },
   {
     "description": "a request to retrieve the repository URL of the 'Pricing Service'",
-    "provider_state": "the 'Pricing Service' does not exist in the pact-broker",
+    "providerState": "the 'Pricing Service' does not exist in the pact-broker",
     "request": {
       "method": "get",
       "path": "/pacticipant/Pricing%20Service/repository_url",
@@ -90,7 +90,7 @@
 
     {
       "description": "a request to register the repository URL of a pacticipant",
-      "provider_state": "the 'Pricing Service' does not exist in the pact-broker",
+      "providerState": "the 'Pricing Service' does not exist in the pact-broker",
       "request": {
         "method": "patch",
         "path": "/pacticipant/Pricing%20Service",
@@ -108,7 +108,7 @@
     },
   {
     "description": "a request to retrieve the repository URL of the 'Pricing Service'",
-    "provider_state": "the 'Pricing Service' already exists in the pact-broker",
+    "providerState": "the 'Pricing Service' already exists in the pact-broker",
     "request": {
       "method": "get",
       "path": "/pacticipant/Pricing%20Service/repository_url",

data/script/foo-bar.json

@@ -0,0 +1,22 @@
+{
+  "consumer": {
+    "name": "Foo"
+  },
+  "provider": {
+    "name": "Bar"
+  },
+  "interactions": [
+    {
+      "description" : "a request for something",
+      "providerState": null,
+      "request": {
+        "method": "get",
+        "path" : "/something"
+      },
+      "response": {
+        "status": 200,
+        "body" : "something"
+      }
+    }
+  ]
+}

data/script/publish-new.sh

@@ -0,0 +1,7 @@
+# set -x
+BODY=$(ruby -e "require 'json'; j = JSON.parse(File.read('script/foo-bar.json')); j['interactions'][0]['providerState'] = 'it is ' + Time.now.to_s; puts j.to_json")
+echo ${BODY} >> tmp.json
+curl -v -XPUT \-H "Content-Type: application/json" \
+-d@tmp.json \
+http://127.0.0.1:9292/pacts/provider/Bar/consumer/Foo/version/1.0.0
+rm tmp.json

data/script/publish.sh

@@ -1,3 +1,3 @@
 curl -v -XPUT \-H "Content-Type: application/json" \
--d@spec/fixtures/a_consumer-a_provider.json \
-http://localhost:9292/pacts/provider/A%20Provider/consumer/A%20Consumer/version/1.0.0
+-d@script/foo-bar.json \
+http://127.0.0.1:9292/pacts/provider/Bar/consumer/Foo/version/1.0.0

data/script/recreate-pg-db.sh

@@ -0,0 +1,7 @@
+psql postgres -c "drop database pact_broker;"
+psql postgres -c "create database pact_broker;"
+psql postgres -c "GRANT ALL PRIVILEGES ON DATABASE pact_broker to pact_broker;"
+ip=$(ifconfig en0 | sed -n -e '/inet/s/.*inet \([0-9.]*\) netmask .*/\1/p')
+echo ""
+echo "run the following command to set your environment variables:"
+echo "export PACT_BROKER_DATABASE_HOST=${ip}"

data/spec/fixtures/a_consumer-a_provider-2.json

@@ -8,7 +8,7 @@
   "interactions": [
     {
       "description" : "a request for something",
-      "provider_state": null,
+      "providerState": null,
       "request": {
         "method": "post",
         "path" : "/something"

data/spec/fixtures/a_consumer-a_provider-3.json

@@ -8,7 +8,7 @@
   "interactions": [
     {
       "description" : "another request for something",
-      "provider_state": null,
+      "providerState": null,
       "request": {
         "method": "get",
         "path" : "/something_else"

data/spec/fixtures/a_consumer-a_provider-conflict.json

@@ -8,7 +8,7 @@
   "interactions": [
     {
       "description" : "a request for something",
-      "provider_state": null,
+      "providerState": null,
       "request": {
         "method": "post",
         "path" : "/something"

data/spec/fixtures/a_consumer-a_provider-merged.json

@@ -8,7 +8,7 @@
   "interactions": [
     {
       "description" : "a request for something",
-      "provider_state": null,
+      "providerState": null,
       "request": {
         "method": "get",
         "path" : "/something"
@@ -20,7 +20,7 @@
     },
     {
       "description" : "another request for something",
-      "provider_state": null,
+      "providerState": null,
       "request": {
         "method": "get",
         "path" : "/something_else"

data/spec/fixtures/a_consumer-a_provider.json

@@ -8,7 +8,7 @@
   "interactions": [
     {
       "description" : "a request for something",
-      "provider_state": null,
+      "providerState": null,
       "request": {
         "method": "get",
         "path" : "/something"

data/spec/fixtures/consumer-provider.json

@@ -8,7 +8,7 @@
   "interactions": [
     {
       "description" : "a request for something",
-      "provider_state": null,
+      "providerState": null,
       "request": {
         "method": "get",
         "path" : "/something",

data/spec/fixtures/renderer_pact.json

@@ -8,7 +8,7 @@
   "interactions": [
     {
       "description": "a request for alligators",
-      "provider_state": "alligators exist",
+      "providerState": "alligators exist",
       "request": {
         "method": "get",
         "path": "/alligators"

data/spec/lib/pact_broker/configuration_spec.rb

@@ -7,35 +7,15 @@ module PactBroker
 
     context "default configuration" do
       describe ".html_pact_renderer" do
+
         let(:pact) { double('pact') }
 
         it "calls the inbuilt HtmlPactRenderer" do
           expect(PactBroker::Api::Renderers::HtmlPactRenderer).to receive(:call).with(pact)
           PactBroker.configuration.html_pact_renderer.call pact
         end
-      end
-
-      describe "protect_with_basic_auth" do
-        let(:config) do
-          config = Configuration.new
-          config.protect_with_basic_auth [:foo, :bar], {some: 'credentials'}
-          config.protect_with_basic_auth :foo, {some: 'othercredentials'}
-          config
-        end
 
-        it "groups credentials by scope" do
-          expect(config.basic_auth_credentials_list_for(:foo)).to eq([{some: 'credentials'},{some: 'othercredentials'}])
-          expect(config.basic_auth_credentials_list_for(:bar)).to eq([{some: 'credentials'}])
-        end
-
-        describe "protect_with_basic_auth?" do
-          it "indicates whether a scope is protected" do
-            expect(config.protect_with_basic_auth?(:foo)).to be true
-            expect(config.protect_with_basic_auth?(:bar)).to be true
-            expect(config.protect_with_basic_auth?(:wiffle)).to be false
-          end
-        end
       end
     end
   end
-end
+end

data/spec/lib/pact_broker/domain/order_versions_spec.rb

@@ -4,20 +4,40 @@ require 'pact_broker/domain/order_versions.rb'
 
 describe PactBroker::Domain::OrderVersions do
 
+  context "when order_versions_by_date is false (the default)" do
+    before do
+      ProviderStateBuilder.new
+        .create_condor
+        .create_condor_version('1.3.0')
+        .create_condor_version('1.5.0')
+        .create_condor_version('1.4.0')
+        .create_condor_version('1.6.0')
+    end
 
-  before do
-    ProviderStateBuilder.new
-      .create_condor
-      .create_condor_version('1.3.0')
-      .create_condor_version('1.5.0')
-      .create_condor_version('1.4.0')
+    let(:ordered_versions) { PactBroker::Domain::Version.order(:order).all.collect(&:number) }
+    let(:condor) { PactBroker::Domain::Pacticipant.where(name: 'Condor').single_record }
+
+    it "orders the versions so they can be loaded from the database in order" do
+      expect(ordered_versions).to eq(['1.3.0', '1.4.0', '1.5.0', '1.6.0'])
+    end
   end
 
-  let(:ordered_versions) { PactBroker::Domain::Version.order(:order).all.collect(&:number) }
-  let(:condor) { PactBroker::Domain::Pacticipant.where(name: 'Condor').single_record }
+  context "when order_versions_by_date is true (not recommended)" do
+    before do
+      allow(PactBroker.configuration).to receive(:order_versions_by_date).and_return(true)
+    end
+    let(:consumer) { ProviderStateBuilder.new.create_consumer.and_return(:consumer) }
+    let!(:version_1) { PactBroker::Domain::Version.create(pacticipant_id: consumer.id, number: '2', created_at: DateTime.new(2017)) }
+    let!(:version_2) { PactBroker::Domain::Version.create(pacticipant_id: consumer.id, number: '1', created_at: DateTime.new(2017)) }
+    let!(:version_3) { PactBroker::Domain::Version.create(pacticipant_id: consumer.id, number: '3', created_at: DateTime.new(2016)) }
+    let!(:version_4) { PactBroker::Domain::Version.create(pacticipant_id: consumer.id, number: '4', created_at: DateTime.new(2018)) }
+
+    let(:ordered_versions) { PactBroker::Domain::Version.order(:order).all.collect(&:number) }
+
+    it "orders by date, then id" do
+      expect(ordered_versions).to eq(['3', '2', '1', '4'])
+    end
 
-  it "orders the versions so they can be loaded from the database in order" do
-    expect(ordered_versions).to eq(['1.3.0','1.4.0', '1.5.0'])
   end
 
 end

data/spec/lib/pact_broker/domain/webhook_request_spec.rb

@@ -64,7 +64,9 @@ module PactBroker
 
         it "logs the response" do
           allow(PactBroker.logger).to receive(:info)
-          expect(PactBroker.logger).to receive(:info).with(/response.*302.*respbod/)
+          allow(PactBroker.logger).to receive(:debug)
+          expect(PactBroker.logger).to receive(:info).with(/response.*302/)
+          expect(PactBroker.logger).to receive(:debug).with(/respbod/)
           subject.execute
         end
 

data/spec/lib/pact_broker/pacticipants/repository_spec.rb

@@ -53,6 +53,22 @@ module PactBroker
 
       end
 
+      describe "#find_all_pacticipant_versions_in_reverse_order" do
+        before do
+          ProviderStateBuilder.new
+            .create_consumer("Foo")
+            .create_consumer_version("1.2.3")
+            .create_consumer_version("4.5.6")
+            .create_consumer("Bar")
+            .create_consumer_version("8.9.0")
+        end
+
+        subject { Repository.new.find_all_pacticipant_versions_in_reverse_order "Foo" }
+
+        it "returns all the application versions for the given consumer" do
+          expect(subject.collect(&:number)).to eq ["4.5.6", "1.2.3"]
+        end
+      end
 
     end
   end

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

@@ -0,0 +1,67 @@
+require 'pact_broker/webhooks/job'
+
+module PactBroker
+  module Webhooks
+    describe Job do
+
+      before do
+        allow(PactBroker::Webhooks::Service).to receive(:execute_webhook_now)
+      end
+
+      let(:webhook) { double("webhook", uuid: '1234') }
+
+      context "when an error occurs for the first time" do
+        before do
+          allow(PactBroker::Webhooks::Service).to receive(:execute_webhook_now).and_raise("an error")
+        end
+
+        it "reschedules the job in 10 seconds" do
+          expect(Job).to receive(:perform_in).with(10, {webhook: webhook, error_count: 1})
+          Job.new.perform(webhook: webhook)
+        end
+      end
+
+      context "when the webhook execution result is not successful for the first time" do
+        before do
+          allow(PactBroker::Webhooks::Service).to receive(:execute_webhook_now).and_return(instance_double("PactBroker::Domain::WebhookExecutionResult", success?: false))
+        end
+
+        it "reschedules the job in 10 seconds" do
+          expect(Job).to receive(:perform_in).with(10, {webhook: webhook, error_count: 1})
+          Job.new.perform(webhook: webhook)
+        end
+      end
+
+      context "when an error occurs for the second time" do
+        before do
+          allow(PactBroker::Webhooks::Service).to receive(:execute_webhook_now).and_raise("an error")
+        end
+
+        it "reschedules the job in 60 seconds" do
+          expect(Job).to receive(:perform_in).with(60, {webhook: webhook, error_count: 2  })
+          Job.new.perform(webhook: webhook, error_count: 1)
+        end
+      end
+
+      context "when an error occurs for the last time" do
+        before do
+          allow(PactBroker::Webhooks::Service).to receive(:execute_webhook_now).and_raise("an error")
+        end
+
+        subject { Job.new.perform(webhook: webhook, error_count: 6) }
+
+        it "does not reschedule the job" do
+          expect(Job).to_not receive(:perform_in)
+          subject
+        end
+
+        it "logs that it has failed" do
+          allow(Job.logger).to receive(:error)
+          expect(Job.logger).to receive(:error).with(/Failed to execute/)
+          subject
+        end
+      end
+
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 require 'spec_helper'
 require 'pact_broker/webhooks/service'
+require 'webmock/rspec'
+require 'sucker_punch/testing/inline'
 
 module PactBroker
 
@@ -12,11 +14,11 @@ module PactBroker
         let(:consumer_version) { PactBroker::Domain::Version.new(number: '1.2.3') }
         let(:consumer) { PactBroker::Domain::Pacticipant.new(name: 'Consumer') }
         let(:provider) { PactBroker::Domain::Pacticipant.new(name: 'Provider') }
-        let(:webhooks) { [instance_double(PactBroker::Domain::Webhook)]}
+        let(:webhooks) { [instance_double(PactBroker::Domain::Webhook, description: 'description', uuid: '1244')]}
 
         before do
           allow_any_instance_of(PactBroker::Webhooks::Repository).to receive(:find_by_consumer_and_provider).and_return(webhooks)
-          allow(Service).to receive(:run_later)
+          allow(Job).to receive(:perform_async)
         end
 
         subject { Service.execute_webhooks pact }
@@ -45,7 +47,42 @@ module PactBroker
             subject
           end
         end
+
+        context "when there is a scheduling error" do
+          before do
+            allow(Job).to receive(:perform_async).and_raise("an error")
+          end
+
+          it "logs the error" do
+            allow(Service.logger).to receive(:error)
+            expect(Service.logger).to receive(:error).with(/an error/)
+            subject
+          end
+        end
+      end
+
+      describe ".execute_webhooks integration test" do
+        let!(:http_request) do
+          stub_request(:get, "http://example.org").
+            to_return(:status => 200)
+        end
+
+        let(:pact) do
+          ProviderStateBuilder.new
+            .create_consumer
+            .create_provider
+            .create_consumer_version
+            .create_pact
+            .create_webhook(method: 'GET', url: 'http://example.org')
+            .and_return(:pact)
+        end
+
+
+        it "executes the HTTP request of the webhook" do
+          PactBroker::Webhooks::Service.execute_webhooks pact
+          expect(http_request).to have_been_made
+        end
       end
     end
   end
-end
+end