chemistrykit 3.3.1 → 3.4.0

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.rspec

@@ -1,2 +1,6 @@
 --color
 --format progress
+--format documentation
+--out build/spec/manual_run.log
+--format html
+--out build/spec/manual_run.html

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
   - 1.9.3
 notifications:
   hipchat: 2a07784c1aeed1b6efa332242d3fc3@Regulation Station
+  email: false

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+#3.4.0 (2013-07-14)
+upgrade to use new selenium connect and integrated sauce lab job failures screenshots and ci reporting
+
+- small patch to the rake file
+- Bumped version to 3.4.0 to prepare for release.
+- updated sc to fix bug
+- updated tests to look for job assets on concurency
+- updated cli to use the new sc with test pass or fail and screenshot grab
+- updated selenium connect to latest version
+- updated rake file for ckit readme update and standard title format on readme
+- updated build process to use standard rspec convention and added coverage and spec reporting
+- turned off travis email notifications
+- added dynamic naming for sauce runs, and a dump of the video url on failure
+
 #3.3.1 (2013-07-11)
 Fixed bugs related to tagging and alternate configuration files in concurrent runs
 

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/unit/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/unit/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,11 +1,6 @@
-[![Gem Version](https://badge.fury.io/rb/chemistrykit.png)](http://badge.fury.io/rb/chemistrykit)
-[![Code Climate](https://codeclimate.com/github/arrgyle/chemistrykit.png)](https://codeclimate.com/github/arrgyle/chemistrykit)
+#ChemistryKit 3.4.0 (2013-07-14)
 
-Master branch: [![Build Status](https://travis-ci.org/arrgyle/chemistrykit.png?branch=master)](https://travis-ci.org/jrobertfox/chef-broiler-platter)
-
-Develop branch: [![Build Status](https://travis-ci.org/arrgyle/chemistrykit.png?branch=develop)](https://travis-ci.org/jrobertfox/chef-broiler-platter)
-
-#ChemistryKit
+[![Gem Version](https://badge.fury.io/rb/chemistrykit.png)](http://badge.fury.io/rb/chemistrykit) [![Build Status](https://travis-ci.org/arrgyle/chemistrykit.png?branch=develop)](https://travis-ci.org/jrobertfox/chef-broiler-platter) [![Code Climate](https://codeclimate.com/github/arrgyle/chemistrykit.png)](https://codeclimate.com/github/arrgyle/chemistrykit) [![Coverage Status](https://coveralls.io/repos/arrgyle/chemistrykit/badge.png?branch=develop)](https://coveralls.io/r/arrgyle/chemistrykit?branch=develop)
 
 ### A simple and opinionated web testing framework for Selenium WebDriver
 
@@ -105,6 +100,8 @@ You can even nest them inside different describe/context blocks and they will ge
 ###Logs and CI Integration
 Each run of Chemistry Kit saves logging and test output to the _evidence_ directory by default. And in there will be the full set of JUnit Ant XML files that may be consumed by your CI.
 
+We also output an attachment message to stdout allowing you to use [this plugin](https://wiki.jenkins-ci.org/display/JENKINS/JUnit+Attachments+Plugin) for integrating the files with jenkins!
+
 ##Configuration
 ChemistryKit is configured by default with a `config.yaml` file that is created for you when you scaffold out a test harness. Relevant configuration options are detailed below:
 

data/Rakefile

@@ -5,26 +5,40 @@ require 'cucumber'
 require 'cucumber/rake/task'
 require 'rspec/core/rake_task'
 
-task default: :build_ci
+task default: :build
 
 desc 'Runs standard build activities.'
-task build: [:clean, :prepare, :rubocop, :spec, :cucumber]
+task build: [:clean, :prepare, :rubocop, :unit, :integration]
 
 desc 'Runs standard build activities for ci server.'
-task build_ci: [:clean, :prepare, :rubocop, :spec]
+task build_full: [:clean, :prepare, :rubocop, :unit, :integration, :system]
 
 desc 'Removes the build directory.'
 task :clean do
   FileUtils.rm_rf('build')
 end
+
 desc 'Adds the build tmp directory for test kit creation.'
 task :prepare do
   FileUtils.mkdir_p('build/tmp')
+  FileUtils.mkdir_p('build/spec')
+end
+
+def get_rspec_flags(log_name, others = nil)
+  "--format documentation --out build/spec/#{log_name}.log --format html --out build/spec/#{log_name}.html --format progress #{others}"
 end
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:unit) do |t|
+  t.pattern = FileList['spec/unit/**/*_spec.rb']
+  t.rspec_opts = get_rspec_flags('unit')
+end
+
+RSpec::Core::RakeTask.new(:integration) do |t|
+  t.pattern = FileList['spec/integration/**/*_spec.rb']
+  t.rspec_opts = get_rspec_flags('integration')
+end
 
-Cucumber::Rake::Task.new(:cucumber)
+Cucumber::Rake::Task.new(:system)
 
 desc 'Runs code quality check'
 task :rubocop do
@@ -48,7 +62,7 @@ task :release_start, :version do |t, args|
   system 'git pull --no-edit origin develop'
 
   # next assure all the tests run
-  task(:build).invoke
+  task(:build_full).invoke
 
   # start the release process
   system "git flow release start #{version}"
@@ -75,6 +89,8 @@ task :release_finish, :update_message do |t, args|
   gemspec   = File.join(Dir.getwd, 'chemistrykit.gemspec')
   changelog = File.join(Dir.getwd, 'CHANGELOG.md')
   version   = File.read(gemspec).match(/s.version\s+=\s?["|'](.+)["|']/)[1]
+  readme = File.join(Dir.getwd, 'README.md')
+  date = Time.new.strftime('%Y-%m-%d')
 
   ### Changelog
   # get the latest tag
@@ -88,7 +104,7 @@ task :release_finish, :update_message do |t, args|
   log = `git log --format="- %s" --no-merges #{hash.chomp}..HEAD`
 
   changelog_contents = File.read(changelog)
-  date = Time.new.strftime('%Y-%m-%d')
+
   # create the new heading
   updated_changelog = "##{version} (#{date})\n" + message + "\n\n" + log + "\n" + changelog_contents
   # update the contents
@@ -102,8 +118,15 @@ task :release_finish, :update_message do |t, args|
   )
   File.open(gemspec, 'w') { |f| f.write(updated_gemspec) }
 
-  # Commit the updated change log and gemspec
-  system "git commit -am 'Updated CHANGELOG.md and gemspec for #{version} release.'"
+  ### Update the readme heading
+  updated = File.read(readme).gsub(
+    /^#ChemistryKit \d+\.\d+.\d+ \(.+\)/,
+    "#ChemistryKit #{version} (#{date})"
+  )
+  File.open(readme, 'w') { |f| f.write(updated) }
+
+  # Commit the updated change log and gemspec and readme
+  system "git commit -am 'Updated CHANGELOG.md gemspec and readme heading for #{version} release.'"
 
   # build the gem
   system 'gem build chemistrykit.gemspec'

data/chemistrykit.gemspec

@@ -1,36 +1,38 @@
 # Encoding: utf-8
 
 Gem::Specification.new do |s|
-  s.name          = "chemistrykit"
-  s.version       = "3.3.1"
+  s.name          = 'chemistrykit'
+  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/chemistrykit"
-  s.summary       = "A simple and opinionated web testing framework for Selenium that follows convention over configuration."
-  s.description   = "Fixed bugs related to tagging and alternate configuration files in concurrent runs"
+  s.authors       = ['Dave Haeffner', 'Jason Fox']
+  s.email         = ['dave@arrgyle.com', 'jason@arrgyle.com']
+  s.homepage      = 'https://github.com/arrgyle/chemistrykit'
+  s.summary       = 'A simple and opinionated web testing framework for Selenium that follows convention over configuration.'
+  s.description   = 'upgrade to use new selenium connect and integrated sauce lab job failures screenshots and ci reporting'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)
   s.files.reject! { |file| file.include? '.jar' }
   s.test_files    = s.files.grep(%r{^(scripts|spec|features)/})
   s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
   s.required_ruby_version = '>=1.9'
 
-  s.add_dependency "thor", "~> 0.17.0"
-  s.add_dependency "rspec", "~> 2.13.0"
-  s.add_dependency "yarjuf", "~> 1.0.5"
-  s.add_dependency "selenium-webdriver", "~> 2.29.0"
-  s.add_dependency "rest-client", "~> 1.6.7"
-  s.add_dependency "selenium-connect", "~> 2.2.0"
-  s.add_dependency "parallel_tests", "~> 0.15.0"
-  s.add_dependency "parallel", "~> 0.7.0"
+  s.add_dependency 'thor', '~> 0.17.0'
+  s.add_dependency 'rspec', '~> 2.14.1'
+  s.add_dependency 'yarjuf', '~> 1.0.5'
+  s.add_dependency 'selenium-webdriver', '~> 2.29.0'
+  s.add_dependency 'rest-client', '~> 1.6.7'
+  s.add_dependency 'selenium-connect', '~> 3.1.1'
+  s.add_dependency 'parallel_tests', '~> 0.15.0'
+  s.add_dependency 'parallel', '~> 0.7.0'
 
-  s.add_development_dependency "rspec", "~> 2.13.0"
-  s.add_development_dependency "aruba", "~> 0.5.1"
-  s.add_development_dependency "cucumber", "~> 1.2.1"
-  s.add_development_dependency "rake", "~> 10.0.3"
-  s.add_development_dependency "rubocop", "~> 0.9.0"
+  s.add_development_dependency 'rspec', '~> 2.14.1'
+  s.add_development_dependency 'aruba', '~> 0.5.1'
+  s.add_development_dependency 'cucumber', '~> 1.2.1'
+  s.add_development_dependency 'rake', '~> 10.0.3'
+  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/features/brew.feature

@@ -43,7 +43,6 @@ Feature: Brewing a ChemistryKit project
       | evidence/results_junit.xml  |
       | evidence/server.log       |
 
-
   Scenario: Saucelabs
     Given a file named "config.yaml" with:
       """
@@ -100,3 +99,31 @@ Feature: Brewing a ChemistryKit project
     When I run `ckit brew --all`
     Then the stdout should contain "2 examples, 0 failures"
 
+  Scenario: Saucelabs
+    Given a file named "config.yaml" with:
+      """
+      selenium_connect:
+          log: 'evidence'
+          host: 'saucelabs'
+          browser: 'iexplore'
+          os: 'windows 2003'
+          sauce_username: 'testing_arrgyle'
+          sauce_api_key: 'ab7a6e17-16df-42d2-9ef6-c8d2539cc38a'
+          browser_version: '8'
+          description: 'ckit feature check'
+      """
+    And a file named "beakers/failure.rb" with:
+    """
+    describe "Failing", :depth => 'shallow' do
+      it "loads an external web page" do
+        @driver.get "http://www.google.com"
+        @driver.title.should_not include("Google")
+      end
+    end
+    """
+    When I run `ckit brew --beakers=beakers/failure.rb`
+    Then the stdout should contain "1 example, 1 failure"
+    And the stdout should contain "[[ATTACHEMENT|/Users/jfox/development/arrgyle/chemistrykit/build/tmp/booker/evidence/"
+    And there should be "1" "failed image" log files in "evidence"
+    And there should be "1" "report" log files in "evidence"
+    And there should be "1" "sauce log" log files in "evidence"

data/features/concurrency.feature

@@ -97,3 +97,5 @@ Feature: Support for concurency
     Then the stdout should not contain "All examples were filtered out"
     And the stdout should not contain "0 examples, 0 failures"
     And there should be "4" unique results files in the "evidence" directory
+    And there should be "5" "report" log files in "evidence"
+    And there should be "5" "sauce log" log files in "evidence"

data/features/step_definitions/steps.rb

@@ -19,3 +19,19 @@ Then(/^there should be "(.*?)" unique results files in the "(.*?)" directory$/)
   end
   count.should == number_files.to_i
 end
+
+Then(/^there should be "(.*?)" "(.*?)" log files in "(.*?)"$/) do |number, type, logs_path|
+  files = Dir.glob(File.join(current_dir, logs_path, '*.*'))
+  count = 0
+  files.each do |file|
+    case type
+    when 'failed image'
+      count += 1 if file =~ /failed_.+\.png/
+    when 'report'
+      count += 1 if file =~ /report_.+\.log/
+    when 'sauce log'
+        count += 1 if file =~ /sauce_job_.+\.log/
+    end
+  end
+  count.should == number.to_i
+end

data/lib/chemistrykit/cli/cli.rb

@@ -9,7 +9,7 @@ require 'chemistrykit/cli/beaker'
 require 'chemistrykit/cli/helpers/formula_loader'
 require 'chemistrykit/catalyst'
 require 'chemistrykit/formula/base'
-require 'selenium-connect'
+require 'selenium_connect'
 require 'chemistrykit/configuration'
 require 'parallel_tests'
 require 'chemistrykit/parallel_tests_mods'
@@ -152,10 +152,8 @@ module ChemistryKit
         end unless selected_tags.nil?
       end
 
+      # rubocop:disable MethodLength
       def rspec_config(config) # Some of these bits work and others don't
-        SeleniumConnect.configure do |c|
-          c.populate_with_hash config.selenium_connect
-        end
         RSpec.configure do |c|
           c.treat_symbols_as_metadata_keys_with_true_values = true
           unless options[:all]
@@ -165,10 +163,34 @@ module ChemistryKit
           c.before(:all) do
             @config = config # set the config available globaly
             ENV['BASE_URL'] = config.base_url # assign base url to env variable for formulas
+            sc_config = SeleniumConnect::Configuration.new
+            sc_config.populate_with_hash config.selenium_connect
+            @sc = SeleniumConnect.start sc_config # fire up a connection to SC
+          end
+          c.around(:each) do |example|
+            @job = @sc.create_job # create a new job
+            @driver = @job.start name: example.metadata[:full_description]
+            example.run
+          end
+          c.after(:each) do
+            if example.exception != nil
+              report = @job.finish failed: true, failshot: true
+            else
+              report = @job.finish passed: true
+            end
+            @sc.finish
+
+            # TODO absctract this out into some report handler class
+            data = report.data
+            unless data.empty?
+              report_file = File.join(Dir.getwd, config.log.path, "report_#{data[:sauce_data][:id]}.log")
+              File.open(report_file, 'w') { |file| file.write(data.to_s) }
+              puts "\n[[ATTACHEMENT|#{report_file}]]\n"
+            end
+            puts "\n[[ATTACHEMENT|#{File.join(Dir.getwd, config.log.path, data[:failshot])}]]\n" if data[:failshot]
+            puts "\n[[ATTACHEMENT|#{File.join(Dir.getwd, config.log.path, data[:server_log])}]]\n" if data[:server_log]
+            ###
           end
-          c.before(:each) { @driver = SeleniumConnect.start }
-          c.after(:each) { @driver.quit }
-          c.after(:all) { SeleniumConnect.finish }
           c.order = 'random'
           c.default_path = 'beakers'
           c.pattern = '**/*_beaker.rb'
@@ -179,6 +201,7 @@ module ChemistryKit
           end
         end
       end
+      # rubocop:enable MethodLength
 
       def run_in_parallel(beakers, concurrency, tags, options)
         unless options[:all]
@@ -192,7 +215,6 @@ module ChemistryKit
       def run_rspec(beakers)
         RSpec::Core::Runner.run(beakers)
       end
-
     end # CkitCLI
   end # CLI
 end # ChemistryKit

data/spec/spec_helper.rb

@@ -6,16 +6,27 @@
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-#
+
+require 'simplecov'
+require 'coveralls'
 require 'rubygems'
 require 'bundler/setup'
 require 'fileutils'
+
 # not sure it this is the right way to include all the files under test.
 require_relative '../lib/chemistrykit/cli/helpers/formula_loader'
 require_relative '../lib/chemistrykit/formula/base'
 require_relative '../lib/chemistrykit/catalyst'
 require_relative '../lib/chemistrykit/configuration'
 
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  coverage_dir 'build/coverage'
+end
+
 TEST_TMP_PATH = File.join(Dir.pwd, 'build', 'tmp')
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chemistrykit
 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-11 00:00:00.000000000 Z
+date: 2013-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -35,7 +35,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.14.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: yarjuf
   requirement: !ruby/object:Gem::Requirement
@@ -99,7 +99,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 3.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -107,7 +107,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
@@ -147,7 +147,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -155,7 +155,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -220,8 +220,40 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
-description: Fixed bugs related to tagging and alternate configuration files in concurrent
-  runs
+- !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: upgrade to use new selenium connect and integrated sauce lab job failures
+  screenshots and ci reporting
 email:
 - dave@arrgyle.com
 - jason@arrgyle.com
@@ -230,6 +262,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
 - .rspec
 - .rubocop.yml
@@ -239,6 +272,7 @@ files:
 - CHANGELOG.md
 - CONTRIBUTORS.md
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -276,12 +310,13 @@ files:
 - lib/templates/chemistrykit/formulas/lib/catalysts/.gitkeep
 - lib/templates/chemistrykit/formulas/lib/formula.rb
 - lib/templates/formula.tt
-- spec/chemistrykit/catalyst_spec.rb
-- spec/chemistrykit/cli/helpers/formula_loader_spec.rb
-- spec/chemistrykit/configuration_spec.rb
-- spec/chemistrykit/formula/base_spec.rb
+- spec/integration/lib/chemistrykit/.gitkeep
 - spec/spec_helper.rb
 - spec/support/config.yaml
+- spec/unit/lib/chemistrykit/catalyst_spec.rb
+- spec/unit/lib/chemistrykit/cli/helpers/formula_loader_spec.rb
+- spec/unit/lib/chemistrykit/configuration_spec.rb
+- spec/unit/lib/chemistrykit/formula/base_spec.rb
 homepage: https://github.com/arrgyle/chemistrykit
 licenses:
 - MIT
@@ -303,7 +338,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2304816470703574176
+      hash: 4250055921726185008
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -324,9 +359,10 @@ test_files:
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - features/tags.feature
-- spec/chemistrykit/catalyst_spec.rb
-- spec/chemistrykit/cli/helpers/formula_loader_spec.rb
-- spec/chemistrykit/configuration_spec.rb
-- spec/chemistrykit/formula/base_spec.rb
+- spec/integration/lib/chemistrykit/.gitkeep
 - spec/spec_helper.rb
 - spec/support/config.yaml
+- spec/unit/lib/chemistrykit/catalyst_spec.rb
+- spec/unit/lib/chemistrykit/cli/helpers/formula_loader_spec.rb
+- spec/unit/lib/chemistrykit/configuration_spec.rb
+- spec/unit/lib/chemistrykit/formula/base_spec.rb