selenium-connect 2.3.0 → 3.0.0

data/lib/{selenium-connect → selenium_connect}/configuration.rb

@@ -2,7 +2,8 @@
 
 require 'yaml'
 
-module SeleniumConnect
+# selenium connect
+class SeleniumConnect
   # Encapsulates the configuration
   class Configuration
 
@@ -18,10 +19,11 @@ module SeleniumConnect
     attr_accessor :sauce_username, :sauce_api_key,
                   :os, :browser_version, :description
 
-    def initialize
+    def initialize(opts = {})
       @host     = 'localhost'
       @port     = 4444
       @browser  = 'firefox'
+      populate_with_hash opts unless opts.empty?
     end
 
     def populate_with_hash(hash)

data/lib/selenium_connect/job.rb

@@ -0,0 +1,102 @@
+# Encoding: utf-8
+require 'selenium_connect/runner'
+require 'sauce/client'
+require 'rest_client'
+require 'selenium-webdriver'
+require 'json'
+require 'sauce_whisk'
+require 'curb'
+
+# selenium connect
+class SeleniumConnect
+  # encapsulates the creation of a driver and a run
+  class Job
+
+    def initialize(config, report_factory)
+      @config = config
+      @report_factory = report_factory
+    end
+
+    # Creates and returns the driver, using options passed in
+    def start(opts = {})
+
+      # TODO this could be refactored out into an options parser of sorts
+      @config.description = opts[:name] if opts.has_key? :name
+
+      @driver = Runner.new(@config).driver
+    end
+
+    # Finishes the driver run, taking any data to help, returning report
+    def finish(opts = {})
+
+      # extracted from the earlier main finish
+      begin
+        @driver.quit
+        job_id = @driver.session_id
+        if @config.host == 'saucelabs'
+          if opts.has_key?(:failed) && opts[:failed]
+            fail_job job_id
+            if opts.has_key?(:failshot) && opts[:failshot]
+              save_last_screenshot job_id
+            end
+          end
+          if opts.has_key?(:passed) && opts[:passed]
+            pass_job job_id
+          end
+          data = fetch_logs(job_id)
+          report_data = symbolize_keys sauce_data: data
+        end
+      # rubocop:disable HandleExceptions
+      rescue Selenium::WebDriver::Error::WebDriverError
+      # rubocop:enable HandleExceptions
+      end
+
+      @report_factory.build :job, report_data
+    end
+
+    private
+
+      # TODO all this sauce stuff needs to be pulled out of the job class
+      # TODO need to put error handling around the sauce api requests
+      def save_last_screenshot(job_id)
+        begin
+        # Seemingly need to wait slightly for the images to be processed
+        sleep(2)
+        image = SauceWhisk::Jobs.fetch_asset job_id, 'final_screenshot.png'
+        image_file = File.join(Dir.getwd, @config.log, "failed_#{job_id}.png") if @config.log
+        File.open(image_file, 'w') { |f| f.write image }
+        rescue RestClient::ResourceNotFound
+          puts 'Unable to download image!'
+        end
+      end
+
+      def fail_job(job_id)
+        SauceWhisk::Jobs.fail_job job_id
+      end
+
+      def pass_job(job_id)
+        SauceWhisk::Jobs.pass_job job_id
+      end
+
+      def fetch_logs(job_id)
+        sauce_job = Sauce::Job.find(job_id)
+        # Seemingly need to wait slightly for the images to be processed
+        sleep(2)
+        server_log = SauceWhisk::Jobs.fetch_asset job_id, 'selenium-server.log'
+        log_file = File.join(Dir.getwd, @config.log, "sauce_job_#{job_id}.log") if @config.log
+        File.open(log_file, 'w') { |f| f.write server_log }
+        JSON.parse(sauce_job.to_json)
+      end
+
+      # TODO this should be pulled out into a generic report... or something
+      def symbolize_keys(hash)
+        hash.reduce({}) do |result, (key, value)|
+          new_key = key.class == String ? key.to_sym : key
+          new_value = value.class == Hash ? symbolize_keys(value) : value
+          result[new_key] = new_value
+          result
+        end
+      end
+  end
+end
+

data/lib/selenium_connect/report/job_report.rb

@@ -0,0 +1,17 @@
+# Encoding: utf-8
+
+# selenium connect
+class SeleniumConnect
+  module Report
+    # report for a specific job
+    class JobReport
+
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+
+    end
+  end
+end

data/lib/selenium_connect/report/main_report.rb

@@ -0,0 +1,17 @@
+# Encoding: utf-8
+
+# selenium connect
+class SeleniumConnect
+  module Report
+    # report for a connection
+    class MainReport
+
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+
+    end
+  end
+end

data/lib/selenium_connect/report/report_factory.rb

@@ -0,0 +1,25 @@
+# Encoding: utf-8
+
+require 'selenium_connect/report/job_report'
+require 'selenium_connect/report/main_report'
+
+# selenium connect
+class SeleniumConnect
+  module Report
+    # creates report objects
+    class ReportFactory
+
+      def build(type, data)
+        # resource locator for report
+        case type
+        when :main
+          SeleniumConnect::Report::MainReport.new data
+        when :job
+          SeleniumConnect::Report::JobReport.new data
+        else
+          raise ArgumentError, "Report type \"#{type.to_s}\" unknown!"
+        end
+      end
+    end
+  end
+end

data/lib/{selenium-connect → selenium_connect}/runner.rb

@@ -1,13 +1,14 @@
 # Encoding: utf-8
 
-require 'selenium-connect/runners/firefox'
-require 'selenium-connect/runners/ie'
-require 'selenium-connect/runners/chrome'
-require 'selenium-connect/runners/phantomjs'
-require 'selenium-connect/runners/no_browser'
-require 'selenium-connect/runners/saucelabs'
-
-module SeleniumConnect
+require 'selenium_connect/runners/firefox'
+require 'selenium_connect/runners/ie'
+require 'selenium_connect/runners/chrome'
+require 'selenium_connect/runners/phantomjs'
+require 'selenium_connect/runners/no_browser'
+require 'selenium_connect/runners/saucelabs'
+
+# selenium connect
+class SeleniumConnect
   # Initializes the driver
   class Runner
     attr_reader :driver, :config

data/lib/{selenium-connect → selenium_connect}/runners/chrome.rb

@@ -1,6 +1,6 @@
 # Encoding: utf-8
 
-module SeleniumConnect
+class SeleniumConnect
   # Runner
   class Runner
     # Chrome browser runner

data/lib/{selenium-connect → selenium_connect}/runners/firefox.rb

@@ -1,6 +1,6 @@
 # Encoding: utf-8
 
-module SeleniumConnect
+class SeleniumConnect
   # Runner
   class Runner
     # Firefox browser runner

data/lib/{selenium-connect → selenium_connect}/runners/ie.rb

@@ -1,6 +1,6 @@
 # Encoding: utf-8
 
-module SeleniumConnect
+class SeleniumConnect
   # Runner
   class Runner
     # IE Browser Runner

data/lib/{selenium-connect → selenium_connect}/runners/no_browser.rb

@@ -1,6 +1,6 @@
 # Encoding: utf-8
 
-module SeleniumConnect
+class SeleniumConnect
   # Runner
   class Runner
     # No Browser Runner

data/lib/{selenium-connect → selenium_connect}/runners/phantomjs.rb

@@ -1,6 +1,6 @@
 # Encoding: utf-8
 
-module SeleniumConnect
+class SeleniumConnect
   # Runner
   class Runner
     # PhantomJS browser runner

data/lib/{selenium-connect → selenium_connect}/runners/saucelabs.rb

@@ -2,7 +2,8 @@
 
 require 'sauce'
 
-module SeleniumConnect
+# selenium connect
+class SeleniumConnect
   # Runner
   class Runner
     # Sauce runner

data/lib/{selenium-connect → selenium_connect}/server.rb

@@ -1,6 +1,7 @@
 # Encoding: utf-8
 
-module SeleniumConnect
+# selenium connect
+class SeleniumConnect
   # Creates a server connection
   class Server
     attr_reader :configuration, :current_dir_path

data/selenium-connect.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name          = 'selenium-connect'
-  s.version       = '2.3.0'
+  s.version       = '3.0.0'
   s.platform      = Gem::Platform::RUBY
   s.authors       = ['Dave Haeffner', 'Jason Fox']
   s.email         = ['dave@arrgyle.com', 'jason@arrgyle.com']
   s.homepage      = 'https://github.com/arrgyle/selenium-connect'
   s.summary       = 'A stupid simple way to run your Selenium tests on localhost, against a Selenium Grid, or in the cloud (e.g. SauceLabs).'
-  s.description   = 'Added return data to a finish call to pass back relevent job details'
+  s.description   = 'Major refactoring of the public api which now includes correct updating of sauce lab job status and fetching screenshots on failure'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)
@@ -17,8 +17,13 @@ Gem::Specification.new do |s|
   s.add_dependency 'selenium-webdriver'
   s.add_dependency 'rake'
   s.add_dependency 'sauce', '~> 2.4.4'
+  s.add_dependency 'sauce_whisk', '~> 0.0.8'
+  s.add_dependency 'curb', '~> 0.8.4'
 
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency "rubocop", "~> 0.9.0"
+  s.add_development_dependency 'rspec', '~> 2.14.1'
+  s.add_development_dependency 'mocha', '~> 0.14.0'
+  s.add_development_dependency 'rubocop', '~> 0.9.0'
+  s.add_development_dependency 'guard-rspec', '~> 3.0.2'
+  s.add_development_dependency 'coveralls', '~> 0.6.7'
 
 end

data/spec/integration/lib/selenium_connect/runners/chrome_spec.rb

@@ -0,0 +1,19 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'selenium_connect'
+
+describe 'Chrome', selenium: true do
+
+  it 'localhost' do
+    config = SeleniumConnect::Configuration.new browser: 'chrome'
+    sc = SeleniumConnect.start config
+    job = sc.create_job
+    driver = job.start
+
+    execute_simple_test driver
+
+    job.finish
+    sc.finish
+  end
+end

data/spec/integration/lib/selenium_connect/runners/firefox_spec.rb

@@ -0,0 +1,55 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'selenium_connect'
+
+describe 'Firefox', selenium: true do
+
+  it 'blank config' do
+    @config = SeleniumConnect::Configuration.new
+  end
+
+  it 'localhost' do
+    @config = SeleniumConnect::Configuration.new host: 'localhost'
+  end
+
+  it 'local jar file specified' do
+    opts = {
+      host: 'localhost',
+      jar: "#{Dir.pwd}/bin/selenium-server-standalone-2.33.0.jar"
+    }
+    @config = SeleniumConnect::Configuration.new opts
+  end
+
+  it 'profile name' do
+    pending 'requires machine setup to run, and need a public example'
+    @config = SeleniumConnect::Configuration.new profile_name: 'YourProfileNameGoesHere'
+  end
+
+  it 'profile path' do
+    pending 'need to add a profile to the repo'
+    @config = SeleniumConnect::Configuration.new profile_path: "#{Dir.pwd}/path/to/profile"
+  end
+
+  it 'browser path' do
+    # example only works on Mac
+    opts = {
+      browser: 'firefox',
+      browser_path: '/Applications/Firefox.app/Contents/MacOS/firefox'
+    }
+    @config = SeleniumConnect::Configuration.new opts
+  end
+
+  after(:each) do
+    # execute a simple test with the configuration
+    unless @config.nil?
+      sc = SeleniumConnect.start @config
+      job = sc.create_job
+      driver = job.start
+      execute_simple_test driver
+      job.finish
+      sc.finish
+    end
+  end
+
+end

data/spec/integration/lib/selenium_connect/runners/headless_spec.rb

@@ -0,0 +1,33 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'selenium_connect'
+
+describe 'Headless', selenium: true do
+
+  let(:google)  { Google.new(SeleniumConnect.start) }
+  let(:quit)    { SeleniumConnect.finish }
+
+  before(:each) do
+      config = SeleniumConnect::Configuration.new browser: 'phantomjs'
+      @sc = SeleniumConnect.start config
+      @job = @sc.create_job
+      @driver = @job.start
+  end
+
+  it 'should run a basic test with phantom js' do
+      execute_simple_test @driver
+  end
+
+  it 'should not find something on a page' do
+    google = ExamplePageObject.new @driver
+    google.visit
+    google.page_title.should_not include('Poogle')
+  end
+
+  after(:each) do
+      @job.finish
+      @sc.finish
+  end
+
+end

data/spec/integration/lib/selenium_connect/runners/ie_spec.rb

@@ -0,0 +1,24 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'selenium_connect'
+
+describe 'IE', selenium: true do
+
+  it 'with Selenium Grid' do
+    pending 'not yet implemented'
+    opts = {
+      host: '192.168.1.139',
+      browser: 'ie'
+    }
+    config = SeleniumConnect::Configuration.new opts
+    sc = SeleniumConnect.start config
+    job = sc.create_job
+    driver = job.start
+    execute_simple_test driver
+    job.finish
+    sc.finish
+  end
+
+end
+