spassky 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+tmp
+*.swp
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2@spassky

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in akki.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    spassky (0.1.0)
+      json
+      rainbow
+      rest-client
+      sinatra
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.4.3)
+      bcat (>= 0.6.1)
+      childprocess (>= 0.1.9)
+      cucumber (>= 0.10.7)
+      rdiscount (>= 1.6.8)
+      rspec (>= 2.6.0)
+    bcat (0.6.1)
+      rack (~> 1.0)
+    builder (3.0.0)
+    capybara (1.0.0)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 0.2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.1.9)
+      ffi (~> 1.0.6)
+    cucumber (1.0.0)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.4.1)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.5)
+    diff-lcs (1.1.2)
+    ffi (1.0.9)
+    gherkin (2.4.5)
+      json (>= 1.4.6)
+    json (1.5.3)
+    json_pure (1.5.3)
+    mime-types (1.16)
+    nokogiri (1.5.0)
+    rack (1.3.1)
+    rack-test (0.6.0)
+      rack (>= 1.0)
+    rainbow (1.1.1)
+    rake (0.9.2)
+    rdiscount (1.6.8)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.2.2)
+      childprocess (>= 0.1.9)
+      ffi (>= 1.0.7)
+      json_pure
+      rubyzip
+    sinatra (1.2.6)
+      rack (~> 1.1)
+      tilt (< 2.0, >= 1.2.2)
+    term-ansicolor (1.0.5)
+    tilt (1.3.2)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  capybara
+  cucumber
+  rake
+  rspec
+  spassky!

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2011 British Broadcasting Corporation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,47 @@
+# Spassky #
+A distributed web testing tool. We use it at the BBC for testing our web apps on a wide range of mobile devices.
+
+# Installation #
+
+```
+gem install spassky
+```
+
+# Usage #
+
+Start the server:
+
+```
+spassky-server
+```
+
+Run a test:
+
+```
+spassky http://localhost:9191 html_test.html
+```
+
+Run a test with colour:
+
+```
+spassky http://localhost:9191 html_test.html --colour
+```
+
+Run a directory that contains a test (the first .html file will be used as the test)
+
+```
+spassky http://localhost:9191 test_directory
+```
+
+## Why? ##
+We need to run automated tests on a wide range of web-enabled devices with very mixed capabilities. Some of them have JavaScript, but in many cases it's not standard and buggy. That means web testing tools targeted at desktop browsers don't tend to work very well, if at all. Spassky uses legacy techniques and as little client-side JavaScript as possible to ensure we can run tests on as many devices as possible.
+
+## How it works ##
+Physical devices act as test agents, connected permanently to a central server using meta refresh tags. Using a command-line utility, developers execute tests against those browsers by posting to the central server. The tests themselves are plain HTML pages, that are expected to call an assert URL (e.g. by embedding an image) within a time frame. That means even devices without any JavaScript can run automated tests of some kind.
+
+## Some features that would be nice to have ##
+- Conveniently run QUnit / Jasmine / other tests
+- Aliases for user agents
+- Run tests on a subset of agents
+- List disconnected devices
+- Assertions on network activity (e.g. for caching tests)

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :default do
+	sh "rspec spec --color"
+end

data/bin/spassky

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'spassky'
+require 'spassky/client/cli'
+
+Spassky::Client::Cli.run(ARGV)

data/bin/spassky-server

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'spassky'
+require 'spassky/server/app'
+
+Spassky::Server::App.set :port, 9191
+Spassky::Server::App.run!

data/config.ru

@@ -0,0 +1,6 @@
+$:.unshift(File.join(File.dirname(__FILE__), "lib"))
+
+require 'spassky'
+require 'spassky/server'
+
+run Spassky::Server::App.new()

data/features/connection.feature

@@ -0,0 +1,9 @@
+Feature: Connection
+  In order to run tests with minimal effort
+  As a web developer
+  I want to connect devices to a constantly running service
+  
+  Scenario: Connect a device
+    Given a connected mobile device "ipad"
+    Then it should wait for a test to run
+    And the word "Idle" should appear on the device

data/features/device_timeout.feature

@@ -0,0 +1,31 @@
+Feature: Device Timeout
+  In order for a clean test run
+  As a Developer-in-Test
+  I want to ignore devices that haven't connected recently
+  
+  Background: One passing test
+    Given a file named "timed-out.html" with:
+      """
+        <html>
+          <head>
+          </head>
+          <body>
+          <h1>My first passing test!</h1>
+          <script type="text/javascript">
+          assert(true, 'this test should pass');
+          </script>
+          </body>
+        </html>
+      """
+      
+  Scenario: One device times out
+    Given a connected mobile device "ipad"
+    When the device disconnects
+    And I run "spassky <host> timed-out.html" with the server host
+    Then the output should contain:
+      """
+      TIMED OUT timed-out.html on ipad
+      """
+    And the exit status should be 2
+    
+    

data/features/run_html_tests.feature

@@ -0,0 +1,65 @@
+Feature: Run HTML Tests
+
+  In order to inform design decisions
+  As a web developer
+  I want to test HTML code on different web browsers
+
+  Background: Two tests, one passes, one fails
+    Given a file named "passing.html" with:
+      """
+        <html>
+          <head>
+          </head>
+          <body>
+          <h1>A PASSING test!</h1>
+          <script type="text/javascript">
+          assert(true, 'this test should pass');
+          </script>
+          </body>
+        </html>
+      """
+    And a file named "failing.html" with:
+      """
+        <html>
+          <head>
+          </head>
+          <body>
+          <h1>A FAILING test!</h1>
+          <script type="text/javascript">
+          assert(false, 'this test should fail');
+          </script>
+          </body>
+        </html>
+      """
+
+  Scenario: One passing test on one device
+    Given a connected mobile device "blackberry"
+    When I run "spassky <host> passing.html" with the server host
+    Then the output should contain:
+      """
+      PASS passing.html on blackberry
+      """
+    And the exit status should be 0
+
+  Scenario: One passing test on two devices
+    Given a connected mobile device "blackberry"
+    And a connected mobile device "iphone"
+    When I run "spassky <host> passing.html" with the server host
+    Then the output should contain:
+      """
+      PASS passing.html on blackberry
+      """
+    Then the output should contain:
+      """
+      PASS passing.html on iphone
+      """
+    Then the exit status should be 0
+
+  Scenario: Failing test
+    Given a connected mobile device "blackberry"
+    When I run "spassky <host> failing.html" with the server host
+    Then the output should contain:
+      """
+      FAIL failing.html on blackberry
+      """
+    And the exit status should be 1

data/features/run_qunit_tests.feature

@@ -0,0 +1,45 @@
+Feature: Run QUnit Tests
+
+  In order to inform design decisions
+  As a QUnit user
+  I want to test JavaScript code on different web browsers
+
+  Background: Two tests, one passes, one fails
+    Given a file named "qunit_suite/qunit_test/passing.js" with:
+      """
+      QUnit.done = function(failed, passed, total, runtime){
+      assert(true, "pass");
+
+        if (failed.length() > 0) {
+          assert(false, "qunit failed");
+        } else {
+          assert(true, "qunit passed");
+        }
+      };
+
+      test("should pass", function() {
+        ok(true, "it passed!");
+      });
+      """
+    And a file named "qunit_suite/qunit_test/qunit.js" with QUnit.js in it
+    And a file named "qunit_suite/qunit_test/suite.html" with:
+      """
+      <html>
+        <head>
+        </head>
+        <body>
+        <h1>A QUnit Suite</h1>
+        <script type="text/javascript" src="qunit.js"></script>
+        <script type="text/javascript" src="passing.js"></script>
+        </body>
+      </html>
+      """
+
+  Scenario: One passing suite on one device
+    Given a connected mobile device "blackberry"
+    When I run "spassky <host> qunit_suite/qunit_test" with the server host
+    Then the output should contain:
+      """
+      PASS qunit_test on blackberry
+      """
+    And the exit status should be 0

data/features/server.feature

@@ -0,0 +1,11 @@
+Feature: Server
+  In order to spawn a spassky server
+  As a developer
+  I want to be able to type 'spassky-server' to launch a server
+
+  Scenario: Launch Server
+    Given I run spassky-server and then exit it
+    Then I should see the output:
+    """
+    Sinatra/1.2.6 has taken the stage on 9191
+    """

data/features/step_definitions/steps.rb

@@ -0,0 +1,66 @@
+require 'uri'
+
+Given /^a connected mobile device "([^"]*)"$/ do |user_agent|
+  register_driver_with_user_agent user_agent
+  using_session(user_agent) do
+    visit '/device/connect'
+    @uri = URI.parse(current_url)
+  end
+  @last_user_agent = user_agent
+end
+
+Given /^a file named "([^"]*)" with ([^\s]*) in it$/ do |file_name, fixture_name|
+  fixture_path = File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "fixtures", fixture_name))
+  fixture_content = File.read(fixture_path)
+  write_file(file_name, fixture_content)
+end
+
+When /^I run "([^"]*)" with the server host$/ do |command_line|
+  run_simple(unescape(command_line.gsub('<host>', "http://#{@uri.host}:#{@uri.port}")), false)
+end
+
+Then /^it should wait for a test to run$/ do
+  using_session(@last_user_agent) do
+    urls = [page.current_url]
+    sleep 2
+    urls << page.current_url
+    sleep 2
+    urls << page.current_url
+    urls.uniq.size.should eq(3), "expected 3 different urls, got:\n" + urls.join("\n")
+  end
+end
+
+Then /^the word "Idle" should appear on the device$/ do
+  using_session(@last_user_agent) do
+    page.html.should include("Idle")
+  end
+end
+
+When /^the device disconnects$/ do
+  using_session(@last_user_agent) do
+    visit "/device/disconnect"
+  end
+end
+
+Given /^I run spassky\-server and then exit it$/ do
+  @output = Tempfile.new("output")
+  process = ChildProcess.build('./bin/spassky-server')
+  process.io.stdout = @output
+  process.start
+  sleep 1
+  process.stop
+end
+
+Then /^I should see the output:$/ do |string|
+  text = ""
+  sleep_count = 0
+  while text == ""
+    @output.rewind
+    text = @output.read
+    break if sleep_count = 10
+    sleep 0.5
+    sleep_count += 1
+  end
+
+  text.should include string
+end

data/features/support/env.rb

@@ -0,0 +1,31 @@
+require 'capybara'
+require 'capybara/dsl'
+require 'capybara/cucumber'
+
+require 'aruba/cucumber'
+
+$:.unshift(File.join(File.dirname(__FILE__), '../../lib'))
+require 'spassky'
+require 'spassky/server'
+
+World(Capybara::DSL)
+
+Capybara.app = Spassky::Server::App
+
+Before do
+  Capybara.default_driver = :selenium
+  @aruba_timeout_seconds = 8
+  visit "/devices/clear"
+end
+
+def register_driver_with_user_agent user_agent
+  Capybara.register_driver user_agent.to_sym do |app|
+    require 'selenium/webdriver'
+    profile = Selenium::WebDriver::Firefox::Profile.new
+    profile['general.useragent.override'] = user_agent
+    Capybara::Selenium::Driver.new(app, :profile => profile)
+  end
+  Capybara.current_driver = user_agent.to_sym
+end
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"