pact_broker-client 1.60.0 → 1.62.0

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

@@ -0,0 +1,174 @@
+require "pact_broker/client/versions/create"
+
+module PactBroker
+  module Client
+    describe Versions::Create do
+      describe "#call" do
+        let(:index_body) do
+          {
+            "_links" => {
+              "pb:pacticipant-branch-version" => {
+                "href" => "http://broker/pacticipants/{pacticipant}/branches/{branch}/versions/{version}"
+              },
+              "pb:pacticipant-version-tag" => {
+                "href" => "http://broker/pacticipants/{pacticipant}/versions/{version}/tags/{tag}"
+              },
+              "pb:pacticipant-version" => {
+                "href" => "http://broker/pacticipants/{pacticipant}/versions/{version}"
+              }
+            }
+          }
+        end
+
+        let!(:index_request) do
+          stub_request(:get, "http://broker").to_return(status: 200, body: index_body.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:branch_request) do
+          stub_request(:put, "http://broker/pacticipants/Foo/branches/main/versions/1").to_return(status: 200, body: "{}", headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:tag_request) do
+          stub_request(:put, "http://broker/pacticipants/Foo/versions/1/tags/dev").to_return(status: 200, body: "{}", headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:create_version_request) do
+          stub_request(:put, "http://broker/pacticipants/Foo/versions/1").to_return(status: 200, body: { version: "created" }.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:get_version_request) do
+          stub_request(:get, "http://broker/pacticipants/Foo/versions/1").to_return(status: 200, body: { version: "got" }.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let(:params) do
+          {
+            pacticipant_name: "Foo",
+            version_number: "1",
+            branch_name: branch_name,
+            tags: tags
+          }
+        end
+
+        let(:branch_name) { "main" }
+        let(:tags) { ["dev"] }
+
+        let(:options) do
+          {
+            verbose: "verbose",
+            output: output
+          }
+        end
+
+        let(:output) { "text" }
+
+        let(:pact_broker_client_options) do
+          {
+            token: "token",
+            pact_broker_base_url: "http://broker"
+          }
+        end
+
+        subject { PactBroker::Client::Versions::Create.call(params, options, pact_broker_client_options)}
+
+        context "with a branch and tags" do
+          it "creates a branch version" do
+            subject
+            expect(branch_request).to have_been_made
+          end
+
+          it "creates the tag" do
+            subject
+            expect(tag_request).to have_been_made
+          end
+
+          it "returns a message" do
+            expect(subject.message).to include "Created/updated pacticipant version 1 with branch main and tag(s) dev in the Pact Broker"
+            expect(subject.success).to be true
+          end
+
+          context "without output json" do
+            let(:output) { "json" }
+
+            it "returns a json message" do
+              expect(subject.message).to eq({ version: "got" }.to_json)
+            end
+          end
+        end
+
+        context "with only tags" do
+          let(:branch_name) { nil }
+
+          it "returns a message" do
+            expect(subject.message).to include "Created/updated pacticipant version 1 with tag(s) dev in the Pact Broker"
+            expect(subject.success).to be true
+          end
+
+          context "without output json" do
+            let(:output) { "json" }
+
+            it "returns a json message" do
+              expect(subject.message).to eq({ version: "got" }.to_json)
+            end
+          end
+        end
+
+        context "with only a branch" do
+          let(:tags) { nil }
+
+          it "returns a message" do
+            expect(subject.message).to include "Created/updated pacticipant version 1 with branch main in the Pact Broker"
+            expect(subject.success).to be true
+          end
+
+          context "without output json" do
+            let(:output) { "json" }
+
+            it "returns a json message" do
+              expect(subject.message).to eq({ version: "got" }.to_json)
+            end
+          end
+        end
+
+        context "with no branch or tags" do
+          let(:tags) { nil }
+          let(:branch_name) { nil }
+
+          it "creates a version" do
+            subject
+            expect(create_version_request).to have_been_made
+          end
+
+          it "returns a message" do
+            expect(subject.message).to include "Created/updated pacticipant version 1 in the Pact Broker"
+            expect(subject.success).to be true
+          end
+
+          context "without output json" do
+            let(:output) { "json" }
+
+            it "returns a json message" do
+              expect(subject.message).to eq({ version: "created" }.to_json)
+            end
+          end
+        end
+
+        context "when the Pact Broker does not support branch versions" do
+          before do
+            index_body["_links"].delete("pb:pacticipant-branch-version")
+          end
+
+          let(:index_body) do
+            {
+              "_links" => {}
+            }
+          end
+
+          it "returns an error" do
+            expect(subject.message).to include "does not support branch versions"
+            expect(subject.success).to be false
+          end
+        end
+      end
+    end
+  end
+end

data/spec/pacts/pact_broker_client-pactflow.json

@@ -6,6 +6,36 @@
     "name": "Pactflow"
   },
   "interactions": [
+    {
+      "description": "a request to create a provider contract",
+      "request": {
+        "method": "put",
+        "path": "/contracts/provider/Bar/version/1",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "content": "LS0tCjpzb21lOiBjb250cmFjdAo=",
+          "contractType": "oas",
+          "contentType": "application/yaml",
+          "verificationResults": {
+            "success": true,
+            "content": "c29tZSByZXN1bHRz",
+            "contentType": "text/plain",
+            "format": "text",
+            "verifier": "my custom tool",
+            "verifierVersion": "1.0"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        }
+      }
+    },
     {
       "description": "a request for the index resource",
       "request": {

data/spec/service_providers/pactflow_publish_provider_contract_spec.rb

@@ -0,0 +1,92 @@
+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))
+  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" => "LS0tCjpzb21lOiBjb250cmFjdAo=",
+        "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::Publish.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"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.60.0
+  version: 1.62.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -176,14 +176,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.24
+        version: 0.0.18
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.24
+        version: 0.0.18
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -204,6 +204,7 @@ email:
 - beth@bethesque.com
 executables:
 - pact-broker
+- pactflow
 extensions: []
 extra_rdoc_files: []
 files:
@@ -220,6 +221,7 @@ files:
 - Rakefile
 - appveyor.yml
 - bin/pact-broker
+- bin/pactflow
 - ci.sh
 - doc/CAN_I_DEPLOY_USAGE_WITH_TAGS.md
 - doc/pacts/markdown/Pact Broker Client - Pact Broker.md
@@ -245,8 +247,10 @@ files:
 - lib/pact_broker/client/cli/deployment_commands.rb
 - lib/pact_broker/client/cli/environment_commands.rb
 - lib/pact_broker/client/cli/matrix_commands.rb
+- lib/pact_broker/client/cli/pact_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_commands.rb
 - lib/pact_broker/client/cli/version_selector_options_parser.rb
 - lib/pact_broker/client/cli/webhook_commands.rb
 - lib/pact_broker/client/colorize_notices.rb
@@ -304,6 +308,7 @@ files:
 - lib/pact_broker/client/verification_required.rb
 - lib/pact_broker/client/version.rb
 - lib/pact_broker/client/versions.rb
+- lib/pact_broker/client/versions/create.rb
 - lib/pact_broker/client/versions/describe.rb
 - lib/pact_broker/client/versions/formatter.rb
 - lib/pact_broker/client/versions/json_formatter.rb
@@ -311,17 +316,23 @@ files:
 - lib/pact_broker/client/webhooks/create.rb
 - lib/pact_broker/client/webhooks/test.rb
 - lib/pact_broker_client.rb
+- lib/pactflow/client/cli/pactflow.rb
+- lib/pactflow/client/cli/provider_contract_commands.rb
+- lib/pactflow/client/provider_contracts/publish.rb
 - pact-broker-client.gemspec
 - script/approve-all.sh
 - script/can-i-deploy.sh
 - script/create-pacticipant.sh
+- script/oas.yml
 - script/publish-pact.sh
+- script/publish-provider-contract.sh
 - script/record-deployment.sh
 - script/record-deployments-and-releases.sh
 - script/record-undeployment.sh
 - script/release.sh
 - script/trigger-release.sh
 - script/update-cli-usage-in-readme.rb
+- script/verification-results.txt
 - script/webhook-commands.sh
 - spec/fixtures/approvals/can_i_deploy_failure_dry_run.approved.txt
 - spec/fixtures/approvals/can_i_deploy_ignore.approved.txt
@@ -365,6 +376,7 @@ files:
 - spec/lib/pact_broker/client/publish_pacts_the_old_way_spec.rb
 - spec/lib/pact_broker/client/retry_spec.rb
 - spec/lib/pact_broker/client/tasks/publication_task_spec.rb
+- spec/lib/pact_broker/client/versions/create_spec.rb
 - 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
@@ -385,6 +397,7 @@ files:
 - spec/service_providers/pact_broker_client_tags_spec.rb
 - 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_webhooks_create_spec.rb
 - spec/service_providers/pacticipants_create_spec.rb
 - spec/service_providers/publish_pacts_spec.rb
@@ -425,7 +438,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.3.13
 signing_key:
 specification_version: 4
 summary: See description
@@ -472,6 +485,7 @@ test_files:
 - spec/lib/pact_broker/client/publish_pacts_the_old_way_spec.rb
 - spec/lib/pact_broker/client/retry_spec.rb
 - spec/lib/pact_broker/client/tasks/publication_task_spec.rb
+- spec/lib/pact_broker/client/versions/create_spec.rb
 - 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
@@ -492,6 +506,7 @@ test_files:
 - spec/service_providers/pact_broker_client_tags_spec.rb
 - 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_webhooks_create_spec.rb
 - spec/service_providers/pacticipants_create_spec.rb
 - spec/service_providers/publish_pacts_spec.rb