pact_broker 2.100.0 → 2.102.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f22862d2054c07b06fb947f8a1f710dab261ae6ac1207e6a15adebb07dc488db
-  data.tar.gz: 5cc63160ad026673f194af54237080aeb6eb8ab4f9ac93cbe5cd71b63727d60e
+  metadata.gz: 0ca0c487490557098ca1314f79ebe8736b1d7b72d29f5a3f48f04ad1204e81c0
+  data.tar.gz: f34e76335daffdff234eaad0f72c51b61080b47e4d0972be4893db97b094e80f
 SHA512:
-  metadata.gz: 8b6c0cefc1e4847ed53627f0b2aae7cfd5be46e351ce1969f21b80f5f8899990cca3f612d9ab14a82d58c0521b91fb5f5a820f4c7d9e72f17fbc391f1583daff
-  data.tar.gz: 4c1c3fa1a8e983718f1f841c8b17088678c6f4ada22c36b3ededb71a46c2bf004712c4716a8af33c17e068c88b88a6b69f219a286549841c20fa8c79ae41a214
+  metadata.gz: d2688f72d68f644707b443bb695c8899f028a5ea4ad4ac76b8680e0409b283c7d760f4229eae4c611f3878c5f609097ffd95ed79ec55f64b6239402ffc060c98
+  data.tar.gz: ecf36e225ebc07860c368bbbc94a805d6ae1cacb587b36dd4344ed6b8a0038014fffc115c054f1785a7d134e940a5cab1bf6d2c36773718a581e66ab6d973b47

data/CHANGELOG.md

@@ -1,3 +1,39 @@
+<a name="v2.102.1"></a>
+### v2.102.1 (2022-07-08)
+
+#### Bug Fixes
+
+* ensure blank? method is defined where used	 ([b81b5e9b](/../../commit/b81b5e9b))
+
+<a name="v2.102.0"></a>
+### v2.102.0 (2022-07-07)
+
+#### Features
+
+* default allow_dangerous_contract_modification to false for new installations	 ([85a89951](/../../commit/85a89951))
+
+#### Bug Fixes
+
+* add missing provider version branch parameter to webhook requests	 ([262dae44](/../../commit/262dae44))
+* clean up pacticipants with no names	 ([0aff250d](/../../commit/0aff250d))
+* update string refinements with blank? and present?	 ([8373f88f](/../../commit/8373f88f))
+* update validation for creating pacticipants to return a 400 when name is missing	 ([fcb02aa6](/../../commit/fcb02aa6))
+
+<a name="v2.101.0"></a>
+### v2.101.0 (2022-06-07)
+
+#### Features
+
+* recalculate the branch head if the deleted branch version was the latest for the branch	 ([db51d4fe](/../../commit/db51d4fe))
+* support deleting branch versions (removing a version from a branch)	 ([661667b3](/../../commit/661667b3))
+* improve error message when request has non UTF-8 characters (#559)	 ([3addc0c8](/../../commit/3addc0c8))
+
+#### Bug Fixes
+
+* add missing environment policy record for use when recording deployments	 ([09bb02a6](/../../commit/09bb02a6))
+* fix bug where pacticipant with blank name was being created instead of updating existing record	 ([be24a8ad](/../../commit/be24a8ad))
+* ensure pacticipant name is retained when updating with PUT	 ([eeac47c3](/../../commit/eeac47c3))
+
 <a name="v2.100.0"></a>
 ### v2.100.0 (2022-05-20)
 

data/Gemfile

@@ -30,6 +30,7 @@ group :test do
   gem "faraday_middleware", "~> 0.14"
   gem "docker-api", "~>1.34"
   gem "approvals", ">=0.0.24", "<1.0.0"
+  gem "tzinfo", "~>2.0"
 end
 
 if ENV["INSTALL_MYSQL"] == "true"

data/README.md

@@ -114,7 +114,17 @@ Use the HAL browser to view documentation as you browse.
 
 ### To have a play around on your local machine
 
-* Install Ruby and Bundler (check the automated tests to find the most recent version of Ruby and Bundler that are supported)
+#### Using Docker Compose
+
+Download a copy of the [example Docker Compose file](https://github.com/pact-foundation/pact-broker-docker/blob/master/docker-compose.yml) from the Pact Broker Docker repository and run:
+
+`docker compose up`
+
+Then open a browser at [http://localhost:9292](http://localhost:9292).
+
+#### Using Ruby
+
+* Install Ruby 2.7 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`
@@ -144,8 +154,8 @@ You can use the [Pact Broker Docker image][docker] or [Terraform on AWS][terrafo
   * To ensure you're on a supported version of the database that you choose, check the [travis.yml][travisyml] file to see which versions we're currently running our tests against.
   * MySQL was supported for the native Ruby application until around 2021, but the official `pactfoundation/pact-broker` Docker image does not support it. New features will not be optimised for MySQL, and some new features may not even be supported on it (eg. the database clean feature).
 * You'll find a sample database creation script in the [example/config.ru](https://github.com/pact-foundation/pact_broker/blob/master/example/config.ru).
-* Install ruby 2.7 or later and the latest version of bundler (if you've come this far, I'm assuming you know how to do both of these. Did I mention there was a [Docker][docker] image?)
-* Copy the [pact\_broker](https://github.com/DiUS/pact_broker-docker/tree/master/pact_broker) directory from the Pact Broker Docker project. This will have the recommended settings for database connections, logging, basic auth etc. Note that the Docker image uses Phusion Passenger as the web application server in front of the Pact Broker Ruby application, which is the recommended set up.
+* Install ruby 2.7 and the latest version of bundler (if you've come this far, I'm assuming you know how to do both of these. Did I mention there was a [Docker][docker] image?)
+* Copy the [pact\_broker](https://github.com/DiUS/pact_broker-docker/tree/master/pact_broker) directory from the Pact Broker Docker project. This will have the recommended settings for database connections, logging, basic auth etc. Note that the Docker image uses Phusion Passenger as the web application server in front of the Pact Broker Ruby application, which is the recommended set up if you are not using a containerized solution.
 * Modify the config.ru and Gemfile as desired (eg. choose database driver gem, set your database credentials. Use the "pg" gem for Postgres)
   * example Sequel configuration for postgres `{ adapter: "postgres", database: "pact_broker", username: 'pact_broker', password: 'pact_broker', :encoding => 'utf8' }`
 * Please ensure you use `encoding: 'utf8'` in your Sequel options to avoid encoding issues.
@@ -169,7 +179,7 @@ The Pact Broker follows the [semantic versioning](https://semver.org/) scheme.
 [terraform]: https://github.com/nadnerb/terraform-pact-broker
 [pactflow]: https://pactflow.io/?utm_source=github&utm_campaign=pact_broker_usage
 [wiki]: https://github.com/pact-foundation/pact_broker/wiki
-[reverse-proxy-docs]: https://github.com/pact-foundation/pact_broker/wiki/Configuration#running-the-broker-behind-a-reverse-proxy
+[reverse-proxy-docs]: https://docs.pact.io/pact_broker/configuration/features#running-the-broker-behind-a-reverse-proxy
 [stackoverflow]: http://stackoverflow.com/questions/tagged/pact-broker
 [twitter]: https://twitter.com/pact_up
 [slack]: https://slack.pact.io/

data/db/migrations/20220622_default_allow_dangerous_contract_modification_to_false_for_new_installations.rb

@@ -0,0 +1,22 @@
+require_relative "migration_helper"
+include PactBroker::MigrationHelper
+
+Sequel.migration do
+  up do
+    # Need to do this again because didn't actually set default of allow_dangerous_contract_modification to true
+    # when the first migration was run in db/migrations/20210810_set_allow_contract_modification.rb
+    for_upgrades_of_existing_installations do
+      from(:config).insert_ignore.insert(
+        name: "allow_dangerous_contract_modification",
+        type: "boolean",
+        value: "1",
+        created_at: Sequel.datetime_class.now,
+        updated_at: Sequel.datetime_class.now
+      )
+    end
+  end
+
+  down do
+
+  end
+end

data/db/migrations/20220625_delete_pacticipants_with_no_name.rb

@@ -0,0 +1,62 @@
+# There was a bug that caused a duplicate pacticipant to be created
+# with a null name when updating the pacticipant in a certain way.
+# It was fixed in be24a8ad650f0ed49993283b22ba1d1a744fb3e8.
+# This migration deletes any pacticipants with null names that are not referenced by any other rows,
+# or assigns a name if the pacticipant is referenced so that it can be deleted through the API
+# (I can't think of a reason why a pacticipant with a null name should be referenced, but better to be safe than sorry).
+# The "find tables that reference pacticipants" logic is done dynamically because Pactflow has extra tables not in the OSS.
+
+# Query each table that references the pacticipants table to determine
+# if there are any rows in it that reference the pacticipant with the specified ID.
+# @return [Boolean]
+def pacticipant_is_unreferenced(pacticipant_id, table_foreign_keys)
+  table_foreign_keys.any? do | (table_name, foreign_keys) |
+    criteria = foreign_keys.flat_map do | fk |
+      fk[:columns].collect do | column_name |
+        { column_name => pacticipant_id }
+      end
+    end
+
+    # SELECT 'one' FROM xxx where consumer_id = x or provider_id = x LIMIT 1
+    !from(table_name).where(Sequel.|(*criteria)).empty?
+  end
+end
+
+# Return a structure describing the tables and columns that reference the pacticipants table.
+# @return [Array] eg. [ [:integrations, [ { columns: [:consumer_id] }, { columns: [:provider_id] } ] ] ]
+def get_table_foreign_keys
+  table_foreign_keys = tables.sort.collect do | table_name |
+    key_list = foreign_key_list(table_name).select{ |fk| fk[:table] == :pacticipants }
+    if key_list.any?
+      [ table_name,  key_list]
+    end
+  end.compact
+
+  # move the integrations table check first because that's the most likely candidate to have a referencing row
+  table_foreign_keys.select{ |(table_name, _)| table_name == :integrations } | table_foreign_keys
+end
+
+# Deletes the pacticipant if it is unreferenced, or populates the name so it can
+# be deleted through the API.
+def delete_pacticipant_or_populate_name(row, table_foreign_keys)
+  if pacticipant_is_unreferenced(row[:id], table_foreign_keys)
+    from(:pacticipants).where(id: row[:id]).delete
+  else
+    from(:pacticipants).where(id: row[:id]).update(name: "Delete me #{row[:id]}")
+  end
+end
+
+Sequel.migration do
+  up do
+
+    table_foreign_keys = get_table_foreign_keys
+
+    from(:pacticipants).where(name: nil).all.each do | row |
+      delete_pacticipant_or_populate_name(row, table_foreign_keys)
+    end
+  end
+
+  down do
+
+  end
+end

data/db/migrations/migration_helper.rb

@@ -3,6 +3,12 @@ module PactBroker
 
     extend self
 
+    def for_upgrades_of_existing_installations
+      if from(:integrations).count > 0
+        yield
+      end
+    end
+
     def large_text_type
       if postgres?
         :text

data/docs/CONFIGURATION.md

@@ -648,10 +648,12 @@ Whether or not to allow the pact content for an existing consumer version to be
 as allowing modification makes the results of can-i-deploy unreliable. When this is set to false as recommended, each commit must publish pacts
 with a unique version number.
 
+If modification of an existing contract is attempted when the value is set to `false`, an HTTP 409 status will be returned.
+
 **Supported versions:** From v2.82.0<br/>
 **Environment variable name:** `PACT_BROKER_ALLOW_DANGEROUS_CONTRACT_MODIFICATION`<br/>
 **YAML configuration key name:** `allow_dangerous_contract_modification`<br/>
-**Default:** For new installations of v2.82.0 and later, this defaults to `false`.<br/>
+**Default:** For new installations of v2.102 and later, this defaults to `false` (the recommended value). Previous installations will have the default value of `true` (not recommended).<br/>
 **Allowed values:** `true`, `false`<br/>
 **More information:** https://docs.pact.io/versioning<br/>
 

data/docs/api/PACTICIPANTS.md

@@ -0,0 +1,290 @@
+
+# Pacticipants
+
+
+## Pacticipant
+
+Path: `/pacticipants/:pacticipant_name`<br/>
+Allowed methods: `GET`, `PUT`, `PATCH`, `DELETE`<br/>
+
+### GET
+
+#### Request
+
+Headers: `{"Accept":"application/hal+json"}`<br/>
+
+
+#### Response
+
+Status: `200`<br/>
+Headers: `{"Content-Type":"application/hal+json;charset=utf-8"}`<br/>
+Body:
+
+```
+{
+  "name": "foo",
+  "displayName": "Foo",
+  "repositoryUrl": "https://github.com/example-organization/foo",
+  "createdAt": "2021-09-01T00:07:21+00:00",
+  "_embedded": {
+    "latestVersion": {
+      "number": "3e1f00a04",
+      "_links": {
+        "self": {
+          "title": "Version",
+          "name": "3e1f00a04",
+          "href": "https://pact-broker/pacticipants/foo/versions/3e1f00a04"
+        }
+      }
+    },
+    "labels": [
+
+    ]
+  },
+  "_links": {
+    "self": {
+      "href": "https://pact-broker/pacticipants/foo"
+    },
+    "pb:versions": {
+      "href": "https://pact-broker/pacticipants/foo/versions"
+    },
+    "pb:version": {
+      "title": "Get, create or delete a pacticipant version",
+      "href": "https://pact-broker/pacticipants/foo/versions/{version}",
+      "templated": true
+    },
+    "pb:version-tag": {
+      "title": "Get, create or delete a tag for a version of foo",
+      "href": "https://pact-broker/pacticipants/foo/versions/{version}/tags/{tag}",
+      "templated": true
+    },
+    "pb:branch-version": {
+      "title": "Get or add/create a version for a branch of foo",
+      "href": "https://pact-broker/pacticipants/foo/branches/{branch}/versions/{version}",
+      "templated": true
+    },
+    "pb:label": {
+      "title": "Get, create or delete a label for foo",
+      "href": "https://pact-broker/pacticipants/foo/labels/{label}",
+      "templated": true
+    },
+    "pb:can-i-deploy-badge": {
+      "title": "Can I Deploy foo badge",
+      "href": "https://pact-broker/pacticipants/foo/latest-version/{tag}/can-i-deploy/to/{environmentTag}/badge",
+      "templated": true
+    },
+    "pb:can-i-deploy-branch-to-environment-badge": {
+      "title": "Can I Deploy foo from branch to environment badge",
+      "href": "https://pact-broker/pacticipants/foo/branches/{branch}/latest-version/can-i-deploy/to-environment/{environment}/badge",
+      "templated": true
+    },
+    "curies": [
+      {
+        "name": "pb",
+        "href": "https://pact-broker/doc/{rel}?context=pacticipant",
+        "templated": true
+      }
+    ]
+  }
+}
+```
+
+
+### PUT
+
+PUT replaces the entire resource with the specified body, so missing properties will effectively be nulled. Embedded properties (eg. versions) will not be affected.
+
+#### Request
+
+Headers: `{"Content-Type":"application/json","Accept":"application/hal+json"}`<br/>
+Body:
+
+```
+{
+  "displayName": "Foo",
+  "repositoryUrl": "https://github.com/example/foo",
+  "repositoryName": "foo",
+  "repositoryNamespace": "example",
+  "mainBranch": "main"
+}
+```
+
+
+#### Response
+
+Status: `200`<br/>
+Headers: `{"Content-Type":"application/hal+json;charset=utf-8"}`<br/>
+Body:
+
+```
+{
+  "name": "foo",
+  "displayName": "Foo",
+  "repositoryUrl": "https://github.com/example/foo",
+  "repositoryName": "foo",
+  "repositoryNamespace": "example",
+  "mainBranch": "main",
+  "createdAt": "2021-09-01T00:07:21+00:00",
+  "_embedded": {
+    "latestVersion": {
+      "number": "3e1f00a04",
+      "_links": {
+        "self": {
+          "title": "Version",
+          "name": "3e1f00a04",
+          "href": "https://pact-broker/pacticipants/foo/versions/3e1f00a04"
+        }
+      }
+    },
+    "labels": [
+
+    ]
+  },
+  "_links": {
+    "self": {
+      "href": "https://pact-broker/pacticipants/foo"
+    },
+    "pb:versions": {
+      "href": "https://pact-broker/pacticipants/foo/versions"
+    },
+    "pb:version": {
+      "title": "Get, create or delete a pacticipant version",
+      "href": "https://pact-broker/pacticipants/foo/versions/{version}",
+      "templated": true
+    },
+    "pb:version-tag": {
+      "title": "Get, create or delete a tag for a version of foo",
+      "href": "https://pact-broker/pacticipants/foo/versions/{version}/tags/{tag}",
+      "templated": true
+    },
+    "pb:branch-version": {
+      "title": "Get or add/create a version for a branch of foo",
+      "href": "https://pact-broker/pacticipants/foo/branches/{branch}/versions/{version}",
+      "templated": true
+    },
+    "pb:label": {
+      "title": "Get, create or delete a label for foo",
+      "href": "https://pact-broker/pacticipants/foo/labels/{label}",
+      "templated": true
+    },
+    "pb:can-i-deploy-badge": {
+      "title": "Can I Deploy foo badge",
+      "href": "https://pact-broker/pacticipants/foo/latest-version/{tag}/can-i-deploy/to/{environmentTag}/badge",
+      "templated": true
+    },
+    "pb:can-i-deploy-branch-to-environment-badge": {
+      "title": "Can I Deploy foo from branch to environment badge",
+      "href": "https://pact-broker/pacticipants/foo/branches/{branch}/latest-version/can-i-deploy/to-environment/{environment}/badge",
+      "templated": true
+    },
+    "curies": [
+      {
+        "name": "pb",
+        "href": "https://pact-broker/doc/{rel}?context=pacticipant",
+        "templated": true
+      }
+    ]
+  }
+}
+```
+
+
+### PATCH
+
+PATCH with the Content-Type application/merge-patch+json merges the pacticipant's existing properties with those from the request body. Embedded properties (eg. versions) will not be affected.
+
+#### Request
+
+Headers: `{"Content-Type":"application/merge-patch+json","Accept":"application/hal+json"}`<br/>
+Body:
+
+```
+{
+  "displayName": "Foo",
+  "repositoryUrl": "https://github.com/example/foo",
+  "repositoryName": "foo",
+  "repositoryNamespace": "example",
+  "mainBranch": "main"
+}
+```
+
+
+#### Response
+
+Status: `200`<br/>
+Headers: `{"Content-Type":"application/hal+json;charset=utf-8"}`<br/>
+Body:
+
+```
+{
+  "name": "foo",
+  "displayName": "Foo",
+  "repositoryUrl": "https://github.com/example/foo",
+  "repositoryName": "foo",
+  "repositoryNamespace": "example",
+  "mainBranch": "main",
+  "createdAt": "2021-09-01T00:07:21+00:00",
+  "_embedded": {
+    "latestVersion": {
+      "number": "3e1f00a04",
+      "_links": {
+        "self": {
+          "title": "Version",
+          "name": "3e1f00a04",
+          "href": "https://pact-broker/pacticipants/foo/versions/3e1f00a04"
+        }
+      }
+    },
+    "labels": [
+
+    ]
+  },
+  "_links": {
+    "self": {
+      "href": "https://pact-broker/pacticipants/foo"
+    },
+    "pb:versions": {
+      "href": "https://pact-broker/pacticipants/foo/versions"
+    },
+    "pb:version": {
+      "title": "Get, create or delete a pacticipant version",
+      "href": "https://pact-broker/pacticipants/foo/versions/{version}",
+      "templated": true
+    },
+    "pb:version-tag": {
+      "title": "Get, create or delete a tag for a version of foo",
+      "href": "https://pact-broker/pacticipants/foo/versions/{version}/tags/{tag}",
+      "templated": true
+    },
+    "pb:branch-version": {
+      "title": "Get or add/create a version for a branch of foo",
+      "href": "https://pact-broker/pacticipants/foo/branches/{branch}/versions/{version}",
+      "templated": true
+    },
+    "pb:label": {
+      "title": "Get, create or delete a label for foo",
+      "href": "https://pact-broker/pacticipants/foo/labels/{label}",
+      "templated": true
+    },
+    "pb:can-i-deploy-badge": {
+      "title": "Can I Deploy foo badge",
+      "href": "https://pact-broker/pacticipants/foo/latest-version/{tag}/can-i-deploy/to/{environmentTag}/badge",
+      "templated": true
+    },
+    "pb:can-i-deploy-branch-to-environment-badge": {
+      "title": "Can I Deploy foo from branch to environment badge",
+      "href": "https://pact-broker/pacticipants/foo/branches/{branch}/latest-version/can-i-deploy/to-environment/{environment}/badge",
+      "templated": true
+    },
+    "curies": [
+      {
+        "name": "pb",
+        "href": "https://pact-broker/doc/{rel}?context=pacticipant",
+        "templated": true
+      }
+    ]
+  }
+}
+```
+
+