chemistrykit 1.3.0 → 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+#2.0.0 (2013-06-27)
+- Updated to Selenium-Connect version to 2.0.0
+- Improved performance with driver hooks
+- Added the ability to specify config files on brew.
+- Added the "catalyst" concept for injecting data into formulas.
+
 #1.3.0 (2013-06-22)
 - Added explicit recursive file loading process for formulas
 - Cleaned up documentation

data/chemistrykit.gemspec

@@ -1,15 +1,16 @@
 Gem::Specification.new do |s|
   s.name          = "chemistrykit"
-  s.version       = "1.3.0"
+  s.version       = "2.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/chemistrykit"
   s.summary       = "A simple and opinionated web testing framework for Selenium that follows convention over configuration."
-  s.description   = "Updated file loading, documentation and tests."
+  s.description   = "Added catalyst data injection, multiple configuration usage, improved perfomrance."
   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"]
@@ -21,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency "selenium-webdriver", "~> 2.29.0"
   s.add_dependency "ci_reporter", "~> 1.8.3"
   s.add_dependency "rest-client", "~> 1.6.7"
-  s.add_dependency "selenium-connect", "~> 1.9.3"
+  s.add_dependency "selenium-connect", "~> 2.0.0"
 
   s.add_development_dependency "rspec", "~> 2.12.0"
   s.add_development_dependency "aruba", "~> 0.5.1"

data/features/brew.feature

@@ -12,11 +12,7 @@ Feature: Brewing a ChemistryKit project
     And a file named "formulas/bookie.rb" with:
       """
       module Formulas
-        class Bookie
-          def initialize(driver)
-            @driver = driver
-          end
-
+        class Bookie < Formula
           def open(url)
             @driver.get url
           end
@@ -34,13 +30,12 @@ Feature: Brewing a ChemistryKit project
       end
       """
 
-  Scenario Outline: Run All Configurations
-    When I overwrite _config.yaml with:
+  Scenario: Localhost
+    Given a file named "config.yaml" with:
       """
+      jar: '../../../vendor/selenium-server-standalone-2.33.0.jar'
       log: 'evidence'
-      host: '<%= <hostname> %>'
-      sauce_username: 'testing_arrgyle'
-      sauce_api_key:  'ab7a6e17-16df-42d2-9ef6-c8d2539cc38a'
+      host: 'localhost'
       """
     When I run `ckit brew`
     Then the stdout should contain "1 example, 0 failures"
@@ -48,9 +43,18 @@ Feature: Brewing a ChemistryKit project
       | evidence/SPEC-Bookie.xml  |
       | evidence/server.log       |
 
-    Examples:
-    | hostname    |
-    | "localhost" |
-#    | "saucelabs" |
-
 
+  Scenario: Saucelabs
+    Given a file named "config.yaml" with:
+      """
+      log: 'evidence'
+      host: 'saucelabs'
+      brower: 'iexplore'
+      os: 'windows 2003'
+      sauce_username: 'dave_arrgyle'
+      sauce_api_key: '58092e14-4e9c-4911-bfc4-a09ecc02db63'
+      browser_version: '8'
+      description: 'ckit feature check'
+      """
+    When I run `ckit brew`
+    Then the stdout should contain "1 example, 0 failures"

data/features/catalyst.feature

@@ -0,0 +1,88 @@
+Feature: Catalyst
+Catalyst: n. A pocket of data (consumed from a CSV file) used to drive a test that needs it.
+
+  Scenario: Use a catalyst value to drive a test
+    Given I run `ckit new catalyst-example`
+    And I cd to "catalyst-example"
+
+    And a file named "formulas/lib/catalysts/google_test_data.csv" with:
+    """
+    url,http://www.google.com
+    search_query,Flying Elephants
+    """
+
+    And a file named "formulas/google.rb" with:
+      """
+      module Formulas
+        class Google < Formula
+
+          def visit
+            open catalyst.url
+          end
+
+          def search
+            search_box = find id: 'gbqfq'
+            search_box.send_keys catalyst.search_query
+            search_box.send_keys :enter
+          end
+
+          def search_results_found?
+            wait_for(5) { displayed? id: 'search' }
+            search_results = find id: 'search'
+            search_results.text.include?(catalyst.search_query)
+          end
+
+        end
+      end
+      """
+
+    And a file named "formulas/lib/formula.rb" with:
+      """
+      module Formulas
+        class Formula < ChemistryKit::Formula::Base
+
+          def open(url)
+            @driver.get url
+          end
+
+          def find(locator)
+            @driver.find_element locator
+          end
+
+          def displayed?(locator)
+            begin
+              find(locator).displayed?
+            rescue
+              false
+            end
+          end
+
+          def wait_for(seconds=2)
+            Selenium::WebDriver::Wait.new(:timeout => seconds).until { yield }
+          end
+        end
+      end
+      """
+
+    And a file named "beaker/google_beaker.rb" with:
+      """
+      describe "Google", :depth => 'shallow' do
+        let(:google) { Formulas::Google.new(@driver) }
+
+        it "loads an external web page" do
+          google.catalyze('formulas/lib/catalysts/google_test_data.csv')
+          google.visit
+          google.search
+          google.search_results_found?.should eq true
+        end
+      end
+      """
+
+    And a file named "config.yaml" with:
+      """
+      jar: '../../../vendor/selenium-server-standalone-2.33.0.jar'
+      log: 'evidence'
+      host: 'localhost'
+      """
+    When I run `ckit brew`
+    Then the stdout should contain "1 example, 0 failures"

data/features/exit_status.feature

@@ -3,6 +3,12 @@ Feature: Exit Status
   Background:
     Given I run `ckit new cheese`
     And I cd to "cheese"
+    And a file named "config.yaml" with:
+      """
+      jar: '../../../vendor/selenium-server-standalone-2.33.0.jar'
+      log: 'evidence'
+      host: 'localhost'
+      """
 
   Scenario: Passing
     And a file named "beaker/test_beaker.rb" with:

data/features/load_page_objects.feature

@@ -4,6 +4,12 @@ Formulas should be loaded in the correct order with thier dependencies
   Scenario: Load the libs first
     Given I run `ckit new big-project`
     And I cd to "big-project"
+    And a file named "config.yaml" with:
+      """
+      jar: '../../../vendor/selenium-server-standalone-2.33.0.jar'
+      log: 'evidence'
+      host: 'localhost'
+      """
     And a file named "formulas/big.rb" with:
       """
       module Formulas
@@ -20,11 +26,7 @@ Formulas should be loaded in the correct order with thier dependencies
     And a file named "formulas/lib/formula.rb" with:
       """
       module Formulas
-        class Formula
-          def initialize(driver)
-            @driver = driver
-          end
-
+        class Formula < ChemistryKit::Formula::Base
           def helper_open(url)
             @driver.get url
           end

data/features/multi-config.feature

@@ -0,0 +1,55 @@
+Feature: Support for multiple configuration files
+  In order to quickly change between different configurations
+  As a chemistry kit harness developer
+  I want to specify different configuration files on the command line
+
+  Background:
+    Given I run `ckit new config-test`
+    And I cd to "config-test"
+    And a file named "beaker/test_beaker.rb" with:
+    """
+    describe "Cheese", :depth => 'shallow' do
+      it "loads an external web page" do
+        @driver.get "http://www.google.com"
+        @driver.title.should include("Google")
+      end
+    end
+    """
+  Scenario: The default will be conifg.yaml
+    Given a directory named "evidence_config"
+    When I overwrite config.yaml with:
+      """
+      jar: '../../../vendor/selenium-server-standalone-2.33.0.jar'
+      log: 'evidence_config'
+      host: 'localhost'
+      """
+    When I run `ckit brew`
+    Then the stdout should contain "1 example, 0 failures"
+    And the following files should exist:
+      | evidence_config/server.log       |
+
+  Scenario: I can specifiy an alternative configuration with --config
+    Given a directory named "evidence_alternate"
+    And a file named "alternate.yaml" with:
+      """
+      jar: '../../../vendor/selenium-server-standalone-2.33.0.jar'
+      log: 'evidence_alternate'
+      host: 'localhost'
+      """
+      When I run `ckit brew --config alternate.yaml`
+      Then the stdout should contain "1 example, 0 failures"
+      And the following files should exist:
+        | evidence_alternate/server.log       |
+
+  Scenario: I can specifiy an alternative configuration with -c
+    Given a directory named "evidence_alternate"
+    And a file named "alternate.yaml" with:
+      """
+      jar: '../../../vendor/selenium-server-standalone-2.33.0.jar'
+      log: 'evidence_alternate'
+      host: 'localhost'
+      """
+      When I run `ckit brew -c alternate.yaml`
+      Then the stdout should contain "1 example, 0 failures"
+      And the following files should exist:
+        | evidence_alternate/server.log       |

data/features/new.feature

@@ -6,12 +6,14 @@ Feature: ckit new
     When I run `bundle exec ckit new new-project`
     And I cd to "new-project"
 
-  @announce
   Scenario: Test Harness is created
     Then the following directories should exist:
-      | beakers  |
-      | formulas |
-      | evidence |
+      | beakers                 |
+      | formulas                |
+      | formulas/lib            |
+      | formulas/lib/catalysts  |
+      | evidence                |
     And the following files should exist:
-      | _config.yaml  |
-      | .rspec        |
+      | config.yaml             |
+      | .rspec                  |
+      | formulas/lib/formula.rb |

data/features/support/env.rb

@@ -4,3 +4,7 @@ Before do
   @aruba_timeout_seconds = 90
   @dirs = ["build/tmp"]
 end
+
+After do
+  FileUtils.rm_rf("build/tmp")
+end

data/lib/chemistrykit/catalyst.rb

@@ -0,0 +1,32 @@
+require 'csv'
+
+module ChemistryKit
+  class Catalyst
+    #this class serves as a standard container for data that can be injected into a formula
+
+    def initialize(data_file)
+      @data = {}
+      CSV.foreach(data_file) do | row |
+        @data[row[0].to_sym] = row[1]
+      end
+    end
+
+    def method_missing(name)
+      validate_key name
+      @data[name]
+    end
+
+    def get_value_for(key)
+      validate_key key
+      @data[key.to_sym]
+    end
+
+    private
+
+      def validate_key(key)
+        unless @data.has_key?(key.to_sym)
+          raise "Unknown \"#{key}\""
+        end
+      end
+  end
+end

data/lib/chemistrykit/cli/cli.rb

@@ -5,6 +5,8 @@ require 'chemistrykit/cli/new'
 require 'chemistrykit/cli/formula'
 require 'chemistrykit/cli/beaker'
 require 'chemistrykit/cli/helpers/formula_loader'
+require 'chemistrykit/catalyst'
+require 'chemistrykit/formula/base'
 
 module ChemistryKit
   module CLI
@@ -26,7 +28,9 @@ module ChemistryKit
       desc "brew", "Run ChemistryKit"
       method_option :params, :type => :hash
       method_option :tag, :default => ['depth:shallow'], :type => :array
+      method_option :config, :default => 'config.yaml', :aliases => "-c", :desc => "Supply alternative config file."
       def brew
+        load_config
         require 'chemistrykit/shared_context'
         pass_params if options['params']
         turn_stdout_stderr_on_off
@@ -58,6 +62,12 @@ module ChemistryKit
         ENV['CI_CAPTURE'] = 'on'
       end
 
+      def load_config
+        #not wild about using an env variable here... but maybe it makes sense
+        #just not sure how to inject it into the shared context.
+        ENV['CONFIG_FILE'] = options['config']
+      end
+
       def setup_tags
         @tags = {}
         options['tag'].each do |tag|

data/lib/chemistrykit/formula/base.rb

@@ -0,0 +1,21 @@
+module ChemistryKit
+  module Formula
+    class Base
+
+      attr_accessor :catalyst
+
+      def initialize(driver)
+        @driver = driver
+      end
+
+      def catalyze(path_to_file)
+        self.catalyst = ChemistryKit::Catalyst.new(path_to_file)
+      end
+
+      def catalyst
+        @catalyst
+      end
+
+    end #Base
+  end #Formula
+end #ChemistryKit

data/lib/chemistrykit/shared_context.rb

@@ -6,7 +6,7 @@ module ChemistryKit
     extend RSpec::Core::SharedContext
 
       SeleniumConnect.configure do |c|
-        c.config_file = File.join(Dir.getwd, '_config.yaml')
+        c.config_file = File.join(Dir.getwd, ENV['CONFIG_FILE'])
       end
 
       before(:each) do
@@ -14,6 +14,10 @@ module ChemistryKit
       end
 
       after(:each) do
+        @driver.quit
+      end
+
+      after(:all) do
         SeleniumConnect.finish
       end
 

data/lib/templates/chemistrykit/formulas/lib/formula.rb

@@ -0,0 +1,4 @@
+class Formula < ChemistryKit::Formula::Base
+  #this is where you can define generic helper functions that are inhereted by
+  #the rest of your formulas
+end

data/lib/templates/formula.tt

@@ -1,9 +1,7 @@
 module Formulas
-  class <%= name.capitalize %>
+  class <%= name.capitalize %> < Formula
+
 
-    def initialize(driver)
-      @driver = driver
-    end
 
   end
 end

data/spec/chemistrykit/catalyst_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe ChemistryKit::Catalyst do
+
+  before(:each) do
+
+    Dir.mkdir(File.join(TEST_TMP_PATH, 'catalyst'))
+    @data_file = File.join(TEST_TMP_PATH, 'catalyst', 'catalyst_data.csv')
+    File.open(@data_file, 'w') {|f| f.write("first_key,first_value\nsecond_key,second_value") }
+    @catalyst = ChemistryKit::Catalyst.new(@data_file)
+  end
+
+  it 'Should take a csv file on initialization.' do
+    @catalyst.should be_an_instance_of ChemistryKit::Catalyst
+  end
+
+  it 'Should respond to a named key.' do
+    @catalyst.first_key.should be == 'first_value'
+    @catalyst.second_key.should be == 'second_value'
+  end
+
+  it 'Should respond to a convienence method.' do
+    @catalyst.get_value_for('second_key').should be == 'second_value'
+    @catalyst.get_value_for('first_key').should be == 'first_value'
+  end
+
+  it 'Should throw an exception for a non existant key.' do
+    expect {
+      @catalyst.get_value_for('third_key')
+    }.to raise_error("Unknown \"third_key\"")
+
+    expect {
+      @catalyst.third_key
+    }.to raise_error("Unknown \"third_key\"")
+
+  end
+
+  after(:each) do
+    FileUtils.rm_rf(File.join(TEST_TMP_PATH, 'catalyst'))
+  end
+
+end

data/spec/chemistrykit/formula/base_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ChemistryKit::Formula::Base do
+
+  before(:each) do
+    #ideally we should mock the driver and not pass in nil
+    driver = nil
+    @formula_base = ChemistryKit::Formula::Base.new(driver)
+
+    Dir.mkdir(File.join(TEST_TMP_PATH, 'catalyst'))
+    @data_file = File.join(TEST_TMP_PATH, 'catalyst', 'catalyst_data.csv')
+    File.open(@data_file, 'w') {|f| f.write("first_key,first_value\nsecond_key,second_value") }
+    @catalyst = ChemistryKit::Catalyst.new(@data_file)
+  end
+
+  it 'Should allow a catalyst to be set.' do
+    @formula_base.catalyst = @catalyst
+    @formula_base.catalyst.should be_an_instance_of ChemistryKit::Catalyst
+  end
+
+  it 'Should allow the use of catalyze as a convenience method.' do
+    @formula_base.catalyze(@data_file)
+    @formula_base.catalyst.should be_an_instance_of ChemistryKit::Catalyst
+  end
+
+  after(:each) do
+    FileUtils.rm_rf(File.join(TEST_TMP_PATH, 'catalyst'))
+  end
+
+end

data/spec/spec_helper.rb

@@ -10,6 +10,8 @@ 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'
 
 TEST_TMP_PATH = File.join(Dir.pwd, 'build', 'tmp')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chemistrykit
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-22 00:00:00.000000000 Z
+date: 2013-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -99,7 +99,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.9.3
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -107,7 +107,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.9.3
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -172,7 +172,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 10.0.3
-description: Updated file loading, documentation and tests.
+description: Added catalyst data injection, multiple configuration usage, improved
+  perfomrance.
 email:
 - dave@arrgyle.com
 - jason@arrgyle.com
@@ -196,27 +197,35 @@ files:
 - chemistrykit.gemspec
 - ext/mkrf_conf.rb
 - features/brew.feature
+- features/catalyst.feature
 - features/exit_status.feature
 - features/load_page_objects.feature
+- features/multi-config.feature
 - features/new.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - lib/chemistrykit.rb
+- lib/chemistrykit/catalyst.rb
 - lib/chemistrykit/cli/beaker.rb
 - lib/chemistrykit/cli/cli.rb
 - lib/chemistrykit/cli/formula.rb
 - lib/chemistrykit/cli/helpers/formula_loader.rb
 - lib/chemistrykit/cli/new.rb
+- lib/chemistrykit/formula/base.rb
 - lib/chemistrykit/shared_context.rb
 - lib/templates/beaker.tt
 - lib/templates/beaker_with_formula.tt
 - lib/templates/chemistrykit/.rspec
-- lib/templates/chemistrykit/_config.yaml.tt
 - lib/templates/chemistrykit/beakers/.gitkeep
+- lib/templates/chemistrykit/config.yaml.tt
 - lib/templates/chemistrykit/evidence/.gitkeep
 - lib/templates/chemistrykit/formulas/.gitkeep
+- 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/formula/base_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/arrgyle/chemistrykit
 licenses:
@@ -246,10 +255,14 @@ summary: A simple and opinionated web testing framework for Selenium that follow
   convention over configuration.
 test_files:
 - features/brew.feature
+- features/catalyst.feature
 - features/exit_status.feature
 - features/load_page_objects.feature
+- features/multi-config.feature
 - features/new.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
+- spec/chemistrykit/catalyst_spec.rb
 - spec/chemistrykit/cli/helpers/formula_loader_spec.rb
+- spec/chemistrykit/formula/base_spec.rb
 - spec/spec_helper.rb