pact_broker 2.76.2 → 2.79.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdc8ed42038e4b622005f53471a000d870efd99a6dbd6b773aa9e8a3f9a993cb
-  data.tar.gz: d2f42cd3e13007471cdd33fabbe515afa9c9ff4896566868accd9961f66f557f
+  metadata.gz: 95badfada259b53967395cf6851ae3c73524f840f03f458c8ddaee800b43e8b7
+  data.tar.gz: dc0168aa2af112bc896e55ae32b5e3e9c4bf4531eec51908a8acc5a6c38068d6
 SHA512:
-  metadata.gz: a250f5f452356d3a9eb87659933cc47d0e947b7ce10a8c984d7cd296a28bc9be7dcfe82bd37fba29919f570a949b9b4a46b1622d6d242b92698268e54018aadf
-  data.tar.gz: c136cbe836ed813de2819480cf3347de86248f00258e0f8e89ec33375cf0c929186a65c51ef620995c11d2c596d496bec858c430894f80bacd6f647877f4af3e
+  metadata.gz: 286e176364f2c583e6751aaa4c85205eefb6823994e65eff24494cb78318fb391f0ad96cc478162f078fabacda071893c546c789788197e18ef9d61c46a3d65f
+  data.tar.gz: 80a06b3f6aba77993311f46d8d558132d1d61d8922725d219d08352c78dd6e27fd799e03fd283b183edb8c0973974fe115212eadabe130f785a007d5289c0444

data/.codeclimate.yml

@@ -1,4 +1,13 @@
 ---
+checks:
+  argument-count:
+    config:
+      threshold: 6
+  method-count:
+    config:
+      threshold: 40
+  similar-code:
+    enabled: false
 engines:
   csslint:
     enabled: true
@@ -35,3 +44,6 @@ exclude_patterns:
 - public/javascripts/highlight.pack.js
 - public/javascripts/jquery*.js
 - public/js/bootstrap*.js
+- public/javascripts/pagination.js
+- public/javascripts/material-menu.js
+

data/.github/workflows/release_gem.yml

@@ -4,6 +4,7 @@ on:
   repository_dispatch:
     types:
       - release-triggered
+  workflow_dispatch:
 
 jobs:
   release:

data/.github/workflows/test-ruby-3.yml

@@ -0,0 +1,19 @@
+name: Tests for Ruby 3.0 - these are hardcoded to succeed so every commit doesn't look like it's failing
+
+on: [push, pull_request]
+
+jobs:
+  sqlite:
+    if: "!contains(github.event.head_commit.message, '[ci-skip]')"
+    runs-on: "ubuntu-latest"
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version: ["3.0"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - run: "bundle install"
+      - run: "bundle exec rake || true"

data/.github/workflows/test.yml

@@ -1,29 +1,36 @@
 name: Test
 
-on: push
+on: [push, pull_request]
 
 jobs:
   sqlite:
+    if: "!contains(github.event.head_commit.message, '[ci-skip]')"
     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: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}
       - run: "bundle install"
-      - run: "bundle exec rake"
+      - name: "Install CodeClimate Test Reporter"
+        run: |
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+          chmod +x ./cc-test-reporter
+      - name: Tests
+        run: bundle exec rake
+      - name: Report test coverage
+        run: ./cc-test-reporter after-build --exit-code 0 || true
+    env:
+      CC_TEST_REPORTER_ID: dc2c30b67c9e2a5309e1aef699c30fdab55ba4f0e4f1beac029ba93e293835db
   postgres:
+    if: "!contains(github.event.head_commit.message, '[ci-skip]')"
     runs-on: "ubuntu-latest"
     strategy:
+      fail-fast: false
       matrix:
         ruby_version: ["2.5", "2.7"]
     services:
@@ -51,8 +58,10 @@ jobs:
           DATABASE_ADAPTER: github_actions_postgres
           INSTALL_PG: "true"
   mysql:
+    if: "!contains(github.event.head_commit.message, '[ci-skip]')"
     runs-on: "ubuntu-latest"
     strategy:
+      fail-fast: false
       matrix:
         ruby_version: ["2.7"]
     steps:

data/.gitignore

@@ -39,4 +39,6 @@ db/test/change_migration_strategy/pact_broker_database.sqlite3
 coverage
 db/test/backwards_compatibility/pids
 db/test/backwards_compatibility/pact_broker_database.sqlite3
-spec/examples.txt
+spec/examples.txt
+.approvals
+regression/fixtures/approvals

data/CHANGELOG.md

@@ -1,3 +1,56 @@
+<a name="v2.79.1"></a>
+### v2.79.1 (2021-03-01)
+
+#### Bug Fixes
+
+* lock reform gem	 ([53aa92f8](/../../commit/53aa92f8))
+
+* **ui**
+  * Make long pacticipant versions look nice (#407)	 ([96b50572](/../../commit/96b50572))
+
+<a name="v2.79.0"></a>
+### v2.79.0 (2021-02-25)
+
+#### Features
+
+* allow multiple base URLs to be configured	 ([6d0dc8b3](/../../commit/6d0dc8b3))
+* copy full git sha rather than abbreviated one when clicking the copy button next to an application version	 ([dae9cae5](/../../commit/dae9cae5))
+
+#### Bug Fixes
+
+* fix missing verification status colours in matrix rows	 ([687d4647](/../../commit/687d4647))
+
+<a name="v2.78.1"></a>
+### v2.78.1 (2021-02-18)
+
+#### Bug Fixes
+
+* handle nil response when determining webhook success status	 ([20ca9e66](/../../commit/20ca9e66))
+
+<a name="v2.78.0"></a>
+### v2.78.0 (2021-02-15)
+
+#### Features
+
+* support create, update and delete of environment resources (#379)	 ([410f2e80](/../../commit/410f2e80))
+* allow version to be created with tags	 ([798afce9](/../../commit/798afce9))
+* Follow up for #239 + adding list of success codes to SAVABLE_SETTING_NAMES variable (#388)	 ([08c0ad09](/../../commit/08c0ad09))
+
+<a name="v2.77.0"></a>
+### v2.77.0 (2021-02-11)
+
+#### Features
+
+* **webhooks**
+  * allow the http codes to be considered as "successful" to be configured.	 ([a84989b1](/../../commit/a84989b1))
+
+* add duplicate columns to tags table to reduce joins	 ([5ca9de62](/../../commit/5ca9de62))
+* set the branch in the seed data	 ([9a00ce6d](/../../commit/9a00ce6d))
+* display version branch on index and matrix pages	 ([2057df7d](/../../commit/2057df7d))
+* support creating version with branch (#371)	 ([5884a047](/../../commit/5884a047))
+* sort tags on index and matrix pages and APIs by creation date	 ([91590718](/../../commit/91590718))
+* sort consumer version tags by date in dashboard response	 ([f82ba1bc](/../../commit/f82ba1bc))
+
 <a name="v2.76.2"></a>
 ### v2.76.2 (2021-01-29)
 

data/DEVELOPER_DOCUMENTATION.md

@@ -148,3 +148,16 @@ In the beginning, I made a lot of Sequel models based on views that pulled in th
   * Write a spec for the repository.
 * Go back and make the original feature spec pass.
 * Profit.
+
+## Writing Data migrations
+
+The same database may be used by multiple application instances to support highly available set ups and no downtime deployments. This can lead to the situation where the database migrations have been applied, but new data is written to the database by old application code, which may lead to some columns not being populated. The mitigation to this problem is to run the *data* migrations only each time an application instance starts up. This ensures that that any data inserted into the database by a previous version of the application are migrated. This is done automatically in the `PactBroker::App` class.
+
+If you write a schema migration that then requires a data migration to populate or update any columns:
+
+* Create a data migrations class in `lib/pact_broker/db/data_migrations`, copying the existing pattern.
+* Add a call to the new class at the end of `lib/pact_broker/db/migrate_data.rb`
+* Make sure you check for the existance of the required columns, because you don't know which version of the database might be running with this code.
+* Add a null check (eg. `db[:my_table].where(my_column: nil).update(...)`) where appropriate to make sure that the data migration doesn't run more than once.
+* Don't use any Sequel Models, as this will run before the model classes are loaded, and migrations should never depend on Models because models change as the schema migrations are applied.
+* Create a migration file in `db/migrations` that calls the data migration (eg. like `db/migrations/20190603_migrate_webhook_headers.rb`)

data/DEVELOPER_SETUP.md

@@ -36,7 +36,7 @@ Remember to rebuild the image if you change any of the gems or gem versions.
 
 ### With native install
 
-* You will need to install Ruby 2.5, and preferably a ruby version manager. I recommend using [chruby][chruby] and [ruby-install][ruby-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`.
@@ -75,17 +75,27 @@ 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)
+* To run the "quick tests" (skip the lengthy migration specs and db setup)
   ```sh
   bundle exec rake spec:quick
   ```
@@ -94,7 +104,56 @@ mysql -hmysql -upact_broker -ppact_broker
   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.
+## 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/reload.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

@@ -16,6 +16,7 @@ RUN apk update \
       "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

data/ISSUES.md

@@ -2,29 +2,29 @@
 
 ## Reproducing an issue
 
-In [script/reproduce-issue.rb](script/reproduce-issue.rb) you will find a fluent API that allows you to simulate client libraries interacting with the Pact Broker.
+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 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.
 
     ```
-    # might need to try twice if it doesn't connect to postgres
+    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 - new window
+    # 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
 
-    # new window
-    docker-compose -f docker-compose-issue-repro-with-pact-broker-docker-image.yml run repro-issue
-
     ```
 
 * Run the reproduction script.
 
     ```
+    # in a new shell
     docker-compose -f docker-compose-issue-repro-with-pact-broker-docker-image.yml run repro-issue
     ```
 

data/config.ru

@@ -26,7 +26,8 @@ app = PactBroker::App.new do | config |
   config.webhook_host_whitelist = [/.*/, "10.0.0.0/8"]
   config.webhook_scheme_whitelist = ['http', 'https']
   config.webhook_http_method_whitelist = ['GET', 'POST']
-  #config.base_url = ENV['PACT_BROKER_BASE_URL']
+  config.webhook_http_code_success = [200, 201, 202, 203, 204, 205, 206]
+  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/db/ddl_statements/head_pact_tags.rb

@@ -5,6 +5,29 @@ def head_pact_tags_v1(connection)
     Sequel[:lp][:consumer_id] => Sequel[:o][:consumer_id],
     Sequel[:lp][:provider_id] => Sequel[:o][:provider_id],
     Sequel[:cv][:order] => Sequel[:o][:latest_consumer_version_order]
-  }, { table_alias: :o})
+  }, { table_alias: :o })
   .select(Sequel[:o][:tag_name].as(:name), Sequel[:lp][:pact_publication_id])
 end
+
+def head_pact_tags_v2_rollback(connection, postgres)
+  if(postgres)
+    head_pact_tags_v1(connection).select_append(Sequel.lit("TIMESTAMP 'epoch'").as(:created_at))
+  else
+    head_pact_tags_v1(connection)
+  end
+end
+
+def head_pact_tags_v2(connection)
+  connection.from(Sequel.as(:latest_pact_publication_ids_for_consumer_versions, :lp))
+  .join(:versions,{ Sequel[:lp][:consumer_version_id] => Sequel[:cv][:id]}, { table_alias: :cv })
+  .join(:latest_tagged_pact_consumer_version_orders, {
+    Sequel[:lp][:consumer_id] => Sequel[:o][:consumer_id],
+    Sequel[:lp][:provider_id] => Sequel[:o][:provider_id],
+    Sequel[:cv][:order] => Sequel[:o][:latest_consumer_version_order]
+  }, { table_alias: :o } )
+  .join(:tags, {
+    Sequel[:tags][:version_id] => Sequel[:cv][:id],
+    Sequel[:tags][:name] => Sequel[:o][:tag_name]
+  })
+  .select(Sequel[:o][:tag_name].as(:name), Sequel[:lp][:pact_publication_id], Sequel[:tags][:created_at])
+end

data/db/ddl_statements/latest_tagged_pact_consumer_version_orders.rb

@@ -21,3 +21,14 @@ def latest_tagged_pact_consumer_version_orders_v3(connection)
     .join(:versions, { Sequel[:lp][:consumer_version_id] => Sequel[:cv][:id] }, { table_alias: :cv} )
     .join(:tags, { Sequel[:t][:version_id] => Sequel[:lp][:consumer_version_id] }, { table_alias: :t })
 end
+
+def latest_tagged_pact_consumer_version_orders_v4(connection)
+  view = Sequel.as(:latest_pact_publication_ids_for_consumer_versions, :lp)
+  connection.from(view)
+    .select_group(
+      Sequel[:lp][:provider_id],
+      Sequel[:lp][:consumer_id],
+      Sequel[:t][:name].as(:tag_name))
+    .select_append{ max(version_order).as(latest_consumer_version_order) }
+    .join(:tags, { Sequel[:t][:version_id] => Sequel[:lp][:consumer_version_id] }, { table_alias: :t })
+end

data/db/ddl_statements/latest_tagged_pact_publications.rb

@@ -0,0 +1,6 @@
+LATEST_TAGGED_PACT_PUBLICATIONS = "select lp.*, o.tag_name
+      from latest_pact_publications_by_consumer_versions lp
+      inner join latest_tagged_pact_consumer_version_orders o
+      on lp.consumer_id = o.consumer_id
+        and lp.provider_id = o.provider_id
+        and lp.consumer_version_order = latest_consumer_version_order"

data/db/ddl_statements/latest_verification_ids_for_consumer_version_tags.rb

@@ -51,3 +51,16 @@ LATEST_VERIFICATION_IDS_FOR_CONSUMER_VERSION_TAGS_V3 = "select
         on v.provider_version_id = pv.id
       where v.id in (select latest_verification_id from latest_verification_ids_for_pact_versions)
       group by pv.pacticipant_id, lpp.consumer_id, t.name"
+
+LATEST_VERIFICATION_IDS_FOR_CONSUMER_VERSION_TAGS_V4 = "select
+    lpp.provider_id,
+    lpp.consumer_id,
+    t.name as consumer_version_tag_name,
+    max(lv.latest_verification_id) as latest_verification_id
+  from latest_verification_ids_for_pact_versions lv
+  join latest_pact_publication_ids_for_consumer_versions lpp
+    on lv.pact_version_id = lpp.pact_version_id
+  join tags t
+    on lpp.consumer_version_id = t.version_id
+  group by lpp.provider_id, lpp.consumer_id, t.name
+"

data/db/migrations/20210117_add_branch_to_version.rb

@@ -0,0 +1,9 @@
+Sequel.migration do
+  change do
+    alter_table(:versions) do
+      add_column(:branch, String)
+      add_column(:build_url, String)
+      add_index([:pacticipant_id, :branch, :order], name: "versions_pacticipant_id_branch_order_index")
+    end
+  end
+end

data/db/migrations/20210202_add_created_at_to_head_pact_tags.rb

@@ -0,0 +1,14 @@
+require_relative '../ddl_statements'
+require_relative 'migration_helper'
+
+include PactBroker::MigrationHelper
+
+Sequel.migration do
+  up do
+    create_or_replace_view(:head_pact_tags, head_pact_tags_v2(self))
+  end
+
+  down do
+    create_or_replace_view(:head_pact_tags, head_pact_tags_v2_rollback(self, postgres?))
+  end
+end