chemistrykit 3.9.0.rc2 → 3.9.0.rc3

data/CHANGELOG.md

@@ -1,5 +1,12 @@
+#3.9.0-rc.3 (2013-08-19)
+- added toggle for parts of html reports
+- added a fix to allow jenkins ci server to show the html report images
+- integrated new selenium connect
+- updates to configurations
+- integrated optimizely opt out
+
 #3.9.0-rc.2 (2013-08-14)
-Added Basic Auth Support. Preserving release candidate numbering since there are improvements to be made to HTTP reporting
+- Added Basic Auth Support. Preserving release candidate numbering since there are improvements to be made to HTTP reporting
 
 #3.9.0-rc.1 (2013-08-12)
 Release candidate with new features including

data/Gemfile

@@ -15,7 +15,8 @@ gem 'ruby2ruby'
 gem 'reek', '1.3.1'
 gem 'guard-reek'
 gem 'guard-rubocop'
-
 gem "selenium-client", "~> 1.2.18"
 gem 'compass'
 gem 'zurb-foundation'
+
+

data/README.md

@@ -1,4 +1,4 @@
-#ChemistryKit 3.9.0-rc.2 (2013-08-14)
+#ChemistryKit 3.9.0.rc3 (2013-08-19)
 
 [![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)
 
@@ -138,11 +138,11 @@ Here is a summary of the other methods available:
 Using `.and_with` lets you mix up various sets of user data. For example:
 
      @formula_lab.using('my_formula').with('admin1').and_with('sub_account1').mix
-     
+
 Would get you (assuming `sub_account1` has a type of `sub_account`, and a field `my_sub_field`) the ability to do something like this:
 
     chemist.sub_account.my_sub_field
-    
+
 Inside your formula. COOL!
 
 

data/TODO.md

@@ -14,3 +14,5 @@
 - opera
 - chrome
 - flex pilot (for flex/flash support)
+
+- add documentation about basic auth and a/b testing for final 3.9 release

data/chemistrykit.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'chemistrykit'
-  s.version       = '3.9.0.rc2'
+  s.version       = '3.9.0.rc3'
   s.platform      = Gem::Platform::RUBY
   s.authors       = ['Dave Haeffner', 'Jason Fox']
   s.email         = ['dave@arrgyle.com', 'jason@arrgyle.com']
@@ -24,12 +24,11 @@ Gem::Specification.new do |s|
   s.add_dependency 'builder', '~> 3.2.2'
   s.add_dependency 'selenium-webdriver', '~> 2.29.0'
   s.add_dependency 'rest-client', '~> 1.6.7'
-  s.add_dependency 'selenium-connect', '~> 3.5.0'
+  s.add_dependency 'selenium-connect', '~> 3.6.0'
   s.add_dependency 'parallel_tests', '~> 0.15.0'
   s.add_dependency 'parallel', '~> 0.7.0'
   s.add_dependency 'rspec-retry', '~> 0.2.1'
   s.add_dependency 'nokogiri', '~> 1.6.0'
-
   s.add_dependency 'syntax'
   s.add_dependency 'pygments.rb', '~> 0.5.2'
 end

data/features/basic_auth.feature

@@ -16,7 +16,6 @@ Background:
       end
     end
     """
-
 Scenario: Pre-load HTTP before each test
   And a file named "config.yaml" with:
     """

data/features/chemists.feature

@@ -11,6 +11,13 @@ Feature: Brewing a ChemistryKit project
       ran1,random,normal@email.com,Ms. Normal,test123%
       ran2,random,normal@email.com,Ms. Normal,test123%
       """
+    And I overwrite config.yaml with:
+      """
+      screenshot_on_fail: true
+      selenium_connect:
+          log: 'evidence'
+          browser: 'firefox'
+      """
     And a file named "formulas/basic_formula.rb" with:
       """
       module Formulas
@@ -76,13 +83,13 @@ Feature: Brewing a ChemistryKit project
             @driver.get url
           end
 
-          def find(locator)
-            @driver.find_element locator
+          def find(locater)
+            @driver.find_element locater
           end
 
-          def displayed?(locator)
+          def displayed?(locater)
             begin
-              find(locator).displayed?
+              find(locater).displayed?
             rescue
               false
             end
@@ -154,6 +161,7 @@ Feature: Brewing a ChemistryKit project
     When I run `ckit brew`
     Then the stdout should contain "2 examples, 0 failures"
 
+  @announce
   Scenario: Composing a chemist from multiple files
     Given a file named "beakers/chemist_beaker.rb" with:
       """
@@ -170,7 +178,7 @@ Feature: Brewing a ChemistryKit project
     And a file named "chemists/others.csv" with:
       """
       Key,Type,Item
-      other1,some_sub_account,some_item
+      other1,some_sub_account,some
       """
     When I run `ckit brew`
     Then the stdout should contain "1 example, 0 failures"

data/features/exit_status.feature

@@ -23,7 +23,6 @@ Feature: Exit Status
     When I run `ckit brew`
     Then the exit code should be 0
 
-  @announce
   Scenario: Failing
     And a file named "beakers/test_beaker.rb" with:
     """

data/features/reporting.feature

@@ -48,14 +48,12 @@ Feature: Advanced HTML Reports
           browser: 'firefox'
       """
 
-  @announce
   Scenario: I can run the tests
     When I run `ckit brew`
     Then the stdout should contain "5 examples, 3 failures, 1 pending"
     And the following files should exist:
       | evidence/final_results.html |
 
-  @announce
   Scenario: I can run the tests local with  concurrency
     Given I overwrite config.yaml with:
       """
@@ -70,7 +68,6 @@ Feature: Advanced HTML Reports
     And the following files should exist:
       | evidence/final_results.html |
 
-  @announce
   Scenario: I can run the tests with concurrency
     Given I overwrite config.yaml with:
       """

data/features/split_testing.feature

@@ -0,0 +1,29 @@
+Feature: opting out of ab tests based on configuration
+
+Background:
+    Given I run `ckit new split-test`
+    And I cd to "split-test"
+    And a file named "beakers/first_beaker.rb" with:
+    """
+    describe "Split test beaker", :depth => 'shallow' do
+      it "would not hit the ab testing end point" do
+          @driver.get 'http://the-internet.herokuapp.com/abtest'
+          @driver.find_element(css: 'h3').text.should == 'No A/B Test'
+      end
+    end
+    """
+    And I overwrite config.yaml with:
+      """
+      screenshot_on_fail: true
+      base_url: 'http://the-internet.herokuapp.com/abtest'
+      selenium_connect:
+          log: 'evidence'
+          browser: 'firefox'
+      split_testing:
+        provider: 'optimizely'
+        opt_out: true
+      """
+
+  Scenario: opt out is on
+    When I run `ckit brew`
+    Then the stdout should contain "1 example, 0 failures"

data/features/step_definitions/steps.rb

@@ -30,7 +30,7 @@ Then(/^there should be "(.*?)" "(.*?)" log files in "(.*?)"$/) do |number, type,
     when 'report'
       count += 1 if file =~ /sauce_job\.log/
     when 'sauce log'
-        count += 1 if file =~ /server\.log/
+      count += 1 if file =~ /server\.log/
     end
   end
   count.should == number.to_i

data/features/tags.feature

@@ -7,7 +7,6 @@ Feature: Listing all the tags
     Given I run `ckit new tags-test`
     And I cd to "tags-test"
 
-  @announce
   Scenario: Get the tag for a single beaker
     Given a file named "beakers/bookie_beaker.rb" with:
       """

data/lib/chemistrykit/cli/cli.rb

@@ -21,6 +21,8 @@ require 'rspec/core/formatters/html_formatter'
 require 'chemistrykit/rspec/html_formatter'
 
 require 'chemistrykit/reporting/html_report_assembler'
+require 'chemistrykit/split_testing/provider_factory'
+
 module ChemistryKit
   module CLI
 
@@ -124,7 +126,6 @@ module ChemistryKit
       protected
 
       def process_html
-        puts 'PROCESS HTML CALLED'
         File.join(Dir.getwd, 'evidence')
         results_folder = File.join(Dir.getwd, 'evidence')
         output_file = File.join(Dir.getwd, 'evidence', 'final_results.html')
@@ -211,23 +212,17 @@ module ChemistryKit
             example.run
           end
           c.before(:each) do
-            # basic auth caching
-            if config.basic_auth[:username]
-              if config.basic_auth[:http_path]
-                basic_auth_http_url = config.base_url.gsub(%r{http://}, "http:\/\/#{config.basic_auth[:username]}:#{config.basic_auth[:password]}@") + config.basic_auth[:http_path]
-                @driver.get basic_auth_http_url
-              else
-                basic_auth_http_url = config.base_url.gsub(%r{http://}, "http:\/\/#{config.basic_auth[:username]}:#{config.basic_auth[:password]}@")
-                @driver.get basic_auth_http_url
-              end
-              if config.basic_auth[:https_path]
-                basic_auth_https_url = config.base_url.gsub(%r{http://}, "https:\/\/#{config.basic_auth[:username]}:#{config.basic_auth[:password]}@") + config.basic_auth[:https_path]
-                @driver.get basic_auth_https_url
-              end
+            if config.basic_auth
+              @driver.get(config.basic_auth.http_url)
+              @driver.get(config.basic_auth.https_url) if config.basic_auth.https?
+            end
+
+            if config.split_testing
+              ChemistryKit::SplitTesting::ProviderFactory.build(config.split_testing).split(@driver)
             end
           end
           c.after(:each) do
-            if example.exception != nil
+            if example.exception.nil? == false
               @job.finish failed: true, failshot: @config.screenshot_on_fail
             else
               @job.finish passed: true

data/lib/chemistrykit/config/basic_auth.rb

@@ -0,0 +1,37 @@
+# Encoding: utf-8
+
+module ChemistryKit
+  module Config
+    class BasicAuth
+
+      attr_accessor :username, :password, :base_url, :http_path, :https_path
+
+      def initialize(opts)
+        opts.each do |key, value|
+          begin
+            send("#{key}=", value)
+          rescue NoMethodError
+            raise ArgumentError.new "The config key: \"#{key}\" is unknown!"
+          end
+        end
+      end
+
+      def http?
+        !!http_path
+      end
+
+      def https?
+        !!https_path
+      end
+
+      def http_url
+        base_url.gsub(%r{http://}, "http:\/\/#{username}:#{password}@") + (http_path || '')
+      end
+
+      def https_url
+        base_url.gsub(%r{http://}, "https:\/\/#{username}:#{password}@") + (https_path || '')
+      end
+
+    end
+  end
+end

data/lib/chemistrykit/config/split_testing.rb

@@ -0,0 +1,26 @@
+# Encoding: utf-8
+
+module ChemistryKit
+  module Config
+    class SplitTesting
+
+      attr_accessor :provider, :base_url
+
+      attr_writer :opt_out
+
+      def initialize(opts)
+        opts.each do |key, value|
+          begin
+            send("#{key}=", value)
+          rescue NoMethodError
+            raise ArgumentError.new "The config key: \"#{key}\" is unknown!"
+          end
+        end
+      end
+
+      def opt_out?
+        !!@opt_out
+      end
+    end
+  end
+end

data/lib/chemistrykit/configuration.rb

@@ -3,6 +3,9 @@
 require 'yaml'
 require 'ostruct'
 
+require 'chemistrykit/config/basic_auth'
+require 'chemistrykit/config/split_testing'
+
 module ChemistryKit
   # Default configuration class
   class Configuration
@@ -10,10 +13,9 @@ module ChemistryKit
     attr_accessor :base_url,
                   :concurrency,
                   :screenshot_on_fail,
-                  :retries_on_failure,
-                  :basic_auth
+                  :retries_on_failure
 
-    attr_reader   :log
+    attr_reader   :log, :basic_auth, :split_testing
 
     attr_writer   :selenium_connect
 
@@ -27,7 +29,8 @@ module ChemistryKit
       @log.path = 'evidence'
       @log.results_file = 'results_junit.xml'
       @log.format = 'ChemistryKit::RSpec::JUnitFormatter'
-      @basic_auth = {}
+      @basic_auth = nil
+      @split_testing = nil
 
       # overide with argument
       populate_with_hash hash
@@ -40,6 +43,14 @@ module ChemistryKit
       end
     end
 
+    def basic_auth=(basic_auth_hash)
+      @basic_auth = ChemistryKit::Config::BasicAuth.new(basic_auth_hash.merge(base_url: base_url))
+    end
+
+    def split_testing=(split_testing_hash)
+      @split_testing = ChemistryKit::Config::SplitTesting.new(split_testing_hash.merge(base_url: base_url))
+    end
+
     def selenium_connect
       # return the default log unless the sc log is set
       if @selenium_connect[:log].nil?

data/lib/chemistrykit/reporting/html_report_assembler.rb

@@ -43,7 +43,7 @@ module ChemistryKit
           file.write '<!--[if IE 8]>         <html class="no-js lt-ie9" lang="en" > <![endif]-->'
           file.write '<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->'
 
-            file.write get_report_head 'passing'
+            file.write get_report_head status
           file.write '<body>'
             file.write get_report_header
             file.write '<div class="report">'
@@ -101,12 +101,30 @@ module ChemistryKit
         build_fragment do |doc|
           doc.div(class: 'summary') do
             doc.div(class: "row status #{status}") do
-              doc.div(class: 'large-12 columns') do
+              doc.div(class: 'large-9 columns') do
                 doc.h1 do
                   doc.i(class: icon)
                   doc.text message
                 end
               end
+              doc.div(class: 'large-3 columns top-row') do
+                %w[passing failing pending].each do | type |
+                  doc.div(class: 'row switch-row') do
+                    doc.div(class: 'large-6 columns switch-label') do
+                      doc.text type.capitalize
+                    end
+                    doc.div(class: 'large-6 columns') do
+                      doc.div(class: "#{type}-switch") do
+                        doc.input(id: "show-#{type}", onclick: "toggle#{type.capitalize}();", name: "switch-show-#{type}", type: 'radio', checked: 'checked')
+                        doc.label(for: "show-#{type}") { doc.text 'Hide' }
+                        doc.input(id: "show-#{type}1", onclick: "toggle#{type.capitalize}();", name: "switch-show-#{type}", type: 'radio')
+                        doc.label(for: "show-#{type}1") { doc.text 'Show' }
+                        doc.span
+                      end
+                    end
+                  end
+                end
+              end
             end
             doc.div(class: 'row details') do
               doc.div(class: 'large-12 columns') do
@@ -150,6 +168,26 @@ module ChemistryKit
             doc.text load_from_file(File.join(File.dirname(File.expand_path(__FILE__)), '../../../report/', 'javascripts', 'foundation', 'foundation.section.js'))
           end
           doc.script { doc.text '$(document).foundation();' }
+          doc.script do
+            doc.text "
+              function togglePassing() {
+                console.log('passing')
+                $('.example.passing').toggle();
+                $('.example-group.passing').toggle();
+              }
+
+              function toggleFailing() {
+                console.log('failing')
+                $('.example.failing').toggle();
+                $('.example-group.failing').toggle();
+              }
+
+              function togglePending() {
+                console.log('pending')
+                $('.example.pending').toggle();
+                $('.example-group.pending').toggle();
+              }"
+          end
         end
       end
 

data/lib/chemistrykit/rspec/html_formatter.rb

@@ -128,9 +128,14 @@ module ChemistryKit
       def render_failshot_if_found(example)
         beaker_folder = slugify(@example_group.description)
         example_folder = slugify(@example_group.description + '_' + example.description)
+
         path = File.join(Dir.getwd, 'evidence', beaker_folder, example_folder, 'failshot.png')
         if File.exist?(path)
           render_section('Failure Screenshot') do |doc|
+             # if this is a jenkins job this variable is set and we can use it to get the right path to the images
+            if ENV['JOB_NAME']
+              path = File.join("/job/#{ENV['JOB_NAME']}/ws", 'evidence', beaker_folder, example_folder, 'failshot.png')
+            end
             doc.img(src: path)
           end
         end