selenium-connect 2.3.0 → 3.0.0

data/spec/{runners → integration/lib/selenium_connect/runners}/phantomjs_spec.rb

@@ -1,10 +1,11 @@
 # Encoding: utf-8
 
-require 'selenium-connect/configuration'
-require 'selenium-connect/runners/phantomjs'
+require 'spec_helper'
+require 'selenium_connect/configuration'
+require 'selenium_connect/runners/phantomjs'
 require 'selenium-webdriver'
 
-describe 'phantomjs runner', selenium: true do
+describe 'phantomjs runner' do
   it 'should match against phantomjs if configured as such' do
     config = SeleniumConnect::Configuration.new
     config.browser = 'phantomjs'

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

@@ -0,0 +1,63 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'selenium_connect'
+
+describe 'Sauce Labs', selenium: true do
+
+  before(:each) do
+    opts = {
+      log: File.join('build', 'tmp'),
+      host: 'saucelabs',
+      sauce_username: 'testing_arrgyle',
+      sauce_api_key: 'ab7a6e17-16df-42d2-9ef6-c8d2539cc38a',
+      os: 'windows',
+      browser: 'iexplore',
+      browser_version: '7',
+    }
+    config = SeleniumConnect::Configuration.new opts
+    @sc = SeleniumConnect.start config
+  end
+
+  it 'just execute a sauce job successfully' do
+    job = @sc.create_job
+    name = 'successful sauce job'
+    driver = job.start name: name
+    execute_simple_test driver
+    report = job.finish passed: true
+    sauce_id = report.data[:sauce_data][:id]
+    report.data[:sauce_data][:name].should be == name
+    report.data[:sauce_data][:passed].should be_true
+    File.exist?(File.join(Dir.pwd, 'build', 'tmp', "sauce_job_#{sauce_id}.log")).should be_true
+  end
+
+  it 'should mark a sauce job as failed' do
+    job = @sc.create_job
+    name = 'failing sauce job'
+    job.start name: name
+    # we don't even need to run anything
+    report = job.finish failed: true
+    report.data[:sauce_data][:passed].should be false
+  end
+
+  it 'should download save a screenshot on failure' do
+    # pending 'need to resolve the api issues first'
+    job = @sc.create_job
+    name = 'failshot'
+    driver = job.start name: name
+
+    driver.get 'http://www.yahoo.com'
+    driver.get 'http://www.google.com'
+
+    unless driver.title =~ /Poogle/
+      # simulate a failure situation
+      report = job.finish failed: true, failshot: true
+    end
+
+    report.data[:sauce_data][:passed].should be false
+  end
+
+  after(:each) do
+    @sc.finish
+  end
+end

data/spec/integration/lib/selenium_connect_spec.rb

@@ -0,0 +1,41 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'selenium_connect'
+
+describe SeleniumConnect, selenium: true do
+
+  it 'should run a simple job by default' do
+    config = SeleniumConnect::Configuration.new
+    sc = SeleniumConnect.start config
+    job = sc.create_job
+    driver = job.start
+
+    execute_simple_test driver
+
+    driver.get 'http://www.google.com'
+    driver.title.should include('Google')
+
+    job.finish
+    sc.finish
+  end
+
+  it 'should return log files to a location' do
+    log_path = File.join('build', 'tmp')
+    config = SeleniumConnect::Configuration.new log: log_path
+    sc = SeleniumConnect.start config
+    job = sc.create_job
+    driver = job.start
+
+    execute_simple_test driver
+
+    job.finish
+    sc.finish
+
+    server_log = File.read(File.join(ENV['BUILD_PATH'], 'tmp', 'server.log'))
+    server_log.empty?.should be false
+
+    browser_log = File.read(File.join(ENV['BUILD_PATH'], 'tmp', 'firefox.log'))
+    browser_log.empty?.should be false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+# Encoding: utf-8
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'simplecov'
+require 'coveralls'
+
+require 'support/integration_helper'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  coverage_dir 'build/coverage'
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.before(:all) do
+    setup_test_environment
+  end
+  config.order = 'random'
+end
+
+def setup_test_environment
+  ENV['SUPPORT_PATH'] = File.join(Dir.pwd, 'spec', 'support')
+  ENV['BUILD_PATH'] = File.join(Dir.pwd, 'build')
+end
+

data/spec/{acceptance/helper.rb → support/example_page_object.rb}

@@ -1,6 +1,6 @@
 # Encoding: utf-8
 
-class Google
+class ExamplePageObject
   attr_accessor :page
 
   def initialize(driver)

data/spec/support/integration_helper.rb

@@ -0,0 +1,9 @@
+# Encoding: utf-8
+
+require_relative 'example_page_object'
+
+def execute_simple_test(driver)
+  google = ExamplePageObject.new driver
+  google.visit
+  google.page_title.should include('Google')
+end

data/spec/unit/lib/selenium-connect_spec.rb

@@ -0,0 +1,15 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'selenium-connect'
+
+describe SeleniumConnect do
+  it 'should allow the old require statement' do
+    config = double 'SeleniumConnect::Configuration'
+    allow(config).to receive(:is_a?).and_return(true)
+    allow(config).to receive(:host).and_return(false)
+    report_factory = double 'SeleniumConnect::Report::ReportFactory'
+    selenium_connect = SeleniumConnect.new config, report_factory
+    selenium_connect.should be_an_instance_of SeleniumConnect
+  end
+end

data/spec/{configuration_spec.rb → unit/lib/selenium_connect/configuration_spec.rb}

@@ -1,6 +1,7 @@
 # Encoding: utf-8
 
-require 'selenium-connect/configuration'
+require 'spec_helper'
+require 'selenium_connect/configuration'
 
 describe SeleniumConnect::Configuration do
 
@@ -12,6 +13,11 @@ describe SeleniumConnect::Configuration do
     @configuration = SeleniumConnect::Configuration.new
   end
 
+  it 'can recieve a simple hash of options on initialization' do
+    config = SeleniumConnect::Configuration.new host: 'newhost'
+    config.host.should == 'newhost'
+  end
+
   it 'can be populated by a hash' do
     @configuration.populate_with_hash jar: VALID_JAR, host: VALID_HOST
     @configuration.jar.should eq VALID_JAR
@@ -19,12 +25,12 @@ describe SeleniumConnect::Configuration do
   end
 
   it 'can be populated with a yaml file' do
-    @configuration.populate_with_yaml "#{Dir.pwd}/spec/example.yaml"
+    @configuration.populate_with_yaml "#{ENV['SUPPORT_PATH']}/example.yaml"
     @configuration.sauce_username.should eq VALID_SAUCE_USERNAME
   end
 
   it 'supports the config_file= method' do
-    @configuration.config_file= "#{Dir.pwd}/spec/example.yaml"
+    @configuration.config_file= "#{ENV['SUPPORT_PATH']}/example.yaml"
     @configuration.sauce_username.should eq VALID_SAUCE_USERNAME
   end
 

data/spec/unit/lib/selenium_connect/job_spec.rb

@@ -0,0 +1,38 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'selenium_connect/job'
+
+describe SeleniumConnect::Job do
+
+  before(:each) do
+    config = double 'SeleniumConnect::Configuration'
+    report_factory = double 'SeleniumConnect::Report::ReportFactory'
+    @report = double 'SeleniumConnect::Report::JobReport'
+    allow(report_factory).to receive(:build).and_return(@report)
+    @job = SeleniumConnect::Job.new config, report_factory
+  end
+
+  it 'should be initialized' do
+    @job.should be_an_instance_of SeleniumConnect::Job
+  end
+
+  it 'should respond to start' do
+    @job.should respond_to :start
+  end
+
+  it 'should return the driver on start' do
+    pending('need to pass in something to build the driver here...')
+    @job.start
+  end
+
+  it 'should respond to finish' do
+    @job.should respond_to :finish
+  end
+
+  it 'should return a report on finish' do
+    pending('need to pass in something to build the driver here...')
+    @job.finish.should be @report
+  end
+end
+

data/spec/unit/lib/selenium_connect/report/job_report_spec.rb

@@ -0,0 +1,20 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'selenium_connect/report/job_report'
+
+describe SeleniumConnect::Report::JobReport do
+
+  before(:each) do
+    @data = { key: 'value' }
+    @report = SeleniumConnect::Report::JobReport.new @data
+  end
+
+  it 'should be initialized with data' do
+    @report.should be_an_instance_of SeleniumConnect::Report::JobReport
+  end
+
+  it 'should simply return the data for now' do
+    @report.data.should be @data
+  end
+end

data/spec/unit/lib/selenium_connect/report/main_report_spec.rb

@@ -0,0 +1,20 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'selenium_connect/report/main_report'
+
+describe SeleniumConnect::Report::MainReport do
+
+  before(:each) do
+    @data = { key: 'value' }
+    @report = SeleniumConnect::Report::MainReport.new @data
+  end
+
+  it 'should be initialized with data' do
+    @report.should be_an_instance_of SeleniumConnect::Report::MainReport
+  end
+
+  it 'should simply return the data for now' do
+    @report.data.should be @data
+  end
+end

data/spec/unit/lib/selenium_connect/report/report_factory_spec.rb

@@ -0,0 +1,27 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'selenium_connect/report/report_factory'
+
+describe SeleniumConnect::Report::ReportFactory do
+
+  before(:each) do
+    @report_factory = SeleniumConnect::Report::ReportFactory.new
+  end
+
+  it 'should return an empty main report' do
+    report = @report_factory.build :main, {}
+    report.should_not be_nil
+  end
+
+  it 'should return an empty job report' do
+    report = @report_factory.build :job, {}
+    report.should_not be_nil
+  end
+
+  it 'should throw an esception for unknown report type' do
+    expect do
+      @report_factory.build :not_real, {}
+    end.to raise_error ArgumentError, 'Report type "not_real" unknown!'
+  end
+end

data/spec/unit/lib/selenium_connect_spec.rb

@@ -0,0 +1,58 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'selenium_connect'
+
+describe SeleniumConnect do
+
+  before(:each) do
+    @config = double 'SeleniumConnect::Configuration'
+    allow(@config).to receive(:is_a?).and_return(true)
+    allow(@config).to receive(:host).and_return(false)
+
+    report_factory = double 'SeleniumConnect::Report::ReportFactory'
+    @report = double 'SeleniumConnect::Report::MainReport'
+
+    allow(report_factory).to receive(:build).and_return(@report)
+
+    @selenium_connect = SeleniumConnect.new @config, report_factory
+
+  end
+
+  it 'should be created with the start method' do
+    SeleniumConnect.should respond_to :start
+    SeleniumConnect.start(@config).should be_an_instance_of SeleniumConnect
+  end
+
+  it 'can be initialized' do
+    @selenium_connect.should be_an_instance_of SeleniumConnect
+  end
+
+  it 'should fail for non config object' do
+    ['foo', nil, 10, { bar: 'baz' }].each do |config|
+      expect do
+        SeleniumConnect.new config, nil
+      end.to raise_error ArgumentError, 'Instance of SeleniumConnect::Configuration expected.'
+    end
+  end
+
+  it 'can return the config' do
+    sc = SeleniumConnect.start @config
+    sc.config.should be @config
+  end
+
+  it 'should respond to finish' do
+    sc = SeleniumConnect.start @config
+    sc.should respond_to :finish
+  end
+
+  it 'should return an main report on finish' do
+    @selenium_connect.finish.should be @report
+  end
+
+  it 'should respond to create_job' do
+    opts = { name: 'test-job' }
+    @selenium_connect.create_job opts
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-connect
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -60,22 +60,70 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.4.4
+- !ruby/object:Gem::Dependency
+  name: sauce_whisk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -92,7 +140,40 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
-description: Added return data to a finish call to pass back relevent job details
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+description: Major refactoring of the public api which now includes correct updating
+  of sauce lab job status and fetching screenshots on failure
 email:
 - dave@arrgyle.com
 - jason@arrgyle.com
@@ -100,41 +181,56 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
+- .rspec
 - .rubocop.yml
 - .ruby-gemset
 - .ruby-version
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
 - bin/chromedriver
 - bin/phantomjs
 - bin/selenium-server-standalone-2.33.0.jar
 - lib/selenium-connect.rb
-- lib/selenium-connect/configuration.rb
-- lib/selenium-connect/runner.rb
-- lib/selenium-connect/runners/chrome.rb
-- lib/selenium-connect/runners/firefox.rb
-- lib/selenium-connect/runners/ie.rb
-- lib/selenium-connect/runners/no_browser.rb
-- lib/selenium-connect/runners/phantomjs.rb
-- lib/selenium-connect/runners/saucelabs.rb
-- lib/selenium-connect/server.rb
+- lib/selenium_connect.rb
+- lib/selenium_connect/configuration.rb
+- lib/selenium_connect/job.rb
+- lib/selenium_connect/report/job_report.rb
+- lib/selenium_connect/report/main_report.rb
+- lib/selenium_connect/report/report_factory.rb
+- lib/selenium_connect/runner.rb
+- lib/selenium_connect/runners/chrome.rb
+- lib/selenium_connect/runners/firefox.rb
+- lib/selenium_connect/runners/ie.rb
+- lib/selenium_connect/runners/no_browser.rb
+- lib/selenium_connect/runners/phantomjs.rb
+- lib/selenium_connect/runners/saucelabs.rb
+- lib/selenium_connect/server.rb
 - selenium-connect.gemspec
-- spec/acceptance/chrome_spec.rb
-- spec/acceptance/firefox_spec.rb
-- spec/acceptance/headless_spec.rb
-- spec/acceptance/helper.rb
-- spec/acceptance/ie_spec.rb
-- spec/acceptance/logging_spec.rb
-- spec/acceptance/sauce_spec.rb
-- spec/configuration_spec.rb
-- spec/example.yaml
-- spec/quit_and_finish_spec.rb
-- spec/runners/phantomjs_spec.rb
-- spec/yaml_spec.rb
+- spec/integration/lib/selenium_connect/runners/chrome_spec.rb
+- spec/integration/lib/selenium_connect/runners/firefox_spec.rb
+- spec/integration/lib/selenium_connect/runners/headless_spec.rb
+- spec/integration/lib/selenium_connect/runners/ie_spec.rb
+- spec/integration/lib/selenium_connect/runners/phantomjs_spec.rb
+- spec/integration/lib/selenium_connect/runners/sauce_spec.rb
+- spec/integration/lib/selenium_connect_spec.rb
+- spec/spec_helper.rb
+- spec/support/example.yaml
+- spec/support/example_page_object.rb
+- spec/support/integration_helper.rb
+- spec/unit/lib/selenium-connect_spec.rb
+- spec/unit/lib/selenium_connect/configuration_spec.rb
+- spec/unit/lib/selenium_connect/job_spec.rb
+- spec/unit/lib/selenium_connect/report/job_report_spec.rb
+- spec/unit/lib/selenium_connect/report/main_report_spec.rb
+- spec/unit/lib/selenium_connect/report/report_factory_spec.rb
+- spec/unit/lib/selenium_connect/runners/.gitkeep
+- spec/unit/lib/selenium_connect_spec.rb
 homepage: https://github.com/arrgyle/selenium-connect
 licenses:
 - MIT
@@ -156,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 592273692965868662
+      hash: -448221364801641841
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25