pact_broker 2.32.0 → 2.33.0

data/lib/pact_broker/webhooks/repository.rb

@@ -19,9 +19,6 @@ module PactBroker
         db_webhook = Webhook.from_domain webhook, consumer, provider
         db_webhook.uuid = uuid
         db_webhook.save
-        webhook.request.headers.each_pair do | name, value |
-          db_webhook.add_header PactBroker::Webhooks::WebhookHeader.from_domain(name, value, db_webhook.id)
-        end
         (webhook.events || []).each do | webhook_event |
           db_webhook.add_event(webhook_event)
         end
@@ -34,14 +31,10 @@ module PactBroker
 
       def update_by_uuid uuid, webhook
         existing_webhook = Webhook.find(uuid: uuid)
-        existing_webhook.consumer_id = pacticipant_repository.find_by_name(webhook.consumer.name).id if webhook.consumer
-        existing_webhook.provider_id = pacticipant_repository.find_by_name(webhook.provider.name).id if webhook.provider
+        existing_webhook.consumer_id = webhook.consumer ? pacticipant_repository.find_by_name(webhook.consumer.name).id : nil
+        existing_webhook.provider_id = webhook.provider ? pacticipant_repository.find_by_name(webhook.provider.name).id : nil
         existing_webhook.update_from_domain(webhook).save
-        existing_webhook.headers.collect(&:delete)
         existing_webhook.events.collect(&:delete)
-        webhook.request.headers.each_pair do | name, value |
-          existing_webhook.add_header PactBroker::Webhooks::WebhookHeader.from_domain(name, value, existing_webhook.id)
-        end
         (webhook.events || []).each do | webhook_event |
           existing_webhook.add_event(webhook_event)
         end

data/lib/pact_broker/webhooks/service.rb

@@ -68,10 +68,10 @@ module PactBroker
       end
 
       def self.test_execution webhook, options
-        execution_options = options[:execution_options].merge(
+        logging_options = options[:logging_options].merge(
           failure_log_message: "Webhook execution failed",
         )
-        merged_options = options.merge(execution_options: execution_options)
+        merged_options = options.merge(logging_options: logging_options)
         verification = nil
         if webhook.trigger_on_provider_verification_published?
           verification = verification_service.search_for_latest(webhook.consumer_name, webhook.provider_name) || PactBroker::Verifications::PlaceholderVerification.new
@@ -84,8 +84,8 @@ module PactBroker
       # # TODO delete?
       # def self.execute_webhook_now webhook, pact, verification = nil
       #   triggered_webhook = webhook_repository.create_triggered_webhook(next_uuid, webhook, pact, verification, USER)
-      #   execution_options = { failure_log_message: "Webhook execution failed"}
-      #   webhook_execution_result = execute_triggered_webhook_now triggered_webhook, execution_options
+      #   logging_options = { failure_log_message: "Webhook execution failed"}
+      #   webhook_execution_result = execute_triggered_webhook_now triggered_webhook, logging_options
       #   if webhook_execution_result.success?
       #     webhook_repository.update_triggered_webhook_status triggered_webhook, TriggeredWebhook::STATUS_SUCCESS
       #   else
@@ -135,7 +135,7 @@ module PactBroker
             job_data = {
               triggered_webhook: triggered_webhook,
               webhook_context: options.fetch(:webhook_context),
-              execution_options: options.fetch(:execution_options),
+              logging_options: options.fetch(:logging_options),
               database_connector: options.fetch(:database_connector)
             }
             # Delay slightly to make sure the request transaction has finished before we execute the webhook

data/lib/pact_broker/webhooks/triggered_webhook.rb

@@ -104,7 +104,7 @@ end
 
 # Table: triggered_webhooks
 # Columns:
-#  id                  | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
+#  id                  | integer                     | PRIMARY KEY DEFAULT nextval('triggered_webhooks_id_seq'::regclass)
 #  trigger_uuid        | text                        | NOT NULL
 #  trigger_type        | text                        | NOT NULL
 #  pact_publication_id | integer                     | NOT NULL

data/lib/pact_broker/webhooks/webhook.rb

@@ -7,11 +7,12 @@ module PactBroker
   module Webhooks
     class Webhook < Sequel::Model
       set_primary_key :id
+      plugin :serialization, :json, :headers
+      plugin :timestamps, update_on_create: true
+
       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)
-
       one_to_many :events, :class => "PactBroker::Webhooks::WebhookEvent", :reciprocal => :webhook
-      one_to_many :headers, :class => "PactBroker::Webhooks::WebhookHeader", :reciprocal => :webhook
 
       dataset_module do
         include PactBroker::Repositories::Helpers
@@ -21,11 +22,6 @@ module PactBroker
         end
       end
 
-      def before_destroy
-        WebhookHeader.where(webhook_id: id).destroy
-        super
-      end
-
       def update_from_domain webhook
         set(self.class.properties_hash_from_domain(webhook))
       end
@@ -57,19 +53,13 @@ module PactBroker
       end
 
       def request_attributes
-        values.merge(headers: parsed_headers, body: parsed_body, password: plain_text_password, uuid: uuid)
+        values.merge(headers: headers, body: parsed_body, password: plain_text_password, uuid: uuid)
       end
 
       def plain_text_password
         password.nil? ? nil : Base64.strict_decode64(password)
       end
 
-      def parsed_headers
-        WebhookHeader.where(webhook_id: id).all.each_with_object({}) do | header, hash |
-          hash[header[:name]] = header[:value]
-        end
-      end
-
       def parsed_body
         if body && is_json_request_body
            JSON.parse(body)
@@ -94,30 +84,17 @@ module PactBroker
           password: not_plain_text_password(webhook.request.password),
           enabled: webhook.enabled.nil? ? true : webhook.enabled,
           body: (is_json_request_body ? webhook.request.body.to_json : webhook.request.body),
-          is_json_request_body: is_json_request_body
+          is_json_request_body: is_json_request_body,
+          headers: webhook.request.headers
         }
       end
     end
-
-    Webhook.plugin :timestamps, update_on_create: true
-
-    class WebhookHeader < Sequel::Model
-      associate(:many_to_one, :webhook, :class => "PactBroker::Repositories::Webhook", :key => :webhook_id, :primary_key => :id)
-
-      def self.from_domain name, value, webhook_id
-        db_header = new
-        db_header.name = name
-        db_header.value = value
-        db_header.webhook_id = webhook_id
-        db_header
-      end
-    end
   end
 end
 
 # Table: webhooks
 # Columns:
-#  id                   | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
+#  id                   | integer                     | PRIMARY KEY DEFAULT nextval('webhooks_id_seq'::regclass)
 #  uuid                 | text                        | NOT NULL
 #  method               | text                        | NOT NULL
 #  url                  | text                        | NOT NULL
@@ -129,6 +106,8 @@ end
 #  updated_at           | timestamp without time zone |
 #  username             | text                        |
 #  password             | text                        |
+#  enabled              | boolean                     | DEFAULT true
+#  description          | text                        |
 # Indexes:
 #  webhooks_pkey   | PRIMARY KEY btree (id)
 #  uq_webhook_uuid | UNIQUE btree (uuid)

data/lib/pact_broker/webhooks/webhook_event.rb

@@ -38,7 +38,7 @@ end
 
 # Table: webhook_events
 # Columns:
-#  id         | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
+#  id         | integer                     | PRIMARY KEY DEFAULT nextval('webhook_events_id_seq'::regclass)
 #  webhook_id | integer                     |
 #  name       | text                        |
 #  created_at | timestamp without time zone | NOT NULL

data/lib/pact_broker/{domain → webhooks}/webhook_execution_result.rb

@@ -1,12 +1,13 @@
-module PactBroker
-
-  module Domain
+require 'pact_broker/webhooks/http_request_with_redacted_headers'
+require 'pact_broker/webhooks/http_response_with_utf_8_safe_body'
 
+module PactBroker
+  module Webhooks
     class WebhookExecutionResult
 
       def initialize request, response, logs, error = nil
-        @request = request
-        @response = response
+        @request = PactBroker::Webhooks::HttpRequestWithRedactedHeaders.new(request)
+        @response = response ? PactBroker::Webhooks::HttpResponseWithUtf8SafeBody.new(response) : nil
         @logs = logs
         @error = error
       end

data/lib/pact_broker/webhooks/webhook_request_logger.rb

@@ -0,0 +1,105 @@
+require 'pact_broker/messages'
+require 'pact_broker/logging'
+require 'pact_broker/webhooks/http_request_with_redacted_headers'
+require 'pact_broker/webhooks/http_response_with_utf_8_safe_body'
+
+module PactBroker
+  module Webhooks
+    class WebhookRequestLogger
+      include PactBroker::Logging
+
+      attr_reader :execution_logger, :options
+
+      def initialize(options)
+        @log_stream = StringIO.new
+        @execution_logger = Logger.new(log_stream)
+        @options = options
+      end
+
+      def log(uuid, webhook_request, http_response, error)
+        safe_response = http_response ? HttpResponseWithUtf8SafeBody.new(http_response) : nil
+        log_request(webhook_request)
+        log_response(uuid, safe_response) if safe_response
+        log_error(uuid, error) if error
+        log_completion_message(success?(safe_response))
+        log_stream.string
+      end
+
+      private
+
+      attr_reader :log_stream
+
+      def log_request(webhook_request)
+        http_request = HttpRequestWithRedactedHeaders.new(webhook_request.http_request)
+        logger.info "Making webhook #{webhook_request.uuid} request #{http_request.method.upcase} URI=#{webhook_request.url} (headers and body in debug logs)"
+        logger.debug "Webhook #{webhook_request.uuid} request headers=#{http_request.to_hash}"
+        logger.debug "Webhook #{webhook_request.uuid} request body=#{http_request.body}"
+
+        execution_logger.info "HTTP/1.1 #{webhook_request.http_method.upcase} #{webhook_request.url}"
+        http_request.to_hash.each do | name, value |
+          execution_logger.info "#{name}: #{value.join(", ")}"
+        end
+        execution_logger.info(webhook_request.body) if webhook_request.body
+      end
+
+      def log_response uuid, response
+        log_response_to_application_logger(uuid, response)
+        if options.fetch(:show_response)
+          log_response_to_execution_logger(response)
+        else
+          execution_logger.info response_body_hidden_message
+        end
+      end
+
+      def response_body_hidden_message
+        PactBroker::Messages.message('messages.response_body_hidden')
+      end
+
+      def log_response_to_application_logger uuid, response
+        logger.info "Received response for webhook #{uuid} status=#{response.code} (headers and body in debug logs)"
+        logger.debug "Webhook #{uuid} response headers=#{response.to_hash} "
+        logger.debug "Webhook #{uuid} response body=#{response.unsafe_body}"
+      end
+
+      def log_response_to_execution_logger response
+        execution_logger.info "HTTP/#{response.http_version} #{response.code} #{response.message}"
+        response.each_header do | name, value |
+          execution_logger.info "#{name}: #{value}"
+        end
+
+        if response.body
+          if response.unsafe_body?
+            execution_logger.debug "Note that invalid UTF-8 byte sequences were removed from response body before saving the logs"
+          end
+          execution_logger.info response.body
+        end
+      end
+
+      def log_completion_message success
+        if options[:success_log_message] && success
+          execution_logger.info(options[:success_log_message])
+          logger.info(options[:success_log_message])
+        end
+
+        if options[:failure_log_message] && !success
+          execution_logger.info(options[:failure_log_message])
+          logger.info(options[:failure_log_message])
+        end
+      end
+
+      def log_error uuid, e
+        logger.info "Error executing webhook #{uuid} #{e.class.name} - #{e.message} #{e.backtrace.join("\n")}"
+
+        if options[:show_response]
+          execution_logger.error "Error executing webhook #{uuid} #{e.class.name} - #{e.message}"
+        else
+          execution_logger.error "Error executing webhook #{uuid}. #{response_body_hidden_message}"
+        end
+      end
+
+      def success?(response)
+        !response.nil? && response.code.to_i < 300
+      end
+    end
+  end
+end

data/lib/pact_broker/webhooks/webhook_request_template.rb

@@ -28,25 +28,26 @@ module PactBroker
       end
 
       def build(context)
+        template_params = PactBroker::Webhooks::PactAndVerificationParameters.new(context[:pact], context[:verification], context[:webhook_context]).to_hash
         attributes = {
           method: http_method,
-          url: build_url(context[:pact], context[:verification], context[:webhook_context]),
+          url: build_url(template_params),
           headers: headers,
           username: username,
           password: password,
           uuid: uuid,
-          body: build_body(context[:pact], context[:verification], context[:webhook_context])
+          body: build_body(template_params)
         }
         PactBroker::Domain::WebhookRequest.new(attributes)
       end
 
-      def build_url(pact, verification, webhook_context)
-        URI(PactBroker::Webhooks::Render.call(url, pact, verification, webhook_context){ | value | CGI::escape(value) if !value.nil? } ).to_s
+      def build_url(template_params)
+        URI(PactBroker::Webhooks::Render.call(url, template_params){ | value | CGI::escape(value) if !value.nil? } ).to_s
       end
 
-      def build_body(pact, verification, webhook_context)
+      def build_body(template_params)
         body_string = String === body ? body : body.to_json
-        PactBroker::Webhooks::Render.call(body_string, pact, verification, webhook_context)
+        PactBroker::Webhooks::Render.call(body_string, template_params)
       end
 
       def description

data/pact_broker.gemspec

@@ -81,4 +81,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'timecop', '~> 0.9'
   gem.add_development_dependency 'sequel-annotate', '~>1.3'
   gem.add_development_dependency 'faraday', '~>0.15'
+  gem.add_development_dependency 'docker-api', '~>1.34'
 end

data/script/docker/db-restore.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+: "${1:?Please specify file to restore}"
+
+docker exec -it pact-broker-postgres pg_restore -h localhost -U postgres -d postgres /data/$1

data/script/docker/db-rm.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+docker rm -f pact-broker-postgres

data/script/docker/db-start.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+docker run --name pact-broker-postgres \
+  -e POSTGRES_PASSWORD=postgres \
+  -p 5432:5432 \
+  -v $PWD:/data \
+  -d postgres:10

data/script/import-pg-database.sh

@@ -0,0 +1,5 @@
+# import
+echo "Importing database from ${export_file}"
+script/recreate-pg-db.sh
+local_connection_string="postgresql://pact_broker:pact_broker@localhost/pact_broker"
+psql $local_connection_string < "$1"

data/script/seed.rb

@@ -44,7 +44,7 @@ webhook_body = {
 }
 
 TestDataBuilder.new
-  .create_global_webhook(method: 'POST', url: "http://localhost:9292/pact-changed-webhook", body: webhook_body.to_json)
+  .create_global_webhook(method: 'POST', url: "http://localhost:9292/pact-changed-webhook", body: webhook_body.to_json, username: "foo", password: "bar")
   .create_global_verification_webhook(method: 'POST', url: "http://localhost:9292/verification-published-webhook", body: webhook_body.to_json)
   # .create_certificate(path: 'spec/fixtures/certificates/self-signed.badssl.com.pem')
   # .create_consumer("Bethtest")

data/spec/features/execute_webhook_spec.rb

@@ -22,7 +22,7 @@ describe "Execute a webhook" do
       stub_request(:post, /http/).with(body: expected_webhook_url).to_return(:status => 200, body: response_body)
     end
 
-    let(:expected_webhook_url) { %r{http://example.org/pacts/provider/Bar/consumer/Foo/pact-version/.*/metadata/Y29uc3VtZXJfdmVyc2lvbl9udW1iZXI9MQ==} }
+    let(:expected_webhook_url) { %r{http://example.org/pacts/provider/Bar/consumer/Foo/pact-version/.*/metadata/.*} }
     let(:response_body) { "webhook-response-body" }
 
     it "performs the HTTP request" do

data/spec/features/publish_verification_spec.rb

@@ -1,6 +1,6 @@
 require 'pact_broker/domain/verification'
 
-describe "Recording a pact verification" do
+describe "Publishing a pact verification" do
 
   let(:td) { TestDataBuilder.new }
   let(:path) { "/pacts/provider/Provider/consumer/Consumer/pact-version/#{pact.pact_version_sha}/verification-results" }

data/spec/integration/webhooks/certificate_spec.rb

@@ -22,13 +22,11 @@ describe "executing a webhook to a server with a self signed certificate" do
       url: 'https://localhost:4444/')
   end
 
-  let(:pact) { td.create_pact_with_hierarchy.and_return(:pact) }
-
-  subject { webhook_request.execute({ show_response: true }) }
+  subject { webhook_request.execute }
 
   context "without the correct cacert" do
     it "fails" do
-      expect(subject.success?).to be false
+      expect { subject }.to raise_error(OpenSSL::SSL::SSLError)
     end
   end
 
@@ -38,8 +36,8 @@ describe "executing a webhook to a server with a self signed certificate" do
     end
 
     it "succeeds" do
-      puts subject.error unless subject.success?
-      expect(subject.success?).to be true
+      puts subject.body unless subject.code == "200"
+      expect(subject.code).to eq "200"
     end
   end
 

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

@@ -8,7 +8,7 @@ module PactBroker
 
         describe "to_json" do
 
-          let(:webhook_execution_result) { PactBroker::Domain::WebhookExecutionResult.new(request, response, logs, error)}
+          let(:webhook_execution_result) { PactBroker::Webhooks::WebhookExecutionResult.new(request, response, logs, error)}
           let(:logs) { "logs" }
           let(:headers) { { "Something" => ["blah", "thing"]} }
           let(:request) do

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

@@ -80,7 +80,7 @@ module PactBroker
                 hash_including('some' => 'params'),
                 pact,
                 {
-                  execution_options: {
+                  logging_options: {
                     show_response: 'some-boolean'
                   },
                   webhook_context: {

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

@@ -35,7 +35,7 @@ module PactBroker
             let(:provider_name) { "bar" }
             let(:webhook_options) do
               {
-                execution_options: {
+                logging_options: {
                   show_response: false,
                 },
                 webhook_context: {