pact_broker 2.4.2 → 2.5.0

data/lib/pact_broker/webhooks/service.rb

@@ -3,12 +3,17 @@ require 'pact_broker/logging'
 require 'pact_broker/webhooks/job'
 require 'base64'
 require 'securerandom'
+require 'pact_broker/webhooks/triggered_webhook'
+require 'pact_broker/webhooks/status'
 
 module PactBroker
 
   module Webhooks
     class Service
 
+      PUBLICATION = PactBroker::Webhooks::TriggeredWebhook::TRIGGER_TYPE_PUBLICATION
+      USER = PactBroker::Webhooks::TriggeredWebhook::TRIGGER_TYPE_USER
+
       extend Repositories
       include Logging
 
@@ -30,25 +35,50 @@ module PactBroker
         webhook_repository.find_by_uuid uuid
       end
 
+      def self.update_by_uuid uuid, webhook
+        webhook_repository.update_by_uuid uuid, webhook
+      end
+
       def self.delete_by_uuid uuid
-        webhook_repository.unlink_executions_by_webhook_uuid uuid
+        webhook_repository.unlink_triggered_webhooks_by_webhook_uuid uuid
         webhook_repository.delete_by_uuid uuid
       end
 
-      def self.delete_by_pacticipant pacticipant
+      def self.delete_all_webhhook_related_objects_by_pacticipant pacticipant
+        webhook_repository.delete_executions_by_pacticipant pacticipant
+        webhook_repository.delete_triggered_webhooks_by_pacticipant pacticipant
         webhook_repository.delete_by_pacticipant pacticipant
       end
 
+      def self.delete_all_webhook_related_objects_by_pact_publication_ids pact_publication_ids
+        webhook_repository.delete_triggered_webhooks_by_pact_publication_ids pact_publication_ids
+      end
+
       def self.find_all
         webhook_repository.find_all
       end
 
-      def self.execute_webhook_now webhook
-        webhook_execution_result = webhook.execute
-        webhook_repository.create_execution webhook, webhook_execution_result
+      def self.execute_webhook_now webhook, pact
+        triggered_webhook = webhook_repository.create_triggered_webhook(next_uuid, webhook, pact, USER)
+        webhook_execution_result = execute_triggered_webhook_now triggered_webhook, failure_log_message: "Webhook execution failed"
+        if webhook_execution_result.success?
+          webhook_repository.update_triggered_webhook_status triggered_webhook, TriggeredWebhook::STATUS_SUCCESS
+        else
+          webhook_repository.update_triggered_webhook_status triggered_webhook, TriggeredWebhook::STATUS_FAILURE
+        end
+        webhook_execution_result
+      end
+
+      def self.execute_triggered_webhook_now triggered_webhook, options
+        webhook_execution_result = triggered_webhook.execute options
+        webhook_repository.create_execution triggered_webhook, webhook_execution_result
         webhook_execution_result
       end
 
+      def self.update_triggered_webhook_status triggered_webhook, status
+        webhook_repository.update_triggered_webhook_status triggered_webhook, status
+      end
+
       def self.find_by_consumer_and_provider consumer, provider
         webhook_repository.find_by_consumer_and_provider consumer, provider
       end
@@ -57,22 +87,32 @@ module PactBroker
         webhooks = webhook_repository.find_by_consumer_and_provider pact.consumer, pact.provider
 
         if webhooks.any?
-          run_later(webhooks)
+          run_later(webhooks, pact)
         else
           logger.debug "No webhook found for consumer \"#{pact.consumer.name}\" and provider \"#{pact.provider.name}\""
         end
       end
 
-      def self.run_later webhooks
+      def self.run_later webhooks, pact
+        trigger_uuid = next_uuid
         webhooks.each do | webhook |
           begin
+            triggered_webhook = webhook_repository.create_triggered_webhook(trigger_uuid, webhook, pact, PUBLICATION)
             logger.info "Scheduling job for #{webhook.description} with uuid #{webhook.uuid}"
-            Job.perform_async webhook: webhook
+            Job.perform_async triggered_webhook: triggered_webhook
           rescue StandardError => e
             log_error e
           end
         end
       end
+
+      def self.find_latest_triggered_webhooks consumer, provider
+        webhook_repository.find_latest_triggered_webhooks consumer, provider
+      end
+
+      def self.fail_retrying_triggered_webhooks
+        webhook_repository.fail_retrying_triggered_webhooks
+      end
     end
   end
 end

data/lib/pact_broker/webhooks/status.rb

@@ -0,0 +1,29 @@
+module PactBroker
+  module Webhooks
+    class Status
+
+      def initialize pact, webhooks, latest_triggered_webhooks
+        @webhooks = webhooks
+        @latest_triggered_webhooks = latest_triggered_webhooks
+      end
+
+      def to_s
+        to_sym.to_s
+      end
+
+      def to_sym
+        return :none if webhooks.empty?
+        return :not_run if latest_triggered_webhooks.empty?
+        if latest_triggered_webhooks.any?{|w| w.status == "retrying" }
+          return :retrying
+        end
+        latest_triggered_webhooks.all?{|w| w.status == "success"} ? :success : :failure
+      end
+
+      private
+
+      attr_reader :webhooks, :latest_triggered_webhooks
+
+    end
+  end
+end

data/lib/pact_broker/webhooks/triggered_webhook.rb

@@ -0,0 +1,96 @@
+require 'sequel'
+require 'pact_broker/repositories/helpers'
+require 'pact_broker/webhooks/execution'
+
+module PactBroker
+  module Webhooks
+    class TriggeredWebhook < Sequel::Model(:triggered_webhooks)
+
+      TRIGGER_TYPE_PUBLICATION = 'pact_publication'
+      TRIGGER_TYPE_USER = 'user'
+
+      STATUS_NOT_RUN = 'not_run'.freeze
+      STATUS_RETRYING = 'retrying'.freeze
+      STATUS_SUCCESS = 'success'.freeze
+      STATUS_FAILURE = 'failure'.freeze
+
+      dataset_module do
+        include PactBroker::Repositories::Helpers
+
+        def retrying
+          where(status: STATUS_RETRYING)
+        end
+
+        def successful
+          where(status: STATUS_SUCCESS)
+        end
+
+        def failed
+          where(status: STATUS_FAILURE)
+        end
+
+        def not_run
+          where(status: STATUS_NOT_RUN)
+        end
+      end
+
+      associate(:one_to_many, :webhook_executions, :class => "PactBroker::Webhooks::Execution", :key => :triggered_webhook_id, :primary_key => :id, :order => :id)
+      associate(:many_to_one, :webhook, :class => "PactBroker::Webhooks::Webhook", :key => :webhook_id, :primary_key => :id)
+      associate(:many_to_one, :pact_publication, :class => "PactBroker::Pacts::PactPublication", :key => :pact_publication_id, :primary_key => :id)
+      associate(:many_to_one, :provider, :class => "PactBroker::Domain::Pacticipant", :key => :provider_id, :primary_key => :id)
+      associate(:many_to_one, :consumer, :class => "PactBroker::Domain::Pacticipant", :key => :consumer_id, :primary_key => :id)
+
+
+      def request_description
+        webhook.to_domain.request_description
+      end
+
+      def execute options
+        webhook.to_domain.execute options
+      end
+
+      def consumer_name
+        consumer && consumer.name
+      end
+
+      def provider_name
+        provider && provider.name
+      end
+
+      def success?
+        status == STATUS_SUCCESS
+      end
+
+      def failure?
+        status == STATUS_FAILURE
+      end
+
+      def retrying?
+        status == STATUS_RETRYING
+      end
+
+      def not_run?
+        status == STATUS_NOT_RUN
+      end
+
+      def number_of_attempts_made
+        webhook_executions.size
+      end
+
+      def finished?
+        success? || failure?
+      end
+
+      def number_of_attempts_remaining
+        if finished?
+          0
+        else
+          (PactBroker.configuration.webhook_retry_schedule.size + 1) - number_of_attempts_made
+        end
+      end
+    end
+
+    TriggeredWebhook.plugin :timestamps, update_on_create: true
+
+  end
+end

data/lib/pact_broker/webhooks/webhook.rb

@@ -15,16 +15,13 @@ module PactBroker
         WebhookHeader.where(webhook_id: id).destroy
       end
 
+      def update_from_domain webhook
+        set(self.class.properties_hash_from_domain(webhook))
+      end
+
       def self.from_domain webhook, consumer, provider
-        is_json_request_body = !(String === webhook.request.body || webhook.request.body.nil?) # Can't rely on people to set content type
         new(
-          uuid: webhook.uuid,
-          method: webhook.request.method,
-          url: webhook.request.url,
-          username: webhook.request.username,
-          password: not_plain_text_password(webhook.request.password),
-          body: (is_json_request_body ? webhook.request.body.to_json : webhook.request.body),
-          is_json_request_body: is_json_request_body
+          properties_hash_from_domain(webhook).merge(uuid: webhook.uuid)
         ).tap do | db_webhook |
           db_webhook.consumer_id = consumer.id
           db_webhook.provider_id = provider.id
@@ -67,6 +64,20 @@ module PactBroker
         end
       end
 
+      private
+
+      def self.properties_hash_from_domain webhook
+        is_json_request_body = !(String === webhook.request.body || webhook.request.body.nil?) # Can't rely on people to set content type
+        {
+          method: webhook.request.method,
+          url: webhook.request.url,
+          username: webhook.request.username,
+          password: not_plain_text_password(webhook.request.password),
+          body: (is_json_request_body ? webhook.request.body.to_json : webhook.request.body),
+          is_json_request_body: is_json_request_body
+        }
+      end
+
     end
 
     Webhook.plugin :timestamps, :update_on_create=>true

data/lib/rack/pact_broker/database_transaction.rb

@@ -1,4 +1,4 @@
-require 'pact_broker/version'
+require 'pact_broker/constants'
 require 'sequel'
 
 module Rack
@@ -6,7 +6,7 @@ module Rack
     class DatabaseTransaction
 
       REQUEST_METHOD = "REQUEST_METHOD".freeze
-      TRANS_METHODS = %{POST PUT PATCH DELETE}.freeze
+      TRANS_METHODS = %w{POST PUT PATCH DELETE}.freeze
 
       def initialize app, database_connection
         @app = app
@@ -33,10 +33,16 @@ module Rack
         response = nil
         @database_connection.transaction do
           response = @app.call(env)
-          raise Sequel::Rollback if response.first == 500
+          if response.first == 500
+            raise Sequel::Rollback unless do_not_rollback?(response)
+          end
         end
         response
       end
+
+      def do_not_rollback? response
+        response[1].delete(::PactBroker::DO_NOT_ROLLBACK)
+      end
     end
   end
 end

data/pact_broker.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'reform', '~> 2.2'
   gem.add_runtime_dependency 'dry-validation', '~> 0.10.5'
   gem.add_runtime_dependency 'sequel', '~> 4.23'
-  gem.add_runtime_dependency 'webmachine', '1.4.0'
+  gem.add_runtime_dependency 'webmachine', '1.5.0'
   gem.add_runtime_dependency 'semver2', '~> 3.4.2'
   gem.add_runtime_dependency 'rack', '~>2.0'
   gem.add_runtime_dependency 'redcarpet', '>=3.3.2', '~>3.3'
@@ -39,7 +39,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'dry-types', '~> 0.10.3' # https://travis-ci.org/pact-foundation/pact_broker/jobs/249448621
 
   gem.add_development_dependency 'bundler-audit', '~>0.4'
-  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'sqlite3', '~>1.3'
   gem.add_development_dependency 'pry-byebug'
   gem.add_development_dependency 'rake', '~>10.0'
   gem.add_development_dependency 'fakefs', '~>0.4'
@@ -48,7 +48,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec', '~>3.0'
   gem.add_development_dependency 'rspec-its', '~>1.2'
   gem.add_development_dependency 'database_cleaner', '~>1.6'
-  gem.add_development_dependency 'pg'
+  gem.add_development_dependency 'pg', '~>0.21'
   gem.add_development_dependency 'conventional-changelog', '~>1.3'
 
 end

data/public/javascripts/pact.js

@@ -0,0 +1,5 @@
+$( document ).ready(function() {
+  $('.badge').click(function(){
+    $('.badge-markdown').toggle();
+  });
+});

data/public/stylesheets/pact.css

@@ -13,4 +13,17 @@ div.pact-metadata span.name {
 
 pre {
   font-size: 1em
-}
+}
+
+li.badge {
+  cursor: pointer;
+}
+
+li.badge > img {
+  cursor: pointer;
+  height: 20px;
+}
+
+div.badge-markdown {
+  background-color: #f8f8f8
+}

data/public/stylesheets/relationships.css

@@ -48,7 +48,6 @@ body { padding-top: 10px; }
 
 .consumer, .provider {
   text-align: center;
-  white-space: nowrap;
 }
 
 span.pact {

data/script/db-spec.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+set -e
+cd db/test/backwards_compatibility
+export BUNDLE_GEMFILE=$PWD/Gemfile
+bundle install
+bundle exec appraisal install
+bundle exec rake

data/script/seed.rb

@@ -10,19 +10,20 @@ require 'logger'
 DATABASE_CREDENTIALS = {logger: Logger.new($stdout), adapter: "sqlite", database: ARGV[0], :encoding => 'utf8'}
 connection = Sequel.connect(DATABASE_CREDENTIALS)
 connection.timezone = :utc
+require 'pact_broker/db'
+PactBroker::DB.connection = connection
 require 'pact_broker'
 require 'support/test_data_builder'
 
-def random_build
-  rand * 100
-end
 
-tables_to_clean = [:labels, :webhook_executions, :verifications, :pact_publications, :pact_versions, :pacts, :pact_version_contents, :tags, :versions, :webhook_headers, :webhooks, :pacticipants]
+tables_to_clean = [:labels, :webhook_executions, :triggered_webhooks, :verifications, :pact_publications, :pact_versions, :pacts, :pact_version_contents, :tags, :versions, :webhook_headers, :webhooks, :pacticipants]
 
 tables_to_clean.each do | table_name |
   connection[table_name].delete if connection.table_exists?(table_name)
 end
 
+
+
 class TestDataBuilder
   def method_missing *args
       self
@@ -52,7 +53,7 @@ TestDataBuilder.new
   .create_label("microservice")
   .create_provider("Bar")
   .create_label("microservice")
-  .create_webhook(method: 'GET', url: 'http://127.0.0.1:1234/')
+  .create_webhook(method: 'GET', url: 'http://localhost:9393/')
   .create_consumer_version("1.2.100")
   .publish_pact
   .create_verification(provider_version: "1.4.234", success: true, execution_date: DateTime.now - 15)
@@ -62,7 +63,7 @@ TestDataBuilder.new
   .create_consumer_version("1.2.102")
   .publish_pact(created_at: (Date.today - 7).to_datetime)
   .create_provider("Animals")
-  .create_webhook(method: 'GET', url: 'http://127.0.0.1:1234/')
+  .create_webhook(method: 'GET', url: 'http://localhost:9393/')
   .publish_pact(created_at: (Time.now - 140).to_datetime)
   .create_verification(provider_version: "2.0.366", execution_date: Date.today - 2) #changed
   .create_provider("Wiffles")
@@ -73,12 +74,16 @@ TestDataBuilder.new
   .publish_pact(created_at: (Date.today - 1).to_datetime)
   .create_consumer("The Android App")
   .create_provider("The back end")
-  .create_webhook(method: 'GET', url: 'http://127.0.0.1:1234/')
+  .create_webhook(method: 'GET', url: 'http://localhost:9393/')
   .create_consumer_version("1.2.106")
   .publish_pact
   .create_consumer("Some other app")
   .create_provider("A service")
-  .create_webhook(method: 'GET', url: 'http://127.0.0.1:1234/')
+  .create_webhook(method: 'GET', url: 'http://localhost:9393/')
+  .create_triggered_webhook(status: 'success')
+  .create_webhook_execution
+  .create_webhook(method: 'POST', url: 'http://foo:9393/')
+  .create_triggered_webhook(status: 'failure')
   .create_webhook_execution
   .create_consumer_version("1.2.106")
   .publish_pact(created_at: (Date.today - 26).to_datetime)

data/spec/features/create_webhook_spec.rb

@@ -3,7 +3,7 @@ require 'support/test_data_builder'
 describe "Creating a webhook" do
 
   before do
-    TestDataBuilder.new.create_pact_with_hierarchy("Some Consumer", "1", "Some Provider")
+    TestDataBuilder.new.create_pact_with_hierarchy("Some Consumer", "1", "Some Provider").and_return(:pact)
   end
 
   let(:path) { "/webhooks/provider/Some%20Provider/consumer/Some%20Consumer" }

data/spec/features/delete_pact_spec.rb

@@ -8,7 +8,11 @@ describe "Deleting a pact" do
 
   context "when the pact exists" do
     before do
-      TestDataBuilder.new.create_pact_with_hierarchy "A Consumer", "1.2.3", "A Provider"
+      TestDataBuilder.new
+        .create_pact_with_hierarchy("A Consumer", "1.2.3", "A Provider")
+        .create_webhook
+        .create_triggered_webhook
+        .create_deprecated_webhook_execution
     end
 
     it "deletes the pact" do

data/spec/features/delete_webhook_spec.rb

@@ -9,7 +9,8 @@ describe "Delete a webhook" do
       .create_provider
       .create_pact
       .create_webhook
-      .create_webhook_execution
+      .create_triggered_webhook
+      .create_deprecated_webhook_execution
       .and_return(:webhook)
   end
 

data/spec/features/edit_webhook_spec.rb

@@ -0,0 +1,61 @@
+require 'support/test_data_builder'
+
+describe "Creating a webhook" do
+
+  let(:td) { TestDataBuilder.new }
+
+  before do
+    td.create_pact_with_hierarchy("Some Consumer", "1", "Some Provider")
+      .create_webhook
+  end
+
+  let(:path) { "/webhooks/#{td.webhook.uuid}" }
+  let(:headers) { {'CONTENT_TYPE' => 'application/json'} }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
+  let(:webhook_json) do
+    h = load_json_fixture('webhook_valid.json')
+    h['request']['method'] = 'GET'
+    h.to_json
+  end
+
+  let(:reloaded_webhook) { PactBroker::Webhooks::Repository.new.find_by_uuid(td.webhook.uuid) }
+
+  subject { put path, webhook_json, headers; last_response }
+
+  context "with invalid attributes" do
+    let(:webhook_json) { '{}' }
+
+    it "returns a 400" do
+      subject
+      expect(last_response.status).to be 400
+    end
+
+    it "returns the validation errors" do
+      subject
+      expect(response_body[:errors]).to_not be_empty
+    end
+
+    it "does not update the webhook" do
+      expect(reloaded_webhook.request.method).to eq 'POST'
+    end
+  end
+
+  context "with valid attributes" do
+    let(:webhook_hash) { JSON.parse(webhook_json, symbolize_names: true) }
+
+    it "returns a 200 response" do
+      subject
+      expect(last_response.status).to be 200
+    end
+
+    it "returns a JSON Content Type" do
+      subject
+      expect(last_response.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
+    end
+
+    it "updates the webhook" do
+      subject
+      expect(reloaded_webhook.request.method).to eq 'GET'
+    end
+  end
+end

data/spec/features/execute_webhook_spec.rb

@@ -0,0 +1,73 @@
+require 'support/test_data_builder'
+require 'webmock/rspec'
+require 'rack/pact_broker/database_transaction'
+
+describe "Execute a webhook" do
+
+  let(:td) { TestDataBuilder.new }
+
+  before do
+    td.create_pact_with_hierarchy("Some Consumer", "1", "Some Provider")
+      .create_webhook(method: 'POST')
+  end
+
+  let(:path) { "/webhooks/#{td.webhook.uuid}/execute" }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
+
+  subject { post path; last_response }
+
+  context "when the execution is successful" do
+    let!(:request) do
+      stub_request(:post, /http/).to_return(:status => 200)
+    end
+
+    it "performs the HTTP request" do
+      subject
+      expect(request).to have_been_made
+    end
+
+    it "returns a 200 response" do
+      expect(subject.status).to be 200
+    end
+
+    it "saves a TriggeredWebhook" do
+      expect { subject }.to change { PactBroker::Webhooks::TriggeredWebhook.count }.by(1)
+    end
+
+    it "saves a WebhookExecution" do
+      expect { subject }.to change { PactBroker::Webhooks::Execution.count }.by(1)
+    end
+  end
+
+  context "when an error occurs", no_db_clean: true do
+    let(:app) { Rack::PactBroker::DatabaseTransaction.new(PactBroker::API, PactBroker::DB.connection) }
+
+    let!(:request) do
+      stub_request(:post, /http/).to_raise(Errno::ECONNREFUSED)
+    end
+
+    before do
+      PactBroker::Database.truncate
+      td.create_pact_with_hierarchy("Some Consumer", "1", "Some Provider")
+        .create_webhook(method: 'POST')
+    end
+
+    after do
+      PactBroker::Database.truncate
+    end
+
+    subject { post path; last_response }
+
+    it "returns a 500 response" do
+      expect(subject.status).to be 500
+    end
+
+    it "saves a TriggeredWebhook" do
+      expect { subject }.to change { PactBroker::Webhooks::TriggeredWebhook.count }.by(1)
+    end
+
+    it "saves a WebhookExecution" do
+      expect { subject }.to change { PactBroker::Webhooks::Execution.count }.by(1)
+    end
+  end
+end

data/spec/features/get_latest_pact_badge_spec.rb

@@ -3,7 +3,7 @@ require 'webmock/rspec'
 describe "get latest pact badge" do
 
   before do
-    PactBroker.configuration.enable_badge_resources = true
+    PactBroker.configuration.enable_public_badge_access = true
     TestDataBuilder.new
       .create_consumer('consumer')
       .create_provider('provider')

data/spec/features/get_latest_tagged_pact_badge_spec.rb

@@ -3,7 +3,7 @@ require 'webmock/rspec'
 describe "get latest tagged pact badge" do
 
   before do
-    PactBroker.configuration.enable_badge_resources = true
+    PactBroker.configuration.enable_public_badge_access = true
     PactBroker.configuration.shields_io_base_url = nil
     TestDataBuilder.new
       .create_consumer('consumer')

data/spec/features/get_latest_untagged_pact_badge_spec.rb

@@ -3,7 +3,7 @@ require 'webmock/rspec'
 describe "get latest untagged pact badge" do
 
   before do
-    PactBroker.configuration.enable_badge_resources = true
+    PactBroker.configuration.enable_public_badge_access = true
     PactBroker.configuration.shields_io_base_url = nil
     TestDataBuilder.new
       .create_consumer('consumer')

data/spec/features/get_pact_spec.rb

@@ -7,7 +7,7 @@ describe "retrieving a pact" do
     let(:path) { "/pacts/provider/a%20provider/consumer/a%20consumer/version/1.2.3A" }
 
     before do
-      TestDataBuilder.new.create_pact_with_hierarchy "A Consumer", "1.2.3a", "A Provider"
+      TestDataBuilder.new.create_pact_with_hierarchy("A Consumer", "1.2.3a", "A Provider").and_return(:pact)
     end
 
     context "when case sensitivity is turned on" do

data/spec/features/merge_pact_spec.rb

@@ -29,7 +29,7 @@ describe "Merging a pact" do
     let(:merged_pact_content) { load_fixture('a_consumer-a_provider-merged.json') }
 
     before do
-      TestDataBuilder.new.create_pact_with_hierarchy "A Consumer", "1.2.3", "A Provider", existing_pact_content
+      TestDataBuilder.new.create_pact_with_hierarchy("A Consumer", "1.2.3", "A Provider", existing_pact_content).and_return(:pact)
     end
 
     it "returns a 200 Success" do

data/spec/features/publish_pact_spec.rb

@@ -23,7 +23,7 @@ describe "Publishing a pact" do
   context "when a pact for this consumer version does exist" do
 
     before do
-      TestDataBuilder.new.create_pact_with_hierarchy "A Consumer", "1.2.3", "A Provider"
+      TestDataBuilder.new.create_pact_with_hierarchy("A Consumer", "1.2.3", "A Provider").and_return(:pact)
     end
 
     it "returns a 200 Success" do