pyrite 0.5.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dean Strelau, Mint Digital Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/pyrite.rb

@@ -0,0 +1,28 @@
+require 'selenium/client'
+
+require 'database_cleaner'
+DatabaseCleaner.strategy = :truncation
+
+require 'pyrite/pyrite_test'
+
+module Pyrite
+  # The port on which the test server will be booted
+  mattr_accessor :server_port
+  @@server_port = 2222
+
+  # The ip address the RC is running on
+  mattr_accessor :rc_host
+  @@rc_host = ENV['RC_HOST'] || '0.0.0.0'
+
+  # The url on which the test server will be booted
+  mattr_accessor :sever_url
+  @@sever_url = ENV['SERVER_URL'] || 'http://localhost'
+
+  # The browser that selenium will drive
+  mattr_accessor :browser
+  @@browser = ENV['BROWSER'] || '*chrome'
+
+  # The timeout for Selenium::Client
+  mattr_accessor :timeout
+  @@timeout = 60
+end

data/lib/pyrite/assertions.rb

@@ -0,0 +1,26 @@
+module Pyrite
+  module Assertions
+
+    # Assert some text appears somewhere on the page
+    def assert_text(text, msg=nil)
+      assert browser.text?(text), msg || "Text '#{text}' not found on page"
+    end
+
+    # Assert some text does not appear somewhere on the page
+    def assert_no_text(text, msg=nil)
+      assert !browser.text?(text), msg || "Text '#{text}' not found on page"
+    end
+
+    # Assert an element appears on the page via CSS selector
+    def assert_element(selector, msg=nil)
+      assert browser.element?("css=#{selector}"),
+        msg || "Element '#{selector}' not found on page"
+    end
+
+    # Assert an element does not appear on the page via CSS selector
+    def assert_no_element(selector, msg=nil)
+      assert !browser.element?("css=#{selector}"),
+        msg || "Element '#{selector}' was found on page but shouldn't be"
+    end
+  end
+end

data/lib/pyrite/dsl.rb

@@ -0,0 +1,116 @@
+module Pyrite
+  module Dsl
+
+    # Fill in a form field
+    def fill_in(element, value)
+      if element.match /date/ # Try to guess at date selects
+        select_date(element, value)
+      else
+        browser.type(element, value)
+      end
+    end
+
+    # Fill in a Rails-ish set of date_select fields
+    def select_date(element, value)
+      suffixes = {
+        :year   => '1i',
+        :month  => '2i',
+        :day    => '3i',
+        :hour   => '4i',
+        :minute => '5i'
+      }
+      date = value.respond_to?(:year) ? value : Date.parse(value)
+      browser.select "#{element}_#{suffixes[:year]}", date.year
+      browser.select "#{element}_#{suffixes[:month]}", date.strftime('%B')
+      browser.select "#{element}_#{suffixes[:day]}", date.day
+    end
+
+    # Open a URL
+    def visit(path)
+      browser.open(path)
+      wait_for :page_load
+    end
+
+    # Follow a link based on its text
+    def follow(text)
+      browser.click("link=#{text}")
+    end
+
+    # Press a button based on its text
+    def press(text)
+      browser.click("css=input[type=submit][value='#{text}']")      
+    end
+
+    # Check a chek box or toggle a radio button
+    def check(locator)
+      browser.check(locator)
+    end
+
+    # Click anything else
+    def click(locator)
+      browser.click(locator)
+    end
+    
+    def attach(field, file)
+      browser.attach(field, "http://test.rodreegez.com/#{file}")
+    end
+
+    # Pick an option from a select element
+    def select(element, option)
+      browser.select(element, option)
+    end
+
+    # Wait for a specific element or the page to load
+    def wait_for(element)
+      if element == :page_load
+        browser.wait_for_page_to_load
+      else
+        browser.wait_for_element(element)
+      end
+    end
+
+    # Wait for a frame with a give ID to finish loading
+    def wait_for_frame(frame) 
+      browser.wait_for_frame_to_load(frame, 5000)
+    end
+
+    # Excecute commands within an iframe, then switch back to the parent frame
+    # i.e.
+    # inside_frame(iframe) do
+    #   click "Submit"
+    # end
+    def inside_iframe(frame)
+      wait_for frame
+      browser.select_frame(frame)
+      wait_for_frame frame
+      yield
+      browser.select_frame("relative=parent")
+    end
+
+    # Use this to consume JS alerts
+    # i.e.
+    # follow 'delete'
+    # get_confirmation
+    # !assert_element "h2:contains('user1')"
+    def get_confirmation
+      browser.get_confirmation
+    end
+
+    # drag an css selector to the center pixel of another, e.g. 
+    # `drag_and_drop(:from => "li#element_#{my_oject.id}", :to => "div#trash")
+    # ProTip: if you have a list of elements you wish to re-order, drag the top element down.
+    def drag_and_drop(opts={})
+      browser.drag_and_drop_to_object("css=#{opts[:from]}", "css=#{opts[:to]}")
+    end
+
+    # Capture the page and try to open it
+    # (probably only works on os x)
+    def show_me
+      image = "#{Rails.root.join('tmp')}/pyrite-#{Time.now.to_i}.png"
+      browser.capture_entire_page_screenshot(image, '')
+      puts `open #{image}`
+    end
+
+  end
+
+end

data/lib/pyrite/helpers.rb

@@ -0,0 +1,10 @@
+module Pyrite
+  module Helpers
+
+    # Easily get the path to a fixture file
+    def fixture(filename)
+      File.join(Rails.root,'test','fixtures', filename)
+    end
+
+  end
+end

data/lib/pyrite/pyrite_test.rb

@@ -0,0 +1,34 @@
+require 'pyrite/dsl'
+require 'pyrite/assertions'
+require 'pyrite/helpers'
+
+module Pyrite
+  class PyriteTest < ActionController::IntegrationTest
+    include Dsl
+    include Assertions
+    include Helpers
+
+    self.use_transactional_fixtures = false
+
+    def browser
+      $browser ||= Selenium::Client::Driver.new(
+        :host => Pyrite.rc_host,
+        :port => 4444,
+        :browser => Pyrite.browser,
+        :url => "#{Pyrite.sever_url}:#{Pyrite.server_port}",
+        :timeout_in_second => Pyrite.timeout
+      )
+    end
+
+    def setup
+      DatabaseCleaner.clean
+      browser.start_new_browser_session
+      super
+    end
+
+    def teardown
+      super
+      browser.close_current_browser_session
+    end
+  end
+end

data/lib/pyrite/tasks.rb

@@ -0,0 +1,2 @@
+require 'pyrite/tasks/pyrite'
+require 'pyrite/tasks/selenium'

data/lib/pyrite/tasks/pyrite.rb

@@ -0,0 +1,36 @@
+namespace :pyrite do
+  Rake::TestTask.new(:run) do |t|
+    t.libs << "test"
+    t.pattern = 'test/pyrite/**/*_test.rb'
+    t.verbose = true
+  end
+  task :run # stub so that below will work
+  Rake::Task['pyrite:run'].comment = "Full-stack in-browser tests with pyrite"
+
+  desc "Startup Selenium RC and the server for browser testing"
+  task :start => 'selenium:start' do
+    puts `thin start -e pyrite -p 2222 -d`
+  end
+
+  desc "Shutdown Selenium RC and the server for browser testing"
+  task :stop do
+    begin
+      Rake::Task['selenium:stop'].invoke
+    rescue Errno::ECONNREFUSED => boom
+      puts "*** Could not connect to Selenium RC. Assuming it is not running."
+    end
+    if File.exist?(pidfile = Rails.root+'tmp/pids/server.pid')
+      puts "Stopping server process #{pid = File.read(pidfile)}"
+      Process.kill 'QUIT', Integer(pid)
+    else
+      puts "*** Could not read pid file for server. Assuming it is not running."
+    end
+  end
+
+    desc "Start, run then stop pyrite"
+    task :all do
+      Rake::Task['pyrite:start'].invoke
+      Rake::Task['pyrite:run'].invoke
+      Rake::Task['pyrite:stop'].invoke
+    end
+end

data/lib/pyrite/tasks/selenium.rb

@@ -0,0 +1,20 @@
+require 'selenium/rake/tasks'
+require 'selenium_remote_control'
+
+namespace :selenium do
+  Selenium::Rake::RemoteControlStartTask.new(:start) do |rc|
+    rc.port = 4444
+    rc.timeout_in_seconds = 3 * 60
+    rc.background = true
+    rc.wait_until_up_and_running = true
+    rc.log_to = 'log/selenium_rc.log'
+    rc.additional_args << "-singleWindow"
+    rc.jar_file = SeleniumRC.jar_file
+  end
+
+  Selenium::Rake::RemoteControlStopTask.new(:stop) do |rc|
+    rc.host = "localhost"
+    rc.port = 4444
+    rc.timeout_in_seconds = 3 * 60
+  end
+end

data/tasks/pyrite.rake

@@ -0,0 +1 @@
+require 'pyrite/tasks'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: pyrite
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Adam Rogers
+- Dean Strelau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-26 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: selenium-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 18
+        version: 1.2.18
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: selenium_remote_control
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :runtime
+  version_requirements: *id003
+description: A small, simple testing framework for use with selenium
+email: adam@mintdigital.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/pyrite/assertions.rb
+- lib/pyrite/dsl.rb
+- lib/pyrite/helpers.rb
+- lib/pyrite/pyrite_test.rb
+- lib/pyrite/tasks.rb
+- lib/pyrite/tasks/pyrite.rb
+- lib/pyrite/tasks/selenium.rb
+- lib/pyrite.rb
+- MIT-LICENSE
+- tasks/pyrite.rake
+has_rdoc: true
+homepage: http://github.com/mintdigital/pyrite
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Easy peasy browser testing
+test_files: []
+