pact_broker-client 1.23.0 → 1.24.0

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

@@ -27,6 +27,12 @@ module PactBroker::Client::CLI
       Delegate.call(options)
     end
 
+    desc '', ''
+    ignored_and_hidden_potential_options_from_environment_variables
+    def test_without_parameters
+      Delegate.call(options)
+    end
+
     default_command :test_default
   end
 
@@ -65,6 +71,11 @@ module PactBroker::Client::CLI
         end
         TestThor.start(%w{test_using_env_vars --broker-base-url http://bar})
       end
+
+      it "allows commands to be called that don't use the environment variables" do
+        expect(Delegate).to receive(:call)
+        TestThor.start(%w{test_without_parameters})
+      end
     end
 
     describe ".turn_muliple_tag_options_into_array" do

data/spec/lib/pact_broker/client/webhooks/create_spec.rb

@@ -18,10 +18,6 @@ module PactBroker
             stub_request(:get, "http://broker").with(headers: { "Authorization" => /.*/}).to_return(status: 200, body: index_body, headers: { "Content-Type" => "application/hal+json" }  )
           end
 
-          let!(:webhook_request) do
-            stub_request(:post, "http://broker/webhooks").to_return(status: 405)
-          end
-
           let(:params) do
             {
               http_method: "POST",
@@ -44,8 +40,22 @@ module PactBroker
           subject { Create.call(params, "http://broker", pact_broker_client_options) }
 
           context "when a 405 is returned from the webhook creation request" do
-            it "raises an error with a message to upgrade the Pact Broker" do
-              expect { subject }.to raise_error PactBroker::Client::Error, /This version of the Pact Broker/
+            let!(:webhook_request) do
+              stub_request(:post, "http://broker/webhooks").to_return(status: 405)
+            end
+
+            it "returns a result with success=false and a message" do
+              expect(subject.success).to be false
+              expect(subject.message).to eq Create::WEBHOOKS_WITH_OPTIONAL_PACTICICPANTS_NOT_SUPPORTED
+            end
+          end
+
+          context "when a UUID is specified and index does not contain a pb:webhook relation" do
+            subject { Create.call(params.merge(uuid: 'some-uuid'), "http://broker", pact_broker_client_options) }
+
+            it "returns a result with success=false and a message" do
+              expect(subject.success).to be false
+              expect(subject.message).to eq Create::CREATING_WEBHOOK_WITH_UUID_NOT_SUPPORTED
             end
           end
 

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -1260,6 +1260,7 @@
           "Accept": "application/hal+json"
         },
         "body": {
+          "description": "a webhook",
           "events": [
             {
               "name": "contract_content_changed"
@@ -1304,6 +1305,74 @@
         }
       }
     },
+    {
+      "description": "a request to create a webhook with every possible event type",
+      "providerState": "the 'Pricing Service' and 'Condor' already exist in the pact-broker",
+      "request": {
+        "method": "post",
+        "path": "/webhooks/provider/Pricing%20Service/consumer/Condor",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "description": "a webhook",
+          "events": [
+            {
+              "name": "contract_content_changed"
+            },
+            {
+              "name": "contract_published"
+            },
+            {
+              "name": "provider_verification_published"
+            },
+            {
+              "name": "provider_verification_succeeded"
+            },
+            {
+              "name": "provider_verification_failed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            },
+            "username": "username",
+            "password": "password"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
+    },
     {
       "description": "a request to create a webhook with a non-JSON body for a consumer and provider",
       "providerState": "the 'Pricing Service' and 'Condor' already exist in the pact-broker",
@@ -1315,6 +1384,7 @@
           "Accept": "application/hal+json"
         },
         "body": {
+          "description": "a webhook",
           "events": [
             {
               "name": "contract_content_changed"
@@ -1368,6 +1438,7 @@
           "Accept": "application/hal+json"
         },
         "body": {
+          "description": "a webhook",
           "events": [
             {
               "name": "contract_content_changed"
@@ -1421,6 +1492,7 @@
           "Accept": "application/hal+json"
         },
         "body": {
+          "description": "a webhook",
           "events": [
             {
               "name": "contract_content_changed"
@@ -1488,6 +1560,7 @@
           "Accept": "application/hal+json"
         },
         "body": {
+          "description": "a webhook",
           "events": [
             {
               "name": "contract_content_changed"
@@ -1545,6 +1618,7 @@
           "Accept": "application/hal+json"
         },
         "body": {
+          "description": "a webhook",
           "events": [
             {
               "name": "contract_content_changed"
@@ -1601,6 +1675,7 @@
           "Accept": "application/hal+json"
         },
         "body": {
+          "description": "a webhook",
           "events": [
             {
               "name": "contract_content_changed"
@@ -1658,6 +1733,7 @@
           "Accept": "application/hal+json"
         },
         "body": {
+          "description": "a webhook",
           "events": [
             {
               "name": "contract_content_changed"
@@ -1701,6 +1777,98 @@
           }
         }
       }
+    },
+    {
+      "description": "a request for the index resource with the webhook relation",
+      "request": {
+        "method": "get",
+        "path": "/",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pb:webhook": {
+              "href": "http://localhost:1234/webhooks/{uuid}",
+              "templated": true
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:webhook.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*\\/webhooks\\/{uuid}"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a webhook with a JSON body and a uuid",
+      "providerState": "the 'Pricing Service' and 'Condor' already exist in the pact-broker",
+      "request": {
+        "method": "put",
+        "path": "/webhooks/696c5f93-1b7f-44bc-8d03-59440fcaa9a0",
+        "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"
+            },
+            "username": "username",
+            "password": "password"
+          },
+          "provider": {
+            "name": "Pricing Service"
+          },
+          "consumer": {
+            "name": "Condor"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
     }
   ],
   "metadata": {

data/spec/service_providers/pact_helper.rb

@@ -63,4 +63,25 @@ module PactBrokerPactHelperMethods
           }
         )
   end
+
+  def mock_pact_broker_index_with_webhook_relation(context)
+    pact_broker
+      .upon_receiving("a request for the index resource with the webhook relation")
+      .with(
+          method: :get,
+          path: '/',
+          headers: context.get_request_headers).
+        will_respond_with(
+          status: 200,
+          headers: context.pact_broker_response_headers,
+          body: {
+            _links: {
+              :'pb:webhook' => {
+                href: Pact.term(pact_broker.mock_service_base_url + "/webhooks/{uuid}", %r{http://.*/webhooks/{uuid}}),
+                templated: true
+              }
+            }
+          }
+        )
+  end
 end

data/spec/service_providers/webhooks_create_spec.rb

@@ -6,8 +6,12 @@ RSpec.describe "creating a webhook", pact: true do
   include_context "pact broker"
   include PactBrokerPactHelperMethods
 
+  let(:event_names) { %w{contract_content_changed contract_published provider_verification_published provider_verification_succeeded provider_verification_failed}  }
+
   let(:params) do
     {
+      description: "a webhook",
+      events: %w{contract_content_changed},
       http_method: "POST",
       url: "https://webhook",
       headers: { "Foo" => "bar", "Bar" => "foo"},
@@ -15,8 +19,7 @@ RSpec.describe "creating a webhook", pact: true do
       password: "password",
       body: body,
       consumer: "Condor",
-      provider: "Pricing Service",
-      events: ["contract_content_changed"]
+      provider: "Pricing Service"
     }.tap { |it| Pact::Fixture.add_fixture(:create_webhook_params, it) }
   end
 
@@ -24,10 +27,9 @@ RSpec.describe "creating a webhook", pact: true do
 
   let(:request_body) do
     {
+      "description" => "a webhook",
       "events" => [
-        {
-          "name" => "contract_content_changed"
-        }
+        "name" => "contract_content_changed"
       ],
       "request" => {
         "url" => "https://webhook",
@@ -84,6 +86,27 @@ RSpec.describe "creating a webhook", pact: true do
     end
   end
 
+  context "when a valid webhook with every possible event type is sumbitted" do
+    before do
+      params.merge!(events: event_names)
+      request_body.merge!("events" => event_names.map{ |event_name| { "name" => event_name } })
+
+      pact_broker
+        .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")
+        .upon_receiving("a request to create a webhook with every possible event type")
+        .with(
+            method: :post,
+            path: '/webhooks/provider/Pricing%20Service/consumer/Condor',
+            headers: post_request_headers,
+            body: request_body)
+        .will_respond_with(success_response)
+    end
+
+    it "returns a CommandResult with success = true" do
+      expect(subject.success).to be true
+    end
+  end
+
   context "when a valid webhook with an XML body is submitted" do
     before do
       request_body["request"]["body"] = body
@@ -252,4 +275,30 @@ RSpec.describe "creating a webhook", pact: true do
       expect(subject.success).to be true
     end
   end
+
+  context "when a uuid is specified" do
+    before do
+      params.merge!(uuid: uuid)
+      request_body["provider"] = { "name" => "Pricing Service" }
+      request_body["consumer"] = { "name" => "Condor" }
+      mock_pact_broker_index_with_webhook_relation(self)
+
+      pact_broker
+        .upon_receiving("a request to create a webhook with a JSON body and a uuid")
+        .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")
+        .with(
+            method: :put,
+            path: "/webhooks/#{uuid}",
+            headers: put_request_headers,
+            body: request_body)
+        .will_respond_with(success_response)
+    end
+    let(:uuid) { '696c5f93-1b7f-44bc-8d03-59440fcaa9a0' }
+
+    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 title\" created"
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.24.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -199,6 +199,7 @@ files:
 - lib/pact_broker/client/can_i_deploy.rb
 - lib/pact_broker/client/cli/broker.rb
 - lib/pact_broker/client/cli/can_i_deploy_long_desc.txt
+- lib/pact_broker/client/cli/create_or_update_webhook_long_desc.txt
 - lib/pact_broker/client/cli/create_webhook_long_desc.txt
 - lib/pact_broker/client/cli/custom_thor.rb
 - lib/pact_broker/client/cli/version_selector_options_parser.rb
@@ -244,8 +245,10 @@ files:
 - spec/lib/pact_broker/client/base_client_spec.rb
 - spec/lib/pact_broker/client/can_i_deploy_spec.rb
 - spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb
+- spec/lib/pact_broker/client/cli/broker_create_or_update_webhook_spec.rb
 - spec/lib/pact_broker/client/cli/broker_create_webhook_spec.rb
 - spec/lib/pact_broker/client/cli/broker_publish_spec.rb
+- spec/lib/pact_broker/client/cli/broker_run_webhook_commands_spec.rb
 - spec/lib/pact_broker/client/cli/custom_thor_spec.rb
 - spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb
 - spec/lib/pact_broker/client/git_spec.rb
@@ -309,7 +312,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: See description
@@ -319,8 +322,10 @@ test_files:
 - spec/lib/pact_broker/client/base_client_spec.rb
 - spec/lib/pact_broker/client/can_i_deploy_spec.rb
 - spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb
+- spec/lib/pact_broker/client/cli/broker_create_or_update_webhook_spec.rb
 - spec/lib/pact_broker/client/cli/broker_create_webhook_spec.rb
 - spec/lib/pact_broker/client/cli/broker_publish_spec.rb
+- spec/lib/pact_broker/client/cli/broker_run_webhook_commands_spec.rb
 - spec/lib/pact_broker/client/cli/custom_thor_spec.rb
 - spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb
 - spec/lib/pact_broker/client/git_spec.rb