pact_broker 2.72.0 → 2.76.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f848cc7a613de4d084d69d97bf1b835c1d1bb130eec3c4c968800e348daf95bf
-  data.tar.gz: 1cbbbd2832eb98cd3904bba8aff8d909a95663c70abe7ad710473e46b3fb3e7c
+  metadata.gz: d14eafba260b6b71dd75c725768863c0f923e167bdb37084606a0b51d110d363
+  data.tar.gz: 545dabeda5ede4c25508e8ca5135d94dacec61f9df1692207787bdc6e3227ec4
 SHA512:
-  metadata.gz: 2200189e21700c21b67e1f8abc85574c3ed9367287568ce7dab4f808cd81ae01a80acd60fe3309cb134cd4466d2c243244429073d4e3af53b6b009bc58848782
-  data.tar.gz: c304534b3125112f4bd2bead0509e7e711face5f0e84ec88594cae1eb6e14a1618a4e61884ffbb0f66dbd813c4e5d4ebd61867ce276120a471a6a77f4c1e6e61
+  metadata.gz: c8df83a6bf1588e8a9a96f915b0926d1a164ebd8f246d7ed831d83d43610bcbaf38875800bbd56ab792af3c9b2b6a9b2f415b6e3a581b6d8955e80248b25d67d
+  data.tar.gz: f1bb7162afee7913b9ac53fc523aa47d021f760350cca52758af1f626f3c440dd73bd02921254487820b1724b5a4c3e334283f728e7b279d92a69b29995de074

data/.github/workflows/test.yml

@@ -37,7 +37,7 @@ jobs:
       - uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}
-      - run: "bundle install"
+      - run: "gem install bundler && bundle install"
         env:
           INSTALL_PG: "true"
       - run: "bundle exec rake"

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,69 @@
+<a name="v2.76.0"></a>
+### v2.76.0 (2021-01-21)
+
+#### Features
+
+* **verification results**
+  * redirect requests for verification results to the HAL browser if requested in a web browser	 ([0f948de5](/../../commit/0f948de5))
+
+<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)
+
+#### Bug Fixes
+
+* **deps**
+  * remove manual specification for nokogiri now the fix for CVE-2020-26247 has been released in 1.11	 ([771378a9](/../../commit/771378a9))
+
+<a name="v2.74.0"></a>
+### v2.74.0 (2021-01-04)
+
+#### Features
+
+* include the consumer version selectors in the metadata of the 'pact for verification' URL	 ([32bbe1c3](/../../commit/32bbe1c3))
+
+#### Bug Fixes
+
+* **deps**
+  * update nokogiri for CVE-2020-26247	 ([336ec897](/../../commit/336ec897))
+
+<a name="v2.73.0"></a>
+### v2.73.0 (2020-12-16)
+
+#### Features
+
+* **wip**
+  * permenently enable feature that keeps pacts as WIP when verified via the URL from a webhook triggered by pact publication	 ([70071373](/../../commit/70071373))
+
+* allow error causes to be configured to log at warning level	 ([3a7bf5ea](/../../commit/3a7bf5ea))
+* add self relations for tags in matrix resource	 ([727cee99](/../../commit/727cee99))
+* add self relation to tags in extended pact and verification resources	 ([a560ce6d](/../../commit/a560ce6d))
+
+* **metrics**
+  * timeout matrix count	 ([43091b57](/../../commit/43091b57))
+
+#### Bug Fixes
+
+* url encode tag name in tag URL	 ([80df832d](/../../commit/80df832d))
+
 <a name="v2.72.0"></a>
 ### v2.72.0 (2020-12-02)
 

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/ISSUES.md

@@ -8,16 +8,16 @@ You can use it to easily reproduce issues.
 
 To use it:
 
-* Run the Pact Broker using the latest development code:
+* Run the Pact Broker using a specific Pact Broker Docker image by setting the required tag for the pact-broker service in the docker-compose-issue-repro-with-pact-broker-docker-image.yml file.
 
     ```
-    docker-compose -f docker-compose-issue-repro.yml up --build pact-broker
+    docker-compose -f docker-compose-issue-repro-with-pact-broker-docker-image.yml up --build pact-broker
     ```
 
 * Run the reproduction script.
 
     ```
-    docker-compose -f docker-compose-issue-repro.yml up repro-issue
+    docker-compose -f docker-compose-issue-repro-with-pact-broker-docker-image.yml up repro-issue
     ```
 
 You can modify `script/reproduce-issue.rb` and then re-run it with the change applied.

data/README.md

@@ -1,6 +1,6 @@
 # Pact Broker
 [![Gem Version](https://badge.fury.io/rb/pact_broker.svg)](http://badge.fury.io/rb/pact_broker)
- [![Build Status](https://travis-ci.org/pact-foundation/pact_broker.svg?branch=master)](https://travis-ci.org/pact-foundation/pact_broker)
+ ![Build status](https://github.com/pact-foundation/pact_broker/workflows/Test/badge.svg)
  [![Join the chat at https://pact-foundation.slack.com/](https://img.shields.io/badge/chat-on%20slack-blue.svg?logo=slack)](https://slack.pact.io)
  [![security](https://hakiri.io/github/pact-foundation/pact_broker/master.svg)](https://hakiri.io/github/pact-foundation/pact_broker/master)
  [![Code Climate](https://codeclimate.com/github/pact-foundation/pact_broker/badges/gpa.svg)](https://codeclimate.com/github/pact-foundation/pact_broker)

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-issue-repro-with-pact-broker-docker-image.yml

@@ -0,0 +1,33 @@
+version: "3"
+
+services:
+  postgres:
+    image: postgres
+    healthcheck:
+      test: psql postgres --command "select 1" -U postgres
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: postgres
+
+  pact-broker:
+    image: pactfoundation/pact-broker:2.73.0.0
+    ports:
+      - "9292:9292"
+    depends_on:
+      - postgres
+    environment:
+      PACT_BROKER_PORT: '9292'
+      PACT_BROKER_DATABASE_URL: "postgres://postgres:password@postgres/postgres"
+      PACT_BROKER_LOG_LEVEL: INFO
+      PACT_BROKER_SQL_LOG_LEVEL: DEBUG
+
+  repro-issue:
+    build: .
+    depends_on:
+      - pact-broker
+    command: dockerize -wait http://pact-broker:9292 -timeout 30s /home/script/reproduce-issue.rb
+    environment:
+      - PACT_BROKER_BASE_URL=http://pact-broker:9292
+    volumes:
+      - $PWD:/home

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/db.rb

@@ -33,6 +33,7 @@ module DB
     con = Sequel.connect(db_credentials.merge(:logger => logger, :pool_class => Sequel::ThreadedConnectionPool, :encoding => 'utf8'))
     con.extension(:connection_validator)
     con.extension(:pagination)
+    con.extension(:statement_timeout)
     con.extend_datasets do
       def any?
         !empty?

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/extended_pact_decorator.rb

@@ -11,6 +11,14 @@ module PactBroker
           property :name
           property :latest, getter: ->(_) { true }
 
+          link :self do | options |
+            {
+              title: 'Tag',
+              name: represented.name,
+              href: tag_url(options[:base_url], represented)
+            }
+          end
+
           link "pb:latest-pact" do | opts |
             {
               name: "The latest pact with the tag #{represented.name}",
@@ -33,7 +41,7 @@ module PactBroker
 
         def head_tags
           represented.head_tag_names.collect do | tag_name |
-            OpenStruct.new(name: tag_name, pact: represented)
+            OpenStruct.new(name: tag_name, pact: represented, version: represented.consumer_version)
           end
         end
       end