pact_broker 2.74.1 → 2.75.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bb163d5ed55a2b3f98f18b63763749a0a9a337538a69b30af9f01295e720154
-  data.tar.gz: cd8cc58097602d87c09f9af494b49c28666223350f57a2f4f9ccade3f3b1d57c
+  metadata.gz: fe978e58a9f4c7e3e190b8fd5b48ce70212bac2dcc4c0ea795565a00db6127e3
+  data.tar.gz: 551b0f07b25b75db367cb4a6d16ce114ab64b2541f1a452ab686145d3b5610ec
 SHA512:
-  metadata.gz: a32dd3179963aac89bff4ca0197e80f73576188355b92984e51ee010522e34d7017ab6a2cac6eaf5ac865391b221d7aa619efdd8950727cac20c2e6d2b686e79
-  data.tar.gz: fbd56c79155229b5900294f13b0ce1ce9390cd2260e678a83ef2b358d4ad8112ae6e4f257bc3380e4ed488b67ed838f80214ba16bb8431c002f85878c5989a33
+  metadata.gz: 87c8c396ed8dd5aaabd184a7a65a24c7ba641d11a257bfb17d3cf497e4cc9e3e33a2a761143f3c59d511e0d42c3440ea3117f186ee179aff095d917c228dd820
+  data.tar.gz: 5d4b9dfc5bab8f3f3671dc10011a11c925bbf2ff2edc8b3a8196c204c6bdace6bc09d8c004e3bbed438a111c202b99b01937163708da591375f8828ef02e81a4

data/.optic/.gitignore

@@ -0,0 +1,2 @@
+
+captures/

data/.optic/api/specification.json

@@ -0,0 +1 @@
+[]

data/.optic/ignore

@@ -0,0 +1,14 @@
+# Default Ignore Rules
+# Learn to configure your own at https://useoptic.com/docs
+OPTIONS *
+HEAD *
+GET (.*).htm
+GET (.*).html
+GET (.*).css
+GET (.*).js
+GET (.*).woff
+GET (.*).png
+GET (.*).jpg
+GET (.*).jpeg
+GET (.*).svg
+GET (.*).gif

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+<a name="v2.75.0"></a>
+### v2.75.0 (2021-01-18)
+
+#### Features
+
+* upgrade bootstrap (#370)	 ([a457c337](/../../commit/a457c337))
+* add indexes to webhook_executions and triggered_webhooks tables	 ([b05e7dbe](/../../commit/b05e7dbe))
+
+* **webhook**
+  * set read and open timeouts	 ([8b502c44](/../../commit/8b502c44))
+
+#### Bug Fixes
+
+* **ui**
+  * upgrade to jquery-3.5.1 to address vulnerabilities in jquery-3.3.1	 ([de41b231](/../../commit/de41b231))
+
+* **deps**
+  * upgrade redcarpet for CVE-2020-26298	 ([b57aad32](/../../commit/b57aad32))
+
 <a name="v2.74.1"></a>
 ### v2.74.1 (2021-01-05)
 

data/DEVELOPER_SETUP.md

@@ -68,6 +68,13 @@ bundle exec rake
 # if you don't want to run the whole rake test suite, init the db first
 /home/init-db.sh
 ```
+
+Running a mysql client in the mysql-tests container:
+
+```
+mysql -hmysql -upact_broker -ppact_broker
+```
+
 ## Running the tests
 
 * To run everything (specs, pact verifications, vulnerability scan...):
@@ -87,5 +94,7 @@ bundle exec rake
   bundle exec rspec path_to_your_spec.rb
   ```
 
+NOTE: the spec tasks requires the `db:prepare:test` task to be executed at least once prior to running.
+
 [chruby]: https://github.com/postmodern/chruby
 [ruby-install]: https://github.com/postmodern/ruby-install

data/Dockerfile

@@ -15,6 +15,7 @@ RUN apk update \
       "sqlite>=3.28" \
       "tzdata>=2019" \
       "mariadb-dev>=10.3" \
+      "mysql-client>=10.3.25" \
     && rm -rf /var/cache/apk/*
 
 RUN apk add --no-cache openssl less

data/config/database.yml

@@ -17,7 +17,7 @@ test:
     username: postgres
     password: postgres
     host: localhost
-    port: "5433"
+    port: "5432"
   docker_compose_postgres:
     adapter: postgres
     database: postgres

data/db/migrations/20210115_add_webhook_foreign_key_indexes.rb

@@ -0,0 +1,49 @@
+require_relative 'migration_helper'
+
+include PactBroker::MigrationHelper
+
+Sequel.migration do
+  up do
+    if !mysql?
+      alter_table(:webhook_executions) do
+        add_index([:triggered_webhook_id], name: "webhook_executions_triggered_webhook_id_index")
+      end
+      # MySQL automatically creates indexes for foreign keys then complains if you
+      # re-create it with a different name and try to drop it.
+
+      # https://stackoverflow.com/a/52274628/832671 - "When there is only one index that can be used
+      # for the foreign key, it can't be dropped. If you really wan't to drop it, you either have to drop
+      # the foreign key constraint or to create another index for it first."
+
+      alter_table(:triggered_webhooks) do
+        add_index([:webhook_id], name: "triggered_webhooks_webhook_id_index")
+        add_index([:consumer_id], name: "triggered_webhooks_consumer_id_index")
+        add_index([:provider_id], name: "triggered_webhooks_provider_id_index")
+        add_index([:verification_id], name: "triggered_webhooks_verification_id_index")
+        add_index([:pact_publication_id], name: "triggered_webhooks_pact_publication_id_index")
+      end
+    end
+  end
+
+  down do
+    if !mysql?
+      alter_table(:webhook_executions) do
+        drop_index([:triggered_webhook_id], name: "webhook_executions_triggered_webhook_id_index")
+      end
+      # MySQL automatically creates indexes for foreign keys then complains if you
+      # re-create it with a different name and try to drop it.
+
+      # https://stackoverflow.com/a/52274628/832671 - "When there is only one index that can be used
+      # for the foreign key, it can't be dropped. If you really wan't to drop it, you either have to drop
+      # the foreign key constraint or to create another index for it first."
+
+      alter_table(:triggered_webhooks) do
+        drop_index([:webhook_id], name: "triggered_webhooks_webhook_id_index")
+        drop_index([:consumer_id], name: "triggered_webhooks_consumer_id_index")
+        drop_index([:provider_id], name: "triggered_webhooks_provider_id_index")
+        drop_index([:verification_id], name: "triggered_webhooks_verification_id_index")
+        drop_index([:pact_publication_id], name: "triggered_webhooks_pact_publication_id_index")
+      end
+    end
+  end
+end

data/db/migrations/20210116_add_context_to_triggered_webhook.rb

@@ -0,0 +1,11 @@
+require_relative 'migration_helper'
+
+include PactBroker::MigrationHelper
+
+Sequel.migration do
+  change do
+    alter_table(:triggered_webhooks) do
+      add_column(:event_context, String)
+    end
+  end
+end

data/db/migrations/migration_helper.rb

@@ -30,6 +30,14 @@ module PactBroker
       Sequel::Model.db.adapter_scheme.to_s
     end
 
+    def with_type_hash_if_postgres(options)
+      if postgres?
+        options.merge(type: "hash")
+      else
+        options
+      end
+    end
+
     def sqlite_safe string
       if adapter == 'sqlite'
         string.gsub(/(?:\b|")order(?:"|\b)/, '`order`')

data/docker-compose-test.yml

@@ -6,8 +6,8 @@ services:
     image: postgres
     healthcheck:
       test: psql postgres --command "select 1" -U postgres
-    ports:
-      - "5432:5432"
+    # ports:
+    #   - "5432:5432"
     environment:
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: postgres
@@ -58,8 +58,8 @@ services:
       MYSQL_DATABASE: pact_broker
       MYSQL_USER: pact_broker
       MYSQL_PASSWORD: pact_broker
-    ports:
-      - "3306:3306"
+    # ports:
+    #   - "3306:3306"
 
   init-mysql:
     build: .

data/lib/pact_broker/api.rb

@@ -1,6 +1,8 @@
 require 'webmachine/adapters/rack_mapped'
 require 'webmachine/rack_adapter_monkey_patch'
 require 'pact_broker/api/resources'
+require 'pact_broker/api/decorators'
+require 'pact_broker/application_context'
 require 'pact_broker/feature_toggle'
 
 module Webmachine
@@ -12,8 +14,7 @@ module Webmachine
 end
 
 module PactBroker
-
-  API ||= begin
+  def self.build_api(application_context = PactBroker::ApplicationContext.default_application_context)
     pact_api = Webmachine::Application.new do |app|
       app.routes do
         add(['trace', :*], Webmachine::Trace::TraceResource) unless ENV['RACK_ENV'] == 'production'
@@ -111,10 +112,20 @@ module PactBroker
       end
     end
 
+    # naughty, but better than setting each route manually
+    pact_api.routes.each do | route |
+      route.instance_variable_get(:@bindings)[:application_context] = application_context
+    end
+
     pact_api.configure do |config|
       config.adapter = :RackMapped
     end
 
     pact_api.adapter
   end
+
+
+  API ||= begin
+    build_api
+  end
 end

data/lib/pact_broker/api/decorators.rb

@@ -1,7 +1,3 @@
-require 'pact_broker/api/decorators/pacticipant_decorator'
-require 'pact_broker/api/decorators/pacticipant_collection_decorator'
-require 'pact_broker/api/decorators/embedded_version_decorator'
-require 'pact_broker/api/decorators/pact_collection_decorator'
-require 'pact_broker/api/decorators/pact_pacticipant_decorator'
-require 'pact_broker/api/decorators/pact_details_decorator'
-require 'pact_broker/api/decorators/tag_decorator'
+Dir.glob(File.expand_path(File.join(__FILE__, "..", "decorators", "*.rb"))).sort.each do | path |
+  require path
+end

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

@@ -0,0 +1,33 @@
+require 'pact_broker/string_refinements'
+
+module PactBroker
+  module Api
+    module Decorators
+      class Configuration
+        using PactBroker::StringRefinements
+
+        def initialize(overrides = {})
+          @overrides = overrides
+        end
+
+        def class_for(name)
+          if overrides[name].is_a?(String)
+            Object.const_get(overrides[name])
+          elsif overrides[name].is_a?(Class)
+            overrides[name]
+          else
+           Object.const_get("PactBroker::Api::Decorators::#{name.to_s.camelcase(true)}")
+          end
+        end
+
+        def self.default_configuration
+          Configuration.new
+        end
+
+        private
+
+        attr_reader :overrides
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'pact_broker/api/decorators/decorator_context'
+
+module PactBroker
+  module Api
+    module Decorators
+      class DecoratorContextCreator
+        def self.call(resource, options)
+          Decorators::DecoratorContext.new(resource.base_url, resource.resource_url, resource.request.env, options)
+        end
+      end
+    end
+  end
+end

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

@@ -2,6 +2,7 @@ require_relative 'base_decorator'
 require_relative 'embedded_version_decorator'
 require_relative 'latest_pact_decorator'
 require_relative 'representable_pact'
+require 'pact_broker/domain/pact'
 
 module PactBroker
   module Api

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

@@ -1,13 +1,12 @@
 require 'roar/json/hal'
 require 'pact_broker/api/pact_broker_urls'
 require_relative 'embedded_version_decorator'
+require 'pact_broker/domain/pacticipant'
+require 'pact_broker/api/decorators/pacticipant_decorator'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       class PacticipantCollectionDecorator < BaseDecorator
 
         collection :entries, :as => :pacticipants, :class => PactBroker::Domain::Pacticipant, :extend => PactBroker::Api::Decorators::PacticipantDecorator, embedded: true

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

@@ -1,3 +1,5 @@
+require 'pact_broker/matrix/reason'
+
 module PactBroker
   module Api
     module Decorators

data/lib/pact_broker/api/renderers/html_pact_renderer.rb

@@ -45,7 +45,7 @@ module PactBroker
           <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/material-menu.css'>
           <link rel='stylesheet' type='text/css' href='#{base_url}/stylesheets/jquery-confirm.min.css'>
           <script src='#{base_url}/javascripts/highlight.pack.js'></script>
-          <script src='#{base_url}/javascripts/jquery-3.3.1.min.js'></script>
+          <script src='#{base_url}/javascripts/jquery-3.5.1.min.js'></script>
           <script src='#{base_url}/js/bootstrap.min.js'></script>
           <script src='#{base_url}/javascripts/material-menu.js'></script>
           <script src='#{base_url}/javascripts/pact.js'></script>
@@ -80,7 +80,7 @@ module PactBroker
                       data-provider-name=\"#{provider_name}\"
                       data-consumer-version-number=\"#{consumer_version_number}\"
                       data-pact-url=\"#{pact_url}\"
-                      class='more-options glyphicon glyphicon-option-horizontal'
+                      class='more-options kebab-horizontal'
                       aria-hidden='true'></span>
               </li>
             </ul>

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

@@ -37,12 +37,12 @@ module PactBroker
         end
 
         def to_json
-          Decorators::WebhooksDecorator.new(webhooks).to_json(decorator_options(resource_title: "Webhooks"))
+          decorator_class(:webhooks_decorator).new(webhooks).to_json(decorator_options(resource_title: "Webhooks"))
         end
 
         def from_json
           saved_webhook = webhook_service.create(next_uuid, webhook, consumer, provider)
-          response.body = Decorators::WebhookDecorator.new(saved_webhook).to_json(decorator_options)
+          response.body = decorator_class(:webhook_decorator).new(saved_webhook).to_json(decorator_options)
         end
 
         def policy_name
@@ -74,7 +74,7 @@ module PactBroker
         end
 
         def webhook
-          @webhook ||= Decorators::WebhookDecorator.new(PactBroker::Domain::Webhook.new).from_json(request_body)
+          @webhook ||= decorator_class(:webhook_decorator).new(PactBroker::Domain::Webhook.new).from_json(request_body)
         end
 
         def next_uuid

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

@@ -55,7 +55,7 @@ module PactBroker
             end
           rescue StandardError => e
             # Want to render a badge, even if there's an error
-            badge_service.error_badge_url("error", ErrorHandler.display_message(e, "reference: #{ErrorHandler.generate_error_reference}"))
+            badge_service.error_badge_url("error", ErrorResponseBodyGenerator.display_message(e, "reference: #{PactBroker::Errors.generate_error_reference}"))
           end
         end
 

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

@@ -18,11 +18,11 @@ module PactBroker
         end
 
         def to_json
-          PactBroker::Api::Decorators::DashboardDecorator.new(index_items).to_json(user_options: decorator_context)
+          decorator_class(:dashboard_decorator).new(index_items).to_json(decorator_options)
         end
 
         def to_text
-          PactBroker::Api::Decorators::DashboardTextDecorator.new(index_items).to_text(user_options: decorator_context)
+          decorator_class(:dashboard_text_decorator).new(index_items).to_text(decorator_options)
         end
 
         def policy_name

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

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
 require 'webmachine'
-require 'pact_broker/api/resources/error_handler'
 require 'pact_broker/services'
 require 'pact_broker/api/decorators'
 require 'pact_broker/logging'
 require 'pact_broker/api/pact_broker_urls'
-require 'pact_broker/api/decorators/decorator_context'
 require 'pact_broker/json'
 require 'pact_broker/pacts/pact_params'
 require 'pact_broker/api/resources/authentication'
+require 'pact_broker/errors'
 
 module PactBroker
   module Api
@@ -24,6 +24,7 @@ module PactBroker
 
         def initialize
           PactBroker.configuration.before_resource.call(self)
+          application_context.before_resource&.call(self)
         end
 
         def options
@@ -35,6 +36,7 @@ module PactBroker
         end
 
         def finish_request
+          application_context.after_resource&.call(self)
           PactBroker.configuration.after_resource.call(self)
         end
 
@@ -43,29 +45,39 @@ module PactBroker
         end
 
         def forbidden?
-          return false if PactBroker.configuration.authorize.nil?
-          !PactBroker.configuration.authorize.call(self, {})
+          if application_context.resource_authorizer
+            !application_context.resource_authorizer.call(self)
+          elsif PactBroker.configuration.authorize
+            !PactBroker.configuration.authorize.call(self, {})
+          else
+            false
+          end
         end
 
+        # The path_info segments aren't URL decoded
         def identifier_from_path
-          request.path_info.each_with_object({}) do | pair, hash|
-            hash[pair.first] = pair.last === String ? URI.decode(pair.last) : pair.last
+          @identifier_from_path ||= request.path_info.each_with_object({}) do | (key, value), hash|
+            if value.is_a?(String)
+              hash[key] = URI.decode(value)
+            elsif value.is_a?(Symbol) || value.is_a?(Numeric)
+              hash[key] = value
+            end
           end
         end
 
         alias_method :path_info, :identifier_from_path
 
         def base_url
-          PactBroker.configuration.base_url || request.base_uri.to_s.chomp('/')
+          request.env["pactbroker.base_url"] || PactBroker.configuration.base_url || request.base_uri.to_s.chomp('/')
         end
 
         # See comments for base_url in lib/pact_broker/doc/controllers/app.rb
         def ui_base_url
-          PactBroker.configuration.base_url || ''
+          request.env["pactbroker.base_url"] || PactBroker.configuration.base_url || ''
         end
 
         def charsets_provided
-          [['utf-8', :encode]]
+          [["utf-8", :encode]]
         end
 
         # We only use utf-8 so leave encoding as it is
@@ -78,15 +90,20 @@ module PactBroker
         end
 
         def decorator_context options = {}
-          Decorators::DecoratorContext.new(base_url, resource_url, request.env, options)
+          application_context.decorator_context_creator.call(self, options)
         end
 
         def decorator_options options = {}
           { user_options: decorator_context(options) }
         end
 
-        def handle_exception e
-          PactBroker::Api::Resources::ErrorHandler.call(e, request, response)
+        def handle_exception(error)
+          error_reference = PactBroker::Errors.generate_error_reference
+          application_context.error_logger.call(error, error_reference, request)
+          if PactBroker::Errors.reportable_error?(error)
+            PactBroker::Errors.report(error, error_reference, request)
+          end
+          response.body = application_context.error_response_body_generator.call(error, error_reference, request)
         end
 
         def params(options = {})
@@ -214,6 +231,14 @@ module PactBroker
         def database_connector
           request.env["pactbroker.database_connector"]
         end
+
+        def application_context
+          request.path_info[:application_context]
+        end
+
+        def decorator_class(name)
+          application_context.decorator_configuration.class_for(name)
+        end
       end
     end
   end