sauce_connect 3.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b56c2f924091bac3a7f5aca719edd393812043d6
+  data.tar.gz: e50ee142b53516ce21bf448a12981241b484e345
+SHA512:
+  metadata.gz: a2dbef3999ab736761308dd400f22ee5fe0f2ef67c2cd9e6dbf19f3ffff7c363119d2aa9560beba4bc302621f348e7364db2dbb21cf20cc0b8b865ad7118e066
+  data.tar.gz: 43e4d418185295b57f69a84806a69c768c6ff762f04d528e9550299cb8651ec8c0351007bebe9e4c981e479e8ed0a6454519285e95c600a846dddccea370e9af

data/lib/sauce/connect.rb

@@ -0,0 +1,242 @@
+require 'sauce/config'
+require 'net/http'
+require 'socket'
+
+module Sauce
+  class Connect
+    class TunnelNotPossibleException < StandardError
+    end
+
+    TIMEOUT = 90
+
+    attr_reader :status, :error
+
+    def initialize(options={})
+      @ready = false
+      @status = "uninitialized"
+      @error = nil
+      @quiet = options[:quiet]
+      @timeout = options.fetch(:timeout) { TIMEOUT }
+      @config = Sauce::Config.new(options)
+      @skip_connection_test = @config[:skip_connection_test]
+      @cli_options = @config[:connect_options]
+      @sc4_executable = @config[:sauce_connect_4_executable]
+
+      if @config.username.nil?
+        raise ArgumentError, "Username required to launch Sauce Connect. Please set the environment variable $SAUCE_USERNAME"
+      end
+
+      if @config.access_key.nil?
+        raise ArgumentError, "Access key required to launch Sauce Connect. Please set the environment variable $SAUCE_ACCESS_KEY"
+      end
+
+      if @sc4_executable.nil?
+        raise TunnelNotPossibleException, Sauce::Connect.plzGetSC4
+      end
+    end
+
+    def ensure_connection_is_possible
+      $stderr.puts "[Checking REST API is contactable...]" unless @quiet
+      uri = URI("http://saucelabs.com/rest/v1/#{@config[:username]}/tunnels")
+      
+      response = Net::HTTP.start(uri.host, uri.port) do |http|
+        request = Net::HTTP::Get.new uri.request_uri
+        request.basic_auth(@config[:username], @config[:access_key])
+        response = http.request request
+      end
+
+      unless response.kind_of? Net::HTTPOK
+        $stderr.puts Sauce::Connect.cant_access_rest_api_message
+        raise TunnelNotPossibleException, "Couldn't access REST API"
+      end
+
+      begin
+        $stderr.puts "[Checking port 443 is open...]" unless @quiet
+        socket = TCPSocket.new 'saucelabs.com', 443
+      rescue SystemCallError => e
+        raise e unless e.class.name.start_with? 'Errno::'
+        $stderr.puts Sauce::Connect.port_not_open_message
+        raise TunnelNotPossibleException, "Couldn't use port 443"
+      end
+    end
+
+    def connect
+      unless @skip_connection_test
+        ensure_connection_is_possible
+      end
+
+      puts "[Sauce Connect is connecting to Sauce Labs...]"
+
+      formatted_cli_options = array_of_formatted_cli_options_from_hash(cli_options)
+
+      command_args = ['-u', @config.username, '-k', @config.access_key]
+      command_args << formatted_cli_options
+
+      command = "exec #{find_sauce_connect} #{command_args.join(' ')} 2>&1"
+
+      unless @quiet
+        string_arguments = formatted_cli_options.join(' ')
+        puts "[Sauce Connect arguments: '#{string_arguments}' ]"
+      end
+
+      @pipe = IO.popen(command)
+
+      @process_status = $?
+      at_exit do
+        Process.kill("INT", @pipe.pid)
+        while @ready
+          sleep 1
+        end
+      end
+
+      Thread.new {
+        while( (line = @pipe.gets) )
+          if line =~ /Tunnel remote VM is (.*) (\.\.|at)/
+            @status = $1
+          end
+          if line =~/You may start your tests\./i
+            @ready = true
+          end
+          if line =~ /- (Problem.*)$/
+            @error = $1
+            @quiet = false
+          end
+          if line =~ /== Missing requirements ==/
+            @error = "Missing requirements"
+            @quiet = false
+          end
+          if line =~/Invalid API_KEY provided/
+            @error = "Invalid API_KEY provided"
+            @quiet = false
+          end
+          $stderr.puts line unless @quiet
+        end
+        @ready = false
+        }
+    end
+
+    def cli_options
+      cli_options = { readyfile: "sauce_connect.ready" }
+      cli_options.merge!(@cli_options) if @cli_options
+      cli_options
+    end
+
+    def wait_until_ready
+      start = Time.now
+      while !@ready and (Time.now-start) < @timeout and @error != "Missing requirements"
+        sleep 0.5
+      end
+
+      if @error == "Missing requirements"
+        raise "Missing requirements"
+      end
+
+      if !@ready
+        error_message = "Sauce Connect failed to connect after #{@timeout} seconds"
+        error_message << "\n(Using Sauce Connect at #{@sc4_executable}"
+        raise error_message
+      end
+    end
+
+    def disconnect
+      if @ready
+        Process.kill("INT", @pipe.pid)
+        while @ready
+          sleep 1
+        end
+      end
+    end
+
+    # Check whether the path, or it's bin/sc descendant, exists and is executable
+    def find_sauce_connect
+      paths = [@sc4_executable, File.join("#{@sc4_executable}", "bin", "sc")]
+
+      sc_path = paths.find do |path|
+        path_is_connect_executable? path
+      end
+
+      if sc_path.nil?
+        raise TunnelNotPossibleException, "No executable found at #{sc_path}, or it can't be executed by #{Process.euid}"
+      end
+
+      return File.absolute_path sc_path
+    end
+
+    def path_is_connect_executable? path
+      absolute_path = File.absolute_path path
+      return (File.exist? absolute_path) && (File.executable? absolute_path) && !(Dir.exist? absolute_path)
+    end
+
+    # Global Sauce Connect-ness
+    @connection = nil
+
+    def self.connect!(*args)
+      @connection = self.new(*args)
+      @connection.connect
+      @connection.wait_until_ready
+      at_exit do
+        @connection.disconnect
+      end
+    end
+
+    def self.ensure_connected(*args)
+      if @connection
+        @connection.wait_until_ready
+      else
+        connect!(*args)
+      end
+    end
+
+    private
+
+    def array_of_formatted_cli_options_from_hash(hash)
+      hash.collect do |key, value|
+        opt_name = key.to_s.gsub("_", "-")
+        "--#{opt_name} #{value}"
+      end
+    end
+
+    def self.port_not_open_message
+      <<-ENDLINE
+        Unable to connect to port 443 on saucelabs.com, which may interfere with
+        Sauce Connect.
+
+        This might be caused by a HTTP mocking framework like WebMock or 
+        FakeWeb.  Check out 
+        (https://github.com/saucelabs/sauce_ruby#network-mocking) 
+        if you're using one.  Sauce Connect needs access to *.saucelabs.com,
+        port 80 and port 443.
+
+        You can disable network tests by setting :skip_connection_test to true in
+        your Sauce.config block.
+      ENDLINE
+    end
+
+    def self.cant_access_rest_api_message
+      <<-ENDLINE
+        Unable to connect to the Sauce REST API, which may interfere with
+        Sauce Connect.
+
+        This might be caused by a HTTP mocking framework like WebMock or 
+        FakeWeb.  Check out 
+        (https://github.com/saucelabs/sauce_ruby#network-mocking) 
+        if you're using one.  Sauce Connect needs access to *.saucelabs.com,
+        port 80 and port 443.
+        
+        You can disable network tests by setting :skip_connection_test to true in
+        your Sauce.config block.
+      ENDLINE
+    end
+
+    def self.plzGetSC4
+      <<-ENDLINE
+        Using Sauce Connect 3 has been deprecated.  Please set the :sauce_connect_4_executable
+        option in your Sauce.config block to the path of an installation of
+        Sauce Connect 4.
+
+        You can download Sauce Connect 4 for free at
+        http://docs.saucelabs.com/sauce_connect
+      ENDLINE
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: sauce_connect
+version: !ruby/object:Gem::Version
+  version: 3.6.1
+platform: ruby
+authors:
+- R. Tyler Croy
+- Steve Hazel
+- Dylan Lacey
+- Rick Martínez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sauce_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: A wrapper to start and stop a Sauce Connect tunnel programatically.
+email:
+- tyler@monkeypox.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sauce/connect.rb
+homepage: https://docs.saucelabs.com/reference/sauce-connect
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: |2
+    To use the Sauce Connect gem, you'll need to download the appropriate
+    Sauce Connect binary from https://docs.saucelabs.com/reference/sauce-connect
+
+    Then, set the 'sauce_connect_4_executable' key in your Sauce.config block, to
+    the path of the unzipped file's /bin/sc.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- An account at http://www.saucelabs.com
+- A working copy of Sauce Connect from https://docs.saucelabs.com/reference/sauce-connect
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Manage Sauce Connect from within your tests
+test_files: []
+has_rdoc: