Module: Kookaburra::TestHelpers

Extended by:
Forwardable
Defined in:
lib/kookaburra/test_helpers.rb

Overview

This module is intended to be mixed in to your testing context to provide convenient access to your Kookaburra objects. Examples for both RSpec and Cucumber are given below; mixing it in to other test setups should be pretty straight-forward.

Examples:

RSpec setup

# in 'spec/support/kookaburra_setup.rb'
require 'kookaburra/test_helpers'
require 'my_app/kookaburra/given_driver'
require 'my_app/kookaburra/ui_driver'

Kookaburra.configure do |c|
  c.given_driver_class = myapp::kookaburra::givendriver,
  c.ui_driver_class = myapp::kookaburra::uidriver,
  c.app_host = 'http://my_app.example.com:12345',
  c.browser = capybara,
  c.server_error_detection { |browser|
    browser.has_css?('h1', text: 'internal server error')
  }
end

RSpec.configure do |c|
  c.include(Kookaburra::TestHelpers, :type => :request)
end

# in 'spec/request/some_feature_spec.rb'
describe "Some Feature" do
  example "some test script" do
    given.a_widget(:foo)
    given.a_widget(:bar, :hidden => true)
    given.a_widget(:baz)

    ui.view_list_of_widgets

    ui.widget_list.widgets.should == k.get_data(:widgets).slice(:foo, :baz)

    ui.widget_list.hide_widget(:foo)

    ui.widget_list.widgets.should == k.get_data(:widgets).slice(:baz)
  end
end

Cucumber setup

# in 'features/support/kookaburra_setup.rb'
require 'kookaburra/test_helpers'
require 'my_app/kookaburra/given_driver'
require 'my_app/kookaburra/ui_driver'

Kookaburra.configure do |c|
  c.given_driver_class = myapp::kookaburra::givendriver,
  c.ui_driver_class = myapp::kookaburra::uidriver,
  c.app_host = 'http://my_app.example.com:12345',
  c.browser = capybara,
  c.server_error_detection { |browser|
    browser.has_css?('h1', text: 'internal server error')
  }
end

World(Kookaburra::TestHelpers)

# in 'features/step_definitions/some_steps.rb
Given /^there is a widget, "(\w+)"/ do |name|
  given.a_widget(name.to_sym)
end

Given /^there is a hidden widget, "(\w+)"/ do |name|
  given.a_widget(name.to_sym, :hidden => true)
end

When /^I view the widget list/ do
  ui.view_the_widget_list
end

Then /^I see the widget list contains the following widgets$/ do |widget_names|
  widgets = widget_names.hashes.map { |h| h['name'].to_sym }
  ui.widget_list.widgets.should == k.get_data(:widgets).slice(widgets)
end

Instance Method Summary collapse

Instance Method Details

#assert_mental_model_matches(collection_key, actual, message = nil) ⇒ Object

Custom assertion for Test::Unit-style tests (really, anything that uses #assert(predicate, message = nil))

See Also:



115
116
117
118
119
120
121
122
 
# File 'lib/kookaburra/test_helpers.rb', line 115

def assert_mental_model_matches(collection_key, actual, message = nil)
  matcher = match_mental_model_of(collection_key)
  result = matcher.matches?(actual)
  return if !!result  # don't even bother

  message ||= matcher.failure_message_for_should
  assert result, message
end

#given ⇒ Object

Delegates to #k



97
 
# File 'lib/kookaburra/test_helpers.rb', line 97

def_delegator :k, :given

#k ⇒ Kookaburra

The Kookaburra instance to be used by your tests. It gets configured using the options set in Kookaburra.configuration, and the result is memoized.

Returns:



91
92
93
 
# File 'lib/kookaburra/test_helpers.rb', line 91

def k
  @k ||= Kookaburra.new
end

#match_mental_model_of(collection_key) ⇒ Object

RSpec-style custom matcher that compares a given array with the current state of one named collection in the mental model

See Also:



107
108
109
 
# File 'lib/kookaburra/test_helpers.rb', line 107

def match_mental_model_of(collection_key)
  MentalModel::Matcher.new(k.send(:__mental_model__), collection_key)
end

#ui ⇒ Object

Delegates to #k



101
 
# File 'lib/kookaburra/test_helpers.rb', line 101

def_delegator :k, :ui