pact_broker-client 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d02c4958a4ce2075aa48badee273f98fa548a788
-  data.tar.gz: b46ca8c2e3d9774b03708d21a37dbd1ba38b5a49
+  metadata.gz: 9e145049914705be5d6fbf40b0c558fa03b1f721
+  data.tar.gz: 1af03d94ccc879a70f04297a8d2e3fe41878c446
 SHA512:
-  metadata.gz: e40cdbc4fb73a1003aa67031ceaa81e87af13f0e5ebef364ea2eedfa645b146aa4c9b5c1428c6be23a83f7a6ce331f1e7763121302173fca39ee49a3ef7e0c2d
-  data.tar.gz: e35369fe4b2ede88564929b9c9bec86bf13bbca64b9b4ad170c9fbfab300aa8da6e4145fd626643e4b868e6fdbbd03732e9e4fb3cf815a214ed8a45bacaef678
+  metadata.gz: cf7f69734f2cc5195ab2b9ad04647ef10a8d841488132fc327db0bc363076dee6ed6b2e97a7a78930e59f72fc270c62a4588387692a5b84ab6625f54b9871db4
+  data.tar.gz: 96760c522ae3663b570d53537bb0af321bd9d24cf74c945cb7a7cc96118b076e44434e09ff175b5fffef45c1f9a58896ea69a468ac5330778c6c7b98d0310015

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+<a name="v1.11.0"></a>
+### v1.11.0 (2017-11-01)
+
+
+#### Features
+
+* **can-i-deploy**
+  * add --latest option to command line	 ([c7f012d](/../../commit/c7f012d))
+
+* allow broker base url, username and password to be set by environment variables	 ([3516103](/../../commit/3516103))
+
+* **cli**
+  * add one line of backtrace to error output	 ([c2ede03](/../../commit/c2ede03))
+
+* **create-version-tag**
+  * add CLI to tag a pacticipant version	 ([c62d9b8](/../../commit/c62d9b8))
+
+
 <a name="v1.10.0"></a>
 ### v1.10.0 (2017-10-31)
 

data/lib/pact_broker/client/cli/broker.rb

@@ -6,6 +6,7 @@ require 'pact_broker/client/cli/custom_thor'
 require 'pact_broker/client/publish_pacts'
 require 'rake/file_list'
 require 'thor/error'
+require 'pact_broker/client/create_tag'
 
 module PactBroker
   module Client
@@ -17,7 +18,8 @@ module PactBroker
         desc 'can-i-deploy', "Returns exit code 0 or 1, indicating whether or not the specified application versions are compatible."
 
         method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name. Use once for each pacticipant being checked."
-        method_option :version, required: true, aliases: "-e", desc: "The application version. Must be entered after the --pacticipant that it relates to."
+        method_option :version, required: false, aliases: "-e", desc: "The pacticipant version. Must be entered after the --pacticipant that it relates to."
+        method_option :latest, required: false, aliases: "-l", banner: '[TAG]', desc: "Use the latest pacticipant version. Optionally specify a TAG to use the latest version with the specified tag."
         method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
         method_option :broker_username, aliases: "-u", desc: "Pact Broker basic auth username"
         method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
@@ -49,6 +51,25 @@ module PactBroker
           raise PactPublicationError, "#{e.class} - #{e.message}"
         end
 
+        desc 'create-version-tag', 'Add a tag to a pacticipant version'
+        method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name"
+        method_option :version, required: true, aliases: "-e", desc: "The pacticipant version"
+        method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for pacticipant version. Can be specified multiple times."
+        method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag pacticipant version with the name of the current git branch. Default: false"
+        method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
+        method_option :broker_username, aliases: "-u", desc: "Pact Broker basic auth username"
+        method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
+        method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+
+        def create_version_tag
+          PactBroker::Client::CreateTag.call(
+            options.broker_base_url,
+            options.pacticipant,
+            options.version,
+            tags,
+            pact_broker_client_options)
+        end
+
         desc 'version', "Show the pact_broker-client gem version"
         def version
           $stdout.puts PactBroker::Client::VERSION
@@ -67,8 +88,8 @@ module PactBroker
           end
 
           def validate_can_i_deploy_selectors selectors
-            pacticipants_without_versions = selectors.select{ |s| s[:version].nil? }.collect{ |s| s[:pacticipant] }
-            raise ::Thor::RequiredArgumentMissingError, "No --version provided for pacticipant #{pacticipants_without_versions.join(", ")}" if pacticipants_without_versions.any?
+            pacticipants_without_versions = selectors.select{ |s| s[:version].nil? && s[:latest].nil? }.collect{ |s| s[:pacticipant] }
+            raise ::Thor::RequiredArgumentMissingError, "The version must be specified using --version or --latest [TAG] for pacticipant #{pacticipants_without_versions.join(", ")}" if pacticipants_without_versions.any?
           end
 
           def publish_pacts pact_files

data/lib/pact_broker/client/cli/custom_thor.rb

@@ -16,7 +16,24 @@ module PactBroker
           end
 
           def self.massage_args argv
-            turn_muliple_tag_options_into_array(argv)
+            add_broker_config_from_environment_variables(turn_muliple_tag_options_into_array(argv))
+          end
+
+          def self.add_broker_config_from_environment_variables argv
+            return argv if argv[0] == 'version' || argv[0] == 'help'
+
+            new_argv = add_option_from_environment_variable(argv, 'broker-base-url', 'b', 'PACT_BROKER_BASE_URL')
+            new_argv = add_option_from_environment_variable(new_argv, 'broker-username', 'u', 'PACT_BROKER_USERNAME')
+            add_option_from_environment_variable(new_argv, 'broker-password', 'p', 'PACT_BROKER_PASSWORD')
+          end
+
+          def self.add_option_from_environment_variable argv, long_name, short_name, environment_variable_name
+            option_options = ["--#{long_name}", "--#{long_name.gsub('-','_')}", "-#{short_name}"]
+            if (argv & option_options).empty? && ENV[environment_variable_name]
+              argv + ["--#{long_name}", ENV[environment_variable_name]]
+            else
+              argv
+            end
           end
 
           # other task names, help, and the help shortcuts

data/lib/pact_broker/client/cli/version_selector_options_parser.rb

@@ -9,6 +9,9 @@ module PactBroker
             case option
             when "--pacticipant", "-a"
               versions << {}
+            when "--latest", "-l"
+              versions << {pacticipant: nil} unless versions.last
+              versions.last[:latest] = true
             when /^\-/
               nil
             else
@@ -18,6 +21,9 @@ module PactBroker
               when "--version", "-e"
                 versions << {pacticipant: nil} unless versions.last
                 versions.last[:version] = option
+              when "--latest", "-l"
+                versions << {pacticipant: nil} unless versions.last
+                versions.last[:tag] = option
               end
             end
             last_flag = option if option.start_with?("-")

data/lib/pact_broker/client/create_tag.rb

@@ -0,0 +1,49 @@
+require 'pact_broker/client/error'
+require 'pact_broker/client/pact_broker_client'
+require 'pact_broker/client/retry'
+
+module PactBroker
+  module Client
+    class CreateTag
+
+      class Result
+        attr_reader :success, :message
+
+        def initialize success, message = nil
+          @success = success
+          @message = message
+        end
+      end
+
+      def self.call(pact_broker_base_url, pacticipant_name, version, tags, pact_broker_client_options={})
+        new(pact_broker_base_url, pacticipant_name, version, tags, pact_broker_client_options).call
+      end
+
+      def initialize(pact_broker_base_url, pacticipant_name, version, tags, pact_broker_client_options)
+        @pact_broker_base_url = pact_broker_base_url
+        @pacticipant_name = pacticipant_name
+        @version = version
+        @tags = tags
+        @pact_broker_client_options = pact_broker_client_options
+      end
+
+      def call
+        tags.each do | tag |
+          # todo check that pacticipant exists first
+          $stdout.puts "Tagging #{pacticipant_name} version #{version} as #{tag}"
+          Retry.until_true do
+            pact_broker_client.pacticipants.versions.tag pacticipant: pacticipant_name, version: version, tag: tag
+          end
+        end
+      end
+
+      private
+
+      attr_reader :pact_broker_base_url, :pacticipant_name, :version, :tags, :pact_broker_client_options
+
+      def pact_broker_client
+        @pact_broker_client ||= PactBroker::Client::PactBrokerClient.new(base_url: pact_broker_base_url, client_options: pact_broker_client_options)
+      end
+    end
+  end
+end

data/lib/pact_broker/client/matrix.rb

@@ -25,7 +25,14 @@ module PactBroker
         else
           error_message = nil
           begin
-            error_message = JSON.parse(response.body)['errors'].join("\n")
+            errors = JSON.parse(response.body)['errors']
+            error_message = if errors.is_a?(Array)
+              errors.join("\n")
+            elsif errors.is_a?(Hash)
+              errors.collect{ |key, value| "#{key}: #{value}" }.join("\n")
+            else
+              response.body
+            end
           rescue
             raise Error.new(response.body)
           end
@@ -45,6 +52,8 @@ module PactBroker
         selectors.collect do |selector|
           { pacticipant: selector[:pacticipant] }.tap do | hash |
             hash[:version] = selector[:version] if selector[:version]
+            hash[:latest] = 'true' if selector[:latest]
+            hash[:tag] = selector[:tag] if selector[:tag]
           end
         end
       end

data/lib/pact_broker/client/retry.rb

@@ -22,7 +22,7 @@ module PactBroker
             return yield
           rescue RescuableError => e
             tries += 1
-            $stderr.puts "Error making request - #{e.message}, attempt #{tries} of #{max_tries}"
+            $stderr.puts "Error making request - #{e.class} #{e.message} #{e.backtrace.find{|l| l.include?('pact_broker-client')}}, attempt #{tries} of #{max_tries}"
             raise e if max_tries == tries
             sleep options
           end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.10.0'
+    VERSION = '1.11.0'
   end
 end

data/spec/integration/create_version_tag_spec.rb

@@ -0,0 +1,20 @@
+describe "pact-broker create-version-tag" do
+  before(:all) do
+    @pipe = IO.popen("bundle exec pact-stub-service spec/pacts/pact_broker_client-pact_broker.json -p 5001")
+    sleep 2
+  end
+
+  context "when the version is successfully tagged" do
+    subject { `bundle exec bin/pact-broker create-version-tag -v --pacticipant Condor --version 1.3.0 --tag prod --broker-base-url http://localhost:5001` }
+
+    it "returns a success exit code" do
+      subject
+      expect($?.exitstatus).to eq 0
+      expect(subject).to include 'Tagging Condor version 1.3.0 as prod'
+    end
+  end
+
+  after(:all) do
+    Process.kill 'KILL', @pipe.pid
+  end
+end

data/spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb

@@ -36,11 +36,11 @@ module PactBroker
           invoke_can_i_deploy
         end
 
-        context "with a missing --version" do
+        context "with a missing --version and --latest" do
           let(:version_selectors) { [{pacticipant: "Foo", version: nil}] }
 
           it "raises an error" do
-            expect { invoke_can_i_deploy }.to raise_error Thor::RequiredArgumentMissingError, "No --version provided for pacticipant Foo"
+            expect { invoke_can_i_deploy }.to raise_error Thor::RequiredArgumentMissingError, /The version must be specified/
           end
         end
 

data/spec/lib/pact_broker/client/cli/custom_thor_spec.rb

@@ -18,6 +18,14 @@ module PactBroker::Client::CLI
       Delegate.call(options)
     end
 
+    desc '', ''
+    method_option :broker_base_url, required: true, aliases: "-b"
+    method_option :broker_username, aliases: "-u"
+    method_option :broker_password, aliases: "-p"
+    def test_using_env_vars
+      Delegate.call(options)
+    end
+
     default_command :test_default
   end
 
@@ -29,6 +37,32 @@ module PactBroker::Client::CLI
       TestThor.start(%w{test_multiple_options --multi one --multi two})
     end
 
+    context "with broker configuration in the environment variables" do
+      before do
+        ENV['PACT_BROKER_BASE_URL'] = 'http://foo'
+        ENV['PACT_BROKER_USERNAME'] = 'username'
+        ENV['PACT_BROKER_PASSWORD'] = 'password'
+      end
+
+      it "populates the options from the environment variables" do
+        expect(Delegate).to receive(:call) do | options |
+          expect(options.broker_base_url).to eq 'http://foo'
+          expect(options.broker_username).to eq 'username'
+          expect(options.broker_password).to eq 'password'
+        end
+        TestThor.start(%w{test_using_env_vars})
+      end
+
+      it "does not override a value specifed on the command line" do
+        expect(Delegate).to receive(:call) do | options |
+          expect(options.broker_base_url).to eq 'http://bar'
+          expect(options.broker_username).to eq 'username'
+          expect(options.broker_password).to eq 'password'
+        end
+        TestThor.start(%w{test_using_env_vars --broker-base-url http://bar})
+      end
+    end
+
     describe ".turn_muliple_tag_options_into_array" do
       it "turns '--tag foo --tag bar' into '--tag foo bar'" do
         input = %w{--ignore this --tag foo --tag bar --wiffle --that}

data/spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb

@@ -30,6 +30,12 @@ module PactBroker
           ],[
             ["--version", "1.2.3"],
             [{ pacticipant: nil, version: "1.2.3" } ]
+          ],[
+            ["--pacticipant", "Foo", "--latest", "--pacticipant", "Bar"],
+            [{ pacticipant: "Foo", latest: true }, { pacticipant: "Bar" } ]
+          ],[
+            ["--pacticipant", "Foo", "--latest", "prod", "--pacticipant", "Bar"],
+            [{ pacticipant: "Foo", latest: true, tag: "prod"}, { pacticipant: "Bar" } ]
           ]
         ]
 

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -451,6 +451,102 @@
         }
       }
     },
+    {
+      "description": "a request for the compatibility matrix for Foo version 1.2.3 and the latest prod version of Bar",
+      "providerState": "the pact for Foo version 1.2.3 has been successfully verified by Bar version 4.5.6 with tag prod, and 1.2.4 unsuccessfully by 9.9.9",
+      "request": {
+        "method": "get",
+        "path": "/matrix",
+        "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][latest]=true&q[][tag]=prod"
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+        },
+        "body": {
+          "summary": {
+            "deployable": true,
+            "reason": "some text"
+          },
+          "matrix": [
+            {
+              "consumer": {
+                "name": "Foo",
+                "version": {
+                  "number": "4"
+                }
+              },
+              "provider": {
+                "name": "Bar",
+                "version": {
+                  "number": "5"
+                }
+              },
+              "verificationResult": {
+                "verifiedAt": "2017-10-10T12:49:04+11:00",
+                "success": true
+              },
+              "pact": {
+                "createdAt": "2017-10-10T12:49:04+11:00"
+              }
+            }
+          ]
+        },
+        "matchingRules": {
+          "$.body": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request for the compatibility matrix for Foo version 1.2.3 and the latest version of Bar",
+      "providerState": "the pact for Foo version 1.2.3 has been successfully verified by Bar version 4.5.6, and 1.2.4 unsuccessfully by 9.9.9",
+      "request": {
+        "method": "get",
+        "path": "/matrix",
+        "query": "q[][pacticipant]=Foo&q[][version]=1.2.4&q[][pacticipant]=Bar&q[][latest]=true"
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+        },
+        "body": {
+          "summary": {
+            "deployable": true,
+            "reason": "some text"
+          },
+          "matrix": [
+            {
+              "consumer": {
+                "name": "Foo",
+                "version": {
+                  "number": "4"
+                }
+              },
+              "provider": {
+                "name": "Bar",
+                "version": {
+                  "number": "5"
+                }
+              },
+              "verificationResult": {
+                "verifiedAt": "2017-10-10T12:49:04+11:00",
+                "success": true
+              },
+              "pact": {
+                "createdAt": "2017-10-10T12:49:04+11:00"
+              }
+            }
+          ]
+        },
+        "matchingRules": {
+          "$.body": {
+            "match": "type"
+          }
+        }
+      }
+    },
     {
       "description": "a request to publish a pact",
       "providerState": "the 'Pricing Service' already exists in the pact-broker",

data/spec/service_providers/pact_broker_client_matrix_spec.rb

@@ -186,6 +186,58 @@ module PactBroker::Client
           expect(matrix[:matrix].size).to eq 1
         end
       end
+
+      context "when the latest version for a given tag is specified" do
+        before do
+          pact_broker.
+            given("the pact for Foo version 1.2.3 has been successfully verified by Bar version 4.5.6 with tag prod, and 1.2.4 unsuccessfully by 9.9.9").
+            upon_receiving("a request for the compatibility matrix for Foo version 1.2.3 and the latest prod version of Bar").
+            with(
+              method: :get,
+              path: "/matrix",
+              query: "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][latest]=true&q[][tag]=prod"
+            ).
+            will_respond_with(
+              status: 200,
+              headers: pact_broker_response_headers,
+              body: matrix_response_body
+            )
+        end
+        let(:matrix_row) { JSON.parse(File.read('spec/support/matrix.json'))['matrix'].first }
+        let(:selectors) { [{ pacticipant: "Foo", version: "1.2.3"}, { pacticipant: "Bar", latest: true, tag: 'prod' }] }
+        let(:options) { {} }
+
+        it "returns the matrix with the latest prod version of Bar" do
+          matrix = pact_broker_client.matrix.get(selectors, options)
+          expect(matrix[:matrix].size).to eq 1
+        end
+      end
+
+      context "when the latest version is specified" do
+        before do
+          pact_broker.
+            given("the pact for Foo version 1.2.3 has been successfully verified by Bar version 4.5.6, and 1.2.4 unsuccessfully by 9.9.9").
+            upon_receiving("a request for the compatibility matrix for Foo version 1.2.3 and the latest version of Bar").
+            with(
+              method: :get,
+              path: "/matrix",
+              query: "q[][pacticipant]=Foo&q[][version]=1.2.4&q[][pacticipant]=Bar&q[][latest]=true"
+            ).
+            will_respond_with(
+              status: 200,
+              headers: pact_broker_response_headers,
+              body: matrix_response_body
+            )
+        end
+        let(:matrix_row) { JSON.parse(File.read('spec/support/matrix.json'))['matrix'].first }
+        let(:selectors) { [{ pacticipant: "Foo", version: "1.2.4"}, { pacticipant: "Bar", latest: true }] }
+        let(:options) { {} }
+
+        it "returns the matrix with the latest prod version of Bar" do
+          matrix = pact_broker_client.matrix.get(selectors, options)
+          expect(matrix[:matrix].size).to eq 1
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,3 +3,11 @@ require 'webmock/rspec'
 WebMock.disable_net_connect!(allow_localhost: true)
 
 require "./spec/support/shared_context.rb"
+
+RSpec.configure do | config |
+
+  config.before(:each) do
+    ENV.delete('PACT_BROKER_BASE_URL')
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2017-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -163,6 +163,7 @@ files:
 - lib/pact_broker/client/cli/broker.rb
 - lib/pact_broker/client/cli/custom_thor.rb
 - lib/pact_broker/client/cli/version_selector_options_parser.rb
+- lib/pact_broker/client/create_tag.rb
 - lib/pact_broker/client/error.rb
 - lib/pact_broker/client/git.rb
 - lib/pact_broker/client/matrix.rb
@@ -186,6 +187,7 @@ files:
 - script/publish-pact.sh
 - script/release.sh
 - spec/integration/can_i_deploy_spec.rb
+- spec/integration/create_version_tag_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
@@ -242,12 +244,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: See description
 test_files:
 - spec/integration/can_i_deploy_spec.rb
+- spec/integration/create_version_tag_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