chemistrykit 3.8.1 → 3.9.0.rc1

data/features/step_definitions/steps.rb

@@ -15,7 +15,7 @@ Then(/^there should be "(.*?)" unique results files in the "(.*?)" directory$/)
   files = Dir.glob(File.join(current_dir, logs_path, '*.xml'))
   count = 0
   files.each do |file|
-    count += 1 if file =~ /parallel_part_\w{8}-(\w{4}-){3}\w{12}\.xml/
+    count += 1 if file =~ /junit_\d+\.xml/
   end
   count.should == number_files.to_i
 end
@@ -26,11 +26,11 @@ Then(/^there should be "(.*?)" "(.*?)" log files in "(.*?)"$/) do |number, type,
   files.each do |file|
     case type
     when 'failed image'
-      count += 1 if file =~ /.+_failshot_.+\.png/
+      count += 1 if file =~ /failshot\.png/
     when 'report'
-      count += 1 if file =~ /.+_saucejob_.+\.log/
+      count += 1 if file =~ /sauce_job\.log/
     when 'sauce log'
-        count += 1 if file =~ /.+_serverlog_.+\.log/
+        count += 1 if file =~ /server\.log/
     end
   end
   count.should == number.to_i

data/features/support/env.rb

@@ -4,6 +4,6 @@ require 'aruba/cucumber'
 
 Before do
   FileUtils.rm_rf('build/tmp')
-  @aruba_timeout_seconds = 90
+  @aruba_timeout_seconds = 150
   @dirs = ['build/tmp']
 end

data/features/tags.feature

@@ -7,6 +7,7 @@ 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/chemist.rb

@@ -15,10 +15,15 @@ module ChemistryKit
 
     def data=(data)
       data.each do |key, value|
-        send("#{key}=", value) unless key == :key
+        send("#{key}=", value) unless key == :key || key == :with
       end
     end
 
+    def with(chemist)
+      send("#{chemist.type}=", chemist)
+      self
+    end
+
     # allow this object to be set with arbitrary key value data
     def method_missing(name, *arguments)
       value = arguments[0]

data/lib/chemistrykit/chemist/repository/csv_chemist_repository.rb

@@ -34,7 +34,7 @@ module ChemistryKit
           @tables.each do |table|
             chemist_data = table.find { |row| row[:key] == key }
             chemist = make_chemist(key, chemist_data[:type], chemist_data) if chemist_data
-            return fetch_from_cache chemist
+            return fetch_from_cache(chemist) if chemist
           end
           raise ArgumentError, "Chemist for type \"#{key}\" not found!"
         end

data/lib/chemistrykit/cli/cli.rb

@@ -14,9 +14,13 @@ require 'chemistrykit/chemist/repository/csv_chemist_repository'
 require 'selenium_connect'
 require 'chemistrykit/configuration'
 require 'parallel_tests'
-require 'chemistrykit/parallel_tests_mods'
-require 'chemistrykit/j_unit'
+require 'chemistrykit/parallel_tests/rspec/runner'
+require 'chemistrykit/rspec/j_unit_formatter'
 
+require 'rspec/core/formatters/html_formatter'
+require 'chemistrykit/rspec/html_formatter'
+
+require 'chemistrykit/reporting/html_report_assembler'
 module ChemistryKit
   module CLI
 
@@ -40,22 +44,22 @@ module ChemistryKit
       desc 'tags', 'Lists all tags in use in the test harness.'
       def tags
         beakers = Dir.glob(File.join(Dir.getwd, 'beakers/*'))
-        RSpec.configure do |c|
+        ::RSpec.configure do |c|
           c.add_setting :used_tags
-          c.before(:suite) { RSpec.configuration.used_tags = [] }
+          c.before(:suite) { ::RSpec.configuration.used_tags = [] }
           c.around(:each) do |example|
             standard_keys = [:example_group, :example_group_block, :description_args, :caller, :execution_result]
             example.metadata.each do |key, value|
               tag = "#{key}:#{value}" unless standard_keys.include?(key)
-              RSpec.configuration.used_tags.push tag unless RSpec.configuration.used_tags.include?(tag) || tag.nil?
+              ::RSpec.configuration.used_tags.push tag unless ::RSpec.configuration.used_tags.include?(tag) || tag.nil?
             end
           end
           c.after(:suite) do
             puts "\nTags used in harness:\n\n"
-            puts RSpec.configuration.used_tags.sort
+            puts ::RSpec.configuration.used_tags.sort
           end
         end
-        RSpec::Core::Runner.run(beakers)
+        ::RSpec::Core::Runner.run(beakers)
       end
 
       desc 'brew', 'Run ChemistryKit'
@@ -108,15 +112,26 @@ module ChemistryKit
 
         # based on concurrency parameter run tests
         if config.concurrency > 1 && ! options['parallel']
-          run_in_parallel beakers, config.concurrency, @tags, options
+          exit_code = run_in_parallel beakers, config.concurrency, @tags, options
         else
-          run_rspec beakers
+          exit_code = run_rspec beakers
         end
 
+        process_html unless options['parallel']
+        exit_code unless options['parallel']
       end
 
       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')
+        assembler = ChemistryKit::Reporting::HtmlReportAssembler.new(results_folder, output_file)
+        assembler.assemble
+      end
+
       def override_configs(options, config)
         # TODO: expand this to allow for more overrides as needed
         config.log.results_file = options['results_file'] if options['results_file']
@@ -157,7 +172,7 @@ module ChemistryKit
 
       # rubocop:disable MethodLength
       def rspec_config(config) # Some of these bits work and others don't
-        RSpec.configure do |c|
+        ::RSpec.configure do |c|
           c.treat_symbols_as_metadata_keys_with_true_values = true
           unless options[:all]
             c.filter_run @tags[:filter] unless @tags[:filter].nil?
@@ -209,12 +224,18 @@ module ChemistryKit
           c.output_stream = $stdout
           c.add_formatter 'progress'
 
+          html_log_name = options[:parallel] ? "results_#{options[:parallel]}.html" : 'results_0.html'
+
+          c.add_formatter(ChemistryKit::RSpec::HtmlFormatter, File.join(Dir.getwd, config.log.path, html_log_name))
+          # c.add_formatter(::RSpec::Core::Formatters::HtmlFormatter, File.join(Dir.getwd, config.log.path, html_log_name))
+
           # for rspec-retry
           c.verbose_retry = true # for rspec-retry
           c.default_retry_count = config.retries_on_failure
 
           if config.concurrency == 1 || options['parallel']
-            c.add_formatter(config.log.format, File.join(Dir.getwd, config.log.path, config.log.results_file))
+            junit_log_name = options[:parallel] ? "junit_#{options[:parallel]}.xml" : 'junit.xml'
+            c.add_formatter(ChemistryKit::RSpec::JUnitFormatter, File.join(Dir.getwd, config.log.path, junit_log_name))
           end
         end
       end
@@ -230,7 +251,7 @@ module ChemistryKit
       end
 
       def run_rspec(beakers)
-        RSpec::Core::Runner.run(beakers)
+        ::RSpec::Core::Runner.run(beakers)
       end
     end # CkitCLI
   end # CLI

data/lib/chemistrykit/configuration.rb

@@ -25,7 +25,7 @@ module ChemistryKit
       @log = OpenStruct.new
       @log.path = 'evidence'
       @log.results_file = 'results_junit.xml'
-      @log.format = 'JUnit'
+      @log.format = 'ChemistryKit::RSpec::JUnitFormatter'
 
       # overide with argument
       populate_with_hash hash
@@ -33,7 +33,7 @@ module ChemistryKit
 
     def log=(log_hash)
       log_hash.each do |key, value|
-        value = 'JUnit' if key == :format && value =~ /junit/i
+        value = 'ChemistryKit::RSpec::JUnitFormatter' if key == :format && value =~ /junit/i
         @log.send("#{key}=", value) unless value.nil?
       end
     end

data/lib/chemistrykit/formula/formula_lab.rb

@@ -14,6 +14,7 @@ module ChemistryKit
         @chemist_repository = chemist_repository
         raise ArgumentError, "Formula directory \"#{formulas_dir}\" does not exist!" unless File.directory?(formulas_dir)
         @formulas_dir = formulas_dir
+        @sub_chemists = []
       end
 
       def using(formula_key)
@@ -23,6 +24,7 @@ module ChemistryKit
 
       def mix(formula_key = nil)
         @formula = formula_key ||= formula
+        compose_chemists unless @sub_chemists.empty?
         raise ArgumentError, 'A formula key must be defined!' unless @formula
         formula_file = find_formula_file
         class_name = get_class_name formula_file
@@ -49,8 +51,19 @@ module ChemistryKit
         self
       end
 
+      def and_with(key)
+        @sub_chemists << @chemist_repository.load_chemist_by_key(key)
+        self
+      end
+
       private
 
+        def compose_chemists
+          @sub_chemists.each do |sub_chemist|
+            @chemist.with sub_chemist
+          end
+        end
+
         def find_formula_file
           Find.find(@formulas_dir) do |path|
             return path if path =~ /.*\/#{@formula}\.rb$/

data/lib/chemistrykit/{parallel_tests_mods.rb → parallel_tests/rspec/runner.rb}

@@ -2,11 +2,12 @@
 
 require 'parallel_tests/rspec/runner'
 require 'parallel_tests/test/runner'
-require 'securerandom'
 
 module ParallelTests
   module RSpec
     # Monkey Patching the ParallelTest RSpec Runner class to work with CKit's config and binary
+    # TODO: we could probably make this its own typed runner versus extinding the rspec
+    # one if this continues to get used
     class Runner < ParallelTests::Test::Runner
       class << self
 
@@ -18,7 +19,8 @@ module ParallelTests
         # cmd = [exe, options[:test_options], (rspec_2_color if version == 2), spec_opts, *test_files].compact.join(" ")
         # NOTE: The above line was modified to conform to ckit's command line constraints
 
-          cmd = [exe, options[:test_options]].compact.join(' ')
+          # Passes the process number into so that any generated assets can be identified.
+          cmd = [exe, "--parallel=#{process_number}", options[:test_options]].compact.join(' ')
           cmd << test_files.join(' ')
 
         # This concatenates the command into `bundle exec ckit brew --beakers=beaker1 beaker2 beaker3 etc`
@@ -32,9 +34,7 @@ module ParallelTests
         end
 
         def determine_executable
-          uuid = SecureRandom.uuid
-          file_name = "parallel_part_#{uuid}.xml"
-          "bundle exec ckit brew --parallel --results_file #{file_name}"
+          'bundle exec ckit brew'
         end
 
         def test_file_name

data/lib/chemistrykit/reporting/html_report_assembler.rb

@@ -0,0 +1,170 @@
+# Encoding: utf-8
+
+require 'nokogiri'
+
+module ChemistryKit
+  module Reporting
+    class HtmlReportAssembler
+      # TODO: Refactor to remove this cop exception
+      # rubocop:disable MethodLength, ParameterLists
+      def initialize(results_path, output_file)
+        @results_path = results_path
+        @output_file = output_file
+        @groups = []
+        @total_reactions = 0
+        @total_failures = 0
+        @total_duration = 0
+        @total_pending = 0
+      end
+
+      def assemble
+        result_files = Dir.glob(File.join(@results_path, 'results_*.html'))
+
+        result_files.each do |file|
+          doc = Nokogiri.HTML(open(file))
+
+          doc.css('.results').each do |element|
+            @total_reactions += element['data-count'].to_i
+            @total_failures += element['data-failures'].to_i
+            @total_pending += element['data-pendings'].to_i
+            @total_duration += element['data-duration'].to_f
+          end
+
+          doc.css('.example-group').each do |group|
+            @groups << group
+          end
+        end
+
+        status = @total_failures > 0 ? 'failing' : 'passing'
+
+        File.open(@output_file, 'w') do |file|
+
+          file.write '<!DOCTYPE html>'
+          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 '<body>'
+            file.write get_report_header
+            file.write '<div class="report">'
+              file.write get_report_summary status, @groups.count, @total_reactions, @total_failures, @total_pending, @total_duration
+
+          @groups.each do |group|
+            file.write group
+          end
+
+          file.write '</div>' # closes .report
+
+          file.write get_report_endscripts
+          file.write '</body>'
+          file.write '</html>'
+
+        end
+
+      end
+
+      def get_report_head(state)
+        build_fragment do |doc|
+          doc.head do
+            doc.meta(charset: 'utf-8')
+            doc.meta(name: 'viewport', content: 'width=device-width')
+            doc.title { doc.text "ChemistryKit - #{state.capitalize}" }
+            doc.style(type: 'text/css') do
+              doc.text load_from_file(File.join(File.dirname(File.expand_path(__FILE__)), '../../../report/', 'stylesheets', 'app.css'))
+            end
+            doc.link(href: 'http://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.css', rel: 'stylesheet')
+            doc.script do
+              doc.text load_from_file(File.join(File.dirname(File.expand_path(__FILE__)), '../../../report/', 'javascripts', 'vendor', 'custom.modernizr.js'))
+            end
+          end
+        end
+      end
+
+      def get_report_header
+        build_fragment do |doc|
+          doc.header(class: 'row') do
+            doc.div(class: 'large-12 columns') do
+              doc.h2 { doc.text 'ChemistryKit Brew Results' }
+            end
+          end
+        end
+      end
+
+      def get_report_summary(status, beakers, reactions, failures, pendings, duration)
+        if status == 'passing'
+          icon = 'icon-ok-sign'
+          message = ' Brew Passing'
+        else
+          icon = 'icon-warning-sign'
+          message = ' Brew Failing'
+        end
+        build_fragment do |doc|
+          doc.div(class: 'summary') do
+            doc.div(class: "row status #{status}") do
+              doc.div(class: 'large-12 columns') do
+                doc.h1 do
+                  doc.i(class: icon)
+                  doc.text message
+                end
+              end
+            end
+            doc.div(class: 'row details') do
+              doc.div(class: 'large-12 columns') do
+                doc.ul(class: 'large-block-grid-5') do
+                  doc.li do
+                    doc.i(class: 'icon-beaker passing-color')
+                    doc.p { doc.text "#{beakers.to_s} Beakers" }
+                  end
+                  doc.li do
+                    doc.i(class: 'icon-tint reaction-color')
+                    doc.p { doc.text "#{reactions.to_s} Reactions" }
+                  end
+                  doc.li do
+                    doc.i(class: 'icon-warning-sign failing-color')
+                    doc.p { doc.text "#{failures.to_s} Failures" }
+                  end
+                  doc.li do
+                    doc.i(class: 'icon-question-sign pending-color')
+                    doc.p { doc.text "#{pendings.to_s} Pending" }
+                  end
+                  doc.li do
+                    doc.i(class: 'icon-time')
+                    doc.p { doc.text "#{ sprintf("%.1i", duration / 60) }m Duration" }
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      def get_report_endscripts
+        build_fragment do |doc|
+          doc.script do
+            doc.text load_from_file(File.join(File.dirname(File.expand_path(__FILE__)), '../../../report/', 'javascripts', 'vendor', 'jquery.js'))
+          end
+          doc.script do
+            doc.text load_from_file(File.join(File.dirname(File.expand_path(__FILE__)), '../../../report/', 'javascripts', 'foundation', 'foundation.js'))
+          end
+          doc.script do
+            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();' }
+        end
+      end
+
+      def build_fragment
+        final = Nokogiri::HTML::DocumentFragment.parse ''
+        Nokogiri::HTML::Builder.with(final) do |doc|
+          yield doc
+        end
+        final.to_html
+      end
+
+      def load_from_file(path)
+        File.open(path, 'rb') { |file| file.read }
+      end
+      # rubocop:enable MethodLength, ParameterLists
+    end
+  end
+end

data/lib/chemistrykit/rspec/html_formatter.rb

@@ -0,0 +1,241 @@
+# Encoding: utf-8
+
+require 'rspec/core/formatters/base_text_formatter'
+require 'nokogiri'
+require 'erb'
+require 'rspec/core/formatters/snippet_extractor'
+require 'pygments'
+require 'securerandom'
+
+module ChemistryKit
+  module RSpec
+    class HtmlFormatter < ::RSpec::Core::Formatters::BaseTextFormatter
+      include ERB::Util # for the #h method
+      def initialize(output)
+        super(output)
+        @example_group_number = 0
+        @example_number = 0
+      end
+
+      def message(message)
+      end
+
+      def start(example_count)
+        super(example_count)
+        @output_html = ''
+      end
+
+      def example_group_started(example_group)
+        @example_group = example_group
+        @example_group_html = ''
+        @example_group_number += 1
+        @example_group_status = 'passing'
+      end
+
+      def example_group_finished(example_group)
+        @output_html << build_fragment do |doc|
+          doc.div(class: "row example-group #{@example_group_status}") do
+            doc.div(class: 'large-12 columns') do
+              doc.h3 do
+                doc.i(class: 'icon-beaker')
+                doc.text ' ' + example_group.description
+              end
+              doc.div(class: 'examples') do
+                doc << @example_group_html
+              end
+            end
+          end
+        end
+      end
+
+      def example_started(example)
+        super(example)
+        @example_number += 1
+      end
+
+      def example_passed(example)
+        @example_group_html += render_example('passing', example) {}
+      end
+
+      def example_pending(example)
+        super(example)
+        @example_group_html += render_example('pending', example) do |doc|
+          doc.div(class: 'row exception') do
+            doc.div(class: 'large-12 columns') do
+              doc.pre do
+                doc.text "PENDING: #{example.metadata[:execution_result][:pending_message]}"
+              end
+            end
+          end
+        end
+      end
+
+      def example_failed(example)
+        super(example)
+        exception = example.metadata[:execution_result][:exception]
+        @example_group_status = 'failing'
+        @example_group_html += render_example('failing', example) do |doc|
+          doc.div(class: 'row exception') do
+            doc.div(class: 'large-12 columns') do
+              doc.pre do
+                message = exception.message if exception
+                doc.text message
+              end
+            end
+          end
+          doc.div(class: 'row code-snippet') do
+            doc.div(class: 'large-12 columns') do
+              doc << render_code(exception)
+            end
+          end
+          doc << render_extra_content(example)
+        end
+      end
+
+      # TODO: put the right methods private, or better yet, pull this stuff out into its own
+      # set of classes
+      def render_extra_content(example)
+        build_fragment do |doc|
+          doc.div(class: 'row extra-content') do
+            doc.div(class: 'large-12 columns') do
+              doc.div(class: 'section-container auto', 'data-section' => '') do
+                doc << render_stack_trace(example)
+                doc << render_log_if_found(example, 'server.log')
+                doc << render_log_if_found(example, 'chromedriver.log')
+                doc << render_log_if_found(example, 'firefox.log')
+                doc << render_log_if_found(example, 'sauce_job.log')
+                doc << render_dom_html_if_found(example)
+                doc << render_failshot_if_found(example)
+              end
+            end
+          end
+        end
+      end
+
+      def render_dom_html_if_found(example)
+        # TODO: pull out the common code for checking if the log file exists
+        beaker_folder = slugify(@example_group.description)
+        example_folder = slugify(@example_group.description + '_' + example.description)
+        path = File.join(Dir.getwd, 'evidence', beaker_folder, example_folder, 'dom.html')
+        if File.exist?(path)
+          render_section('Dom Html') do |doc|
+            doc << Pygments.highlight(File.read(path), lexer: 'html')
+          end
+        end
+      end
+
+      # TODO: replace the section id with a uuid or something....
+      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|
+            doc.img(src: path)
+          end
+        end
+      end
+
+      def render_log_if_found(example, log)
+        beaker_folder = slugify(@example_group.description)
+        example_folder = slugify(@example_group.description + '_' + example.description)
+        log_path = File.join(Dir.getwd, 'evidence', beaker_folder, example_folder, log)
+        if File.exist?(log_path)
+          render_section(log.capitalize) do |doc|
+            doc.pre do
+              doc.text File.open(log_path, 'rb') { |file| file.read }
+            end
+          end
+        end
+      end
+
+      def slugify(string)
+        string.downcase.strip.gsub(' ', '_').gsub(/[^\w-]/, '')
+      end
+
+      def render_stack_trace(example)
+        exception = example.metadata[:execution_result][:exception]
+        render_section('Stack Trace') do |doc|
+          doc.pre do
+            doc.text format_backtrace(exception.backtrace, example).join("\n")
+          end
+        end
+      end
+
+      def render_code(exception)
+        backtrace = exception.backtrace.map { |line| backtrace_line(line) }
+        backtrace.compact!
+        @snippet_extractor ||= ::RSpec::Core::Formatters::SnippetExtractor.new
+        "<pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"
+      end
+
+      def render_section(title)
+        panel_id = SecureRandom.uuid
+        build_fragment do |doc|
+          doc.section do
+            doc.p(class: 'title', 'data-section-title' => '') do
+              doc.a(href: "#panel#{panel_id}") { doc.text title }
+            end
+            doc.div(class: 'content', 'data-section-content' => '') do
+              yield doc
+            end
+          end
+        end
+      end
+
+      def render_example(status, example)
+        build_fragment do |doc|
+          doc.div(class: "row example #{status}") do
+            doc.div(class: 'large-12 columns') do
+              doc.div(class: 'row example-heading') do
+                doc.div(class: 'large-9 columns') do
+                  doc.p { doc.text example.description.capitalize }
+                end
+                doc.div(class: 'large-3 columns text-right') do
+                  doc.p { doc.text sprintf('%.0i', example.execution_result[:run_time]) + 's' }
+                end
+              end
+              doc.div(class: 'row example-body') do
+                doc.div(class: 'large-12 columns') { yield doc }
+              end
+            end
+          end
+        end
+      end
+
+      def dump_failures
+      end
+
+      def dump_pending
+      end
+
+      def dump_summary(duration, example_count, failure_count, pending_count)
+        output = build_fragment do |doc|
+          doc.div(
+            class: 'results',
+            'data-count' => example_count.to_s,
+            'data-duration' => duration.to_s,
+            'data-failures' => failure_count.to_s,
+            'data-pendings' => pending_count.to_s
+            ) { doc << @output_html }
+        end
+        @output.puts output
+      end
+
+      # def extra_failure_content(exception)
+      #   super + "<h1>Ya'll know we be failing.</h1>"
+      # end
+      #
+      def build_fragment
+        final = Nokogiri::HTML::DocumentFragment.parse ''
+        Nokogiri::HTML::Builder.with(final) do |doc|
+          yield doc
+        end
+        final.to_html
+      end
+    end
+  end
+end
+
+
+