pact_broker 2.32.0 → 2.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cc025b711061dcb0c7ceecb89e57b5df8560667
-  data.tar.gz: 87e712268e55f5325f1ea3c6a81dd370504b34f9
+  metadata.gz: 97134f270141a482c9af9641cffd34827002be42
+  data.tar.gz: '058cf5c4bdddd00ffd77b8a366cfdfbf539e40ff'
 SHA512:
-  metadata.gz: bc84f0a9394bb378f64bcb04796a4f594c395f4a1f1018e55e2e64a1a97738346be25f5ecf1a6632ec4b0ce100fd36d3fb1167de90af0db62b4abb95ae258e21
-  data.tar.gz: 2b135a336313e79f8f448f8ab466bf9d50c1f096d425c406edbda93a415bb62a28abbea616f64dad1af226650f1340a5d43ac6f263020c9c877c9ec04b945662
+  metadata.gz: cf993532a2a921c255d35c52918f5aba61f310109f2d0beaacac3abddd16b8a55bcd12b4f21b7ecbade8a9c7e2104dc3198a2efbb1d3cfa3ec45c738e5357385
+  data.tar.gz: d5544a81be59d19d52b906f8a3c320bc25620e9020c9bc7e4d02217c7d3c549719564fa226f2df3ddd15bb8bb0776f8208d502105d0e8088cac3f018beb43804

data/.github/ISSUE_TEMPLATE.md

@@ -4,6 +4,9 @@ I have already (please mark the applicable with an `x`):
 
 * [ ] Upgraded to the latest Pact Broker OR
 * [ ] Checked the CHANGELOG to see if the issue I am about to raise has been fixed
+* [ ] Created an executable example that demonstrates the issue using either a:
+  * Dockerfile
+  * Git repository with a Travis or Appveyor (or similar) build
 
 ## Software versions
 

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+<a name="v2.33.0"></a>
+### v2.33.0 (2019-06-07)
+
+
+#### Features
+
+* add pb:pacticipant and pb:pacticipant-version-tag relations to the index resource	 ([2c4c258c](/../../commit/2c4c258c))
+
+
+#### Bug Fixes
+
+* correctly remove webhook consumer/provider when update params do not contain a consumer/provider	 ([118bbee1](/../../commit/118bbee1))
+* duplicate key value violates unique constraint "cv_prov_revision_unq" error when publishing identical pact resources at the same time	 ([6c8e38fb](/../../commit/6c8e38fb))
+
+* **matrix**
+  * ensure unrelated dependencies are not included in a matrix result when three pacticipants each have dependencies on each other	 ([a086ffec](/../../commit/a086ffec))
+
+
 <a name="v2.32.0"></a>
 ### v2.32.0 (2019-05-28)
 

data/config/database.yml

@@ -18,11 +18,6 @@ test:
     password: postgres
     host: "localhost"
     port: "5432"
-  docker_compose_postgres:
-    <<: *default
-    adapter: postgres
-    host: postgres
-    port: "5432"
   mysql:
     <<: *default
     adapter: mysql2
@@ -35,10 +30,12 @@ development:
     <<: *default
     adapter: postgres
   docker_postgres:
-    <<: *default
     adapter: postgres
-    host: "127.0.0.1"
-    port: "5433"
+    database: postgres
+    username: postgres
+    password: postgres
+    host: "localhost"
+    port: "5432"
   mysql:
     <<: *default
     adapter: mysql2

data/db/migrations/20190510_set_version_sequence.rb

@@ -1,4 +1,5 @@
 require 'pact_broker/db/data_migrations/set_latest_version_sequence_value'
+
 Sequel.migration do
   up do
     PactBroker::DB::DataMigrations::SetLatestVersionSequenceValue.call(self)

data/db/migrations/20190602_add_headers_column_to_webhooks.rb

@@ -0,0 +1,6 @@
+Sequel.migration do
+  change do
+    # TODO delete webhook headers table
+    add_column(:webhooks, :headers, String)
+  end
+end

data/db/migrations/20190603_migrate_webhook_headers.rb

@@ -0,0 +1,10 @@
+require 'pact_broker/db/data_migrations/migrate_webhook_headers'
+
+Sequel.migration do
+  up do
+    PactBroker::DB::DataMigrations::MigrateWebhookHeaders.call(self)
+  end
+
+  down do
+  end
+end

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

@@ -50,6 +50,12 @@ module PactBroker
               title: 'Pacticipants',
               templated: false
             },
+            'pb:pacticipant' =>
+            {
+              href: base_url + '/pacticipants/{pacticipant}',
+              title: 'Fetch pacticipant by name',
+              templated: true
+            },
             'pb:latest-provider-pacts' =>
             {
               href: base_url + '/pacts/provider/{provider}/latest',
@@ -94,6 +100,12 @@ module PactBroker
               title: 'Integrations',
               templated: false
             },
+            'pb:pacticipant-version-tag' =>
+            {
+              href: base_url + '/pacticipants/{pacticipant}/versions/{version}/tags/{tag}',
+              title: "Get, create or delete a tag for a pacticipant version",
+              templated: true
+            },
             'beta:pending-provider-pacts' =>
             {
               href: base_url + '/pacts/provider/{provider}/pending',

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

@@ -122,7 +122,7 @@ module PactBroker
         def webhook_options
           {
             database_connector: database_connector,
-            execution_options: {
+            logging_options: {
               show_response: PactBroker.configuration.show_webhook_response?
             },
             webhook_context: {

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

@@ -78,7 +78,7 @@ module PactBroker
         def webhook_options
           {
             database_connector: database_connector,
-            execution_options: {
+            logging_options: {
               show_response: PactBroker.configuration.show_webhook_response?
             },
             webhook_context: metadata.merge(

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

@@ -47,7 +47,7 @@ module PactBroker
 
         def webhook_options
           {
-            execution_options: {
+            logging_options: {
               show_response: PactBroker.configuration.show_webhook_response?
             },
             webhook_context: {

data/lib/pact_broker/certificates/certificate.rb

@@ -9,7 +9,7 @@ end
 
 # Table: certificates
 # Columns:
-#  id          | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
+#  id          | integer                     | PRIMARY KEY DEFAULT nextval('certificates_id_seq'::regclass)
 #  uuid        | text                        | NOT NULL
 #  description | text                        |
 #  content     | text                        | NOT NULL

data/lib/pact_broker/config/setting.rb

@@ -69,7 +69,7 @@ end
 
 # Table: config
 # Columns:
-#  id         | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
+#  id         | integer                     | PRIMARY KEY DEFAULT nextval('config_id_seq'::regclass)
 #  name       | text                        | NOT NULL
 #  type       | text                        | NOT NULL
 #  value      | text                        |

data/lib/pact_broker/db/data_migrations/migrate_webhook_headers.rb

@@ -0,0 +1,30 @@
+require 'pact_broker/db/data_migrations/helpers'
+
+module PactBroker
+  module DB
+    module DataMigrations
+      class MigrateWebhookHeaders
+        extend Helpers
+
+        def self.call(connection)
+          if columns_exist?(connection)
+            connection[:webhook_headers].for_update.each do | webhook_header |
+              webhook = connection[:webhooks].for_update.where(id: webhook_header[:webhook_id]).first
+              new_headers = webhook[:headers] ? JSON.parse(webhook[:headers]) : {}
+              new_headers.merge!(webhook_header[:name] => webhook_header[:value])
+              connection[:webhooks].where(id: webhook[:id]).update(headers: new_headers.to_json)
+              connection[:webhook_headers].where(webhook_header).delete
+            end
+          end
+        end
+
+        def self.columns_exist?(connection)
+          column_exists?(connection, :webhooks, :headers) &&
+            column_exists?(connection, :webhook_headers, :name) &&
+            column_exists?(connection, :webhook_headers, :value) &&
+            column_exists?(connection, :webhook_headers, :webhook_id)
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/domain/pacticipant.rb

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

data/lib/pact_broker/domain/verification.rb

@@ -95,7 +95,7 @@ end
 
 # Table: verifications
 # Columns:
-#  id                  | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
+#  id                  | integer                     | PRIMARY KEY DEFAULT nextval('verifications_id_seq'::regclass)
 #  number              | integer                     |
 #  success             | boolean                     | NOT NULL
 #  provider_version    | text                        |

data/lib/pact_broker/domain/version.rb

@@ -48,7 +48,7 @@ end
 
 # Table: versions
 # Columns:
-#  id             | integer                     | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY
+#  id             | integer                     | PRIMARY KEY DEFAULT nextval('versions_id_seq'::regclass)
 #  number         | text                        |
 #  repository_ref | text                        |
 #  pacticipant_id | integer                     | NOT NULL

data/lib/pact_broker/domain/webhook.rb

@@ -2,6 +2,7 @@ require 'pact_broker/domain/webhook_request'
 require 'pact_broker/messages'
 require 'pact_broker/logging'
 require 'pact_broker/api/contracts/webhook_contract'
+require 'pact_broker/webhooks/http_request_with_redacted_headers'
 
 module PactBroker
   module Domain
@@ -10,6 +11,7 @@ module PactBroker
       include Messages
       include Logging
 
+      # request is actually a request_template
       attr_accessor :uuid, :consumer, :provider, :request, :created_at, :updated_at, :events, :enabled, :description
       attr_reader :attributes
 
@@ -52,7 +54,31 @@ module PactBroker
 
       def execute pact, verification, options
         logger.info "Executing #{self}"
-        request.build(pact: pact, verification: verification, webhook_context: options.fetch(:webhook_context)).execute(options.fetch(:execution_options))
+        webhook_request = request.build(pact: pact, verification: verification, webhook_context: options.fetch(:webhook_context))
+        http_response = nil
+        error = nil
+        begin
+          http_response = webhook_request.execute
+        rescue StandardError => e
+          error = e
+        end
+
+        PactBroker::Webhooks::WebhookExecutionResult.new(
+          webhook_request.http_request,
+          http_response,
+          generate_logs(webhook_request, http_response, error, options.fetch(:logging_options)),
+          error
+        )
+      end
+
+      def generate_logs(webhook_request, http_response, error, logging_options)
+        webhook_request_logger = PactBroker::Webhooks::WebhookRequestLogger.new(logging_options)
+        webhook_request_logger.log(
+          uuid,
+          webhook_request,
+          http_response,
+          error
+        )
       end
 
       def to_s

data/lib/pact_broker/domain/webhook_request.rb

@@ -1,61 +1,21 @@
 require 'pact_broker/build_http_options'
 require 'pact_broker/domain/webhook_request_header'
-require 'pact_broker/domain/webhook_execution_result'
+require 'pact_broker/webhooks/webhook_execution_result'
 require 'pact_broker/logging'
 require 'pact_broker/messages'
 require 'net/http'
-require 'pact_broker/webhooks/render'
-require 'pact_broker/api/pact_broker_urls'
 require 'pact_broker/build_http_options'
 require 'cgi'
 require 'delegate'
 require 'rack/utils'
+require 'pact_broker/webhooks/webhook_request_logger'
 
 module PactBroker
-
   module Domain
-
-    class WebhookRequestError < StandardError
-      def initialize message, response
-        super message
-        @response = response
-      end
-    end
-
-    class WebhookResponseWithUtf8SafeBody < SimpleDelegator
-      def body
-        if unsafe_body
-          unsafe_body.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
-        else
-          unsafe_body
-        end
-      end
-
-      def unsafe_body
-        __getobj__().body
-      end
-
-      def unsafe_body?
-        unsafe_body != body
-      end
-    end
-
-    class WebhookRequestWithRedactedHeaders < SimpleDelegator
-      def to_hash
-        __getobj__().to_hash.each_with_object({}) do | (key, values), new_hash |
-          new_hash[key] = redact?(key) ? ["**********"] : values
-        end
-      end
-
-      def redact? name
-        WebhookRequest::HEADERS_TO_REDACT.any?{ | pattern | name =~ pattern }
-      end
-    end
-
     class WebhookRequest
 
       include PactBroker::Logging
-      include PactBroker::Messages
+
       HEADERS_TO_REDACT = [/authorization/i, /token/i]
 
       attr_accessor :method, :url, :headers, :body, :username, :password, :uuid
@@ -89,36 +49,14 @@ module PactBroker
         end
       end
 
-      def execute options = {}
-        @options = options
-        @logs = StringIO.new
-        @execution_logger = Logger.new(logs)
-        begin
-          execute_and_build_result
-        rescue StandardError => e
-          handle_error_and_build_result(e)
+      def execute
+        options = PactBroker::BuildHttpOptions.call(uri)
+        req = http_request
+        Net::HTTP.start(uri.hostname, uri.port, :ENV, options) do |http|
+          http.request req
         end
       end
 
-      private
-
-      attr_reader :options, :execution_logger, :logs
-
-      def execute_and_build_result
-        log_request
-        response = do_request
-        log_response(response)
-        result = WebhookExecutionResult.new(WebhookRequestWithRedactedHeaders.new(http_request), response, logs.string)
-        log_completion_message(result.success?)
-        result
-      end
-
-      def handle_error_and_build_result e
-        log_error(e)
-        log_completion_message(false)
-        WebhookExecutionResult.new(WebhookRequestWithRedactedHeaders.new(http_request), nil, logs.string, e)
-      end
-
       def http_request
         @http_request ||= begin
           req = Net::HTTP.const_get(method.capitalize).new(url)
@@ -129,82 +67,7 @@ module PactBroker
         end
       end
 
-      def do_request
-        options = PactBroker::BuildHttpOptions.call(uri)
-        req = http_request
-        response = Net::HTTP.start(uri.hostname, uri.port, :ENV, options) do |http|
-          http.request req
-        end
-        WebhookResponseWithUtf8SafeBody.new(response)
-      end
-
-      def log_request
-        redacted_request = WebhookRequestWithRedactedHeaders.new(http_request)
-        logger.info "Making webhook #{uuid} request #{http_method.upcase} URI=#{uri} (headers and body in debug logs)"
-        logger.debug "Webhook #{uuid} request headers=#{redacted_request.to_hash}"
-        logger.debug "Webhook #{uuid} request body=#{redacted_request.body}"
-
-        execution_logger.info "HTTP/1.1 #{http_method.upcase} #{url}"
-        redacted_request.to_hash.each do | name, value |
-          execution_logger.info "#{name}: #{value.join(", ")}"
-        end
-        execution_logger.info(body) if body
-      end
-
-      def log_response response
-        log_response_to_application_logger(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 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 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
+      private
 
       def to_s
         "#{method.upcase} #{url}, username=#{username}, password=#{display_password}, headers=#{redacted_headers}, body=#{body}"