blade-sauce_labs_plugin 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2733717f9692c727f0ab682719aed8d0ee0d4774
-  data.tar.gz: 3e1c39b55266c0699876b259dba3defcd070c956
+  metadata.gz: 36b3598b5eaa5726a03629ec518e327f316bd556
+  data.tar.gz: f30ffedd23ac0dc98cb70bf3135690bc92b0bacc
 SHA512:
-  metadata.gz: 57434ce3d3b2ed0076ca5144f9b13ba4c10ed2af88658ce9c88d699b55f28bc520aa266e9cbb4c845618eff6c49c6ab91af91557ba2839befbcee9c66589dc74
-  data.tar.gz: 46cede3586837f693d622bff817d05a506c11adcfb82b7cc06fe490fedfe25a62d725aa0e2a1e015d886aa367ad5eb55ba51ad2ec5e964907de3edcada4cfc1c
+  metadata.gz: c7acce2a43bc42c59722174128be43291d8018f0480c02ae85b6d506cc44ce1ede98d46c62bb8bc78c95b1619a61e9d063e74820dcb723c4cea78f14fe276631
+  data.tar.gz: b91a3980daba289f58775c094e6eae01d13c1dd6b1efe842fd2033feb76eb1d28b2df2cffc1b3b5855a6768b38c12c116b0dce1febd1ff442f14e69fdbbff3e7

data/README.md

@@ -1 +1,69 @@
 [Blade](https://github.com/javan/blade) plugin for [Sauce Labs](https://saucelabs.com/)
+
+## Configuration
+
+### Authenticate with Sauce Labs
+
+Set the `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables to authenticate with Sauce Labs.
+
+All CI tools provide a way to set environment variables for a test run. For non-CI test runs, set the environment variables in your shell or in your test runner script.
+
+### Pick the browsers to run against
+
+Rather than exhaustively list every permutation of devices, operating systems,
+and browsers, we use a shorthand to match all the platforms we target.
+
+Full example:
+```yaml
+plugins:
+  sauce_labs:
+    browsers:
+      # Internet Explorer 11 on every device and operating system it supports.
+      IE: 11
+
+      # Latest two Chrome releases on all Mac and Windows platforms:
+      Google Chrome:
+        os: Mac, Windows
+        version: -2
+
+      # Latest two Firefox releases on every platform:
+      Firefox:
+        version: -2
+
+      # Latest Safari release on every Mac platform (OS X 10.x):
+      Safari:
+        platform: Mac
+        version: -1
+
+      # Latest two Edge releases on every platform:
+      Microsoft Edge:
+        version: -2
+
+      # Specific iOS Mobile Safari versions:
+      iPhone:
+        version: [9.2, 8.4]
+
+      # Mobile-specific browser:
+      Motorola Droid 4 Emulator:
+        version: [5.1, 4.4]
+```
+
+See Sauce Labs' [Platform Configurator](https://wiki.saucelabs.com/display/DOCS/Platform+Configurator) for an exhaustive list of supported devices, operating systems, and browsers.
+
+### Advanced configuration
+
+For low-level Sauce Connect configuration, set `tunnel_args` to an array of command line arguments.
+
+Example:
+```yaml
+plugins:
+  sauce_labs:
+    tunnel_args:
+      - "--verbose"     # Turn on verbose logging.
+      - "--vm-version"  # Use the varnish VM for WebSockets support.
+      - "dev-varnish"
+```
+
+The plugin already sets the `--user`, `--api-key`, `--tunnel-identifier`, and `--readyfile` arguments, so don't set these yourself.
+
+Full [Sauce Connect command line reference](https://wiki.saucelabs.com/pages/viewpage.action?pageId=48365781).

data/bin/update_sc

@@ -0,0 +1,25 @@
+#!/bin/bash
+set -euo pipefail
+
+which -s wget || brew install wget
+which -s jq || brew install jq
+
+download_and_extract() {
+  local url="$1"
+  local dirname="$2"
+  local extension="$3"
+  local filename="$dirname$extension"
+
+  wget "$url" -O "$filename"
+  tar -zxvf "$filename" -C "$dirname" --strip=1
+  rm -f "$filename"
+}
+
+platforms=$(curl https://saucelabs.com/versions.json | jq '."Sauce Connect"')
+
+osx_url=$(echo "$platforms" | jq --raw-output '.osx.download_url')
+linux_url=$(echo "$platforms" | jq --raw-output '.linux.download_url')
+
+cd support
+download_and_extract "$osx_url" "sc-osx" ".zip"
+download_and_extract "$linux_url" "sc-linux" ".tar.gz"

data/lib/blade/sauce_labs_plugin/job_manager.rb

@@ -3,7 +3,7 @@ module Blade::SauceLabsPlugin::JobManager
 
   Job = Blade::SauceLabsPlugin::Job
 
-  delegate :config, :client, to: Blade::SauceLabsPlugin
+  delegate :config, :client, :session_manager, to: Blade::SauceLabsPlugin
 
   cattr_accessor(:job_queue) { EM::Queue.new }
   cattr_accessor(:jobs) { [] }
@@ -11,7 +11,12 @@ module Blade::SauceLabsPlugin::JobManager
   def start
     enqueue_jobs
     process_queue
-    handle_completed_jobs
+
+    Blade.subscribe("/results") do |details|
+      if details[:completed]
+        EM.add_timer(1) { process_queue }
+      end
+    end
   end
 
   def stop
@@ -36,6 +41,7 @@ module Blade::SauceLabsPlugin::JobManager
           job_queue.pop do |job|
             job.callback do
               jobs << job
+              session_manager.update(job.session_id, job: job)
             end
 
             job.errback do
@@ -65,18 +71,6 @@ module Blade::SauceLabsPlugin::JobManager
       end
     end
 
-    def handle_completed_jobs
-      Blade.subscribe("/results") do |details|
-        if details["completed"]
-          if job = jobs.detect { |job| job.session_id == details["session_id"] }
-            job.stop
-            job.update(passed: (details["state"] != "failed"))
-            EM.add_timer(1) { process_queue }
-          end
-        end
-      end
-    end
-
     def test_params
       camelize_keys(combined_test_config)
     end

data/lib/blade/sauce_labs_plugin/session_manager.rb

@@ -0,0 +1,39 @@
+module Blade::SauceLabsPlugin::SessionManager
+  extend self
+
+  delegate :client, to: Blade::SauceLabsPlugin
+
+  mattr_accessor(:sessions) { Hash.new }
+
+  def start
+    Blade.config.expected_sessions = client.platforms.size
+    handle_completed_jobs
+  end
+
+  def stop
+  end
+
+  def update(session_id, data = {})
+    session =
+      if sessions[session_id]
+        sessions[session_id].merge!(data)
+      else
+        sessions[session_id] = data
+      end
+
+    if session.has_key?(:job) && session.has_key?(:passed)
+      session[:job].update(passed: session[:passed])
+      session[:job].stop
+    end
+  end
+
+  private
+    def handle_completed_jobs
+      Blade.subscribe("/results") do |details|
+        if details[:completed]
+          passed = details[:state] != "failed"
+          update(details[:session_id], passed: passed)
+        end
+      end
+    end
+end

data/lib/blade/sauce_labs_plugin/tunnel.rb

@@ -36,6 +36,7 @@ module Blade::SauceLabsPlugin::Tunnel
       ChildProcess.build(tunnel_command, *tunnel_args).tap do |process|
         process.leader = true
         process.io.inherit! if debug?
+        process.environment.merge! tunnel_env
         process.start
         debug process.inspect
       end
@@ -46,7 +47,11 @@ module Blade::SauceLabsPlugin::Tunnel
     end
 
     def tunnel_args
-      ["--user", username, "--api-key", access_key, "--tunnel-identifier", identifier, "--readyfile", ready_file_path]
+      ["--tunnel-identifier", identifier, "--readyfile", ready_file_path] + Array(config.tunnel_args)
+    end
+
+    def tunnel_env
+      { "SAUCE_USERNAME" => username, "SAUCE_ACCESS_KEY" => access_key }
     end
 
     def ready_file_path

data/lib/blade/sauce_labs_plugin/version.rb

@@ -1,5 +1,5 @@
 module Blade
   module SauceLabsPlugin
-    VERSION = "0.5.1"
+    VERSION = "0.5.2"
   end
 end

data/lib/blade/sauce_labs_plugin/web_driver.rb

@@ -38,9 +38,19 @@ class Blade::SauceLabsPlugin::WebDriver < EventMachine::Completion
   def navigate_to(url)
     EM.defer do
       begin
-        driver.navigate.to url
-        sleep 0.5
-        yield driver.current_url == url
+        driver.navigate.to(url)
+
+        start = Time.now
+
+        EM.tick_loop do
+          if driver.current_url == url
+            yield true
+            :stop
+          elsif Time.now - start > 2
+            yield false
+            :stop
+          end
+        end
       rescue
         yield false
       end

data/lib/blade/sauce_labs_plugin.rb

@@ -13,11 +13,12 @@ module Blade::SauceLabsPlugin
   autoload :WebDriver, "blade/sauce_labs_plugin/web_driver"
   autoload :Job, "blade/sauce_labs_plugin/job"
   autoload :JobManager, "blade/sauce_labs_plugin/job_manager"
+  autoload :SessionManager, "blade/sauce_labs_plugin/session_manager"
 
   def start
     if Blade.config.interface == :ci
       tunnel.start do
-        Blade.config.expected_sessions = client.platforms.size
+        session_manager.start
         job_manager.start
       end
     end
@@ -39,6 +40,10 @@ module Blade::SauceLabsPlugin
     Client
   end
 
+  def session_manager
+    SessionManager
+  end
+
   def job_manager
     JobManager
   end
@@ -48,11 +53,11 @@ module Blade::SauceLabsPlugin
   end
 
   def username
-    config.username || ENV["SAUCE_USERNAME"]
+    ENV["SAUCE_USERNAME"] || config.username
   end
 
   def access_key
-    config.access_key || ENV["SAUCE_ACCESS_KEY"]
+    ENV["SAUCE_ACCESS_KEY"] || config.access_key
   end
 
   def debug(message)

data/support/sc-linux/lib/libsauceconnect.la

@@ -17,7 +17,7 @@ old_library='libsauceconnect.a'
 inherited_linker_flags=' -pthread'
 
 # Libraries that this one depends upon.
-dependency_libs=' -L/build/build/Linux/openssl/lib -L/build/curl/ares /build/build/sc-build-2010/lib/libevent.la /build/build/sc-build-2010/lib/libevent_openssl.la /build/build/sc-build-2010/lib/libcares.la /build/build/sc-build-2010/lib/libcurl.la /build/build/sc-build-2010/lib/libcares.la -lz -lrt /build/build/sc-build-2010/lib/libunwind.la -lc -lgcc -lssl -lcrypto -ldl'
+dependency_libs=' -L/build/build/Linux/openssl/lib -L/build/c-ares/.libs -L/home/travis/build/saucelabs/libsauceconnect/curl/ares /build/build/sc-build-2396/lib/libevent.la /build/build/sc-build-2396/lib/libevent_openssl.la /build/build/sc-build-2396/lib/libcares.la /build/build/sc-build-2396/lib/libcurl.la /build/build/sc-build-2396/lib/libcares.la -lz -lrt /build/build/sc-build-2396/lib/libunwind.la -lc -lgcc -lssl -lcrypto -ldl'
 
 # Names of additional weak libraries provided by this library
 weak_library_names=''
@@ -38,4 +38,4 @@ dlopen=''
 dlpreopen=''
 
 # Directory that this library needs to be installed in:
-libdir='/build/build/sc-build-2010/lib'
+libdir='/build/build/sc-build-2396/lib'

data/support/sc-osx/lib/libsauceconnect.la

@@ -17,7 +17,7 @@ old_library='libsauceconnect.a'
 inherited_linker_flags='  -framework CoreFoundation -framework Security'
 
 # Libraries that this one depends upon.
-dependency_libs=' -L/Users/travis/build/saucelabs/libsauceconnect/build/Darwin/openssl/lib -L/Users/travis/build/saucelabs/libsauceconnect/curl/ares /Users/travis/build/saucelabs/libsauceconnect/build/sc-build-2011/lib/libevent.la /Users/travis/build/saucelabs/libsauceconnect/build/sc-build-2011/lib/libevent_openssl.la /Users/travis/build/saucelabs/libsauceconnect/build/sc-build-2011/lib/libcares.la /Users/travis/build/saucelabs/libsauceconnect/build/sc-build-2011/lib/libcurl.la /Users/travis/build/saucelabs/libsauceconnect/build/sc-build-2011/lib/libcares.la -lz -lssl -lcrypto -ldl'
+dependency_libs=' -L/Users/travis/build/saucelabs/libsauceconnect/build/Darwin/openssl/lib -L/Users/travis/build/saucelabs/libsauceconnect/c-ares/.libs -L/Users/travis/build/saucelabs/libsauceconnect/curl/ares /Users/travis/build/saucelabs/libsauceconnect/build/sc-build-2399/lib/libevent.la /Users/travis/build/saucelabs/libsauceconnect/build/sc-build-2399/lib/libevent_openssl.la /Users/travis/build/saucelabs/libsauceconnect/build/sc-build-2399/lib/libcares.la /Users/travis/build/saucelabs/libsauceconnect/build/sc-build-2399/lib/libcurl.la /Users/travis/build/saucelabs/libsauceconnect/build/sc-build-2399/lib/libcares.la -lz -lssl -lcrypto -ldl'
 
 # Names of additional weak libraries provided by this library
 weak_library_names=''
@@ -38,4 +38,4 @@ dlopen=''
 dlpreopen=''
 
 # Directory that this library needs to be installed in:
-libdir='/Users/travis/build/saucelabs/libsauceconnect/build/sc-build-2011/lib'
+libdir='/Users/travis/build/saucelabs/libsauceconnect/build/sc-build-2399/lib'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blade-sauce_labs_plugin
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Javan Makhmali
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-30 00:00:00.000000000 Z
+date: 2016-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,12 +123,14 @@ files:
 - bin/console
 - bin/rake
 - bin/setup
+- bin/update_sc
 - blade-sauce_labs_plugin.gemspec
 - lib/blade/sauce_labs_plugin.rb
 - lib/blade/sauce_labs_plugin/cli.rb
 - lib/blade/sauce_labs_plugin/client.rb
 - lib/blade/sauce_labs_plugin/job.rb
 - lib/blade/sauce_labs_plugin/job_manager.rb
+- lib/blade/sauce_labs_plugin/session_manager.rb
 - lib/blade/sauce_labs_plugin/tunnel.rb
 - lib/blade/sauce_labs_plugin/version.rb
 - lib/blade/sauce_labs_plugin/web_driver.rb