pact-mock_service 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebcb0082a273a588dcca76818918e469ad66fad1
-  data.tar.gz: 0555f3c7bc6f652577e3efb3f96967fd203437f5
+  metadata.gz: fd03f421bbf55e3e676c14e1381c0b8276b65929
+  data.tar.gz: b083148cc1cc3d7ca79a2a42dc4b55b3b3129bf8
 SHA512:
-  metadata.gz: ca2923d11a5d07fec5906ef98eb2300048d23247fff17efcbc99ea4c1706aec9f9116c346debaf8fdcbb19725ce36f5ce7719a4181764b71402d4d7298cb1155
-  data.tar.gz: 368e8f6e568cbf212f5c6e64009b9cd0caa7832979025091ccd7676853aa4e413b1631a8ec92805b58cf59d0881a9c0a9f844ac368771d0449ebbd76073880e7
+  metadata.gz: 5d19c285a1b6c2d97ff25407ede34967c06471ae80f965ddc3cc1ca24e08b313bfaafca9ac7c49f711879e549fee6109aa653430bd063944e4d65c026d163237
+  data.tar.gz: ed483795cb21f664e482499f53b0fade46e774d978c051edbe906c9b4d5f464433523e6c22d17adcce9690c9a73a4fffde2cb5bba10d2cf4c84094e5050cab5e

data/CHANGELOG.md

@@ -2,6 +2,12 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+### 0.3.0 (4 Feb 2015)
+
+* 60869be - Refactor - moving classes from Pact::Consumer module into Pact::MockService module. (Beth Skurrie, Wed Feb 4 19:28:54 2015 +1100)
+* 4ada4f0 - Added endpoint for PUT /interactions. Allow javascript client to set up all interactions at once and avoid callback hell. (Beth Skurrie, Thu Jan 29 21:48:00 2015 +1100)
+* a329f49 - Add X-Pact-Mock-Service-Location header to all responses from the MockService (Beth Skurrie, Sun Jan 25 09:00:20 2015 +1100)
+
 ### 0.2.4 (24 Jan 2015)
 
 * b14050e - Add --ssl option for control server (Beth, Sat Jan 24 22:14:14 2015 +1100)

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

@@ -0,0 +1,28 @@
+module Pact
+  module Consumer
+    class SetLocation
+
+      LOCATION = 'X-Pact-Mock-Service-Location'.freeze
+      HTTP_X_PACT_MOCK_SERVICE = 'HTTP_X_PACT_MOCK_SERVICE'
+
+      def initialize app, base_url
+        @app = app
+        @location_header = {LOCATION => base_url}.freeze
+      end
+
+      def call env
+        response = @app.call(env)
+        env[HTTP_X_PACT_MOCK_SERVICE] ? add_location_header_to_response(response) : response
+      end
+
+      def add_location_header_to_response response
+        [response.first, response[1].merge(@location_header), response.last]
+      end
+
+      def shutdown
+        @app.shutdown
+      end
+
+    end
+  end
+end

data/lib/pact/consumer_contract/consumer_contract_writer.rb

@@ -1,5 +1,5 @@
 require 'pact/consumer_contract'
-require 'pact/consumer/interactions_filter'
+require 'pact/mock_service/interactions/interactions_filter'
 require 'pact/consumer_contract/file_name'
 require 'pact/consumer_contract/pact_file'
 require 'pact/consumer_contract/consumer_contract_decorator'
@@ -63,7 +63,7 @@ module Pact
     def interactions_for_new_consumer_contract
       if updating?
         merged_interactions = existing_interactions.dup
-        filter = Consumer::UpdatableInteractionsFilter.new(merged_interactions)
+        filter = Pact::MockService::Interactions::UpdatableInteractionsFilter.new(merged_interactions)
         interactions.each {|i| filter << i }
         merged_interactions
       else

data/lib/pact/mock_service/app.rb

@@ -0,0 +1,56 @@
+require 'rack'
+require 'uri'
+require 'json'
+require 'pact/mock_service/logger'
+require 'pact/consumer/mock_service/cors_origin_header_middleware'
+require 'pact/mock_service/request_handlers'
+require 'pact/consumer/mock_service/error_handler'
+require 'pact/mock_service/session'
+
+module Pact
+  module MockService
+
+    def self.new *args
+      App.new(*args)
+    end
+
+    class App
+
+      def initialize options = {}
+        @name = options.fetch(:name, "MockService")
+        logger = Logger.from_options(options)
+        @session = Session.new(options.merge(logger: logger))
+        request_handlers = RequestHandlers.new(@name, logger, @session, options)
+        @app = Rack::Builder.app do
+          use Pact::Consumer::MockService::ErrorHandler, logger
+          use Pact::Consumer::CorsOriginHeaderMiddleware, options[:cors_enabled]
+          run request_handlers
+        end
+      end
+
+      def call env
+        @app.call env
+      end
+
+      def shutdown
+        write_pact_if_configured
+      end
+
+      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?
+      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

data/lib/pact/{consumer → mock_service}/app_manager.rb

@@ -6,11 +6,11 @@ require 'find_a_port'
 require 'pact/logging'
 require 'pact/consumer/server'
 require 'singleton'
-require 'pact/consumer/mock_service'
+require 'pact/mock_service/app'
 require 'find_a_port'
 
 module Pact
-  module Consumer
+  module MockService
     class AppManager
 
       include Pact::Logging
@@ -27,7 +27,7 @@ module Pact
         raise "Currently only http is supported" unless uri.scheme == 'http'
         raise "Currently only services on localhost are supported" unless uri.host == 'localhost'
 
-        register(MockService.new(log_file: create_log_file(name), name: name, pact_dir: pact_dir), uri.port)
+        register(Pact::MockService.new(log_file: create_log_file(name), name: name, pact_dir: pact_dir), uri.port)
       end
 
       def register(app, port = FindAPort.available_port)
@@ -133,7 +133,7 @@ module Pact
       end
 
       def is_a_mock_service?
-        app.is_a? MockService
+        app.is_a? Pact::MockService::App
       end
 
       def to_s

data/lib/pact/{consumer/mock_service_client.rb → mock_service/client.rb}

@@ -2,8 +2,8 @@ require 'net/http'
 require 'pact/mock_service/interaction_decorator'
 
 module Pact
-  module Consumer
-    class MockServiceClient
+  module MockService
+    class Client
 
       MOCK_SERVICE_ADMINISTRATON_HEADERS = {'X-Pact-Mock-Service' => 'true'}
 

data/lib/pact/mock_service/control_server/delegator.rb

@@ -11,16 +11,13 @@ module Pact
 
         HTTP_X_PACT_CONSUMER = 'HTTP_X_PACT_CONSUMER'.freeze
         HTTP_X_PACT_PROVIDER = 'HTTP_X_PACT_PROVIDER'.freeze
-        LOCATION = 'X-Pact-Mock-Service-Location'.freeze
         PACT_MOCK_SERVICE_HEADER = {'HTTP_X_PACT_MOCK_SERVICE' => 'true'}.freeze
         NOT_FOUND_RESPONSE = [404, {}, []].freeze
 
-        def initialize app, base_url, consumer_name, provider_name
+        def initialize app, consumer_name, provider_name
           @app = app
-          @base_url = base_url
           @consumer_name = consumer_name
           @provider_name = provider_name
-          @location_header = {LOCATION => @base_url}.freeze
         end
 
         def call env
@@ -39,16 +36,8 @@ module Pact
         end
 
         def delegate env
-          add_location_header_to_response(call_app(env))
-        end
-
-        def call_app env
           @app.call(env.merge(PACT_MOCK_SERVICE_HEADER))
         end
-
-        def add_location_header_to_response response
-          [response.first, response[1].merge(@location_header), response.last]
-        end
       end
     end
   end

data/lib/pact/mock_service/control_server/mock_service_creator.rb

@@ -23,7 +23,7 @@ module Pact
           provider_name = env['HTTP_X_PACT_PROVIDER']
           port = FindAPort.available_port
           mock_service = Pact::MockService::Spawn.(consumer_name, provider_name, port, options)
-          delegator = Delegator.new(mock_service, "http://localhost:#{port}", consumer_name, provider_name)
+          delegator = Delegator.new(mock_service, consumer_name, provider_name)
           @mock_services.add(delegator)
           response = delegator.call(env)
           response

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

@@ -0,0 +1,36 @@
+require 'pact/mock_service/interactions/candidate_interactions'
+
+module Pact
+  module MockService
+    module Interactions
+      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
+end

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

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

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

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

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

@@ -0,0 +1,45 @@
+require 'pact/shared/json_differ'
+require 'pact/mock_service/interaction_decorator'
+
+module Pact
+  module MockService
+    module Interactions
+      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

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

@@ -0,0 +1,74 @@
+module Pact
+  module MockService
+    module Interactions
+
+      # 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
+end

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

@@ -0,0 +1,34 @@
+#
+# 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 MockService
+      module Interactions
+
+         #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
+end

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

@@ -0,0 +1,48 @@
+module Pact
+  module MockService
+    module Interactions
+      class Verification
+
+        def initialize expected_interactions, actual_interactions
+          @expected_interactions = expected_interactions
+          @actual_interactions = actual_interactions
+        end
+
+        def all_matched?
+          interaction_diffs.empty?
+        end
+
+        def interaction_diffs
+          {
+            :missing_interactions => missing_interactions_summaries,
+            :interaction_mismatches => interaction_mismatches_summaries,
+            :unexpected_requests => unexpected_requests_summaries
+          }.each_with_object({}) do | (key, value), hash |
+            hash[key] = value if value.any?
+          end
+        end
+
+        def missing_interactions_summaries
+          missing_interactions.collect(&:request).collect(&:method_and_path)
+        end
+
+        def interaction_mismatches_summaries
+          actual_interactions.interaction_mismatches.collect(&:short_summary)
+        end
+
+        def unexpected_requests_summaries
+          actual_interactions.unexpected_requests.collect(&:method_and_path)
+        end
+
+        def missing_interactions
+          expected_interactions - actual_interactions.matched_interactions - @actual_interactions.interaction_mismatches.collect(&:candidate_interactions).flatten
+        end
+
+        private
+
+        attr_reader :expected_interactions, :actual_interactions
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Pact
+  module MockService
+    module Interactions
+      class VerifiedInteractions < Array
+
+        def << interaction
+          unless find_matching_description_and_provider_state interaction
+            super
+          end
+        end
+
+        def find_matching_description_and_provider_state interaction
+          find do |candidate_interaction|
+            candidate_interaction.matches_criteria?(description: interaction.description, provider_state: interaction.provider_state)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact/mock_service/logger.rb

@@ -0,0 +1,27 @@
+require 'logger'
+
+module Pact
+  module MockService
+    class Logger < ::Logger
+
+      attr_reader :description
+
+      def initialize stream
+        super stream
+        @description = if stream.is_a? File
+           File.absolute_path(stream).gsub(Dir.pwd + "/", '')
+        else
+          "standard out/err"
+        end
+      end
+
+      def self.from_options options
+        log_stream = options[:log_file] || $stdout
+        logger = new log_stream
+        logger.formatter = options[:log_formatter] if options[:log_formatter]
+        logger.level = Pact.configuration.logger.level
+        logger
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require 'pact/consumer/mock_service/rack_request_helper'
+require 'pact/mock_service/request_handlers/base_request_handler'
+
+module Pact
+  module MockService
+    module RequestHandlers
+      class BaseAdministrationRequestHandler < BaseRequestHandler
+
+        attr_accessor :logger, :name
+
+        def initialize name, logger
+          @name = name
+          @logger = logger
+        end
+
+        def match? env
+          has_mock_service_header?(env) && path_matches?(env) && method_matches?(env)
+        end
+
+        def has_mock_service_header? env
+          env['HTTP_X_PACT_MOCK_SERVICE']
+        end
+
+        def path_matches? env
+          env['PATH_INFO'].chomp("/") == request_path
+        end
+
+        def method_matches? env
+          env['REQUEST_METHOD'] == request_method
+        end
+
+        def request_path
+          raise NotImplementedError
+        end
+
+        def request_method
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'pact/consumer/mock_service/rack_request_helper'
+
+module Pact
+  module MockService
+    module RequestHandlers
+      class BaseRequestHandler
+
+        NOT_FOUND_RESPONSE = [404, {}, []].freeze
+
+        include Pact::Consumer::RackRequestHelper
+
+        def match? env
+          raise NotImplementedError
+        end
+
+        def call env
+          match?(env) ? respond(env) : NOT_FOUND_RESPONSE
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require 'pact/mock_service/request_handlers/base_administration_request_handler'
+
+module Pact
+  module MockService
+    module RequestHandlers
+
+      class IndexGet < BaseAdministrationRequestHandler
+
+        def request_path
+          ''
+        end
+
+        def request_method
+          'GET'
+        end
+
+        def respond env
+          [200, {'Content-Type' => 'text/plain'}, ['Mock service running']]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require 'pact/mock_service/request_handlers/base_administration_request_handler'
+
+module Pact
+  module MockService
+    module RequestHandlers
+
+      class InteractionDelete < BaseAdministrationRequestHandler
+
+        attr_accessor :session
+
+        def initialize name, logger, session
+          super name, logger
+          @session = session
+        end
+
+        def request_path
+          '/interactions'
+        end
+
+        def request_method
+          'DELETE'
+        end
+
+        def respond env
+          session.clear_expected_and_actual_interactions
+          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
+end