pact_broker-client 1.41.0 → 1.42.0

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

@@ -0,0 +1,39 @@
+require 'pact_broker/client/generate_display_name'
+
+module PactBroker
+  module Client
+    describe GenerateDisplayName do
+      describe ".call" do
+        TEST_CASES = {
+          "foo" => "Foo",
+          "MyService" => "My Service",
+          "my-service" => "My Service",
+          "my_service" => "My Service",
+          "my service" => "My Service",
+          "ABCService" => "ABC Service",
+          "A4Service" => "A4 Service",
+          "SNSPactEventConsumer" => "SNS Pact Event Consumer",
+          "AWSSummiteerWeb" => "AWS Summiteer Web",
+          "Beer-Consumer" => "Beer Consumer",
+          "foo.pretend-consumer" => "Foo Pretend Consumer",
+          "Client-XX" => "Client XX",
+          "providerJSWorkshop" => "Provider JS Workshop",
+          "e2e Provider Example" => "E2e Provider Example",
+          "MP - Our Provider" => "MP - Our Provider",
+          "PoC - Pact-broker-consumer" => "PoC - Pact Broker Consumer",
+          "QB-DATABASE Service" => "QB DATABASE Service",
+          "Support Species App (Provider)" => "Support Species App (Provider)",
+          9 => "9",
+          "" => "",
+          nil => nil
+        }
+
+        TEST_CASES.each do | name, expected_display_name |
+          it "converts #{name.inspect} to #{expected_display_name.inspect}" do
+            expect(GenerateDisplayName.call(name)).to eq expected_display_name
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -73,7 +73,7 @@ module PactBroker::Client
           subject(:entity) { ErrorEntity.new("http://pact", pact_hash, http_client) }
 
           it "raises an error" do
-            expect { entity.assert_success! }.to raise_error ErrorResponseReturned, "Error retrieving http://pact status="
+            expect { entity.assert_success! }.to raise_error ErrorResponseReturned, "Error making request to http://pact status="
           end
         end
 
@@ -83,7 +83,7 @@ module PactBroker::Client
           subject(:entity) { ErrorEntity.new("http://pact", pact_hash, http_client, response) }
 
           it "raises an error" do
-            expect { entity.assert_success! }.to raise_error ErrorResponseReturned, "Error retrieving http://pact status=200 body"
+            expect { entity.assert_success! }.to raise_error ErrorResponseReturned, "Error making request to http://pact status=200 body"
           end
         end
       end

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

@@ -8,11 +8,11 @@ module PactBroker
           before do
             allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:sleep)
           end
-          let(:pact_broker_client_options) { {} }
+          let(:pact_broker_client_options) { { pact_broker_base_url: broker_base_url} }
           let(:broker_base_url) { "http://url" }
           let(:params) { { name: 'Foo' } }
 
-          subject { Create.call(params, broker_base_url, pact_broker_client_options)}
+          subject { Create.call(params, {}, pact_broker_client_options)}
 
           context "when there is an http error" do
             let!(:index_request) do

data/spec/service_providers/create_environment_spec.rb

@@ -0,0 +1,78 @@
+require 'service_providers/pact_helper'
+require 'pact_broker/client/environments/create_environment'
+
+RSpec.describe "create an environment", pact: true, skip: true do
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:params) do
+    {
+      name: "test",
+      display_name: "Test",
+      production: false,
+      contact_name: "Foo team",
+      contact_email_address: "foo@bar.com"
+
+    }
+  end
+  let(:pact_broker_client_options) { {} }
+  let(:request_body) do
+    {
+      name: "test",
+      displayName: "Test",
+      production: false,
+      contacts: [{
+        name: "Foo team",
+        details: {
+          emailAddress: "foo@bar.com"
+        }
+      }]
+    }
+  end
+
+  subject { PactBroker::Client::Environments::CreateEnvironment.call(params, broker_base_url, pact_broker_client_options) }
+
+  def mock_index
+    pact_broker
+      .given("the pb:environments 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:environments' => {
+              href: placeholder_url_term("pb:environments")
+            }
+          }
+        }
+      )
+  end
+
+  def mock_environment_creation_request
+    pact_broker
+      .upon_receiving("a request to create an environment")
+      .with(
+        method: "POST",
+        path: "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
+        headers: post_request_headers,
+        body: request_body
+      )
+      .will_respond_with(
+        status: 201,
+        headers: pact_broker_response_headers,
+        body: request_body.merge("uuid" => Pact.like("ffe683ef-dcd7-4e4f-877d-f6eb3db8e86e"))
+      )
+  end
+
+  it "returns a success result" do
+    mock_index
+    mock_environment_creation_request
+    expect(subject.success).to be true
+    expect(subject.message).to include "Created test environment in the Pact Broker with UUID ffe683ef-dcd7-4e4f-877d-f6eb3db8e86e"
+  end
+end

data/spec/service_providers/list_environments_spec.rb

@@ -0,0 +1,77 @@
+require 'service_providers/pact_helper'
+require 'pact_broker/client/environments/list_environments'
+
+RSpec.describe "list environments", pact: true, skip: true do
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:params) { { output: output } }
+  let(:output) { "text" }
+  let(:pact_broker_client_options) { {} }
+  let(:response_body) do
+    {
+      _embedded: {
+        environments: Pact.each_like(
+          {
+            uuid: "78e85fb2-9df1-48da-817e-c9bea6294e01",
+            name: "test",
+            displayName: "Test",
+            production: false,
+            contacts: [{
+              name: "Foo team",
+              details: {
+                emailAddress: "foo@bar.com"
+              }
+            }]
+          }
+        )
+      }
+    }
+  end
+
+  subject { PactBroker::Client::Environments::ListEnvironments.call(params, broker_base_url, pact_broker_client_options) }
+
+  def mock_index
+    pact_broker
+      .given("the pb:environments 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:environments' => {
+              href: placeholder_url_term("pb:environments")
+            }
+          }
+        }
+      )
+  end
+
+  def mock_get_environments
+    pact_broker
+      .given("an environment exists")
+      .upon_receiving("a request to list the environments")
+      .with(
+        method: "GET",
+        path: "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
+        headers: get_request_headers
+      )
+      .will_respond_with(
+        status: 200,
+        headers: pact_broker_response_headers,
+        body: response_body
+      )
+  end
+
+  it "returns a success result" do
+    mock_index
+    mock_get_environments
+    expect(subject.success).to be true
+    Approvals.verify(subject.message, :name => "list_environments", format: :txt)
+  end
+end

data/spec/service_providers/pacticipants_create_spec.rb

@@ -54,9 +54,10 @@ RSpec.describe "creating or updating a pacticipant", pact: true do
     }
   end
 
-  let(:pact_broker_client_options) { {} }
+  let(:pact_broker_client_options) { { pact_broker_base_url: broker_base_url} }
+  let(:options) { {} }
 
-  subject { PactBroker::Client::Pacticipants2::Create.call(params, broker_base_url, pact_broker_client_options) }
+  subject { PactBroker::Client::Pacticipants2::Create.call(params, options, pact_broker_client_options) }
 
   context "when the pacticipant does not already exist" do
     before do
@@ -81,7 +82,7 @@ RSpec.describe "creating or updating a pacticipant", pact: true do
     it "returns a CommandResult with success = true" do
       expect(subject).to be_a PactBroker::Client::CommandResult
       expect(subject.success).to be true
-      expect(subject.message).to eq "Pacticipant \"Foo\" created"
+      expect(subject.message).to include "Pacticipant \"Foo\" created"
     end
   end
 
@@ -112,7 +113,7 @@ RSpec.describe "creating or updating a pacticipant", pact: true do
     it "returns a CommandResult with success = true" do
       expect(subject).to be_a PactBroker::Client::CommandResult
       expect(subject.success).to be true
-      expect(subject.message).to eq "Pacticipant \"Foo\" updated"
+      expect(subject.message).to include "Pacticipant \"Foo\" updated"
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'webmock/rspec'
+require 'rspec/its'
 
 ENV['PACT_BROKER_FEATURES'] = 'deployments publish_contracts ignore'
 

data/spec/support/approvals.rb

@@ -9,7 +9,7 @@ def print_diff(exception)
   parts = exception.message.split('"')
   received_file = parts[1]
   approved_file = parts[3]
-  if File.exist?(received_file) && File.exist?(approved_file)
+  if File.exist?(received_file) && File.exist?(approved_file) && received_file.end_with?(".json") && approved_file.end_with?(".json")
     received_hash = JSON.parse(File.read(received_file))
     approved_hash = JSON.parse(File.read(approved_file))
     diff = Pact::Matchers.diff(approved_hash, received_hash)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.41.0
+  version: 1.42.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -190,6 +190,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: Client for the Pact Broker. Publish, retrieve and query pacts and verification
   results.
 email:
@@ -226,18 +240,30 @@ files:
 - lib/pact_broker/client.rb
 - lib/pact_broker/client/backports.rb
 - lib/pact_broker/client/base_client.rb
+- lib/pact_broker/client/base_command.rb
 - lib/pact_broker/client/can_i_deploy.rb
 - lib/pact_broker/client/cli/broker.rb
 - lib/pact_broker/client/cli/can_i_deploy_long_desc.txt
 - lib/pact_broker/client/cli/create_or_update_webhook_long_desc.txt
 - lib/pact_broker/client/cli/create_webhook_long_desc.txt
 - lib/pact_broker/client/cli/custom_thor.rb
+- lib/pact_broker/client/cli/environment_commands.rb
+- lib/pact_broker/client/cli/pacticipant_commands.rb
 - lib/pact_broker/client/cli/record_deployment_long_desc.txt
 - lib/pact_broker/client/cli/version_selector_options_parser.rb
 - lib/pact_broker/client/colorize_notices.rb
 - lib/pact_broker/client/command_result.rb
 - lib/pact_broker/client/create_tag.rb
+- lib/pact_broker/client/environments.rb
+- lib/pact_broker/client/environments/create_environment.rb
+- lib/pact_broker/client/environments/delete_environment.rb
+- lib/pact_broker/client/environments/describe_environment.rb
+- lib/pact_broker/client/environments/environment_command.rb
+- lib/pact_broker/client/environments/list_environments.rb
+- lib/pact_broker/client/environments/text_formatter.rb
+- lib/pact_broker/client/environments/update_environment.rb
 - lib/pact_broker/client/error.rb
+- lib/pact_broker/client/generate_display_name.rb
 - lib/pact_broker/client/git.rb
 - lib/pact_broker/client/hal.rb
 - lib/pact_broker/client/hal/authorization_header_redactor.rb
@@ -260,11 +286,14 @@ files:
 - lib/pact_broker/client/pact_hash.rb
 - lib/pact_broker/client/pacticipants.rb
 - lib/pact_broker/client/pacticipants/create.rb
+- lib/pact_broker/client/pacticipants/list.rb
+- lib/pact_broker/client/pacticipants/text_formatter.rb
 - lib/pact_broker/client/pacts.rb
 - lib/pact_broker/client/pacts/list_latest_versions.rb
 - lib/pact_broker/client/publish_pacts.rb
 - lib/pact_broker/client/publish_pacts_the_old_way.rb
 - lib/pact_broker/client/retry.rb
+- lib/pact_broker/client/string_refinements.rb
 - lib/pact_broker/client/tasks.rb
 - lib/pact_broker/client/tasks/publication_task.rb
 - lib/pact_broker/client/version.rb
@@ -288,6 +317,8 @@ files:
 - script/release.sh
 - script/trigger-release.sh
 - spec/fixtures/approvals/can_i_deploy_ignore.approved.txt
+- spec/fixtures/approvals/describe_environment.approved.txt
+- spec/fixtures/approvals/list_environments.approved.txt
 - spec/fixtures/foo-bar.json
 - spec/integration/can_i_deploy_spec.rb
 - spec/integration/create_version_tag_spec.rb
@@ -300,6 +331,10 @@ files:
 - spec/lib/pact_broker/client/cli/broker_run_webhook_commands_spec.rb
 - spec/lib/pact_broker/client/cli/custom_thor_spec.rb
 - spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb
+- spec/lib/pact_broker/client/environments/delete_environment_spec.rb
+- spec/lib/pact_broker/client/environments/describe_environment_spec.rb
+- spec/lib/pact_broker/client/environments/update_environment_spec.rb
+- spec/lib/pact_broker/client/generate_display_name_spec.rb
 - spec/lib/pact_broker/client/git_spec.rb
 - spec/lib/pact_broker/client/hal/authorization_header_redactor_spec.rb
 - spec/lib/pact_broker/client/hal/entity_spec.rb
@@ -320,7 +355,9 @@ files:
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/lib/pact_broker/client/webhooks/create_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
+- spec/service_providers/create_environment_spec.rb
 - spec/service_providers/extra_goodies_spec.rb
+- spec/service_providers/list_environments_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_ignore_spec.rb
@@ -370,12 +407,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.18
 signing_key: 
 specification_version: 4
 summary: See description
 test_files:
 - spec/fixtures/approvals/can_i_deploy_ignore.approved.txt
+- spec/fixtures/approvals/describe_environment.approved.txt
+- spec/fixtures/approvals/list_environments.approved.txt
 - spec/fixtures/foo-bar.json
 - spec/integration/can_i_deploy_spec.rb
 - spec/integration/create_version_tag_spec.rb
@@ -388,6 +427,10 @@ test_files:
 - spec/lib/pact_broker/client/cli/broker_run_webhook_commands_spec.rb
 - spec/lib/pact_broker/client/cli/custom_thor_spec.rb
 - spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb
+- spec/lib/pact_broker/client/environments/delete_environment_spec.rb
+- spec/lib/pact_broker/client/environments/describe_environment_spec.rb
+- spec/lib/pact_broker/client/environments/update_environment_spec.rb
+- spec/lib/pact_broker/client/generate_display_name_spec.rb
 - spec/lib/pact_broker/client/git_spec.rb
 - spec/lib/pact_broker/client/hal/authorization_header_redactor_spec.rb
 - spec/lib/pact_broker/client/hal/entity_spec.rb
@@ -408,7 +451,9 @@ test_files:
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/lib/pact_broker/client/webhooks/create_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
+- spec/service_providers/create_environment_spec.rb
 - spec/service_providers/extra_goodies_spec.rb
+- spec/service_providers/list_environments_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_ignore_spec.rb