Class Capybara::Session
In: lib/capybara/session.rb
Parent: Object

The Session class represents a single user‘s interaction with the system. The Session can use any of the underlying drivers. A session can be initialized manually like this:

    session = Capybara::Session.new(:culerity, MyRackApp)

The application given as the second argument is optional. When running Capybara against an external page, you might want to leave it out:

    session = Capybara::Session.new(:culerity)
    session.visit('http://www.google.com')

Session provides a number of methods for controlling the navigation of the page, such as visit, +current_path, and so on. It also delegate a number of methods to a Capybara::Document, representing the current HTML document. This allows interaction:

    session.fill_in('q', :with => 'Capybara')
    session.click_button('Search')
    session.should have_content('Capybara')

When using capybara/dsl, the Session is initialized automatically for you.

Methods

Constants

NODE_METHODS = [ :all, :first, :attach_file, :text, :check, :choose, :click_link_or_button, :click_button, :click_link, :field_labeled, :fill_in, :find, :find_button, :find_by_id, :find_field, :find_link, :has_content?, :has_css?, :has_no_content?, :has_no_css?, :has_no_xpath?, :has_xpath?, :select, :uncheck, :has_link?, :has_no_link?, :has_button?, :has_no_button?, :has_field?, :has_no_field?, :has_checked_field?, :has_unchecked_field?, :has_no_table?, :has_table?, :unselect, :has_select?, :has_no_select?, :has_selector?, :has_no_selector?, :click_on, :has_no_checked_field?, :has_no_unchecked_field?
SESSION_METHODS = [ :body, :html, :current_url, :current_host, :evaluate_script, :source, :visit, :wait_until, :within, :within_fieldset, :within_table, :within_frame, :within_window, :current_path, :save_page, :save_and_open_page, :reset_session!
DSL_METHODS = NODE_METHODS + SESSION_METHODS

Attributes

app  [R] 
mode  [R] 

Public Class methods

Public Instance methods

@return [String] A snapshot of the HTML of the current document, as it looks right now (potentially modified by JavaScript).

cleanup!()

Alias for reset!

@return [String] Host of the current page

@return [String] Path of the current page, without any domain information

@return [String] Fully qualified URL of the current page

Evaluate the given JavaScript and return the result. Be careful when using this with scripts that return complex objects, such as jQuery statements. execute_script might be a better alternative.

@param [String] script A string of JavaScript to evaluate @return [Object] The result of the evaluated JavaScript (may be driver specific)

Execute the given script, not returning a result. This is useful for scripts that return complex objects, such as jQuery statements. execute_script should always be used over evaluate_script whenever possible.

@param [String] script A string of JavaScript to execute

html()

Alias for body

Reset the session, removing all cookies.

reset_session!()

Alias for reset!

Returns a hash of response headers. Not supported by all drivers (e.g. Selenium)

@return [Hash{String => String}] A hash of response headers.

Save a snapshot of the page and open it in a browser for inspection

@return [String] HTML source of the document, before being modified by JavaScript.

Returns the current HTTP status code as an Integer. Not supported by all drivers (e.g. Selenium)

@return [Integer] Current HTTP status code

Navigate to the given URL. The URL can either be a relative URL or an absolute URL The behaviour of either depends on the driver.

    session.visit('/foo')
    session.visit('http://google.com')

For drivers which can run against an external application, such as culerity and selenium giving an absolute URL will navigate to that page. This allows testing applications running on remote servers. For these drivers, setting Capybara.app_host will make the remote server the default. For example:

    Capybara.app_host = 'http://google.com'
    session.visit('/') # visits the google homepage

@param [String] url The URL to navigate to

Retry executing the block until a truthy result is returned or the timeout time is exceeded

@param [Integer] timeout The amount of seconds to retry executing the given block

Execute the given block for a particular scope on the page. Within will find the first element matching the given selector and execute the block scoped to that element:

    within(:xpath, '//div[@id="delivery-address"]') do
      fill_in('Street', :with => '12 Main Street')
    end

It is possible to omit the first parameter, in that case, the selector is assumed to be of the type set in Capybara.default_selector.

    within('div#delivery-address') do
      fill_in('Street', :with => '12 Main Street')
    end

@param (see Capybara::Node::Finders#all) @raise [Capybara::ElementNotFound] If the scope can‘t be found before time expires

Execute the given block within the a specific fieldset given the id or legend of that fieldset.

@param [String] locator Id or legend of the fieldset

Execute the given block within the given iframe given the id of that iframe. Only works on some drivers (e.g. Selenium)

@param [String] locator Id of the frame

Execute the given block within the a specific table given the id or caption of that table.

@param [String] locator Id or caption of the table

Execute the given block within the given window. Only works on some drivers (e.g. Selenium)

@param [String] locator of the window

[Validate]