pact_broker-client 1.34.0 → 1.38.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/lib/pact_broker/client/versions/describe_spec.rb

@@ -5,7 +5,6 @@ module PactBroker
     class Versions
       describe Describe do
         describe ".call" do
-
           let(:versions_client) do
             instance_double('PactBroker::Client::Versions', latest: version_hash)
           end

data/spec/lib/pact_broker/client/versions/record_deployment_spec.rb

@@ -0,0 +1,82 @@
+require 'pact_broker/client/versions/record_deployment'
+
+module PactBroker
+  module Client
+    class Versions
+      describe RecordDeployment do
+        describe ".call" do
+          let(:broker_base_url) { "http://broker" }
+          let(:index_body_hash) do
+            {
+              _links: {}
+            }
+          end
+          let!(:index_request) do
+            stub_request(:get, broker_base_url).to_return(status: 200, body: index_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+          end
+
+          let(:replaced_previous_deployed_version) { true }
+
+          let(:params) do
+            {
+              pacticipant_name: "Foo",
+              version_number: "1",
+              environment_name: "test",
+              replaced_previous_deployed_version: replaced_previous_deployed_version,
+              output: "text"
+            }
+          end
+
+          let(:pact_broker_client_options) { {} }
+
+          subject { RecordDeployment.call(params, broker_base_url, pact_broker_client_options) }
+
+          context "when the pb:environments relation does not exist" do
+            it "returns an error response" do
+              expect(subject.success).to be false
+              expect(subject.message).to include "does not support"
+            end
+          end
+
+          context "when the response headers contain Pactflow" do
+            before do
+              allow_any_instance_of(RecordDeployment).to receive(:check_if_command_supported)
+              allow_any_instance_of(RecordDeployment).to receive(:check_environment_exists)
+              allow_any_instance_of(RecordDeployment).to receive(:record_deployment)
+              allow_any_instance_of(RecordDeployment).to receive(:deployed_version_resource).and_return(deployed_version_resource)
+            end
+
+            let(:response_headers) { { "X-Pactflow-Sha" => "abc" } }
+
+            let(:deployed_version_resource) do
+              double('PactBroker::Client::Hal::Entity', response: double('response', headers: response_headers) )
+            end
+
+            it "indicates the API was Pactflow" do
+              expect(subject.message).to include "Recorded deployment of Foo version 1 to test in Pactflow"
+            end
+          end
+
+          context "when replaced_previous_deployed_version is false" do
+            before do
+              allow_any_instance_of(RecordDeployment).to receive(:check_if_command_supported)
+              allow_any_instance_of(RecordDeployment).to receive(:check_environment_exists)
+              allow_any_instance_of(RecordDeployment).to receive(:record_deployment)
+              allow_any_instance_of(RecordDeployment).to receive(:pact_broker_name).and_return("")
+            end
+
+            let(:replaced_previous_deployed_version) { false }
+
+            let(:deployed_version_resource) do
+              double('PactBroker::Client::Hal::Entity', response: double('response', headers: response_headers) )
+            end
+
+            it "does not include the message about marking the previous version as undeployed" do
+              expect(subject.message).to_not include "undeployed"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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",
@@ -221,7 +327,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -271,7 +382,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -321,7 +437,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -418,7 +539,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -439,7 +565,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -492,7 +623,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -542,7 +678,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -592,7 +733,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -1404,6 +1550,187 @@
         }
       }
     },
+    {
+      "description": "a request for the index resource",
+      "providerState": "the pb:pacticipant-version and pb:environments relations exist in the index resource",
+      "request": {
+        "method": "GET",
+        "path": "/",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pb:pacticipant-version": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
+            },
+            "pb:environments": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:pacticipant-version.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*{pacticipant}.*{version}"
+          },
+          "$.body._links.pb:environments.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request for a pacticipant version",
+      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment",
+      "request": {
+        "method": "GET",
+        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pb:record-deployment": [
+              {
+                "name": "test",
+                "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST"
+              }
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:record-deployment[0].href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to record a deployment",
+      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment",
+      "request": {
+        "method": "POST",
+        "path": "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "replacedPreviousDeployedVersion": true
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "replacedPreviousDeployedVersion": true
+        }
+      }
+    },
+    {
+      "description": "a request for a pacticipant version",
+      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist",
+      "request": {
+        "method": "GET",
+        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 404,
+        "headers": {
+        }
+      }
+    },
+    {
+      "description": "a request for a pacticipant version",
+      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with 2 environments that aren't test available for deployment",
+      "request": {
+        "method": "GET",
+        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pb:record-deployment": [
+              {
+                "name": "prod",
+                "href": "href"
+              },
+              {
+                "name": "dev",
+                "href": "href"
+              }
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:record-deployment[0]": {
+            "match": "type"
+          },
+          "$.body._links.pb:record-deployment[1]": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request for the environments",
+      "providerState": "an environment with name test exists",
+      "request": {
+        "method": "GET",
+        "path": "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pb:environments": [
+              {
+                "name": "test",
+                "href": "href"
+              }
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:environments[0].href": {
+            "match": "type"
+          }
+        }
+      }
+    },
     {
       "description": "a request 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",