pact_broker-client 1.70.0 → 1.72.0

data/spec/service_providers/pactflow_publish_provider_contract_spec.rb

@@ -1,11 +1,11 @@
+require "yaml"
 require_relative "pact_helper"
 require "pactflow/client/provider_contracts/publish"
-require "yaml"
 
 RSpec.describe "publishing a provider contract to PactFlow", pact: true do
   before do
-    # no point re-testing this
-    allow(PactBroker::Client::Versions::Create).to receive(:call).and_return(double("result", success: true))
+    allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:sleep)
+    allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:default_max_tries).and_return(1)
   end
 
   include_context "pact broker"
@@ -17,8 +17,9 @@ RSpec.describe "publishing a provider contract to PactFlow", pact: true do
       provider_version_number: "1",
       branch_name: "main",
       tags: ["dev"],
+      build_url: "http://build",
       contract: {
-        content: { some: "contract" }.to_yaml,
+        content: { "some" => "contract" }.to_yaml,
         content_type: "application/yaml",
         specification: "oas"
       },
@@ -33,14 +34,17 @@ RSpec.describe "publishing a provider contract to PactFlow", pact: true do
     }
   end
 
-  let(:body) { { some: "body" }.to_json }
-
   let(:request_body) do
      {
-        "content" => "LS0tCjpzb21lOiBjb250cmFjdAo=",
-        "contractType" => "oas",
+      "pacticipantVersionNumber" => "1",
+      "tags" => ["dev"],
+      "branch" => "main",
+      "buildUrl" => "http://build",
+      "contract" => {
+        "content" => "LS0tCnNvbWU6IGNvbnRyYWN0Cg==",
         "contentType" => "application/yaml",
-        "verificationResults" => {
+        "specification" => "oas",
+        "selfVerificationResults" => {
           "success" => true,
           "content" => "c29tZSByZXN1bHRz",
           "contentType" => "text/plain",
@@ -48,14 +52,36 @@ RSpec.describe "publishing a provider contract to PactFlow", pact: true do
           "verifier" => "my custom tool",
           "verifierVersion" => "1.0"
         }
+      }
      }
   end
 
-  let(:response_status) { 201 }
+  let(:response_status) { 200 }
+
+  # Can't tell from the response if the buildUrl was correct, but it's not that important
+  # Add some assertions to the body to ensure we have called the endpoint correctly,
+  # not because we use the properties in the CLI output.
+  # There is unfortunately no good way to determine from the response whether or not
+  # we have correctly published the self verification results.
   let(:success_response) do
     {
       status: response_status,
-      headers: pact_broker_response_headers
+      headers: pact_broker_response_headers,
+      body: {
+        "notices" => Pact.each_like("text" => "some notice", "type" => "info"),
+        "_embedded" => {
+          "version" => {
+            # This tells us we have set the version number correctly
+            "number" => "1"
+          }
+        },
+        "_links" => {
+          # The links tell us we have successfully created the tags, but we don't care about the contents
+          "pb:pacticipant-version-tags" => [{}],
+          # The link tells us we have successfully created the branch version, but we don't care about the contents
+          "pb:branch-version" => {},
+        }
+      }
     }
   end
 
@@ -74,54 +100,38 @@ RSpec.describe "publishing a provider contract to PactFlow", pact: true do
   context "creating a provider contract with valid parameters" do
     before do
       pactflow
-        .upon_receiving("a request to create a provider contract")
+        .given("the pb:publish-provider-contract relation exists in the index resource")
+        .upon_receiving("a request for the index resource")
         .with(
-            method: :put,
-            path: "/contracts/provider/Bar/version/1",
-            headers: put_request_headers,
-            body: request_body)
-        .will_respond_with(success_response)
-    end
-
-    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 include "Successfully published provider contract for Bar version 1"
-      expect(subject.message).not_to include pactflow.mock_service_base_url
-    end
-  end
-
-  context "creating a provider contract with valid parameters with pf:ui return results" do
-    let(:success_response_with_pf_ui_url) do
-      {
-        status: response_status,
-        headers: pact_broker_response_headers,
-        body: { "_links": {
-          "pf:ui": {
-            "href": "#{pactflow.mock_service_base_url}/contracts/bi-directional/provider/Bar/version/1/provider-contract"
+            method: "GET",
+            path: "/",
+            headers: get_request_headers
+        ).will_respond_with(
+          status: 200,
+          headers: pact_broker_response_headers,
+          body: {
+            _links: {
+              :'pf:publish-provider-contract' => {
+                href: placeholder_url_term("pf:publish-provider-contract", ['provider'], pactflow)
+              }
+            }
           }
-        } }
-      }
-    end
-    before do
+        )
+
       pactflow
-        .given("there is a pf:ui href in the response")
-        .upon_receiving("a request to create a provider contract")
+        .upon_receiving("a request to publish a provider contract")
         .with(
-          method: :put,
-          path: "/contracts/provider/Bar/version/1",
-          headers: put_request_headers,
-          body: request_body
-        )
-        .will_respond_with(success_response_with_pf_ui_url)
+            method: :post,
+            path: placeholder_path("pf:publish-provider-contract", ["Bar"]),
+            headers: post_request_headers,
+            body: request_body
+        ).will_respond_with(success_response)
     end
 
-    it "returns a CommandResult with success = true and a provider contract ui url" 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 include "Successfully published provider contract for Bar version 1"
-      expect(subject.message).to include "Next steps:"
-      expect(subject.message).to include success_response_with_pf_ui_url[:body][:_links][:'pf:ui'][:href]
+      expect(subject.message).to include "some notice"
     end
   end
-end
+end

data/spec/service_providers/pactflow_publish_provider_contract_the_old_way_spec.rb

@@ -0,0 +1,129 @@
+require_relative "pact_helper"
+require "yaml"
+require "pactflow/client/provider_contracts/publish_the_old_way"
+require "pact_broker/client/versions/create"
+
+
+RSpec.describe "publishing a provider contract to PactFlow the old way", pact: true do
+  before do
+    # no point re-testing this
+    allow(PactBroker::Client::Versions::Create).to receive(:call).and_return(double("result", success: true))
+  end
+
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:command_params) do
+    {
+      provider_name: "Bar",
+      provider_version_number: "1",
+      branch_name: "main",
+      tags: ["dev"],
+      contract: {
+        content: { "some" => "contract" }.to_yaml,
+        content_type: "application/yaml",
+        specification: "oas"
+      },
+      verification_results: {
+        success: true,
+        content: "some results",
+        content_type: "text/plain",
+        format: "text",
+        verifier: "my custom tool",
+        verifier_version: "1.0"
+      }
+    }
+  end
+
+  let(:body) { { some: "body" }.to_json }
+
+  let(:request_body) do
+     {
+        "content" => "LS0tCnNvbWU6IGNvbnRyYWN0Cg==",
+        "contractType" => "oas",
+        "contentType" => "application/yaml",
+        "verificationResults" => {
+          "success" => true,
+          "content" => "c29tZSByZXN1bHRz",
+          "contentType" => "text/plain",
+          "format" => "text",
+          "verifier" => "my custom tool",
+          "verifierVersion" => "1.0"
+        }
+     }
+  end
+
+  let(:response_status) { 201 }
+  let(:success_response) do
+    {
+      status: response_status,
+      headers: pact_broker_response_headers
+    }
+  end
+
+  let(:options) do
+    {
+      verbose: false
+    }
+  end
+
+  let(:pact_broker_client_options) do
+    { pact_broker_base_url: pactflow.mock_service_base_url }
+  end
+
+  subject { Pactflow::Client::ProviderContracts::PublishTheOldWay.call(command_params, options, pact_broker_client_options) }
+
+  context "creating a provider contract with valid parameters" do
+    before do
+      pactflow
+        .upon_receiving("a request to create a provider contract")
+        .with(
+            method: :put,
+            path: "/contracts/provider/Bar/version/1",
+            headers: put_request_headers,
+            body: request_body)
+        .will_respond_with(success_response)
+    end
+
+    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 include "Successfully published provider contract for Bar version 1"
+      expect(subject.message).not_to include pactflow.mock_service_base_url
+    end
+  end
+
+  context "creating a provider contract with valid parameters with pf:ui return results" do
+    let(:success_response_with_pf_ui_url) do
+      {
+        status: response_status,
+        headers: pact_broker_response_headers,
+        body: { "_links": {
+          "pf:ui": {
+            "href": Pact.like("some-url")
+          }
+        } }
+      }
+    end
+    before do
+      pactflow
+        .given("there is a pf:ui href in the response")
+        .upon_receiving("a request to create a provider contract")
+        .with(
+          method: :put,
+          path: "/contracts/provider/Bar/version/1",
+          headers: put_request_headers,
+          body: request_body
+        )
+        .will_respond_with(success_response_with_pf_ui_url)
+    end
+
+    it "returns a CommandResult with success = true and a provider contract ui url" do
+      expect(subject).to be_a PactBroker::Client::CommandResult
+      expect(subject.success).to be true
+      expect(subject.message).to include "Successfully published provider contract for Bar version 1"
+      expect(subject.message).to include "Next steps:"
+      expect(subject.message).to include "some-url"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -33,6 +33,10 @@ RSpec.configure do | config |
       eval "$#{stream} = StringIO.new"
       yield
       result = eval("$#{stream}").string
+    rescue SystemExit => e
+      puts "CAUGHT SYSTEM EXIT"
+      puts e
+      puts e.backtrace
     ensure
       eval("$#{stream} = #{stream.upcase}")
     end

data/tasks/pact.rake

@@ -2,7 +2,7 @@ require "pact_broker/client/tasks"
 require "pact_broker/client/git"
 
 PactBroker::Client::PublicationTask.new(:localhost) do | task |
-  require 'pact_broker/client/version'
+  require "pact_broker/client/version"
   task.tag = `git rev-parse --abbrev-ref HEAD`.strip
   task.consumer_version = PactBroker::Client::VERSION
   task.pact_broker_base_url = "http://localhost:9292"
@@ -11,17 +11,17 @@ PactBroker::Client::PublicationTask.new(:localhost) do | task |
 end
 
 PactBroker::Client::PublicationTask.new(:remote) do | task |
-  require 'pact_broker/client/version'
+  require "pact_broker/client/version"
   task.tag = `git rev-parse --abbrev-ref HEAD`.strip
   task.consumer_version = PactBroker::Client::VERSION
   task.pact_broker_base_url = "https://test.pact.dius.com.au"
-  task.pact_broker_basic_auth = { username: ENV.fetch('PACT_BROKER_USERNAME'), password: ENV.fetch('PACT_BROKER_PASSWORD') }
+  task.pact_broker_basic_auth = { username: ENV.fetch("PACT_BROKER_USERNAME"), password: ENV.fetch("PACT_BROKER_PASSWORD") }
 end
 
-PactBroker::Client::PublicationTask.new(:pactflow) do | task |
-  version = ENV.fetch('GITHUB_SHA')
-  branch = ENV.fetch('GITHUB_REF').gsub("refs/heads/", "")
-  feature = ENV.fetch('TEST_FEATURE', '')
+PactBroker::Client::PublicationTask.new(:pactflow_oss) do | task |
+  version = ENV.fetch("GITHUB_SHA")
+  branch = ENV.fetch("GITHUB_REF").gsub("refs/heads/", "")
+  feature = ENV.fetch("TEST_FEATURE", "")
   tag = branch
 
   if feature != ''
@@ -29,7 +29,7 @@ PactBroker::Client::PublicationTask.new(:pactflow) do | task |
     tag = "#{tag}+#{feature}"
   end
 
-  require 'pact_broker/client/version'
+  require "pact_broker/client/version"
   task.auto_detect_version_properties = false
   task.tags = [tag]
   task.branch = nil
@@ -38,3 +38,24 @@ PactBroker::Client::PublicationTask.new(:pactflow) do | task |
   task.pact_broker_token = ENV['PACT_BROKER_TOKEN']
   task.build_url = PactBroker::Client::Git.build_url
 end
+
+PactBroker::Client::PublicationTask.new(:pactflow_pact_foundation) do | task |
+  version = ENV.fetch("GITHUB_SHA")
+  branch = ENV.fetch("GITHUB_REF").gsub("refs/heads/", "")
+  feature = ENV.fetch("TEST_FEATURE", "")
+  tag = branch
+
+  if feature != ""
+    version = "#{version}+#{feature}"
+    tag = "#{tag}+#{feature}"
+  end
+
+  require "pact_broker/client/version"
+  task.auto_detect_version_properties = false
+  task.tags = [tag]
+  task.branch = nil
+  task.consumer_version = version
+  task.pact_broker_base_url = "https://pact-foundation.pactflow.io"
+  task.pact_broker_token = ENV["PACT_BROKER_TOKEN_PACT_FOUNDATION"]
+  task.build_url = PactBroker::Client::Git.build_url
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.70.0
+  version: 1.72.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -106,104 +106,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: fakefs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: conventional-changelog
-  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'
-- !ruby/object:Gem::Dependency
-  name: pact
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: pact-support
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: approvals
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.0.26
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.0.26
-- !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. Manage webhooks and environments.
 email:
@@ -333,10 +235,13 @@ files:
 - lib/pactflow/client/cli/pactflow.rb
 - lib/pactflow/client/cli/provider_contract_commands.rb
 - lib/pactflow/client/provider_contracts/publish.rb
+- lib/pactflow/client/provider_contracts/publish_the_old_way.rb
 - pact-broker-client.gemspec
 - script/approve-all.sh
 - script/can-i-deploy.sh
+- script/ci/record-release.sh
 - script/create-pacticipant.sh
+- script/foo-bar.json
 - script/oas.yml
 - script/publish-pact.sh
 - script/publish-provider-contract.sh
@@ -354,11 +259,13 @@ files:
 - spec/fixtures/approvals/describe_environment.approved.txt
 - spec/fixtures/approvals/describe_pacticipant.approved.txt
 - spec/fixtures/approvals/list_environments.approved.txt
+- spec/fixtures/approvals/publish_provider_contract.approved.txt
 - spec/fixtures/foo-bar.json
 - spec/integration/can_i_deploy_spec.rb
 - spec/integration/can_i_merge_spec.rb
 - spec/integration/create_version_tag_spec.rb
 - spec/integration/describe_environment_spec.rb
+- spec/integration/publish_provider_contract_spec.rb
 - spec/lib/pact_broker/client/base_client_spec.rb
 - spec/lib/pact_broker/client/can_i_deploy_spec.rb
 - spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb
@@ -395,6 +302,7 @@ files:
 - spec/lib/pact_broker/client/versions/describe_spec.rb
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/lib/pact_broker/client/webhooks/create_spec.rb
+- spec/lib/pactflow/client/provider_contracts/publish_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
 - spec/pacts/pact_broker_client-pactflow.json
 - spec/readme_spec.rb
@@ -413,6 +321,7 @@ files:
 - spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
 - spec/service_providers/pactflow_publish_provider_contract_spec.rb
+- spec/service_providers/pactflow_publish_provider_contract_the_old_way_spec.rb
 - spec/service_providers/pactflow_webhooks_create_spec.rb
 - spec/service_providers/pacticipants_create_spec.rb
 - spec/service_providers/publish_pacts_spec.rb
@@ -464,11 +373,13 @@ test_files:
 - spec/fixtures/approvals/describe_environment.approved.txt
 - spec/fixtures/approvals/describe_pacticipant.approved.txt
 - spec/fixtures/approvals/list_environments.approved.txt
+- spec/fixtures/approvals/publish_provider_contract.approved.txt
 - spec/fixtures/foo-bar.json
 - spec/integration/can_i_deploy_spec.rb
 - spec/integration/can_i_merge_spec.rb
 - spec/integration/create_version_tag_spec.rb
 - spec/integration/describe_environment_spec.rb
+- spec/integration/publish_provider_contract_spec.rb
 - spec/lib/pact_broker/client/base_client_spec.rb
 - spec/lib/pact_broker/client/can_i_deploy_spec.rb
 - spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb
@@ -505,6 +416,7 @@ test_files:
 - spec/lib/pact_broker/client/versions/describe_spec.rb
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/lib/pact_broker/client/webhooks/create_spec.rb
+- spec/lib/pactflow/client/provider_contracts/publish_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
 - spec/pacts/pact_broker_client-pactflow.json
 - spec/readme_spec.rb
@@ -523,6 +435,7 @@ test_files:
 - spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
 - spec/service_providers/pactflow_publish_provider_contract_spec.rb
+- spec/service_providers/pactflow_publish_provider_contract_the_old_way_spec.rb
 - spec/service_providers/pactflow_webhooks_create_spec.rb
 - spec/service_providers/pacticipants_create_spec.rb
 - spec/service_providers/publish_pacts_spec.rb