pact_broker-client 1.45.0 → 1.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99a06a67fbe9da6f970649c5159443669ed9ce419911e6178594944467255dd0
-  data.tar.gz: c45dcfa2fd158febe01b9094e2125b4a1637c716da3a6d11d3bd13a8ce19867c
+  metadata.gz: fde8c782e40832e6e989a59a78e0bdedf62d117ceb4e44d322fe38e3911ff714
+  data.tar.gz: be91210f775ccf15d2bf49a2cecf3aebf1fc68133b87b5343224d75153b28254
 SHA512:
-  metadata.gz: 6da2ec04fc73a54ae53bebc62ddb5ddfe1fe1db17b1f94d22a3e195edfb756ad6330e9a99ebfeb1a6f5d20be71c92df4c16c0a808a409623b9600fb59e2e6385
-  data.tar.gz: c714b39a69e0f96ffccabe9b6bc3097c0401a6c1931a0de89e57eae7c1e0c04ef5133e1c3d124df49b2dd294bdd90fe2415baeba365e1bf44fc40b45b4602164
+  metadata.gz: 31ec264efd314d6cc03059f2eddfc5f0a842055e79c3d68fcbe20896619b6469aad06aa57e26c60585727d94443d7f5fd6e11626c14775e0dadb7fba63afbbe8
+  data.tar.gz: 1b78604dfa9f2860523432eea37d4943b7f222b685238ca60d0a8605e87afd42398f02568ddfd35ee330e3b055738db07a3331e800bc4ef839e63a1e2f6c26e5

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+<a name="v1.46.0"></a>
+### v1.46.0 (2021-06-24)
+
+#### Features
+
+* support specifying team UUID when creating a webhook in Pactflow	 ([c4201e1](/../../commit/c4201e1))
+
 <a name="v1.45.0"></a>
 ### v1.45.0 (2021-06-16)
 

data/README.md

@@ -78,44 +78,44 @@ Usage:
   pact-broker can-i-deploy -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
 
 Options:
-  -a, --pacticipant=PACTICIPANT            
+  -a, --pacticipant=PACTICIPANT
                 # The pacticipant name. Use once for each pacticipant being checked.
-  -e, [--version=VERSION]                  
+  -e, [--version=VERSION]
                 # The pacticipant version. Must be entered after the --pacticipant that it relates to.
-      [--ignore=IGNORE]                    
-                # The pacticipant name to ignore. Use once for each pacticipant being ignored. 
-                A specific version can be ignored by also specifying a --version after the 
+      [--ignore=IGNORE]
+                # The pacticipant name to ignore. Use once for each pacticipant being ignored.
+                A specific version can be ignored by also specifying a --version after the
                 pacticipant name option.
-  -l, [--latest=[TAG]]                     
-                # Use the latest pacticipant version. Optionally specify a TAG to use the 
+  -l, [--latest=[TAG]]
+                # Use the latest pacticipant version. Optionally specify a TAG to use the
                 latest version with the specified tag.
-      [--to=TAG]                           
+      [--to=TAG]
                 # This is too hard to explain in a short sentence. Look at the examples.
-  -o, [--output=OUTPUT]                    
+  -o, [--output=OUTPUT]
                 # json or table
-                                           
+
                 # Default: table
-      [--retry-while-unknown=TIMES]        
-                # The number of times to retry while there is an unknown verification result 
+      [--retry-while-unknown=TIMES]
+                # The number of times to retry while there is an unknown verification result
                 (ie. the provider verification is likely still running)
-                                           
+
                 # Default: 0
-      [--retry-interval=SECONDS]           
+      [--retry-interval=SECONDS]
                 # The time between retries in seconds. Use in conjuction with --retry-while-unknown
-                                           
+
                 # Default: 10
-      [--dry-run], [--no-dry-run]          
+      [--dry-run], [--no-dry-run]
                 # When enabled, always exits process with a success code. Can also be enabled by setting
                 the environment variable PACT_BROKER_CAN_I_DEPLOY_DRY_RUN=true.
-  -b, --broker-base-url=BROKER_BASE_URL    
+  -b, --broker-base-url=BROKER_BASE_URL
                 # The base URL of the Pact Broker
-  -u, [--broker-username=BROKER_USERNAME]  
+  -u, [--broker-username=BROKER_USERNAME]
                 # Pact Broker basic auth username
-  -p, [--broker-password=BROKER_PASSWORD]  
+  -p, [--broker-password=BROKER_PASSWORD]
                 # Pact Broker basic auth password
-  -k, [--broker-token=BROKER_TOKEN]        
+  -k, [--broker-token=BROKER_TOKEN]
                 # Pact Broker bearer token
-  -v, [--verbose], [--no-verbose]          
+  -v, [--verbose], [--no-verbose]
                 # Verbose output. Default: false
 ```
 
@@ -235,27 +235,19 @@ Usage:
 
 Options:
   -X, --request=METHOD
-            # HTTP method
+            # Webhook HTTP method
   -H, [--header=one two three]
-            # Header
+            # Webhook Header
   -d, [--data=DATA]
-            # Data
+            # Webhook payload (file or string)
   -u, [--user=USER]
-            # Basic auth username and password eg. username:password
+            # Webhook basic auth username and password eg. username:password
       [--consumer=CONSUMER]
             # Consumer name
       [--provider=PROVIDER]
             # Provider name
-  -b, --broker-base-url=BROKER_BASE_URL
-            # The base URL of the Pact Broker
-      [--broker-username=BROKER_USERNAME]
-            # Pact Broker basic auth username
-  -p, [--broker-password=BROKER_PASSWORD]
-            # Pact Broker basic auth password
-  -k, [--broker-token=BROKER_TOKEN]
-            # Pact Broker bearer token
       [--description=DESCRIPTION]
-            # The description of the webhook
+            # Webhook description
       [--contract-content-changed], [--no-contract-content-changed]
             # Trigger this webhook when the pact content changes
       [--contract-published], [--no-contract-published]
@@ -266,6 +258,16 @@ Options:
             # Trigger this webhook when a failed provider verification result is published
       [--provider-verification-succeeded], [--no-provider-verification-succeeded]
             # Trigger this webhook when a successful provider verification result is published
+      [--team-uuid=UUID]
+            # UUID of the Pactflow team to which the webhook should be assigned (Pactflow only)
+  -b, --broker-base-url=BROKER_BASE_URL
+            # The base URL of the Pact Broker
+  -u, [--broker-username=BROKER_USERNAME]
+            # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]
+            # Pact Broker basic auth password
+  -k, [--broker-token=BROKER_TOKEN]
+            # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
             # Verbose output. Default: false
 
@@ -283,27 +285,19 @@ Usage:
 
 Options:
   -X, --request=METHOD
-            # HTTP method
+            # Webhook HTTP method
   -H, [--header=one two three]
-            # Header
+            # Webhook Header
   -d, [--data=DATA]
-            # Data
+            # Webhook payload (file or string)
   -u, [--user=USER]
-            # Basic auth username and password eg. username:password
+            # Webhook basic auth username and password eg. username:password
       [--consumer=CONSUMER]
             # Consumer name
       [--provider=PROVIDER]
             # Provider name
-  -b, --broker-base-url=BROKER_BASE_URL
-            # The base URL of the Pact Broker
-      [--broker-username=BROKER_USERNAME]
-            # Pact Broker basic auth username
-  -p, [--broker-password=BROKER_PASSWORD]
-            # Pact Broker basic auth password
-  -k, [--broker-token=BROKER_TOKEN]
-            # Pact Broker bearer token
       [--description=DESCRIPTION]
-            # The description of the webhook
+            # Webhook description
       [--contract-content-changed], [--no-contract-content-changed]
             # Trigger this webhook when the pact content changes
       [--contract-published], [--no-contract-published]
@@ -314,6 +308,16 @@ Options:
             # Trigger this webhook when a failed provider verification result is published
       [--provider-verification-succeeded], [--no-provider-verification-succeeded]
             # Trigger this webhook when a successful provider verification result is published
+      [--team-uuid=UUID]
+            # UUID of the Pactflow team to which the webhook should be assigned (Pactflow only)
+  -b, --broker-base-url=BROKER_BASE_URL
+            # The base URL of the Pact Broker
+  -u, [--broker-username=BROKER_USERNAME]
+            # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]
+            # Pact Broker basic auth password
+  -k, [--broker-token=BROKER_TOKEN]
+            # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
             # Verbose output. Default: false
       --uuid=UUID

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

@@ -2264,7 +2264,6 @@ Given **the 'Pricing Service' and 'Condor' already exist in the pact-broker**, u
       }
     ],
     "request": {
-      "url": null,
       "method": "POST",
       "headers": {
         "Foo": "bar",

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

@@ -0,0 +1,94 @@
+### A pact between Pact Broker Client and Pactflow
+
+#### Requests from Pact Broker Client to Pactflow
+
+* [A request for the index resource](#a_request_for_the_index_resource)
+
+* [A request to create a webhook for a team](#a_request_to_create_a_webhook_for_a_team_given_a_team_with_UUID_2abbc12a-427d-432a-a521-c870af1739d9_exists) given a team with UUID 2abbc12a-427d-432a-a521-c870af1739d9 exists
+
+#### Interactions
+
+<a name="a_request_for_the_index_resource"></a>
+Upon receiving **a request for the index resource** from Pact Broker Client, with
+```json
+{
+  "method": "get",
+  "path": "/",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pactflow will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pb:webhooks": {
+        "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PB-WEBHOOKS"
+      },
+      "pb:pacticipants": {
+        "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PB-PACTICIPANTS"
+      },
+      "pb:pacticipant": {
+        "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-{pacticipant}"
+      }
+    }
+  }
+}
+```
+<a name="a_request_to_create_a_webhook_for_a_team_given_a_team_with_UUID_2abbc12a-427d-432a-a521-c870af1739d9_exists"></a>
+Given **a team with UUID 2abbc12a-427d-432a-a521-c870af1739d9 exists**, upon receiving **a request to create a webhook for a team** from Pact Broker Client, with
+```json
+{
+  "method": "post",
+  "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "description": "a webhook",
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
+    "request": {
+      "url": "https://webhook",
+      "method": "POST",
+      "headers": {
+        "Foo": "bar",
+        "Bar": "foo"
+      },
+      "body": {
+        "some": "body"
+      }
+    },
+    "teamUuid": "2abbc12a-427d-432a-a521-c870af1739d9"
+  }
+}
+```
+Pactflow will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "description": "a webhook",
+    "teamUuid": "2abbc12a-427d-432a-a521-c870af1739d9",
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url",
+        "title": "A title"
+      }
+    }
+  }
+}
+```

data/doc/pacts/markdown/README.md

@@ -1,3 +1,4 @@
 ### Pacts for Pact Broker Client
 
 * [Pact Broker](Pact%20Broker%20Client%20-%20Pact%20Broker.md)
+* [Pactflow](Pact%20Broker%20Client%20-%20Pactflow.md)

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

@@ -4,13 +4,13 @@ require 'thor/error'
 require 'pact_broker/client/cli/environment_commands'
 require 'pact_broker/client/cli/deployment_commands'
 require 'pact_broker/client/cli/pacticipant_commands'
+require 'pact_broker/client/cli/webhook_commands'
 
 module PactBroker
   module Client
     module CLI
       # Thor::Error will have its backtrace hidden
       class PactPublicationError < ::Thor::Error; end
-      class WebhookCreationError < ::Thor::Error; end
       class AuthError < ::Thor::Error; end
       class VersionCreationError < ::Thor::Error; end
 
@@ -21,6 +21,7 @@ module PactBroker
           include PactBroker::Client::CLI::DeploymentCommands
         end
         include PactBroker::Client::CLI::PacticipantCommands
+        include PactBroker::Client::CLI::WebhookCommands
 
 
         desc 'can-i-deploy', ''
@@ -131,31 +132,7 @@ module PactBroker
           exit(1) unless result.success
         end
 
-        shared_options_for_webhook_commands
 
-        desc 'create-webhook URL', 'Creates a webhook using the same switches as a curl request.'
-        long_desc File.read(File.join(File.dirname(__FILE__), 'create_webhook_long_desc.txt'))
-        def create_webhook webhook_url
-          run_webhook_commands webhook_url
-        end
-
-        shared_options_for_webhook_commands
-        method_option :uuid, type: :string, required: true, desc: "Specify the uuid for the webhook"
-
-        desc 'create-or-update-webhook URL', 'Creates or updates a webhook with a provided uuid and using the same switches as a curl request.'
-        long_desc File.read(File.join(File.dirname(__FILE__), 'create_or_update_webhook_long_desc.txt'))
-        def create_or_update_webhook webhook_url
-          run_webhook_commands webhook_url
-        end
-
-        desc 'test-webhook', 'Test the execution of a webhook'
-        method_option :uuid, type: :string, required: true, desc: "Specify the uuid for the webhook"
-        shared_authentication_options
-        def test_webhook
-          require 'pact_broker/client/webhooks/test'
-          result = PactBroker::Client::Webhooks::Test.call(options, pact_broker_client_options)
-          $stdout.puts result.message
-        end
 
         ignored_and_hidden_potential_options_from_environment_variables
         desc 'generate-uuid', 'Generate a UUID for use when calling create-or-update-webhook'
@@ -297,64 +274,6 @@ module PactBroker
 
             client_options.compact
           end
-
-          def parse_webhook_events
-            events = []
-            events << 'contract_content_changed' if options.contract_content_changed
-            events << 'contract_published' if options.contract_published
-            events << 'provider_verification_published' if options.provider_verification_published
-            events << 'provider_verification_succeeded' if options.provider_verification_succeeded
-            events << 'provider_verification_failed' if options.provider_verification_failed
-            events
-          end
-
-          def parse_webhook_options(webhook_url)
-            events = parse_webhook_events
-
-            if events.size == 0
-              raise WebhookCreationError.new("You must specify at least one of --contract-content-changed, --contract-published, --provider-verification-published, --provider-verification-succeeded or --provider-verification-failed")
-            end
-
-            username = options.user ? options.user.split(":", 2).first : nil
-            password = options.user ? options.user.split(":", 2).last : nil
-
-            headers = (options.header || []).each_with_object({}) { | header, headers | headers[header.split(":", 2).first.strip] = header.split(":", 2).last.strip }
-
-            body = options.data
-            if body && body.start_with?("@")
-              filepath = body[1..-1]
-              begin
-                body = File.read(filepath)
-              rescue StandardError => e
-                raise WebhookCreationError.new("Couldn't read data from file \"#{filepath}\" due to #{e.class} #{e.message}")
-              end
-            end
-
-            {
-              uuid: options.uuid,
-              description: options.description,
-              http_method: options.request,
-              url: webhook_url,
-              headers: headers,
-              username: username,
-              password: password,
-              body: body,
-              consumer: options.consumer,
-              provider: options.provider,
-              events: events
-            }
-          end
-
-          def run_webhook_commands webhook_url
-            require 'pact_broker/client/webhooks/create'
-
-            validate_credentials
-            result = PactBroker::Client::Webhooks::Create.call(parse_webhook_options(webhook_url), options.broker_base_url, pact_broker_client_options)
-            $stdout.puts result.message
-            exit(1) unless result.success
-          rescue PactBroker::Client::Error => e
-            raise WebhookCreationError, "#{e.class} - #{e.message}"
-          end
         end
       end
     end

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

@@ -91,22 +91,6 @@ module PactBroker
             method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
           end
 
-          def self.shared_options_for_webhook_commands
-            method_option :request, banner: "METHOD", aliases: "-X", desc: "Webhook HTTP method", required: true
-            method_option :header, aliases: "-H", type: :array, desc: "Webhook Header"
-            method_option :data, aliases: "-d", desc: "Webhook payload (file or string)"
-            method_option :user, aliases: "-u", desc: "Webhook basic auth username and password eg. username:password"
-            method_option :consumer, desc: "Consumer name"
-            method_option :provider, desc: "Provider name"
-            method_option :description, desc: "Wwebhook description"
-            method_option :contract_content_changed, type: :boolean, desc: "Trigger this webhook when the pact content changes"
-            method_option :contract_published, type: :boolean, desc: "Trigger this webhook when a pact is published"
-            method_option :provider_verification_published, type: :boolean, desc: "Trigger this webhook when a provider verification result is published"
-            method_option :provider_verification_failed, type: :boolean, desc: "Trigger this webhook when a failed provider verification result is published"
-            method_option :provider_verification_succeeded, type: :boolean, desc: "Trigger this webhook when a successful provider verification result is published"
-            shared_authentication_options
-          end
-
           def self.verbose_option
             method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
           end

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

@@ -0,0 +1,122 @@
+module PactBroker
+  module Client
+    module CLI
+      # Thor::Error will have its backtrace hidden
+      class WebhookCreationError < ::Thor::Error; end
+
+      module WebhookCommands
+        def self.included(thor)
+          thor.class_eval do
+
+            no_commands do
+              def self.shared_options_for_webhook_commands
+                method_option :request, banner: "METHOD", aliases: "-X", desc: "Webhook HTTP method", required: true
+                method_option :header, aliases: "-H", type: :array, desc: "Webhook Header"
+                method_option :data, aliases: "-d", desc: "Webhook payload (file or string)"
+                method_option :user, aliases: "-u", desc: "Webhook basic auth username and password eg. username:password"
+                method_option :consumer, desc: "Consumer name"
+                method_option :provider, desc: "Provider name"
+                method_option :description, desc: "Webhook description"
+                method_option :contract_content_changed, type: :boolean, desc: "Trigger this webhook when the pact content changes"
+                method_option :contract_published, type: :boolean, desc: "Trigger this webhook when a pact is published"
+                method_option :provider_verification_published, type: :boolean, desc: "Trigger this webhook when a provider verification result is published"
+                method_option :provider_verification_failed, type: :boolean, desc: "Trigger this webhook when a failed provider verification result is published"
+                method_option :provider_verification_succeeded, type: :boolean, desc: "Trigger this webhook when a successful provider verification result is published"
+                method_option :team_uuid, banner: "UUID", desc: "UUID of the Pactflow team to which the webhook should be assigned (Pactflow only)"
+                shared_authentication_options
+              end
+            end
+
+            shared_options_for_webhook_commands
+
+            desc 'create-webhook URL', 'Creates a webhook using the same switches as a curl request.'
+            long_desc File.read(File.join(File.dirname(__FILE__), 'create_webhook_long_desc.txt'))
+            def create_webhook webhook_url
+              run_webhook_commands webhook_url
+            end
+
+            shared_options_for_webhook_commands
+            method_option :uuid, type: :string, required: true, desc: "Specify the uuid for the webhook"
+
+            desc 'create-or-update-webhook URL', 'Creates or updates a webhook with a provided uuid and using the same switches as a curl request.'
+            long_desc File.read(File.join(File.dirname(__FILE__), 'create_or_update_webhook_long_desc.txt'))
+            def create_or_update_webhook webhook_url
+              run_webhook_commands webhook_url
+            end
+
+            desc 'test-webhook', 'Test the execution of a webhook'
+            method_option :uuid, type: :string, required: true, desc: "Specify the uuid for the webhook"
+            shared_authentication_options
+            def test_webhook
+              require 'pact_broker/client/webhooks/test'
+              result = PactBroker::Client::Webhooks::Test.call(options, pact_broker_client_options)
+              $stdout.puts result.message
+            end
+
+            no_commands do
+
+              def parse_webhook_events
+                events = []
+                events << 'contract_content_changed' if options.contract_content_changed
+                events << 'contract_published' if options.contract_published
+                events << 'provider_verification_published' if options.provider_verification_published
+                events << 'provider_verification_succeeded' if options.provider_verification_succeeded
+                events << 'provider_verification_failed' if options.provider_verification_failed
+                events
+              end
+
+              def parse_webhook_options(webhook_url)
+                events = parse_webhook_events
+
+                if events.size == 0
+                  raise WebhookCreationError.new("You must specify at least one of --contract-content-changed, --contract-published, --provider-verification-published, --provider-verification-succeeded or --provider-verification-failed")
+                end
+
+                username = options.user ? options.user.split(":", 2).first : nil
+                password = options.user ? options.user.split(":", 2).last : nil
+
+                headers = (options.header || []).each_with_object({}) { | header, headers | headers[header.split(":", 2).first.strip] = header.split(":", 2).last.strip }
+
+                body = options.data
+                if body && body.start_with?("@")
+                  filepath = body[1..-1]
+                  begin
+                    body = File.read(filepath)
+                  rescue StandardError => e
+                    raise WebhookCreationError.new("Couldn't read data from file \"#{filepath}\" due to #{e.class} #{e.message}")
+                  end
+                end
+
+                {
+                  uuid: options.uuid,
+                  description: options.description,
+                  http_method: options.request,
+                  url: webhook_url,
+                  headers: headers,
+                  username: username,
+                  password: password,
+                  body: body,
+                  consumer: options.consumer,
+                  provider: options.provider,
+                  events: events,
+                  team_uuid: options.team_uuid
+                }
+              end
+
+              def run_webhook_commands webhook_url
+                require 'pact_broker/client/webhooks/create'
+
+                validate_credentials
+                result = PactBroker::Client::Webhooks::Create.call(parse_webhook_options(webhook_url), options.broker_base_url, pact_broker_client_options)
+                $stdout.puts result.message
+                exit(1) unless result.success
+              rescue PactBroker::Client::Error => e
+                raise WebhookCreationError, "#{e.class} - #{e.message}"
+              end
+            end
+          end
+        end
+      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.46.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/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_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/pacts/pact_broker_client-pact_broker.json

@@ -1846,7 +1846,6 @@
             }
           ],
           "request": {
-            "url": null,
             "method": "POST",
             "headers": {
               "Foo": "bar",

data/spec/pacts/pact_broker_client-pactflow.json

@@ -0,0 +1,118 @@
+{
+  "consumer": {
+    "name": "Pact Broker Client"
+  },
+  "provider": {
+    "name": "Pactflow"
+  },
+  "interactions": [
+    {
+      "description": "a request for 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:webhooks": {
+              "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PB-WEBHOOKS"
+            },
+            "pb:pacticipants": {
+              "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PB-PACTICIPANTS"
+            },
+            "pb:pacticipant": {
+              "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-{pacticipant}"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:webhooks.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.pb:pacticipants.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.pb:pacticipant.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*{pacticipant}"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a webhook for a team",
+      "providerState": "a team with UUID 2abbc12a-427d-432a-a521-c870af1739d9 exists",
+      "request": {
+        "method": "post",
+        "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "description": "a webhook",
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            }
+          },
+          "teamUuid": "2abbc12a-427d-432a-a521-c870af1739d9"
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "description": "a webhook",
+          "teamUuid": "2abbc12a-427d-432a-a521-c870af1739d9",
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
+    }
+  ],
+  "metadata": {
+    "pactSpecification": {
+      "version": "2.0.0"
+    }
+  }
+}

data/spec/service_providers/pact_helper.rb

@@ -8,7 +8,6 @@ Pact.configure do | config |
 end
 
 Pact.service_consumer 'Pact Broker Client' do
-
   has_pact_with "Pact Broker" do
     mock_service :pact_broker do
       port 1234
@@ -16,6 +15,12 @@ Pact.service_consumer 'Pact Broker Client' do
     end
   end
 
+  has_pact_with "Pactflow" do
+    mock_service :pactflow do
+      port 1235
+      pact_specification_version "2.0"
+    end
+  end
 end
 
 module PactBrokerPactHelperMethods
@@ -30,22 +35,22 @@ module PactBrokerPactHelperMethods
     path
   end
 
-  def placeholder_url(relation, params = [])
-    "#{pact_broker.mock_service_base_url}#{placeholder_path(relation, params)}"
+  def placeholder_url(relation, params = [], mock_service = pact_broker)
+    "#{mock_service.mock_service_base_url}#{placeholder_path(relation, params)}"
   end
 
-  def placeholder_url_term(relation, params = [])
+  def placeholder_url_term(relation, params = [], mock_service = pact_broker)
     regexp = "http:\/\/.*"
     if params.any?
       joined_params_for_regexp = params.collect{ |param| "{#{param}}"}.join(".*")
       regexp = "#{regexp}#{joined_params_for_regexp}"
     end
 
-    Pact.term(placeholder_url(relation, params), /#{regexp}/)
+    Pact.term(placeholder_url(relation, params, mock_service), /#{regexp}/)
   end
 
-  def mock_pact_broker_index(context)
-    pact_broker
+  def mock_pact_broker_index(context, mock_service = pact_broker)
+    mock_service
       .upon_receiving("a request for the index resource")
       .with(
           method: :get,
@@ -57,13 +62,13 @@ module PactBrokerPactHelperMethods
           body: {
             _links: {
               :'pb:webhooks' => {
-                href: placeholder_url_term('pb:webhooks')
+                href: placeholder_url_term('pb:webhooks', [], mock_service)
               },
               :'pb:pacticipants' => {
-                href: placeholder_url_term('pb:pacticipants')
+                href: placeholder_url_term('pb:pacticipants', [], mock_service)
               },
               :'pb:pacticipant' => {
-                href: placeholder_url_term('pb:pacticipant', ['pacticipant'])
+                href: placeholder_url_term('pb:pacticipant', ['pacticipant'], mock_service)
               }
             }
           }

data/spec/service_providers/pactflow_webhooks_create_spec.rb

@@ -0,0 +1,86 @@
+require_relative 'pact_helper'
+require 'pact_broker/client/webhooks/create'
+
+RSpec.describe "creating a webhook in Pactflow", pact: true do
+
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:params) do
+    {
+      description: "a webhook",
+      events: %w{contract_content_changed},
+      http_method: "POST",
+      url: "https://webhook",
+      headers: { "Foo" => "bar", "Bar" => "foo"},
+      body: body,
+      team_uuid: "2abbc12a-427d-432a-a521-c870af1739d9"
+    }
+  end
+
+  let(:body) { { some: "body" }.to_json }
+
+  let(:request_body) do
+    {
+      "description" => "a webhook",
+      "events" => [
+        "name" => "contract_content_changed"
+      ],
+      "request" => {
+        "url" => "https://webhook",
+        "method" => "POST",
+        "headers" => {
+          "Foo" => "bar",
+          "Bar" => "foo"
+        },
+        "body" => {
+          "some" => "body"
+        },
+      },
+      "teamUuid" => "2abbc12a-427d-432a-a521-c870af1739d9"
+    }
+  end
+
+  let(:response_status) { 201 }
+  let(:success_response) do
+    {
+      status: response_status,
+      headers: pact_broker_response_headers,
+      body: {
+        description: Pact.like("a webhook"),
+        teamUuid: "2abbc12a-427d-432a-a521-c870af1739d9",
+        _links: {
+          self: {
+            href: Pact.term('http://localhost:1234/some-url', %r{http://.*}),
+            title: Pact.like("A title")
+          }
+        }
+      }
+    }
+  end
+
+  let(:pact_broker_client_options) { {} }
+
+  subject { PactBroker::Client::Webhooks::Create.call(params, pactflow.mock_service_base_url, pact_broker_client_options) }
+
+  context "when a valid webhook with a team specified is submitted" do
+    before do
+      mock_pact_broker_index(self, pactflow)
+      pactflow
+        .given("a team with UUID 2abbc12a-427d-432a-a521-c870af1739d9 exists")
+        .upon_receiving("a request to create a webhook for a team")
+        .with(
+            method: :post,
+            path: '/HAL-REL-PLACEHOLDER-PB-WEBHOOKS',
+            headers: post_request_headers,
+            body: request_body)
+        .will_respond_with(success_response)
+    end
+
+    it "returns a CommandResult with success = true" do
+      expect(subject).to be_a PactBroker::Client::CommandResult
+      expect(subject.success).to be true
+      expect(subject.message).to eq "Webhook \"a webhook\" created"
+    end
+  end
+end

data/spec/service_providers/webhooks_create_spec.rb

@@ -134,7 +134,7 @@ RSpec.describe "creating a webhook", pact: true do
   context "when an invalid webhook is submitted" do
     before do
       params[:url] = nil
-      request_body["request"]["url"] = nil
+      request_body["request"].delete("url")
 
       pact_broker
         .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")

data/spec/spec_helper.rb

@@ -15,6 +15,7 @@ RSpec.configure do | config |
     ENV.delete('PACT_BROKER_BASE_URL')
     ENV.delete('PACT_BROKER_USERNAME')
     ENV.delete('PACT_BROKER_PASSWORD')
+    ENV.delete('PACT_BROKER_TOKEN')
   end
 
   config.after(:all) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.45.0
+  version: 1.46.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-16 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -230,6 +230,7 @@ files:
 - doc/markdown/Pact Broker Client - Pact Broker.md
 - doc/markdown/README.md
 - doc/pacts/markdown/Pact Broker Client - Pact Broker.md
+- doc/pacts/markdown/Pact Broker Client - Pactflow.md
 - doc/pacts/markdown/README.md
 - example/scripts/README.md
 - example/scripts/deploy-consumer.sh
@@ -252,6 +253,7 @@ files:
 - lib/pact_broker/client/cli/pacticipant_commands.rb
 - lib/pact_broker/client/cli/record_deployment_long_desc.txt
 - lib/pact_broker/client/cli/version_selector_options_parser.rb
+- lib/pact_broker/client/cli/webhook_commands.rb
 - lib/pact_broker/client/colorize_notices.rb
 - lib/pact_broker/client/command_result.rb
 - lib/pact_broker/client/create_tag.rb
@@ -323,6 +325,7 @@ files:
 - script/record-undeployment.sh
 - script/release.sh
 - script/trigger-release.sh
+- script/webhook-commands.sh
 - spec/fixtures/approvals/can_i_deploy_failure_dry_run.approved.txt
 - spec/fixtures/approvals/can_i_deploy_ignore.approved.txt
 - spec/fixtures/approvals/can_i_deploy_success_dry_run.approved.txt
@@ -368,6 +371,7 @@ files:
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/lib/pact_broker/client/webhooks/create_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
+- spec/pacts/pact_broker_client-pactflow.json
 - spec/service_providers/create_environment_spec.rb
 - spec/service_providers/extra_goodies_spec.rb
 - spec/service_providers/list_environments_spec.rb
@@ -383,6 +387,7 @@ files:
 - spec/service_providers/pact_broker_client_tags_spec.rb
 - spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
+- spec/service_providers/pactflow_webhooks_create_spec.rb
 - spec/service_providers/pacticipants_create_spec.rb
 - spec/service_providers/publish_pacts_spec.rb
 - spec/service_providers/record_deployment_spec.rb
@@ -422,7 +427,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.2.21
 signing_key: 
 specification_version: 4
 summary: See description
@@ -472,6 +477,7 @@ test_files:
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/lib/pact_broker/client/webhooks/create_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
+- spec/pacts/pact_broker_client-pactflow.json
 - spec/service_providers/create_environment_spec.rb
 - spec/service_providers/extra_goodies_spec.rb
 - spec/service_providers/list_environments_spec.rb
@@ -487,6 +493,7 @@ test_files:
 - spec/service_providers/pact_broker_client_tags_spec.rb
 - spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
+- spec/service_providers/pactflow_webhooks_create_spec.rb
 - spec/service_providers/pacticipants_create_spec.rb
 - spec/service_providers/publish_pacts_spec.rb
 - spec/service_providers/record_deployment_spec.rb