selenium-connect 3.3.1 → 3.4.0

data/.rubocop.yml

@@ -3,3 +3,9 @@ LineLength:
 
 MethodLength:
   Max: 30
+
+SymbolName:
+  AllowCamelCase: false
+
+Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+#3.4.0 (2013-08-03)
+Added more code quality tools and capture enhanced chrome logs
+
+- Bumped version to 3.4.0 to prepare for release.
+- fixed error with chrome processor
+- added reek and a rake task and fixed on of the smell issues, leaving it only as warnings for now but we should fix the smells at some point
+- added flog and updated rubocop version, fixed all quality issues, updated rake tasks for flog and rubocop
+- moved development dependencies to gemfile to support git based repo for latest rubocop
+- added a test for the chrome log files and also updated it to pull the libpeer log
+- updated readme
+- added animoto to the readme
+- updated job finishing to move chrome log to evidence folder
+- added advanced logs to the evidence directory
+
 #3.3.1 (2013-07-24)
 Fixed bug with the job naming
 

data/Gemfile

@@ -1,3 +1,13 @@
 source "https://rubygems.org"
 
 gemspec
+
+# Using the master version to incorporate latest cops and bug fixes
+gem 'rubocop', git: 'https://github.com/bbatsov/rubocop.git', branch: 'master'
+gem 'rspec', '~> 2.14.1'
+gem 'guard-rspec', '~> 3.0.2'
+gem 'coveralls', '~> 0.6.7'
+gem 'flog'
+gem 'flay'
+gem 'ruby2ruby'
+gem 'reek', '1.3.1'

data/README.md

@@ -1,8 +1,8 @@
-#selenium-connect 3.3.1 (2013-07-24)
+#selenium-connect 3.4.0 (2013-08-03)
 
 [![Gem Version](https://badge.fury.io/rb/selenium-connect.png)](http://badge.fury.io/rb/selenium-connect) [![Build Status](https://travis-ci.org/arrgyle/selenium-connect.png?branch=develop)](https://travis-ci.org/arrgyle/selenium-connect) [![Code Climate](https://codeclimate.com/github/arrgyle/selenium-connect.png)](https://codeclimate.com/github/arrgyle/selenium-connect) [![Coverage Status](https://coveralls.io/repos/arrgyle/selenium-connect/badge.png?branch=develop)](https://coveralls.io/r/arrgyle/selenium-connect?branch=develop)
 
-A stupid simple way to run your Selenium tests on your computer, against a Selenium Grid, or in the cloud (e.g. SauceLabs). For a rocking implementation of this library, checkout [ChemistryKit](https://github.com/arrgyle/chemistrykit)!
+A stupid simple way to run your Selenium tests on your computer, against a Selenium Grid, or in the cloud (e.g. SauceLabs). For a rocking implementation of this library, checkout [ChemistryKit](https://github.com/arrgyle/chemistrykit)! For more usage examples check out our [Friends](#friends) section!
 
 All the documentation for Selenium Connect can be found in this README, organized as follows:
 
@@ -11,6 +11,7 @@ All the documentation for Selenium Connect can be found in this README, organize
 - [Configuration](#configuration)
 - [Contribution Guidelines](#contribution-guidelines)
 - [Deployment](#deployment)
+- [Friends](#friends)
 
 ## Getting Started
 ```ruby
@@ -170,3 +171,11 @@ And another to finish the release:
     rake release_finish['A helpful tag message that will be included in the gemspec.']
 
 This handles updating the change log, committing, and tagging the release.
+
+## Friends
+
+Below you can find some honorable mentions of those friends that are using Selenium Connect:
+
+![image](http://d14f1fnryngsxt.cloudfront.net/images/logo/animotologotext_f78c60cbbd36837c7aad596e3b3bb019.svg)
+
+We are proud that [Animoto](http://animoto.com/) uses Selenium Connect to help them test their awesome web app.

data/Rakefile

@@ -1,13 +1,20 @@
 # Encoding: utf-8
 
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'flog_task'
+require 'flay_task'
+require 'reek/rake/task'
 
 task default: :build
 
-task build: [:clean, :prepare, :rubocop, :unit, :integration]
+task build: [:clean, :prepare, :quality, :unit, :integration]
 
 desc 'Runs standard build activities.'
-task build_full: [:clean, :prepare, :rubocop, :unit, :integration, :system]
+task build_full: [:clean, :prepare, :quality, :unit, :integration, :system]
+
+desc 'Runs quality checks.'
+task quality: [:rubocop, :reek, :flog_total, :flog_average, :flay]
 
 desc 'Removes the build directory.'
 task :clean do
@@ -40,12 +47,33 @@ RSpec::Core::RakeTask.new(:system) do |t|
   t.rspec_opts = get_rspec_flags('system', '--tag selenium')
 end
 
-desc 'Runs code quality check'
-task :rubocop do
-  sh 'rubocop'
+Rubocop::RakeTask.new
+
+# TODO: lower the quality score and improve the code!
+FlogTask.new :flog_total, 1250 do |t|
+  t.method = :total_score
+  t.verbose = true
+end
+
+# TODO: lower the quality score and improve the code!
+FlogTask.new :flog_average, 10 do |t|
+  t.method = :average
+  t.verbose = true
+end
+
+# TODO: lower the quality score and improve the code!
+FlayTask.new :flay, 200 do |t|
+  t.verbose = true
+end
+
+# TODO: fix all the smells and turn on failing on error
+Reek::Rake::Task.new do |t|
+    t.fail_on_error = false
+    t.verbose = false
+    t.reek_opts = '--quiet'
 end
 
-# TODO This could probably be more cleanly automated
+# TODO: This could probably be more cleanly automated
 desc 'Start a release (Requires Git Flow)'
 task :release_start, :version do |t, args|
   version = args['version']

data/lib/sauce/sauce_facade.rb

@@ -41,13 +41,13 @@ module Sauce
 
     def fetch_job_data
       requires_job_id
-      # TODO let's switch this over to use whisk as well
+      # TODO: let's switch this over to use whisk as well
       # This is used because it's easy to get all the data out of the job
       begin
         job = Sauce::Job.find @job_id
         JSON.parse job.to_json
-      rescue StandardError => e
-        puts "An error occured while fetching the job data: #{e.message}"
+      rescue StandardError => exception
+        puts "An error occured while fetching the job data: #{exception.message}"
       end
     end
 
@@ -58,16 +58,14 @@ module Sauce
       end
 
       def polling_api_request(timeout)
-        begin
-          sleep 1
-          yield
-        rescue RestClient::Exception => e
+        sleep 1
+        yield
+        rescue RestClient::Exception => exception
           if timeout > 0
             polling_api_request(timeout - 1) { yield }
           else
-            puts "Request timed out after #{timeout} with: #{e.message}"
+            puts "Request timed out after #{timeout} with: #{exception.message}"
           end
-        end
       end
   end
 end

data/lib/selenium_connect.rb

@@ -39,7 +39,7 @@ class SeleniumConnect
 
     def server_start
       if @config.host == 'localhost'
-        # TODO this is just temp,
+        # TODO: this is just temp,
         # in the next iteration we will inject this in by default in start
         # to a required argument in initialize
         @server = Server.new(config)

data/lib/selenium_connect/configuration.rb

@@ -29,7 +29,7 @@ class SeleniumConnect
       populate_with_hash opts unless opts.empty?
     end
 
-    # TODO eventually roll all sauce options under this node
+    # TODO: eventually roll all sauce options under this node
     # and deprecate setting them at the top level
     def sauce_opts=(opts = {})
       opts.each do |key, value|
@@ -40,7 +40,7 @@ class SeleniumConnect
     def populate_with_hash(hash)
       hash.each do |key, value|
         begin
-          self.send "#{key}=", value unless value.nil?
+          send "#{key}=", value unless value.nil?
         rescue NoMethodError
           raise ArgumentError.new "The config key: \"#{key}\" is unknown!"
         end

data/lib/selenium_connect/job.rb

@@ -20,7 +20,7 @@ class SeleniumConnect
     # Creates and returns the driver, using options passed in
     def start(opts = {})
       @job_name = slugify_name opts[:name] if opts.has_key? :name
-      # TODO this could be refactored out into an options parser of sorts
+      # TODO: this could be refactored out into an options parser of sorts
       @config.sauce_opts.job_name = @job_name ||= 'unnamed_job'
       @driver = Runner.new(@config).driver
     end
@@ -33,6 +33,7 @@ class SeleniumConnect
         @driver.quit
         @data = { assets: {} }
         process_sauce_logs(opts) if @config.host == 'saucelabs'
+        process_chrome_logs(opts) if @config.browser == 'chrome'
       # rubocop:disable HandleExceptions
       rescue Selenium::WebDriver::Error::WebDriverError
       # rubocop:enable HandleExceptions
@@ -42,6 +43,19 @@ class SeleniumConnect
 
     private
 
+      # if a log path is configured move the logs, otherwise delete them
+      def process_chrome_logs(opts = {})
+        ['chromedriver.log', 'libpeerconnection.log'].each do |log_file|
+          path = File.join(Dir.getwd, log_file)
+
+          if @config.log
+            FileUtils.mv(path, File.join(Dir.getwd, @config.log)) if File.exist? path
+          else
+            FileUtils.rm path if File.exist? path
+          end
+        end
+      end
+
       def process_sauce_logs(opts = {})
         job_id = @driver.session_id
         @sauce_facade.job_id = job_id
@@ -81,7 +95,7 @@ class SeleniumConnect
         name.downcase.strip.gsub(' ', '_').gsub(/[^\w-]/, '')
       end
 
-      # TODO this should be pulled out into a generic report... or something
+      # 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

data/lib/selenium_connect/runners/chrome.rb

@@ -22,7 +22,13 @@ class SeleniumConnect
       private
 
       def init_browser
-        config.browser.to_sym
+        caps = Selenium::WebDriver::Remote::Capabilities.chrome
+
+        if config.log
+          log_path = File.join(Dir.getwd, config.log, 'chrome')
+          caps['chrome.switches'] = ["--user-data-dir=#{log_path}", '--enable-logging', '--v=1', "--log-net-log=#{log_path}/net_log.log", '--net-log-level=0']
+        end
+        caps
       end
 
     end # Chrome

data/lib/selenium_connect/runners/firefox.rb

@@ -38,7 +38,7 @@ class SeleniumConnect
         browser = Selenium::WebDriver::Remote::Capabilities.firefox
         browser[:firefox_binary] = config.browser_path if config.browser_path
         browser[:firefox_profile] = profile
-        return browser
+        browser
       end
 
       def init_browser

data/lib/selenium_connect/runners/phantomjs.rb

@@ -30,7 +30,7 @@ class SeleniumConnect
         executable_path = get_executable_path
         browser = Selenium::WebDriver::Remote::Capabilities.phantomjs
         browser['phantomjs.binary.path'] = executable_path
-        return browser
+        browser
       end
 
       def init_browser

data/lib/selenium_connect/server.rb

@@ -58,7 +58,7 @@ class SeleniumConnect
       rake_file = File.open(rake_file_path, 'w')
       rake_file << generate_rake_task
       rake_file.close
-      return rake_file_path
+      rake_file_path
     end
 
     def rake(task)

data/selenium-connect.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name          = 'selenium-connect'
-  s.version       = '3.3.1'
+  s.version       = '3.4.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   = 'Fixed bug with the job naming'
+  s.description   = 'Added more code quality tools and capture enhanced chrome logs'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)
@@ -18,10 +18,4 @@ Gem::Specification.new do |s|
   s.add_dependency 'rake'
   s.add_dependency 'sauce', '~> 2.4.4'
   s.add_dependency 'sauce_whisk', '~> 0.0.8'
-
-  s.add_development_dependency 'rspec', '~> 2.14.1'
-  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

@@ -16,4 +16,20 @@ describe 'Chrome', selenium: true do
     job.finish
     sc.finish
   end
+
+  it 'should work correctly with a configuration file' do
+    config = SeleniumConnect::Configuration.new
+    config.populate_with_yaml "#{ENV['SUPPORT_PATH']}/chrome.yaml"
+    sc = SeleniumConnect.start config
+    job = sc.create_job
+    driver = job.start
+
+    execute_simple_test driver
+
+    job.finish
+    sc.finish
+
+    File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'chromedriver.log')).should be_true
+    File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'libpeerconnection.log')).should be_true
+  end
 end

data/spec/support/chrome.yaml

@@ -0,0 +1,26 @@
+# Setup & Debugging
+jar:
+log: /build/tmp
+
+
+# Where to run your tests
+host: 'localhost'
+port:
+
+
+# Browser
+browser:      'chrome'
+browser_path:
+profile_path:
+profile_name:
+
+
+# Saucelabs
+sauce_username: 'test_user_name'
+sauce_api_key:
+api_timeout: 10
+
+os:
+browser_version:
+description:
+

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

@@ -30,7 +30,7 @@ describe SeleniumConnect::Configuration do
   end
 
   it 'supports the config_file= method' do
-    @configuration.config_file= "#{ENV['SUPPORT_PATH']}/example.yaml"
+    @configuration.config_file = "#{ENV['SUPPORT_PATH']}/example.yaml"
     @configuration.sauce_username.should eq VALID_SAUCE_USERNAME
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-connect
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-24 00:00:00.000000000 Z
+date: 2013-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -76,71 +76,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.8
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-- !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: Fixed bug with the job naming
+description: Added more code quality tools and capture enhanced chrome logs
 email:
 - dave@arrgyle.com
 - jason@arrgyle.com
@@ -188,6 +124,7 @@ files:
 - spec/integration/lib/selenium_connect/runners/sauce_spec.rb
 - spec/integration/lib/selenium_connect_spec.rb
 - spec/spec_helper.rb
+- spec/support/chrome.yaml
 - spec/support/example.yaml
 - spec/support/example_page_object.rb
 - spec/support/integration_helper.rb
@@ -221,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2232335152555328092
+      hash: 2633789005975885710
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25