pact_broker 2.77.0 → 2.78.0

data/spec/features/delete_environment_spec.rb

@@ -0,0 +1,16 @@
+require 'pact_broker/api/pact_broker_urls'
+
+describe "Deleting an environment" do
+  before do
+    td.create_environment("test", uuid: "1234")
+  end
+
+  let(:path) { PactBroker::Api::PactBrokerUrls.environment_url(td.and_return(:environment)) }
+
+  subject { delete(path, nil) }
+
+  it "returns a 204 response" do
+    subject
+    expect(last_response.status).to be 204
+  end
+end

data/spec/features/end_deployment_spec.rb

@@ -0,0 +1,29 @@
+#
+# RPC style seems cleaner than REST here, as setting the endedAt parameter directly
+# seems likely to end in Timezone tears
+# This endpoint would be called by the pact broker client during `record-deployment` if the
+# --end-previous-deployment (on by default) was specified.
+# This allows us to know exactly what is deployed to a particular environment at a given time,
+# (eg. /environments/test/deployments/current)
+# and provides first class support for mobile clients that have multiple versions in prod
+# at once.
+
+describe "Record deployment ended", skip: "Not yet implemented" do
+  before do
+    td.create_environment("test")
+      .create_pacticipant("Foo")
+      .create_pacticipant_version("1")
+      .create_deployment("test")
+  end
+  let(:path) { "/pacticipants/Foo/deployments/test/latest/end" }
+  let(:headers) { {} }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true) }
+
+  subject { post(path, nil, headers) }
+
+  it { is_expected.be_a_hal_json_success_response }
+
+  it "returns the updated deployment" do
+    expect(subject[:endedAt]).to_not be nil
+  end
+end

data/spec/features/get_environment_spec.rb

@@ -0,0 +1,19 @@
+require 'pact_broker/api/pact_broker_urls'
+
+describe "Get an environment" do
+  before do
+    td.create_environment("test", display_name: "Test", uuid: "1234", contacts: [ { name: "Foo" } ] )
+  end
+  let(:path) { PactBroker::Api::PactBrokerUrls.environment_url(td.and_return(:environment)) }
+  let(:headers) { {'HTTP_ACCEPT' => 'application/hal+json'} }
+  let(:response_body) { JSON.parse(subject.body, symbolize_names: true)}
+
+  subject { get(path, nil, headers) }
+
+  it { is_expected.to be_a_hal_json_success_response }
+
+  it "returns the environment" do
+    expect(response_body[:uuid]).to eq "1234"
+    expect(response_body[:name]).to eq "test"
+  end
+end

data/spec/features/get_environments_spec.rb

@@ -0,0 +1,20 @@
+require 'pact_broker/api/pact_broker_urls'
+
+describe "Get all environments" do
+  before do
+    td.create_environment("test", display_name: "Test", uuid: "1234", contacts: [ { name: "Foo" } ] )
+      .create_environment("prod", display_name: "Production", uuid: "5678", contacts: [ { name: "Foo" } ] )
+  end
+  let(:path) { PactBroker::Api::PactBrokerUrls.environments_url }
+  let(:headers) { {'HTTP_ACCEPT' => 'application/hal+json'} }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
+
+  subject { get(path, nil, headers) }
+
+  it { is_expected.to be_a_hal_json_success_response }
+
+  it "returns the environments" do
+    subject
+    expect(response_body[:_embedded][:environments].size).to be 2
+  end
+end

data/spec/features/record_deployment_spec.rb

@@ -0,0 +1,28 @@
+#
+# pact-broker record-deployment --pacticipant Foo --version 1 --environment test --end-previous-deployment
+#
+
+describe "Record deployment", skip: "Not yet implemented" do
+  before do
+    td.create_environment("test")
+      .create_pacticipant("Foo")
+      .create_pacticipant_version("1")
+  end
+  let(:path) { "/pacticipants/Foo/versions/1/deployments/test" }
+  let(:headers) { {"CONTENT_TYPE" => "application/json"} }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
+
+  subject { post(path, nil, headers) }
+
+  it { is_expected.to be_a_hal_json_created_response }
+
+  it "returns the Location header" do
+    subject
+    expect(last_response.headers["Location"]).to eq "http://example.org/deployments/123456"
+  end
+
+  it "returns the newly created deployment" do
+    subject
+    expect(response_body).to include_key(:createdAt)
+  end
+end

data/spec/features/update_environment_spec.rb

@@ -0,0 +1,44 @@
+require 'pact_broker/api/pact_broker_urls'
+
+describe "Updating an environment" do
+  before do
+    td.create_environment("test", uuid: "1234", contacts: [ { name: "Foo" } ] )
+  end
+  let(:path) { PactBroker::Api::PactBrokerUrls.environment_url(td.and_return(:environment)) }
+  let(:headers) { {'CONTENT_TYPE' => 'application/json'} }
+  let(:response_body) { JSON.parse(last_response.body, symbolize_names: true)}
+  let(:environment_hash) do
+    {
+      name: "test",
+      production: false,
+      displayName: "Testing"
+    }
+  end
+
+  subject { put(path, environment_hash.to_json, headers) }
+
+  it { is_expected.to be_a_hal_json_success_response }
+
+  it "returns the updated environment" do
+    subject
+    expect(response_body[:displayName]).to eq "Testing"
+    expect(response_body[:contacts]).to be nil
+  end
+
+  context "when the environment doesn't exist" do
+    let(:path) { "/environments/5678" }
+
+    it "returns a 404" do
+      expect(subject.status).to eq 404
+    end
+  end
+
+  context "with invalid params" do
+    let(:environment_hash) { {} }
+
+    it "returns a 400 response" do
+      expect(subject.status).to be 400
+      expect(response_body[:errors]).to_not be nil
+    end
+  end
+end

data/spec/fixtures/approvals/modifiable_resources.approved.json

@@ -6,6 +6,12 @@
     {
       "resource_class_name": "PactBroker::Api::Resources::Clean"
     },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Environment"
+    },
+    {
+      "resource_class_name": "PactBroker::Api::Resources::Environments"
+    },
     {
       "resource_class_name": "PactBroker::Api::Resources::ErrorTest"
     },

data/spec/lib/pact_broker/api/contracts/environment_schema_spec.rb

@@ -0,0 +1,83 @@
+require 'pact_broker/api/contracts/environment_schema'
+
+module PactBroker
+  module Api
+    module Contracts
+      describe EnvironmentSchema do
+        before do
+          allow(PactBroker::Deployments::EnvironmentService).to receive(:find_by_name).and_return(existing_environment)
+        end
+        let(:existing_environment) { nil }
+        let(:name) { "test" }
+
+        let(:params) do
+          {
+            uuid: "1234",
+            name: name,
+            displayName: "Test",
+            production: false,
+            contacts: contacts
+          }
+        end
+
+        let(:contacts) do
+          [{
+            name: "Foo",
+            details: { email: "foo@bar.com" }
+          }]
+        end
+
+        subject { EnvironmentSchema.call(params) }
+
+        context "with valid params" do
+          it { is_expected.to be_empty }
+        end
+
+        context "with a name with a new line" do
+          let(:name) { "test 1" }
+
+          it { is_expected.to_not be_empty }
+        end
+
+        context "with empty params" do
+          let(:params) { {} }
+
+          it { is_expected.to_not be_empty }
+        end
+
+        context "when there is another environment with the same name but a different uuid" do
+          let(:existing_environment) { instance_double("PactBroker::Deployments::Environment", uuid: "5678")}
+
+          its([:name]) { is_expected.to eq ["Another environment with name 'test' already exists."] }
+        end
+
+        context "when there is another environment with the same name and same uuid" do
+          let(:existing_environment) { instance_double("PactBroker::Deployments::Environment", uuid: "1234")}
+
+          it { is_expected.to be_empty }
+        end
+
+        context "with no owner name" do
+          let(:contacts) do
+            [{
+              details: { email: "foo@bar.com" }
+            }]
+          end
+
+          its([:contacts, 0]) { is_expected.to eq "name is missing at index 0" }
+        end
+
+        context "with string contact details" do
+          let(:contacts) do
+            [{
+              name: "foo",
+              details: "foo"
+            }]
+          end
+
+          its([:contacts, 0]) { is_expected.to eq "details must be a hash at index 0" }
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/api/decorators/version_decorator_spec.rb

@@ -6,6 +6,24 @@ module PactBroker
     module Decorators
       describe VersionDecorator do
 
+        describe "from_json" do
+          let(:hash) do
+            {
+              branch: "branch",
+              buildUrl: "buildUrl",
+              tags: [{ name: "main" }]
+            }
+          end
+
+          subject { VersionDecorator.new(OpenStruct.new).from_json(hash.to_json) }
+
+          it "sets the properties" do
+            expect(subject.branch).to eq "branch"
+            expect(subject.build_url).to eq "buildUrl"
+            expect(subject.tags.first.name).to eq "main"
+          end
+        end
+
         let(:version) do
           TestDataBuilder.new
             .create_consumer("Consumer")

data/spec/lib/pact_broker/api/resources/default_base_resource_approval_spec.rb

@@ -45,7 +45,7 @@ module PactBroker
               if resource.respond_to?(:policy_pacticipant)
                 resource_class_data[:resource_class_data] = resource.policy_pacticipant
               end
-                resource_class_data
+              resource_class_data
             else
               nil
             end

data/spec/lib/pact_broker/api/resources/webhook_execution_result_spec.rb

@@ -0,0 +1,56 @@
+module PactBroker
+  module Webhooks
+    describe WebhookExecutionResult do
+      subject { WebhookExecutionResult::new(request, response, nil) }
+      let(:request) do
+        Net::HTTP::Get.new("http://example.org?foo=bar")
+      end
+
+      context "When 'webhook_http_code_success' has [200, 201]" do
+        before do
+          allow(PactBroker.configuration).to receive(:webhook_http_code_success).and_return([200, 201])
+        end
+
+        context "and response is '200'" do
+          let(:response) { double(code: '200') }
+
+          it "then it should be success" do
+            expect(subject.success?).to be_truthy
+          end
+        end
+
+        context "and response is '400'" do
+          let(:response) { double(code: '400') }
+
+          it "then it should fail" do
+            expect(subject.success?).to be_falsey
+          end
+        end
+      end
+
+
+      context "When 'webhook_http_code_success' has [400, 401]" do
+        before do
+          allow(PactBroker.configuration).to receive(:webhook_http_code_success).and_return([400, 401])
+        end
+
+        context "and response is '200'" do
+          let(:response) { double(code: '200') }
+
+          it "then it should fail" do
+            expect(subject.success?).to be_falsey
+          end
+        end
+
+        context "and response is '400'" do
+          let(:response) { double(code: '400') }
+
+          it "then it should be success" do
+            expect(subject.success?).to be_truthy
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/lib/pact_broker/versions/repository_spec.rb

@@ -123,7 +123,7 @@ module PactBroker
         end
       end
 
-      describe "#create_or_update" do
+      describe "#create_or_overwrite" do
         before do
           td.subtract_day
             .create_consumer("Foo")
@@ -133,9 +133,10 @@ module PactBroker
 
         let(:pacticipant) { td.and_return(:consumer) }
         let(:version_number) { "1234" }
-        let(:version) { PactBroker::Domain::Version.new(branch: "new-branch") }
+        let(:tags) { nil }
+        let(:open_struct_version) { OpenStruct.new(branch: "new-branch", tags: tags) }
 
-        subject { Repository.new.create_or_update(pacticipant, version_number, version) }
+        subject { Repository.new.create_or_overwrite(pacticipant, version_number, open_struct_version) }
 
         it "overwrites the values" do
           expect(subject.branch).to eq "new-branch"
@@ -146,6 +147,15 @@ module PactBroker
           expect { subject }.to_not change { PactBroker::Domain::Version.for("Foo", "1234").tags }
         end
 
+        context "when there are tags specified" do
+          let(:tags) { [ OpenStruct.new(name: "main")] }
+
+          it "overwrites the tags" do
+            expect(subject.tags.count).to eq 1
+            expect(subject.tags.first.name).to eq "main"
+          end
+        end
+
         it "does not change the created date" do
           expect { subject }.to_not change { PactBroker::Domain::Version.for("Foo", "1234").created_at }
         end
@@ -159,7 +169,7 @@ module PactBroker
         end
 
         context "when the version does not already exist" do
-          let(:version) { PactBroker::Domain::Version.new(number: "555", branch: "new-branch") }
+          let(:version) { OpenStruct.new(number: "555", branch: "new-branch") }
 
           it "sets the order" do
             expect(subject.order).to_not be nil

data/spec/service_consumers/hal_relation_proxy_app.rb

@@ -9,7 +9,9 @@ class HalRelationProxyApp
     '/HAL-REL-PLACEHOLDER-INDEX-PB-LATEST-VERSION-Condor' =>
       '/pacticipants/Condor/latest-version',
     '/HAL-REL-PLACEHOLDER-PB-WEBHOOKS' =>
-      '/webhooks'
+      '/webhooks',
+    '/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb' =>
+      '/pacticipants/Foo/versions/26f353580936ad3b9baddb17b00e84f33c69e7cb'
   }
 
   RESPONSE_BODY_REPLACEMENTS = {

data/spec/service_consumers/provider_states_for_pact_broker_client.rb

@@ -255,4 +255,20 @@ Pact.provider_states_for "Pact Broker Client" do
         .create_consumer("Foo")
     end
   end
+
+  provider_state "the pb:pacticipant-version relation exists in the index resource" do
+    no_op
+  end
+
+  provider_state "version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does not exist" do
+    no_op
+  end
+
+  provider_state "version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does exist" do
+    set_up do
+      TestDataBuilder.new
+        .create_consumer("Foo")
+        .create_consumer_version("26f353580936ad3b9baddb17b00e84f33c69e7cb")
+    end
+  end
 end

data/spec/support/shared_examples_for_responses.rb

@@ -22,6 +22,17 @@ RSpec::Matchers.define :be_a_hal_json_success_response do
   end
 end
 
+RSpec::Matchers.define :be_a_hal_json_created_response do
+  match do | actual |
+    expect(actual.status).to be 201
+    expect(actual.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
+  end
+
+  failure_message do
+    "Expected creation successful json response, got #{actual.status} #{actual.headers['Content-Type']} with body #{actual.body}"
+  end
+end
+
 RSpec::Matchers.define :be_a_json_response do
   match do | actual |
     expect(actual.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'