pact_broker 2.61.0 → 2.62.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3495dd128672a4f4e614b7c60d93734cb3eee3799863af054963c503172d86f2
-  data.tar.gz: be415648babf90774ef011a0485835f386632768fb95b5a1f125ea9bddea2492
+  metadata.gz: 0d90410ba82c9f6ee8681073d1a9435660abf73045fa4ea08658294512771106
+  data.tar.gz: ff2c697fa385d574c26225ebf3aa6bb93276a749bfc6851685dc17728aa18fb0
 SHA512:
-  metadata.gz: aabedcd424d01dfa172424f99feac69d71ce2c55fe97f5c6b25dc1e29247168c14f0aa0d56c144c353a9444cd1cce99e14f7b677161f609ca829d00fdd2cf72c
-  data.tar.gz: a18db48c05cb2f3ae9ebc48b18673d45b4bafe19574633fef2d0ae6c21c2242a7b5cd80dab359eeccedb7044dcb1c2895b8290065fd4e7c7db5ba9c6686fefc4
+  metadata.gz: 95c87ab86bd54c472362e678a8fd6307637ad34059beb390baf59fa33456014ed47bd725940fe792ffd7151c80201baf9c063d670b7ed4c857708c22e60e352a
+  data.tar.gz: 3c101564948c497f80d286eccfd70cc92734c5a94b280825bd437c3a6ab4141caf7e98fefb6594b230d0021bba732c44704e9338df081c630d752f0bbb3140cc

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+<a name="v2.62.0"></a>
+### v2.62.0 (2020-09-23)
+
+#### Features
+
+* **webhooks**
+  * remove user-agent and accept-encoding headers which the Ruby HTTP library adds by default	 ([ef25b88c](/../../commit/ef25b88c))
+
+* add event name to triggered webhook	 ([ecce16fd](/../../commit/ecce16fd))
+
+#### Bug Fixes
+
+* **webhooks**
+  * use path to initialise http request, rather than full URL	 ([ecbac9a6](/../../commit/ecbac9a6))
+
+* gracefully handle corrupt webhook metadata in pact URL	 ([ba94c355](/../../commit/ba94c355))
+
 <a name="v2.61.0"></a>
 ### v2.61.0 (2020-09-12)
 

data/db/migrations/20200922_add_event_to_triggered_webhook.rb

@@ -0,0 +1,5 @@
+Sequel.migration do
+  change do
+    add_column(:triggered_webhooks, :event_name, String)
+  end
+end

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

@@ -9,6 +9,7 @@ module PactBroker
         property :number_of_attempts_made, as: :attemptsMade
         property :number_of_attempts_remaining, as: :attemptsRemaining
         property :trigger_type, as: :triggerType
+        property :event_name, as: :eventName
 
         property :created_at, as: :triggeredAt
 

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -1,11 +1,13 @@
 require 'erb'
 require 'pact_broker/pacts/metadata'
+require 'pact_broker/logging'
 
 module PactBroker
   module Api
     module PactBrokerUrls
 
       include PactBroker::Pacts::Metadata
+      include PactBroker::Logging
       # TODO make base_url the last and optional argument for all methods, defaulting to ''
 
       extend self
@@ -70,8 +72,13 @@ module PactBroker
 
       def decode_webhook_metadata(metadata)
         if metadata
-          Rack::Utils.parse_nested_query(Base64.strict_decode64(metadata)).each_with_object({}) do | (k, v), new_hash |
-            new_hash[k.to_sym] = v
+          begin
+            Rack::Utils.parse_nested_query(Base64.strict_decode64(metadata)).each_with_object({}) do | (k, v), new_hash |
+              new_hash[k.to_sym] = v
+            end
+          rescue StandardError => e
+            logger.warn("Exception parsing webhook metadata: #{metadata}", e)
+            {}
           end
         else
           {}

data/lib/pact_broker/configuration.rb

@@ -32,7 +32,12 @@ module PactBroker
       :base_equality_only_on_content_that_affects_verification_results,
       :seed_example_data,
       :badge_provider_mode,
-      :warning_error_class_names
+      :warning_error_class_names,
+      :base_url,
+      :log_dir,
+      :allow_missing_migration_files,
+      :auto_migrate_db_data,
+      :use_rack_protection
     ]
 
     attr_accessor :base_url, :log_dir, :database_connection, :auto_migrate_db, :auto_migrate_db_data, :allow_missing_migration_files, :example_data_seeder, :seed_example_data, :use_hal_browser, :html_pact_renderer, :use_rack_protection
@@ -129,6 +134,12 @@ module PactBroker
       @custom_logger = logger
     end
 
+    def log_configuration
+      SAVABLE_SETTING_NAMES.sort.each do | setting |
+        logger.info "PactBroker.configuration.#{setting}=#{PactBroker.configuration.send(setting).inspect}"
+      end
+    end
+
     def self.default_html_pact_render
       lambda { |pact, options|
         require 'pact_broker/api/renderers/html_pact_renderer'

data/lib/pact_broker/db.rb

@@ -3,6 +3,7 @@ require 'pact_broker/db/validate_encoding'
 require 'pact_broker/db/migrate'
 require 'pact_broker/db/migrate_data'
 require 'pact_broker/db/version'
+require 'pact_broker/db/table_dependency_calculator'
 
 Sequel.datetime_class = DateTime
 
@@ -31,6 +32,19 @@ module PactBroker
       Sequel::TimestampMigrator.is_current?(database_connection, PactBroker::DB::MIGRATIONS_DIR, options)
     end
 
+    def self.truncate database_connection, options = {}
+      exceptions = options[:except] || []
+      TableDependencyCalculator.call(database_connection).each do | table_name |
+        if !exceptions.include?(table_name)
+          begin
+            database_connection[table_name].truncate
+          rescue StandardError => e
+            puts "Could not truncate table #{table_name}"
+          end
+        end
+      end
+    end
+
     def self.version database_connection
       PactBroker::DB::Version.call(database_connection)
     end

data/lib/pact_broker/db/table_dependency_calculator.rb

@@ -0,0 +1,45 @@
+module PactBroker
+  module DB
+
+    # Returns a list of the tables in the database in the order in which
+    # they can be truncated or dropped
+    class TableDependencyCalculator
+
+      def self.call connection
+        new(connection).call
+      end
+
+      def initialize connection
+        @connection = connection
+      end
+
+      def call
+        ordered_table_names = []
+        dependencies = @connection
+          .tables
+          .collect{|it| @connection.foreign_key_list(it)
+          .collect{|fk| {from: it, to: fk[:table]} } }
+          .flatten
+          .uniq
+        table_names = @connection.tables - [:schema_migrations, :schema_info]
+        check(table_names, dependencies, ordered_table_names)
+        ordered_table_names
+      end
+
+      def deps_on table_name, deps
+        deps.select{ | d| d[:to] == table_name }.collect{ |d| d[:from] }
+      end
+
+      def check table_names, deps, ordered_table_names
+        return if table_names.size == 0
+        remaining_dependencies = deps_on(table_names.first, deps) - ordered_table_names
+        if remaining_dependencies.size == 0
+          ordered_table_names << table_names.first
+          check(table_names[1..-1], deps, ordered_table_names)
+        else
+          check((remaining_dependencies + table_names).uniq, deps, ordered_table_names)
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/domain/webhook_request.rb

@@ -59,7 +59,9 @@ module PactBroker
 
       def http_request
         @http_request ||= begin
-          req = Net::HTTP.const_get(method.capitalize).new(url)
+          req = Net::HTTP.const_get(method.capitalize).new(uri.request_uri)
+          req.delete("accept-encoding")
+          req.delete("user-agent")
           headers.each_pair { | name, value | req[name] = value }
           req.basic_auth(username, password) if username && username.size > 0
           req.body = body unless body.nil?

data/lib/pact_broker/test/test_data_builder.rb

@@ -294,7 +294,7 @@ module PactBroker
         params.delete(:comment)
         trigger_uuid = params[:trigger_uuid] || webhook_service.next_uuid
         verification = @webhook.trigger_on_provider_verification_published? ? @verification : nil
-        @triggered_webhook = webhook_repository.create_triggered_webhook trigger_uuid, @webhook, @pact, verification, PactBroker::Webhooks::Service::RESOURCE_CREATION
+        @triggered_webhook = webhook_repository.create_triggered_webhook trigger_uuid, @webhook, @pact, verification, PactBroker::Webhooks::Service::RESOURCE_CREATION, @webhook.events.first.name
         @triggered_webhook.update(status: params[:status]) if params[:status]
         set_created_at_if_set params[:created_at], :triggered_webhooks, {id: @triggered_webhook.id}
         self

data/lib/pact_broker/version.rb

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

data/lib/pact_broker/webhooks/repository.rb

@@ -101,7 +101,7 @@ module PactBroker
           .collect(&:to_domain)
       end
 
-      def create_triggered_webhook trigger_uuid, webhook, pact, verification, trigger_type
+      def create_triggered_webhook trigger_uuid, webhook, pact, verification, trigger_type, event_name
         db_webhook = Webhook.where(uuid: webhook.uuid).single_record
         TriggeredWebhook.create(
           status: TriggeredWebhook::STATUS_NOT_RUN,
@@ -112,7 +112,8 @@ module PactBroker
           trigger_uuid: trigger_uuid,
           trigger_type: trigger_type,
           consumer: pact.consumer,
-          provider: pact.provider
+          provider: pact.provider,
+          event_name: event_name
         )
       end
 

data/lib/pact_broker/webhooks/service.rb

@@ -136,7 +136,7 @@ module PactBroker
         trigger_uuid = next_uuid
         webhooks.each do | webhook |
           begin
-            triggered_webhook = webhook_repository.create_triggered_webhook(trigger_uuid, webhook, pact, verification, RESOURCE_CREATION)
+            triggered_webhook = webhook_repository.create_triggered_webhook(trigger_uuid, webhook, pact, verification, RESOURCE_CREATION, event_name)
             logger.info "Scheduling job for webhook with uuid #{webhook.uuid}"
             logger.debug "Schedule webhook with options #{options}"
             job_data = { triggered_webhook: triggered_webhook }.deep_merge(options)

data/lib/pact_broker/webhooks/triggered_webhook.rb

@@ -8,6 +8,7 @@ require 'pact_broker/webhooks/execution'
 module PactBroker
   module Webhooks
     class TriggeredWebhook < Sequel::Model(:triggered_webhooks)
+      plugin :timestamps, update_on_create: true
 
       TRIGGER_TYPE_RESOURCE_CREATION = 'resource_creation'
       TRIGGER_TYPE_USER = 'user'
@@ -95,9 +96,6 @@ module PactBroker
         end
       end
     end
-
-    TriggeredWebhook.plugin :timestamps, update_on_create: true
-
   end
 end
 

data/lib/pact_broker/webhooks/webhook_event.rb

@@ -4,6 +4,7 @@ require 'pact_broker/repositories/helpers'
 module PactBroker
   module Webhooks
     class WebhookEvent < Sequel::Model
+      plugin :timestamps, update_on_create: true
 
       CONTRACT_PUBLISHED = 'contract_published'
       CONTRACT_CONTENT_CHANGED = 'contract_content_changed'
@@ -38,8 +39,6 @@ module PactBroker
         name == VERIFICATION_FAILED
       end
     end
-
-    WebhookEvent.plugin :timestamps, update_on_create: true
   end
 end
 

data/spec/lib/pact_broker/api/decorators/pact_webhooks_status_decorator_spec.rb

@@ -22,7 +22,8 @@ module PactBroker
             number_of_attempts_made: 1,
             number_of_attempts_remaining: 2,
             created_at: DateTime.new(2017),
-            updated_at: DateTime.new(2017)
+            updated_at: DateTime.new(2017),
+            event_name: 'some_event'
           )
         end
 

data/spec/lib/pact_broker/api/decorators/triggered_webhook_decorator_spec.rb

@@ -7,6 +7,7 @@ module PactBroker
         let(:triggered_webhook) do
           double('PactBroker::Webhooks::TriggeredWebhook',
             trigger_type: PactBroker::Webhooks::TriggeredWebhook::TRIGGER_TYPE_RESOURCE_CREATION,
+            event_name: 'some_event',
             status: status,
             failure?: failure,
             retrying?: retrying,
@@ -55,7 +56,8 @@ module PactBroker
             status: 'success',
             triggerType: 'resource_creation',
             attemptsMade: 1,
-            attemptsRemaining: 2
+            attemptsRemaining: 2,
+            eventName: 'some_event'
           )
         end
       end

data/spec/lib/pact_broker/api/pact_broker_urls_spec.rb

@@ -3,6 +3,10 @@ require 'pact_broker/api/pact_broker_urls'
 module PactBroker
   module Api
     describe PactBrokerUrls do
+      before do
+        allow(PactBrokerUrls).to receive(:logger).and_return(logger)
+      end
+      let(:logger) { double('logger').as_null_object }
 
       # Regex find all the URL parameter names
       # \/\{[^\}\s\[\(\.]+\}
@@ -117,6 +121,17 @@ module PactBroker
             expect(PactBrokerUrls.decode_webhook_metadata(nil)).to eq({})
           end
         end
+
+        context "when the metadata is not valid base64" do
+          it "returns an empty hash" do
+            expect(PactBrokerUrls.decode_webhook_metadata("foo==,")).to eq({})
+          end
+
+          it "logs a warning" do
+            expect(logger).to receive(:warn).with("Exception parsing webhook metadata: foo==,", ArgumentError)
+            PactBrokerUrls.decode_webhook_metadata("foo==,")
+          end
+        end
       end
 
       describe "latest_verification_for_pact_url" do

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

@@ -386,7 +386,7 @@ module PactBroker
             .create_verification
         end
 
-        subject { Repository.new.create_triggered_webhook '1234', td.webhook, td.pact, td.verification, 'publication' }
+        subject { Repository.new.create_triggered_webhook '1234', td.webhook, td.pact, td.verification, 'publication', 'some_event' }
 
         it "creates a TriggeredWebhook" do
           expect(subject.webhook_uuid ).to eq td.webhook.uuid
@@ -395,6 +395,7 @@ module PactBroker
           expect(subject.verification).to eq td.verification
           expect(subject.trigger_uuid).to eq '1234'
           expect(subject.trigger_type).to eq 'publication'
+          expect(subject.event_name).to eq 'some_event'
         end
 
         it "sets the webhook" do
@@ -418,7 +419,7 @@ module PactBroker
         end
 
         context "without a verification" do
-          subject { Repository.new.create_triggered_webhook '1234', td.webhook, td.pact, nil, 'publication' }
+          subject { Repository.new.create_triggered_webhook '1234', td.webhook, td.pact, nil, 'publication', 'some_event' }
 
           it "does not set the verification" do
             expect(subject.verification).to be nil

data/tasks/database.rb

@@ -1,6 +1,7 @@
 require 'pact_broker/project_root'
 require 'pact_broker/db/migrate'
 require 'pact_broker/db/version'
+require 'pact_broker/db'
 require 'sequel'
 require 'yaml'
 require_relative 'database/table_dependency_calculator'

data/tasks/database/table_dependency_calculator.rb

@@ -1,45 +1,8 @@
+require 'pact_broker/db/table_dependency_calculator'
+
 module PactBroker
   module Database
-
-    # Returns a list of the tables in the database in the order in which
-    # they can be truncated or dropped
-    class TableDependencyCalculator
-
-      def self.call connection
-        new(connection).call
-      end
-
-      def initialize connection
-        @connection = connection
-      end
-
-      def call
-        ordered_table_names = []
-        dependencies = @connection
-          .tables
-          .collect{|it| @connection.foreign_key_list(it)
-          .collect{|fk| {from: it, to: fk[:table]} } }
-          .flatten
-          .uniq
-        table_names = @connection.tables - [:schema_migrations, :schema_info]
-        check(table_names, dependencies, ordered_table_names)
-        ordered_table_names
-      end
-
-      def deps_on table_name, deps
-        deps.select{ | d| d[:to] == table_name }.collect{ |d| d[:from] }
-      end
-
-      def check table_names, deps, ordered_table_names
-        return if table_names.size == 0
-        remaining_dependencies = deps_on(table_names.first, deps) - ordered_table_names
-        if remaining_dependencies.size == 0
-          ordered_table_names << table_names.first
-          check(table_names[1..-1], deps, ordered_table_names)
-        else
-          check((remaining_dependencies + table_names).uniq, deps, ordered_table_names)
-        end
-      end
-    end
+    # For backwards compatibility
+    TableDependencyCalculator = PactBroker::DB::TableDependencyCalculator
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.61.0
+  version: 2.62.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -517,6 +517,7 @@ files:
 - db/migrations/20191101_create_head_pact_tags.rb
 - db/migrations/20200318_add_created_at_to_latest_pact_publications.rb
 - db/migrations/20200319_add_created_at_to_latest_verifications.rb
+- db/migrations/20200922_add_event_to_triggered_webhook.rb
 - db/migrations/migration_helper.rb
 - db/test/backwards_compatibility/.rspec
 - db/test/backwards_compatibility/Appraisals
@@ -722,6 +723,7 @@ files:
 - lib/pact_broker/db/seed/pact_2.json
 - lib/pact_broker/db/seed/pact_3.json
 - lib/pact_broker/db/seed_example_data.rb
+- lib/pact_broker/db/table_dependency_calculator.rb
 - lib/pact_broker/db/validate_encoding.rb
 - lib/pact_broker/db/version.rb
 - lib/pact_broker/diagnostic/app.rb