pact_broker-client 0.0.1

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

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'fakefs/safe'
+require 'pact_broker/client/publish_pacts'
+require 'json'
+
+module PactBroker
+  module Client
+    describe PublishPacts do
+
+      before do
+        FakeFS.activate!
+        pacts_client.stub(:publish)
+        PactBroker::Client::PactBrokerClient.stub(:new).with(base_url: pact_broker_base_url).and_return(pact_broker_client)
+      end
+
+      after do
+        FakeFS.deactivate!
+      end
+
+      let(:pact_broker_client) { double("PactBroker::Client")}
+      let(:pact_files) { ['spec/pacts/consumer-provider.json']}
+      let(:consumer_version) { "1.2.3" }
+      let(:pact_hash) { {consumer: {name: 'Consumer'}, provider: {name: 'Provider'} } }
+      let(:pacts_client) { instance_double("PactBroker::ClientSupport::Pacts")}
+      let(:pact_broker_base_url) { 'http://some-host'}
+
+      subject { PublishPacts.new(pact_broker_base_url, pact_files, consumer_version) }
+
+      before do
+        FileUtils.mkdir_p "spec/pacts"
+        File.open("spec/pacts/consumer-provider.json", "w") { |file| file << pact_hash.to_json }
+        pact_broker_client.stub_chain(:pacticipants, :versions, :pacts).and_return(pacts_client)
+      end
+
+      describe "call" do
+
+        it "uses the pact_broker client to publish the given pact" do
+          pacts_client.should_receive(:publish).with(pact_json: pact_hash.to_json, consumer_version: consumer_version)
+          subject.call
+        end
+
+        context "when publishing is successful" do
+          it "returns true" do
+            expect(subject.call).to be_true
+          end
+        end
+
+        context "when publishing one or more pacts fails" do
+          let(:pact_files) { ['spec/pacts/doesnotexist.json','spec/pacts/consumer-provider.json']}
+          before do
+            $stderr.stub(:puts)
+          end
+
+          it "logs an message to stderr" do
+            $stderr.should_receive(:puts).with(/Failed to publish pact/)
+            subject.call
+          end
+
+          it "continues publishing the rest" do
+            pacts_client.should_receive(:publish).with(pact_json: pact_hash.to_json, consumer_version: consumer_version)
+            subject.call
+          end
+
+          it "returns false" do
+            expect(subject.call).to be_false
+          end
+        end
+
+        context "when no pact files are specified" do
+          let(:pact_files) { [] }
+          it "raises a validation error" do
+            expect { subject.call }.to raise_error(/No pact files found/)
+          end
+        end
+
+        context "when consumer_version is blank" do
+          let(:consumer_version) { " " }
+          it "raises a validation error" do
+            expect { subject.call }.to raise_error(/Please specify the consumer_version/)
+          end
+        end
+
+        context "when pact_broker_base_url is blank" do
+          let(:pact_broker_base_url) { " " }
+          it "raises a validation errror" do
+            expect { subject.call }.to raise_error(/Please specify the pact_broker_base_url/)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'pact_broker/client/tasks/publication_task'
+require 'pact_broker/client/publish_pacts'
+
+module PactBroker::Client
+
+  describe PublicationTask do
+
+    before do
+      @consumer_version = "1.2.3"
+    end
+
+    let(:publish_pacts) { instance_double("PactBroker::ClientSupport::PublishPacts")}
+    let(:pact_file_list) { ['spec/pact/consumer-provider.json'] }
+
+    before do
+      PactBroker::Client::PublishPacts.stub(:new).and_return(publish_pacts)
+      FileList.should_receive(:[]).with(pattern).and_return(pact_file_list)
+    end
+
+    let(:pattern) { "spec/pacts/*.json" }
+
+    describe "default task" do
+
+      before :all do
+        PactBroker::Client::PublicationTask.new do | task |
+          task.consumer_version = '1.2.3'
+        end
+      end
+
+      context "when pacts are succesfully published" do
+        it "invokes PublishPacts with the default values" do
+          PactBroker::Client::PublishPacts.should_receive(:new).with('http://pact-broker', pact_file_list, '1.2.3').and_return(publish_pacts)
+          publish_pacts.should_receive(:call).and_return(true)
+          Rake::Task['pact:publish'].execute
+        end
+      end
+
+      context "when a pact fails to be published" do
+        it "raises an error" do
+          publish_pacts.should_receive(:call).and_return(false)
+          expect { Rake::Task['pact:publish'].execute }.to raise_error("One or more pacts failed to be published")
+        end
+      end
+    end
+
+
+    describe "custom task" do
+
+      before :all do
+        @pact_broker_base_url = "http://some-host"
+        @pattern = "pact/*.json"
+        PactBroker::Client::PublicationTask.new(:custom) do | task |
+          task.consumer_version = '1.2.3'
+          task.pact_broker_base_url = @pact_broker_base_url
+          task.pattern = @pattern
+        end
+      end
+
+      let(:pattern) { @pattern }
+
+      it "invokes PublishPacts with the customised values" do
+        PactBroker::Client::PublishPacts.should_receive(:new).with(@pact_broker_base_url, pact_file_list, '1.2.3')
+        publish_pacts.should_receive(:call).and_return(true)
+        Rake::Task['pact:publish:custom'].execute
+      end
+    end
+
+
+  end
+
+end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -0,0 +1,365 @@
+{
+  "provider": {
+    "name": "Pact Broker"
+  },
+  "consumer": {
+    "name": "Pact Broker Client"
+  },
+  "interactions": [
+    {
+      "description": "a request to publish a pact",
+      "provider_state": "the 'Pricing Service' already exists in the pact-broker",
+      "request": {
+        "method": "put",
+        "path": "/pacticipant/Condor/versions/1.3.0/pacts/Pricing%20Service",
+        "body": {
+          "consumer": {
+            "name": "Condor"
+          },
+          "provider": {
+            "name": "Pricing Service"
+          },
+          "interactions": [
+
+          ]
+        },
+        "headers": {
+          "Content-Type": "application/json"
+        }
+      },
+      "response": {
+        "headers": {
+        },
+        "status": 201
+      }
+    },
+    {
+      "description": "a request to publish a pact",
+      "provider_state": "the 'Pricing Service' and 'Condor' already exist in the pact-broker, and Condor already has a pact published for version 1.3.0",
+      "request": {
+        "method": "put",
+        "path": "/pacticipant/Condor/versions/1.3.0/pacts/Pricing%20Service",
+        "body": {
+          "consumer": {
+            "name": "Condor"
+          },
+          "provider": {
+            "name": "Pricing Service"
+          },
+          "interactions": [
+
+          ]
+        },
+        "headers": {
+          "Content-Type": "application/json"
+        }
+      },
+      "response": {
+        "headers": {
+        },
+        "status": 200
+      }
+    },
+    {
+      "description": "a request to publish a pact",
+      "provider_state": "'Condor' already exist in the pact-broker, but the 'Pricing Service' does not",
+      "request": {
+        "method": "put",
+        "path": "/pacticipant/Condor/versions/1.3.0/pacts/Pricing%20Service",
+        "body": {
+          "consumer": {
+            "name": "Condor"
+          },
+          "provider": {
+            "name": "Pricing Service"
+          },
+          "interactions": [
+
+          ]
+        },
+        "headers": {
+          "Content-Type": "application/json"
+        }
+      },
+      "response": {
+        "headers": {
+        },
+        "status": 201
+      }
+    },
+    {
+      "description": "a request to publish a pact",
+      "provider_state": "an error occurs while publishing a pact",
+      "request": {
+        "method": "put",
+        "path": "/pacticipant/Condor/versions/1.3.0/pacts/Pricing%20Service",
+        "body": {
+          "consumer": {
+            "name": "Condor"
+          },
+          "provider": {
+            "name": "Pricing Service"
+          },
+          "interactions": [
+
+          ]
+        },
+        "headers": {
+          "Content-Type": "application/json"
+        }
+      },
+      "response": {
+        "status": 500,
+        "headers": {
+        },
+        "body": {
+          "message": {
+            "json_class": "Pact::Term",
+            "data": {
+              "generate": "An error occurred",
+              "matcher": {"json_class":"Regexp","o":0,"s":".*"}
+            }
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to register the repository URL of a pacticipant",
+      "provider_state": "the 'Pricing Service' does not exist in the pact-broker",
+      "request": {
+        "method": "patch",
+        "path": "/pacticipant/Pricing%20Service",
+        "body": {
+          "repository_url": "git@git.realestate.com.au:business-systems/condor.git"
+        },
+        "headers": {
+          "Content-Type": "application/json+patch"
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+        }
+      }
+    },
+    {
+      "description": "a request to register the repository URL of a pacticipant",
+      "provider_state": "the 'Pricing Service' already exists in the pact-broker",
+      "request": {
+        "method": "patch",
+        "path": "/pacticipant/Pricing%20Service",
+        "body": {
+          "repository_url": "git@git.realestate.com.au:business-systems/condor.git"
+        },
+        "headers": {
+          "Content-Type": "application/json+patch"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+        }
+      }
+    },
+    {
+      "description": "a request to retrieve the repository URL of the 'Pricing Service'",
+      "provider_state": "the 'Pricing Service' does not exist in the pact-broker",
+      "request": {
+        "method": "get",
+        "path": "/pacticipant/Pricing%20Service/repository_url",
+        "headers": {
+          "Accept": "text/plain"
+        }
+      },
+      "response": {
+        "status": 404,
+        "headers": {
+        }
+      }
+    },
+    {
+      "description": "a request to retrieve the repository URL of the 'Pricing Service'",
+      "provider_state": "the 'Pricing Service' already exists in the pact-broker",
+      "request": {
+        "method": "get",
+        "path": "/pacticipant/Pricing%20Service/repository_url",
+        "headers": {
+          "Accept": "text/plain"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "text/plain;charset=utf-8"
+        },
+        "body": "git@git.realestate.com.au:business-systems/condor.git"
+      }
+    },
+    {
+      "description": "a request to tag the production version of Condor",
+      "provider_state": "'Condor' exists in the pact-broker",
+      "request": {
+        "method": "patch",
+        "path": "/pacticipant/Condor/versions/1.3.0",
+        "body": {
+          "tags": [
+            "prod"
+          ],
+          "repository_ref": "packages/condor-1.3.0",
+          "repository_url": "git@git.realestate.com.au:business-systems/condor.git"
+        },
+        "headers": {
+          "Content-Type": "application/json+patch"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+        }
+      }
+    },
+    {
+      "description": "a request to tag the production version of Condor",
+      "provider_state": "'Condor' does not exist in the pact-broker",
+      "request": {
+        "method": "patch",
+        "path": "/pacticipant/Condor/versions/1.3.0",
+        "body": {
+          "tags": [
+            "prod"
+          ],
+          "repository_ref": "packages/condor-1.3.0",
+          "repository_url": "git@git.realestate.com.au:business-systems/condor.git"
+        },
+        "headers": {
+          "Content-Type": "application/json+patch"
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+        }
+      }
+    },
+    {
+      "description": "a request to retrieve the latest pact between Condor and the Pricing Service",
+      "provider_state": "a pact between Condor and the Pricing Service exists",
+      "request": {
+        "method": "get",
+        "path": "/pacticipant/Condor/versions/last/pacts/Pricing%20Service",
+        "headers": {
+          "Accept": "application/json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/json;charset=utf-8",
+          "X-Pact-Consumer-Version": "1.3.0"
+        },
+        "body": {
+          "consumer": {
+            "name": "Condor"
+          },
+          "provider": {
+            "name": "Pricing Service"
+          },
+          "interactions": [
+
+          ]
+        }
+      }
+    },
+    {
+      "description": "a request to retrieve the latest pact between Condor and the Pricing Service",
+      "provider_state": "no pact between Condor and the Pricing Service exists",
+      "request": {
+        "method": "get",
+        "path": "/pacticipant/Condor/versions/last/pacts/Pricing%20Service",
+        "headers": {
+          "Accept": "application/json"
+        }
+      },
+      "response": {
+        "status": 404,
+        "headers": {
+        }
+      }
+    },
+    {
+      "description": "a request to retrieve the pact between the production verison of Condor and the Pricing Service",
+      "provider_state": "a pact between Condor and the Pricing Service exists for the production version of Condor",
+      "request": {
+        "method": "get",
+        "path": "/pacticipant/Condor/versions/last/pacts/Pricing%20Service",
+        "headers": {
+          "Accept": "application/json"
+        },
+        "query": "tag=prod"
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+        },
+        "body": {
+          "consumer": {
+            "name": "Condor"
+          },
+          "provider": {
+            "name": "Pricing Service"
+          },
+          "interactions": [
+
+          ]
+        }
+      }
+    },
+    {
+      "description": "a request for the latest version tagged with 'prod'",
+      "provider_state": "a version with production details exists for the Pricing Service",
+      "request": {
+        "method": "get",
+        "path": "/pacticipant/Pricing%20Service/versions/last",
+        "headers": {
+          "Accept": "application/json"
+        },
+        "query": "tag=prod"
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/json;charset=utf-8"
+        },
+        "body": {
+          "number": "1.2.3",
+          "repository_url": "git@git.realestate.com.au:business-systems/pricing-service.git",
+          "repository_ref": "package/pricing-service-1.2.3",
+          "tags": [
+            "prod"
+          ]
+        }
+      }
+    },
+    {
+      "description": "a request for the latest version",
+      "provider_state": "no version exists for the Pricing Service",
+      "request": {
+        "method": "get",
+        "path": "/pacticipant/Pricing%20Service/versions/last",
+        "headers": {
+          "Accept": "application/json"
+        }
+      },
+      "response": {
+        "status": 404,
+        "headers": {
+        }
+      }
+    }
+  ],
+  "metadata": {
+    "pact_gem": {
+      "version": "1.0.15"
+    }
+  }
+}