jasmine-selenium-sauce 1.1.1 → 1.2.0

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
+  - "1.8.7"
   - "1.9.2"
   - "1.9.3"

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## 1.2.0
+
+- Added rake task for running jasmine suite through SauceLabs against localhost using a tunnel
+- Compatible with Ruby 1.8.7
+
+## 1.1.1
+
+- Minor cleanup
+
+## 1.1.0
+
+- Added rake task that supports running jasmine suite using local browser
+
+## 1.0.0
+
+- Initial release supporting running jasmine suite using SauceLabs

data/README.md

@@ -2,26 +2,24 @@
 
 # Jasmine::Sauce::Ci
 
-Rake tasks for running your Jasmine suite via a local browse or through SauceLabs using the 
+Rake tasks for running your Jasmine suite via a local browser or through SauceLabs using the
 [Selenium Webdriver](http://seleniumhq.org/projects/webdriver/).
 
-Can be used in your CI builds to enable running Jasmine suites.
+Can be used in your CI builds to enable running Jasmine suites. The Jasmine results are reported using RSpec to make
+parsing easy.
 
-## Installation
+# Installation
 
 Add this line to your application's Gemfile:
 
     gem 'jasmine-selenium-sauce'
 
-And then execute:
+# Running Jasmine via SauceLabs
 
-    $ bundle
+## Remote Jasmine Server
 
-Or install it yourself as:
-
-    $ gem install jasmine-selenium-sauce
-
-## Running Jasmine via SauceLabs
+When you want to run a Jasmine suite hosted on a publicly available host. Uses Selenium to connect to SauceLabs, and 
+requests a browser instance to run your suite.
 
     rake jasmine:sauce
 
@@ -29,68 +27,91 @@ Or install it yourself as:
 
 Requires the following environment variables to be set:
 
-#### SAUCELABS_URL
+```shell
+SAUCELABS_URL=http://username:password@ondemand.saucelabs.com:80/wd/hub
+```
+- URL for Saucelabs with your credentials included
+
+```shell
+JASMINE_URL=http://my.server.com/jasmine
+```
+- Where your Jasmine tests are hosted
 
-URL for Saucelabs with your credentials included:
+```shell
+SAUCE_BROWSER=chrome
+```
+- Which browser SauceLabs should use to run your tests
 
-    SAUCELABS_URL=http://username:password@ondemand.saucelabs.com:80/wd/hub
+## Local Jasmine Server behind a Firewall
 
-#### JASMINE_URL
+When you want to run a Jasmine suite hosted on an internal host. Uses [LocalTunnel](http://progrium.com/localtunnel/)
+to make localhost available through a tunnel. It then uses Selenium to connect to SauceLabs, and requests a 
+browser instance to run your suite.
 
-Where your Jasmine tests are hosted:
+    rake jasmine:local_sauce
 
-    JASMINE_URL=http://my.server.com/jasmine
+### Required Environment Variables
 
-#### SAUCE_BROWSER
+Requires the following environment variables to be set:
 
-Which browser SauceLabs should use to run your tests:
+```shell
+SAUCELABS_URL=http://username:password@ondemand.saucelabs.com:80/wd/hub
+```
+- URL for Saucelabs with your credentials included
 
-    SAUCE_BROWSER=chrome
+```shell
+JASMINE_PORT=3000
+```
+- Port on localhost where jasmine tests are located
 
-### Optional Configuration
+```shell
+SAUCE_BROWSER=chrome
+```
+- Which browser SauceLabs should use to run your tests
 
-#### RSpec
+## Optional Configuration
 
-You can specify the format of the RSpec report with:
+### RSpec
 
-    JASMINE_SPEC_FORMAT=documentation
+```shell
+JASMINE_SPEC_FORMAT=documentation
+```
+- Allows you to control the format of the RSpec report
 
-#### Sauce Labs Configuration
+### Additional Sauce Labs Configuration
 
 See [sauce_config.rb](https://github.com/darend/jasmine-selenium-sauce/tree/master/lib/jasmine-selenium-sauce/sauce_config.rb)
 
-## Running Jasmine via local browser
+# Running Jasmine via local browser
 
     rake jasmine:browser
 
-### Required Environment Variables
+## Required Environment Variables
 
 Requires the following environment variables to be set:
 
-#### JASMINE_URL
-
-Where your Jasmine tests are hosted:
-
-    JASMINE_URL=http://my.server.com/jasmine
-
-#### LOCAL_BROWSER
-
-Which browser that will be used to run your tests. Selenium may require a driver be installed depending the driver. See
-the Selenium documentation for more details.
-
-    LOCAL_BROWSER=firefox
+```shell
+JASMINE_URL=http://my.server.com/jasmine
+```
+- Where your Jasmine tests are hosted
 
+```shell
+LOCAL_BROWSER=firefox
+```
+- Which browser that will be used to run your tests. Selenium may require a driver be installed depending the driver. See
+the Selenium documentation for more details
 See [Which browsers does WebDriver support?](http://code.google.com/p/selenium/wiki/FrequentlyAskedQuestions#Q:_Which_browsers_does_WebDriver_support?).
 
-### Optional Configuration
-
-#### RSpec
+## Optional Configuration
 
-You can specify the format of the RSpec report with:
+### RSpec
 
-    JASMINE_SPEC_FORMAT=documentation
+```shell
+JASMINE_SPEC_FORMAT=documentation
+```
+- Allows you to control the format of the RSpec report
 
-## Contributing
+# Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/jasmine-selenium-sauce.gemspec

@@ -2,10 +2,10 @@
 require File.expand_path('../lib/jasmine-selenium-sauce/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Daren"]
+  gem.authors       = ["Daren Desjardins"]
   gem.email         = ["darend@gmail.com"]
-  gem.description   = %q{Rake tasks for running your Jasmine suite via a local browse or through SauceLabs}
-  gem.summary       = %q{Rake tasks for running your Jasmine suite via a local browse or through SauceLabs. Can be used in your CI builds to enable running Jasmine suites}
+  gem.description   = %q{Rake tasks for running your Jasmine suite via a local browser or through SauceLabs}
+  gem.summary       = %q{Rake tasks for running your Jasmine suite via a local browser or through SauceLabs. Can be used in your CI builds to enable running Jasmine suites}
   gem.homepage      = "https://github.com/darend/jasmine-selenium-sauce"
 
   gem.files         = `git ls-files`.split($\)
@@ -23,6 +23,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rb-fsevent'
   gem.add_development_dependency 'vcr'
 
+  gem.add_dependency 'localtunnel', "~> 0.3"
   gem.add_dependency 'rspec', ">= 2.0"
-  gem.add_dependency 'selenium-webdriver'
+  gem.add_dependency 'selenium-webdriver', "> 2.0.0"
 end

data/lib/jasmine-selenium-sauce.rb

@@ -3,8 +3,14 @@ require 'jasmine-selenium-sauce/jasmine_results'
 require 'jasmine-selenium-sauce/rspec_reporter'
 require 'jasmine-selenium-sauce/browser_config'
 require 'jasmine-selenium-sauce/sauce_config'
+require 'jasmine-selenium-sauce/local_sauce_config'
 require 'jasmine-selenium-sauce/selenium_runner'
-require 'jasmine-selenium-sauce/drivers'
+require 'jasmine-selenium-sauce/drivers/selenium_driver'
+require 'jasmine-selenium-sauce/drivers/selenium_browser_driver'
+require 'jasmine-selenium-sauce/drivers/selenium_saucelabs_driver'
+
+require 'localtunnel/tunnel'
+require 'localtunnel_patch'
 
 module Jasmine
   module Sauce
@@ -12,13 +18,25 @@ module Jasmine
 
       class Main
         def self.run_via_saucelabs(sauce_config, reporter = RspecReporter.new)
+          puts "Using SauceLabs to run Jasmine suite located at #{sauce_config.jasmine_server_url}"
           driver = SeleniumSauceLabsDriver.new(sauce_config)
           selenium_runner = SeleniumRunner.new(driver)
           results = selenium_runner.run(sauce_config.jasmine_server_url)
           reporter.report(results)
         end
 
+        def self.run_local_via_saucelabs(local_sauce_config, reporter = RspecReporter.new)
+          puts "Establishing tunnel to port #{local_sauce_config.jasmine_server_port}"
+          tunnel = LocalTunnel::Tunnel.new(local_sauce_config.jasmine_server_port,nil)
+          response = tunnel.register_tunnel
+          tunnel.start_tunnel do
+            ENV['JASMINE_URL'] = "http://#{response['host']}/jasmine"
+            run_via_saucelabs(local_sauce_config, reporter)
+          end
+        end
+
         def self.run_via_browser(browser_config, reporter = RspecReporter.new)
+          puts "Running Jasmine suite against #{browser_config.jasmine_server_url} using #{browser_config.browser}"
           driver = SeleniumBrowserDriver.new(browser_config.browser)
           selenium_runner = SeleniumRunner.new(driver)
           results = selenium_runner.run(browser_config.jasmine_server_url)

data/lib/jasmine-selenium-sauce/drivers/selenium_browser_driver.rb

@@ -1,5 +1,3 @@
-require_relative 'selenium_driver'
-
 module Jasmine
   module Sauce
     module CI

data/lib/jasmine-selenium-sauce/drivers/selenium_saucelabs_driver.rb

@@ -1,5 +1,3 @@
-require_relative 'selenium_driver'
-
 module Jasmine
   module Sauce
     module CI

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

@@ -0,0 +1,19 @@
+module Jasmine
+  module Sauce
+    module CI
+
+      class LocalSauceConfig < SauceConfig
+
+        def validate
+          raise ArgumentError.new("SAUCELABS_URL was not set") unless saucelabs_server_url
+          raise ArgumentError.new("JASMINE_PORT was not set") unless jasmine_server_port
+          raise ArgumentError.new("SAUCE_BROWSER was not set") unless browser
+        end
+
+        def jasmine_server_port
+          ENV['JASMINE_PORT']
+        end
+      end
+    end
+  end
+end

data/lib/jasmine-selenium-sauce/tasks/jasmine_selenium_sauce.rake

@@ -14,6 +14,20 @@ namespace :jasmine do
     Rake::Task["jasmine_sauce_runner"].invoke
   end
 
+  desc "Run Jasmine via SauceLabs against localhost using a tunnel"
+  task :local_sauce do
+    require "rspec/core/rake_task"
+
+    RSpec::Core::RakeTask.new(:jasmine_local_sauce_runner) do |t|
+      t.rspec_opts = ["--colour", "--format", ENV['JASMINE_SPEC_FORMAT'] || "progress"]
+      t.verbose = true
+      runner_path = File.expand_path(File.join(File.dirname(__FILE__), "rake_local_sauce_runner.rb"))
+      t.pattern = [runner_path]
+    end
+
+    Rake::Task["jasmine_local_sauce_runner"].invoke
+  end
+
   desc "Run Jasmine via local browser"
   task :browser do
     require "rspec/core/rake_task"
@@ -27,4 +41,6 @@ namespace :jasmine do
 
     Rake::Task["jasmine_browser_runner"].invoke
   end
+
+
 end

data/lib/jasmine-selenium-sauce/tasks/rake_browser_runner.rb

@@ -1,4 +1,4 @@
-require_relative '../../jasmine-selenium-sauce'
+require File.join(File.dirname(__FILE__), '../../jasmine-selenium-sauce')
 
 config = Jasmine::Sauce::CI::BrowserConfig.new
 begin

data/lib/jasmine-selenium-sauce/tasks/rake_local_sauce_runner.rb

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), '../../jasmine-selenium-sauce')
+
+begin
+  config = Jasmine::Sauce::CI::LocalSauceConfig.new
+  config.validate
+  Jasmine::Sauce::CI::Main.run_local_via_saucelabs(config)
+rescue ArgumentError => e
+  STDERR << "\nError: #{e.message}\n\n"
+  STDERR << "The following environment variables are required:\n"
+  STDERR << "\n"
+  STDERR << "    SAUCELABS_URL - Your SauceLabs OnDemand URL with Basic Auth (http://username:password@ondemand.saucelabs.com:80/wd/hub)\n"
+  STDERR << "    JASMINE_PORT - Port on localhost where server is running\n"
+  STDERR << "    SAUCE_BROWSER - Which Browser SauceLabs should use\n"
+  STDERR << "\n"
+  exit -1
+rescue StandardError => e
+  STDERR << "\nError: #{e.message}\n\n"
+  if e.message.include?("jsApiReporter is not defined")
+      STDERR << "Unable to find Jasmine tests, ensure server is running and #{config.jasmine_server_url} is correct\n\n"
+  end
+  exit -1
+end

data/lib/jasmine-selenium-sauce/tasks/rake_sauce_runner.rb

@@ -1,4 +1,4 @@
-require_relative '../../jasmine-selenium-sauce'
+require File.join(File.dirname(__FILE__), '../../jasmine-selenium-sauce')
 
 begin
   config = Jasmine::Sauce::CI::SauceConfig.new

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

@@ -1,7 +1,7 @@
 module Jasmine
   module Sauce
     module Ci
-      VERSION = "1.1.1"
+      VERSION = "1.2.0"
     end
   end
 end

data/lib/localtunnel_patch.rb

@@ -0,0 +1,28 @@
+class LocalTunnel::Tunnel
+
+  #
+  # Replace sleep call in start_tunnel with a yield to a block to be executed
+  # once the tunnel is established.
+  #
+  def start_tunnel
+    port = @port
+    tunnel = @tunnel
+    gateway = Net::SSH::Gateway.new(tunnel['host'], tunnel['user'])
+    gateway.open_remote(port.to_i, '127.0.0.1', tunnel['through_port'].to_i) do |rp,rh|
+      puts "   " << tunnel['banner'] if tunnel.has_key? 'banner'
+      puts "   Port #{port} is now publicly accessible from http://#{tunnel['host']} ..."
+      begin
+        yield
+      rescue Interrupt
+        gateway.close_remote(rp, rh)
+        exit
+      end
+    end
+  rescue Net::SSH::AuthenticationFailed
+    possible_key = Dir[File.expand_path('~/.ssh/*.pub')].first
+    puts "   Failed to authenticate. If this is your first tunnel, you need to"
+    puts "   upload a public key using the -k option. Try this:\n\n"
+    puts "   localtunnel -k #{possible_key ? possible_key : '~/path/to/key'} #{port}"
+    exit
+  end
+end

data/spec/fixtures/config_fixtures.rb

@@ -0,0 +1,79 @@
+
+shared_examples_for "overridable configuration setting" do |env_setting, default|
+  context "when not specified" do
+    it { should eq(default) }
+  end
+
+  context "when specified" do
+    let(:value) { "random value" }
+    before { ENV[env_setting] = value }
+    after { ENV.delete(env_setting) }
+    it { should eq(value) }
+  end
+end
+
+shared_examples_for "jasmine server url" do
+  describe "#jasmine_server_url" do
+    let(:url) { "http://my.host.com/jasmine" }
+    before { ENV['JASMINE_URL'] = url }
+    after { ENV.delete('JASMINE_URL') }
+    its(:jasmine_server_url) { should eq(url)}
+  end
+end
+
+shared_examples_for "sauce config" do
+
+  include_context "jasmine server url"
+
+  describe "#saucelabs_server_url" do
+    let(:url) { "http://user:password@ondemand.saucelabs.com:80/wd/hub" }
+    before { ENV['SAUCELABS_URL'] = url }
+    after { ENV.delete('SAUCELABS_URL') }
+    its(:saucelabs_server_url) { should eq(url)}
+  end
+
+  describe "#sauce_browser" do
+    let(:browser) { "Chrome" }
+    before { ENV['SAUCE_BROWSER'] = browser }
+    after { ENV.delete('SAUCE_BROWSER') }
+    its(:browser) { should eq(browser)}
+  end
+
+  describe "#sauce_platform" do
+    context "when not specified" do
+      its(:platform) { should eq(:VISTA) }
+    end
+
+    context "when specified" do
+      let(:platform) { "WIN_7" }
+      before { ENV['SAUCE_PLATFORM'] = platform }
+      after { ENV.delete('SAUCE_PLATFORM') }
+      its(:platform) { should eq(platform.to_sym) }
+    end
+  end
+
+  describe "#browser_version" do
+    subject { under_test.browser_version }
+    it_behaves_like "overridable configuration setting", 'SAUCE_BROWSER_VERSION', nil
+  end
+
+  describe "#record_screenshots" do
+    subject { under_test.record_screenshots }
+    it_behaves_like "overridable configuration setting", 'SAUCE_SCREENSHOTS', false
+  end
+
+  describe "#record_video" do
+    subject { under_test.record_video }
+    it_behaves_like "overridable configuration setting", 'SAUCE_VIDEO', false
+  end
+
+  describe "#idle_timeout" do
+    subject { under_test.idle_timeout }
+    it_behaves_like "overridable configuration setting", 'SAUCE_IDLE_TIMEOUT', 90
+  end
+
+  describe "#max_duration" do
+    subject { under_test.max_duration }
+    it_behaves_like "overridable configuration setting", 'SAUCE_MAX_DURATION', 180
+  end
+end