pact_broker-client 1.25.0 → 1.27.2

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.25.0'
+    VERSION = '1.27.2'
   end
 end

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

@@ -101,7 +101,13 @@ module PactBroker
         end
 
         def success_result(webhook_entity)
-          CommandResult.new(true, "Webhook #{webhook_entity._link('self').title_or_name.inspect} created")
+          action = webhook_entity.response.status == 201 ? "created" : "updated"
+          name = if webhook_entity.description && webhook_entity.description.size > 0
+            webhook_entity.description
+          else
+            webhook_entity._link('self').title_or_name
+          end
+          CommandResult.new(true, "Webhook #{name.inspect} #{action}")
         end
 
         def error_result(message)

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

@@ -0,0 +1,16 @@
+require 'pact_broker/client/hal'
+require 'pact_broker/client/command_result'
+
+module PactBroker
+  module Client
+    module Webhooks
+      class Test
+        def self.call(options, pact_broker_client_options)
+          http_client = PactBroker::Client::Hal::HttpClient.new(pact_broker_client_options.merge(pact_broker_client_options[:basic_auth] || {}))
+          execution_result = PactBroker::Client::Hal::EntryPoint.new(options.broker_base_url, http_client).get!._link!('pb:webhook').expand('uuid' => options.uuid).get!.post('pb:execute')
+          PactBroker::Client::CommandResult.new(true, execution_result.response.body['logs'])
+        end
+      end
+    end
+  end
+end

data/pact-broker-client.gemspec

@@ -21,12 +21,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.license       = 'MIT'
 
-  gem.add_runtime_dependency 'httparty'
-  gem.add_runtime_dependency 'json'
-  gem.add_runtime_dependency 'term-ansicolor'
+  gem.add_runtime_dependency 'httparty', '~>0.18'
+  gem.add_runtime_dependency 'term-ansicolor', '~> 1.7'
   gem.add_runtime_dependency 'table_print', '~> 1.5'
   gem.add_runtime_dependency 'thor', '~> 0.20'
-  gem.add_runtime_dependency 'rake' #For FileList
+  gem.add_runtime_dependency 'rake', '~> 13.0' #For FileList
 
   gem.add_development_dependency 'fakefs', '~> 0.4'
   gem.add_development_dependency 'webmock', '~> 3.0'

data/spec/integration/can_i_deploy_spec.rb

@@ -1,7 +1,7 @@
-describe "pact-broker can-i-deploy", skip_windows: true, skip_ci: true do
+describe "pact-broker can-i-deploy", skip_windows: true do
   before(:all) do
-    @pipe = IO.popen("bundle exec pact-stub-service spec/pacts/pact_broker_client-pact_broker.json -p 5000")
-    sleep 2
+    @pipe = IO.popen("bundle exec pact-stub-service spec/pacts/pact_broker_client-pact_broker.json -p 5000 --log tmp/pact-stub-can-i-deploy.log")
+    sleep 4
   end
 
   context "when the pacticipants can be deployed" do

data/spec/integration/create_version_tag_spec.rb

@@ -1,7 +1,6 @@
-# Currently failing on Travis, skip for now
-describe "pact-broker create-version-tag", skip_windows: true, skip_ci: true do
+describe "pact-broker create-version-tag", skip_windows: true do
   before(:all) do
-    @pipe = IO.popen("bundle exec pact-stub-service spec/pacts/pact_broker_client-pact_broker.json -p 5001")
+    @pipe = IO.popen("bundle exec pact-stub-service spec/pacts/pact_broker_client-pact_broker.json -p 5001 --log tmp/pact-stub-service-create-verison-tag.log")
     sleep 2
   end
 

data/spec/lib/pact_broker/client/can_i_deploy_spec.rb

@@ -9,11 +9,19 @@ module PactBroker
       let(:matrix_options) { {} }
       let(:pact_broker_client_options) { { foo: 'bar' } }
       let(:matrix_client) { instance_double('PactBroker::Client::Matrix') }
-      let(:matrix) { instance_double('Matrix::Resource', deployable?: true, reason: 'some reason', any_unknown?: any_unknown, supports_unknown_count?: supports_unknown_count) }
-      let(:any_unknown) { false }
+      let(:matrix) do
+        instance_double('Matrix::Resource',
+          deployable?: true,
+          reason: 'some reason',
+          any_unknown?: any_unknown,
+          supports_unknown_count?: supports_unknown_count,
+          unknown_count: unknown_count)
+      end
+      let(:unknown_count) { 0 }
+      let(:any_unknown) { unknown_count > 0 }
       let(:supports_unknown_count) { true }
       let(:retry_while_unknown) { 0 }
-      let(:options) { { output: 'text', retry_while_unknown: retry_while_unknown, retry_interval: 5} }
+      let(:options) { { output: 'text', retry_while_unknown: retry_while_unknown, retry_interval: 5 } }
 
 
       before do
@@ -76,7 +84,17 @@ module PactBroker
         end
 
         context "when any_unknown? is true" do
-          let(:any_unknown) { true }
+          before do
+            allow($stderr).to receive(:puts)
+            allow(Retry).to receive(:until_truthy_or_max_times)
+          end
+
+          let(:unknown_count) { 1 }
+
+          it "puts a message to stderr" do
+            expect($stderr).to receive(:puts).with("Waiting for 1 verification result to be published (maximum of 5 seconds)")
+            subject
+          end
 
           it "retries the request" do
             expect(Retry).to receive(:until_truthy_or_max_times).with(hash_including(times: 1, sleep: 5, sleep_first: true))

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

@@ -22,6 +22,7 @@ module PactBroker
           let(:options_hash) do
             {
               uuid: '9999',
+              description: "some webhook",
               request: "POST",
               header: header,
               data: data,
@@ -39,6 +40,7 @@ module PactBroker
           let(:expected_params) do
             {
               uuid: '9999',
+              description: "some webhook",
               http_method: "POST",
               url: "http://webhook",
               headers: { "Foo" => "bar", "Bar" => "foo"},

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

@@ -109,6 +109,12 @@ module PactBroker::Client::CLI
         expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq output
       end
 
+      it "turns '--tag=foo --tag=bar' into '--tag foo bar'" do
+        input = %w{--ignore this --tag=foo --tag=bar --wiffle --that}
+        output = %w{--ignore this --tag foo bar --wiffle --that }
+        expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq output
+      end
+
       it "doesn't change anything when there are no duplicate options" do
         input = %w{--ignore this --taggy foo --blah bar --wiffle --that}
         expect(TestThor.turn_muliple_tag_options_into_array(input)).to eq input

data/spec/lib/pact_broker/client/hal/entity_spec.rb

@@ -17,6 +17,7 @@ module PactBroker::Client
           "name" => "Provider"
         }
       end
+
       let(:pact_hash) do
         {
           "name" => "a name",

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

@@ -0,0 +1,28 @@
+require 'pact_broker/client/pacticipants/create'
+
+module PactBroker
+  module Client
+    module Pacticipants2
+      describe Create do
+        describe ".call" do
+          let(:pact_broker_client_options) { {} }
+          let(:broker_base_url) { "http://url" }
+          let(:params) { { name: 'Foo' } }
+
+          subject { Create.call(params, broker_base_url, pact_broker_client_options)}
+
+          context "when there is an http error" do
+            let!(:index_request) do
+              stub_request(:get, broker_base_url).to_return(status: 500, body: 'some error', headers: { "Content-Type" => "application/hal+json" }  )
+            end
+
+            it "returns a failure result" do
+              expect(subject.success).to be false
+              expect(subject.message).to include 'some error'
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -70,6 +70,28 @@ module PactBroker
               expect(subject.message).to match /"some":"error"/
             end
           end
+
+          context "when there is an empty description returned" do
+            let!(:webhook_request) do
+              stub_request(:post, "http://broker/webhooks").to_return(status: 200, body: response_body.to_json, headers: { "Content-Type" => "application/hal+json" })
+            end
+
+            let(:response_body) do
+              {
+                description: "",
+                _links: {
+                  self: {
+                    href: "href",
+                    title: "the title"
+                  }
+                }
+              }
+            end
+
+            it "uses the self title in the message instead" do
+              expect(subject.message).to include "the title"
+            end
+          end
         end
       end
     end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -192,7 +192,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=4.5.6&latestby=cvpv"
+        "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1.2.3&q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Bversion%5D=4.5.6&latestby=cvpv"
       },
       "response": {
         "status": 200,
@@ -242,7 +242,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo%20Thing&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=4.5.6&latestby=cvpv"
+        "query": "q%5B%5D%5Bpacticipant%5D=Foo%20Thing&q%5B%5D%5Bversion%5D=1.2.3&q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Bversion%5D=4.5.6&latestby=cvpv"
       },
       "response": {
         "status": 200,
@@ -292,7 +292,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&latestby=cvp&latest=true"
+        "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1.2.3&latestby=cvp&latest=true"
       },
       "response": {
         "status": 200,
@@ -342,7 +342,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=9.9.9&latestby=cvpv"
+        "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1.2.3&q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Bversion%5D=9.9.9&latestby=cvpv"
       },
       "response": {
         "status": 200,
@@ -366,7 +366,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Wiffle&q[][version]=1.2.3&q[][pacticipant]=Meep&q[][version]=9.9.9&latestby=cvpv"
+        "query": "q%5B%5D%5Bpacticipant%5D=Wiffle&q%5B%5D%5Bversion%5D=1.2.3&q%5B%5D%5Bpacticipant%5D=Meep&q%5B%5D%5Bversion%5D=9.9.9&latestby=cvpv"
       },
       "response": {
         "status": 400,
@@ -394,7 +394,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][pacticipant]=Bar&latestby=cvpv"
+        "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bpacticipant%5D=Bar&latestby=cvpv"
       },
       "response": {
         "status": 200,
@@ -463,7 +463,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][pacticipant]=Bar&latestby=cvpv&success[]=true"
+        "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bpacticipant%5D=Bar&latestby=cvpv&success%5B%5D=true"
       },
       "response": {
         "status": 200,
@@ -513,7 +513,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][latest]=true&q[][tag]=prod&latestby=cvpv"
+        "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1.2.3&q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Blatest%5D=true&q%5B%5D%5Btag%5D=prod&latestby=cvpv"
       },
       "response": {
         "status": 200,
@@ -563,7 +563,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][version]=1.2.4&q[][pacticipant]=Bar&q[][latest]=true&latestby=cvpv"
+        "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1.2.4&q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Blatest%5D=true&latestby=cvpv"
       },
       "response": {
         "status": 200,
@@ -613,7 +613,7 @@
       "request": {
         "method": "get",
         "path": "/matrix",
-        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&latestby=cvp&latest=true&tag=prod"
+        "query": "q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1.2.3&latestby=cvp&latest=true&tag=prod"
       },
       "response": {
         "status": 200,
@@ -1249,6 +1249,161 @@
         }
       }
     },
+    {
+      "description": "a request for the index resource",
+      "providerState": "the pacticipant relations are present",
+      "request": {
+        "method": "get",
+        "path": "/",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pb:pacticipants": {
+              "href": "http://localhost:1234/pacticipants"
+            },
+            "pb:pacticipant": {
+              "href": "http://localhost:1234/pacticipants/{pacticipant}"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:pacticipants.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.pb:pacticipant.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*\\{pacticipant\\}"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to retrieve a pacticipant",
+      "request": {
+        "method": "get",
+        "path": "/pacticipants/Foo",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 404,
+        "headers": {
+        }
+      }
+    },
+    {
+      "description": "a request to create a pacticipant",
+      "request": {
+        "method": "post",
+        "path": "/pacticipants",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "name": "Foo",
+          "repositoryUrl": "http://foo"
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "name": "Foo",
+          "repositoryUrl": "http://foo",
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/pacticipants/Foo"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to retrieve a pacticipant",
+      "providerState": "a pacticipant with name Foo exists",
+      "request": {
+        "method": "get",
+        "path": "/pacticipants/Foo",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/pacticipants/Foo"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to update a pacticipant",
+      "providerState": "a pacticipant with name Foo exists",
+      "request": {
+        "method": "patch",
+        "path": "/pacticipants/Foo",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "name": "Foo",
+          "repositoryUrl": "http://foo"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "name": "Foo",
+          "repositoryUrl": "http://foo",
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/pacticipants/Foo"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
     {
       "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",
@@ -1287,6 +1442,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1295,6 +1451,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
@@ -1355,6 +1514,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1363,6 +1523,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
@@ -1409,6 +1572,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1417,6 +1581,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
@@ -1538,6 +1705,12 @@
           "_links": {
             "pb:webhooks": {
               "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-WEBHOOKS"
+            },
+            "pb:pacticipants": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANTS"
+            },
+            "pb:pacticipant": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-{pacticipant}"
             }
           }
         },
@@ -1545,6 +1718,14 @@
           "$.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}"
           }
         }
       }
@@ -1590,6 +1771,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1598,6 +1780,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
@@ -1705,6 +1890,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1713,6 +1899,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
@@ -1760,6 +1949,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1768,6 +1958,9 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
@@ -1852,6 +2045,7 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "description": "a webhook",
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -1860,6 +2054,75 @@
           }
         },
         "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to update a webhook",
+      "providerState": "a webhook with the uuid 696c5f93-1b7f-44bc-8d03-59440fcaa9a0 exists",
+      "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": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "description": "a webhook",
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
           "$.body._links.self.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"