pact_broker 2.79.1 → 2.80.0

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.7.3

data/CHANGELOG.md

@@ -1,12 +1,76 @@
-<a name="v2.79.1"></a>
-### v2.79.1 (2021-03-01)
+<a name="v2.80.0"></a>
+### v2.80.0 (2021-07-06)
+
+#### Features
+
+* filter pacticipant name on index page (#446)	 ([fd882da4](/../../commit/fd882da4))
+* add uuid to webhook decorator	 ([3a916064](/../../commit/3a916064))
+* add endpoint to list currently supported versions for an environment	 ([9608be8b](/../../commit/9608be8b))
+* support marking a released version as unsupported	 ([f6c4ee27](/../../commit/f6c4ee27))
+* add pactbroker.azureDevOpsVerificationStatus webhook parameter	 ([8804a90f](/../../commit/8804a90f))
+* add deployed version resource, supporting marking deployed version as undeployed	 ([3dd19955](/../../commit/3dd19955))
+* add warnings to can-i-deploy response when bad practice selectors are used	 ([85540c85](/../../commit/85540c85))
+* support PATCH for pacticipant with application/merge-patch+json	 ([404e14cb](/../../commit/404e14cb))
+* set main branch for pacticipant	 ([ab1cd016](/../../commit/ab1cd016))
+* rename writeMode to onConflict for contract publishing endpoint	 ([26a4e358](/../../commit/26a4e358))
+* replace mainDevelopmentBranches with mainBranch for pacticipant	 ([02d4525e](/../../commit/02d4525e))
+* updating pending and wip logic to exclude pacts already verified by another branch before the specified branch was created (#432)	 ([db643d3c](/../../commit/db643d3c))
+* ignore pacticipant for can i deploy (#429)	 ([25e62fd9](/../../commit/25e62fd9))
+* add notices to contract publishing response, with intent to rem… (#430)	 ([dacbe906](/../../commit/dacbe906))
+* support deployments and releases as separate concepts (#426)	 ([58d173db](/../../commit/58d173db))
+* keep the triggered webhooks after the webhook has been deleted	 ([a5ab2a35](/../../commit/a5ab2a35))
+* add endpoint to create pacts, pacticipant, version, tags in one request (#420)	 ([df899ebd](/../../commit/df899ebd))
+* add pb:version relation to the pacticipant resource	 ([83ce38a4](/../../commit/83ce38a4))
+* add repository and branch properties to pacticipant	 ([98a799b2](/../../commit/98a799b2))
+* currently deployed selector (#396)	 ([8666d709](/../../commit/8666d709))
+* add relations to environments endpoint for each environment	 ([784c3535](/../../commit/784c3535))
+* allow multiple base URLs to be configured	 ([f88c69de](/../../commit/f88c69de))
+* support recording deployments (#389)	 ([19ac1fcc](/../../commit/19ac1fcc))
+
+* **pacts for verification**
+  * support released:true selector (#451)	 ([8a90cc57](/../../commit/8a90cc57))
+  * default latest to true when branch is specified and currentlyDeployed to true when an environment is specified	 ([984320b6](/../../commit/984320b6))
+  * display selectors in a formatted list	 ([3cab7a00](/../../commit/3cab7a00))
+  * update validation for consumer version selectors for the fields environment, currentlyDeployed and branch	 ([ec7dc435](/../../commit/ec7dc435))
+
+* **webhooks**
+  * support consumerVersionBranch and providerVersionBranch in the template parameters	 ([6637644f](/../../commit/6637644f))
+  * support ${pactbroker.currentlyDeployedProviderVersionNumber} in webhook templates (#402)	 ([1e5487f8](/../../commit/1e5487f8))
+
+* **matrix**
+  * support querying by branch	 ([110578dc](/../../commit/110578dc))
+
+* **pacticipant versions**
+  * support use of PATCH with application/merge-patch+json to create versions	 ([0429398f](/../../commit/0429398f))
+  * do not allow branch to be modified once set	 ([4aa8e121](/../../commit/4aa8e121))
+
+* **record deployment**
+  * require replacedPreviousDeployedVersion to be set	 ([70398069](/../../commit/70398069))
+
+* **environments**
+  * validate environment name in can-i-deploy and matrix queries	 ([dcad5fb5](/../../commit/dcad5fb5))
+  * allow environments endpoint to be searched by name	 ([ce4b188e](/../../commit/ce4b188e))
+
+* **deployed versions**
+  * add endpoint to list deployed versions for an environment	 ([bd0ca9d6](/../../commit/bd0ca9d6))
 
 #### Bug Fixes
 
-* lock reform gem	 ([53aa92f8](/../../commit/53aa92f8))
+* add rubocop and fix offenses (#441)	 ([7c1c3044](/../../commit/7c1c3044))
+* gracefully handle an interactions value that is not an array	 ([a9a5df3d](/../../commit/a9a5df3d))
+* Dockerfile to reduce vulnerabilities (#418)	 ([5319a997](/../../commit/5319a997))
+* select pact publication with matching consumer version when triggering webhook for verification	 ([274e1456](/../../commit/274e1456))
+* issue-reproduction/Dockerfile-pact-broker to reduce vulnerabilities (#414)	 ([34c70984](/../../commit/34c70984))
+* use URL safe base64 encoding for pact metadata	 ([fa1a3333](/../../commit/fa1a3333))
+* handle metadata that has had its padding removed	 ([06bd6d3d](/../../commit/06bd6d3d))
+* lock reform gem	 ([00cbac8c](/../../commit/00cbac8c))
+* fix missing verification status colours in matrix rows	 ([d91662d9](/../../commit/d91662d9))
+
+* **verifications**
+  * gracefully handle a verification number in the URL that is not an integer	 ([7fe98a7d](/../../commit/7fe98a7d))
 
 * **ui**
-  * Make long pacticipant versions look nice (#407)	 ([96b50572](/../../commit/96b50572))
+  * Make long pacticipant versions look nice (#407)	 ([dbb967e3](/../../commit/dbb967e3))
 
 <a name="v2.79.0"></a>
 ### v2.79.0 (2021-02-25)

data/DEVELOPER_SETUP.md

@@ -51,6 +51,12 @@ To make the barrier to entry as low as possible, the mysql2 and pg gems are not
 
 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
 
 ```

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.5.3-alpine
+FROM ruby:2.7.3-alpine3.13
 
 WORKDIR /home
 

data/Gemfile

@@ -1,42 +1,44 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'rake', '~>12.3.3'
-gem 'sqlite3', '~>1.3'
-gem 'conventional-changelog', '~>1.3'
-gem 'bump', '~> 0.5'
+gem "rake", "~>12.3.3"
+gem "sqlite3", "~>1.3"
+gem "conventional-changelog", "~>1.3"
+gem "bump", "~> 0.5"
 
 group :development do
-  gem 'pry-byebug'
-  gem 'sequel-annotate', '~>1.3'
+  gem "pry-byebug"
+  gem "rubocop", "~>1.1"
+  gem "rubocop-performance", "~> 1.11"
+  gem "sequel-annotate", "~>1.3"
 end
 
 group :test do
-  gem 'simplecov', :require => false
-  gem 'pact', '~>1.14'
-  gem 'rspec-pact-matchers', '~>0.1'
-  gem 'bundler-audit', '~>0.4'
-  gem 'fakefs', '~>0.4'
-  gem 'webmock', '~>3.9'
-  gem 'rspec', '~>3.0'
-  gem 'rspec-its', '~>1.2'
-  gem 'database_cleaner', '~>1.8', '>= 1.8.1'
-  gem 'timecop', '~> 0.9'
-  gem 'faraday', '~>0.15'
-  gem 'faraday_middleware', '~> 0.14'
-  gem 'docker-api', '~>1.34'
-  gem 'approvals', '>=0.0.1', '<1.0.0'
+  gem "simplecov", :require => false
+  gem "pact", "~>1.14"
+  gem "rspec-pact-matchers", "~>0.1"
+  gem "bundler-audit", "~>0.4"
+  gem "fakefs", "~>0.4"
+  gem "webmock", "~>3.9"
+  gem "rspec", "~>3.0"
+  gem "rspec-its", "~>1.2"
+  gem "database_cleaner", "~>1.8", ">= 1.8.1"
+  gem "timecop", "~> 0.9"
+  gem "faraday", "~>0.15"
+  gem "faraday_middleware", "~> 0.14"
+  gem "docker-api", "~>1.34"
+  gem "approvals", ">=0.0.24", "<1.0.0"
 end
 
-if ENV['INSTALL_MYSQL'] == "true"
-  gem 'mysql2', '~>0.5'
+if ENV["INSTALL_MYSQL"] == "true"
+  gem "mysql2", "~>0.5"
 end
 
-if ENV['INSTALL_PG'] == 'true'
-  gem 'pg', '~>1.2'
+if ENV["INSTALL_PG"] == "true"
+  gem "pg", "~>1.2"
 end
 
-if ENV['X_PACT_DEVELOPMENT'] == 'true'
-  gem 'pact-support', path: '../pact-support'
-end
+if ENV["X_PACT_DEVELOPMENT"] == "true"
+  gem "pact-support", path: "../pact-support"
+end

data/Rakefile

@@ -1,8 +1,8 @@
 # encoding: utf-8
 require "bundler/gem_tasks"
 
-require 'rubygems'
-require 'bundler'
+require "rubygems"
+require "bundler"
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -11,11 +11,13 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
-FileList['lib/tasks/**/*.rake'].each { |task| load "#{Dir.pwd}/#{task}" }
-FileList['tasks/**/*.rake'].each { |task| load "#{Dir.pwd}/#{task}" }
+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 :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')
+  require File.join(File.dirname(__FILE__), "config/boot")
 end

data/config.ru

@@ -1,14 +1,14 @@
-require 'fileutils'
-require 'logger'
-require 'sequel'
-require 'pact_broker'
+require "fileutils"
+require "logger"
+require "sequel"
+require "pact_broker"
 
-FileUtils.mkdir_p('tmp') unless ENV['PACT_BROKER_DATABASE_URL']
+FileUtils.mkdir_p("tmp") unless ENV["PACT_BROKER_DATABASE_URL"]
 
-DATABASE_URL = ENV['PACT_BROKER_DATABASE_URL'] || 'sqlite://tmp/pact_broker_database.sqlite3'
-DB_OPTIONS = { encoding: 'utf8', sql_log_level: :debug }
+DATABASE_URL = ENV["PACT_BROKER_DATABASE_URL"] || "sqlite://tmp/pact_broker_database.sqlite3"
+DB_OPTIONS = { encoding: "utf8", sql_log_level: :debug }
 
-ENV['TZ'] = 'Australia/Melbourne'
+ENV["TZ"] = "Australia/Melbourne"
 
 SemanticLogger.add_appender(io: $stderr)
 SemanticLogger.default_level = :info
@@ -24,10 +24,10 @@ app = PactBroker::App.new do | config |
 
   config.webhook_retry_schedule = [3, 3, 3]
   config.webhook_host_whitelist = [/.*/, "10.0.0.0/8"]
-  config.webhook_scheme_whitelist = ['http', 'https']
-  config.webhook_http_method_whitelist = ['GET', 'POST']
+  config.webhook_scheme_whitelist = ["http", "https"]
+  config.webhook_http_method_whitelist = ["GET", "POST"]
   config.webhook_http_code_success = [200, 201, 202, 203, 204, 205, 206]
-  config.base_url = ENV['PACT_BROKER_BASE_URL']
+  config.base_url = ENV["PACT_BROKER_BASE_URL"]
 
   database_logger = PactBroker::DB::LogQuietener.new(config.logger)
   config.database_connection = Sequel.connect(DATABASE_URL, DB_OPTIONS.merge(logger: database_logger))

data/config/boot.rb

@@ -1,16 +1,16 @@
 # 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')
+$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
+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.exists?(ENV['BUNDLE_GEMFILE'])
-  require 'bundler/setup'
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+if File.exist?(ENV["BUNDLE_GEMFILE"])
+  require "bundler/setup"
   Bundler.require
 end
 
@@ -18,4 +18,4 @@ if defined?(I18n)
   I18n.enforce_available_locales = false
 end
 
-require 'pact_broker'
+require "pact_broker"

data/db/ddl_statements/latest_pact_consumer_version_orders.rb

@@ -1,7 +1,7 @@
 # The consumer id, provider id, and consumer version order
 # for the latest consumer version that has a pact with that provider.
 
-def latest_pact_consumer_version_orders_v1(connection = nil)
+def latest_pact_consumer_version_orders_v1(_connection = nil)
   "select provider_id, consumer_id, max(consumer_version_order) as latest_consumer_version_order
   from all_pact_publications
   group by provider_id, consumer_id"

data/db/ddl_statements/latest_pact_publications_by_consumer_versions.rb

@@ -1,4 +1,4 @@
-def latest_pact_publications_by_consumer_versions_v2(connection = nil)
+def latest_pact_publications_by_consumer_versions_v2(_connection = nil)
   "select app.*
   from latest_pact_publication_ids_for_consumer_versions lpp
   inner join all_pact_publications app
@@ -8,7 +8,7 @@ def latest_pact_publications_by_consumer_versions_v2(connection = nil)
 end
 
 # Don't need all the join keys, just pact_publication_id
-def latest_pact_publications_by_consumer_versions_v3(connection)
+def latest_pact_publications_by_consumer_versions_v3(_connection)
   "select app.*
   from latest_pact_publication_ids_for_consumer_versions lpp
   inner join all_pact_publications app

data/db/migrations/000001_create_pacticipant_table.rb

@@ -1,6 +1,6 @@
 Sequel.migration do
   change do
-    create_table(:pacticipants, charset: 'utf8') do
+    create_table(:pacticipants, charset: "utf8") do
       primary_key :id
       String :name, :unique => true
       String :repository_url

data/db/migrations/000002_create_versions_table.rb

@@ -1,7 +1,7 @@
 Sequel.migration do
 
   change do
-    create_table(:versions, charset: 'utf8') do
+    create_table(:versions, charset: "utf8") do
       primary_key :id
       String :number
       String :repository_ref

data/db/migrations/000003_create_pacts_table.rb

@@ -1,6 +1,6 @@
 Sequel.migration do
   change do
-    create_table(:pacts, charset: 'utf8') do
+    create_table(:pacts, charset: "utf8") do
       primary_key :id
       String :json_content, :text=>true
       foreign_key :version_id, :versions, null: false

data/db/migrations/000004_create_tags_table.rb

@@ -1,6 +1,6 @@
 Sequel.migration do
   change do
-    create_table(:tags, charset: 'utf8') do
+    create_table(:tags, charset: "utf8") do
       String :name
       foreign_key :version_id, :versions
       primary_key [:version_id, :name], name: :tags_pk

data/db/migrations/000007_increase_json_content_length.rb

@@ -1,4 +1,4 @@
-require_relative 'migration_helper'
+require_relative "migration_helper"
 
 Sequel.migration do
   change do

data/db/migrations/000012_create_webhooks_table.rb

@@ -1,20 +1,20 @@
 Sequel.migration do
   change do
-    create_table(:webhooks, charset: 'utf8') do
+    create_table(:webhooks, charset: "utf8") do
       primary_key :id
-      String :uuid, null: false, unique: true, unique_constraint_name: 'uq_webhook_uuid'
+      String :uuid, null: false, unique: true, unique_constraint_name: "uq_webhook_uuid"
       String :method, null: false
       String :url, null: false
       String :body
       Boolean :is_json_request_body
-      foreign_key :consumer_id, :pacticipants, null: false, foreign_key_constraint_name: 'fk_webhooks_consumer'
-      foreign_key :provider_id, :pacticipants, null: false, foreign_key_constraint_name: 'fk_webhooks_provider'
+      foreign_key :consumer_id, :pacticipants, null: false, foreign_key_constraint_name: "fk_webhooks_consumer"
+      foreign_key :provider_id, :pacticipants, null: false, foreign_key_constraint_name: "fk_webhooks_provider"
     end
 
-    create_table(:webhook_headers, charset: 'utf8') do
+    create_table(:webhook_headers, charset: "utf8") do
       String :name, null: false
       String :value
-      foreign_key :webhook_id, :webhooks, null: false, foreign_key_constraint_name: 'fk_webhookheaders_webhooks'
+      foreign_key :webhook_id, :webhooks, null: false, foreign_key_constraint_name: "fk_webhookheaders_webhooks"
       primary_key [:webhook_id, :name], :name=>:webhooks_headers_pk
     end
   end

data/db/migrations/000015_create_pact_version_content.rb

@@ -1,10 +1,10 @@
-require 'digest/sha1'
-require_relative 'migration_helper'
+require "digest/sha1"
+require_relative "migration_helper"
 
 Sequel.migration do
   change do
-    create_table(:pact_version_contents, charset: 'utf8') do
-      String :sha, primary_key: true, null: false, primary_key_constraint_name: 'pk_pact_version_contents'
+    create_table(:pact_version_contents, charset: "utf8") do
+      String :sha, primary_key: true, null: false, primary_key_constraint_name: "pk_pact_version_contents"
       String :content, type: PactBroker::MigrationHelper.large_text_type
       DateTime :created_at, null: false
       DateTime :updated_at, null: false

data/db/migrations/000016_add_pact_content_foreign_key_to_pacts.rb

@@ -1,5 +1,5 @@
-require 'digest/sha1'
-require_relative 'migration_helper'
+require "digest/sha1"
+require_relative "migration_helper"
 
 Sequel.migration do
   change do
@@ -10,7 +10,7 @@ Sequel.migration do
     end
 
     alter_table(:pacts) do
-      add_foreign_key :pact_version_content_sha, :pact_version_contents, type: String, null: true, foreign_key_constraint_name: 'fk_pact_version_content'
+      add_foreign_key :pact_version_content_sha, :pact_version_contents, type: String, null: true, foreign_key_constraint_name: "fk_pact_version_content"
     end
   end
 end

data/db/migrations/000017_migrate_json_content_to_pact_version_content_table.rb

@@ -1,5 +1,5 @@
-require 'digest/sha1'
-require_relative 'migration_helper'
+require "digest/sha1"
+require_relative "migration_helper"
 
 Sequel.migration do
   change do

data/db/migrations/000018_drop_json_content_column_from_pacts.rb

@@ -1,5 +1,5 @@
-require 'digest/sha1'
-require_relative 'migration_helper'
+require "digest/sha1"
+require_relative "migration_helper"
 
 Sequel.migration do
   change do

data/db/migrations/000019_make_pact_version_content_sha_not_nullable.rb

@@ -1,5 +1,5 @@
-require 'digest/sha1'
-require_relative 'migration_helper'
+require "digest/sha1"
+require_relative "migration_helper"
 
 Sequel.migration do
   up do

data/db/migrations/000020_add_pact_version_content_sha_to_all_pacts_view.rb

@@ -1,5 +1,5 @@
-require 'digest/sha1'
-require_relative 'migration_helper'
+require "digest/sha1"
+require_relative "migration_helper"
 
 Sequel.migration do
   change do

data/db/migrations/000021_recreate_latest_pacts_view.rb

@@ -1,5 +1,5 @@
-require 'digest/sha1'
-require_relative 'migration_helper'
+require "digest/sha1"
+require_relative "migration_helper"
 
 Sequel.migration do
   change do