pact_broker-client 1.28.0 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e23b12ee8b9f8c67c792cd830bcd29b9c6d705606476ec473028175c2763486c
-  data.tar.gz: b610a006305ecb79523fada0b3af80f745437d83cae4fe9691462f5f3da2647d
+  metadata.gz: 3a07f8cd0761d2826dd2b2c28b47bee6b3d792480fe97f49724280f451ea47bf
+  data.tar.gz: 3dd78bb84b1f392211d4762e89da7040ef56e13a990dc87c1866e7658778a8e6
 SHA512:
-  metadata.gz: d2485fe9b05e4039826f722c692eb666b3631fa7d618558ef7abfbdb177e9dcaaf44bf62fd6935fe298ff25bf94282be9383ba81c20b1d0e856974db23bc2787
-  data.tar.gz: abb37f8f92a773850122c0fac6b98ca72e154e6d9cf5a05bb6bfd985b5179196b44a71b800007b7dd032f14728c98cdf0ab12581c708f5a0baeefee7d7f9115e
+  metadata.gz: ea00e0e31727d6f826661ad2316762b94f4f8097f9829f44e2e85f6f7c62d0da5e9002101141dbbd6b5af009768c246ce4375053e2dfe9fce86f605a33e8ccbf
+  data.tar.gz: e6fe10b4acc7cf24f24fca2ccc8a3ee4709d1d421c466abba59a20c72c7672498f4bc893ccc2c229d70d5fdb0586d52edcfcdb8be651f4337fd7d1d10434eeaa

data/.github/workflows/release_gem.yml

@@ -3,22 +3,56 @@ name: Release gem
 on:
   repository_dispatch:
     types:
-      - release-patch
+      - release-triggered
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: '2.6'
+    - run: |
+        gem install bundler -v 2.1
+        bundle install
+    - name: Test
+      run: bundle exec rake
+
+  release:
+    needs: test
+    runs-on: ubuntu-latest
+    outputs:
+      gem_name: ${{ steps.release.outputs.gem_name }}
+      version: ${{ steps.release.outputs.version }}
+      increment: ${{ steps.release.outputs.increment }}
+    steps:
     - uses: actions/checkout@v2
       with:
         fetch-depth: 0
-    - uses: pact-foundation/release-gem@v0.0.5
+    - uses: pact-foundation/release-gem@v0.0.11
+      id: release
       env:
         GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_API_KEY }}'
         GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
-    # - name: Trigger release of pact-cli Docker image
-    #   uses: peter-evans/repository-dispatch@v1
-    #   with:
-    #     token: ${{ secrets.GHTOKENFORPACTCLIRELEASE }}
-    #     repository: pact-foundation/pact-ruby-cli
-    #     event-type: gem-released
+        INCREMENT: '${{ github.event.client_payload.increment }}'
+
+  notify-gem-released:
+    needs: release
+    strategy:
+      matrix:
+        repository: [pact-foundation/pact-ruby-cli, pact-foundation/pact-ruby-standalone, pact-foundation/pact_broker-client]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Notify ${{ matrix.repository }} of gem release
+        uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.GHTOKENFORPACTCLIRELEASE }}
+          repository: ${{ matrix.repository }}
+          event-type: gem-released
+          client-payload: |
+              {
+                "name": "${{ needs.release.outputs.gem_name }}",
+                "version": "${{ needs.release.outputs.version }}",
+                "increment": "${{ needs.release.outputs.increment }}"
+              }

data/.github/workflows/trigger_pact_docs_update.yml

@@ -6,6 +6,9 @@ on:
       - master
     paths:
       - '**.md'
+  repository_dispatch:
+    types:
+      - gem-released
 
 jobs:
   build:

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+<a name="v1.29.0"></a>
+### v1.29.0 (2020-08-05)
+
+#### Features
+
+* print out helpful error message for 403	 ([5d5a18a](/../../commit/5d5a18a))
+* support publishing pacts for multiple consumers at the same time	 ([573e97c](/../../commit/573e97c))
+
+<a name="v1.28.4"></a>
+### v1.28.4 (2020-07-31)
+
+#### Bug Fixes
+
+* add missing require for PactBroker::Client::Error	 ([72eb796](/../../commit/72eb796))
+
+<a name="v1.28.3"></a>
+### v1.28.3 (2020-07-19)
+
+<a name="v1.28.2"></a>
+### v1.28.2 (2020-07-17)
+
+
+#### Bug Fixes
+
+* **create-version-tag**
+  * raise an error if the version does not exist rather than automatically creating it.	 ([2ed7a55](/../../commit/2ed7a55))
+
+
 <a name="v1.28.0"></a>
 ### v1.28.0 (2020-07-12)
 

data/README.md

@@ -42,13 +42,11 @@ Publish pacts to a Pact Broker.
 ### create-version-tag
 
 ```
-Usage:
-  pact-broker create-version-tag -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL -e, --version=VERSION
-
 Options:
   -a, --pacticipant=PACTICIPANT                            # The pacticipant name
   -e, --version=VERSION                                    # The pacticipant version
   -t, [--tag=TAG]                                          # Tag name for pacticipant version. Can be specified multiple times.
+      [--auto-create-version], [--no-auto-create-version]  # Automatically create the pacticipant version if it does not exist. Default: false
   -g, [--tag-with-git-branch], [--no-tag-with-git-branch]  # Tag pacticipant version with the name of the current git branch. Default: false
   -b, --broker-base-url=BROKER_BASE_URL                    # The base URL of the Pact Broker
   -u, [--broker-username=BROKER_USERNAME]                  # Pact Broker basic auth username

data/lib/pact_broker/client/base_client.rb

@@ -69,6 +69,12 @@ module PactBroker
           yield response
         elsif response.code == 404
           nil
+        elsif response.code == 403
+          message = "Authorization failed (insufficient permissions)"
+          if response.body && response.body.size > 0
+            message = message + ": #{response.body}"
+          end
+          raise Error.new(message)
         elsif response.code == 401
           message = "Authentication failed"
           if response.body && response.body.size > 0

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

@@ -8,6 +8,7 @@ module PactBroker
       class PactPublicationError < ::Thor::Error; end
       class WebhookCreationError < ::Thor::Error; end
       class AuthError < ::Thor::Error; end
+      class VersionCreationError < ::Thor::Error; end
 
       class Broker < CustomThor
         desc 'can-i-deploy', ''
@@ -52,6 +53,7 @@ module PactBroker
         method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
 
         def publish(*pact_files)
+          require 'pact_broker/client/error'
           validate_credentials
           validate_pact_files(pact_files)
           success = publish_pacts(pact_files)
@@ -64,6 +66,7 @@ module PactBroker
         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 :auto_create_version, type: :boolean, default: false, desc: "Automatically create the pacticipant version if it does not exist. Default: false"
         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"
@@ -80,7 +83,10 @@ module PactBroker
             options.pacticipant,
             options.version,
             tags,
+            options.auto_create_version,
             pact_broker_client_options)
+        rescue PactBroker::Client::Error => e
+          raise VersionCreationError.new(e.message)
         end
 
         method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that the version belongs to."

data/lib/pact_broker/client/create_tag.rb

@@ -6,30 +6,22 @@ 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
+      def self.call(pact_broker_base_url, pacticipant_name, version, tags, auto_create_version, pact_broker_client_options={})
+        new(pact_broker_base_url, pacticipant_name, version, tags, auto_create_version, pact_broker_client_options).call
       end
 
-      def initialize(pact_broker_base_url, pacticipant_name, version, tags, pact_broker_client_options)
+      def initialize(pact_broker_base_url, pacticipant_name, version, tags, auto_create_version, pact_broker_client_options)
         @pact_broker_base_url = pact_broker_base_url
         @pacticipant_name = pacticipant_name
         @version = version
         @tags = tags
+        @auto_create_version = auto_create_version
         @pact_broker_client_options = pact_broker_client_options
       end
 
       def call
+        ensure_version_exists if !auto_create_version
         tags.each do | tag |
-          # todo check that pacticipant exists first
           $stdout.puts "Tagging #{pacticipant_name} version #{version} as #{tag}"
           Retry.while_error do
             pact_broker_client.pacticipants.versions.tag pacticipant: pacticipant_name, version: version, tag: tag
@@ -39,11 +31,17 @@ module PactBroker
 
       private
 
-      attr_reader :pact_broker_base_url, :pacticipant_name, :version, :tags, :pact_broker_client_options
+      attr_reader :pact_broker_base_url, :pacticipant_name, :version, :tags, :auto_create_version, :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
+
+      def ensure_version_exists
+        if pact_broker_client.pacticipants.versions.find(pacticipant: pacticipant_name, version: version).nil?
+          raise PactBroker::Client::Error.new("Could not create tag. Version #{version} of #{pacticipant_name} does not exist.")
+        end
+      end
     end
   end
 end

data/lib/pact_broker/client/git.rb

@@ -11,7 +11,7 @@ APPVEYOR_REPO_COMMIT APPVEYOR_REPO_BRANCH       https://www.appveyor.com/docs/en
 CI_COMMIT_REF_NAME https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
 CI_BRANCH CI_COMMIT_ID https://documentation.codeship.com/pro/builds-and-configuration/environment-variables/
 bamboo.repository.git.branch https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html
-BITBUCKET_BRANCH https://confluence.atlassian.com/bitbucket/variables-in-pipelines-794502608.html
+BITBUCKET_BRANCH BITBUCKET_COMMIT https://confluence.atlassian.com/bitbucket/variables-in-pipelines-794502608.html
 
 =end
 
@@ -21,6 +21,11 @@ module PactBroker
     module Git
       COMMAND = 'git name-rev --name-only HEAD'.freeze
       BRANCH_ENV_VAR_NAMES = %w{BUILDKITE_BRANCH CIRCLE_BRANCH TRAVIS_BRANCH GIT_BRANCH GIT_LOCAL_BRANCH APPVEYOR_REPO_BRANCH CI_COMMIT_REF_NAME BITBUCKET_BRANCH}.freeze
+      COMMIT_ENV_VAR_NAMES = %w{BUILDKITE_COMMIT CIRCLE_SHA1 TRAVIS_COMMIT GIT_COMMIT APPVEYOR_REPO_COMMIT CI_COMMIT_ID BITBUCKET_COMMIT}
+
+      def self.commit
+        find_commit_from_env_vars
+      end
 
       def self.branch
         find_branch_from_env_vars || branch_from_git_command
@@ -28,11 +33,15 @@ module PactBroker
 
       # private
 
+      def self.find_commit_from_env_vars
+        COMMIT_ENV_VAR_NAMES.collect { |env_var_name| value_from_env_var(env_var_name) }.compact.first
+      end
+
       def self.find_branch_from_env_vars
-        BRANCH_ENV_VAR_NAMES.collect { |env_var_name| branch_from_env_var(env_var_name) }.compact.first
+        BRANCH_ENV_VAR_NAMES.collect { |env_var_name| value_from_env_var(env_var_name) }.compact.first
       end
 
-      def self.branch_from_env_var(env_var_name)
+      def self.value_from_env_var(env_var_name)
         val = ENV[env_var_name]
         if val && val.strip.size > 0
           val

data/lib/pact_broker/client/publish_pacts.rb

@@ -52,6 +52,10 @@ module PactBroker
         @pact_files ||= pact_file_paths.collect{ |pact_file_path| PactFile.new(pact_file_path) }
       end
 
+      def consumer_names
+        pact_files.collect(&:consumer_name).uniq
+      end
+
       def publish_pact pact
         begin
           $stdout.puts "Publishing #{pact.pact_name} to pact broker at #{pact_broker_base_url}"
@@ -72,12 +76,14 @@ module PactBroker
       def tag_consumer_version tag
         versions = pact_broker_client.pacticipants.versions
         Retry.while_error do
-          $stdout.puts "Tagging version #{consumer_version} of #{consumer_name} as #{tag.inspect}"
-          versions.tag(pacticipant: consumer_name, version: consumer_version, tag: tag)
-          true
+          consumer_names.collect do | consumer_name |
+            $stdout.puts "Tagging version #{consumer_version} of #{consumer_name} as #{tag.inspect}"
+            versions.tag(pacticipant: consumer_name, version: consumer_version, tag: tag)
+            true
+          end
         end
       rescue => e
-        $stderr.puts "Failed to tag version #{consumer_version} of #{consumer_name} due to error: #{e.class} - #{e}}"
+        $stderr.puts "Failed to tag versions due to error: #{e.class} - #{e}"
         false
       end
 
@@ -94,10 +100,6 @@ module PactBroker
         end
       end
 
-      def consumer_name
-        pact_files.first.consumer_name
-      end
-
       def validate
         raise PactBroker::Client::Error.new("Please specify the consumer_version") unless (consumer_version && consumer_version.to_s.strip.size > 0)
         raise PactBroker::Client::Error.new("Please specify the pact_broker_base_url") unless (pact_broker_base_url && pact_broker_base_url.to_s.strip.size > 0)

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.28.0'
+    VERSION = '1.29.0'
   end
 end

data/lib/pact_broker/client/versions/describe.rb

@@ -28,7 +28,7 @@ module PactBroker
 
         def call
           version_hash = if params[:version]
-            versions_client.find params
+            versions_client.find(params)
           else
             pact_broker_client.pacticipants.versions.latest(params)
           end

data/script/trigger-release.sh

@@ -1,14 +1,30 @@
-#!/bin/bash
+#!/bin/sh
 
-output=$(curl -v -X POST https://api.github.com/repos/pact-foundation/pact_broker-client/dispatches \
+# Script to trigger release of gem via the pact-foundation/release-gem action
+# Requires a Github API token with repo scope stored in the
+# environment variable GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES
+
+: "${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES:?Please set environment variable GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}"
+
+if [ -n "$1" ]; then
+  increment="\"${1}\""
+else
+  increment="null"
+fi
+
+repository_slug=$(git remote get-url $(git remote show) | cut -d':' -f2 | sed 's/\.git//')
+
+output=$(curl -v -X POST https://api.github.com/repos/${repository_slug}/dispatches \
       -H 'Accept: application/vnd.github.everest-preview+json' \
-      -H "Authorization: Bearer $GITHUB_ACCESS_TOKEN" \
-      -d '{"event_type": "release-patch"}' 2>&1)
+      -H "Authorization: Bearer $GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES" \
+      -d "{\"event_type\": \"release-triggered\", \"client_payload\": {\"increment\": ${increment}}}" 2>&1)
 
 if  ! echo "${output}" | grep "HTTP\/1.1 204" > /dev/null; then
-  echo "$output" | sed  "s/${GITHUB_ACCESS_TOKEN}/****/g"
-  echo "Failed to do the thing"
+  echo "$output" | sed  "s/${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}/********/g"
+  echo "Failed to trigger release"
   exit 1
+else
+  echo "Release workflow triggered"
 fi
 
-echo "See https://github.com/pact-foundation/pact_broker-client/actions?query=workflow%3A%22Release+gem%22"
+echo "See https://github.com/${repository_slug}/actions?query=workflow%3A%22Release+gem%22"

data/spec/integration/create_version_tag_spec.rb

@@ -5,7 +5,7 @@ describe "pact-broker create-version-tag", skip_windows: true do
   end
 
   context "when the version is successfully tagged" do
-    subject { `bundle exec bin/pact-broker create-version-tag --pacticipant Condor --version 1.3.0 --tag prod --broker-base-url http://localhost:5001` }
+    subject { `bundle exec bin/pact-broker create-version-tag --auto-create-version --pacticipant Condor --version 1.3.0 --tag prod --broker-base-url http://localhost:5001` }
 
     it "returns a success exit code" do
       subject

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

@@ -81,6 +81,25 @@ module PactBroker
           end
         end
 
+        context "when publishing multiple files with different consumers" do
+          let(:pact_file_paths) { ['spec/pacts/consumer-provider.json','spec/pacts/foo-bar.json']}
+          let(:tags) { ['dev'] }
+
+          it "tags each consumer" do
+            expect(pact_versions_client).to receive(:tag).with(
+              pacticipant: "Consumer",
+              version: consumer_version,
+              tag: "dev"
+            )
+            expect(pact_versions_client).to receive(:tag).with(
+              pacticipant: "Foo",
+              version: consumer_version,
+              tag: "dev"
+            )
+            subject.call
+          end
+        end
+
         context "when publishing one or more pacts fails" do
           let(:pact_file_paths) { ['spec/pacts/consumer-provider.json','spec/pacts/foo-bar.json']}
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.28.0
+  version: 1.29.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-12 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty