chemistrykit 3.7.0 → 3.8.0

data/lib/chemistrykit/cli/cli.rb

@@ -9,6 +9,8 @@ require 'chemistrykit/cli/beaker'
 require 'chemistrykit/cli/helpers/formula_loader'
 require 'chemistrykit/catalyst'
 require 'chemistrykit/formula/base'
+require 'chemistrykit/formula/formula_lab'
+require 'chemistrykit/chemist/repository/csv_chemist_repository'
 require 'selenium_connect'
 require 'chemistrykit/configuration'
 require 'parallel_tests'
@@ -60,7 +62,7 @@ module ChemistryKit
       method_option :params, type: :hash
       method_option :tag, 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
+      # TODO: there should be a facility to simply pass a path to this command
       method_option :beakers, aliases: '-b', 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
@@ -70,7 +72,7 @@ module ChemistryKit
 
       def brew
         config = load_config options['config']
-        # TODO perhaps the params should be rolled into the available
+        # TODO: perhaps the params should be rolled into the available
         # config object injected into the system?
         pass_params if options['params']
 
@@ -116,13 +118,9 @@ module ChemistryKit
       protected
 
       def override_configs(options, config)
-        # TODO expand this to allow for more overrides as needed
-        if options['results_file']
-          config.log.results_file = options['results_file']
-        end
-        if options['retry']
-          config.retries_on_failure = options['retry'].to_i
-        end
+        # TODO: expand this to allow for more overrides as needed
+        config.log.results_file = options['results_file'] if options['results_file']
+        config.retries_on_failure = options['retry'].to_i if options['retry']
         config
       end
 
@@ -188,6 +186,13 @@ module ChemistryKit
             @sc = SeleniumConnect.start configuration
             @job = @sc.create_job # create a new job
             @driver = @job.start name: test_name
+
+            # TODO: this is messy, and could be refactored out into a static on the lab
+            chemist_data_paths = Dir.glob(File.join(Dir.getwd, 'chemists', '*.csv'))
+            repo = ChemistryKit::Chemist::Repository::CsvChemistRepository.new chemist_data_paths
+            # make the formula lab available
+            @formula_lab = ChemistryKit::Formula::FormulaLab.new @driver, repo, File.join(Dir.getwd, 'formulas')
+
             example.run
           end
           c.after(:each) do

data/lib/chemistrykit/configuration.rb

@@ -48,7 +48,7 @@ module ChemistryKit
     end
 
     def self.initialize_with_yaml(file)
-      self.new symbolize_keys YAML.load_file file
+      new symbolize_keys YAML.load_file file
     end
 
     private
@@ -56,7 +56,7 @@ module ChemistryKit
       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/chemistrykit/formula/chemist_aware.rb

@@ -0,0 +1,10 @@
+# Encoding: utf-8
+
+module ChemistryKit
+  module Formula
+    # Mixin to provide formulas with methods related to having a chemist (user)
+    module ChemistAware
+      attr_accessor :chemist
+    end
+  end
+end

data/lib/chemistrykit/formula/formula_lab.rb

@@ -0,0 +1,99 @@
+# Encoding: utf-8
+
+require 'find'
+
+module ChemistryKit
+  module Formula
+    # Factory class to assemble page objects with users
+    class FormulaLab
+
+      attr_reader :formula
+
+      def initialize(driver, chemist_repository, formulas_dir)
+        @driver = driver
+        @chemist_repository = chemist_repository
+        raise ArgumentError, "Formula directory \"#{formulas_dir}\" does not exist!" unless File.directory?(formulas_dir)
+        @formulas_dir = formulas_dir
+      end
+
+      def using(formula_key)
+        @formula = formula_key
+        self
+      end
+
+      def mix(formula_key = nil)
+        @formula = formula_key ||= formula
+        raise ArgumentError, 'A formula key must be defined!' unless @formula
+        formula_file = find_formula_file
+        class_name = get_class_name formula_file
+        formula = constantize(class_name).new(@driver)
+        if formula.singleton_class.include?(ChemistryKit::Formula::ChemistAware)
+          raise RuntimeError, "Trying to mix a formula: \"#{formula_key}\" that requires a user, but no user set!" unless @chemist
+          formula.chemist = @chemist
+        end
+        formula
+      end
+
+      def with(key)
+        @chemist = @chemist_repository.load_chemist_by_key key
+        self
+      end
+
+      def with_random(type)
+        @chemist = @chemist_repository.load_random_chemist_of_type type
+        self
+      end
+
+      def with_first(type)
+        @chemist = @chemist_repository.load_first_chemist_of_type type
+        self
+      end
+
+      private
+
+        def find_formula_file
+          Find.find(@formulas_dir) do |path|
+            return path if path =~ /.*#{@formula}\.rb$/
+          end
+        end
+
+        # TODO: try to resolve this backreff thing
+        # rubocop:disable AvoidPerlBackrefs
+        def get_class_name(formula_file)
+          string = formula_file.match(/(#{@formulas_dir.split('/').last}.*#{@formula})\.rb$/)[1]
+          string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+          string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
+        end
+        # rubocop:enable AvoidPerlBackrefs
+
+        # "borrowed" from http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-constantize
+        # TODO: this could be simplified, refactored out, or just use the activestate module some how
+        def constantize(camel_cased_word)
+          names = camel_cased_word.split('::')
+          names.shift if names.empty? || names.first.empty?
+
+          names.reduce(Object) do |constant, name|
+            if constant == Object
+              constant.const_get(name)
+            else
+              candidate = constant.const_get(name)
+              next candidate if constant.const_defined?(name, false)
+              next candidate unless Object.const_defined?(name)
+
+              # Go down the ancestors to check it it's owned
+              # directly before we reach Object or the end of ancestors.
+              constant = constant.ancestors.reduce do |const, ancestor|
+                break const    if ancestor == Object
+                break ancestor if ancestor.const_defined?(name, false)
+                const
+              end
+
+              # owner is in Object, so raise
+              constant.const_get(name, false)
+            end
+          end
+        end
+
+    end
+  end
+end

data/lib/chemistrykit/parallel_tests_mods.rb

@@ -46,7 +46,7 @@ module ParallelTests
         end
 
         def runtime_log
-          # TODO This needs to do something.
+          # TODO: This needs to do something.
           File.join(Dir.getwd, 'evidence', 'parallel_runtime_rspec.log')
         end
 

data/lib/templates/chemistrykit/chemists/chemists.csv

@@ -0,0 +1 @@
+key,type

data/lib/templates/formula.tt

@@ -1,6 +1,8 @@
 module Formulas
   class <%= name.capitalize %> < Formula
 
+  # Uncomment out the below to provide a chemist for your formula
+  # include ChemistryKit::Formula::ChemistAware
 
 
   end

data/spec/integration/lib/chemistrykit/formula/formula_lab_spec.rb

@@ -0,0 +1,59 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'chemistrykit/formula/formula_lab'
+require 'chemistrykit/chemist/repository/csv_chemist_repository'
+
+describe ChemistryKit::Formula::FormulaLab do
+
+  VALID_CHEMIST_KEY = 'admin1'
+  VALID_CHEMIST_TYPE = 'admin'
+
+  VALID_BASIC_FORMULA_KEY = 'basic_formula'
+  VALID_CHEMIST_FORMULA_KEY = 'chemist_formula'
+
+  before(:each) do
+    @stub_driver = double 'Selenium::WebDriver::Driver'
+    chemists_path = File.join(Dir.pwd, 'spec', 'support', 'chemists.csv')
+    @repo = ChemistryKit::Chemist::Repository::CsvChemistRepository.new chemists_path
+    formulas_dir = File.join(Dir.pwd, 'spec', 'support', 'formulas')
+    @lab = ChemistryKit::Formula::FormulaLab.new @stub_driver, @repo, formulas_dir
+  end
+
+  it 'should mix a formula without a chemist' do
+    formula = @lab.mix(VALID_BASIC_FORMULA_KEY)
+    formula.should be_an_instance_of Formulas::SubModule::BasicFormula
+  end
+
+  it 'should mix a formula with a chemist the standard way' do
+    formula = @lab.using(VALID_CHEMIST_FORMULA_KEY).with(VALID_CHEMIST_KEY).mix
+    formula.should be_an_instance_of Formulas::SubModule::ChemistFormula
+    formula.chemist.key.should eq VALID_CHEMIST_KEY
+  end
+
+  it 'should raise an error if trying to mix a formula that requires a user, without setting one' do
+    expect do
+      @lab.using(VALID_CHEMIST_FORMULA_KEY).mix
+    end.to raise_error RuntimeError, "Trying to mix a formula: \"#{VALID_CHEMIST_FORMULA_KEY}\" that requires a user, but no user set!"
+  end
+
+  it 'should mix a formula in the oposite way' do
+    formula = @lab.with(VALID_CHEMIST_KEY).mix(VALID_CHEMIST_FORMULA_KEY)
+    formula.should be_an_instance_of Formulas::SubModule::ChemistFormula
+    formula.chemist.key.should eq VALID_CHEMIST_KEY
+  end
+
+  it 'should mix a formula with a typed chemist' do
+    formula = @lab.with_first(VALID_CHEMIST_TYPE).mix(VALID_CHEMIST_FORMULA_KEY)
+    formula.should be_an_instance_of Formulas::SubModule::ChemistFormula
+    formula.chemist.key.should eq VALID_CHEMIST_KEY
+  end
+
+  it 'should mix a formula with a random chemist of a type' do
+    formula = @lab.with_random('random').mix(VALID_CHEMIST_FORMULA_KEY)
+    formula.should be_an_instance_of Formulas::SubModule::ChemistFormula
+    key = formula.chemist.key
+    (key == 'ran1' || key == 'ran2').should be_true
+  end
+
+end

data/spec/spec_helper.rb

@@ -19,6 +19,9 @@ require_relative '../lib/chemistrykit/formula/base'
 require_relative '../lib/chemistrykit/catalyst'
 require_relative '../lib/chemistrykit/configuration'
 
+require_relative '../spec/support/formulas/sub_module/basic_formula'
+require_relative '../spec/support/formulas/sub_module/chemist_formula'
+
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter

data/spec/support/bad_chemists.csv

@@ -0,0 +1,3 @@
+Key,Email,Name,Password
+admin1,admin@email.com,Mr. Admin,abc123$
+normal1,normal@email.com,Ms. Normal,test123%

data/spec/support/chemists.csv

@@ -0,0 +1,6 @@
+Key,Type,Email,Name,Password
+admin1,admin,admin@email.com,Mr. Admin,abc123$
+normal1,normal,normal@email.com,Ms. Normal,test123%
+ran1,random,normal@email.com,Ms. Normal,test123%
+ran2,random,normal@email.com,Ms. Normal,test123%
+uuid_chemist,normal,normal{{UUID}}@email.com,Mr. uuid,test123#

data/spec/support/default_chemists.csv

@@ -0,0 +1 @@
+key,type

data/spec/support/formulas/sub_module/basic_formula.rb

@@ -0,0 +1,13 @@
+# Encoding: utf-8
+
+require 'chemistrykit/formula/base'
+
+module Formulas
+  module SubModule
+    class BasicFormula < ChemistryKit::Formula::Base
+      def open(url)
+        @driver.get url
+      end
+    end
+  end
+end

data/spec/support/formulas/sub_module/chemist_formula.rb

@@ -0,0 +1,15 @@
+# Encoding: utf-8
+
+require 'chemistrykit/formula/base'
+require 'chemistrykit/formula/chemist_aware'
+
+module Formulas
+  module SubModule
+    class ChemistFormula < ChemistryKit::Formula::Base
+      include ChemistryKit::Formula::ChemistAware
+      def open(url)
+        @driver.get url
+      end
+    end
+  end
+end

data/spec/support/keyless_chemists.csv

@@ -0,0 +1,3 @@
+Type,Email,Name,Password
+admin,admin@email.com,Mr. Admin,abc123$
+normal,normal@email.com,Ms. Normal,test123%

data/spec/support/other_chemists.csv

@@ -0,0 +1,2 @@
+Key,Type,Name,Passion
+cowboy1,cowboy,Billy the Kid,Wrasslin

data/spec/unit/lib/chemistrykit/chemist/repository/csv_chemist_repository_spec.rb

@@ -0,0 +1,99 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'chemistrykit/chemist/repository/csv_chemist_repository'
+
+describe ChemistryKit::Chemist::Repository::CsvChemistRepository do
+
+  VALID_CHEMIST_CSV = 'chemists.csv'
+  VALID_DEFAULT_CSV = 'default_chemists.csv'
+  BAD_CHEMIST_CSV = 'bad_chemists.csv'
+  KEYLESS_CHEMIST_CSV = 'keyless_chemists.csv'
+  INVALID_CHEMIST_CSV = 'file_does_not_exist.csv'
+  VALID_USER_TYPE = 'admin'
+  VALID_USER_KEY = 'admin1'
+  INVALID_USER_TYPE = 'no_type'
+
+  before(:each) do
+    csv_file = File.join(Dir.pwd, 'spec', 'support', VALID_CHEMIST_CSV)
+    @repo = ChemistryKit::Chemist::Repository::CsvChemistRepository.new(csv_file)
+  end
+
+  it 'should be instantiated with a csv file path' do
+    @repo.should be_an_instance_of ChemistryKit::Chemist::Repository::CsvChemistRepository
+  end
+
+  it 'should raise and error if the file does not exist' do
+    expect do
+      csv_file = File.join(Dir.pwd, 'spec', 'support', INVALID_CHEMIST_CSV)
+      ChemistryKit::Chemist::Repository::CsvChemistRepository.new(csv_file)
+    end.to raise_error ArgumentError, 'Supplied file does not exist!'
+  end
+
+  it 'should load a random by type identifier' do
+    chemist = @repo.load_first_chemist_of_type VALID_USER_TYPE
+    chemist.type.should eq VALID_USER_TYPE
+  end
+
+  it 'should load a random by specific key' do
+    chemist = @repo.load_chemist_by_key VALID_USER_KEY
+    chemist.key.should eq VALID_USER_KEY
+  end
+
+  it 'should load a random chemist by type' do
+    chemist = @repo.load_random_chemist_of_type 'random'
+    (chemist.key == 'ran1' || chemist.key == 'ran2').should be_true
+  end
+
+  it 'should set all the parameters defined in the csv file' do
+    chemist = @repo.load_first_chemist_of_type VALID_USER_TYPE
+    chemist.name.should eq 'Mr. Admin'
+    chemist.email.should eq 'admin@email.com'
+    chemist.password.should eq 'abc123$'
+  end
+
+  it 'should rais and error if the chemist is not found' do
+    expect do
+      @repo.load_first_chemist_of_type INVALID_USER_TYPE
+    end.to raise_error ArgumentError, 'Chemist for type "no_type" not found!'
+  end
+
+  it 'should raise and error if there is no type heading in the csv file' do
+    csv_file = File.join(Dir.pwd, 'spec', 'support', BAD_CHEMIST_CSV)
+    expect do
+      ChemistryKit::Chemist::Repository::CsvChemistRepository.new(csv_file)
+    end.to raise_error ArgumentError, 'You must define a type field!'
+  end
+
+  it 'should raise and error if there is no key heading in the csv file' do
+    csv_file = File.join(Dir.pwd, 'spec', 'support', KEYLESS_CHEMIST_CSV)
+    expect do
+      ChemistryKit::Chemist::Repository::CsvChemistRepository.new(csv_file)
+    end.to raise_error ArgumentError, 'You must define a key field!'
+  end
+
+  it 'can search more than one csv file' do
+    files = []
+    files.push File.join(Dir.pwd, 'spec', 'support', VALID_CHEMIST_CSV)
+    files.push File.join(Dir.pwd, 'spec', 'support', 'other_chemists.csv')
+    repo = ChemistryKit::Chemist::Repository::CsvChemistRepository.new(files)
+
+    chemist = repo.load_first_chemist_of_type 'cowboy'
+    chemist.passion.should eq 'Wrasslin'
+
+    chemist = repo.load_first_chemist_of_type 'normal'
+    chemist.email = 'normal@email.com'
+  end
+
+  it 'should replace the {{UUID}} token with a uuid on runtime if found in a parameter' do
+    chemist = @repo.load_chemist_by_key 'uuid_chemist'
+    # the {{UUID}} token was placed in the email parameter
+    expect(chemist.email).to match(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/)
+  end
+
+  it 'should not raise any error if there were no modifications to the default chemists file' do
+    csv_file = File.join(Dir.pwd, 'spec', 'support', VALID_DEFAULT_CSV)
+    repo = ChemistryKit::Chemist::Repository::CsvChemistRepository.new(csv_file)
+    repo.should be_an_instance_of ChemistryKit::Chemist::Repository::CsvChemistRepository
+  end
+end

data/spec/unit/lib/chemistrykit/chemist_spec.rb

@@ -0,0 +1,43 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'chemistrykit/chemist'
+
+describe ChemistryKit::Chemist do
+
+  VALID_KEY = 'specific_admin'
+  VALID_TYPE = 'admin'
+  VALID_VALUE = 'my value'
+
+  before(:each) do
+    @chemist = ChemistryKit::Chemist.new(VALID_KEY, VALID_TYPE)
+  end
+
+  it 'must have at least a key and type' do
+    @chemist.key.should eq VALID_KEY
+    @chemist.type.should eq VALID_TYPE
+  end
+
+  it 'should be able to set and get arbitrary data' do
+    @chemist.my_key = VALID_VALUE
+    @chemist.my_key.should eq VALID_VALUE
+  end
+
+  it 'should be able to get a hash of its data' do
+    @chemist.my_key = VALID_VALUE
+    @chemist.data.should eq my_key: VALID_VALUE
+  end
+
+  it 'should not be able to override the other instance variables' do
+    @chemist.type = 'other'
+    @chemist.type.should eq VALID_TYPE
+    @chemist.data.include?(:type).should be_false
+  end
+
+  it 'should be able to be populated with a hash of arbitrary data' do
+    dataset = { name: 'cool dude', email: 'fun@gmail.com', password: 'Oa8w*#)asd' }
+    @chemist.data = dataset
+    @chemist.name.should eq 'cool dude'
+    @chemist.email.should eq 'fun@gmail.com'
+  end
+end