pact_broker-client 1.43.0 → 1.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62d6345d206920c405cd04c6a3984ac2d3de6ebc687283eb22f3400f7e51e7fa
-  data.tar.gz: 18e2425b5fb80db316beaf58977432316afe9a48cc508a619006c5e8a9ec59af
+  metadata.gz: b9a0a2b003221c85dee29fcab0f035344c961a676faaa63c9eb7a86837726471
+  data.tar.gz: 0356350e5894b59fde846079ed48dee78f494de755728f5c91a01a9f6df25594
 SHA512:
-  metadata.gz: 6ec0cca0de9787d4493143c2a2d9f9512df1b800c978a274a58b0b14a9d8fd7fc6c87609d2c3dd7f6916273c6600b9ec11a98dc47b8ac614aa71843f97c48378
-  data.tar.gz: f0c96d94f6bcd765ac5ac20bbc4950f64b205555461bdc2ca0a7fcfbe5d57e704eea430a3ddf1b11e2b499a76d828a2fdb552b8ce5a03d56bb3b852378690a32
+  metadata.gz: 14ebf92314a784825a3788d5fb9e717e6b545cc2273c863095a3a43a679b24491df1e8cc8b810e4aa8a77d42cd004bcb79e76beff954d386a54f39fc00692ad7
+  data.tar.gz: 965f255b44bc7b9ca1a1bbc85c28a692167b1b08ac1e16c92d0751c8171b7d805a224cbcba7337ecaaa42f3cf85adcc1b53158318c711bf9f3af53828e9ca939

data/.github/workflows/test.yml

@@ -21,3 +21,24 @@ jobs:
           ruby-version: ${{ matrix.ruby_version }}
       - run: "bundle install"
       - run: "bundle exec rake"
+  pact:
+    runs-on: "ubuntu-latest"
+    continue-on-error: true
+    strategy:
+      fail-fast: false
+      matrix:
+        feature: ["", "publish_contracts", "deployments"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "2.7"
+      - run: "bundle install"
+      - run: |
+          rm -rf spec/pacts/*
+          bundle exec rspec spec/service_providers/
+          bundle exec rake pact:publish:pactflow
+        env:
+          PACT_BROKER_TOKEN: ${{ secrets.PACTFLOW_PACT_OSS_TOKEN }}
+          PACT_BROKER_FEATURES: ${{ matrix.feature }}
+          TEST_FEATURE: ${{ matrix.feature }}

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+<a name="v1.44.0"></a>
+### v1.44.0 (2021-06-09)
+
+#### Features
+
+* add record-undeployment (feature toggled off)	 ([951d334](/../../commit/951d334))
+* add describe-environment command	 ([cd11ebb](/../../commit/cd11ebb))
+* add record-release (feature toggled off)	 ([e32e4e5](/../../commit/e32e4e5))
+
+#### Bug Fixes
+
+* hardcode file requires Fixes: https://github.com/pact-foundation/pact_broker-client/issues/88	 ([581f2fd](/../../commit/581f2fd))
+
 <a name="v1.43.0"></a>
 ### v1.43.0 (2021-06-03)
 

data/doc/pacts/markdown/Pact Broker Client - Pact Broker.md

@@ -2,12 +2,6 @@
 
 #### Requests from Pact Broker Client to Pact Broker
 
-* [A request for a pacticipant version](#a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_2_environments_that_aren't_test_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with 2 environments that aren't test available for deployment
-
-* [A request for a pacticipant version](#a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment
-
-* [A request for a pacticipant version](#a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_does_not_exist) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist
-
 * [A request for the compatibility matrix for a pacticipant that does not exist](#a_request_for_the_compatibility_matrix_for_a_pacticipant_that_does_not_exist)
 
 * [A request for the compatibility matrix for all versions of Foo and Bar](#a_request_for_the_compatibility_matrix_for_all_versions_of_Foo_and_Bar_given_the_pact_for_Foo_version_1.2.3_and_1.2.4_has_been_verified_by_Bar_version_4.5.6) given the pact for Foo version 1.2.3 and 1.2.4 has been verified by Bar version 4.5.6
@@ -26,8 +20,6 @@
 
 * [A request for the compatibility matrix where only the version of Foo is specified](#a_request_for_the_compatibility_matrix_where_only_the_version_of_Foo_is_specified_given_the_pact_for_Foo_version_1.2.3_has_been_verified_by_Bar_version_4.5.6_and_version_5.6.7) given the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6 and version 5.6.7
 
-* [A request for the environments](#a_request_for_the_environments_given_an_environment_with_name_test_exists) given an environment with name test exists
-
 * [A request for the index resource](#a_request_for_the_index_resource)
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pacticipant_relations_are_present) given the pacticipant relations are present
@@ -36,12 +28,8 @@
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:latest-version_relation_exists_in_the_index_resource) given the pb:latest-version relation exists in the index resource
 
-* [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:pacticipant-version_and_pb:environments_relations_exist_in_the_index_resource) given the pb:pacticipant-version and pb:environments relations exist in the index resource
-
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:pacticipant-version_relation_exists_in_the_index_resource) given the pb:pacticipant-version relation exists in the index resource
 
-* [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:publish-contracts_relations_exists_in_the_index_resource) given the pb:publish-contracts relations exists in the index resource
-
 * [A request for the index resource with the webhook relation](#a_request_for_the_index_resource_with_the_webhook_relation)
 
 * [A request for the list of the latest pacts from all consumers for the Pricing Service'](#a_request_for_the_list_of_the_latest_pacts_from_all_consumers_for_the_Pricing_Service'_given_a_latest_pact_between_Condor_and_the_Pricing_Service_exists) given a latest pact between Condor and the Pricing Service exists
@@ -96,10 +84,6 @@
 
 * [A request to publish a pact with method put](#a_request_to_publish_a_pact_with_method_put_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker,_and_Condor_already_has_a_pact_published_for_version_1.3.0) given the 'Pricing Service' and 'Condor' already exist in the pact-broker, and Condor already has a pact published for version 1.3.0
 
-* [A request to publish contracts](#a_request_to_publish_contracts)
-
-* [A request to record a deployment](#a_request_to_record_a_deployment_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment
-
 * [A request to register the repository URL of a pacticipant](#a_request_to_register_the_repository_URL_of_a_pacticipant_given_the_'Pricing_Service'_already_exists_in_the_pact-broker) given the 'Pricing Service' already exists in the pact-broker
 
 * [A request to register the repository URL of a pacticipant](#a_request_to_register_the_repository_URL_of_a_pacticipant_given_the_'Pricing_Service'_does_not_exist_in_the_pact-broker) given the 'Pricing Service' does not exist in the pact-broker
@@ -132,87 +116,6 @@
 
 #### Interactions
 
-<a name="a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_2_environments_that_aren&#39;t_test_available_for_deployment"></a>
-Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with 2 environments that aren't test available for deployment**, upon receiving **a request for a pacticipant version** from Pact Broker Client, with
-```json
-{
-  "method": "GET",
-  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-  "headers": {
-    "Accept": "application/hal+json"
-  }
-}
-```
-Pact Broker will respond with:
-```json
-{
-  "status": 200,
-  "headers": {
-    "Content-Type": "application/hal+json;charset=utf-8"
-  },
-  "body": {
-    "_links": {
-      "pb:record-deployment": [
-        {
-          "name": "prod",
-          "href": "href"
-        },
-        {
-          "name": "dev",
-          "href": "href"
-        }
-      ]
-    }
-  }
-}
-```
-<a name="a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment"></a>
-Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment**, upon receiving **a request for a pacticipant version** from Pact Broker Client, with
-```json
-{
-  "method": "GET",
-  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-  "headers": {
-    "Accept": "application/hal+json"
-  }
-}
-```
-Pact Broker will respond with:
-```json
-{
-  "status": 200,
-  "headers": {
-    "Content-Type": "application/hal+json;charset=utf-8"
-  },
-  "body": {
-    "_links": {
-      "pb:record-deployment": [
-        {
-          "name": "test",
-          "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST"
-        }
-      ]
-    }
-  }
-}
-```
-<a name="a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_does_not_exist"></a>
-Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist**, upon receiving **a request for a pacticipant version** from Pact Broker Client, with
-```json
-{
-  "method": "GET",
-  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-  "headers": {
-    "Accept": "application/hal+json"
-  }
-}
-```
-Pact Broker will respond with:
-```json
-{
-  "status": 404
-}
-```
 <a name="a_request_for_the_compatibility_matrix_for_a_pacticipant_that_does_not_exist"></a>
 Upon receiving **a request for the compatibility matrix for a pacticipant that does not exist** from Pact Broker Client, with
 ```json
@@ -634,36 +537,6 @@ Pact Broker will respond with:
   }
 }
 ```
-<a name="a_request_for_the_environments_given_an_environment_with_name_test_exists"></a>
-Given **an environment with name test exists**, upon receiving **a request for the environments** from Pact Broker Client, with
-```json
-{
-  "method": "GET",
-  "path": "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
-  "headers": {
-    "Accept": "application/hal+json"
-  }
-}
-```
-Pact Broker will respond with:
-```json
-{
-  "status": 200,
-  "headers": {
-    "Content-Type": "application/hal+json;charset=utf-8"
-  },
-  "body": {
-    "_links": {
-      "pb:environments": [
-        {
-          "name": "test",
-          "href": "href"
-        }
-      ]
-    }
-  }
-}
-```
 <a name="a_request_for_the_index_resource"></a>
 Upon receiving **a request for the index resource** from Pact Broker Client, with
 ```json
@@ -781,36 +654,6 @@ Pact Broker will respond with:
   }
 }
 ```
-<a name="a_request_for_the_index_resource_given_the_pb:pacticipant-version_and_pb:environments_relations_exist_in_the_index_resource"></a>
-Given **the pb:pacticipant-version and pb:environments relations exist in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
-```json
-{
-  "method": "GET",
-  "path": "/",
-  "headers": {
-    "Accept": "application/hal+json"
-  }
-}
-```
-Pact Broker will respond with:
-```json
-{
-  "status": 200,
-  "headers": {
-    "Content-Type": "application/hal+json;charset=utf-8"
-  },
-  "body": {
-    "_links": {
-      "pb:pacticipant-version": {
-        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
-      },
-      "pb:environments": {
-        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS"
-      }
-    }
-  }
-}
-```
 <a name="a_request_for_the_index_resource_given_the_pb:pacticipant-version_relation_exists_in_the_index_resource"></a>
 Given **the pb:pacticipant-version relation exists in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
 ```json
@@ -838,33 +681,6 @@ Pact Broker will respond with:
   }
 }
 ```
-<a name="a_request_for_the_index_resource_given_the_pb:publish-contracts_relations_exists_in_the_index_resource"></a>
-Given **the pb:publish-contracts relations exists in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
-```json
-{
-  "method": "GET",
-  "path": "/",
-  "headers": {
-    "Accept": "application/hal+json"
-  }
-}
-```
-Pact Broker will respond with:
-```json
-{
-  "status": 200,
-  "headers": {
-    "Content-Type": "application/hal+json;charset=utf-8"
-  },
-  "body": {
-    "_links": {
-      "pb:publish-contracts": {
-        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS"
-      }
-    }
-  }
-}
-```
 <a name="a_request_for_the_index_resource_with_the_webhook_relation"></a>
 Upon receiving **a request for the index resource with the webhook relation** from Pact Broker Client, with
 ```json
@@ -2038,103 +1854,6 @@ Pact Broker will respond with:
   }
 }
 ```
-<a name="a_request_to_publish_contracts"></a>
-Upon receiving **a request to publish contracts** from Pact Broker Client, with
-```json
-{
-  "method": "POST",
-  "path": "/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS",
-  "headers": {
-    "Content-Type": "application/json",
-    "Accept": "application/hal+json"
-  },
-  "body": {
-    "pacticipantName": "Foo",
-    "pacticipantVersionNumber": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-    "branch": "main",
-    "tags": [
-      "dev"
-    ],
-    "buildUrl": "http://build",
-    "contracts": [
-      {
-        "consumerName": "Foo",
-        "providerName": "Bar",
-        "specification": "pact",
-        "contentType": "application/json",
-        "content": "eyJjb25zdW1lciI6eyJuYW1lIjoiRm9vIn0sInByb3ZpZGVyIjp7Im5hbWUiOiJCYXIifSwiaW50ZXJhY3Rpb25zIjpbeyJkZXNjcmlwdGlvbiI6ImFuIGV4YW1wbGUgcmVxdWVzdCIsInByb3ZpZGVyU3RhdGUiOiJhIHByb3ZpZGVyIHN0YXRlIiwicmVxdWVzdCI6eyJtZXRob2QiOiJHRVQiLCJwYXRoIjoiLyIsImhlYWRlcnMiOnt9fSwicmVzcG9uc2UiOnsic3RhdHVzIjoyMDAsImhlYWRlcnMiOnsiQ29udGVudC1UeXBlIjoiYXBwbGljYXRpb24vaGFsK2pzb24ifX19XSwibWV0YWRhdGEiOnsicGFjdFNwZWNpZmljYXRpb24iOnsidmVyc2lvbiI6IjIuMC4wIn19fQ==",
-        "writeMode": "overwrite",
-        "onConflict": "overwrite"
-      }
-    ]
-  }
-}
-```
-Pact Broker will respond with:
-```json
-{
-  "status": 200,
-  "headers": {
-    "Content-Type": "application/hal+json;charset=utf-8"
-  },
-  "body": {
-    "_embedded": {
-      "pacticipant": {
-        "name": "Foo"
-      },
-      "version": {
-        "number": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-        "buildUrl": "http://build"
-      }
-    },
-    "logs": [
-      {
-        "level": "info",
-        "message": "some message"
-      }
-    ],
-    "_links": {
-      "pb:pacticipant-version-tags": [
-        {
-          "name": "dev"
-        }
-      ],
-      "pb:contracts": [
-        {
-          "href": "http://some-pact"
-        }
-      ]
-    }
-  }
-}
-```
-<a name="a_request_to_record_a_deployment_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment"></a>
-Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment**, upon receiving **a request to record a deployment** from Pact Broker Client, with
-```json
-{
-  "method": "POST",
-  "path": "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
-  "headers": {
-    "Content-Type": "application/json",
-    "Accept": "application/hal+json"
-  },
-  "body": {
-    "target": "blue"
-  }
-}
-```
-Pact Broker will respond with:
-```json
-{
-  "status": 201,
-  "headers": {
-    "Content-Type": "application/hal+json;charset=utf-8"
-  },
-  "body": {
-    "target": "blue"
-  }
-}
-```
 <a name="a_request_to_register_the_repository_URL_of_a_pacticipant_given_the_&#39;Pricing_Service&#39;_already_exists_in_the_pact-broker"></a>
 Given **the 'Pricing Service' already exists in the pact-broker**, upon receiving **a request to register the repository URL of a pacticipant** from Pact Broker Client, with
 ```json

data/lib/pact_broker/client/cli/broker.rb

@@ -2,6 +2,7 @@ require 'pact_broker/client/cli/custom_thor'
 require 'pact_broker/client/hash_refinements'
 require 'thor/error'
 require 'pact_broker/client/cli/environment_commands'
+require 'pact_broker/client/cli/deployment_commands'
 require 'pact_broker/client/cli/pacticipant_commands'
 
 module PactBroker
@@ -17,9 +18,11 @@ module PactBroker
         using PactBroker::Client::HashRefinements
         if ENV.fetch("PACT_BROKER_FEATURES", "").include?("deployments")
           include PactBroker::Client::CLI::EnvironmentCommands
+          include PactBroker::Client::CLI::DeploymentCommands
         end
         include PactBroker::Client::CLI::PacticipantCommands
 
+
         desc 'can-i-deploy', ''
         long_desc File.read(File.join(__dir__, 'can_i_deploy_long_desc.txt'))
 
@@ -170,61 +173,6 @@ module PactBroker
           exit(1) unless result.success
         end
 
-        if ENV.fetch("PACT_BROKER_FEATURES", "").include?("deployments")
-          ignored_and_hidden_potential_options_from_environment_variables
-          desc "record-deployment", "Record deployment of a pacticipant version to an environment. See https://docs.pact.io/go/record_deployment for more information."
-          method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that was deployed."
-          method_option :version, required: true, aliases: "-e", desc: "The pacticipant version number that was deployed."
-          method_option :environment, required: true, desc: "The name of the environment that the pacticipant version was deployed to."
-          method_option :target, default: nil, required: false, desc: "Optional. The target of the deployment - a logical identifer required to differentiate deployments when there are multiple instances of the same application in an environment."
-          output_option_json_or_text
-          shared_authentication_options
-
-          def record_deployment
-            require 'pact_broker/client/versions/record_deployment'
-            params = {
-              pacticipant_name: options.pacticipant,
-              version_number: options.version,
-              environment_name: options.environment,
-              target: options.target,
-              output: options.output
-            }
-            result = PactBroker::Client::Versions::RecordDeployment.call(
-              params,
-              options.broker_base_url,
-              pact_broker_client_options
-            )
-            $stdout.puts result.message
-            exit(1) unless result.success
-          end
-
-          ignored_and_hidden_potential_options_from_environment_variables
-          desc "record-undeployment", "Record undeployment of (or the end of support for) a pacticipant version from an environment"
-          method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that was deployed."
-          method_option :version, required: true, aliases: "-e", desc: "The pacticipant version number that was deployed."
-          method_option :environment, required: true, desc: "The name of the environment that the pacticipant version was deployed to."
-          output_option_json_or_text
-          shared_authentication_options
-
-          def record_undeployment
-            require 'pact_broker/client/versions/record_undeployment'
-            params = {
-              pacticipant_name: options.pacticipant,
-              version_number: options.version,
-              environment_name: options.environment,
-              output: options.output
-            }
-            result = PactBroker::Client::Versions::RecordUndeployment.call(
-              params,
-              options.broker_base_url,
-              pact_broker_client_options
-            )
-            $stdout.puts result.message
-            exit(1) unless result.success
-          end
-
-        end
-
         ignored_and_hidden_potential_options_from_environment_variables
         desc 'version', "Show the pact_broker-client gem version"
         def version