pact_broker 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7902c1cd120ea0eba915a6c88bfa1e63b922f5a1
-  data.tar.gz: 01d8538b925d01e927a08de783421316ad3c57d0
+  metadata.gz: e6bcfaf002c3150d58c06e7790c4eeffcd875870
+  data.tar.gz: 4529da832fd2ea9078adbd73043720f68a50f8cb
 SHA512:
-  metadata.gz: 549cfab358749c88bc019b180dc7030e001d27c33657c44d8104e72f66881b20c9ece90c8dadd7bcf80a8441421afc5287722b65e415c0104405c95bfca28efb
-  data.tar.gz: b29f53fb8f58273b45270d45d6b46b1124233fa3474016bbcf616b1acb020a0d2898f0c84e3f929ae9de5ccc6bb85ff96bf2402fe0c86e06a40579b75e38492b
+  metadata.gz: 2088e2c7318966335c99761ebefdac09df3af9afec1fcc461fee3fbb2d20ba362b83aa1f99c3067dfbd56f30532dc0176fcd9d298c5d8c3ac0a99a166cb4d64e
+  data.tar.gz: a6f0fe6b337d2cf5af0ab444c71962b6a9ebad1a1a11bc251d212fe89593f0fa1d75a5b6df1adac1a561e4d29cab443608e857796c2c68aefbf2da743f4778b4

data/.gitignore

@@ -30,3 +30,6 @@ Gemfile.lock
 bethtest/
 bin/
 coverage
+db/test/backwards_compatibility/pids
+db/test/backwards_compatibility/pact_broker_database.sqlite3
+spec/examples.txt

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  # - 2.2.7
-  # - 2.3.4
   - 2.4.1
+  - 2.3.4
+  - 2.2.7
 services:
   - postgresql
   - mysql
@@ -20,9 +20,11 @@ before_script:
   - cp config/database.travis.yml config/database.yml
   - psql -U postgres -c "CREATE DATABASE pact_broker;"
   - mysql -e 'CREATE DATABASE pact_broker;'
+  - mysql -e "GRANT ALL ON pact_broker.* TO 'travis'@'%';"
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
 script:
   - bundle exec rake
   - if [ "$DATABASE_ADAPTER" == "postgres" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT || true; fi
+  - if [ ! -z "$(ruby --version | grep '2\.4\.')" ]; then ./script/db-spec.sh; fi
   - bundle exec bundle-audit update && bundle exec bundle-audit

data/CHANGELOG.md

@@ -1,3 +1,57 @@
+<a name="v2.5.0"></a>
+### v2.5.0 (2017-09-25)
+
+#### Features
+
+* **heartbeat resource**
+  * cache json response body	 ([f2ac0f5](/../../commit/f2ac0f5))
+
+* **webhook status**
+  * delete webhook objects related to previous revisions of a pact when deleting a pact publication	 ([a053623](/../../commit/a053623))
+  * delete related triggered webhooks and executions when pact publication is deleted	 ([3dc590c](/../../commit/3dc590c))
+  * set any triggered webhooks in 'retrying' status to 'failed' on startup	 ([1f2305b](/../../commit/1f2305b))
+  * migrate webhook execution data to triggered webhooks	 ([9f46d86](/../../commit/9f46d86))
+  * consider http status < 300 to be a webhook failure	 ([7ef595a](/../../commit/7ef595a))
+  * log unhandled suckerpunch errors	 ([4cc779d](/../../commit/4cc779d))
+  * log number of seconds until next webhook attempt in webhook logs	 ([5d16330](/../../commit/5d16330))
+  * display attempts made and attempts remaining in webhook status resource	 ([648e1c3](/../../commit/648e1c3))
+  * move webhook retry schedule to configuration	 ([f2d92f3](/../../commit/f2d92f3))
+  * ensure triggered webhook and webhook execution objects are saved to database even when webhook fails and response code is 500	 ([88ba2ac](/../../commit/88ba2ac))
+  * redact authorization headers in webhook logs	 ([10efddb](/../../commit/10efddb))
+  * implement PUT for webhook resource	 ([7266b1e](/../../commit/7266b1e))
+  * add endpoint for triggered webhook execution logs	 ([ad81d20](/../../commit/ad81d20))
+
+* **hal browser**
+  * use name over title in embedded resource heading	 ([6c61da7](/../../commit/6c61da7))
+  * improve readability of link collections	 ([0a9bc8c](/../../commit/0a9bc8c))
+  * use name and title from self link when not specified in embedded resource	 ([354374c](/../../commit/354374c))
+
+* **versions resource**
+  * deprecate versions and pacticipant links in favour of pb:versions and pb:pacticipants	 ([94f395e](/../../commit/94f395e))
+
+* **badges**
+  * only cache successful badge responses from shields.io	 ([e5f08ad](/../../commit/e5f08ad))
+  * use simple in-memory cache for badges	 ([2453c55](/../../commit/2453c55))
+  * show message about enabling public badge access when disabled	 ([6fc78ff](/../../commit/6fc78ff))
+  * show badge in HTML pact and display markdown when clicked	 ([e9b632a](/../../commit/e9b632a))
+  * changed configuration property name from 'enable_badge_resources' to 'enable_public_badge_access'	 ([83540e5](/../../commit/83540e5))
+
+* **resources**
+  * improve usage of title and name attributes	 ([915a7ee](/../../commit/915a7ee))
+
+* **pact resource**
+  * improve usage of name and title fields	 ([3a9a178](/../../commit/3a9a178))
+  * add link relation for all pact versions	 ([d5ea068](/../../commit/d5ea068))
+
+* **gems**
+  * upgrade webmachine to 1.5.0	 ([d23fedc](/../../commit/d23fedc))
+
+#### Bug Fixes
+
+* return correct "latest" verification when a verification has been published for a pact with a revision	 ([f2b4c9f](/../../commit/f2b4c9f))
+* sequel migration 25 for mysql	 ([920c363](/../../commit/920c363))
+* sequel migration 19 for mysql	 ([0ee48e1](/../../commit/0ee48e1))
+
 <a name="v2.4.2"></a>
 ### v2.4.2 (2017-09-07)
 

data/DEVELOPER_DOCUMENTATION.md

@@ -2,10 +2,14 @@
 
 ## Domain and database design
 
+### Domain
+
+Domain classes are found in `lib/pact_broker/domain`. Many of these classes are Sequel models, as the difference between the Sequel model and the functionality required for the domain logic is similar enough to share the class. Some classes separate the domain and database logic, as the concerns are too different. Where there is a separate database model, this will be kept in a module with the pluralized name of the model eg. `PactBroker::Webhooks`. Unfortunately, this sometimes makes it difficult to tell in the calling code whether you have a domain or a database model. I haven't worked out a clean way to handle this yet.
+
 ### Tables
-* `pact_version_contents` - the JSON content of each UNIQUE pact document is stored in this table. The same content is likely to be published over and over again by the CI builds, so deduplicating the content saves us a lot of disk space. Once created, a row is never modified.
+* `pact_versions` - the JSON content of each UNIQUE pact document is stored in this table. The same content is likely to be published over and over again by the CI builds, so deduplicating the content saves us a lot of disk space. Once created, a row is never modified. Uniqueness is just done on string equality - no special pact logic. This means that pacts with randomly generated values or orders (most of pact-jvm pacts!) will get a new version record every time they publish.
 
-* `pact_revisions` - this table holds references to the:
+* `pact_publications` - this table holds references to the:
 
     * `provider` (in the pacticipants table)
     * `consumer version` (in the versions table),
@@ -35,19 +39,19 @@
 
 ### Views
 
-* `all_pact_revisions` - A denormalised view the one-to-one attributes of a `pact_revision`, including:
+* `all_pact_publications` - A denormalised view the one-to-one attributes of a `pact_publication`, including:
 
     * `provider name` and `provider id`
     * `consumer name` and `consumer id`
     * `consumer version number` and `consumer version order`
     * `revision_number`
 
-* `all_pacts` - This view has the same columns as `all_pact_revisions`, but it only contains the latest (current) revision of the pact for each provider/consumer/version. It maps to what a user would consider the "pact" resource ie. `/pacts/provider/Provider/consumer/Consumer/version/1.2.3`
+* `latest_pact_publications` - This view has the same columns as `all_pact_publications`, but it only contains the latest revision of the pact for each provider/consumer/version. It maps to what a user would consider the "pact" resource ie. `/pacts/provider/Provider/consumer/Consumer/version/1.2.3`. Previous revisions are not currently exposed via the API.
 
- The AllPacts Sequel model in the code is what is used when querying data for displaying in a response, rather than the normalised separate PactRevision and PactVersionContent models.
+ The `AllPactPublications` Sequel model in the code is what is used when querying data for displaying in a response, rather than the normalised separate PactPublication and PactVersion models.
 
-* `latest_pacts` - This view has the same columns as `all_pact_revisions`, but it only contains the latest revision of the pact for the latest consumer version for each consumer/provider pair. It is what a user would consider the "latest pact", and maps to the resource at `/pacts/provider/Provider/consumer/Consumer/latest`
+* `latest_pact_publications` - This view has the same columns as `all_pact_publications`, but it only contains the latest revision of the pact for the latest consumer version for each consumer/provider pair. It is what a user would consider the "latest pact", and maps to the resource at `/pacts/provider/Provider/consumer/Consumer/latest`
 
-* `latest_tagged_pacts` - This view has the same columns as `all_pact_revisions`, plus a `tag_name` column. It is used to return the pact for the latest tagged version of a consumer.
+* `latest_tagged_pact_publications` - This view has the same columns as `all_pact_publications`, plus a `tag_name` column. It is used to return the pact for the latest tagged version of a consumer.
 
 * `latest_verifications` - The most recent verification for each pact version.

data/README.md

@@ -26,7 +26,7 @@ Features:
 * Provides badges to display pact verification statuses in your READMEs.
 * Enables a pact version to be tagged (ie. "prod") so a provider can verify itself against a fixed version of a pact to ensure backwards compatibility.
 * Provides webhooks to trigger a provider build when a consumer publishes a change to a pact.
-* Tracks changes between Pact versions so you can tell when a consumer has changed its expectations.
+* View diffs between Pact versions so you can tell what expectations have changed.
 * [Docker Pact Broker][docker]
 
 ### How would I use the Pact Broker?
@@ -125,6 +125,10 @@ You can use the [Pact Broker Docker container][docker] or [Terraform on AWS][ter
 * For production usage, use a web application server like [Phusion Passenger](https://www.phusionpassenger.com) or [Nginx](http://nginx.org/) to serve the Pact Broker application.
 * Deploy to your location of choice.
 
+## Upgrading
+
+Please read the [UPGRADING.md](UPGRADING.md) documentation before upgrading your Pact Broker, for information on the supported upgrade paths.
+
 [decouple]: http://techblog.realestate.com.au/enter-the-pact-matrix-or-how-to-decouple-the-release-cycles-of-your-microservices/
 [pact]: https://github.com/realestate-com-au/pact
 [nerf]: https://github.com/pact-foundation/pact_broker/wiki/pact-broker-ci-nerf-gun

data/UPGRADING.md

@@ -0,0 +1,18 @@
+# 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/db/migrations/19_make_pact_version_content_sha_not_nullable.rb

@@ -2,9 +2,17 @@ require 'digest/sha1'
 require_relative 'migration_helper'
 
 Sequel.migration do
-  change do
+  up do
+    PactBroker::MigrationHelper.with_mysql do
+      run("SET FOREIGN_KEY_CHECKS = 0")
+    end
+
     alter_table(:pacts) do
       set_column_not_null(:pact_version_content_sha)
     end
+
+    PactBroker::MigrationHelper.with_mysql do
+      run("SET FOREIGN_KEY_CHECKS = 1")
+    end
   end
 end

data/db/migrations/25_make_pv_pacticipants_mandatory.rb

@@ -1,8 +1,16 @@
 Sequel.migration do
   up do
+    PactBroker::MigrationHelper.with_mysql do
+      run("SET FOREIGN_KEY_CHECKS = 0")
+    end
+
     alter_table(:pact_versions) do
       set_column_not_null(:consumer_id)
       set_column_not_null(:provider_id)
     end
+
+    PactBroker::MigrationHelper.with_mysql do
+      run("SET FOREIGN_KEY_CHECKS = 1")
+    end
   end
 end

data/db/migrations/38_create_triggered_webhooks_table.rb

@@ -0,0 +1,19 @@
+Sequel.migration do
+  change do
+    create_table(:triggered_webhooks, charset: 'utf8') do
+      primary_key :id
+      String :trigger_uuid, null: false
+      String :trigger_type, null: false # publication or manual
+      foreign_key :pact_publication_id, :pact_publications, null: false
+      foreign_key :webhook_id, :webhooks
+      String :webhook_uuid, null: false # keep so we can group executions even when webhook is deleted
+      foreign_key :consumer_id, :pacticipants, null: false
+      foreign_key :provider_id, :pacticipants, null: false
+      String :status, null: false
+      DateTime :created_at, null: false
+      DateTime :updated_at, null: false
+      index [:webhook_id, :trigger_uuid], unique: true, name: 'uq_triggered_webhook_wi'
+      index [:pact_publication_id, :webhook_id, :trigger_uuid], unique: true, name: 'uq_triggered_webhook_ppi_wi'
+    end
+  end
+end

data/db/migrations/39_add_triggered_webhooks_fk_to_execution.rb

@@ -0,0 +1,24 @@
+Sequel.migration do
+  change do
+    alter_table(:webhook_executions) do
+      add_foreign_key :triggered_webhook_id, :triggered_webhooks
+      set_column_allow_null(:webhook_id)
+      set_column_allow_null(:pact_publication_id)
+      set_column_allow_null(:consumer_id)
+      set_column_allow_null(:provider_id)
+    end
+
+    # Hope old code doesn't insert another webhook in the meantime!
+
+    # TODO drop_column(:webhook_executions, :webhook_id)
+    # TODO drop_column(:webhook_executions, :webhook_uuid)
+    # TODO drop_column(:webhook_executions, :pact_publication_id)
+    # TODO drop_column(:webhook_executions, :consumer_id)
+    # TODO drop_column(:webhook_executions, :provider_id)
+
+    # TODO
+    # alter_table(:triggered_webhooks) do
+    #  set_column_not_null(:triggered_webhook_id)
+    # end
+  end
+end

data/db/migrations/40_create_latest_triggered_webhooks_view.rb

@@ -0,0 +1,24 @@
+Sequel.migration do
+  up do
+    create_or_replace_view(:latest_triggered_webhook_ids,
+      "select webhook_uuid, consumer_id, provider_id, max(created_at) as latest_triggered_webhook_created_at
+      from triggered_webhooks
+      group by webhook_uuid, consumer_id, provider_id"
+    )
+
+    create_view(:latest_triggered_webhooks,
+      "select tw.*
+      from triggered_webhooks tw
+      inner join latest_triggered_webhook_ids ltwi
+      on tw.consumer_id = ltwi.consumer_id
+      and tw.provider_id = ltwi.provider_id
+      and tw.webhook_uuid = ltwi.webhook_uuid
+      and tw.created_at = ltwi.latest_triggered_webhook_created_at"
+    )
+  end
+
+  down do
+    drop_view(:latest_triggered_webhooks)
+    drop_view(:latest_triggered_webhook_ids)
+  end
+end

data/db/migrations/41_migrate_execution_data.rb

@@ -0,0 +1,47 @@
+require 'securerandom'
+
+Sequel.migration do
+  up do
+    from(:webhook_executions).each do | execution |
+      pact_publication = from(:all_pact_publications).where(
+        consumer_id: execution[:consumer_id],
+        provider_id: execution[:provider_id]
+      ).where(
+        Sequel.lit("created_at <= ?", execution[:created_at])
+      ).reverse_order(:id).limit(1).single_record
+
+      if pact_publication && execution[:webhook_id]
+        webhook = from(:webhooks).where(id: execution[:webhook_id]).single_record
+
+        if webhook
+          webhook_uuid = webhook[:uuid]
+          status = execution[:success] ? 'success' : 'failure'
+
+          from(:triggered_webhooks).insert(
+            trigger_uuid: SecureRandom.urlsafe_base64,
+            trigger_type: 'pact_publication',
+            pact_publication_id: pact_publication[:id],
+            webhook_id: execution[:webhook_id],
+            webhook_uuid: webhook_uuid,
+            consumer_id: execution[:consumer_id],
+            provider_id: execution[:provider_id],
+            created_at: execution[:created_at],
+            updated_at: execution[:created_at],
+            status: status
+          )
+        end
+      end
+      from(:webhook_executions)
+        .where(id: execution[:id])
+        .update(
+          webhook_id: nil,
+          consumer_id: nil,
+          provider_id: nil,
+          pact_publication_id: nil)
+    end
+  end
+
+  down do
+    from(:triggered_webhooks).delete
+  end
+end

data/db/test/backwards_compatibility/.rspec

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

data/db/test/backwards_compatibility/Appraisals

@@ -0,0 +1,49 @@
+# 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 "head" do
+  gem "pact_broker", path: "../../../"
+end

data/db/test/backwards_compatibility/Gemfile

@@ -0,0 +1,11 @@
+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'

data/db/test/backwards_compatibility/Rakefile

@@ -0,0 +1,55 @@
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+TESTS = [
+  %w{head  9297},
+  %w{2.4.2 9296},
+  %w{2.3.0 9295},
+  %w{2.2.0 9294},
+  %w{2.1.0 9293}
+]
+
+DATABASE_VERSION = TESTS.first.first
+
+def start_pact_broker code_version, port
+  Bundler.with_clean_env do
+    IO.popen("bundle exec appraisal #{code_version} rackup -p #{port}")
+  end
+end
+
+def kill_servers
+  Dir.chdir('pids') { Dir.glob("*") }.collect(&:to_i).each do | pid |
+    Process.kill 'KILL', pid
+  end
+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
+
+      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

@@ -0,0 +1,18 @@
+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.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

@@ -0,0 +1,14 @@
+# 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 "dry-types", "0.10"