pact_broker-client 1.35.0 → 1.36.0

data/spec/lib/pact_broker/client/tasks/publication_task_spec.rb

@@ -3,7 +3,6 @@ require 'pact_broker/client/tasks/publication_task'
 require 'pact_broker/client/publish_pacts'
 
 module PactBroker::Client
-
   describe PublicationTask do
 
     before do
@@ -22,7 +21,6 @@ module PactBroker::Client
     let(:pattern) { "spec/pacts/*.json" }
 
     describe "default task" do
-
       before :all do
         PactBroker::Client::PublicationTask.new do | task |
           task.consumer_version = '1.2.3'
@@ -31,7 +29,7 @@ module PactBroker::Client
 
       context "when pacts are succesfully published" do
         it "invokes PublishPacts with the default values" do
-          expect(PactBroker::Client::PublishPacts).to receive(:new).with('http://pact-broker', pact_file_list, '1.2.3', [], {}).and_return(publish_pacts)
+          expect(PactBroker::Client::PublishPacts).to receive(:new).with('http://pact-broker', pact_file_list, { number: '1.2.3', branch: "foo", tags: [], version_required: false}, {}).and_return(publish_pacts)
           expect(publish_pacts).to receive(:call).and_return(true)
           Rake::Task['pact:publish'].execute
         end
@@ -54,7 +52,7 @@ module PactBroker::Client
       end
 
       it "invokes PublishPacts with the write method set" do
-        expect(PactBroker::Client::PublishPacts).to receive(:new).with('http://pact-broker', pact_file_list, '1.2.3', [], {write: :merge}).and_return(publish_pacts)
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with('http://pact-broker', pact_file_list, { number: "1.2.3", branch: "foo", tags: [], version_required: false }, {write: :merge}).and_return(publish_pacts)
         expect(publish_pacts).to receive(:call).and_return(true)
         Rake::Task['pact:publish:merge'].execute
       end
@@ -65,17 +63,98 @@ module PactBroker::Client
         PactBroker::Client::PublicationTask.new(:git_branch) do | task |
           task.consumer_version = '1.2.3'
           task.tag_with_git_branch = true
+          task.auto_detect_version_properties = false
           task.tags = ['bar']
         end
       end
 
-      it "invokes PublishPacts with the git branch name as a tag" do
-        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, anything, ['bar', 'foo'], anything).and_return(publish_pacts)
+      it "gets the git branch name" do
+        expect(PactBroker::Client::Git).to receive(:branch).with(raise_error: true)
+        Rake::Task['pact:publish:git_branch'].execute
+      end
 
+      it "invokes PublishPacts with the git branch name as a tag" do
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(tags: ['bar', 'foo']), anything).and_return(publish_pacts)
         Rake::Task['pact:publish:git_branch'].execute
       end
     end
 
+    context "when auto_detect_version_properties is explicitly set to true" do
+      before :all do
+        PactBroker::Client::PublicationTask.new(:git_branch_auto_detect_true) do | task |
+          task.consumer_version = '1.2.3'
+          task.auto_detect_version_properties = true
+        end
+      end
+
+      it "gets the git branch name" do
+        expect(PactBroker::Client::Git).to receive(:branch).with(raise_error: true)
+        Rake::Task['pact:publish:git_branch_auto_detect_true'].execute
+      end
+
+      it "invokes PublishPacts with the branch name" do
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(branch: "foo"), anything).and_return(publish_pacts)
+        Rake::Task['pact:publish:git_branch_auto_detect_true'].execute
+      end
+    end
+
+    context "when auto_detect_version_properties is explicitly set to true and the branch is specified" do
+      before :all do
+        PactBroker::Client::PublicationTask.new(:git_branch_auto_detect_true_with_branch) do | task |
+          task.consumer_version = '1.2.3'
+          task.auto_detect_version_properties = true
+          task.branch = "main"
+        end
+      end
+
+      it "does not get the branch name" do
+        expect(PactBroker::Client::Git).to_not receive(:branch)
+        Rake::Task['pact:publish:git_branch_auto_detect_true_with_branch'].execute
+      end
+
+      it "invokes PublishPacts with the specified branch name" do
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(branch: "main"), anything).and_return(publish_pacts)
+        Rake::Task['pact:publish:git_branch_auto_detect_true_with_branch'].execute
+      end
+    end
+
+    context "when auto_detect_version_properties is explicitly set to false" do
+      before :all do
+        PactBroker::Client::PublicationTask.new(:git_branch_auto_detect_false) do | task |
+          task.consumer_version = '1.2.3'
+          task.auto_detect_version_properties = false
+        end
+      end
+
+      it "does not get the git branch name" do
+        expect(PactBroker::Client::Git).to_not receive(:branch)
+        Rake::Task['pact:publish:git_branch_auto_detect_false'].execute
+      end
+
+      it "invokes PublishPacts without the branch name" do
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_not_including(branch: "foo"), anything).and_return(publish_pacts)
+        Rake::Task['pact:publish:git_branch_auto_detect_false'].execute
+      end
+    end
+
+    context "when auto_detect_version_properties is left as its default" do
+      before :all do
+        PactBroker::Client::PublicationTask.new(:git_branch_auto_detect_default) do | task |
+          task.consumer_version = '1.2.3'
+        end
+      end
+
+      it "gets the git branch name" do
+        expect(PactBroker::Client::Git).to receive(:branch).with(raise_error: false)
+        Rake::Task['pact:publish:git_branch_auto_detect_default'].execute
+      end
+
+      it "invokes PublishPacts with the branch name" do
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(branch: "foo"), anything).and_return(publish_pacts)
+        Rake::Task['pact:publish:git_branch_auto_detect_default'].execute
+      end
+    end
+
     describe "custom task" do
 
       before :all do
@@ -98,10 +177,9 @@ module PactBroker::Client
 
       it "invokes PublishPacts with the customised values" do
         expect(PactBroker::Client::PublishPacts).to receive(:new).with(
-          @pact_broker_base_url, 
-          pact_file_list, 
-          '1.2.3', 
-          [@tag], 
+          @pact_broker_base_url,
+          pact_file_list,
+          { number: "1.2.3", tags: [@tag], branch: "foo", version_required: false},
           { basic_auth: @pact_broker_basic_auth, token: @pact_broker_token }
         )
         expect(publish_pacts).to receive(:call).and_return(true)

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -186,6 +186,112 @@
         }
       }
     },
+    {
+      "description": "a request for the index resource",
+      "providerState": "the pb:pacticipant-version relation exists 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-INDEX-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:pacticipant-version.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*{pacticipant}.*{version}"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a pacticipant version",
+      "providerState": "version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does not exist",
+      "request": {
+        "method": "put",
+        "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "branch": "main",
+          "buildUrl": "http://my-ci/builds/1"
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "number": "26f353580936ad3b9baddb17b00e84f33c69e7cb",
+          "branch": "main",
+          "buildUrl": "http://my-ci/builds/1",
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a pacticipant version",
+      "providerState": "version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does exist",
+      "request": {
+        "method": "put",
+        "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "branch": "main",
+          "buildUrl": "http://my-ci/builds/1"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "number": "26f353580936ad3b9baddb17b00e84f33c69e7cb",
+          "branch": "main",
+          "buildUrl": "http://my-ci/builds/1",
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
     {
       "description": "a request for the compatibility matrix for Foo version 1.2.3 and Bar version 4.5.6",
       "providerState": "the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6",

data/spec/service_providers/pact_broker_client_create_version_spec.rb

@@ -0,0 +1,89 @@
+require_relative 'pact_helper'
+require 'pact_broker/client'
+require 'pact_broker/client/publish_pacts'
+
+describe PactBroker::Client::Versions, pact: true do
+
+  include_context "pact broker"
+
+
+  describe "creating a pacticipant version" do
+    before do
+      allow(publish_pacts).to receive(:consumer_names).and_return(["Foo"])
+      allow($stdout).to receive(:puts)
+    end
+    let(:version_path) { "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-{pacticipant}-{version}" }
+    let(:version_url) { pact_broker.mock_service_base_url + version_path }
+    let(:number) { "26f353580936ad3b9baddb17b00e84f33c69e7cb" }
+    let(:branch) { "main" }
+    let(:build_url) { "http://my-ci/builds/1" }
+    let(:consumer_version_params) { { number: number, branch: branch, build_url: build_url } }
+    let(:publish_pacts) { PactBroker::Client::PublishPacts.new(pact_broker.mock_service_base_url, ["some-pact.json"], consumer_version_params, {}) }
+    let(:provider_state) { "version #{number} of pacticipant Foo does not exist" }
+    let(:expected_response_status) { 201 }
+
+    subject { publish_pacts.send(:create_consumer_versions) }
+
+    before do
+      pact_broker
+        .given("the pb:pacticipant-version relation exists in the index resource")
+        .upon_receiving("a request for the index resource")
+        .with(
+            method: :get,
+            path: '/',
+            headers: get_request_headers).
+          will_respond_with(
+            status: 200,
+            headers: pact_broker_response_headers,
+            body: {
+              _links: {
+                :'pb:pacticipant-version' => {
+                  href: Pact.term(version_url, /http:\/\/.*{pacticipant}.*{version}/)
+                }
+              }
+            }
+          )
+
+      pact_broker
+        .given(provider_state)
+        .upon_receiving("a request to create a pacticipant version")
+        .with(
+            method: :put,
+            path: "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-#{number}",
+            headers: put_request_headers,
+            body: {
+              branch: branch,
+              buildUrl: build_url
+            }).
+          will_respond_with(
+            status: expected_response_status,
+            headers: pact_broker_response_headers,
+            body: {
+              number: number,
+              branch: branch,
+              buildUrl: build_url,
+              _links: {
+                self: {
+                  href: Pact.term('http://localhost:1234/some-url', %r{http://.*})
+                }
+              }
+            }
+          )
+    end
+
+    context "when the version does not already exist" do
+      it "returns true" do
+        expect(subject).to be true
+      end
+    end
+
+    context "when the version does exist" do
+      let(:provider_state) { "version #{number} of pacticipant Foo does exist" }
+      let(:expected_response_status) { 200 }
+
+      it "returns true" do
+        expect(subject).to be true
+      end
+    end
+  end
+end

data/spec/service_providers/pact_broker_client_matrix_spec.rb

@@ -279,6 +279,10 @@ module PactBroker::Client
           expect(matrix[:matrix].size).to eq 1
         end
       end
+
+      context "with an environment name" do
+        it "passes the environment name in the options"
+      end
     end
   end
 end

data/spec/service_providers/pact_broker_client_versions_spec.rb

@@ -1,6 +1,5 @@
-require 'spec_helper'
-require 'pact_broker/client'
 require_relative 'pact_helper'
+require 'pact_broker/client'
 
 describe PactBroker::Client::Versions, pact: true do
 

data/tasks/pact.rake

@@ -5,6 +5,8 @@ PactBroker::Client::PublicationTask.new(:localhost) do | task |
   task.tag = `git rev-parse --abbrev-ref HEAD`.strip
   task.consumer_version = PactBroker::Client::VERSION
   task.pact_broker_base_url = "http://localhost:9292"
+  task.build_url = "http://ci"
+  # task.branch = "main"
 end
 
 PactBroker::Client::PublicationTask.new(:remote) do | task |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.35.0
+  version: 1.36.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-21 00:00:00.000000000 Z
+date: 2021-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -287,6 +287,7 @@ files:
 - spec/pacts/pact_broker_client-pact_broker.json
 - spec/service_providers/extra_goodies_spec.rb
 - spec/service_providers/list_latest_pact_versions_spec.rb.bak
+- spec/service_providers/pact_broker_client_create_version_spec.rb
 - spec/service_providers/pact_broker_client_matrix_spec.rb
 - spec/service_providers/pact_broker_client_pacticipant_version_spec.rb
 - spec/service_providers/pact_broker_client_publish_spec.rb
@@ -330,7 +331,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.6
+rubygems_version: 3.2.11
 signing_key: 
 specification_version: 4
 summary: See description
@@ -367,6 +368,7 @@ test_files:
 - spec/pacts/pact_broker_client-pact_broker.json
 - spec/service_providers/extra_goodies_spec.rb
 - spec/service_providers/list_latest_pact_versions_spec.rb.bak
+- spec/service_providers/pact_broker_client_create_version_spec.rb
 - spec/service_providers/pact_broker_client_matrix_spec.rb
 - spec/service_providers/pact_broker_client_pacticipant_version_spec.rb
 - spec/service_providers/pact_broker_client_publish_spec.rb