module Devise::TestHelpers

Devise::TestHelpers provides a facility to test controllers in isolation when using ActionController::TestCase allowing you to quickly #sign_in or #sign_out a user. Do not use Devise::TestHelpers in integration tests.

Notice you should not test Warden specific behavior (like Warden callbacks) using Devise::TestHelpers since it is a stub of the actual behavior. Such callbacks should be tested in your integration suite instead.

Public Class Methods

included(base) click to toggle source
# File lib/devise/test_helpers.rb, line 10
def self.included(base)
  base.class_eval do
    setup :setup_controller_for_warden, :warden if respond_to?(:setup)
  end
end

Public Instance Methods

process(*) click to toggle source

Override process to consider warden.

# File lib/devise/test_helpers.rb, line 17
def process(*)
  result = nil
  _catch_warden { result = super }
  result
end
sign_in(resource_or_scope, resource=nil) click to toggle source

#sign_in a given resource by storing its keys in the session. This method bypass any warden authentication callback.

Examples:

sign_in :user, @user   # sign_in(scope, resource)
sign_in @user          # sign_in(resource)
# File lib/devise/test_helpers.rb, line 46
def sign_in(resource_or_scope, resource=nil)
  scope    ||= Devise::Mapping.find_scope!(resource_or_scope)
  resource ||= resource_or_scope
  warden.session_serializer.store(resource, scope)
end
sign_out(resource_or_scope) click to toggle source

Sign out a given resource or scope by calling logout on Warden. This method bypass any warden logout callback.

Examples:

sign_out :user     # sign_out(scope)
sign_out @user     # sign_out(resource)
# File lib/devise/test_helpers.rb, line 60
def sign_out(resource_or_scope)
  scope = Devise::Mapping.find_scope!(resource_or_scope)
  @controller.instance_variable_set(:"@current_#{scope}", nil)
  user = warden.instance_variable_get(:@users).delete(scope)
  warden.session_serializer.delete(scope, user)
end

Protected Instance Methods

_catch_warden(&block) click to toggle source
# File lib/devise/test_helpers.rb, line 69
def _catch_warden(&block)
  result = catch(:warden, &block)

  if result.is_a?(Hash) && !warden.custom_failure? && !@controller.send(:performed?)
    result[:action] ||= :unauthenticated

    env = @controller.request.env
    env["PATH_INFO"] = "/#{result[:action]}"
    env["warden.options"] = result
    Warden::Manager._run_callbacks(:before_failure, env, result)

    status, headers, body = Devise.warden_config[:failure_app].call(env).to_a
    @controller.send :render, :status => status, :text => body,
      :content_type => headers["Content-Type"], :location => headers["Location"]

    nil
  else
    result
  end
end