pact_broker 2.71.0 → 2.75.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7fe157577be6cdfb603e4607b174224781db0b9b2ee7ccb1325cdda50ce129d
-  data.tar.gz: 9e28ef38f281ac6d6dbf1879d3794a8f915cb78bb8a82c464c7273ac9f8522dc
+  metadata.gz: fe978e58a9f4c7e3e190b8fd5b48ce70212bac2dcc4c0ea795565a00db6127e3
+  data.tar.gz: 551b0f07b25b75db367cb4a6d16ce114ab64b2541f1a452ab686145d3b5610ec
 SHA512:
-  metadata.gz: 3e5d4d249f691a3e03725e3b827f4044eb2fde360cd0dd9128fce61a4442288083f825f654473cf1a3220745460675036951242cc801211eda258369e38eeb09
-  data.tar.gz: f8b9f3bdbfe42ca21291b41588ae4b3be15ca53efaec275e5356d8363dfa181e592942cb5e13bbd492fadb61d231cee68aaed009fef559c0645bc4debc4137c1
+  metadata.gz: 87c8c396ed8dd5aaabd184a7a65a24c7ba641d11a257bfb17d3cf497e4cc9e3e33a2a761143f3c59d511e0d42c3440ea3117f186ee179aff095d917c228dd820
+  data.tar.gz: 5d4b9dfc5bab8f3f3671dc10011a11c925bbf2ff2edc8b3a8196c204c6bdace6bc09d8c004e3bbed438a111c202b99b01937163708da591375f8828ef02e81a4

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"
@@ -51,24 +51,4 @@ jobs:
         ruby_version: ["2.7"]
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby_version }}
-      - uses: mirromutth/mysql-action@v1.1
-        with:
-          host port: 3306 # Optional, default value is 3306. The port of host
-          #container port: 3307 # Optional, default value is 3306. The port of container
-          character set server: 'utf8' # Optional, default value is 'utf8mb4'. The '--character-set-server' option for mysqld
-          collation server: 'utf8_general_ci' # Optional, default value is 'utf8mb4_general_ci'. The '--collation-server' option for mysqld
-          mysql version: '8.0' # Optional, default value is "latest". The version of the MySQL
-          mysql database: 'pact_broker' # Optional, default value is "test". The specified database which will be create
-          mysql root password: 'pact_broker' # Required if "mysql user" is empty, default is empty. The root superuser password
-          mysql user: 'pact_broker' # Required if "mysql root password" is empty, default is empty. The superuser for the specified database. Can use secrets, too
-          mysql password: 'pact_broker' # Required if "mysql user" exists. The password for the "mysql user"
-      - run: "bundle install"
-        env:
-          INSTALL_MYSQL: "true"
-      - run: "bundle exec rake"
-        env:
-          DATABASE_ADAPTER: github_actions_mysql
-          INSTALL_MYSQL: "true"
+      - run: script/test/run-rake-on-docker-compose-mysql.sh

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,72 @@
+<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)
+
+#### Features
+
+* allow overwritten data deletion to be configured with extra options	 ([fd809737](/../../commit/fd809737))
+* use the consumer version number in the metadata to select the correct consumer version for a pact version resource	 ([422c87fc](/../../commit/422c87fc))
+* return link to latest pact if more pacts exist when deleting pacts by tag	 ([b87ea704](/../../commit/b87ea704))
+* update output for clean dry run	 ([681a5ddd](/../../commit/681a5ddd))
+* update metrics output	 ([0617e9df](/../../commit/0617e9df))
+
 <a name="v2.71.0"></a>
 ### v2.71.0 (2020-11-28)
 

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
@@ -26,7 +27,7 @@ RUN wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSI
 
 
 COPY Gemfile /home/Gemfile
-COPY Gemfile.lock /home/Gemfile.lock
+# COPY Gemfile.lock /home/Gemfile.lock # lock file does not exist on CI
 COPY pact_broker.gemspec /home/pact_broker.gemspec
 COPY lib/pact_broker/version.rb /home/lib/pact_broker/version.rb
 COPY .gitignore /home/.gitignore
@@ -38,6 +39,10 @@ RUN echo '#!/bin/sh' >> /usr/local/bin/start
 RUN echo 'bundle exec rackup -o 0.0.0.0 -p 9292' >> /usr/local/bin/start
 RUN chmod +x /usr/local/bin/start
 
+RUN echo '#!/bin/sh' >> /usr/local/bin/test
+RUN echo 'bundle exec rake' >> /usr/local/bin/test
+RUN chmod +x /usr/local/bin/test
+
 RUN echo '#!/bin/sh' >> /home/init-db.sh
 RUN echo 'bundle exec rake db:prepare:test' >> /home/init-db.sh
 RUN chmod +x /home/init-db.sh

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-ci-mysql.yml

@@ -0,0 +1,37 @@
+version: "3"
+
+services:
+  mysql:
+    image: mysql:5.7.28
+    command: --default-authentication-plugin=mysql_native_password
+    environment:
+      MYSQL_ROOT_PASSWORD: pact_broker
+      MYSQL_DATABASE: pact_broker
+      MYSQL_USER: pact_broker
+      MYSQL_PASSWORD: pact_broker
+    ports:
+      - "3306:3306"
+
+  tests:
+    build: .
+    depends_on:
+      - mysql
+    environment:
+      DATABASE_ADAPTER: docker_compose_mysql
+      PACT_BROKER_HIDE_PACTFLOW_MESSAGES: 'true'
+      INSTALL_MYSQL: 'true'
+    volumes:
+      - ./lib:/home/lib
+      - ./spec:/home/spec
+      - ./db:/home/db
+      - ./config.ru:/home/config.ru
+      - ./tasks:/home/tasks
+      - ./Rakefile:/home/Rakefile
+      - ./config:/home/config
+      - ./.rspec:/home/.rspec
+      - ./.rubocop:/home/.rubocop
+      - ./.gitignore:/home/.gitignore
+      - ./public:/home/public
+      - ./script/docker-container/test.sh:/usr/local/bin/test
+    entrypoint: dockerize
+    command: --wait tcp://mysql:3306 -timeout 60s test

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