chemistrykit 2.1.0 → 3.0.0

data/features/global-config.feature

@@ -0,0 +1,26 @@
+Feature: Initialize a global configuration
+  In order to configure chemistrykit
+  As a chemistry kit harness developer
+  I want to specify configurations in a central file so they are available in test scripts
+
+  Scenario: Use a configuration option in a beaker
+    Given I run `ckit new global-config-test`
+    And I cd to "global-config-test"
+    And a file named "beakers/test_beaker.rb" with:
+    """
+    describe "Cheese", :depth => 'shallow' do
+      it "loads an external web page" do
+        @driver.get @config.base_url
+        @driver.title.should include("Google")
+      end
+    end
+    """
+    And I overwrite config.yaml with:
+    """
+    base_url: http://www.google.com
+    selenium_connect:
+        log: 'evidence'
+        host: 'localhost'
+    """
+    When I run `ckit brew`
+    Then the stdout should contain "1 example, 0 failures"

data/features/load_page_objects.feature

@@ -6,9 +6,9 @@ Formulas should be loaded in the correct order with thier dependencies
     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'
+      selenium_connect:
+          log: 'evidence'
+          host: 'localhost'
       """
     And a file named "formulas/big.rb" with:
       """
@@ -34,7 +34,7 @@ Formulas should be loaded in the correct order with thier dependencies
       end
       """
 
-    And a file named "beaker/big_beaker.rb" with:
+    And a file named "beakers/big_beaker.rb" with:
       """
       describe "Big", :depth => 'shallow' do
         let(:book) { Formulas::BigProject.new(@driver) }

data/features/multi-config.feature

@@ -6,7 +6,7 @@ Feature: Support for multiple configuration files
   Background:
     Given I run `ckit new config-test`
     And I cd to "config-test"
-    And a file named "beaker/test_beaker.rb" with:
+    And a file named "beakers/test_beaker.rb" with:
     """
     describe "Cheese", :depth => 'shallow' do
       it "loads an external web page" do
@@ -19,9 +19,9 @@ Feature: Support for multiple configuration files
     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'
+      selenium_connect:
+          log: 'evidence_config'
+          host: 'localhost'
       """
     When I run `ckit brew`
     Then the stdout should contain "1 example, 0 failures"
@@ -32,9 +32,9 @@ Feature: Support for multiple configuration files
     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'
+      selenium_connect:
+          log: 'evidence_alternate'
+          host: 'localhost'
       """
       When I run `ckit brew --config alternate.yaml`
       Then the stdout should contain "1 example, 0 failures"
@@ -45,9 +45,9 @@ Feature: Support for multiple configuration files
     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'
+      selenium_connect:
+          log: 'evidence_alternate'
+          host: 'localhost'
       """
       When I run `ckit brew -c alternate.yaml`
       Then the stdout should contain "1 example, 0 failures"

data/features/step_definitions/steps.rb

@@ -1,10 +1,12 @@
-When /^I overwrite ([^"]*) with:$/ do |file_name, file_content|
-  #Modified from https://github.com/cucumber/aruba/blob/master/lib/aruba/cucumber.rb
+# Encoding: utf-8
+
+When /^I overwrite ([^"]*) with:$/ do | file_name, file_content |
+  # Modified from https://github.com/cucumber/aruba/blob/master/lib/aruba/cucumber.rb
   require 'erb'
   data = ERB.new(file_content)
   overwrite_file(file_name, data.result)
 end
 
 Then(/^the exit code should be (\d+)$/) do |exit_status|
-  $?.exitstatus.should == exit_status.to_i
+  @last_exit_status.should == exit_status.to_i
 end

data/features/support/env.rb

@@ -1,7 +1,9 @@
+# Encoding: utf-8
+
 require 'aruba/cucumber'
 
 Before do
-  FileUtils.rm_rf("build/tmp")
+  FileUtils.rm_rf('build/tmp')
   @aruba_timeout_seconds = 90
-  @dirs = ["build/tmp"]
+  @dirs = ['build/tmp']
 end

data/lib/chemistrykit.rb

@@ -1 +1,3 @@
+# Encoding: utf-8
+
 require 'chemistrykit/cli/cli'

data/lib/chemistrykit/catalyst.rb

@@ -1,8 +1,11 @@
+# Encoding: utf-8
+
 require 'csv'
 
 module ChemistryKit
+  # Serves as a hash wrapper class for injecting data into formulas
   class Catalyst
-    #this class serves as a standard container for data that can be injected into a formula
+    # this class serves as a standard container for data that can be injected into a formula
 
     def initialize(data_file)
       @data = {}
@@ -24,9 +27,7 @@ module ChemistryKit
     private
 
       def validate_key(key)
-        unless @data.has_key?(key.to_sym)
-          raise "Unknown \"#{key}\""
-        end
+        raise "Unknown \"#{key}\"" unless @data.has_key?(key.to_sym)
       end
   end
 end

data/lib/chemistrykit/cli/beaker.rb

@@ -1,7 +1,10 @@
+# Encoding: utf-8
+
 require 'thor/group'
 
 module ChemistryKit
   module CLI
+    # Creates a starting beaker from a template
     class BeakerGenerator < Thor::Group
       include Thor::Actions
       argument :name

data/lib/chemistrykit/cli/cli.rb

@@ -1,3 +1,5 @@
+# Encoding: utf-8
+
 require 'thor'
 require 'rspec'
 require 'ci/reporter/rake/rspec_loader'
@@ -7,45 +9,55 @@ require 'chemistrykit/cli/beaker'
 require 'chemistrykit/cli/helpers/formula_loader'
 require 'chemistrykit/catalyst'
 require 'chemistrykit/formula/base'
+require 'selenium-connect'
+require 'chemistrykit/configuration'
 
 module ChemistryKit
   module CLI
 
+    # Registers the formula and beaker commands
     class Generate < Thor
       register(ChemistryKit::CLI::FormulaGenerator, 'formula', 'formula [NAME]', 'generates a page object')
       register(ChemistryKit::CLI::BeakerGenerator, 'beaker', 'beaker [NAME]', 'generates a beaker')
     end
 
+    # Main Chemistry Kit CLI Class
     class CKitCLI < Thor
 
       register(ChemistryKit::CLI::New, 'new', 'new [NAME]', 'Creates a new ChemistryKit project')
       check_unknown_options!
       default_task :help
 
-      desc "generate SUBCOMMAND", "generate <formula> or <beaker> [NAME]"
-      subcommand "generate", Generate
+      desc 'generate SUBCOMMAND', 'generate <formula> or <beaker> [NAME]'
+      subcommand 'generate', Generate
 
-      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."
-      #TODO there should be a facility to simply pass a path to this command
-      method_option :beaker, :type => :string
+      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.'
+      # TODO there should be a facility to simply pass a path to this command
+      method_option :beakers, type: :array
+      # This is set if the thread is being run in parallel so as not to trigger recursive concurency
+      method_option :parallel, default: false
 
       def brew
-        load_config
-        require 'chemistrykit/shared_context'
+        config = load_config options['config']
+        # TODO perhaps the params should be rolled into the available
+        # config object injected into the system?
         pass_params if options['params']
         turn_stdout_stderr_on_off
         set_logs_dir
         load_page_objects
         setup_tags
-        rspec_config
-
-        if options['beaker']
-          run_rspec([options['beaker']])
+        # configure rspec
+        rspec_config(config)
+        # get those beakers that should be executed
+        beakers = options['beakers'] ? options['beakers'] : Dir.glob(File.join(Dir.getwd, 'beakers/*'))
+        # based on concurrency parameter run tests
+        if config.concurrency > 1 && ! options['parallel']
+          run_in_parallel beakers, config.concurrency
         else
-          run_rspec(Dir.glob(File.join(Dir.getwd)))
+          run_rspec beakers
         end
       end
 
@@ -59,7 +71,7 @@ module ChemistryKit
 
       def load_page_objects
         loader = ChemistryKit::CLI::Helpers::FormulaLoader.new
-        loader.get_formulas(File.join(Dir.getwd, 'formulas')).each {|file| require file }
+        loader.get_formulas(File.join(Dir.getwd, 'formulas')).each { |file| require file }
       end
 
       def set_logs_dir
@@ -70,10 +82,9 @@ 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']
+      def load_config(file_name)
+        config_file = File.join(Dir.getwd, file_name)
+        ChemistryKit::Configuration.initialize_with_yaml config_file
       end
 
       def setup_tags
@@ -91,25 +102,40 @@ module ChemistryKit
         end
       end
 
-      def rspec_config #Some of these bits work and others don't
+      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
           c.filter_run @tags[:filter] unless @tags[:filter].nil?
           c.filter_run_excluding @tags[:exclusion_filter] unless @tags[:exclusion_filter].nil?
-          c.include ChemistryKit::SharedContext
+          c.before(:each) do
+            @driver = SeleniumConnect.start
+            @config = config
+          end
+          c.after(:each) do
+            @driver.quit
+          end
+          c.after(:all) do
+            SeleniumConnect.finish
+          end
           c.order = 'random'
           c.default_path = 'beakers'
           c.pattern = '**/*_beaker.rb'
         end
       end
 
-      def run_rspec(beakers)
-
-        #puts single_beaker.inspect
+      def run_in_parallel(beakers, concurrency)
+        require 'parallel_tests'
+        require 'chemistrykit/parallel_tests_mods'
+        ParallelTests::CLI.new.run(%w(--type rspec) + ['-n', concurrency.to_s] + %w(-o --beakers=) + beakers)
+      end
 
+      def run_rspec(beakers)
         RSpec::Core::Runner.run(beakers)
       end
 
-    end
-  end
-end
+    end # CkitCLI
+  end # CLI
+end # ChemistryKit

data/lib/chemistrykit/cli/formula.rb

@@ -1,7 +1,10 @@
+# Encoding: utf-8
+
 require 'thor/group'
 
 module ChemistryKit
   module CLI
+    # Creates a starting formula from a template
     class FormulaGenerator < Thor::Group
       include Thor::Actions
 
@@ -12,8 +15,8 @@ module ChemistryKit
       end
 
       def copy_file
-        template "formula.tt", "./formulas/#{name}.rb"
-        template "beaker_with_formula.tt", "./beakers/#{name}_beaker.rb"
+        template 'formula.tt', "./formulas/#{name}.rb"
+        template 'beaker_with_formula.tt', "./beakers/#{name}_beaker.rb"
       end
 
     end

data/lib/chemistrykit/cli/helpers/formula_loader.rb

@@ -1,16 +1,18 @@
+# Encoding: utf-8
+
 module ChemistryKit
   module CLI
     module Helpers
+      # this loader returns the formulas found in a path according to these rules:
+      # - directories loaded in alpha order
+      # - children directories loaded before parents
+      # - files loaded in alpha order
+      # - lib directories are loaded before any other
+      # - rules stack
       class FormulaLoader
-        #this loader returns the formulas found in a path according to these rules:
-        #- directories loaded in alpha order
-        #- children directories loaded before parents
-        #- files loaded in alpha order
-        #- lib directories are loaded before any other
-        #- rules stack
 
         def initialize
-          @formulas = Array.new
+          @formulas = []
         end
 
         def get_formulas(path)
@@ -19,25 +21,36 @@ module ChemistryKit
         end
 
         private
+
           def gather(path)
-            #get all the directories for path
-            directories = Dir.entries(path).select {|entry| File.directory? File.join(path,entry) and !(entry =='.' || entry == '..') }
+            # get all the directories for path
+            directories = get_directories path
             if directories.empty?
-              #if there are no directories is empty just get all the files and add it to the instance variable
-              @formulas.concat Dir.glob(File.join(path, "*.rb")).sort
+              # if there are no directories is empty just get all the files and add it to the instance variable
+              @formulas.concat Dir.glob(File.join(path, '*.rb')).sort
             else
-              #otherwise for each of them recurse into it
+              # otherwise for each of them recurse into it
               directories.sort!
-              if directories.include? 'lib'
-                #if there is a lib directory, put that at the front
-                directories.delete('lib')
-                directories.unshift('lib')
-              end
+              move_lib_to_top_of_stack directories
               directories.each do |directory|
                 gather(File.join(path, directory))
               end
-              #and then after add the files in the original parent
-              @formulas.concat Dir.glob(File.join(path, "*.rb")).sort
+              # and then after add the files in the original parent
+              @formulas.concat Dir.glob(File.join(path, '*.rb')).sort
+            end
+          end
+
+          def get_directories(path)
+            Dir.entries(path).select do |entry|
+              (File.directory? File.join(path, entry)) && !(entry == '.' || entry == '..')
+            end
+          end
+
+          def move_lib_to_top_of_stack(directories)
+            if directories.include? 'lib'
+              # if there is a lib directory, put that at the front
+              directories.delete('lib')
+              directories.unshift('lib')
             end
           end
       end

data/lib/chemistrykit/cli/new.rb

@@ -1,7 +1,10 @@
+# Encoding: utf-8
+
 require 'thor/group'
 
 module ChemistryKit
   module CLI
+    # Creates a new test harness
     class New < Thor::Group
       include Thor::Actions
 
@@ -12,11 +15,11 @@ module ChemistryKit
       end
 
       def create_project
-        directory "templates/chemistrykit", File.join(Dir.getwd, name)
+        directory 'templates/chemistrykit', File.join(Dir.getwd, name)
       end
 
       def notify
-        say "Your test harness has been created."
+        say 'Your test harness has been created.'
       end
 
     end

data/lib/chemistrykit/configuration.rb

@@ -0,0 +1,54 @@
+# Encoding: utf-8
+
+require 'yaml'
+
+module ChemistryKit
+  # Default configuration class
+  class Configuration
+
+    attr_accessor :concurrency,
+                  :base_url,
+                  :selenium_connect
+
+    def initialize(hash)
+      # set defaults
+      @concurrency = 1
+
+      # overide with argument
+      populate_with_hash hash
+      validate_config
+    end
+
+    def self.initialize_with_yaml(file)
+      self.new symbolize_keys YAML.load_file file
+    end
+
+    private
+
+      def populate_with_hash(hash)
+        hash.each do |key, value|
+          begin
+            self.send "#{key}=", value unless value.nil?
+          rescue NoMethodError
+            raise ArgumentError.new "The config key: \"#{key}\" is unknown!"
+          end
+        end
+      end
+
+      def validate_config
+        if @selenium_connect && @selenium_connect[:host] != 'saucelabs' && @concurrency > 1
+          raise ArgumentError.new 'Concurrency is only supported for the host: "saucelabs"!'
+        end
+      end
+
+      # private static to symbolize recursivly a loaded yaml
+      def self.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