pact-mock_service 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cf900a12d4f91a4ff30a3e9f524f989ffedca18
-  data.tar.gz: ac91a2457b5d83c349c70663682dfae00e22af08
+  metadata.gz: e7ba885324798c8512e3957562c9c07f903ef605
+  data.tar.gz: 7c8718131be50169a6a1d8341905b20e25b4e73d
 SHA512:
-  metadata.gz: 296f813db0e501057558d0cdb241b56fba89144be5822f2aac010b9cfbdabf960ae644a4a508eb6ae37192b042901f3180a093a210e7c3372ee20ba3db487598
-  data.tar.gz: fbc2b07d41210eaf4fafe758e6135c9ca41bfe9038a5d8f327eb5dd86ef6fb9a89d81d82f0a4caaa8a0fbf6a1c46f2b1c68ce2efc7e0444f3792631a3cf57c0a
+  metadata.gz: abbd1c16191e86672a8aac3217836bf98190ff218c84362f99faaa4618e6802327e697b1d9dec1433f05a263f5994ec4c68c4b20ea983e1e4066de8f37b4ff8a
+  data.tar.gz: d811402182f55a9b91ef04f122f02da0ba5ea7ff0168c57332e2ceac000976b861206812c67fd647ff87f2e20dac5f2f9aade0166322ac0fa4a9e6161cb5b858

data/CHANGELOG.md

@@ -2,6 +2,14 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)' vX.Y.Z..HEAD
 
+### 2.3.0 (2017-20-04)
+* 79cbdc9 - feat: add example script showing usage (Beth Skurrie, Wed Oct 4 13:42:06 2017 +1100)
+* 873d9ee - feat: only write pact on shutdown of mock service if pact has not already been written (Beth Skurrie, Wed Oct 4 13:41:01 2017 +1100)
+* d3c6067 - feat(cli): add --pact-file-write-mode to cli and remove --unique-pact-file-names (Beth Skurrie, Wed Oct 4 08:01:25 2017 +1100)
+* 476ae5c - feat: only include backtrace in error response for standard errors, not for pact::error (Beth Skurrie, Tue Oct 3 16:40:06 2017 +1100)
+* a76dc7e - feat: add 'merge' pactfile_write_mode (Beth Skurrie, Tue Oct 3 10:13:36 2017 +1100)
+* d0d82f2 - feat: use file locking to ensure pact file isn't corrupted when running multiple mock services in parallel (Beth Skurrie, Mon Oct 2 08:32:34 2017 +1100)
+
 ### 2.2.0 (2017-09-30)
 * 3949e3d - feat(cli): add --unique-pact-file-names option (Beth Skurrie, Thu Sep 28 11:16:22 2017 +1000)
 

data/README.md

@@ -1,42 +1,86 @@
+
 # Pact Mock 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 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 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:
 
 * DELETE /interactions - clear previously mocked interactions
 * POST /interactions - set up an expected interaction
+* PUT /interactions - clear and set up multiple expected interactions in one call
 * GET /interactions/verification - determine whether the expected interactions have taken place
 * POST /pact - write the pact file
+* GET / - the healthcheck endpoint
 
-As the Pact mock service can be used as a standalone executable and administered via HTTP, it can be used for testing with any language. All that is required is a library in the native language to create the HTTP calls listed above. Check out [docs.pact.io](https://docs.pact.io) for a list of implemented languages. If you are interested in creating bindings in a new langauge, and have a chat to one of us on the [pact-dev Google group][pact-dev].
+All requests to the "administration" endpoints listed above must contain the header `X-Pact-Mock-Service: true` to allow the mock service to know whether the request is an administration request or a request from the actual consumer code.
 
-## Documentation
+As the Pact mock service can be used as a standalone executable and administered via HTTP, it can be used for testing with any language. All that is required is a library in the native language to create the HTTP calls listed above. Check out [docs.pact.io](https://docs.pact.io) for a list of implemented languages. If you are interested in creating bindings in a new langauge, and have a chat to one of us on the [pact-dev Google group][pact-dev].
 
-You can find documentation for the mock service in the repository [wiki][wiki].
+## Installation
 
-## Usage
+### Without Ruby
 
-For some examples of the HTTP requests that occur under the hood when using either the Ruby client or the Javascript client, see this [gist](https://gist.github.com/bethesque/9d81f21d6f77650811f4).
+Use the Pact standalone [executables][executables].
 
-### Mac OSX, Linux and Windows, without Ruby
+### With Ruby
 
-See the [releases][releases] page for the latest standalone executables.
+Use the [pact][pact] gem if you would like the full Pact DSL, mock service and verification functionality in your ruby project.
 
-### With Ruby on Mac OSX and Linux
+Otherwise:
 
     $ gem install pact-mock_service
-    $ pact-mock-service --port 1234
+    $ pact-mock-service --consumer Foo --provider Bar --port 1234
+
+Or add `gem "pact-mock_service"` to your Gemfile then run:
+
+    $ bundle install
+    $ bundle exec pact-mock-service --consumer Foo --provider Bar --port 1234
 
 Run `pact-mock-service help` for command line options.
 
-### With Ruby on Windows
+## Usage
+
+The lifecycle of the a mock service instance during at test suite is as follows:
 
-Check out the wiki page [here][install-windows].
+_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
 
-#### With SSL
+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).
+
+```
+Usage:
+  pact-mock-service service
+
+Options:
+      [--consumer=CONSUMER]                                      # Consumer name
+      [--provider=PROVIDER]                                      # Provider name
+  -p, [--port=PORT]                                              # Port on which to run the service
+  -h, [--host=HOST]                                              # Host on which to bind the service
+                                                                 # Default: localhost
+  -d, [--pact-dir=PACT_DIR]                                      # Directory to which the pacts will be written
+  -m, [--pact-file-write-mode=PACT_FILE_WRITE_MODE]              # `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.
+                                                                 # Default: overwrite
+  -i, [--pact-specification-version=PACT_SPECIFICATION_VERSION]  # The pact specification version to use when writing the pact
+                                                                 # Default: 1
+  -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
+
+Start a mock service. If the consumer, provider and pact-dir options are provided, the pact will be written automatically on shutdown.
+```
+
+See [script/example.sh](script/example.sh) for an executable example.
+
+You can find more documentation for the mock service in the repository [wiki][wiki].
+
+### With SSL
 
 If you need to use the mock service with HTTPS, you can use the built-in SSL mode which relies on and generates a self-signed certificate.
 
@@ -46,14 +90,16 @@ If you need to provide your own certificate and key, use the following syntax.
 
     $ pact-mock-service --port 1234 --ssl --sslcert PATH_TO_CERT --sslkey PATH_TO_KEY
 
+### With CORS
+
+Read the wiki page on [CORS][cors].
+
 ## Contributing
 
 See [CONTRIBUTING.md](/CONTRIBUTING.md)
 
 [pact]: https://github.com/realestate-com-au/pact
-[releases]: https://github.com/pact-foundation/pact-mock_service/releases
-[javascript]: https://github.com/DiUS/pact-consumer-js-dsl
+[executables]: https://github.com/pact-foundation/pact-ruby-standalone/releases
 [pact-dev]: https://groups.google.com/forum/#!forum/pact-dev
-[install-windows]: https://github.com/bethesque/pact-mock_service/wiki/Installing-the-pact-mock_service-gem-on-Windows
-[why-generated]: https://github.com/realestate-com-au/pact/wiki/FAQ#why-are-the-pacts-generated-and-not-static
 [wiki]: https://github.com/pact-foundation/pact-mock_service/wiki
+[cors]: https://github.com/pact-foundation/pact-mock_service/wiki/Using-the-mock-service-with-CORS

data/lib/pact/consumer/mock_service/error_handler.rb

@@ -11,6 +11,9 @@ module Pact
         def call env
           begin
             @app.call(env)
+          rescue Pact::Error => e
+            @logger.error e.message
+            [500, {'Content-Type' => 'application/json'}, [{message: e.message}.to_json]]
           rescue StandardError => e
             message = "Error ocurred in mock service: #{e.class} - #{e.message}"
             @logger.error message

data/lib/pact/consumer_contract/consumer_contract_writer.rb

@@ -5,6 +5,7 @@ require 'pact/consumer_contract/pact_file'
 require 'pact/consumer_contract/consumer_contract_decorator'
 require 'pact/shared/active_support_support'
 require 'fileutils'
+require 'filelock'
 
 module Pact
 
@@ -21,7 +22,7 @@ module Pact
     def initialize consumer_contract_details, logger
       @logger = logger
       @consumer_contract_details = consumer_contract_details
-      @pactfile_write_mode = consumer_contract_details.fetch(:pactfile_write_mode, :overwrite).to_sym
+      @pactfile_write_mode = (consumer_contract_details[:pactfile_write_mode] || :overwrite).to_sym
       @interactions = consumer_contract_details.fetch(:interactions)
       @pact_specification_version = (consumer_contract_details[:pact_specification_version] || DEFAULT_PACT_SPECIFICATION_VERSION).to_s
     end
@@ -54,11 +55,9 @@ module Pact
 
     def update_pactfile
       logger.info log_message
-
       FileUtils.mkdir_p File.dirname(pactfile_path)
-      new_pact_json = pact_json
-      File.open(pactfile_path, 'w') do |f|
-        f.write new_pact_json
+      Filelock pactfile_path do | file |
+        file.write pact_json
       end
     end
 
@@ -71,9 +70,9 @@ module Pact
     end
 
     def interactions_for_new_consumer_contract
-      if updating?
+      if pactfile_exists? && (updating? || merging?)
         merged_interactions = existing_interactions.dup
-        filter = Pact::MockService::Interactions::UpdatableInteractionsFilter.new(merged_interactions)
+        filter = Pact::MockService::Interactions.filter(merged_interactions, pactfile_write_mode)
         interactions.each {|i| filter << i }
         merged_interactions
       else
@@ -83,19 +82,14 @@ module Pact
 
     def existing_interactions
       interactions = []
-      if pactfile_exists?
+      if pactfile_exists? && pactfile_has_contents?
         begin
           interactions = existing_consumer_contract.interactions
-          info_and_puts "*****************************************************************************"
-          info_and_puts "Updating existing file .#{pactfile_path.gsub(Dir.pwd, '')} as config.pactfile_write_mode is :update"
-          info_and_puts "Only interactions defined in this test run will be updated."
-          info_and_puts "As interactions are identified by description and provider state, pleased note that if either of these have changed, the old interactions won't be removed from the pact file until the specs are next run with :pactfile_write_mode => :overwrite."
-          info_and_puts "*****************************************************************************"
+          print_updating_warning if updating?
         rescue StandardError => e
-          warn_and_stderr "Could not load existing consumer contract from #{pactfile_path} due to #{e}"
+          warn_and_stderr "Could not load existing consumer contract from #{pactfile_path} due to #{e}. Creating a new file."
           logger.error e
           logger.error e.backtrace
-          warn_and_stderr "Creating a new file."
         end
       end
       interactions
@@ -105,7 +99,12 @@ module Pact
       File.exist?(pactfile_path)
     end
 
+    def pactfile_has_contents?
+      File.size(pactfile_path) != 0
+    end
+
     def existing_consumer_contract
+      # This must only be read after the file has been locked
       Pact::ConsumerContract.from_uri(pactfile_path)
     end
 
@@ -143,12 +142,26 @@ module Pact
       pactfile_write_mode == :update
     end
 
+    def merging?
+      pactfile_write_mode == :merge
+    end
+
     def log_message
       if updating?
         "Updating pact for #{provider_name} at #{pactfile_path}"
+      elsif merging?
+        "Merging interactions into pact for #{provider_name} at #{pactfile_path}"
       else
         "Writing pact for #{provider_name} to #{pactfile_path}"
       end
     end
+
+    def print_updating_warning
+      info_and_puts "*****************************************************************************"
+      info_and_puts "Updating existing file .#{pactfile_path.gsub(Dir.pwd, '')} as pactfile_write_mode is :update"
+      info_and_puts "Only interactions defined in this test run will be updated."
+      info_and_puts "As interactions are identified by description and provider state, pleased note that if either of these have changed, the old interactions won't be removed from the pact file until the specs are next run with :pactfile_write_mode => :overwrite."
+      info_and_puts "*****************************************************************************"
+    end
   end
 end

data/lib/pact/mock_service/app.rb

@@ -38,7 +38,10 @@ module Pact
 
       def write_pact_if_configured
         consumer_contract_writer = ConsumerContractWriter.new(@session.consumer_contract_details, StdoutLogger.new)
-        consumer_contract_writer.write if consumer_contract_writer.can_write?
+        if consumer_contract_writer.can_write? && !@session.pact_written?
+          $stdout.puts "Writing pact before shutting down"
+          consumer_contract_writer.write
+        end
       end
 
       def to_s
@@ -47,6 +50,7 @@ module Pact
     end
 
     # Can't write to a file in a TRAP, might deadlock
+    # Not sure why we can still write to the pact file though
     class StdoutLogger
       def info message
         $stdout.puts "\n#{message}"

data/lib/pact/mock_service/cli.rb

@@ -10,19 +10,22 @@ module Pact
   module MockService
     class CLI < Thor
 
+      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."
+      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 :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
       method_option :sslcert, desc: "Specify the path to the SSL cert to use when running the service over HTTPS"
       method_option :sslkey, desc: "Specify the path to the SSL key to use when running the service over HTTPS"
-      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 :pact_dir, aliases: "-d", desc: "Directory to which the pacts will be written"
-      method_option :unique_pact_file_names, aliases: "-u", desc: "Set to true when running multiple mock service instances in parallel for the same consumer/provider pair", type: :boolean, default: false
-      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact", default: '1'
-      method_option :consumer, desc: "Consumer name"
-      method_option :provider, desc: "Provider name"
 
       def service
         require 'pact/mock_service/run'
@@ -32,14 +35,14 @@ module Pact
       desc 'control', "Run a Pact mock service control server."
       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 :log_dir, aliases: "-l", desc: "File to which to log output"
       method_option :pact_dir, aliases: "-d", desc: "Directory to which the pacts will be written"
-      method_option :unique_pact_file_names, aliases: "-u", desc: "Set to true when running multiple mock service instances in parallel for the same consumer/provider pair", type: :boolean, default: false
+      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 :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"
       method_option :sslkey, desc: "Specify the path to the SSL key to use when running the service over HTTPS"
-      method_option :cors, aliases: "-o", desc: "Support browser security in tests by responding to OPTIONS requests and adding CORS headers to mocked responses"
 
       def control
         require 'pact/mock_service/control_server/run'
@@ -47,19 +50,19 @@ module Pact
       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."
+      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"
       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 :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 :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"
       method_option :sslkey, desc: "Specify the path to the SSL key to use when running the service over HTTPS"
-      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 :pact_dir, aliases: "-d", desc: "Directory to which the pacts will be written"
-      method_option :unique_pact_file_names, aliases: "-u", desc: "Set to true when running multiple mock service instances in parallel for the same consumer/provider pair", type: :boolean, default: false
-      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact", default: '1'
-      method_option :consumer, desc: "Consumer name"
-      method_option :provider, desc: "Provider name"
-      method_option :pid_dir, desc: "PID dir", default: 'tmp/pids'
 
       def start
         start_server(mock_service_pidfile) do
@@ -76,19 +79,19 @@ module Pact
       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."
+      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"
       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 :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 :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"
       method_option :sslkey, desc: "Specify the path to the SSL key to use when running the service over HTTPS"
-      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 :pact_dir, aliases: "-d", desc: "Directory to which the pacts will be written"
-      method_option :unique_pact_file_names, aliases: "-u", desc: "Set to true when running multiple mock service instances in parallel for the same consumer/provider pair", type: :boolean, default: false
-      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact", default: '1'
-      method_option :consumer, desc: "Consumer name"
-      method_option :provider, desc: "Provider name"
-      method_option :pid_dir, desc: "PID dir", default: 'tmp/pids'
 
       def restart
         restart_server(mock_service_pidfile) do
@@ -99,14 +102,14 @@ module Pact
       desc 'control-start', "Start a Pact mock service control server."
       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 :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
       method_option :sslcert, desc: "Specify the path to the SSL cert to use when running the service over HTTPS"
       method_option :sslkey, desc: "Specify the path to the SSL key to use when running the service over HTTPS"
-      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 :pact_dir, aliases: "-d", desc: "Directory to which the pacts will be written", default: "."
-      method_option :unique_pact_file_names, aliases: "-u", desc: "Set to true when running multiple mock service instances in parallel for the same consumer/provider pair", type: :boolean, default: false
-      method_option :pact_specification_version, aliases: "-i", desc: "The pact specification version to use when writing the pact", default: '1'
-      method_option :pid_dir, desc: "PID dir", default: "tmp/pids"
 
       def control_start
         start_server(control_server_pidfile) do
@@ -125,14 +128,14 @@ module Pact
       desc 'control-restart', "Start a Pact mock service control server."
       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 :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"
-      method_option :sslkey, desc: "Specify the path to the SSL key to use when running the service over HTTPS"
-      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 :pact_dir, aliases: "-d", desc: "Directory to which the pacts will be written", default: "."
-      method_option :unique_pact_file_names, aliases: "-u", desc: "Set to true when running multiple mock service instances in parallel for the same consumer/provider pair", type: :boolean, default: false
+      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 :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
+      method_option :sslcert, desc: "Specify the path to the SSL cert to use when running the service over HTTPS"
+      method_option :sslkey, desc: "Specify the path to the SSL key to use when running the service over HTTPS"
 
       def control_restart
         restart_server(control_server_pidfile) do

data/lib/pact/mock_service/errors.rb

@@ -0,0 +1,9 @@
+require 'pact/errors'
+
+module Pact
+  module MockService
+    class AlmostDuplicateInteractionError < Pact::Error; end
+
+    class SameSameButDifferentError < ::Pact::Error; end
+  end
+end

data/lib/pact/mock_service/interactions/interaction_diff_message.rb

@@ -12,7 +12,7 @@ module Pact
         end
 
         def to_s
-          "An interaction with same description (#{new_interaction.description.inspect}) and provider state (#{new_interaction.provider_state.inspect}) but a different #{differences} has already been used. Please use a different description or provider state, or hard-code any random data."
+          "An interaction with same description (#{new_interaction.description.inspect}) and provider state (#{new_interaction.provider_state.inspect}) but a different #{differences} has already been used. Please use a different description or provider state, or remove any random data in the interaction."
         end
 
         private

data/lib/pact/mock_service/interactions/interactions_filter.rb

@@ -1,34 +1,66 @@
+require 'pact/mock_service/errors'
+require 'pact/mock_service/interactions/interaction_diff_message'
+
 #
 # When running in pactfile_write_mode :overwrite, all interactions are cleared from the
 # pact file, and all new interactions should be distinct (unique description and provider state).
 # When running in pactfile_write_mode :update, an interaction with the same description
 # and provider state as an existing one will just overwrite that one interaction.
-#
+# When running in pactfile_write_mode :merge, an interaction with the same description and provider
+# state must be identical to the existing one, otherwise an exception will be raised.
 
 module Pact
-   module MockService
-      module Interactions
+  module MockService
+    module Interactions
 
-         #TODO: think of a better word than filter
-         class InteractionsFilter
-            def initialize interactions = []
-               @interactions = interactions
-            end
+      def self.filter existing_interactions, pactfile_write_mode
+        if pactfile_write_mode == :update
+          UpdatableInteractionsFilter.new(existing_interactions)
+        elsif pactfile_write_mode == :merge
+          MergingInteractionsFilter.new(existing_interactions)
+        else
+          existing_interactions
+        end
+      end
 
-            def index_of interaction
-               @interactions.find_index{ |i| i.matches_criteria?(description: interaction.description, provider_state: interaction.provider_state)}
-            end
-         end
-
-         class UpdatableInteractionsFilter < InteractionsFilter
-            def << interaction
-               if (ndx = index_of(interaction))
-                  @interactions[ndx] = interaction
-               else
-                  @interactions << interaction
-               end
+      #TODO: think of a better word than filter
+      class InteractionsFilter
+        def initialize interactions = []
+           @interactions = interactions
+        end
+
+        def index_of interaction
+           @interactions.find_index{ |i| i.matches_criteria?(description: interaction.description, provider_state: interaction.provider_state)}
+        end
+      end
+
+      class UpdatableInteractionsFilter < InteractionsFilter
+        def << interaction
+           if (ndx = index_of(interaction))
+              @interactions[ndx] = interaction
+           else
+              @interactions << interaction
+           end
+        end
+      end
+
+      class MergingInteractionsFilter < InteractionsFilter
+        def << interaction
+          if (ndx = index_of(interaction))
+            if same_same_but_different?(@interactions[ndx], interaction)
+              message = Interactions::InteractionDiffMessage.new(@interactions[ndx], interaction).to_s
+              raise SameSameButDifferentError, message
             end
-         end
+            @interactions[ndx] = interaction
+          else
+            @interactions << interaction
+          end
+        end
+
+        def same_same_but_different?(existing_interaction, new_interaction)
+          existing_interaction != new_interaction
+        end
       end
-   end
+    end
+  end
 end

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

@@ -16,6 +16,14 @@ module Pact
         def call env
           match?(env) ? respond(env) : NOT_FOUND_RESPONSE
         end
+
+        def json_response json = nil, status = 200
+          [status, {'Content-Type' => 'application/json'}, json ? [json + "\n"]: []]
+        end
+
+        def text_response text = nil, status = 200
+          [status, {'Content-Type' => 'text/plain'}, text ? [text + "\n"]: []]
+        end
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Pact
         end
 
         def respond env
-          [200, {'Content-Type' => 'text/plain'}, ['Mock service running']]
+          text_response('Mock service running')
         end
       end
     end

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

@@ -23,8 +23,10 @@ module Pact
 
         def respond env
           session.clear_expected_and_actual_interactions
-          logger.info "Cleared interactions before example \"#{example_description(env)}\""
-          [200, {}, ['Deleted interactions']]
+          example_desc = example_description(env)
+          example_desc = example_desc ? " for example #{example_desc.inspect}" : ''
+          logger.info "Cleared interactions#{example_desc}"
+          text_response('Cleared interactions')
         end
 
         def example_description env

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

@@ -25,9 +25,9 @@ module Pact
 
           begin
             session.add_expected_interaction interaction
-            [200, {}, ['Set interactions']]
-          rescue AlmostDuplicateInteractionError => e
-            [500, {}, [e.message]]
+            text_response 'Registered interactions'
+          rescue ::Pact::Error => e
+            text_response e.message, 500
           end
 
         end

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

@@ -92,7 +92,7 @@ module Pact
             message: "Multiple interaction found for #{actual_request.method_and_path}",
             matching_interactions:  matching_interactions.collect{ | interaction | request_summary_for(interaction) }
           }
-          [500, {'Content-Type' => 'application/json'}, [response.to_json]]
+          [500, {'Content-Type' => 'application/json'}, [response.to_json + "\n"]]
         end
 
         def self.request_summary_for interaction
@@ -121,7 +121,7 @@ module Pact
             message: "No interaction found for #{interaction_mismatch.actual_request.method_and_path}",
             interaction_diffs:  interaction_mismatch.to_hash
           }
-          [500, {'Content-Type' => 'application/json'}, [response.to_json]]
+          [500, {'Content-Type' => 'application/json'}, [response.to_json + "\n"]]
         end
 
         def self.interaction_mismatch actual_request, candidate_interactions

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

@@ -26,9 +26,9 @@ module Pact
           interactions = request_body['interactions'].collect { | hash | Interaction.from_hash(hash) }
           begin
             session.set_expected_interactions interactions
-            [200, {}, ['Set interactions']]
-          rescue AlmostDuplicateInteractionError => e
-            [500, {}, [e.message]]
+            text_response('Registered interactions')
+          rescue Pact::Error => e
+            text_response(e.message, 500)
           end
         end
 

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

@@ -15,7 +15,7 @@ module Pact
 
         def respond env
           logger.info "Debug message from client - #{message(env)}"
-          [200, {}, []]
+          text_response
         end
 
         def message env

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

@@ -25,7 +25,7 @@ module Pact
           verification = Pact::MockService::Interactions::Verification.new(@expected_interactions, @actual_interactions)
           number_of_missing_interactions = verification.missing_interactions.size
           logger.info "Number of missing interactions for mock \"#{name}\" = #{number_of_missing_interactions}"
-          [200, {}, [{size: number_of_missing_interactions}.to_json]]
+          json_response({size: number_of_missing_interactions}.to_json)
         end
       end
     end

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

@@ -3,7 +3,6 @@ require 'pact/mock_service/request_handlers/base_request_handler'
 module Pact
   module MockService
     module RequestHandlers
-
       class Options < BaseRequestHandler
 
         attr_reader :name, :logger, :cors_enabled
@@ -35,7 +34,6 @@ module Pact
         def is_administration_request? env
           env["HTTP_ACCESS_CONTROL_REQUEST_HEADERS"].match(/x-pact-mock-service/i)
         end
-
       end
     end
   end

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

@@ -6,13 +6,14 @@ module Pact
     module RequestHandlers
       class PactPost < BaseAdministrationRequestHandler
 
-        attr_accessor :consumer_contract, :verified_interactions, :default_options
+        attr_accessor :consumer_contract, :verified_interactions, :default_options, :session
 
         def initialize name, logger, session
           super name, logger
           @verified_interactions = session.verified_interactions
           @default_options = {}
           @default_options.merge!(session.consumer_contract_details)
+          @session = session
         end
 
         def request_path
@@ -24,13 +25,12 @@ module Pact
         end
 
         def respond env
-          consumer_contract_details = JSON.parse(env['rack.input'].string, symbolize_names: true)
-          logger.info "Writing pact with details #{consumer_contract_details}"
+          body = env['rack.input'].string
+          consumer_contract_details = body.size > 0 ? JSON.parse(body, symbolize_names: true) : {}
           consumer_contract_params = default_options.merge(consumer_contract_details.merge(interactions: verified_interactions))
           consumer_contract_writer = ConsumerContractWriter.new(consumer_contract_params, logger)
-          json = consumer_contract_writer.write
-
-          [200, {'Content-Type' =>'application/json'}, [json]]
+          session.record_pact_written
+          json_response(consumer_contract_writer.write)
         end
       end
     end

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

@@ -24,9 +24,8 @@ module Pact
         def respond env
           session.clear_all
           logger.info "Cleared session"
-          [200, {}, ['Cleared session']]
+          text_response 'Cleared session'
         end
-
       end
     end
   end

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

@@ -21,14 +21,17 @@ module Pact
 
         def respond env
           verification = Pact::MockService::Interactions::Verification.new(expected_interactions, actual_interactions)
+          example_desc = example_description(env)
+          example_desc = example_desc ? " for example #{example_desc.inspect}" : ''
           if verification.all_matched?
-            logger.info "Verifying - interactions matched for example \"#{example_description(env)}\""
-            [200, {'Content-Type' => 'text/plain'}, ['Interactions matched']]
+            logger.info "Verifying - interactions matched#{example_desc}"
+            text_response('Interactions matched')
           else
             error_message = FailureMessage.new(verification).to_s
-            logger.warn "Verifying - actual interactions do not match expected interactions for example \"#{example_description(env)}\". \n#{error_message}"
+            logger.warn "Verifying - actual interactions do not match expected interactions#{example_desc}. \n#{error_message}"
             logger.warn error_message
-            [500, {'Content-Type' => 'text/plain'}, ["Actual interactions do not match expected interactions for mock #{name}.\n\n#{error_message}See #{logger.description} for details."]]
+            response_message = "Actual interactions do not match expected interactions for mock #{name}.\n\n#{error_message}See #{logger.description} for details."
+            text_response(response_message, 500)
           end
         end
 
@@ -64,7 +67,6 @@ module Pact
               "Unexpected requests" => verification.unexpected_requests_summaries,
             }
           end
-
         end
       end
     end

data/lib/pact/mock_service/run.rb

@@ -52,7 +52,8 @@ module Pact
           consumer: options[:consumer],
           provider: options[:provider],
           cors_enabled: options[:cors],
-          pact_specification_version: options[:pact_specification_version]
+          pact_specification_version: options[:pact_specification_version],
+          pactfile_write_mode: options[:pact_file_write_mode]
         }
         service_options[:log_file] = open_log_file if options[:log]
         service_options

data/lib/pact/mock_service/session.rb

@@ -3,31 +3,38 @@ require 'pact/mock_service/interactions/actual_interactions'
 require 'pact/mock_service/interactions/verified_interactions'
 require 'pact/mock_service/interaction_decorator'
 require 'pact/mock_service/interactions/interaction_diff_message'
+require 'pact/mock_service/errors'
 
 module Pact
   module MockService
-
-    class AlmostDuplicateInteractionError < StandardError; end
-
     class Session
 
       attr_reader :expected_interactions, :actual_interactions, :verified_interactions, :consumer_contract_details, :logger
 
       def initialize options
+        @pact_written = false
         @logger = options[:logger]
         @expected_interactions = Interactions::ExpectedInteractions.new
         @actual_interactions = Interactions::ActualInteractions.new
         @verified_interactions = Interactions::VerifiedInteractions.new
         @consumer_contract_details = {
           pact_dir: options[:pact_dir],
-          unique_pact_file_names: options[:unique_pact_file_names],
           consumer: {name: options[:consumer]},
           provider: {name: options[:provider]},
           interactions: verified_interactions,
-          pact_specification_version: options[:pact_specification_version]
+          pact_specification_version: options[:pact_specification_version],
+          pactfile_write_mode: options[:pactfile_write_mode]
         }
       end
 
+      def pact_written?
+        @pact_written
+      end
+
+      def record_pact_written
+        @pact_written = true
+      end
+
       def set_expected_interactions interactions
         clear_expected_and_actual_interactions
         interactions.each do | interaction |
@@ -44,6 +51,7 @@ module Pact
         expected_interactions.clear
         actual_interactions.clear
         verified_interactions.clear
+        @pact_written = false
       end
 
       def add_expected_interaction interaction
@@ -65,7 +73,7 @@ module Pact
       def handle_almost_duplicate_interaction previous_interaction, interaction
         message = Interactions::InteractionDiffMessage.new(previous_interaction, interaction).to_s
         logger.error message
-        raise AlmostDuplicateInteractionError, message
+        raise SameSameButDifferentError, message
       end
 
       def interaction_already_verified_with_same_description_and_provider_state_but_not_equal interaction

data/lib/pact/mock_service/spawn.rb

@@ -42,7 +42,8 @@ module Pact
           provider: provider,
           pact_dir: options[:pact_dir] || ".",
           cors_enabled: options[:cors_enabled],
-          pact_specification_version: options[:pact_specification_version]
+          pact_specification_version: options[:pact_specification_version],
+          pactfile_write_mode: options[:pact_file_write_mode]
         )
       end
 

data/lib/pact/mock_service/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module MockService
-    VERSION = "2.2.0"
+    VERSION = "2.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-mock_service
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-30 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -133,6 +133,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -140,6 +143,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: filelock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -258,7 +278,7 @@ email:
 - sergei.matheson@gmail.com
 - brent@fuglylogic.com
 - uglyog@gmail.com
-- bskurrie@dius.com.au
+- beth@bethesque.com
 executables:
 - pact-mock-service
 extensions: []
@@ -292,6 +312,7 @@ files:
 - lib/pact/mock_service/control_server/mock_services.rb
 - lib/pact/mock_service/control_server/require_pacticipant_headers.rb
 - lib/pact/mock_service/control_server/run.rb
+- lib/pact/mock_service/errors.rb
 - lib/pact/mock_service/interaction_decorator.rb
 - lib/pact/mock_service/interactions/actual_interactions.rb
 - lib/pact/mock_service/interactions/candidate_interactions.rb
@@ -345,7 +366,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Provides a mock service for use with Pact