qunit-selenium 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b1d4eb78a62b37be9338bc89b3864b2e89c2e92
+  data.tar.gz: 2d776ef850825d5cda0727bd3bf14c2b8fca705e
+SHA512:
+  metadata.gz: ef6e0f1984d9edc4c9323f6497f9405886c9cf3dc5b9ce36d79015906f2a3ed609849052c4f9096d13f99e1361254308562ed41d0cc2d784263fc32b1e9211da
+  data.tar.gz: 11f8951b8ae4d05c2142b9c332d9803a95c6725f7acc02c6d67c7e7ee43017a670a1e35587f99492e2a354bc1ae0e8ea5a860dff99a18bc89f36ddb7e32e1276

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+.rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    qunit-selenium (0.0.2)
+      selenium-webdriver
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    childprocess (0.5.3)
+      ffi (~> 1.0, >= 1.0.11)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    multi_json (1.10.1)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+    rubyzip (1.1.6)
+    selenium-webdriver (2.42.0)
+      childprocess (>= 0.5.0)
+      multi_json (~> 1.0)
+      rubyzip (~> 1.0)
+      websocket (~> 1.0.4)
+    thor (0.19.1)
+    websocket (1.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  qunit-selenium!
+  rake
+  rspec (~> 3.0)

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Silvio Montanari
+
+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/README.md

@@ -0,0 +1,56 @@
+qunit-selenium
+==============
+
+Ruby QUnit test runner for Selenium WebDriver
+
+## Install
+
+In your Gemfile:
+
+```ruby
+gem 'qunit-selenium'
+```
+
+Or in your ruby gems:
+
+    $ gem install qunit-selenium
+
+## Pre-requisites
+This gem is a wrapper around the [selenium-webdriver](http://rubygems.org/gems/selenium-webdriver) gem with the additional logic to parse the QUnit test results page and report the success/failure of your QUnit tests.
+Please refer to the selenium documentation for detail instructions and drivers/browsers support.
+
+*_By default qunit-selenium will use the Selenium *FirefoxDriver* instantiated with a new Firefox profile._*
+
+If you wish to use a different driver, or to customise your driver behaviour you can still use qunit-selenium through its API (see below.)
+
+## Usage
+
+### Command line
+
+    $ qunit-selenium [--timeout=seconds] [--screenshot=FILE] URL
+
+This command will open the QUnit test page at the given url and wait for the  tests to complete before collecting and displaying the test run results. If the tests do not complete within the given timeout (by default it's 10 seconds) Selenium will raise an error and the command will fail.
+
+More in general, if any error is raised by Selenium which would cause a premature end of the test run, the program will generate a screenshot of the error page (file `qunit-selenium-error.png`).
+
+Example:
+
+    $ qunit-selenium --timeout 20 --screenshot mytests.png http://myserver/tests
+
+### Ruby API
+
+```ruby
+require 'qunit/selenium/test_runner'
+
+driver = ::Selenium::WebDriver.for :firefox
+url = 'http://test.server.com:8080'
+
+result = QUnit::Selenium::TestRunner.new(driver).open(url, timeout: 30)
+
+puts "Total tests: #{result.tests[:total]}"
+puts "Passed:      #{result.tests[:passed]}"
+puts "Failed:      #{result.tests[:failed]}"
+
+driver.quit
+```
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+Rake::Task[:build].prerequisites << Rake::Task[:spec]

data/bin/qunit-selenium

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'qunit/selenium/cli'
+
+QUnit::Selenium::Cli.start(ARGV)

data/lib/qunit/selenium/cli.rb

@@ -0,0 +1,48 @@
+require 'thor'
+require 'selenium-webdriver'
+require_relative 'test_runner'
+
+module QUnit
+  module Selenium
+    class Cli < Thor
+      desc "open URL", %{Run qunit tests at the specified URL}
+      option :timeout, type: :numeric, default: 10, desc: "Timeout in seconds to wait for the tests to complete (default is 10)"
+      option :screenshot, banner: 'FILE', default: nil, desc: "Save a screenshot of the page to the specified FILE after the tests complete"
+
+      def open(url)
+        profile = ::Selenium::WebDriver::Firefox::Profile.new
+        driver = ::Selenium::WebDriver.for :firefox, profile: profile
+
+        begin
+          test_result = TestRunner.new(driver).open(url, timeout: options[:timeout])
+          driver.save_screenshot options[:screenshot] if options[:screenshot]
+
+          print_report(test_result)
+
+          error = test_result.assertions[:failed] > 0
+        rescue => e
+          puts "Error: #{e}"
+          driver.save_screenshot('qunit-selenium-error.png')
+          error = true
+        ensure
+          driver.quit
+        end
+        exit(1) if error
+      end
+
+      default_task :open
+
+      private
+
+      def print_report(result)
+        puts "Total tests: #{result.tests[:total]}"
+        puts "Passed:      #{result.tests[:passed]}"
+        puts "Failed:      #{result.tests[:failed]}"
+        puts "Total assertions: #{result.assertions[:total]}"
+        puts "Passed:           #{result.assertions[:passed]}"
+        puts "Failed:           #{result.assertions[:failed]}"
+        puts "Tests duration:   #{result.duration} seconds"
+      end
+    end
+  end
+end

data/lib/qunit/selenium/test_run.rb

@@ -0,0 +1,47 @@
+module QUnit
+  module Selenium
+    class TestRun
+      TestResult = Struct.new(:tests, :assertions, :duration)
+      ID_TESTRESULT = 'qunit-testresult'
+      ID_TESTS = 'qunit-tests'
+
+      def initialize(driver)
+        @qunit_testresult = driver[ID_TESTRESULT]
+        @qunit_tests = driver[ID_TESTS]
+      end
+
+      def completed?
+        @qunit_testresult.text =~ /Tests completed/
+      end
+
+      def result
+        assertions = {total: total_assertions, passed: passed_assertions, failed: failed_assertions}
+        tests = {total: total_tests, passed: pass_tests, failed: fail_tests}
+        TestResult.new(tests, assertions, duration)
+      end
+
+      private
+
+      def duration
+        match = /Tests completed in (?<milliseconds>\d+) milliseconds/.match @qunit_testresult.text
+        match[:milliseconds].to_i / 1000
+      end
+
+      %w(total passed failed).each do |result|
+        define_method("#{result}_assertions".to_sym) do
+          @qunit_testresult.find_elements(:class, result).first.text.to_i
+        end
+      end
+
+      def total_tests
+        @qunit_tests.find_elements(:css, "##{ID_TESTS} > *").count
+      end
+
+      %w(pass fail).each do |result|
+        define_method("#{result}_tests".to_sym) do
+          @qunit_tests.find_elements(:css, "##{ID_TESTS} > .#{result}").count
+        end
+      end
+    end
+  end
+end

data/lib/qunit/selenium/test_runner.rb

@@ -0,0 +1,26 @@
+require 'selenium-webdriver'
+require_relative 'test_run'
+
+module QUnit
+  module Selenium
+    class TestRunner
+      def initialize(driver = nil)
+        @driver = driver || ::Selenium::WebDriver.for(:firefox)
+      end
+
+      def open(url, options = {})
+        timeout = options[:timeout] || 10
+        force_refresh = options[:force_refresh] || false
+        
+        @driver.get url
+        @driver.navigate.refresh if force_refresh
+
+        TestRun.new(@driver).tap do |run|
+          ::Selenium::WebDriver::Wait.new(timeout: timeout).until do
+            run.completed?
+          end
+        end.result
+      end
+    end
+  end
+end

data/lib/qunit/selenium/version.rb

@@ -0,0 +1,5 @@
+module QUnit
+  module Selenium
+    VERSION = '0.0.4'
+  end
+end

data/qunit-selenium.gemspec

@@ -0,0 +1,27 @@
+libdir = File.join(File.dirname(__FILE__), 'lib')
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'qunit/selenium/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'qunit-selenium'
+  gem.version       = QUnit::Selenium::VERSION
+  gem.summary       = 'Run QUnit tests through Selenium WebDriver'
+  gem.description   = 'Run QUnit tests through Selenium WebDriver'
+  
+  gem.authors       = ['Silvio Montanari']
+  gem.homepage      = 'https://github.com/smontanari/qunit-selenium'
+  gem.license       = 'MIT'
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.add_runtime_dependency 'selenium-webdriver'
+  gem.add_runtime_dependency "thor"
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rake'
+end

data/spec/qunit/selenium/test_run_spec.rb

@@ -0,0 +1,53 @@
+require 'qunit/selenium/test_run'
+
+module QUnit
+  module Selenium
+    describe TestRun do
+      let(:driver) {double('driver')}
+      let(:result_element) {double('result_element')}
+      let(:tests_element) {double('tests_element')}
+
+      before do
+        allow(driver).to receive(:[]).with('qunit-testresult').and_return(result_element)
+        allow(driver).to receive(:[]).with('qunit-tests').and_return(tests_element)
+      end
+
+      context 'tests completed' do
+        before do
+          allow(result_element).to receive(:text).and_return('Tests completed in 3000 milliseconds')
+          allow(result_element).to receive(:find_elements).with(:class, 'total').and_return([Struct.new(:text).new('123')])
+          allow(result_element).to receive(:find_elements).with(:class, 'passed').and_return([Struct.new(:text).new('456')])
+          allow(result_element).to receive(:find_elements).with(:class, 'failed').and_return([Struct.new(:text).new('789')])
+          allow(tests_element).to receive(:find_elements).with(:css, '#qunit-tests > *').and_return([1, 2, 3])
+          allow(tests_element).to receive(:find_elements).with(:css, '#qunit-tests > .pass').and_return([1, 2])
+          allow(tests_element).to receive(:find_elements).with(:css, '#qunit-tests > .fail').and_return([1])
+        end
+
+        it 'is completed' do
+          expect(TestRun.new(driver).completed?).to be_truthy
+        end
+
+        it 'returns the tests result data' do
+          result = TestRun.new(driver).result
+
+          expect(result.tests[:total]).to eq(3)
+          expect(result.tests[:passed]).to eq(2)
+          expect(result.tests[:failed]).to eq(1)
+          expect(result.assertions[:total]).to eq(123)
+          expect(result.assertions[:passed]).to eq(456)
+          expect(result.assertions[:failed]).to eq(789)
+        end
+      end
+
+      context 'tests running' do
+        before do
+          allow(result_element).to receive(:text).and_return('Running...')
+        end
+
+        it 'is not completed' do
+          expect(TestRun.new(driver).completed?).to be_falsy
+        end
+      end
+    end
+  end
+end

data/spec/qunit/selenium/test_runner_spec.rb

@@ -0,0 +1,44 @@
+require 'qunit/selenium/test_runner'
+
+module QUnit
+  module Selenium
+    describe TestRunner do
+      shared_examples 'open test page' do |timeout|
+        let(:test_run) {double('test_run')}
+        let(:wait) {double('wait')}
+
+        before do
+          allow(TestRun).to receive(:new).with(driver).and_return(test_run)
+          allow(::Selenium::WebDriver::Wait).to receive(:new).with(timeout: timeout).and_return(wait)
+          allow(wait).to receive(:until).and_yield
+          expect(test_run).to receive(:completed?).ordered
+          allow(test_run).to receive(:result).ordered.and_return('result')
+        end
+
+        it 'returns the completed test run' do
+          expect(subject).to eq('result')
+        end
+      end
+      
+      let(:driver) {double('driver')}
+
+      before do
+        expect(driver).to receive(:get).with('test_url').ordered
+      end
+
+      describe ' #open' do
+        context 'default options' do
+          let(:subject) {TestRunner.new(driver).open('test_url')}
+
+          include_examples 'open test page', 10
+        end
+
+        context 'custom options' do
+          let(:subject) {TestRunner.new(driver).open('test_url', timeout: 30)}
+
+          include_examples 'open test page', 30
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: qunit-selenium
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Silvio Montanari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Run QUnit tests through Selenium WebDriver
+email: 
+executables:
+- qunit-selenium
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/qunit-selenium
+- lib/qunit/selenium/cli.rb
+- lib/qunit/selenium/test_run.rb
+- lib/qunit/selenium/test_runner.rb
+- lib/qunit/selenium/version.rb
+- qunit-selenium.gemspec
+- spec/qunit/selenium/cli_spec.rb
+- spec/qunit/selenium/test_run_spec.rb
+- spec/qunit/selenium/test_runner_spec.rb
+homepage: https://github.com/smontanari/qunit-selenium
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Run QUnit tests through Selenium WebDriver
+test_files:
+- spec/qunit/selenium/cli_spec.rb
+- spec/qunit/selenium/test_run_spec.rb
+- spec/qunit/selenium/test_runner_spec.rb