pact-mock_service 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 199d51223a496a48e6ab4ca142d1a1c9fdac4a0b
-  data.tar.gz: 19d3aa4d3228559d5ceb27e7678d3f27842b0eeb
+  metadata.gz: 19d534d5cb2a38d99b0cb36e8f4c373e7452d708
+  data.tar.gz: 4bcd7d9c3438fdd76aaed92ac9823946285d5789
 SHA512:
-  metadata.gz: 3ade3ab0ddb3feb73edcca000b9fa99ba0e82d373859f8accf0b1e4b532ad1b7ecfc48b0ee27a208624da6d1a528099a14ebc277c0afe53a0362a1f2f812f528
-  data.tar.gz: a2916297569c675ab1ad635ce883b162fc54f5c030de1e326879b521bd89882576b47a253d836fd5d24e89ba5b3ac230ed730d65e6dda14ee99334c281b7bd3a
+  metadata.gz: 182e56ac2b5e437f4d5014e6c4e816a4a7f90d338243d90471fcbe6c9222cf60c76511bcada3766850c58989587fe860698722c00054e5a2f57a6d191c4e975a
+  data.tar.gz: 918ebb1400b5b9180f2a28b49ae9cd032b6209c22ad1b35b5746c8fd70c8a0066c3f777a9daba9dc0dbfdf6043622228eaee9d53a066d7d3ec5e389c968ad221

data/CHANGELOG.md

@@ -2,6 +2,9 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)' vX.Y.Z..HEAD
 
+### 2.5.0 (2017-10-28)
+* bc15e21 - feat(pact-stub-service): handle case where multiple responses match (Beth Skurrie, Sat Oct 28 09:15:55 2017 +1100)
+
 ### 2.4.0 (2017-10-13)
 * 56bd683 - feat(stub): add pact-stub-service CLI (Beth Skurrie, Fri Oct 13 08:20:49 2017 +1100)
 

data/README.md

@@ -1,9 +1,9 @@
 
-# Pact Mock Service
+# Pact Mock and Stub Service
 
 [![Build Status](https://travis-ci.org/pact-foundation/pact-mock_service.svg?branch=master)](https://travis-ci.org/pact-foundation/pact-mock_service)
 
-This codebase provides the HTTP mock service used by implementations of [Pact][pact]. It is packaged as a gem, and as a standalone executable for Mac OSX and Linux and Windows.
+This codebase provides the HTTP mock and stub service used by implementations of [Pact][pact]. It is packaged as a gem, and as a standalone executable for Mac OSX and Linux and Windows.
 
 The mock service provides the following endpoints:
 
@@ -40,15 +40,15 @@ Or add `gem "pact-mock_service"` to your Gemfile then run:
 
 Run `pact-mock-service help` for command line options.
 
-## Usage
+## Mock Service Usage
 
-The lifecycle of the a mock service instance during at test suite is as follows:
+Each mock service process is designed to mock only ONE provider. To mock multiple providers, you will need to start a process for each provider. The lifecycle of the a mock service instance during at test suite is as follows:
 
-_Before suite:_ start mock service
-_Before each test:_ clear interactions from previous test
-_During test:_ set up interactions, execute interactions
-_After each test:_ verify interactions
-_After suite:_ write pact file, stop mock service
+* _Before suite:_ start mock service
+* _Before each test:_ clear interactions from previous test
+* _During test:_ set up interactions, execute interactions
+* _After each test:_ verify interactions
+* _After suite:_ write pact file, stop mock service
 
 Each mock service instance can only handle one test process/thread at a time. If you wish to run multiple test threads in parallel, you will need to start each mock service instance on a different port, and set the `--pact-file-write-mode` to `merge` (see usage notes below).
 
@@ -73,7 +73,7 @@ Options:
       [--sslcert=SSLCERT]                                        # Specify the path to the SSL cert to use when running the service over HTTPS
       [--sslkey=SSLKEY]                                          # Specify the path to the SSL key to use when running the service over HTTPS
 
-Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown.
+Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT).
 ```
 
 See [script/example.sh](script/example.sh) for an executable example.
@@ -94,6 +94,34 @@ If you need to provide your own certificate and key, use the following syntax.
 
 Read the wiki page on [CORS][cors].
 
+## Stub Service Usage
+
+The pact-stub-service allows you to reuse interactions that have been generated in previous tests. The typical situation would be to generate your pact file using unit tests, and then use the pact stub service for your higher level integration/ui tests. To help reduce the number of interactions that need verifying, you will want to use flexible matching on both requests and responses.
+
+Unlike the mock service, which has a Ruby DSL for managing its lifecycle, the mock service can currently only be started from the command line, so you will need to start/background/kill the process yourself. If this is causing problems, please raise it in the pact-dev google group and we can discuss potential enhancements.
+
+```
+Usage:
+  pact-stub-service PACT ...
+
+Options:
+  -p, [--port=PORT]        # Port on which to run the service
+  -h, [--host=HOST]        # Host on which to bind the service
+                           # Default: localhost
+  -l, [--log=LOG]          # File to which to log output
+  -o, [--cors=CORS]        # Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses
+      [--ssl], [--no-ssl]  # Use a self-signed SSL cert to run the service over HTTPS
+      [--sslcert=SSLCERT]  # Specify the path to the SSL cert to use when running the service over HTTPS
+      [--sslkey=SSLKEY]    # Specify the path to the SSL key to use when running the service over HTTPS
+
+Description:
+  Start a stub service with the given pact file(s). Where multiple matching interactions are found, the
+  interactions will be sorted by response status, and the first one will be returned. This may lead to some
+  non-deterministic behaviour. If you are having problems with this, please raise it on the pact-dev google
+  group, and we can discuss some potential enhancements. Note that only versions 1 and 2 of the pact
+  specification are currently supported.
+```
+
 ## Contributing
 
 See [CONTRIBUTING.md](/CONTRIBUTING.md)

data/lib/pact/consumer_contract/consumer_contract_writer.rb

@@ -13,7 +13,7 @@ module Pact
 
   class ConsumerContractWriter
 
-    DEFAULT_PACT_SPECIFICATION_VERSION = '1.0.0'
+    DEFAULT_PACT_SPECIFICATION_VERSION = '2.0.0'
 
     include Pact::FileName
     include Pact::PactFile

data/lib/pact/mock_service/app.rb

@@ -20,7 +20,7 @@ module Pact
         logger = Logger.from_options(options)
         @name = options.fetch(:name, "MockService")
         @session = Session.new(options.merge(logger: logger))
-        setup_stub(options[:stub_pactfile_paths]) if options[:stub_pactfile_paths] && options[:stub_pactfile_paths].any?
+        setup_stub(options[:stub_pactfile_paths]) if options[:stub_pactfile_paths]
         request_handlers = RequestHandlers.new(@name, logger, @session, options)
         @app = Rack::Builder.app do
           use Pact::Consumer::MockService::ErrorHandler, logger
@@ -39,7 +39,7 @@ module Pact
 
       def setup_stub stub_pactfile_paths
         stub_pactfile_paths.each do | pactfile_path |
-          $stdout.puts "Loading interactions from #{pactfile_path}"
+          $stdout.puts "INFO: Loading interactions from #{pactfile_path}"
           hash_interactions = JSON.parse(File.read(pactfile_path))['interactions']
           interactions = hash_interactions.collect { | hash | Interaction.from_hash(hash) }
           @session.set_expected_interactions interactions
@@ -49,7 +49,7 @@ module Pact
       def write_pact_if_configured
         consumer_contract_writer = ConsumerContractWriter.new(@session.consumer_contract_details, StdoutLogger.new)
         if consumer_contract_writer.can_write? && !@session.pact_written?
-          $stdout.puts "Writing pact before shutting down"
+          $stdout.puts "INFO: Writing pact before shutting down"
           consumer_contract_writer.write
         end
       end

data/lib/pact/mock_service/cli.rb

@@ -13,14 +13,14 @@ module Pact
       PACT_FILE_WRITE_MODE_DESC = "`overwrite` or `merge`. Use `merge` when running multiple mock service instances in parallel for the same consumer/provider pair." +
       " Ensure the pact file is deleted before running tests when using this option so that interactions deleted from the code are not maintained in the file."
 
-      desc 'service', "Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown."
+      desc 'service', "Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT)."
       method_option :consumer, desc: "Consumer name"
       method_option :provider, desc: "Provider name"
       method_option :port, aliases: "-p", desc: "Port on which to run the service"
       method_option :host, aliases: "-h", desc: "Host on which to bind the service", default: 'localhost'
       method_option :pact_dir, aliases: "-d", desc: "Directory to which the pacts will be written"
       method_option :pact_file_write_mode, aliases: "-m", desc: PACT_FILE_WRITE_MODE_DESC, type: :string, default: 'overwrite'
-      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact", default: '1'
+      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.", default: '2'
       method_option :log, aliases: "-l", desc: "File to which to log output"
       method_option :cors, aliases: "-o", desc: "Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses"
       method_option :ssl, desc: "Use a self-signed SSL cert to run the service over HTTPS", type: :boolean, default: false
@@ -38,7 +38,7 @@ module Pact
       method_option :pact_dir, aliases: "-d", desc: "Directory to which the pacts will be written"
       method_option :log_dir, aliases: "-l", desc: "File to which to log output"
       method_option :pact_file_write_mode, aliases: "-m", desc: PACT_FILE_WRITE_MODE_DESC, type: :string, default: 'overwrite'
-      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact", default: '1'
+      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.", default: '2'
       method_option :cors, aliases: "-o", desc: "Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses"
       method_option :ssl, desc: "Use a self-signed SSL cert to run the service over HTTPS", type: :boolean, default: false
       method_option :sslcert, desc: "Specify the path to the SSL cert to use when running the service over HTTPS"
@@ -49,7 +49,7 @@ module Pact
         ControlServer::Run.(options)
       end
 
-      desc 'start', "Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown."
+      desc 'start', "Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT)."
       method_option :consumer, desc: "Consumer name"
       method_option :provider, desc: "Provider name"
       method_option :port, aliases: "-p", default: '1234', desc: "Port on which to run the service"
@@ -58,7 +58,7 @@ module Pact
       method_option :pact_file_write_mode, aliases: "-m", desc: PACT_FILE_WRITE_MODE_DESC, type: :string, default: 'overwrite'
       method_option :pid_dir, desc: "PID dir", default: 'tmp/pids'
       method_option :log, aliases: "-l", desc: "File to which to log output"
-      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact", default: '1'
+      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.", default: '2'
       method_option :cors, aliases: "-o", desc: "Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses"
       method_option :ssl, desc: "Use a self-signed SSL cert to run the service over HTTPS", type: :boolean, default: false
       method_option :sslcert, desc: "Specify the path to the SSL cert to use when running the service over HTTPS"
@@ -78,7 +78,7 @@ module Pact
         mock_service_pidfile.kill_process
       end
 
-      desc 'restart', "Start or restart a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown."
+      desc 'restart', "Start or restart a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown (INT)."
       method_option :consumer, desc: "Consumer name"
       method_option :provider, desc: "Provider name"
       method_option :port, aliases: "-p", default: '1234', desc: "Port on which to run the service"
@@ -87,7 +87,7 @@ module Pact
       method_option :pact_file_write_mode, aliases: "-m", desc: PACT_FILE_WRITE_MODE_DESC, type: :string, default: 'overwrite'
       method_option :pid_dir, desc: "PID dir", default: 'tmp/pids'
       method_option :log, aliases: "-l", desc: "File to which to log output"
-      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact", default: '1'
+      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.", default: '2'
       method_option :cors, aliases: "-o", desc: "Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses"
       method_option :ssl, desc: "Use a self-signed SSL cert to run the service over HTTPS", type: :boolean, default: false
       method_option :sslcert, desc: "Specify the path to the SSL cert to use when running the service over HTTPS"
@@ -103,7 +103,7 @@ module Pact
       method_option :port, aliases: "-p", desc: "Port on which to run the service", default: '1234'
       method_option :log_dir, aliases: "-l", desc: "File to which to log output", default: "log"
       method_option :pact_file_write_mode, aliases: "-m", desc: PACT_FILE_WRITE_MODE_DESC, type: :string, default: 'overwrite'
-      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact", default: '1'
+      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact", default: '2'
       method_option :pid_dir, desc: "PID dir", default: "tmp/pids"
       method_option :cors, aliases: "-o", desc: "Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses"
       method_option :ssl, desc: "Use a self-signed SSL cert to run the service over HTTPS", type: :boolean, default: false
@@ -130,7 +130,7 @@ module Pact
       method_option :log_dir, aliases: "-l", desc: "File to which to log output", default: "log"
       method_option :pact_dir, aliases: "-d", desc: "Directory to which the pacts will be written", default: "."
       method_option :pact_file_write_mode, aliases: "-m", desc: PACT_FILE_WRITE_MODE_DESC, type: :string, default: 'overwrite'
-      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact", default: '1'
+      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact. Note that only versions 1 and 2 are currently supported.", default: '2'
       method_option :pid_dir, desc: "PID dir", default: "tmp/pids"
       method_option :cors, aliases: "-o", desc: "Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses"
       method_option :ssl, desc: "Use a self-signed SSL cert to run the service over HTTPS", type: :boolean, default: false

data/lib/pact/mock_service/request_handlers/interaction_replay.rb

@@ -21,15 +21,16 @@ module Pact
         include Pact::Matchers
         include PrettyGenerate
 
-        attr_accessor :name, :logger, :expected_interactions, :actual_interactions, :verified_interactions
+        attr_accessor :name, :logger, :expected_interactions, :actual_interactions, :verified_interactions, :multiple_interactions_handler
 
-        def initialize name, logger, session, cors_enabled=false
+        def initialize name, logger, session, cors_enabled = false, stub = false
           @name = name
           @logger = logger
           @expected_interactions = session.expected_interactions
           @actual_interactions = session.actual_interactions
           @verified_interactions = session.verified_interactions
           @cors_enabled = cors_enabled
+          @multiple_interactions_handler = stub ? HandleMultipleInteractionsFoundForStub : HandleMultipleInteractionsFound
         end
 
         def match? env
@@ -62,7 +63,7 @@ module Pact
         end
 
         def handle_more_than_one_matching_interaction actual_request, matching_interactions
-          HandleMultipleInteractionsFound.call(actual_request, matching_interactions, logger)
+          multiple_interactions_handler.call(actual_request, matching_interactions, verified_interactions, actual_interactions, logger)
         end
 
         def handle_unrecognised_request actual_request, candidate_interactions
@@ -79,7 +80,7 @@ module Pact
 
         extend PrettyGenerate
 
-        def self.call actual_request, matching_interactions, logger
+        def self.call actual_request, matching_interactions, verified_interactions, actual_interactions, logger
           logger.error "Multiple interactions found for #{actual_request.method_and_path}:"
           matching_interactions.each do | interaction |
             logger.debug pretty_generate(Pact::MockService::InteractionDecorator.new(interaction))
@@ -103,6 +104,29 @@ module Pact
         end
       end
 
+      class HandleMultipleInteractionsFoundForStub
+
+        extend PrettyGenerate
+
+        def self.call actual_request, matching_interactions, verified_interactions, actual_interactions, logger
+          logger.warn "Multiple interactions found for #{actual_request.method_and_path}:"
+          matching_interactions.each do | interaction |
+            logger.debug pretty_generate(Pact::MockService::InteractionDecorator.new(interaction))
+          end
+          response actual_request, matching_interactions, verified_interactions, actual_interactions, logger
+        end
+
+        def self.response actual_request, matching_interactions, verified_interactions, actual_interactions, logger
+          logger.warn "Sorting responses by response status and returning first."
+          interaction = first_most_successful_interaction(matching_interactions)
+          HandleMatchedInteraction.call(interaction, verified_interactions, actual_interactions, logger)
+        end
+
+        def self.first_most_successful_interaction matching_interactions
+          matching_interactions.sort{ |i1, i2| Pact::Reification.from_term(i1.response.status) <=> Pact::Reification.from_term(i2.response.status) }.first
+        end
+      end
+
       class HandleUnrecognisedInteraction
 
         def self.call actual_request, candidate_interactions, actual_interactions, logger

data/lib/pact/mock_service/request_handlers.rb

@@ -33,7 +33,7 @@ module Pact
             LogGet.new(name, logger),
             PactPost.new(name, logger, session),
             IndexGet.new(name, logger),
-            InteractionReplay.new(name, logger, session, options[:cors_enabled])
+            InteractionReplay.new(name, logger, session, options[:cors_enabled], options[:stub_pactfile_paths])
           ]
         end
       end

data/lib/pact/mock_service/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module MockService
-    VERSION = "2.4.0"
+    VERSION = "2.5.0"
   end
 end

data/lib/pact/stub_service/cli.rb

@@ -10,7 +10,16 @@ module Pact
   module StubService
     class CLI < Pact::MockService::CLI::CustomThor
 
-      desc 'PACT ...', "Start a stub service with the given pact file(s). Note that this is in beta release, and no logic has been added to handle the situation where more than one matching interaction is found for a request. At the moment, an error response will be returned."
+      desc 'PACT ...', "Start a stub service with the given pact file(s)."
+      long_desc <<-DOC
+        Start a stub service with the given pact file(s).
+        Where multiple matching interactions are found, the interactions will be sorted by
+        response status, and the first one will be returned. This may lead to some non-deterministic
+        behaviour. If you are having problems with this, please raise it on the pact-dev google group,
+        and we can discuss some potential enhancements.
+        Note that only versions 1 and 2 of the pact specification are currently supported.
+      DOC
+
 
       method_option :port, aliases: "-p", desc: "Port on which to run the service"
       method_option :host, aliases: "-h", desc: "Host on which to bind the service", default: 'localhost'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-mock_service
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-12 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack