right_develop 2.1.5 → 2.2.0

data/VERSION

@@ -1 +1 @@
-2.1.5
+2.2.0

data/bin/right_develop

@@ -1,5 +1,9 @@
 #!/usr/bin/env ruby
 
+unless Gem.respond_to?(:latest_spec_for)
+  fail 'right_develop command line tools require rubygems v1.8+'
+end
+
 require "trollop"
 
 require "right_develop"

data/lib/right_develop.rb

@@ -29,6 +29,7 @@ module RightDevelop
   autoload :Commands, 'right_develop/commands'
   autoload :Git,      'right_develop/git'
   autoload :Parsers,  'right_develop/parsers'
+  autoload :Testing,  'right_develop/testing'
   autoload :Utility,  'right_develop/utility'
 end
 

data/lib/right_develop/commands.rb

@@ -3,4 +3,5 @@ module RightDevelop
   end
 end
 
-require "right_develop/commands/git"
+require 'right_develop/commands/git'
+require 'right_develop/commands/server'

data/lib/right_develop/commands/server.rb

@@ -0,0 +1,194 @@
+#
+# Copyright (c) 2014 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'right_develop'
+require 'right_develop/testing/servers/might_api/lib/config'
+require 'tmpdir'
+
+module RightDevelop::Commands
+  class Server
+    include RightSupport::Log::Mixin
+
+    CONFIG_CLASS = ::RightDevelop::Testing::Server::MightApi::Config
+
+    TASKS = CONFIG_CLASS::VALID_MODES
+
+    class PlainFormatter < ::Logger::Formatter
+      def call(severity, time, progname, msg)
+        sprintf("%s\n", msg2str(msg))
+      end
+    end
+
+     # Parse command-line options and create a Command object
+    def self.create
+      task_list = TASKS.sort.inject([]) do |a, (k, v)|
+        a << ' * %s%s' % [k.to_s.ljust(10), v]
+      end.join("\n")
+
+      options = Trollop.options do
+        banner <<-EOS
+The 'server' command starts a server in the foreground to assist in testing.
+The behavior of the server depends on the type specified.
+
+Usage:
+  right_develop server <task> [options]
+
+Where <task> is one of:
+#{task_list}
+
+And [options] are selected from:
+        EOS
+        opt :root_dir, 'Root directory for config and fixtures',
+            :default => ::Dir.pwd
+        opt :port, 'Port on which server will listen',
+            :default => 9292
+        opt :force, 'Force overwrite of any existing recording',
+            :default => false
+        opt :throttle, 'Playback delay as a percentage of recorded response time',
+            :default => 0
+        opt :debug, 'Enable verbose debug output',
+            :default => false
+      end
+
+      task = ARGV.shift.to_s
+      if TASKS.keys.include?(task)
+        self.new(task.to_sym, options)
+      else
+        ::Trollop.die "unknown task #{task}"
+      end
+    end
+
+    # @param [Symbol] task one of :prune or :tickets
+    # @option options [String] :root_dir for config and fixtures.
+    # @option options [String] :ruby_version to select with rbenv when running server
+    # @option options [String] :debug is true for debug-level logging
+    def initialize(task, options)
+      logger = ::Logger.new(STDOUT)
+      logger.level = options[:debug] ? ::Logger::DEBUG : ::Logger::WARN
+      logger.formatter = PlainFormatter.new
+      ::RightSupport::Log::Mixin.default_logger = logger
+
+      @task = task
+      @options = options
+    end
+
+    # Run the task that was specified when this object was instantiated. This
+    # method does no work; it just delegates to a task method.
+    def run
+      run_might_api(@task, @options)
+    end
+
+    protected
+
+    def shell
+      ::RightDevelop::Utility::Shell
+    end
+
+    def run_might_api(mode, options)
+      if shell.is_windows?
+        ::Trollop.die 'Not supported under Windows'
+      end
+      if RUBY_VERSION < '1.9.3'
+        ::Trollop.die 'Requires a minimum of ruby 1.9.3'
+      end
+      server_root_dir = ::File.expand_path('../../testing/servers/might_api', __FILE__)
+      root_dir = ::File.expand_path(options[:root_dir])
+      [server_root_dir, root_dir].each do |dir|
+        unless ::File.directory?(dir)
+          ::Trollop.die "Missing expected directory: #{dir.inspect}"
+        end
+      end
+
+      # sanity checks.
+      config = nil
+      ::Dir.chdir(root_dir) do
+        config = CONFIG_CLASS.from_file(
+          CONFIG_CLASS::DEFAULT_CONFIG_PATH,
+          mode:      mode,
+          log_level: options[:debug] ? :debug : :info,
+          throttle:  options[:throttle])
+      end
+      fixtures_dir = config.fixtures_dir
+      tmp_root_dir = ::Dir.mktmpdir
+      tmp_config_path = ::File.join(tmp_root_dir, CONFIG_CLASS::DEFAULT_CONFIG_PATH)
+      case mode
+      when :record
+        if ::File.directory?(fixtures_dir)
+          if options[:force]
+            logger.warn("Overwriting existing #{fixtures_dir.inspect} due to force=true")
+            ::FileUtils.rm_rf(fixtures_dir)
+          else
+            ::Trollop.die "Unable to record over existing directory: #{fixtures_dir.inspect}"
+          end
+        end
+      when :playback
+        unless ::File.directory?(fixtures_dir)
+          ::Trollop.die "Missing expected directory: #{fixtures_dir.inspect}"
+        end
+
+        # copy fixtures tmp location so that multiple server instances can
+        # playback the same fixture directory but keep their own state (even if
+        # original gets re-recorded, etc.).
+        tmp_fixtures_dir = ::File.expand_path(CONFIG_CLASS::FIXTURES_DIR_NAME, tmp_root_dir)
+        ::FileUtils.mkdir_p(tmp_fixtures_dir)
+        ::FileUtils.cp_r(::File.join(fixtures_dir, '.'), tmp_fixtures_dir)
+        config.fixtures_dir(tmp_fixtures_dir)
+        config.normalize_fixtures_dir(logger)
+      end
+
+      # write updated config to tmp location.
+      ::FileUtils.mkdir_p(::File.dirname(tmp_config_path))
+      ::File.open(tmp_config_path, 'w') { |f| f.puts ::YAML.dump(config.to_hash) }
+
+      ::Dir.chdir(server_root_dir) do
+        logger.warn("in #{server_root_dir.inspect}")
+        logger.warn('Preparing to run server...')
+        shell.execute('bundle check || bundle install')
+        logger.level = options[:debug] ? ::Logger::DEBUG : ::Logger::INFO
+        begin
+          cmd = "cat #{tmp_config_path.inspect} | bundle exec rackup --port #{options[:port]}"
+          shell.execute(cmd)
+        rescue ::Interrupt
+          # server runs in foreground so interrupt is normal
+        ensure
+          case mode
+          when :record
+            # remove temporary record state file from root of fixtures directory.
+            ::Dir[::File.join(config.fixtures_dir, '*.yml')].each do |path|
+              begin
+                ::File.unlink(path)
+              rescue ::Exception => e
+                logger.error("Unable to remove #{path.inspect}:\n  #{e.class}: #{e.message}")
+              end
+            end
+          end
+          begin
+            ::FileUtils.rm_rf(tmp_root_dir)
+          rescue ::Exception => e
+            logger.error("Unable to remove #{tmp_root_dir.inspect}:\n  #{e.class}: #{e.message}")
+          end
+        end
+      end
+    end
+
+  end # Server
+end # RightDevelop::Commands

data/lib/right_develop/testing.rb

@@ -0,0 +1,31 @@
+#
+# Copyright (c) 2014 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# ancestor
+require 'right_develop'
+
+module RightDevelop
+  module Testing
+    autoload :Client, 'right_develop/testing/clients'
+    autoload :Recording, 'right_develop/testing/recording'
+  end
+end

data/lib/right_develop/testing/clients.rb

@@ -0,0 +1,36 @@
+#
+# Copyright (c) 2014 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# ancestor
+require 'right_develop/testing'
+
+module RightDevelop
+  module Testing
+    module Client
+      autoload :Formats, 'right_develop/testing/clients/formats'
+
+      autoload :RecordMetadata, 'right_develop/testing/clients/record_metadata'
+
+      autoload :Rest, 'right_develop/testing/clients/rest'
+    end
+  end
+end

data/lib/right_develop/testing/clients/rest.rb

@@ -0,0 +1,34 @@
+#
+# Copyright (c) 2014 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+               
+# ancestor
+require 'right_develop/testing/clients'
+
+module RightDevelop
+  module Testing
+    module Client
+      module Rest
+        autoload :Request, 'right_develop/testing/clients/rest/requests'
+      end
+    end
+  end
+end

data/lib/right_develop/testing/clients/rest/requests.rb

@@ -0,0 +1,38 @@
+#
+# Copyright (c) 2014 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+               
+# ancestor
+require 'right_develop/testing/clients/rest'
+
+module RightDevelop
+  module Testing
+    module Client
+      module Rest
+        module Request
+          autoload :Base,     'right_develop/testing/clients/rest/requests/base'
+          autoload :Playback, 'right_develop/testing/clients/rest/requests/playback'
+          autoload :Record,   'right_develop/testing/clients/rest/requests/record'
+        end
+      end
+    end
+  end
+end

data/lib/right_develop/testing/clients/rest/requests/base.rb

@@ -0,0 +1,305 @@
+#
+# Copyright (c) 2014 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# ancestor
+require 'right_develop/testing/clients/rest'
+require 'right_develop/testing/recording/metadata'
+
+require 'digest/md5'
+require 'rack/utils'
+require 'rest_client'
+require 'right_support'
+require 'thread'
+require 'yaml'
+
+module RightDevelop::Testing::Client::Rest::Request
+
+  # Base class for record/playback request implementations.
+  class Base < ::RestClient::Request
+
+    # metadata.
+    METADATA_CLASS = ::RightDevelop::Testing::Recording::Metadata
+
+    # semaphore
+    MUTEX = ::Mutex.new
+
+    attr_reader :fixtures_dir, :logger, :route_path, :route_data
+    attr_reader :state_file_path, :request_timestamp, :response_timestamp
+    attr_reader :request_metadata, :response_metadata
+
+    def initialize(args)
+      args = args.dup
+      unless @fixtures_dir = args.delete(:fixtures_dir)
+        raise ::ArgumentError, 'fixtures_dir is required'
+      end
+      unless @logger = args.delete(:logger)
+        raise ::ArgumentError, 'logger is required'
+      end
+      unless @route_path = args.delete(:route_path)
+        raise ::ArgumentError, 'route_path is required'
+      end
+      unless @route_data = args.delete(:route_data)
+        raise ::ArgumentError, 'route_data is required'
+      end
+      unless @route_data[:subdir]
+        raise ::ArgumentError, "route_data is invalid: #{route_data.inspect}"
+      end
+      unless @state_file_path = args.delete(:state_file_path)
+        raise ::ArgumentError, 'state_file_path is required'
+      end
+
+      # resolve request metadata before initializing base class in order to set
+      # any timeout values.
+      request_verb = args[:method] or raise ::ArgumentError, "must pass :method"
+      request_verb = request_verb.to_s.upcase
+      request_headers = (args[:headers] || {}).dup
+      request_url = args[:url] or raise ::ArgumentError, "must pass :url"
+      request_url = process_url_params(request_url, request_headers)
+      if request_body = args[:payload]
+        # currently only supporting string payload or nil.
+        unless request_body.kind_of?(::String)
+          raise ::ArgumentError, 'args[:payload] must be a string'
+        end
+      end
+
+      rm = nil
+      with_state_lock do |state|
+        rm = METADATA_CLASS.new(
+          mode:       recording_mode,
+          kind:       :request,
+          logger:     @logger,
+          route_data: @route_data,
+          uri:        METADATA_CLASS.normalize_uri(request_url),
+          verb:       request_verb,
+          headers:    request_headers,
+          body:       request_body,
+          variables:  state[:variables])
+      end
+      @request_metadata = rm
+      unless rm.timeouts.empty?
+        args = args.dup
+        if rm.timeouts[:open_timeout]
+          args[:open_timeout] = Integer(rm.timeouts[:open_timeout])
+        end
+        if rm.timeouts[:read_timeout]
+          args[:timeout] = Integer(rm.timeouts[:read_timeout])
+        end
+      end
+      @response_metadata = nil
+
+      super(args)
+
+      if @block_response
+        raise ::NotImplementedError,
+              'block_response not supported for record/playback'
+      end
+      if @raw_response
+        raise ::ArgumentError, 'raw_response not supported for record/playback'
+      end
+    end
+
+    # Overrides log_request to capture start-time for network request.
+    #
+    # @return [Object] undefined
+    def log_request
+      result = super
+      push_outstanding_request
+      result
+    end
+
+    # Overrides log_response to capture end-time for network request.
+    #
+    # @param [RestClient::Response] to capture
+    #
+    # @return [Object] undefined
+    def log_response(response)
+      pop_outstanding_request
+      super
+    end
+
+    # Handles a timeout raised by a Net::HTTP call.
+    #
+    # @return [Net::HTTPResponse] response or nil if subclass responsibility
+    def handle_timeout
+      pop_outstanding_request
+      nil
+    end
+
+    # Removes the current request from the FIFO queue of outstanding requests in
+    # case of error, redirect, etc.
+    def forget_outstanding_request
+      ruid = request_uid
+      ork = outstanding_request_key
+      with_state_lock do |state|
+        outstanding = state[:outstanding]
+        if outstanding_requests = outstanding[ork]
+          if outstanding_requests.delete(ruid)
+            logger.debug("Forgot outstanding request uid=#{ruid.inspect} at #{ork.inspect}")
+          end
+          outstanding.delete(ork) if outstanding_requests.empty?
+        end
+      end
+    end
+
+    protected
+
+    # @return [Symbol] recording mode as one of [:record, :playback]
+    def recording_mode
+      raise NotImplementedError, 'Must be overridden'
+    end
+
+    # @return [String] unique identifier for this request (for this process)
+    def request_uid
+      @request_uid ||= ::Digest::MD5.hexdigest("#{::Process.pid}, #{self.object_id}")
+    end
+
+    # @return [String] path to current outstanding request, if any
+    def outstanding_request_key
+      ::File.join(request_metadata.uri.path, request_metadata.checksum)
+    end
+
+    # Holds the state file lock for block.
+    #
+    # @yield [state] gives exclusive state access to block
+    # @yieldparam [Hash] state
+    # @yieldreturn [Object] anything
+    #
+    # @return [Object] block result
+    def with_state_lock
+      result = nil
+      MUTEX.synchronize do  # mutex for thread sync
+        state_dir = ::File.dirname(state_file_path)
+        ::FileUtils.mkdir_p(state_dir) unless ::File.directory?(state_dir)
+        ::File.open(state_file_path, ::File::RDWR | File::CREAT, 0644) do |f|
+          f.flock(::File::LOCK_EX)  # file lock for process sync
+          state_yaml = f.read
+          if state_yaml.empty?
+            state = { epoch: 0, variables: {}, outstanding: {} }
+          else
+            state = ::YAML.load(state_yaml)
+          end
+          result = yield(state)
+          f.seek(0)
+          f.truncate(0)
+          f.puts(::YAML.dump(state))
+        end
+      end
+      result
+    end
+
+    # Keeps a FIFO queue of outstanding requests using request object id in
+    # state to ensure responses are synchronous. This is important for record/
+    # playback of long polling with many threads/processes doing the polling. We
+    # do not want a younger long polling request to steal responses from an
+    # older request because we cannot maintain asynchronous state for playback.
+    #
+    # To make this blocking behavior more reasonable for testing, configure
+    # shorter timeouts for API calls that you know are long polling; the default
+    # read timeout value is 60 seconds. The timeout only effects playback time
+    # if you use throttle > 0.
+    def push_outstanding_request
+      ruid = request_uid
+      ork = outstanding_request_key
+      with_state_lock do |state|
+        outstanding = state[:outstanding]
+        outstanding_requests = outstanding[ork] ||= []
+        outstanding_requests << ruid
+        logger.debug("Pushed outstanding request uid=#{ruid.inspect} at #{ork.inspect}.")
+      end
+      @request_timestamp = ::Time.now.to_i
+      true
+    end
+
+    # Blocks until all similar previous requests have been popped from the
+    # queue. This is simple if there is a single producer/consumer of
+    # request/response but more complex as threads are introduced.
+    def pop_outstanding_request
+      @response_timestamp = ::Time.now.to_i
+      ruid = request_uid
+      ork = outstanding_request_key
+      while ruid do
+        with_state_lock do |state|
+          outstanding = state[:outstanding]
+          outstanding_requests = outstanding[ork]
+          if outstanding_requests.first == ruid
+            outstanding_requests.shift
+            outstanding.delete(ork) if outstanding_requests.empty?
+            logger.debug("Popped outstanding request uid=#{ruid.inspect} at #{ork.inspect}.")
+            ruid = nil
+          end
+        end
+        sleep 0.1 if ruid
+      end
+      true
+    end
+
+    # @return [RightDevelop::Testing::Client::RecordMetdata] metadata for response
+    def create_response_metadata(state, response_code, response_headers, response_body)
+      METADATA_CLASS.new(
+        mode:                   recording_mode,
+        kind:                   :response,
+        logger:                 logger,
+        route_data:             @route_data,
+        effective_route_config: request_metadata.effective_route_config,
+        uri:                    request_metadata.uri,
+        verb:                   request_metadata.verb,
+        http_status:            response_code,
+        headers:                response_headers,
+        body:                   response_body,
+        variables:              state[:variables])
+    end
+
+    # Directory common to all fixtures of the given kind.
+    def fixtures_route_dir(kind, epoch)
+      ::File.join(
+        @fixtures_dir,
+        epoch.to_s,
+        @route_data[:subdir],
+        kind.to_s)
+    end
+
+    # Expands path to fixture file given kind, state, etc.
+    def fixture_file_path(kind, epoch)
+      # remove API root from path because we are already under an API-specific
+      # subdirectory and the route base path may be redundant.
+      unless request_metadata.uri.path.start_with?(@route_path)
+        raise ::ArgumentError,
+              "Request URI = #{request_metadata.uri.path.inspect} did not start with #{@route_path.inspect}."
+      end
+      route_relative_path = request_metadata.uri.path[@route_path.length..-1]
+      ::File.join(
+        fixtures_route_dir(kind, epoch),
+        route_relative_path,
+        request_metadata.checksum + '.yml')
+    end
+
+    def request_file_path(epoch)
+      fixture_file_path(:request, epoch)
+    end
+
+    def response_file_path(epoch)
+      fixture_file_path(:response, epoch)
+    end
+
+  end # Base
+
+end # RightDevelop::Testing::Client::Rest