jasmine-selenium-sauce 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jasmine-selenium-sauce.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Daren
+
+MIT License
+
+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,63 @@
+# Jasmine::Sauce::Ci
+
+Uses SauceLabs to connect to your server and run your Jasmine suites, producing an RSpec report
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jasmine-selenium-sauce'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jasmine-selenium-sauce
+
+## Usage
+
+    rake jasmine:sauce
+
+### Required Environment Variables
+
+Requires the following environment variables to be set:
+
+#### SAUCELABS_URL
+
+URL for Saucelabs with your credentials included:
+
+    SAUCELABS_URL=http://username:password@ondemand.saucelabs.com:80/wd/hub
+
+#### JASMINE_URL
+
+Where your Jasmine tests are hosted:
+
+    JASMINE_URL=http://my.server.com/jasmine
+
+#### SAUCE_BROWSER
+
+Which browser SauceLabs should use to run your tests:
+
+    SAUCE_BROWSER=chrome
+
+### Optional Configuration
+
+#### RSpec
+
+You can specify the format of the RSpec report with:
+
+    JASMINE_SPEC_FORMAT=documentation
+
+#### Sauce Labs Configuration
+
+See [sauce_config.rb](https://github.com/darend/jasmine-selenium-sauce/tree/master/lib/jasmine-selenium-sauce/sauce_config.rb)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/jasmine-selenium-sauce.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jasmine-selenium-sauce/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Daren"]
+  gem.email         = ["darend@gmail.com"]
+  gem.description   = %q{Runs Jasmine suites on any server through Saucelabs}
+  gem.summary       = %q{Uses SauceLabs to connect to your server and run your Jasmine suites, producing an RSpec report}
+  gem.homepage      = "https://github.com/darend/jasmine-selenium-sauce"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "jasmine-selenium-sauce"
+  gem.require_paths = ["lib"]
+  gem.version       = Jasmine::Sauce::Ci::VERSION
+
+  gem.add_development_dependency 'fakeweb'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'json_pure'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rb-fsevent'
+  gem.add_development_dependency 'vcr'
+
+  gem.add_dependency 'rspec', ">= 2.0"
+  gem.add_dependency 'selenium-webdriver'
+end

data/lib/jasmine-selenium-sauce.rb

@@ -0,0 +1,24 @@
+require 'jasmine-selenium-sauce/version'
+require 'jasmine-selenium-sauce/jasmine_results'
+require 'jasmine-selenium-sauce/rspec_reporter'
+require 'jasmine-selenium-sauce/sauce_config'
+require 'jasmine-selenium-sauce/selenium_runner'
+require 'jasmine-selenium-sauce/selenium_saucelabs_driver'
+
+module Jasmine
+  module Sauce
+    module CI
+
+      class Main
+        def self.run(config, reporter = RspecReporter.new)
+          driver = SeleniumSauceLabsDriver.new(config)
+          selenium_runner = SeleniumRunner.new(driver)
+          results = selenium_runner.run(config.jasmine_server_url)
+          reporter.report(results)
+        end
+      end
+    end
+  end
+end
+
+require 'jasmine-selenium-sauce/tasks/railtie' if defined?(Rails)

data/lib/jasmine-selenium-sauce/jasmine_results.rb

@@ -0,0 +1,19 @@
+module Jasmine
+  module Sauce
+    module CI
+
+      class JasmineResults
+        attr_reader :suites
+
+        def initialize(suites, suite_results)
+          @suites = suites
+          @suite_results = suite_results
+        end
+
+        def for_spec_id(id)
+          @suite_results[id]
+        end
+      end
+    end
+  end
+end

data/lib/jasmine-selenium-sauce/rspec_reporter.rb

@@ -0,0 +1,87 @@
+require 'enumerator'
+require 'rspec'
+
+#
+# Reused from https://github.com/pivotal/jasmine-gem
+#
+
+module Jasmine
+  module Sauce
+    module CI
+      class RspecReporter
+
+        def report(results)
+          @results = results
+          declare_suites(@results.suites)
+        end
+
+        def declare_suites(suites)
+          suites.each do |suite|
+            group = example_group(suite["name"]) {}
+            process_children(group, suite["children"])
+          end
+        end
+
+        def process_children(parent, children)
+          children.each do |suite_or_spec|
+            type = suite_or_spec["type"]
+            if type == "suite"
+              process_children(parent.describe(suite_or_spec["name"]), suite_or_spec["children"])
+            elsif type == "spec"
+              declare_spec(parent, suite_or_spec)
+            else
+              raise "unknown type #{type} for #{suite_or_spec.inspect}"
+            end
+          end
+        end
+
+        def declare_spec(parent, spec)
+          me = self
+          example_name = spec["name"]
+          parent.it example_name, {} do
+            me.report_spec(spec["id"])
+          end
+        end
+
+        def report_spec(spec_id)
+          spec_results = results_for(spec_id)
+          out = ""
+          messages = spec_results['messages'].each do |message|
+            case
+            when message["type"] == "log"
+              puts message["text"]
+              puts "\n"
+            else
+              unless message["message"] =~ /^Passed.$/
+                STDERR << message["message"]
+                STDERR << "\n"
+
+                out << message["message"]
+                out << "\n"
+              end
+
+              if !message["passed"] && message["trace"]["stack"]
+                stack_trace = message["trace"]["stack"].gsub(/<br \/>/, "\n").gsub(/<\/?b>/, " ")
+                STDERR << stack_trace.gsub(/\(.*\)@http:\/\/localhost:[0-9]+\/specs\//, "/spec/")
+                STDERR << "\n"
+              end
+            end
+
+          end
+          fail out unless spec_results['result'] == 'passed'
+          puts out unless out.empty?
+        end
+
+        private
+
+        def example_group(*args, &block)
+          RSpec::Core::ExampleGroup.describe(*args, &block).register
+        end
+
+        def results_for(spec_id)
+          @results.for_spec_id(spec_id.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/jasmine-selenium-sauce/sauce_config.rb

@@ -0,0 +1,56 @@
+module Jasmine
+  module Sauce
+    module CI
+
+      class SauceConfig
+
+        def validate
+          raise ArgumentError.new("SAUCELABS_URL was not set") unless saucelabs_server_url
+          raise ArgumentError.new("JASMINE_URL was not set") unless jasmine_server_url
+          raise ArgumentError.new("SAUCE_BROWSER was not set") unless browser
+        end
+
+        def saucelabs_server_url
+          ENV['SAUCELABS_URL']
+        end
+
+        def jasmine_server_url
+          ENV['JASMINE_URL']
+        end
+
+        def browser
+          ENV['SAUCE_BROWSER']
+        end
+
+        def platform
+           ENV['SAUCE_PLATFORM'] ? ENV['SAUCE_PLATFORM'].to_s.upcase.to_sym : :VISTA
+        end
+
+        def browser_version
+          ENV['SAUCE_BROWSER_VERSION']
+        end
+
+        def record_screenshots
+          ENV['SAUCE_SCREENSHOTS'] ? ENV['SAUCE_SCREENSHOTS'] : false
+        end
+
+        def record_video
+           ENV['SAUCE_VIDEO'] ? ENV['SAUCE_VIDEO'] : false
+        end
+
+        def idle_timeout
+           ENV['SAUCE_IDLE_TIMEOUT'] ? ENV['SAUCE_IDLE_TIMEOUT'] : 90
+        end
+
+        def max_duration
+           ENV['SAUCE_MAX_DURATION'] ? ENV['SAUCE_MAX_DURATION'] : 180
+        end
+
+        def selenium_client_timeout
+          ENV['SELENIUM_CLIENT_TIMEOUT'] ? ENV['SELENIUM_CLIENT_TIMEOUT'] : 120
+        end
+      end
+
+    end
+  end
+end

data/lib/jasmine-selenium-sauce/selenium_runner.rb

@@ -0,0 +1,91 @@
+require 'json'
+
+module Jasmine
+  module Sauce
+    module CI
+      class SeleniumRunner
+
+        def initialize(driver, result_batch_size = 500)
+          @driver = driver
+          @result_batch_size = result_batch_size
+        end
+
+        def run(jasmine_url)
+          @driver.connect jasmine_url
+          wait_for_jasmine_to_load(load_jasmine_timeout)
+          suites = fetch_suites
+          wait_for_jasmine_to_finish(jasmine_execution_timeout)
+          suite_results = fetch_suite_results(suites)
+          @driver.disconnect
+          Jasmine::Sauce::CI::JasmineResults.new(suites, suite_results)
+        end
+
+        private
+
+        def load_jasmine_timeout
+          60
+        end
+
+        def wait_for_jasmine_to_load(timeout)
+          started = Time.now
+          while !evaluate_js('return jsApiReporter && jsApiReporter.started') do
+            raise "Timed out after #{timeout}s waiting for Jasmine to load" if (started + timeout < Time.now)
+            sleep 0.1
+          end
+        end
+
+        def fetch_suites
+          evaluate_js(
+              "var result = jsApiReporter.suites(); " \
+               "if (window.Prototype && Object.toJSON) { return Object.toJSON(result) } " \
+               "else { return JSON.stringify(result) }")
+        end
+
+        def jasmine_execution_timeout
+          300
+        end
+
+        def wait_for_jasmine_to_finish(timeout)
+          started = Time.now
+          while !evaluate_js('return jsApiReporter.finished') do
+            raise "Timed out after #{timeout}s waiting for Jasmine to finish" if (started + timeout < Time.now)
+            sleep 0.1
+          end
+        end
+
+        def fetch_suite_results(suites)
+          spec_results = {}
+          extract_spec_ids(suites).each_slice(@result_batch_size) do |slice|
+            slice_results = evaluate_js(
+                "var result = jsApiReporter.resultsForSpecs(#{json_generate(slice)}); " \
+                 "if (window.Prototype && Object.toJSON) { return Object.toJSON(result) } " \
+                 "else { return JSON.stringify(result) }")
+            spec_results.merge!(slice_results)
+          end
+          spec_results
+        end
+
+        def extract_spec_ids(suites)
+          map_spec_ids = lambda do |suites|
+            suites.map do |suite_or_spec|
+              if suite_or_spec['type'] == 'spec'
+                suite_or_spec['id']
+              else
+                map_spec_ids.call(suite_or_spec['children'])
+              end
+            end
+          end
+          map_spec_ids.call(suites).compact.flatten
+        end
+
+        def evaluate_js(script)
+          @driver.evaluate_js(script)
+        end
+
+        def json_generate(obj)
+          JSON.generate(obj)
+        end
+      end
+    end
+  end
+end