# frozen_string_literal: true
# :markup: markdown
require "stringio"
require "uri"
require "rack/test"
require "active_support/test_case"
require "action_dispatch/testing/request_encoder"
require "action_dispatch/testing/test_helpers/page_dump_helper"
module ActionDispatch
module Integration # :nodoc:
module RequestHelpers
# Performs a GET request with the given parameters. See
# ActionDispatch::Integration::Session#process for more details.
def get(path, **args)
process(:get, path, **args)
end
# Performs a POST request with the given parameters. See
# ActionDispatch::Integration::Session#process for more details.
def post(path, **args)
process(:post, path, **args)
end
# Performs a PATCH request with the given parameters. See
# ActionDispatch::Integration::Session#process for more details.
def patch(path, **args)
process(:patch, path, **args)
end
# Performs a PUT request with the given parameters. See
# ActionDispatch::Integration::Session#process for more details.
def put(path, **args)
process(:put, path, **args)
end
# Performs a DELETE request with the given parameters. See
# ActionDispatch::Integration::Session#process for more details.
def delete(path, **args)
process(:delete, path, **args)
end
# Performs a HEAD request with the given parameters. See
# ActionDispatch::Integration::Session#process for more details.
def head(path, **args)
process(:head, path, **args)
end
# Performs an OPTIONS request with the given parameters. See
# ActionDispatch::Integration::Session#process for more details.
def options(path, **args)
process(:options, path, **args)
end
# Follow a single redirect response. If the last response was not a redirect, an
# exception will be raised. Otherwise, the redirect is performed on the location
# header. If the redirection is a 307 or 308 redirect, the same HTTP verb will
# be used when redirecting, otherwise a GET request will be performed. Any
# arguments are passed to the underlying request.
#
# The HTTP_REFERER header will be set to the previous url.
def follow_redirect!(headers: {}, **args)
raise "not a redirect! #{status} #{status_message}" unless redirect?
method =
if [307, 308].include?(response.status)
request.method.downcase
else
:get
end
if [ :HTTP_REFERER, "HTTP_REFERER" ].none? { |key| headers.key? key }
headers["HTTP_REFERER"] = request.url
end
public_send(method, response.location, headers: headers, **args)
status
end
end
# An instance of this class represents a set of requests and responses performed
# sequentially by a test process. Because you can instantiate multiple sessions
# and run them side-by-side, you can also mimic (to some limited extent)
# multiple simultaneous users interacting with your system.
#
# Typically, you will instantiate a new session using Runner#open_session,
# rather than instantiating a Session directly.
class Session
DEFAULT_HOST = "www.example.com"
include Minitest::Assertions
include TestProcess, RequestHelpers, Assertions
delegate :status, :status_message, :headers, :body, :redirect?, to: :response, allow_nil: true
delegate :path, to: :request, allow_nil: true
# The hostname used in the last request.
def host
@host || DEFAULT_HOST
end
attr_writer :host
# The remote_addr used in the last request.
attr_accessor :remote_addr
# The Accept header to send.
attr_accessor :accept
# A map of the cookies returned by the last response, and which will be sent
# with the next request.
def cookies
_mock_session.cookie_jar
end
# A reference to the controller instance used by the last request.
attr_reader :controller
# A reference to the request instance used by the last request.
attr_reader :request
# A reference to the response instance used by the last request.
attr_reader :response
# A running counter of the number of requests processed.
attr_accessor :request_count
include ActionDispatch::Routing::UrlFor
# Create and initialize a new Session instance.
def initialize(app)
super()
@app = app
reset!
end
def url_options
@url_options ||= default_url_options.dup.tap do |url_options|
url_options.reverse_merge!(controller.url_options) if controller.respond_to?(:url_options)
if @app.respond_to?(:routes)
url_options.reverse_merge!(@app.routes.default_url_options)
end
url_options.reverse_merge!(host: host, protocol: https? ? "https" : "http")
end
end
# Resets the instance. This can be used to reset the state information in an
# existing session instance, so it can be used from a clean-slate condition.
#
# session.reset!
def reset!
@https = false
@controller = @request = @response = nil
@_mock_session = nil
@request_count = 0
@url_options = nil
self.host = DEFAULT_HOST
self.remote_addr = "127.0.0.1"
self.accept = "text/xml,application/xml,application/xhtml+xml," \
"text/html;q=0.9,text/plain;q=0.8,image/png," \
"*/*;q=0.5"
unless defined? @named_routes_configured
# the helpers are made protected by default--we make them public for easier
# access during testing and troubleshooting.
@named_routes_configured = true
end
end
# Specify whether or not the session should mimic a secure HTTPS request.
#
# session.https!
# session.https!(false)
def https!(flag = true)
@https = flag
end
# Returns `true` if the session is mimicking a secure HTTPS request.
#
# if session.https?
# ...
# end
def https?
@https
end
# Performs the actual request.
#
# * `method`: The HTTP method (GET, POST, PATCH, PUT, DELETE, HEAD, OPTIONS)
# as a symbol.
# * `path`: The URI (as a String) on which you want to perform the request.
# * `params`: The HTTP parameters that you want to pass. This may be `nil`, a
# Hash, or a String that is appropriately encoded
# (`application/x-www-form-urlencoded` or `multipart/form-data`).
# * `headers`: Additional headers to pass, as a Hash. The headers will be
# merged into the Rack env hash.
# * `env`: Additional env to pass, as a Hash. The headers will be merged into
# the Rack env hash.
# * `xhr`: Set to `true` if you want to make an Ajax request. Adds request
# headers characteristic of XMLHttpRequest e.g. HTTP_X_REQUESTED_WITH. The
# headers will be merged into the Rack env hash.
# * `as`: Used for encoding the request with different content type. Supports
# `:json` by default and will set the appropriate request headers. The
# headers will be merged into the Rack env hash.
#
#
# This method is rarely used directly. Use RequestHelpers#get,
# RequestHelpers#post, or other standard HTTP methods in integration tests.
# `#process` is only required when using a request method that doesn't have a
# method defined in the integration tests.
#
# This method returns the response status, after performing the request.
# Furthermore, if this method was called from an ActionDispatch::IntegrationTest
# object, then that object's `@response` instance variable will point to a
# Response object which one can use to inspect the details of the response.
#
# Example:
# process :get, '/author', params: { since: 201501011400 }
def process(method, path, params: nil, headers: nil, env: nil, xhr: false, as: nil)
request_encoder = RequestEncoder.encoder(as)
headers ||= {}
if method == :get && as == :json && params
headers["X-Http-Method-Override"] = "GET"
method = :post
end
if path.include?("://")
path = build_expanded_path(path) do |location|
https! URI::HTTPS === location if location.scheme
if url_host = location.host
default = Rack::Request::DEFAULT_PORTS[location.scheme]
url_host += ":#{location.port}" if default != location.port
host! url_host
end
end
end
hostname, port = host.split(":")
request_env = {
:method => method,
:params => request_encoder.encode_params(params),
"SERVER_NAME" => hostname,
"SERVER_PORT" => port || (https? ? "443" : "80"),
"HTTPS" => https? ? "on" : "off",
"rack.url_scheme" => https? ? "https" : "http",
"REQUEST_URI" => path,
"HTTP_HOST" => host,
"REMOTE_ADDR" => remote_addr,
"HTTP_ACCEPT" => request_encoder.accept_header || accept
}
if request_encoder.content_type
request_env["CONTENT_TYPE"] = request_encoder.content_type
end
wrapped_headers = Http::Headers.from_hash({})
wrapped_headers.merge!(headers) if headers
if xhr
wrapped_headers["HTTP_X_REQUESTED_WITH"] = "XMLHttpRequest"
wrapped_headers["HTTP_ACCEPT"] ||= [Mime[:js], Mime[:html], Mime[:xml], "text/xml", "*/*"].join(", ")
end
# This modifies the passed request_env directly.
if wrapped_headers.present?
Http::Headers.from_hash(request_env).merge!(wrapped_headers)
end
if env.present?
Http::Headers.from_hash(request_env).merge!(env)
end
session = Rack::Test::Session.new(_mock_session)
# NOTE: rack-test v0.5 doesn't build a default uri correctly Make sure requested
# path is always a full URI.
uri = build_full_uri(path, request_env)
if method == :get && String === request_env[:params]
# rack-test will needlessly parse and rebuild a :params
# querystring, using Rack's query parser. At best that's a
# waste of time; at worst it can change the value.
uri << "?" << request_env.delete(:params)
end
session.request(uri, request_env)
@request_count += 1
@request = ActionDispatch::Request.new(session.last_request.env)
response = _mock_session.last_response
@response = ActionDispatch::TestResponse.from_response(response)
@response.request = @request
@html_document = nil
@url_options = nil
@controller = @request.controller_instance
response.status
end
# Set the host name to use in the next request.
#
# session.host! "www.example.com"
alias :host! :host=
private
def _mock_session
@_mock_session ||= Rack::MockSession.new(@app, host)
end
def build_full_uri(path, env)
"#{env['rack.url_scheme']}://#{env['SERVER_NAME']}:#{env['SERVER_PORT']}#{path}"
end
def build_expanded_path(path)
location = URI.parse(path)
yield location if block_given?
path = location.path
location.query ? "#{path}?#{location.query}" : path
end
end
module Runner
include ActionDispatch::Assertions
APP_SESSIONS = {}
attr_reader :app
attr_accessor :root_session # :nodoc:
def initialize(*args, &blk)
super(*args, &blk)
@integration_session = nil
end
def before_setup # :nodoc:
@app = nil
super
end
def integration_session
@integration_session ||= create_session(app)
end
# Reset the current session. This is useful for testing multiple sessions in a
# single test case.
def reset!
@integration_session = create_session(app)
end
def create_session(app)
klass = APP_SESSIONS[app] ||= Class.new(Integration::Session) {
# If the app is a Rails app, make url_helpers available on the session. This
# makes app.url_for and app.foo_path available in the console.
if app.respond_to?(:routes) && app.routes.is_a?(ActionDispatch::Routing::RouteSet)
include app.routes.url_helpers
include app.routes.mounted_helpers
end
}
klass.new(app)
end
def remove! # :nodoc:
@integration_session = nil
end
%w(get post patch put head delete cookies assigns follow_redirect!).each do |method|
# reset the html_document variable, except for cookies/assigns calls
unless method == "cookies" || method == "assigns"
reset_html_document = "@html_document = nil"
end
module_eval <<~RUBY, __FILE__, __LINE__ + 1
def #{method}(...)
#{reset_html_document}
result = integration_session.#{method}(...)
copy_session_variables!
result
end
RUBY
end
# Open a new session instance. If a block is given, the new session is yielded
# to the block before being returned.
#
# session = open_session do |sess|
# sess.extend(CustomAssertions)
# end
#
# By default, a single session is automatically created for you, but you can use
# this method to open multiple sessions that ought to be tested simultaneously.
def open_session
dup.tap do |session|
session.reset!
session.root_session = self.root_session || self
yield session if block_given?
end
end
def assertions # :nodoc:
root_session ? root_session.assertions : super
end
def assertions=(assertions) # :nodoc:
root_session ? root_session.assertions = assertions : super
end
# Copy the instance variables from the current session instance into the test
# instance.
def copy_session_variables! # :nodoc:
@controller = @integration_session.controller
@response = @integration_session.response
@request = @integration_session.request
end
def default_url_options
integration_session.default_url_options
end
def default_url_options=(options)
integration_session.default_url_options = options
end
private
def respond_to_missing?(method, _)
integration_session.respond_to?(method) || super
end
# Delegate unhandled messages to the current session instance.
def method_missing(method, ...)
if integration_session.respond_to?(method)
integration_session.public_send(method, ...).tap do
copy_session_variables!
end
else
super
end
end
end
end
# An integration test spans multiple controllers and actions, tying them all
# together to ensure they work together as expected. It tests more completely
# than either unit or functional tests do, exercising the entire stack, from the
# dispatcher to the database.
#
# At its simplest, you simply extend `IntegrationTest` and write your tests
# using the Integration::RequestHelpers#get and/or
# Integration::RequestHelpers#post methods:
#
# require "test_helper"
#
# class ExampleTest < ActionDispatch::IntegrationTest
# fixtures :people
#
# def test_login
# # get the login page
# get "/login"
# assert_equal 200, status
#
# # post the login and follow through to the home page
# post "/login", params: { username: people(:jamis).username,
# password: people(:jamis).password }
# follow_redirect!
# assert_equal 200, status
# assert_equal "/home", path
# end
# end
#
# However, you can also have multiple session instances open per test, and even
# extend those instances with assertions and methods to create a very powerful
# testing DSL that is specific for your application. You can even reference any
# named routes you happen to have defined.
#
# require "test_helper"
#
# class AdvancedTest < ActionDispatch::IntegrationTest
# fixtures :people, :rooms
#
# def test_login_and_speak
# jamis, david = login(:jamis), login(:david)
# room = rooms(:office)
#
# jamis.enter(room)
# jamis.speak(room, "anybody home?")
#
# david.enter(room)
# david.speak(room, "hello!")
# end
#
# private
#
# module CustomAssertions
# def enter(room)
# # reference a named route, for maximum internal consistency!
# get(room_url(id: room.id))
# assert(...)
# ...
# end
#
# def speak(room, message)
# post "/say/#{room.id}", xhr: true, params: { message: message }
# assert(...)
# ...
# end
# end
#
# def login(who)
# open_session do |sess|
# sess.extend(CustomAssertions)
# who = people(who)
# sess.post "/login", params: { username: who.username,
# password: who.password }
# assert(...)
# end
# end
# end
#
# Another longer example would be:
#
# A simple integration test that exercises multiple controllers:
#
# require "test_helper"
#
# class UserFlowsTest < ActionDispatch::IntegrationTest
# test "login and browse site" do
# # login via https
# https!
# get "/login"
# assert_response :success
#
# post "/login", params: { username: users(:david).username, password: users(:david).password }
# follow_redirect!
# assert_equal '/welcome', path
# assert_equal 'Welcome david!', flash[:notice]
#
# https!(false)
# get "/articles/all"
# assert_response :success
# assert_dom 'h1', 'Articles'
# end
# end
#
# As you can see the integration test involves multiple controllers and
# exercises the entire stack from database to dispatcher. In addition you can
# have multiple session instances open simultaneously in a test and extend those
# instances with assertion methods to create a very powerful testing DSL
# (domain-specific language) just for your application.
#
# Here's an example of multiple sessions and custom DSL in an integration test
#
# require "test_helper"
#
# class UserFlowsTest < ActionDispatch::IntegrationTest
# test "login and browse site" do
# # User david logs in
# david = login(:david)
# # User guest logs in
# guest = login(:guest)
#
# # Both are now available in different sessions
# assert_equal 'Welcome david!', david.flash[:notice]
# assert_equal 'Welcome guest!', guest.flash[:notice]
#
# # User david can browse site
# david.browses_site
# # User guest can browse site as well
# guest.browses_site
#
# # Continue with other assertions
# end
#
# private
#
# module CustomDsl
# def browses_site
# get "/products/all"
# assert_response :success
# assert_dom 'h1', 'Products'
# end
# end
#
# def login(user)
# open_session do |sess|
# sess.extend(CustomDsl)
# u = users(user)
# sess.https!
# sess.post "/login", params: { username: u.username, password: u.password }
# assert_equal '/welcome', sess.path
# sess.https!(false)
# end
# end
# end
#
# See the [request helpers documentation]
# (rdoc-ref:ActionDispatch::Integration::RequestHelpers) for help
# on how to use `get`, etc.
#
# ### Changing the request encoding
#
# You can also test your JSON API easily by setting what the request should be
# encoded as:
#
# require "test_helper"
#
# class ApiTest < ActionDispatch::IntegrationTest
# test "creates articles" do
# assert_difference -> { Article.count } do
# post articles_path, params: { article: { title: "Ahoy!" } }, as: :json
# end
#
# assert_response :success
# assert_equal({ id: Article.last.id, title: "Ahoy!" }, response.parsed_body)
# end
# end
#
# The `as` option passes an "application/json" Accept header (thereby setting
# the request format to JSON unless overridden), sets the content type to
# "application/json" and encodes the parameters as JSON.
#
# Calling TestResponse#parsed_body on the response parses the response body
# based on the last response MIME type.
#
# Out of the box, only `:json` is supported. But for any custom MIME types
# you've registered, you can add your own encoders with:
#
# ActionDispatch::IntegrationTest.register_encoder :wibble,
# param_encoder: -> params { params.to_wibble },
# response_parser: -> body { body }
#
# Where `param_encoder` defines how the params should be encoded and
# `response_parser` defines how the response body should be parsed through
# TestResponse#parsed_body.
#
# Consult the [Rails Testing Guide](https://guides.rubyonrails.org/testing.html)
# for more.
class IntegrationTest < ActiveSupport::TestCase
include TestProcess::FixtureFile
module UrlOptions
extend ActiveSupport::Concern
def url_options
integration_session.url_options
end
end
module Behavior
extend ActiveSupport::Concern
include Integration::Runner
include ActionController::TemplateAssertions
include TestHelpers::PageDumpHelper
included do
include ActionDispatch::Routing::UrlFor
include UrlOptions # don't let UrlFor override the url_options method
include ActionDispatch::Assertions::RoutingAssertions::WithIntegrationRouting
ActiveSupport.run_load_hooks(:action_dispatch_integration_test, self)
@@app = nil
end
module ClassMethods
def app
if defined?(@@app) && @@app
@@app
else
ActionDispatch.test_app
end
end
def app=(app)
@@app = app
end
def register_encoder(*args, **options)
RequestEncoder.register_encoder(*args, **options)
end
end
def app
super || self.class.app
end
def document_root_element
html_document.root
end
end
include Behavior
end
end