如何在rspec中的测试运行中共享代码？

Question

I'm writing tests for my API. I would like to output the request, params and other such data to a file when the the tests are run. I have added a log call in each of my test methods that calls to my utilites.rb file in spec/support. This works as expected except the utilities are loaded on each individual test so I can't write to the file how I want to.

Here is my spec_helper.rb

# This file is copied to spec/ when you run 'rails generate rspec:install'
ENV["RAILS_ENV"] ||= 'test'
require File.expand_path("../../conf
require 'rspec/autorun'ig/environment", __FILE__)
require 'rspec/rails'

# Requires supporting ruby files with custom matchers and macros, etc,
# in spec/support/ and its subdirectories.
Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }

RSpec.configure do |config|
  # ## Mock Framework
  #
  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
  #
  # config.mock_with :mocha
  # config.mock_with :flexmock
  # config.mock_with :rr

  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
  config.fixture_path = "#{::Rails.root}/spec/fixtures"

  # If you're not using ActiveRecord, or you'd prefer not to run each of your
  # examples within a transaction, remove the following line or assign false
  # instead of true.
  config.use_transactional_fixtures = true

  # If true, the base class of anonymous controllers will be inferred
  # automatically. This will be the default behavior in future versions of
  # rspec-rails.
  config.infer_base_class_for_anonymous_controllers = false

  # Run specs in random order to surface order dependencies. If you find an
  # order dependency and want to debug it, you can fix the order by providing
  # the seed, which is printed after each run.
  #     --seed 1234
  config.order = "random"

  config.include Requests::JsonHelpers, type: :request
  config.include Utilities
end

Utilities.rb

module Utilities
  EQUAL_STRING = "=========================\n"
  TEST_OUTPUT = "test_output.txt"

  def log
    s = "#{request.method} #{request.path}\n" +
        "Controller: #{request.params[:controller]}\n" +
        "Action: #{request.params[:action]}\n" +
        "Params:\n" +
        JSON.pretty_generate(JSON.parse(request.query_parameters.to_json)) + "\n" +
        "\n" +
        "Response:\n" +
        "Status: #{response.status}\n" +
        JSON.pretty_generate(JSON.parse(response.body)) + "\n" +
        EQUAL_STRING

    write_to_file s
  end

  private

    def write_to_file(input)
      if @file.nil?
        @file = TEST_OUTPUT
        if File.exists? @file
          File.delete @file
        end
      end

      File.open(@file, 'a') do |f|
        puts input
        f.puts input
      end
    end
end

As you can see from the files I would like to append to a test_output.txt after running each test but I would like that file to be cleared between running rspec spec/ each time. How can I make this work the way I want it to?

Answer 1

first of all, i don't think that this is a good idea. if you want to debug your application, you can read more about it here: http://nofail.de/2013/10/debugging-rails-applications-in-development/

if you really really really have to do it, do it like this:

assuming you are doing this in your controller tests, add something like this to your spec_helper.rb :

  config.before(:all, type: :controller) do
    clear_log_file
  end

  config.after(:each, type: :controller) do
    log_request
  end

where clear_log_file and log_request refer to the code you will use according to your Utilities module.

this way you won't even have to add anything to your specs to write the log.

i'm just about 90% sure that this works, but at least it's the general direction of what you should do.

Answer 2

I had to add to the spec helper.

config.before(:suite) do
  #code I added
end