pact_broker-client 1.28.1 → 1.28.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0594e8363c37a845751df4f6d43a6a91fc7f54ac82de0bcea21b83ec02537a0
-  data.tar.gz: 34106b65fa2e619195881b2e64de303fb010a68979ee5a95ba47aa34b2e76690
+  metadata.gz: 75733826388c0e949cc668a58d42f2020383afab1a5434f0357a3f8e4b807042
+  data.tar.gz: 536c574d886e62b61b76ec9d6e19c20719fb61facf5d75537cf882841515c364
 SHA512:
-  metadata.gz: 40fe92403a62268fd688e6d0a6f47e237bcc946e345f99bafc31adc803905a7859af00241b3f9293f898e548d6e0aadd80767de8fb14952d5442a05e9cb80326
-  data.tar.gz: 3fe4645ba758d96a53c6f1dbc0a0faf1129ca8e7ef6e3c62f8be2c677e43bc139071835491d17040a9e47312f3cc2b49a7ad0454d1de14f8ae245719db1a3d1b
+  metadata.gz: 96ddbb368e99906b3a7b8d69d118283edfad013e8ed605af7430cca7babcbfe0f10bb1ffd43b7dec98cbe134368d48f811b04454aa60baa431eb81ac4b2856bb
+  data.tar.gz: 971e100f31ec4a5ea338e60d6f6e0f13f924430f98b40d637e23d2d80be39c243ac4ea0cd9905515563de486d3cb35b7e79993a92fea0884f499e987381d55b3

data/.github/workflows/release_gem.yml

@@ -3,23 +3,41 @@ name: Release gem
 on:
   repository_dispatch:
     types:
-      - release
+      - release-triggered
 
 jobs:
-  build:
+  release:
     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.10
+      id: release
       env:
         GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_API_KEY }}'
         GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
         INCREMENT: '${{ github.event.client_payload.increment }}'
-    - 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
+  dispatch:
+    needs: release
+    strategy:
+      matrix:
+        repository: [pact-foundation/pact-ruby-cli, pact-foundation/pact-ruby-standalone]
+    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/CHANGELOG.md

@@ -1,3 +1,13 @@
+<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/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', ''
@@ -64,6 +65,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 +82,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/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.28.1'
+    VERSION = '1.28.2'
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.28.1
+  version: 1.28.2
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -218,7 +218,6 @@ files:
 - pact-broker-client.gemspec
 - script/generate-cli-usage.sh
 - script/publish-pact.sh
-- script/release-via-github-action.sh
 - script/release.sh
 - script/trigger-release.sh
 - spec/integration/can_i_deploy_spec.rb

data/script/release-via-github-action.sh

@@ -1,7 +0,0 @@
-#!/bin/sh
-set +e
-
-git tag -d release
-git push --delete origin release
-git tag -a release -m "chore: releasing"
-git push origin release