pact-mock_service 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22b2ac0e4b25a237d1b534c112e0dae09fbf268f
-  data.tar.gz: 2d3d54b21a35501ea75660f2007a17a8be8c12f7
+  metadata.gz: ebcb0082a273a588dcca76818918e469ad66fad1
+  data.tar.gz: 0555f3c7bc6f652577e3efb3f96967fd203437f5
 SHA512:
-  metadata.gz: 535ec260ca77b6b4e02f7f35959695a0991c5ec62b16c7a9b16411b77665fcbda76873daf20146ff809dc10e2d1ffeb0741570b75a17fd9bcae783f3d521cd56
-  data.tar.gz: 42f362f541e289fe68358cedcb39573c144131615f7b0f78470276fc32c7d39d541c15a534af93289dcd51489a3093bd0e7d97ff6303ea3537a45289a71781bb
+  metadata.gz: ca2923d11a5d07fec5906ef98eb2300048d23247fff17efcbc99ea4c1706aec9f9116c346debaf8fdcbb19725ce36f5ce7719a4181764b71402d4d7298cb1155
+  data.tar.gz: 368e8f6e568cbf212f5c6e64009b9cd0caa7832979025091ccd7676853aa4e413b1631a8ec92805b58cf59d0881a9c0a9f844ac368771d0449ebbd76073880e7

data/CHANGELOG.md

@@ -2,6 +2,14 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+### 0.2.4 (24 Jan 2015)
+
+* b14050e - Add --ssl option for control server (Beth, Sat Jan 24 22:14:14 2015 +1100)
+* a9821fd - Add --cors option to control command (Beth, Sat Jan 24 21:51:40 2015 +1100)
+* 16d62c8 - Added endpoint to check if server is up and running without causing an error (Beth, Thu Jan 8 14:33:26 2015 +1100)
+* f93ff1f - Added restart for control and mock service (Beth, Thu Jan 8 14:02:19 2015 +1100)
+* 54b2cb8 - Added control server to allow mock servers to be dynamically set up (Beth, Wed Jan 7 08:24:19 2015 +1100)
+
 ### 0.2.3 (21 Jan 2015)
 
 * 560671e - Add support for using Pact::Terms in the path (Beth, Wed Jan 21 07:42:10 2015 +1100)

data/lib/pact/consumer/app_manager.rb

@@ -6,7 +6,8 @@ require 'find_a_port'
 require 'pact/logging'
 require 'pact/consumer/server'
 require 'singleton'
-require 'pact/consumer/mock_service/app'
+require 'pact/consumer/mock_service'
+require 'find_a_port'
 
 module Pact
   module Consumer
@@ -37,15 +38,6 @@ module Pact
         port
       end
 
-      def existing_app_on_port port
-        app_registration = @app_registrations.find { |app_registration| app_registration.port == port }
-        app_registration ? app_registration.app : nil
-      end
-
-      def app_registered_on?(port)
-        app_registrations.any? { |app_registration| app_registration.port == port }
-      end
-
       def ports_of_mock_services
         app_registrations.find_all(&:is_a_mock_service?).collect(&:port)
       end
@@ -65,8 +57,21 @@ module Pact
         @apps_spawned = true
       end
 
+      def app_registered_on?(port)
+        app_registrations.any? { |app_registration| app_registration.port == port }
+      end
+
       private
 
+      def existing_app_on_port port
+        app_registration = registration_on_port port
+        app_registration ? app_registration.app : nil
+      end
+
+      def registration_on_port port
+        @app_registrations.find { |app_registration| app_registration.port == port }
+      end
+
       def pact_dir
         Pact.configuration.pact_dir
       end
@@ -106,22 +111,17 @@ module Pact
       include Pact::Logging
       attr_accessor :port
       attr_accessor :app
-      attr_accessor :pid
 
       def initialize opts
         @max_wait = 10
         @port = opts[:port]
-        @pid = opts[:pid]
         @app = opts[:app]
+        @spawned = false
       end
 
       def kill
-        # TODO: need to work out how to kill
-        # logger.info "Killing #{self}"
-        # Process.kill(9, pid)
-        # Process.wait(pid)
-        # self.pid = nil
-        self.pid = nil
+        logger.debug "Supposed to be stopping"
+        @spawned = false
       end
 
       def not_spawned?
@@ -129,7 +129,7 @@ module Pact
       end
 
       def spawned?
-        self.pid != nil
+        @spawned
       end
 
       def is_a_mock_service?
@@ -137,27 +137,15 @@ module Pact
       end
 
       def to_s
-        "#{app} on port #{port}" + (@pid ? " with pid #{pid}" : "")
+        "#{app} on port #{port}"
       end
 
       def spawn
         logger.info "Starting app #{self}..."
-        Pact::Server.new(app, port).boot
-        self.pid = 'unknown'
-        logger.info "Started with pid #{pid}"
-      end
-
-      def wait_until
-        waited = 0
-        wait_time = 0.1
-        while waited < @max_wait do
-          break if yield
-          sleep wait_time
-          waited += wait_time
-          raise "Waited longer than #{@max_wait} seconds" if waited >= @max_wait
-        end
+        @server = Pact::Server.new(app, port).boot
+        @spawned = true
+        logger.info "Started on port #{port}"
       end
-
     end
   end
 end

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

@@ -2,46 +2,17 @@ require 'rack'
 require 'uri'
 require 'json'
 require 'logger'
-require 'pact/consumer/request'
-require 'pact/consumer/mock_service/expected_interactions'
-require 'pact/consumer/mock_service/actual_interactions'
-require 'pact/consumer/mock_service/verified_interactions'
-require 'pact/consumer/mock_service/interaction_delete'
-require 'pact/consumer/mock_service/interaction_post'
-require 'pact/consumer/mock_service/interaction_replay'
-require 'pact/consumer/mock_service/missing_interactions_get'
-require 'pact/consumer/mock_service/verification_get'
-require 'pact/consumer/mock_service/log_get'
-require 'pact/consumer/mock_service/pact_post'
-require 'pact/consumer/mock_service/options'
 require 'pact/consumer/mock_service/cors_origin_header_middleware'
-require 'pact/support'
+require 'pact/consumer/mock_service/request_handlers'
 
 module Pact
   module Consumer
-
     class MockService
-
-      def initialize options = {}
-        inner_app = InnerApp.new(options)
-        @app = CorsOriginHeaderMiddleware.new(inner_app, options[:cors_enabled])
-      end
-
-      def call env
-        @app.call env
-      end
-
-      def shutdown
-        @app.shutdown
-      end
-
-      class InnerApp
+      class App
 
         def initialize options = {}
-          log_description = configure_logger options
-
           @name = options.fetch(:name, "MockService")
-          pact_dir = options[:pact_dir]
+          @logger = options.fetch(:logger)
           expected_interactions = ExpectedInteractions.new
           actual_interactions = ActualInteractions.new
           verified_interactions = VerifiedInteractions.new
@@ -52,33 +23,11 @@ module Pact
             interactions: verified_interactions
           }
 
-          @handlers = [
-            Options.new(@name, @logger, options[:cors_enabled]),
-            MissingInteractionsGet.new(@name, @logger, expected_interactions, actual_interactions),
-            VerificationGet.new(@name, @logger, expected_interactions, actual_interactions, log_description),
-            InteractionPost.new(@name, @logger, expected_interactions, verified_interactions),
-            InteractionDelete.new(@name, @logger, expected_interactions, actual_interactions),
-            LogGet.new(@name, @logger),
-            PactPost.new(@name, @logger, verified_interactions, pact_dir, options[:consumer_contract_details]),
-            InteractionReplay.new(@name, @logger, expected_interactions, actual_interactions, verified_interactions, options[:cors_enabled])
-          ]
+          @request_handlers = Pact::Consumer::MockService::RequestHandlers.new(@name, @logger, expected_interactions, actual_interactions, verified_interactions, options)
         end
 
         def call env
-          response = []
-          begin
-            relevant_handler = @handlers.detect { |handler| handler.match? env }
-            response = relevant_handler.respond(env)
-          rescue StandardError => e
-            @logger.error "Error ocurred in mock service: #{e.class} - #{e.message}"
-            @logger.error e.backtrace.join("\n")
-            response = [500, {'Content-Type' => 'application/json'}, [{message: e.message, backtrace: e.backtrace}.to_json]]
-          rescue Exception => e
-            @logger.error "Exception ocurred in mock service: #{e.class} - #{e.message}"
-            @logger.error e.backtrace.join("\n")
-            raise e
-          end
-          response
+          @request_handlers.call(env)
         end
 
         def shutdown
@@ -92,30 +41,17 @@ module Pact
           consumer_contract_writer.write if consumer_contract_writer.can_write?
         end
 
-        def configure_logger options
-          options = {log_file: $stdout}.merge options
-          log_stream = options[:log_file]
-          @logger = Logger.new log_stream
-          @logger.formatter = options[:log_formatter] if options[:log_formatter]
-          @logger.level = Pact.configuration.logger.level
-
-          if log_stream.is_a? File
-             File.absolute_path(log_stream).gsub(Dir.pwd + "/", '')
-          else
-            "standard out/err"
-          end
-        end
-
         def to_s
           "#{@name} #{super.to_s}"
         end
 
-        class StdoutLogger
-          def info message
-            $stdout.puts "\n#{message}"
-          end
-        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/error_handler.rb

@@ -0,0 +1,28 @@
+module Pact
+  module Consumer
+    class MockService
+      class ErrorHandler
+
+        def initialize app, logger
+          @app = app
+          @logger = logger
+        end
+
+        def call env
+          begin
+            @app.call(env)
+          rescue StandardError => e
+            message = "Error ocurred in mock service: #{e.class} - #{e.message}"
+            @logger.error message
+            @logger.error e.backtrace.join("\n")
+            [500, {'Content-Type' => 'application/json'}, [{message: message, backtrace: e.backtrace}.to_json]]
+          end
+        end
+
+        def shutdown
+          @app.shutdown
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+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,10 +1,10 @@
 require 'pact/consumer/mock_service/rack_request_helper'
-require 'pact/consumer/mock_service/web_request_administration'
+require 'pact/consumer/mock_service/mock_service_administration_endpoint'
 
 module Pact
   module Consumer
 
-    class InteractionDelete < WebRequestAdministration
+    class InteractionDelete < MockServiceAdministrationEndpoint
 
       include RackRequestHelper
 
@@ -36,4 +36,4 @@ module Pact
       end
     end
   end
-end
+end

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

@@ -1,10 +1,10 @@
-require 'pact/consumer/mock_service/web_request_administration'
+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 < WebRequestAdministration
+    class InteractionPost < MockServiceAdministrationEndpoint
 
       def initialize name, logger, expected_interactions, verified_interactions
         super name, logger

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

@@ -1,8 +1,8 @@
-require 'pact/consumer/mock_service/web_request_administration'
+require 'pact/consumer/mock_service/mock_service_administration_endpoint'
 
 module Pact
   module Consumer
-    class LogGet < WebRequestAdministration
+    class LogGet < MockServiceAdministrationEndpoint
 
       include RackRequestHelper
 

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

@@ -1,10 +1,10 @@
-require 'pact/consumer/mock_service/web_request_administration'
+require 'pact/consumer/mock_service/mock_service_administration_endpoint'
 require 'pact/consumer/mock_service/verification'
 
 module Pact
   module Consumer
 
-    class MissingInteractionsGet < WebRequestAdministration
+    class MissingInteractionsGet < MockServiceAdministrationEndpoint
       include RackRequestHelper
 
       def initialize name, logger, expected_interactions, actual_interactions
@@ -27,7 +27,6 @@ module Pact
         logger.info "Number of missing interactions for mock \"#{name}\" = #{number_of_missing_interactions}"
         [200, {}, [{size: number_of_missing_interactions}.to_json]]
       end
-
     end
   end
 end

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

@@ -13,29 +13,27 @@ module Pact
       end
 
       def match? env
-        (request_header_match? env) && (request_path_match? env) && (request_method_match? env)
+        has_mock_service_header?(env) && path_matches?(env) && method_matches?(env)
       end
 
-      def request_path
-        raise NotImplementedError
+      def has_mock_service_header? env
+        env['HTTP_X_PACT_MOCK_SERVICE']
       end
 
-      def request_method
-        raise NotImplementedError
+      def path_matches? env
+        env['PATH_INFO'].chomp("/") == request_path
       end
 
-      private
-
-      def request_header_match? env
-        raise NotImplementedError
+      def method_matches? env
+        env['REQUEST_METHOD'] == request_method
       end
 
-      def request_path_match? env
-        env['PATH_INFO'] == request_path
+      def request_path
+        raise NotImplementedError
       end
 
-      def request_method_match? env
-        env['REQUEST_METHOD'] == request_method
+      def request_method
+        raise NotImplementedError
       end
     end
   end

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

@@ -1,9 +1,9 @@
+require 'pact/consumer/mock_service/mock_service_administration_endpoint'
 require 'pact/consumer_contract/consumer_contract_writer'
-require 'pact/consumer/mock_service/web_request_administration'
 
 module Pact
   module Consumer
-    class PactPost < WebRequestAdministration
+    class PactPost < MockServiceAdministrationEndpoint
 
       attr_accessor :consumer_contract, :verified_interactions, :default_options
 

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

@@ -0,0 +1,41 @@
+require 'pact/consumer/mock_service/expected_interactions'
+require 'pact/consumer/mock_service/actual_interactions'
+require 'pact/consumer/mock_service/verified_interactions'
+require 'pact/consumer/mock_service/interaction_delete'
+require 'pact/consumer/mock_service/interaction_post'
+require 'pact/consumer/mock_service/interaction_replay'
+require 'pact/consumer/mock_service/missing_interactions_get'
+require 'pact/consumer/mock_service/verification_get'
+require 'pact/consumer/mock_service/log_get'
+require 'pact/consumer/mock_service/pact_post'
+require 'pact/consumer/mock_service/index_get'
+require 'pact/consumer/mock_service/options'
+require 'pact/consumer/request'
+require 'pact/support'
+
+module Pact
+  module Consumer
+    class MockService
+      class RequestHandlers
+        def initialize name, logger, expected_interactions, actual_interactions, verified_interactions, options
+          @handlers = [
+            Options.new(name, logger, options[:cors_enabled]),
+            MissingInteractionsGet.new(name, logger, expected_interactions, actual_interactions),
+            VerificationGet.new(name, logger, expected_interactions, actual_interactions, options[:log_description]),
+            InteractionPost.new(name, logger, expected_interactions, verified_interactions),
+            InteractionDelete.new(name, logger, expected_interactions, actual_interactions),
+            LogGet.new(name, logger),
+            PactPost.new(name, logger, verified_interactions, options[:pact_dir], options[:consumer_contract_details]),
+            IndexGet.new(name, logger),
+            InteractionReplay.new(name, logger, expected_interactions, actual_interactions, verified_interactions, options[:cors_enabled])
+          ]
+        end
+
+        def call env
+          relevant_handler = @handlers.detect { |handler| handler.match? env }
+          response = relevant_handler.respond(env)
+        end
+      end
+    end
+  end
+end

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

@@ -1,8 +1,8 @@
-require 'pact/consumer/mock_service/web_request_administration'
+require 'pact/consumer/mock_service/mock_service_administration_endpoint'
 
 module Pact
   module Consumer
-    class VerificationGet < WebRequestAdministration
+    class VerificationGet < MockServiceAdministrationEndpoint
 
       include RackRequestHelper
 

data/lib/pact/consumer/mock_service.rb

@@ -1,2 +1,43 @@
 require 'pact/consumer/mock_service/app'
+require 'pact/consumer/mock_service/error_handler'
 
+module Pact
+  module Consumer
+
+    class MockService
+
+      def initialize options = {}
+        logger, log_description = configure_logger(options)
+        app_options = options.merge(logger: logger, log_description: log_description)
+        @app = Rack::Builder.app do
+          use ErrorHandler, logger
+          use CorsOriginHeaderMiddleware, options[:cors_enabled]
+          run App.new(app_options)
+        end
+      end
+
+      def call env
+        @app.call env
+      end
+
+      def shutdown
+        @app.shutdown
+      end
+
+      def configure_logger options
+        options = {log_file: $stdout}.merge options
+        log_stream = options[:log_file]
+        logger = Logger.new log_stream
+        logger.formatter = options[:log_formatter] if options[:log_formatter]
+        logger.level = Pact.configuration.logger.level
+
+        log_description = if log_stream.is_a? File
+           File.absolute_path(log_stream).gsub(Dir.pwd + "/", '')
+        else
+          "standard out/err"
+        end
+        return logger, log_description
+      end
+    end
+  end
+end

data/lib/pact/consumer/server.rb

@@ -32,13 +32,14 @@ module Pact
       end
     end
 
-    attr_reader :app, :port
+    attr_reader :app, :port, :options
 
-    def initialize(app, port)
+    def initialize(app, port, options = {})
       @app = app
       @middleware = Middleware.new(@app)
-      @server_thread = nil # supress warnings
+      @server_thread = nil
       @port = port
+      @options = options
     end
 
     def reset_error!
@@ -55,9 +56,7 @@ module Pact
 
     def responsive?
       return false if @server_thread && @server_thread.join(0)
-
-      res = Net::HTTP.start(host, @port) { |http| http.get('/__identify__') }
-
+      res = get_identity
       if res.is_a?(Net::HTTPSuccess) or res.is_a?(Net::HTTPRedirection)
         return res.body == @app.object_id.to_s
       end
@@ -69,7 +68,29 @@ module Pact
 
     def run_default_server(app, port)
       require 'rack/handler/webrick'
-      Rack::Handler::WEBrick.run(app, :Port => port, :AccessLog => [], :Logger => WEBrick::Log::new(nil, 0))
+      Rack::Handler::WEBrick.run(app, webrick_opts)
+    end
+
+    def get_identity
+      http = Net::HTTP.new host, @port
+      if options[:ssl]
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      http.get('/__identify__')
+    end
+
+    def webrick_opts
+      opts = {:Port => port, :AccessLog => [], :Logger => WEBrick::Log::new(nil, 0)}
+      opts.merge!(ssl_opts) if options[:ssl]
+      opts
+    end
+
+    def ssl_opts
+      {
+        :SSLEnable => true,
+        :SSLCertName => [ %w[CN localhost] ]
+      }
     end
 
     def boot