pact-mock_service 0.2.4 → 0.3.0

data/lib/pact/mock_service/spawn.rb

@@ -1,5 +1,8 @@
-require 'pact/consumer/mock_service'
+require 'pact/mock_service/app'
 require 'pact/consumer/server'
+require 'pact/consumer/mock_service/set_location'
+
+# Starts a new MockService on a new Thread. Called by the Control Server.
 
 module Pact
   module MockService
@@ -19,7 +22,7 @@ module Pact
       end
 
       def call
-        mock_service = create_mock_service
+        mock_service = build_app
         start_mock_service mock_service, port
         puts "Started mock service for #{provider} on #{port}"
         mock_service
@@ -27,10 +30,13 @@ module Pact
 
       private
 
-      def create_mock_service
-        name = "#{provider} mock service"
-        Pact::Consumer::MockService.new(
-          log_file: create_log_file(name),
+      def build_app
+        Pact::Consumer::SetLocation.new(mock_service, base_url)
+      end
+
+      def mock_service
+        Pact::MockService.new(
+          log_file: create_log_file,
           name: name,
           consumer: consumer,
           provider: provider,
@@ -43,15 +49,15 @@ module Pact
         Pact::Server.new(app, port, ssl: options[:ssl]).boot
       end
 
-      def create_log_file service_name
+      def create_log_file
         FileUtils::mkdir_p options[:log_dir]
-        log = File.open(log_file_path(service_name), 'w')
+        log = File.open(log_file_path, 'w')
         log.sync = true
         log
       end
 
-      def log_file_name service_name
-        lower_case_name = service_name.downcase.gsub(/\s+/, '_')
+      def log_file_name
+        lower_case_name = name.downcase.gsub(/\s+/, '_')
         if lower_case_name.include?('_service')
           lower_case_name.gsub('_service', '_mock_service')
         else
@@ -59,8 +65,16 @@ module Pact
         end
       end
 
-      def log_file_path service_name
-        File.join(options[:log_dir], "#{log_file_name(service_name)}.log")
+      def log_file_path
+        File.join(options[:log_dir], "#{log_file_name}.log")
+      end
+
+      def base_url
+        options[:ssl] ? "https://localhost:#{port}" : "http://localhost:#{port}"
+      end
+
+      def name
+        "#{provider} mock service"
       end
     end
 

data/lib/pact/mock_service/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module MockService
-    VERSION = "0.2.4"
+    VERSION = "0.3.0"
   end
 end

data/lib/pact/mock_service.rb

@@ -1 +1,2 @@
-require 'pact/consumer/mock_service'
+require 'pact/consumer/app_manager'
+require 'pact/mock_service/app'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-mock_service
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-24 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -251,39 +251,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/pact-mock-service
-- lib/pact/consumer/app_manager.rb
-- lib/pact/consumer/interactions_filter.rb
-- lib/pact/consumer/mock_service/actual_interactions.rb
-- lib/pact/consumer/mock_service/app.rb
-- lib/pact/consumer/mock_service/candidate_interactions.rb
 - lib/pact/consumer/mock_service/cors_origin_header_middleware.rb
 - lib/pact/consumer/mock_service/error_handler.rb
-- lib/pact/consumer/mock_service/expected_interactions.rb
-- lib/pact/consumer/mock_service/index_get.rb
-- lib/pact/consumer/mock_service/interaction_delete.rb
-- lib/pact/consumer/mock_service/interaction_mismatch.rb
-- lib/pact/consumer/mock_service/interaction_post.rb
-- lib/pact/consumer/mock_service/interaction_replay.rb
-- lib/pact/consumer/mock_service/log_get.rb
-- lib/pact/consumer/mock_service/missing_interactions_get.rb
-- lib/pact/consumer/mock_service/mock_service_administration_endpoint.rb
-- lib/pact/consumer/mock_service/options.rb
-- lib/pact/consumer/mock_service/pact_post.rb
 - lib/pact/consumer/mock_service/rack_request_helper.rb
-- lib/pact/consumer/mock_service/request_handlers.rb
-- lib/pact/consumer/mock_service/verification.rb
-- lib/pact/consumer/mock_service/verification_get.rb
-- lib/pact/consumer/mock_service/verified_interactions.rb
-- lib/pact/consumer/mock_service.rb
-- lib/pact/consumer/mock_service_client.rb
+- lib/pact/consumer/mock_service/set_location.rb
 - lib/pact/consumer/server.rb
 - lib/pact/consumer_contract/consumer_contract_decorator.rb
 - lib/pact/consumer_contract/consumer_contract_writer.rb
 - lib/pact/consumer_contract/interaction_decorator.rb
 - lib/pact/consumer_contract/request_decorator.rb
 - lib/pact/consumer_contract/response_decorator.rb
+- lib/pact/mock_service/app.rb
+- lib/pact/mock_service/app_manager.rb
 - lib/pact/mock_service/cli/pidfile.rb
 - lib/pact/mock_service/cli.rb
+- lib/pact/mock_service/client.rb
 - lib/pact/mock_service/control_server/app.rb
 - lib/pact/mock_service/control_server/delegator.rb
 - lib/pact/mock_service/control_server/index.rb
@@ -292,12 +274,35 @@ files:
 - lib/pact/mock_service/control_server/require_pacticipant_headers.rb
 - lib/pact/mock_service/control_server/run.rb
 - lib/pact/mock_service/interaction_decorator.rb
+- lib/pact/mock_service/interactions/actual_interactions.rb
+- lib/pact/mock_service/interactions/candidate_interactions.rb
+- lib/pact/mock_service/interactions/expected_interactions.rb
+- lib/pact/mock_service/interactions/interaction_diff_message.rb
+- lib/pact/mock_service/interactions/interaction_mismatch.rb
+- lib/pact/mock_service/interactions/interactions_filter.rb
+- lib/pact/mock_service/interactions/verification.rb
+- lib/pact/mock_service/interactions/verified_interactions.rb
+- lib/pact/mock_service/logger.rb
 - lib/pact/mock_service/request_decorator.rb
+- lib/pact/mock_service/request_handlers/base_administration_request_handler.rb
+- lib/pact/mock_service/request_handlers/base_request_handler.rb
+- lib/pact/mock_service/request_handlers/index_get.rb
+- lib/pact/mock_service/request_handlers/interaction_delete.rb
+- lib/pact/mock_service/request_handlers/interaction_post.rb
+- lib/pact/mock_service/request_handlers/interaction_replay.rb
+- lib/pact/mock_service/request_handlers/interactions_put.rb
+- lib/pact/mock_service/request_handlers/log_get.rb
+- lib/pact/mock_service/request_handlers/missing_interactions_get.rb
+- lib/pact/mock_service/request_handlers/options.rb
+- lib/pact/mock_service/request_handlers/pact_post.rb
+- lib/pact/mock_service/request_handlers/verification_get.rb
+- lib/pact/mock_service/request_handlers.rb
 - lib/pact/mock_service/response_decorator.rb
 - lib/pact/mock_service/run.rb
 - lib/pact/mock_service/server/restart.rb
 - lib/pact/mock_service/server/spawn.rb
 - lib/pact/mock_service/server/wait_for_server_up.rb
+- lib/pact/mock_service/session.rb
 - lib/pact/mock_service/spawn.rb
 - lib/pact/mock_service/version.rb
 - lib/pact/mock_service.rb

data/lib/pact/consumer/interactions_filter.rb

@@ -1,32 +0,0 @@
-#
-# 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.
-#
-
-module Pact
-   module Consumer
-
-      #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
-   end
-end

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

@@ -1,34 +0,0 @@
-require 'pact/consumer/mock_service/candidate_interactions'
-
-module Pact
-  module Consumer
-    class ActualInteractions
-
-      attr_reader :matched_interactions, :interaction_mismatches, :unexpected_requests
-
-      def initialize
-        clear
-      end
-
-      # For testing, sigh
-      def clear
-        @matched_interactions = []
-        @interaction_mismatches = []
-        @unexpected_requests = []
-      end
-
-      def register_matched interaction
-        @matched_interactions << interaction
-      end
-
-      def register_unexpected_request request
-        @unexpected_requests << request
-      end
-
-      def register_interaction_mismatch interaction_mismatch
-        @interaction_mismatches << interaction_mismatch
-      end
-
-    end
-  end
-end

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

@@ -1,58 +0,0 @@
-require 'rack'
-require 'uri'
-require 'json'
-require 'logger'
-require 'pact/consumer/mock_service/cors_origin_header_middleware'
-require 'pact/consumer/mock_service/request_handlers'
-
-module Pact
-  module Consumer
-    class MockService
-      class App
-
-        def initialize options = {}
-          @name = options.fetch(:name, "MockService")
-          @logger = options.fetch(:logger)
-          expected_interactions = ExpectedInteractions.new
-          actual_interactions = ActualInteractions.new
-          verified_interactions = VerifiedInteractions.new
-          @consumer_contact_details = {
-            pact_dir: options[:pact_dir],
-            consumer: {name: options[:consumer]},
-            provider: {name: options[:provider]},
-            interactions: verified_interactions
-          }
-
-          @request_handlers = Pact::Consumer::MockService::RequestHandlers.new(@name, @logger, expected_interactions, actual_interactions, verified_interactions, options)
-        end
-
-        def call env
-          @request_handlers.call(env)
-        end
-
-        def shutdown
-          write_pact_if_configured
-        end
-
-        private
-
-        def write_pact_if_configured
-          consumer_contract_writer = ConsumerContractWriter.new(@consumer_contact_details, StdoutLogger.new)
-          consumer_contract_writer.write if consumer_contract_writer.can_write?
-        end
-
-        def to_s
-          "#{@name} #{super.to_s}"
-        end
-
-      end
-
-      # Can't write to a file in a TRAP, might deadlock
-      class StdoutLogger
-        def info message
-          $stdout.puts "\n#{message}"
-        end
-      end
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-module Pact
-  module Consumer
-    class CandidateInteractions < Array
-
-      def matching_interactions actual_request
-        select do | candidate_interaction |
-          candidate_interaction.request.matches? actual_request
-        end
-      end
-
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-require 'pact/consumer/mock_service/candidate_interactions'
-
-module Pact
-  module Consumer
-    class ExpectedInteractions < Array
-
-      def find_candidate_interactions actual_request
-        CandidateInteractions.new(
-          select do | interaction |
-            interaction.request.matches_route? actual_request
-          end
-        )
-      end
-
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-require 'pact/consumer/mock_service/rack_request_helper'
-require 'pact/consumer/mock_service/mock_service_administration_endpoint'
-
-module Pact
-  module Consumer
-
-    class IndexGet < MockServiceAdministrationEndpoint
-
-      def request_path
-        ''
-      end
-
-      def request_method
-        'GET'
-      end
-
-      def respond env
-        [200, {'Content-Type' => 'text/plain'}, ['Mock service running']]
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-require 'pact/consumer/mock_service/rack_request_helper'
-require 'pact/consumer/mock_service/mock_service_administration_endpoint'
-
-module Pact
-  module Consumer
-
-    class InteractionDelete < MockServiceAdministrationEndpoint
-
-      include RackRequestHelper
-
-      attr_accessor :expected_interactions, :actual_interactions
-
-      def initialize name, logger, expected_interactions, actual_interactions
-        super name, logger
-        @expected_interactions = expected_interactions
-        @actual_interactions = actual_interactions
-      end
-
-      def request_path
-        '/interactions'
-      end
-
-      def request_method
-        'DELETE'
-      end
-
-      def respond env
-        expected_interactions.clear
-        actual_interactions.clear
-        logger.info "Cleared interactions before example \"#{example_description(env)}\""
-        [200, {}, ['Deleted interactions']]
-      end
-
-      def example_description env
-        params_hash(env).fetch('example_description', [])[0]
-      end
-    end
-  end
-end

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

@@ -1,73 +0,0 @@
-module Pact
-  module Consumer
-
-    # Presents the differences between an actual request, and a list of
-    # expected interactions where the methods and paths match the actual request.
-    # This is used to display a helpful message to the user when a request
-    # comes in that doesn't match any of the expected interactions.
-    class InteractionMismatch
-
-      attr_accessor :candidate_interactions, :actual_request
-
-      # Assumes the method and path matches...
-
-      def initialize candidate_interactions, actual_request
-        @candidate_interactions = candidate_interactions
-        @actual_request = actual_request
-        @candiate_diffs = candidate_interactions.collect{ | candidate_interaction| CandidateDiff.new(candidate_interaction, actual_request)}
-      end
-
-      def to_hash
-        candiate_diffs.collect(&:to_hash)
-      end
-
-      def to_s
-        candiate_diffs.collect(&:to_s).join("\n")
-      end
-
-      def short_summary
-        mismatched_attributes = candiate_diffs.collect(&:mismatched_attributes).flatten.uniq.join(", ").reverse.sub(",", "dna ").reverse #OMG what a hack!
-        actual_request.method_and_path + " (request #{mismatched_attributes} did not match)"
-      end
-
-      private
-
-      attr_accessor :candiate_diffs
-
-      class CandidateDiff
-
-        attr_accessor :candidate_interaction, :actual_request
-
-        def initialize candidate_interaction, actual_request
-          @candidate_interaction = candidate_interaction
-          @actual_request = actual_request
-        end
-
-        def mismatched_attributes
-          diff.keys
-        end
-
-        def to_hash
-          summary = {:description => candidate_interaction.description}
-          summary[:provider_state] = candidate_interaction.provider_state if candidate_interaction.provider_state
-          summary.merge(diff)
-        end
-
-        def to_s
-          [
-            "Diff with interaction: #{candidate_interaction.description_with_provider_state_quoted}",
-            diff_formatter.call(diff, {colour: false})
-          ].join("\n")
-        end
-
-        def diff_formatter
-          Pact.configuration.diff_formatter_for_content_type(candidate_interaction.request.content_type)
-        end
-
-        def diff
-          @diff ||= candidate_interaction.request.difference(actual_request)
-        end
-      end
-    end
-  end
-end

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

@@ -1,95 +0,0 @@
-require 'pact/consumer/mock_service/mock_service_administration_endpoint'
-require 'pact/mock_service/interaction_decorator'
-require 'pact/shared/json_differ'
-
-module Pact
-  module Consumer
-    class InteractionPost < MockServiceAdministrationEndpoint
-
-      def initialize name, logger, expected_interactions, verified_interactions
-        super name, logger
-        @expected_interactions = expected_interactions
-        @verified_interactions = verified_interactions
-      end
-
-      def request_path
-        '/interactions'
-      end
-
-      def request_method
-        'POST'
-      end
-
-      def respond env
-        request_body = env['rack.input'].string
-        interaction = Interaction.from_hash(JSON.load(request_body)) # Load creates the Pact::XXX classes
-
-        if (previous_interaction = interaction_already_verified_with_same_description_and_provider_state_but_not_equal(interaction))
-          handle_almost_duplicate_interaction previous_interaction, interaction
-        else
-          add_expected_interaction request_body, interaction
-        end
-      end
-
-      private
-
-      attr_accessor :expected_interactions, :verified_interactions
-
-      def add_expected_interaction request_body, interaction
-        expected_interactions << interaction
-        logger.info "Registered expected interaction #{interaction.request.method_and_path}"
-        logger.debug JSON.pretty_generate JSON.parse(request_body)
-        [200, {}, ['Added interaction']]
-      end
-
-      def handle_almost_duplicate_interaction previous_interaction, interaction
-        message = InteractionDiffMessage.new(previous_interaction, interaction).to_s
-        logger.error message
-        [500, {}, [message]]
-      end
-
-      def interaction_already_verified_with_same_description_and_provider_state_but_not_equal interaction
-        other = verified_interactions.find_matching_description_and_provider_state interaction
-        other && other != interaction ? other : nil
-      end
-
-      class InteractionDiffMessage
-
-        def initialize previous_interaction, new_interaction
-          @previous_interaction = previous_interaction
-          @new_interaction = new_interaction
-        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."
-        end
-
-        private
-
-        attr_reader :previous_interaction, :new_interaction
-
-        def differences
-          diff = Pact::JsonDiffer.call(previous_interaction_hash, new_interaction_hash, allow_unexpected_keys: false)
-          diff.keys.collect do | parent_key |
-            diff[parent_key].keys.collect do | child_key |
-              "#{parent_key} #{child_key}"
-            end
-          end.flatten.join(", ").reverse.sub(",", "dna ").reverse
-        end
-
-        def previous_interaction_hash
-          raw_hash previous_interaction
-        end
-
-        def new_interaction_hash
-          raw_hash new_interaction
-        end
-
-        def raw_hash interaction
-          JSON.parse(Pact::MockService::InteractionDecorator.new(interaction).to_json)
-        end
-
-      end
-    end
-  end
-end