pact_broker 2.89.1 → 2.90.0

data/DEVELOPER_SETUP.md

@@ -1,165 +0,0 @@
-# Developer setup
-
-## Preparation
-
-### With Docker Compose
-
-The following command runs the application from the source code and binds it to port 9292 of your host. It mounts the source code as a volume, so changes to the code will be applied if you stop and start the containers (the app code doesn't hot reload however).
-
-```sh
-docker-compose -f docker-compose-dev-postgres.yml up --build
-```
-
-### With Docker
-
-This allows you to open a shell to a development environment where you can run the tests and rake tasts.
-
-* Build an initial local image with Docker
-
-    ```sh
-    docker build --rm -t pact_broker:dev .
-    ```
-
-* Spin up a container with mounted volume and open an interactive shell session
-
-    ```sh
-    docker run --rm -v $(PWD):/home -w /home -it pact_broker:dev bash
-    ```
-
-Remember to rebuild the image if you change any of the gems or gem versions.
-
-* Run the server on the docker image
-
-    ```sh
-    docker run --rm -v $(PWD):/home -w /home --entrypoint /bin/sh -p 9292:9292 -it pact_broker:dev /usr/local/bin/start
-    ```
-
-### With native install
-
-* You will need to install Ruby 2.7, and preferably a ruby version manager. I recommend using [chruby][chruby] and [ruby-install][ruby-install].
-* Install bundler (the Ruby gem dependency manager) `gem install bundler`
-* Check out the pact_broker repository and cd into it.
-* Run `bundle install`. If you have any gem conflict issues, run `bundle update`.
-
-To make the barrier to entry as low as possible, the mysql2 and pg gems are not installed by default, as they require mysql and postgres to be installed on your local machine. If you want to install them, set `INSTALL_MYSQL=true` and/or `INSTALL_PG=true` before running `bundle install`.
-
-## Running a local application
-
-* Install Ruby and the gems as per the instructions above.
-* Run `bundle exec rackup`.
-* The application will be available on `http://localhost:9292`. It uses a sqlite database that is stored in the `./tmp` directory.
-
-You can set the `PACT_BROKER_DATABASE_URL` environment variable to use a postgres/mysql database using the format `driver://username:password@host:port/database` eg. `postgres://pact_broker:password@localhost/pact_broker`. Ensure you have set `INSTALL_MYSQL=true` or `INSTALL_PG=true` and run `bundle install` to make sure the required gems are present.
-
-## Listing the routes
-
-```
-bundle exec rake pact_broker:routes
-```
-
-## Running the tests with postgres and mysql
-
-```
-docker-compose -f docker-compose-test.yml up --build --remove-orphans
-
-# in separate console window...
-docker-compose -f docker-compose-test.yml run --rm postgres-tests bash
-
-# in separate console window...
-docker-compose -f docker-compose-test.yml run --rm mysql-tests bash
-
-# inside the tests container
-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 a postgresql client in the postgres-tests container:
-
-```
-psql postgres://postgres:postgres@postgres/postgres
-```
-
-## Running the tests
-
-* To run everything (specs, pact verifications, vulnerability scan...):
-  ```sh
-  bundle exec rake
-  ```
-* To set up the database (this is done automatically when running the default rake task, but if you want to run a different task without running the default task first, this must be run once beforehand):
-  ```sh
-  bundle exec rake db:prepare:test
-  ```
-* To run a smaller subset of the tests:
-  ```sh
-  bundle exec rake spec
-  ```
-* To run the "quick tests" (skip the lengthy migration specs and db setup)
-  ```sh
-  bundle exec rake spec:quick
-  ```
-* To run a single spec:
-  ```sh
-  bundle exec rspec path_to_your_spec.rb
-  ```
-
-## Running the regression tests
-
-The regression tests record a series of API requests/responses using a real exported database (not included in the git repository because of the size) and store the expectations in files using the Approvals gem. They allow you to make sure that the changes you have made have not made any (unexpected) changes to the interface.
-
-The tests and files are stored in the [regression](regression) directory.
-
-To run:
-
-1. Set up your local development environment as described above, making sure you have `INSTALL_PG=true` exported in your shell.
-
-1. Make sure you have the master branch checked out.
-
-1. Load an exported real database into a postgres docker image. The exported file must be in the pg dump format to use this script, and it must be located in the project root directory for it to be found via the mounted directory.
-
-    ```
-    script/docker/restore.sh <export>
-
-    ```
-1. Clear any previously generated approvals.
-
-    ```
-    regression/script/clear.sh
-    ```
-
-1. Run the tests. They will fail because there are no approval files yet.
-
-    ```
-    regression/script/run.sh
-    ```
-
-1. Approval all the things.
-
-    ```
-    regression/script/approval-all.sh
-    ```
-
-1. Run the tests again to make sure that the same results can be expected each time.
-
-    ```
-    regression/script/run.sh
-    ```
-
-1. Check out the feature branch (or enable the feature toggle)
-
-1. Run the tests again.
-    ```
-    regression/script/run.sh
-    ```
-
-1. If there is a diff, you can set `SHOW_REGRESSION_DIFF=true`, but the output is quite noisy, and you're probably better off using diff or diffmerge to view the differences.
-
-[chruby]: https://github.com/postmodern/chruby
-[ruby-install]: https://github.com/postmodern/ruby-install

data/Dockerfile

@@ -1,52 +0,0 @@
-FROM ruby:2.7.4-alpine3.13
-
-WORKDIR /home
-
-ENV INSTALL_MYSQL=true
-ENV INSTALL_PG=true
-RUN apk update \
-    && apk --no-cache add \
-      "build-base>=0.5" \
-      "bash>=4.4" \
-      "ca-certificates>=20190108" \
-      "git>=2.20" \
-      "postgresql-dev>=11.3" \
-      "sqlite-dev>=3.28" \
-      "sqlite>=3.28" \
-      "tzdata>=2019" \
-      "mariadb-dev>=10.3" \
-      "mysql-client>=10.3.25" \
-      "postgresql-client>=11.10" \
-    && rm -rf /var/cache/apk/*
-
-RUN apk add --no-cache openssl less
-
-ENV DOCKERIZE_VERSION v0.6.1
-RUN wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
-    && tar -C /usr/local/bin -xzvf dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
-    && rm dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz
-
-
-COPY Gemfile /home/Gemfile
-# 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
-
-RUN gem install bundler -v '~>2.0.0' \
-    && bundle install --jobs 3 --retry 3
-
-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
-
-ENTRYPOINT bash
-CMD []

data/ISSUES.md

@@ -1,31 +0,0 @@
-# Issues
-
-## Reproducing an issue
-
-In [script/reproduce-issue.rb](script/reproduce-issue.rb) you will find an example fluent API script that allows you to simulate client libraries interacting with the Pact Broker.
-
-You can use it to easily reproduce issues. You will need Docker and Docker Compose installed (but not Ruby).
-
-To use it:
-
-* 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.
-
-    ```
-    git clone git@github.com:pact-foundation/pact_broker.git
-    cd pact_broker
-
-    docker-compose  -f docker-compose-issue-repro-with-pact-broker-docker-image.yml up pact-broker
-
-    # if needing webhooks - run this in a new window so the logs are clearer
-    docker-compose -f docker-compose-issue-repro-with-pact-broker-docker-image.yml up webhook-server
-
-    ```
-
-* Run the reproduction script.
-
-    ```
-    # in a new shell
-    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/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Bethany Skurrie
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/MATRIX.md

@@ -1,4 +0,0 @@
-# Interpreting the Matrix results
-
-* If there is a row with a blank provider version, it's because the pact for that consumer version hasn't been verified by that provider (the result of a left outer join).
-* If there is no row, it's because it has been verified, but not by the provider version you've specified.

data/RELEASING.md

@@ -1,5 +0,0 @@
-# Releasing
-
-Run
-
-    script/release.sh [major|minor|patch] # default is minor

data/Rakefile

@@ -1,23 +0,0 @@
-# encoding: utf-8
-require "bundler/gem_tasks"
-
-require "rubygems"
-require "bundler"
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
-FileList["lib/tasks/**/*.rake"].each { |task| load "#{Dir.pwd}/#{task}" }
-FileList["tasks/**/*.rake"].each { |task| load "#{Dir.pwd}/#{task}" }
-
-task :default => ["db:prepare:test", :boot, :spec, "pact:verify", "bundle:audit"]
-
-task :ci => ["db:prepare:test", :boot, :spec]
-
-task :boot do
-  require File.join(File.dirname(__FILE__), "config/boot")
-end

data/UPGRADING.md

@@ -1,18 +0,0 @@
-# Upgrading from a previous version of the Pact Broker
-
-## Pact Broker versions >= 2.1.0
-
-Backwards compatibility tests will ensure that the latest version of the database will be compatible with a previous version of the code until v3.0.0 for the following endpoints:
-
-* Tag version
-* Publish pact
-* Retrieve latest pact
-* Retrieve latest pact for tag
-
-This means that zero downtime rolling upgrades for architectures that use multiple web servers (eg. Amazon autoscaling groups) are supported between any two versions from 2.1.0.
-
-When backwards-incompatible changes need to be made in the future, a zero downtime upgrade path will documented on this page.
-
-## Pact Broker < 2.1.0
-
-The upgrades between 1.18.0 and 2.1.0 contains database migrations that are NOT backwards compatible with previous versions of the code. It is recommended to run a single instance of the broker while performing an upgrade that traverses these versions.

data/config/boot.rb

@@ -1,21 +0,0 @@
-# Remember everything in this file will be loaded by Rake, don't make it too heavy...
-
-$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + "/../lib")
-
-# Default environment
-# Be aware that rake loads this boot file, so any attempt to change RACK_ENV by
-# setting ENV['RACK_ENV'] after that (eg. in spec_helper) will not work.
-RACK_ENV = ENV["RACK_ENV"] || "development" unless defined? RACK_ENV
-
-# Set up gems listed in the Gemfile.
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
-if File.exist?(ENV["BUNDLE_GEMFILE"])
-  require "bundler/setup"
-  Bundler.require
-end
-
-if defined?(I18n)
-  I18n.enforce_available_locales = false
-end
-
-require "pact_broker"

data/config/database.travis.yml

@@ -1,13 +0,0 @@
-test:
-  default:
-    adapter: sqlite
-    database: tmp/pact_broker_database_test.sqlite3
-  postgres:
-    adapter: postgres
-    database: pact_broker
-    encoding: utf8
-  mysql:
-    adapter: mysql2
-    database: pact_broker
-    username: travis
-    encoding: utf8

data/config/database.yml

@@ -1,79 +0,0 @@
-default: &default
-  database: pact_broker
-  username: pact_broker
-  password: pact_broker
-  encoding: utf8
-
-test:
-  default:
-    adapter: sqlite
-    database: tmp/pact_broker_database_test.sqlite3
-  postgres:
-    <<: *default
-    adapter: postgres
-  docker_postgres:
-    adapter: postgres
-    database: postgres
-    username: postgres
-    password: postgres
-    host: localhost
-    port: "5432"
-  docker_compose_postgres:
-    adapter: postgres
-    database: postgres
-    username: postgres
-    password: postgres
-    host: postgres
-    port: "5432"
-  mysql:
-    <<: *default
-    adapter: mysql2
-  docker_compose_mysql:
-    <<: *default
-    adapter: mysql2
-    host: mysql
-  docker_mysql:
-    <<: *default
-    adapter: mysql2
-    host: "192.168.0.9"
-  github_actions_postgres:
-    adapter: postgres
-    database: postgres
-    username: postgres
-    password: postgres
-    host: localhost
-    port: "5432"
-  github_actions_mysql:
-    adapter: mysql2
-    database: pact_broker
-    username: pact_broker
-    password: pact_broker
-    host: localhost
-    port: 3306
-
-development:
-  default:
-    adapter: sqlite
-    database: db/pact_broker_database.sqlite3
-  postgres:
-    <<: *default
-    adapter: postgres
-  docker_postgres:
-    adapter: postgres
-    database: postgres
-    username: postgres
-    password: postgres
-    host: localhost
-    port: "5432"
-  mysql:
-    <<: *default
-    adapter: mysql2
-  docker_mysql:
-    <<: *default
-    adapter: mysql2
-    host: localhost
-
-production:
-  default:
-    <<: *default
-    adapter: postgres

data/config.ru

@@ -1,11 +0,0 @@
-require "pact_broker"
-
-ENV["TZ"] = "Australia/Melbourne"
-
-app = PactBroker::App.new do | config |
-  config.log_stream = :stdout
-  config.base_urls = ["http://localhost:9292"]
-  config.database_url = "sqlite:////tmp/pact_broker_database.sqlite3"
-end
-
-run app

data/db/test/backwards_compatibility/.rspec

@@ -1,3 +0,0 @@
---color
---format documentation
---require spec_helper

data/db/test/backwards_compatibility/Appraisals

@@ -1,57 +0,0 @@
-# appraise "1.1.0" do
-#   gem "pact_broker", "1.1.0"
-#   gem "roar", "~>0.1"
-#   gem "sequel", "4.13.0"
-#   gem "webmachine", "1.2.2"
-# end
-
-# appraise "1.2.0" do
-#   gem "pact_broker", "1.2.0"
-#   gem "sequel", "4.13.0"
-#   gem "webmachine", "1.2.2"
-# end
-
-appraise "1.18.0" do
-  gem "pact_broker", "1.18.0"
-  gem "dry-types", "0.10"
-end
-
-appraise "2.0.0" do
-  gem "pact_broker", "2.0.0"
-  gem "dry-types", "0.10"
-end
-
-appraise "2.0.0" do
-  gem "pact_broker", "2.0.0"
-  gem "dry-types", "0.10"
-end
-
-appraise "2.1.0" do
-  gem "pact_broker", "2.1.0"
-  gem "dry-types", "0.10"
-end
-
-appraise "2.2.0" do
-  gem "pact_broker", "2.2.0"
-  gem "dry-types", "0.10.3"
-end
-
-appraise "2.3.0" do
-  gem "pact_broker", "2.3.0"
-end
-
-appraise "2.4.2" do
-  gem "pact_broker", "2.4.2"
-end
-
-appraise "2.5.1" do
-  gem "pact_broker", "2.5.1"
-end
-
-appraise "2.6.0" do
-  gem "pact_broker", "2.5.1"
-end
-
-appraise "head" do
-  gem "pact_broker", path: "../../../"
-end

data/db/test/backwards_compatibility/Gemfile

@@ -1,12 +0,0 @@
-source "https://rubygems.org"
-
-gem "pact_broker"
-gem "sqlite3", "~>1.3"
-gem "pg", "~>0.21"
-gem "mysql2", "~>0.3.15"
-gem "thin", "~>1.3"
-gem "appraisal"
-gem "rspec"
-gem "rake", "~>12.0"
-gem "rack-reverse-proxy", "~>0.12"
-gem "rack-test"

data/db/test/backwards_compatibility/Rakefile

@@ -1,72 +0,0 @@
-require "rspec/core"
-require "rspec/core/rake_task"
-require "open-uri"
-
-TESTS = [
-  %w{2.1.0 9293},
-  %w{2.2.0 9294},
-  %w{2.3.0 9295},
-  %w{2.4.2 9296},
-  %w{2.5.1 9297},
-  %w{2.6.0 9298},
-  %w{head  9299}
-]
-
-DATABASE_VERSION = TESTS.first.first
-
-def start_pact_broker code_version, port
-  Bundler.with_clean_env do
-    command = "bundle exec appraisal #{code_version} rackup -p #{port}"
-    puts command
-    IO.popen(command)
-  end
-  sleep 4
-end
-
-def kill_servers
-  Dir.chdir("pids") { Dir.glob("*") }.collect(&:to_i).each do | pid |
-    begin
-      puts "Killing broker with pid #{pid}"
-      Process.kill "KILL", pid
-    rescue Errno::ESRCH
-      puts "Process with pid #{pid} already killed"
-    end
-  end
-  sleep 2
-end
-
-def clean
-  require "fileutils"
-  FileUtils.rm_rf "pids"
-  FileUtils.mkdir "pids"
-  FileUtils.rm_rf "pact_broker_database.sqlite3"
-  FileUtils.rm_rf "log"
-end
-
-RSpec::Core::RakeTask.new(:spec) do |task|
-  task.pattern = "spec/**/*_spec.rb"
-end
-
-desc "Ensure code from previous versions is compatible with latest database"
-task "db:check_backwards_compatibility" do
-  ENV["PACT_BROKER_DATABASE_VERSION"] = DATABASE_VERSION
-  clean
-  begin
-    TESTS.each do | (code_version, port) |
-      start_pact_broker code_version, port
-    end
-
-    # All the brokers must be started before we run the tests
-    # so that we have the latest version of the db running
-
-    TESTS.each do | (code_version, port) |
-      ENV["PACT_BROKER_CODE_VERSION"] = code_version
-      ENV["PORT"] = port
-      Rake::Task["spec"].execute
-    end
-  ensure
-    kill_servers
-  end
-end
-
-task :default => ["db:check_backwards_compatibility"]

data/db/test/backwards_compatibility/config.ru

@@ -1,21 +0,0 @@
-require "fileutils"
-require "logger"
-require "sequel"
-require "pact_broker"
-
-FileUtils.mkdir_p "pids"
-FileUtils.touch "pids/#{Process.pid}"
-
-DATABASE_CREDENTIALS = {adapter: "sqlite", database: "pact_broker_database.sqlite3", :encoding => "utf8"}
-
-app = PactBroker::App.new do | config |
-  config.logger.formatter = proc do |severity, _datetime, _progname, msg|
-    "v#{PactBroker::VERSION} #{severity} -- : #{msg}\n"
-  end
-  config.database_connection = Sequel.connect(DATABASE_CREDENTIALS.merge(:logger => config.logger))
-  config.auto_migrate_db = true
-end
-
-PactBroker.logger.info "Running PactBroker #{PactBroker::VERSION}"
-
-run app

data/db/test/backwards_compatibility/gemfiles/1.18.0.gemfile

@@ -1,15 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pact_broker", "1.18.0"
-gem "sqlite3", "~>1.3"
-gem "pg", "~>0.21"
-gem "mysql2", "~>0.3.15"
-gem "thin", "~>1.3"
-gem "appraisal"
-gem "rspec"
-gem "rake", "~>12.0"
-gem "rack-reverse-proxy", "~>0.12"
-gem "rack-test"
-gem "dry-types", "0.10"