pact_broker 2.74.0 → 2.76.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a3779dfce4701e31c25e10a37154785df8745aa022869f70bcdd3c080066169
-  data.tar.gz: d9c48a07a42949aea37a84ca43930a53d6403abe02a96d1c1de2d58a27d763bc
+  metadata.gz: cdc8ed42038e4b622005f53471a000d870efd99a6dbd6b773aa9e8a3f9a993cb
+  data.tar.gz: d2f42cd3e13007471cdd33fabbe515afa9c9ff4896566868accd9961f66f557f
 SHA512:
-  metadata.gz: 2a4a61fe0838766004ab06723b406d51149d748ec449c81139ada966a223b5491d4728fa0cdd52d6e369081af490eb03b4b7036c12c6f2a6b014bf20608c9d68
-  data.tar.gz: 569774601622663f53d824d40b0013afd6728f0c603fb9f2f8d66f759603daf7d361d6481003dc83a2a844415d93eae78694a076be1172eb45728d678cd672a2
+  metadata.gz: a250f5f452356d3a9eb87659933cc47d0e947b7ce10a8c984d7cd296a28bc9be7dcfe82bd37fba29919f570a949b9b4a46b1622d6d242b92698268e54018aadf
+  data.tar.gz: c136cbe836ed813de2819480cf3347de86248f00258e0f8e89ec33375cf0c929186a65c51ef620995c11d2c596d496bec858c430894f80bacd6f647877f4af3e

data/.github/workflows/test.yml

@@ -5,12 +5,18 @@ on: push
 jobs:
   sqlite:
     runs-on: "ubuntu-latest"
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
+      fail-fast: false
       matrix:
         ruby_version: ["2.7"]
+        experimental: [false]
+        include:
+          - ruby_version: "3.0"
+            experimental: true
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}
       - run: "bundle install"
@@ -34,7 +40,7 @@ jobs:
           - 5432:5432
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}
       - run: "gem install bundler && bundle install"

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,54 @@
+<a name="v2.76.2"></a>
+### v2.76.2 (2021-01-29)
+
+#### Bug Fixes
+
+* trigger one webhook for each pact publication that the verified content belongs to when using the 'pacts for verification' API (#378)	 ([114ccad0](/../../commit/114ccad0))
+
+<a name="v2.76.1"></a>
+### v2.76.1 (2021-01-28)
+
+#### Bug Fixes
+
+* deduplicate wip pacts by content	 ([0af90776](/../../commit/0af90776))
+* message when pending pact is verified successfully for the first time (#376)	 ([4fc69190](/../../commit/4fc69190))
+* use base URL from rack env in UI	 ([5bf21324](/../../commit/5bf21324))
+
+<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)
 

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,24 @@ 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
+    # might need to try twice if it doesn't connect to postgres
+    docker-compose  -f docker-compose-issue-repro-with-pact-broker-docker-image.yml up pact-broker
+
+    # if needing webhooks - new window
+    docker-compose -f docker-compose-issue-repro-with-pact-broker-docker-image.yml up webhook-server
+
+    # new window
+    docker-compose -f docker-compose-issue-repro-with-pact-broker-docker-image.yml run repro-issue
+
     ```
 
 * 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 run 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)
@@ -116,7 +116,7 @@ Use the HAL browser to view documentation as you browse.
 
 ### To have a play around on your local machine
 
-* Install ruby 2.2.0 or later and bundler >= 1.12.0
+* Install Ruby and Bundler (check the automated tests to find the most recent version of Ruby and Bundler that are supported)
     * Windows users: get a Rails/Ruby installer from [RailsInstaller](http://railsinstaller.org/) and run it
     * unix users just use your package manager
 * Run `git clone git@github.com:pact-foundation/pact_broker.git && cd pact_broker/example`

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,44 @@
+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.76.0.0
+    ports:
+      - "9292:9292"
+    # depends_on:
+    #   - postgres
+    environment:
+      PACT_BROKER_PORT: '9292'
+      #PACT_BROKER_DATABASE_URL: "postgres://postgres:password@postgres/postgres"
+      PACT_BROKER_DATABASE_URL: "sqlite:////tmp/pact_broker.sqlite3"
+      PACT_BROKER_LOG_LEVEL: INFO
+      PACT_BROKER_SQL_LOG_LEVEL: DEBUG
+      PACT_BROKER_WEBHOOK_SCHEME_WHITELIST: "http https"
+      PACT_BROKER_WEBHOOK_HOST_WHITELIST: "/.*/"
+
+  repro-issue:
+    build: .
+    depends_on:
+      - pact-broker
+    command: -wait http://pact-broker:9292 -timeout 30s /home/script/reproduce-issue.rb
+    entrypoint: dockerize
+    environment:
+      - PACT_BROKER_BASE_URL=http://pact-broker:9292
+    volumes:
+      - $PWD:/home
+    working_dir: /home
+
+  webhook-server:
+    build: .
+    entrypoint: ["/bin/sh", "-c", "bundle exec rackup -p 9393 -o 0.0.0.0 /home/script/webhook-server.ru"]
+    volumes:
+      - ./script/webhook-server.ru:/home/script/webhook-server.ru

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