pact_broker-client 1.45.0 → 1.48.0

data/lib/pact_broker/client/deployments/record_support_ended.rb

@@ -24,7 +24,7 @@ module PactBroker
         attr_reader :pacticipant_name, :environment_name, :version_number
 
         def currently_supported_versions_link
-          environment_resource._link("pb:currently-supported-versions") or raise PactBroker::Client::Error.new(not_supported_message)
+          environment_resource._link("pb:currently-supported-released-versions", "pb:currently-supported-versions") or raise PactBroker::Client::Error.new(not_supported_message)
         end
 
         def currently_supported_version_entities_for_pacticipant_version

data/lib/pact_broker/client/deployments/record_undeployment.rb

@@ -24,7 +24,7 @@ module PactBroker
         attr_reader :pacticipant_name, :environment_name, :target
 
         def currently_deployed_versions_link
-          environment_resource._link("pb:currently-deployed-versions") or raise PactBroker::Client::Error.new(not_supported_message)
+          environment_resource._link("pb:currently-deployed-deployed-versions", "pb:currently-deployed-versions") or raise PactBroker::Client::Error.new(not_supported_message)
         end
 
         def currently_deployed_version_entities_for_pacticipant

data/lib/pact_broker/client/matrix/resource.rb

@@ -30,6 +30,10 @@ module PactBroker
           end
         end
 
+        def no_results?
+          self[:summary][:success] == 0 && self[:summary][:failed] == 0
+        end
+
         def supports_unknown_count?
           !!(self[:summary] && Integer === self[:summary][:unknown] )
         end

data/lib/pact_broker/client/verification_required.rb

@@ -0,0 +1,34 @@
+require "pact_broker/client/can_i_deploy"
+
+module PactBroker
+  module Client
+    class VerificationRequired < PactBroker::Client::CanIDeploy
+      def call
+        create_result(fetch_matrix_with_retries)
+      rescue StandardError => e
+        message = "Error determining if a verification already existed (#{e.message}) - verification should run just in case"
+        if options[:verbose]
+          message = "#{message}\n#{e.class} - #{e.backtrace.join("\n")}"
+        end
+        Result.new(true, message)
+      end
+
+      private
+
+      def create_result(matrix)
+        matrix_and_notices = format_matrix(matrix) + "\n\n" + remove_warnings(Term::ANSIColor.uncolor(notice_or_reason(matrix, :white)))
+        # If the specified version numbers do not exist, then all the counts come back 0. Can't just check for unknown to be 0.
+        # This command needs to handle "I screwed up the query"
+        if matrix.no_results?
+          Result.new(true, matrix_and_notices + "\n\nVerification is required.")
+        else
+          Result.new(false, matrix_and_notices + "\n\nNo verification is required.")
+        end
+      end
+
+      def remove_warnings(lines)
+        lines.split("\n").select{ | line | !line.include?("WARN:") }.join("\n")
+      end
+    end
+  end
+end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.45.0'
+    VERSION = '1.48.0'
   end
 end

data/lib/pact_broker/client/webhooks/create.rb

@@ -3,6 +3,7 @@ require 'pact_broker/client/hal'
 require 'ostruct'
 require 'json'
 require 'pact_broker/client/command_result'
+require "pact_broker/client/backports"
 
 module PactBroker
   module Client
@@ -61,16 +62,17 @@ module PactBroker
 
         def request_body
           webhook_request_body = JSON.parse(params.body) rescue params.body
+          request_params = {
+            url: params.url,
+            method: params.http_method,
+            headers: params.headers,
+            body: webhook_request_body,
+            username: params.username,
+            password: params.password
+          }.compact
           {
             events: params.events.collect{ | event | { "name" => event }},
-            request: {
-              url: params.url,
-              method: params.http_method,
-              headers: params.headers,
-              body: webhook_request_body,
-              username: params.username,
-              password: params.password
-            }
+            request: request_params
           }.tap { |req| req[:description] = params.description if params.description }
         end
 
@@ -85,6 +87,10 @@ module PactBroker
             body[:provider] = { name: params.provider }
           end
 
+          if params.team_uuid
+            body[:teamUuid] = params.team_uuid
+          end
+
           body
         end
 

data/script/record-deployment.sh

@@ -1,2 +1,2 @@
-PACT_BROKER_FEATURES=deployments bundle exec bin/pact-broker record-deployment \
+bundle exec bin/pact-broker record-deployment \
    --pacticipant foo-consumer --version 1 --environment prod --broker-base-url http://localhost:9292

data/script/record-deployments-and-releases.sh

@@ -1,5 +1,3 @@
-export PACT_BROKER_FEATURES=deployments
-
 bundle exec bin/pact-broker create-or-update-pacticipant --name Foo
 bundle exec bin/pact-broker create-version-tag --pacticipant Foo --version 2 --tag main --auto-create-version
 bundle exec bin/pact-broker describe-version --pacticipant Foo --version 2

data/script/record-undeployment.sh

@@ -1,4 +1,4 @@
-PACT_BROKER_FEATURES=deployments bundle exec bin/pact-broker record-undeployment \
+bundle exec bin/pact-broker record-undeployment \
    --pacticipant foo-consumer --version 1 --environment prod --broker-base-url http://localhost:9292 --output json --verbose
 
 

data/script/webhook-commands.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+bundle exec bin/pact-broker create-webhook \
+  'https://api.github.com/repos/foo/bar/statuses/${pactbroker.consumerVersionNumber}' \
+  -X POST \
+  -H "Content-Type: application/json" \
+  -d '{ "state": "${pactbroker.githubVerificationStatus}", "description": "Pact Verification Tests ${pactbroker.providerVersionTags}", "context": "${pactbroker.providerName}", "target_url": "${pactbroker.verificationResultUrl}" }' \
+  --user username:password \
+  --description "Publish pact verification status to Github" \
+  --contract-published \
+  --provider-verification-published \
+  --team-uuid 4ac05ed8-9e3b-4159-96c0-ad19e3b93658

data/spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb

@@ -38,7 +38,7 @@ module PactBroker
         end
 
         it "invokes the CanIDeploy service" do
-          expect(CanIDeploy).to receive(:call).with('http://pact-broker', version_selectors, { to_tag: nil, to_environment: nil, limit: 1000, ignore_selectors: []}, {output: 'table', retry_while_unknown: 1, retry_interval: 2, dry_run: false}, { pact_broker_base_url: 'http://pact-broker', verbose: 'verbose' })
+          expect(CanIDeploy).to receive(:call).with('http://pact-broker', version_selectors, { to_tag: nil, to_environment: nil, limit: 1000, ignore_selectors: []}, {output: 'table', retry_while_unknown: 1, retry_interval: 2, dry_run: false, verbose: "verbose"}, { pact_broker_base_url: 'http://pact-broker', verbose: 'verbose' })
           invoke_can_i_deploy
         end
 

data/spec/lib/pact_broker/client/cli/broker_run_webhook_commands_spec.rb

@@ -33,7 +33,8 @@ module PactBroker
               broker_username: "username",
               broker_password: "password",
               contract_content_changed: true,
-              verbose: true
+              verbose: true,
+              team_uuid: "1234"
             }
           end
 
@@ -49,7 +50,8 @@ module PactBroker
               body: "data",
               consumer: "consumer",
               provider: "provider",
-              events: ["contract_content_changed"]
+              events: ["contract_content_changed"],
+              team_uuid: "1234"
             }.tap { |it| Pact::Fixture.add_fixture(:create_webhook_params, it) }
           end
 

data/spec/lib/pact_broker/client/deployments/record_support_ended_spec.rb

@@ -46,7 +46,7 @@ module PactBroker
         let(:environment_hash) do
           {
             _links: {
-              :'pb:currently-supported-versions' => {
+              :'pb:currently-supported-released-versions' => {
                 href: currently_supported_versions_url
               }
             }

data/spec/lib/pact_broker/client/deployments/record_undeployment_spec.rb

@@ -46,7 +46,7 @@ module PactBroker
         let(:environment_hash) do
           {
             _links: {
-              :'pb:currently-deployed-versions' => {
+              :'pb:currently-deployed-deployed-versions' => {
                 href: currently_deployed_versions_url
               }
             }

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -1638,6 +1638,323 @@
         }
       }
     },
+    {
+      "description": "a request for the index resource",
+      "providerState": "the pb:pacticipant-version and pb:environments relations exist in the index resource",
+      "request": {
+        "method": "GET",
+        "path": "/",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "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"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:pacticipant-version.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*{pacticipant}.*{version}"
+          },
+          "$.body._links.pb:environments.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request for a pacticipant version",
+      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment",
+      "request": {
+        "method": "GET",
+        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "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"
+              }
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:record-deployment[0].href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to record a deployment",
+      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment",
+      "request": {
+        "method": "POST",
+        "path": "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "target": "blue"
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "target": "blue"
+        }
+      }
+    },
+    {
+      "description": "a request for a pacticipant version",
+      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with 2 environments that aren't test available for deployment",
+      "request": {
+        "method": "GET",
+        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pb:record-deployment": [
+              {
+                "name": "prod",
+                "href": "href"
+              },
+              {
+                "name": "dev",
+                "href": "href"
+              }
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:record-deployment[0]": {
+            "match": "type"
+          },
+          "$.body._links.pb:record-deployment[1]": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request for the environments",
+      "providerState": "an environment with name test exists",
+      "request": {
+        "method": "GET",
+        "path": "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pb:environments": [
+              {
+                "name": "test",
+                "href": "href"
+              }
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:environments[0].href": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request for a pacticipant version",
+      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for release",
+      "request": {
+        "method": "GET",
+        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pb:record-release": [
+              {
+                "name": "test",
+                "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-RECORD-RELEASE-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST"
+              }
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:record-release[0].href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to record a release",
+      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment",
+      "request": {
+        "method": "POST",
+        "path": "/HAL-REL-PLACEHOLDER-PB-RECORD-RELEASE-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        }
+      }
+    },
+    {
+      "description": "a request for an environment",
+      "providerState": "an environment with name test and UUID 16926ef3-590f-4e3f-838e-719717aa88c9 exists",
+      "request": {
+        "method": "GET",
+        "path": "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENT-16926ef3-590f-4e3f-838e-719717aa88c9",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pb:currently-deployed-deployed-versions": {
+              "href": "http://localhost:1234/PLACEHOLDER-ENVIRONMENT-CURRENTLY-DEPLOYED-16926ef3-590f-4e3f-838e-719717aa88c9"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:currently-deployed-deployed-versions.href": {
+            "match": "regex",
+            "regex": "^http.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to list the versions deployed to an environment for a pacticipant name and target",
+      "providerState": "an version is deployed to environment with UUID 16926ef3-590f-4e3f-838e-719717aa88c9 with target customer-1",
+      "request": {
+        "method": "GET",
+        "path": "/PLACEHOLDER-ENVIRONMENT-CURRENTLY-DEPLOYED-16926ef3-590f-4e3f-838e-719717aa88c9",
+        "query": "pacticipant=Foo",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_embedded": {
+            "deployedVersions": [
+              {
+                "target": "customer-1",
+                "_links": {
+                  "self": {
+                    "href": "http://localhost:1234/PLACEHOLDER-DEPLOYED-VERSION-ff3adecf-cfc5-4653-a4e3-f1861092f8e0"
+                  }
+                }
+              }
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body._embedded.deployedVersions[0]._links.self.href": {
+            "match": "regex",
+            "regex": "^http"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to mark a deployed version as not currently deploye",
+      "providerState": "a currently deployed version exists",
+      "request": {
+        "method": "PATCH",
+        "path": "/PLACEHOLDER-DEPLOYED-VERSION-ff3adecf-cfc5-4653-a4e3-f1861092f8e0",
+        "headers": {
+          "Content-Type": "application/merge-patch+json"
+        },
+        "body": {
+          "currentlyDeployed": false
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "currentlyDeployed": false,
+          "_embedded": {
+            "version": {
+              "number": "2"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._embedded.version.number": {
+            "match": "type"
+          }
+        }
+      }
+    },
     {
       "description": "a request to create a webhook with a JSON body for a consumer and provider",
       "providerState": "the 'Pricing Service' and 'Condor' already exist in the pact-broker",
@@ -1846,7 +2163,6 @@
             }
           ],
           "request": {
-            "url": null,
             "method": "POST",
             "headers": {
               "Foo": "bar",