pact_broker-client 1.13.1 → 1.14.0

data/doc/pacts/markdown/README.md

@@ -0,0 +1,3 @@
+### Pacts for Pact Broker Client
+
+* [Pact Broker](Pact Broker Client - Pact Broker.md)

data/example/scripts/README.md

@@ -0,0 +1,13 @@
+# Example scripts
+
+These are designed to be run from the top level of the pact_broker-client repository.
+
+You will need to set your own values for `PACT_BROKER_BASE_URL`, `PACT_BROKER_USERNAME`, and `PACT_BROKER_PASSWORD`
+
+eg.
+
+    export PACT_BROKER_BASE_URL="http://..."
+    export PACT_BROKER_USERNAME="username"
+    export PACT_BROKER_PASSWORD="password"
+    example/scripts/publish-pact.sh
+    example/scripts/publish-verification.sh

data/example/scripts/deploy-consumer.sh

@@ -0,0 +1,26 @@
+version="1"
+stage="development"
+application="A"
+
+export PACT_BROKER_CLIENT="bundle exec bin/pact-broker"
+export PACT_BROKER_BASE_URL="http://localhost:9292"
+
+can_i_deploy_output=$(${PACT_BROKER_CLIENT} can-i-deploy --pacticipant ${application} --version ${version})
+can_i_deploy_exit_code=$?
+
+set -e
+
+echo "${can_i_deploy_output}"
+
+if [[ "${can_i_deploy_exit_code}" == "0" ]]; then
+  existing_tags=$(${PACT_BROKER_CLIENT} describe-version --pacticipant ${application} --version ${version} --output json | jq "[._embedded.tags[].name]" | jq 'join("\n")' --raw-output)
+  if [ $(echo "${existing_tags}" | grep "${stage}") ]; then
+    echo "Version ${version} of ${application} has already been deployed to ${stage}"
+  else
+    echo "Deploying version ${version} of ${application} to ${stage}"
+    # do deployment here
+    ${PACT_BROKER_CLIENT} create-version-tag --pacticipant ${application} --version ${version} --tag ${stage}
+  fi
+else
+  echo "Cannot currently deploy version ${version} of ${application} to ${stage}"
+fi

data/example/scripts/pact.json

@@ -0,0 +1,67 @@
+{
+  "provider": {
+    "name": "Animal Service"
+  },
+  "consumer": {
+    "name": "Zoo App"
+  },
+  "interactions": [
+    {
+      "description": "a request for an alligator",
+      "provider_state": "there is an alligator named Mary",
+      "request": {
+        "method": "get",
+        "path": "/alligators/Mary",
+        "headers": {
+          "Accept": "application/json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/json;charset=utf-8"
+        },
+        "body": {
+          "name": "Mary"
+        }
+      }
+    },
+    {
+      "description": "a request for an alligator",
+      "provider_state": "there is not an alligator named Mary",
+      "request": {
+        "method": "get",
+        "path": "/alligators/Mary",
+        "headers": {
+          "Accept": "application/json"
+        }
+      },
+      "response": {
+        "status": 404
+      }
+    },
+    {
+      "description": "a request for an alligator",
+      "provider_state": "an error occurs retrieving an alligator",
+      "request": {
+        "method": "get",
+        "path": "/alligators/Mary",
+        "headers": {
+          "Accept": "application/json"
+        }
+      },
+      "response": {
+        "status": 500,
+        "headers": {
+          "Content-Type": "application/json;charset=utf-8"
+        },
+        "body": {
+          "error": "Argh!!!"
+        }
+      }
+    }
+  ],
+  "metadata": {
+    "pactSpecificationVersion": "1.0.0"
+  }
+}

data/example/scripts/publish-pact.sh

@@ -0,0 +1,3 @@
+# assumes you've set PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD already
+
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version=1.0.0 --tag master

data/example/scripts/publish-verification.sh

@@ -0,0 +1,3 @@
+response_body=$(curl -u ${PACT_BROKER_USERNAME}:${PACT_BROKER_PASSWORD} ${PACT_BROKER_BASE_URL}/pacts/provider/Animal%20Service/consumer/Zoo%20App/latest)
+verification_url=$(echo "${response_body}" | ruby -e "require 'json'; puts JSON.parse(ARGF.read)['_links']['pb:publish-verification-results']['href']")
+curl -XPOST -u ${PACT_BROKER_USERNAME}:${PACT_BROKER_PASSWORD} -H 'Content-Type: application/json' -d@$(dirname "$0")/verification.json ${verification_url}

data/example/scripts/verification.json

@@ -0,0 +1,4 @@
+{
+  "success": true,
+  "providerApplicationVersion": "2.0.0"
+}

data/lib/pact_broker/client/base_client.rb

@@ -41,6 +41,7 @@ module PactBroker
         @client_options = options[:client_options] || {}
         @verbose = @client_options[:verbose]
         self.class.base_uri base_url
+        self.class.debug_output($stderr) if verbose?
         self.class.basic_auth(client_options[:basic_auth][:username], client_options[:basic_auth][:password]) if client_options[:basic_auth]
       end
 
@@ -62,7 +63,7 @@ module PactBroker
 
       def handle_response response
         if response.success?
-          yield
+          yield response
         elsif response.code == 404
           nil
         elsif response.code == 401
@@ -97,6 +98,21 @@ module PactBroker
         self.class.get(url, *args)
       end
 
+      def url_for_relation relation_name, params
+        handle_response(get("/", headers: default_get_headers)) do | response |
+          relation = (JSON.parse(response.body)['_links'] || {})[relation_name]
+          if relation
+            url = relation['href']
+            params.each do | (key, value) |
+              url = url.gsub("{#{key}}", value)
+            end
+            url
+          else
+            raise PactBroker::Client::RelationNotFound.new("Could not find relation #{relation_name} in index resource. Try upgrading your Pact Broker as the feature you require may not exist in your version.")
+          end
+        end
+      end
+
       def verbose?
         @verbose
       end

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

@@ -7,6 +7,7 @@ require 'pact_broker/client/publish_pacts'
 require 'rake/file_list'
 require 'thor/error'
 require 'pact_broker/client/create_tag'
+require 'pact_broker/client/versions/describe'
 
 module PactBroker
   module Client
@@ -72,6 +73,32 @@ module PactBroker
             pact_broker_client_options)
         end
 
+        method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that the version belongs to."
+        method_option :version, required: false, aliases: "-e", desc: "The pacticipant version number."
+        method_option :latest, required: false, aliases: "-l", banner: '[TAG]', desc: "Describe the latest pacticipant version. Optionally specify a TAG to describe 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"
+        method_option :output, aliases: "-o", desc: "json or table or id", default: 'table'
+        method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+
+        desc 'describe-version', 'Describes a pacticipant version. If no version or tag is specified, the latest version is described.'
+        def describe_version
+          latest = !options.latest.nil? || (options.latest.nil? && options.version.nil?)
+          params = {
+            pacticipant: options.pacticipant,
+            version: options.version,
+            latest: latest,
+            tag: options.latest != "latest" ? options.latest : nil
+          }
+          opts = {
+            output: options.output
+          }
+          result = PactBroker::Client::Versions::Describe.call(params, opts, options.broker_base_url, pact_broker_client_options)
+          $stdout.puts result.message
+          exit(1) unless result.success
+        end
+
         desc 'version', "Show the pact_broker-client gem version"
         def version
           $stdout.puts PactBroker::Client::VERSION

data/lib/pact_broker/client/cli/can_i_deploy_long_desc.txt

@@ -1,20 +1,30 @@
 Returns exit code 0 or 1, indicating whether or not the specified pacticipant versions are compatible. Prints out the relevant pact/verification details.
 
-WARNING! This feature is in beta release, and backwards compatibility is NOT guaranteed. You will need the latest version of the Pact Broker for this feature to work.
-
 The environment variables PACT_BROKER_BASE_URL_BASE_URL, PACT_BROKER_BASE_URL_USERNAME and PACT_BROKER_BASE_URL_PASSWORD may be used instead of their respective command line options.
 
 SCENARIOS
 
+# If every build goes straight to production
+
 Check the status of the pacts for a pacticipant version. Note that this only checks that the most recent verification for each pact is successful. It doesn't provide any assurance that the pact has been verified by the *production* version of the provider, however, it is sufficient if you are doing true continuous deployment.
 
   $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --broker-base-url BROKER_BASE_URL
 
+# If every build does NOT go straight to production
+
+## Recommended approach
+
 If all applications within the pact network are not being deployed continuously (ie. if there is a gap between pact verification and actual deployment) then the following strategy is recommended. Each application version should be tagged in the broker with the name of the stage (eg. test, staging, production) as it is deployed (see the pact-broker create-version-tag CLI). This enables you to use the following very simple command to check if the application version you are about to deploy is compatible with every other application version already deployed in that environment.
 
   $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --to TAG --broker-base-url BROKER_BASE_URL
 
-Check the status of the pacts for the latest pacticipant version:
+## Other approaches
+
+If you do not/cannot tag every application at deployment, you have two options. You can either use the very first form of this command which just checks that the *latest* verification is successful (not recommended as it's the production version that you really care about) or you will need to determine the production versions of each collaborating application from some other source (eg. git) and explictly reference each one using one using the format `--pacticipant PACTICIPANT1 --version VERSION1 --pacticipant PACTICIPANT2 --version VERSION2 ...`
+
+# Other commands
+
+Check the status of the pacts for the latest pacticipant version. This form is not recommended for use in your CI as it is possible that the version you are about to deploy is not the the version that the Broker considers the latest. It's best to specify the version explictly.
 
   $ pact-broker can-i-deploy --pacticipant PACTICIPANT --latest --broker-base-url BROKER_BASE_URL
 

data/lib/pact_broker/client/error.rb

@@ -1,5 +1,7 @@
 module PactBroker
   module Client
     class Error < StandardError; end
+
+    class RelationNotFound < Error; end
   end
 end

data/lib/pact_broker/client/matrix.rb

@@ -10,8 +10,6 @@ module PactBroker
           latestby: latestby
         }.merge(query_options(options))
         response = self.class.get("/matrix", query: query, headers: default_get_headers)
-        $stdout.puts("DEBUG: Response headers #{response.headers}") if verbose?
-        $stdout.puts("DEBUG: Response body #{response}") if verbose?
         response = handle_response(response) do
           JSON.parse(response.body, symbolize_names: true)
         end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.13.1'
+    VERSION = '1.14.0'
   end
 end

data/lib/pact_broker/client/versions.rb

@@ -5,13 +5,23 @@ module PactBroker
   module Client
     class Versions < BaseClient
 
-
-      def latest options
-        query = options[:tag] ? {tag: options[:tag]} : {}
-        response = self.class.get("#{versions_base_url(options)}/latest", query: query, headers: default_get_headers)
+      def find options
+        response = get("#{version_base_url(options)}", headers: default_get_headers)
 
         handle_response(response) do
-          string_keys_to_symbols(response.to_hash)
+          JSON.parse(response.body, symbolize_names: true)
+        end
+      end
+
+      def latest options
+        puts options
+        url = if options[:tag]
+          url_for_relation('pb:latest-tagged-version', pacticipant: options.fetch(:pacticipant), tag: options.fetch(:tag))
+        else
+          url_for_relation('pb:latest-version', pacticipant: options.fetch(:pacticipant))
+        end
+        handle_response(get(url, headers: default_get_headers)) do | response |
+          JSON.parse(response.body, symbolize_names: true)
         end
       end
 

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

@@ -0,0 +1,60 @@
+require 'pact_broker/client/pact_broker_client'
+require 'pact_broker/client/versions/formatter'
+
+module PactBroker
+  module Client
+    class Versions
+      class Describe
+
+        class Result
+          attr_reader :success, :message
+
+          def initialize success, message = nil
+            @success = success
+            @message = message
+          end
+        end
+
+        def self.call params, options, pact_broker_base_url, pact_broker_client_options
+          new(params, options, pact_broker_base_url, pact_broker_client_options).call
+        end
+
+        def initialize params, options, pact_broker_base_url, pact_broker_client_options
+          @params = params
+          @options = options
+          @pact_broker_base_url = pact_broker_base_url
+          @pact_broker_client_options = pact_broker_client_options
+        end
+
+        def call
+          version_hash = if params[:version]
+            versions_client.find params
+          else
+            pact_broker_client.pacticipants.versions.latest(params)
+          end
+          if version_hash
+            Result.new(true, format_version(version_hash))
+          else
+            Result.new(false, "Pacticipant version not found")
+          end
+        end
+
+        private
+
+        def format_version(version_hash)
+          Formatter.call(version_hash, options[:output])
+        end
+
+        attr_reader :params, :options, :pact_broker_base_url, :pact_broker_client_options
+
+        def versions_client
+          pact_broker_client.pacticipants.versions
+        end
+
+        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
+end

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

@@ -0,0 +1,20 @@
+require 'pact_broker/client/versions/json_formatter'
+require 'pact_broker/client/versions/text_formatter'
+
+module PactBroker
+  module Client
+    class Versions
+      class Formatter
+        def self.call(matrix_lines, format)
+          formatter = case format
+          when 'json' then JsonFormatter
+          when 'table' then TextFormatter
+          else
+            raise PactBroker::Client::Error.new("Invalid output option '#{format}. Must be one of 'table' or 'json'.")
+          end
+          formatter.call(matrix_lines)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'table_print'
+
+module PactBroker
+  module Client
+    class Versions
+      class JsonFormatter
+        def self.call(matrix)
+          JSON.pretty_generate(matrix)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require 'table_print'
+
+module PactBroker
+  module Client
+    class Versions
+      class TextFormatter
+
+        Line = Struct.new(:number, :tags)
+
+        OPTIONS = [
+          { number: {} },
+          { tags: {} }
+        ]
+
+        def self.call(version_hash)
+          tags = (lookup(version_hash, [], :_embedded, :tags) || []).collect{ | t| t[:name] }.join(" ")
+          data = Line.new(version_hash[:number], tags)
+
+          printer = TablePrint::Printer.new([data], OPTIONS)
+          printer.table_print
+        end
+
+        def self.lookup line, default, *keys
+          keys.reduce(line) { | line, key | line[key] }
+        rescue NoMethodError
+          default
+        end
+      end
+    end
+  end
+end

data/spec/integration/can_i_deploy_spec.rb

@@ -5,7 +5,7 @@ describe "pact-broker can-i-deploy" do
   end
 
   context "when the pacticipants can be deployed" do
-    subject { `bundle exec bin/pact-broker can-i-deploy -v --pacticipant Foo --version 1.2.3 --pacticipant Bar --version 4.5.6 --broker-base-url http://localhost:5000` }
+    subject { `bundle exec bin/pact-broker can-i-deploy --pacticipant Foo --version 1.2.3 --pacticipant Bar --version 4.5.6 --broker-base-url http://localhost:5000` }
 
     it "returns a success exit code" do
       subject
@@ -18,7 +18,7 @@ describe "pact-broker can-i-deploy" do
   end
 
   context "when the pacticipants can't be deployed" do
-    subject { `bundle exec bin/pact-broker can-i-deploy -v --pacticipant Wiffle --version 1.2.3 --pacticipant Meep --version 4.5.6 --broker-base-url http://localhost:5000` }
+    subject { `bundle exec bin/pact-broker can-i-deploy --pacticipant Wiffle --version 1.2.3 --pacticipant Meep --version 4.5.6 --broker-base-url http://localhost:5000` }
 
     it "returns an error exit code" do
       subject