beaker 1.12.2 → 1.13.0

data/lib/beaker/options/command_line_parser.rb

@@ -111,12 +111,6 @@ module Beaker
             @cmd_options[:quiet] = bool
           end
 
-          opts.on '-x', '--[no-]xml',
-                  'Emit JUnit XML reports on tests',
-                  '(default: false)' do |bool|
-            @cmd_options[:xml] = bool
-          end
-
           opts.on '--[no-]color',
                   'Do not display color in log output',
                   '(default: true)' do |bool|
@@ -170,6 +164,10 @@ module Beaker
             @cmd_options[:add_el_extras] = true
           end
 
+          opts.on '--package-proxy URL', 'Set proxy url for package managers (yum and apt)' do |value|
+            @cmd_options[:package_proxy] = value
+          end
+
           opts.on '--[no-]validate',
                   'Validate that SUTs are correctly configured before running tests',
                   '(default: true)' do |bool|
@@ -198,9 +196,11 @@ module Beaker
             @cmd_options[:log_level] =  bool ? 'debug' : 'info'
           end
 
-          opts.on '--package-proxy URL', 'Set proxy url for package managers (yum and apt)' do |value|
-            @cmd_options[:package_proxy] = value
+          opts.on '-x', '--[no-]xml',
+                  'DEPRECATED - JUnit XML now generated by default' do
+            #noop
           end
+
         end
 
       end

data/lib/beaker/options/presets.rb

@@ -67,7 +67,11 @@ module Beaker
           :preserve_hosts      => 'never',
           :root_keys           => false,
           :quiet               => false,
-          :xml                 => false,
+          :project_root        => File.expand_path(File.join(File.dirname(__FILE__), "../")),
+          :xml_dir             => 'junit',
+          :xml_file            => 'beaker_junit.xml',
+          :xml_stylesheet      => 'junit.xsl',
+          :log_dir             => 'log',
           :color               => true,
           :dry_run             => false,
           :timeout             => 300,

data/lib/beaker/platform.rb

@@ -19,6 +19,7 @@ module Beaker
 
     #Creates the Platform object.  Checks to ensure that the platform String provided meets the platform
     #formatting rules.  Platforms name must be of the format /^OSFAMILY-VERSION-ARCH.*$/ where OSFAMILY is one of:
+    # * osx
     # * centos
     # * fedora
     # * debian

data/lib/beaker/ssh_connection.rb

@@ -5,6 +5,8 @@ require 'net/scp'
 module Beaker
   class SshConnection
 
+    attr_accessor :logger
+
     RETRYABLE_EXCEPTIONS = [
       SocketError,
       Timeout::Error,
@@ -18,14 +20,15 @@ module Beaker
       Net::SSH::AuthenticationFailed,
     ]
 
-    def initialize hostname, user = nil, options = {}
+    def initialize hostname, user = nil, ssh_opts = {}, options = {}
       @hostname = hostname
       @user = user
-      @options = options
+      @ssh_opts = ssh_opts
+      @logger = options[:logger]
     end
 
-    def self.connect hostname, user = 'root', options = {}
-      connection = new hostname, user, options
+    def self.connect hostname, user = 'root', ssh_opts = {}, options = {}
+      connection = new hostname, user, ssh_opts, options
       connection.connect
       connection
     end
@@ -35,21 +38,22 @@ module Beaker
       last_wait = 0
       wait = 1
       @ssh ||= begin
-                 Net::SSH.start(@hostname, @user, @options)
+                 Net::SSH.start(@hostname, @user, @ssh_opts)
                rescue *RETRYABLE_EXCEPTIONS => e
                  if try <= 11
-                   puts "Try #{try} -- Host #{@hostname} unreachable: #{e.message}"
-                   puts "Trying again in #{wait} seconds"
+                   @logger.warn "Try #{try} -- Host #{@hostname} unreachable: #{e.message}"
+                   @logger.warn "Trying again in #{wait} seconds"
                    sleep wait
-                   (last_wait, wait) = wait, last_wait + wait
+                  (last_wait, wait) = wait, last_wait + wait
                    try += 1
                    retry
                  else
                    # why is the logger not passed into this class?
-                   puts "Failed to connect to #{@hostname}"
+                   @logger.error "Failed to connect to #{@hostname}"
                    raise
                  end
                end
+      @logger.debug "Created ssh connection to #{@hostname}, user: #{@user}, opts: #{@ssh_opts}"
       self
     end
 
@@ -101,7 +105,7 @@ module Beaker
       rescue *RETRYABLE_EXCEPTIONS => e
         if attempt
           attempt = false
-          puts "Command execution failed, attempting to reconnect to #{@hostname}"
+          @logger.error "Command execution failed, attempting to reconnect to #{@hostname}"
           close
           connect
           retry
@@ -116,7 +120,7 @@ module Beaker
     def request_terminal_for channel, command
       channel.request_pty do |ch, success|
         if success
-          puts "Allocated a PTY on #{@hostname} for #{command.inspect}"
+          @logger.info "Allocated a PTY on #{@hostname} for #{command.inspect}"
         else
           abort "FAILED: could not allocate a pty when requested on " +
             "#{@hostname} for #{command.inspect}"

data/lib/beaker/tasks/rake_task.rb

@@ -0,0 +1,114 @@
+require 'rake/task_arguments'
+require 'rake/tasklib'
+require 'rake'
+require 'beaker'
+
+
+module Beaker
+  module Tasks
+    class RakeTask < ::Rake::TaskLib
+      include ::Rake::DSL if defined?(::Rake::DSL)
+
+      DEFAULT_ACCEPTANCE_ROOT = "./acceptance"
+
+      COMMAND_OPTIONS = [:fail_mode,
+       :hosts,
+       :helper,
+       :keyfile,
+       :log_level,
+       :options_file,
+       :preserve_hosts,
+       :tests,
+       :type,
+       :acceptance_root,
+       :name]
+      # iterates of acceptable params
+      COMMAND_OPTIONS.each do |sym|
+        attr_accessor(sym.to_sym)
+      end
+
+      # Sets up the predefine task checking
+      # @param args [Array] First argument is always the name of the task
+      # if no additonal arguments are defined such as parameters it will default to [:hosts,:type]
+      def initialize(*args, &task_block)
+        @name = args.shift || 'beaker:test'
+        if args.empty?
+          args = [:hosts,:type]
+        end
+        @acceptance_root = DEFAULT_ACCEPTANCE_ROOT
+        @options_file = nil
+        define(args, &task_block)
+      end
+
+      private
+      # Run the task provided, implements the rake task interface
+      #
+      # @param verbose [bool] Defines wether to run in verbose mode or not
+      def run_task(verbose)
+        puts "Running task"
+
+        check_for_beaker_type_config
+        command = beaker_command
+
+        begin
+          puts command if verbose
+          success = system(command)
+          preserve_configuration(@options_file)
+        rescue
+          puts failure_message if failure_message
+        end
+        if fail_mode == "fast" && !success
+          $stderr.puts "#{command} failed"
+          exit $?.exitstatus
+        end
+      end
+
+      # @private
+      def define(args, &task_block)
+        desc "Run Beaker Acceptance" unless ::Rake.application.last_comment
+        task name, *args do |_, task_args|
+          RakeFileUtils.__send__(:verbose, verbose) do
+            task_block.call(*[self, task_args].slice(0, task_block.arity)) if task_block
+            run_task verbose
+          end
+        end
+      end
+
+      #
+      # If an options file exists in the acceptance path for the type given use it as a default options file
+      #   if no other options file is provided
+      #
+      def check_for_beaker_type_config
+        if !@options_file && File.exists?("#{@acceptance_root}/.beaker-#{@type}.cfg")
+          @options_file = File.join(@acceptance_root, ".beaker-#{@type}.cfg")
+        end
+      end
+
+      #
+      # Check for existence of ENV variables for test if !@tests is undef
+      #
+      def check_env_variables
+        if File.exists?(File.join(DEFAULT_ACCEPTANCE_ROOT, 'tests'))
+          @tests = File.join(DEFAULT_ACCEPTANCE_ROOT, 'tests')
+        end
+        @tests = ENV['TESTS'] || ENV['TEST'] if !@tests
+      end
+
+      #
+      # Generate the beaker command to run beaker with all possible options passed
+      #
+      def beaker_command
+        cmd_parts = []
+        cmd_parts << "beaker"
+        cmd_parts << "--keyfile #{@keyfile}" if @keyfile
+        cmd_parts << "--hosts #{@hosts}" if @hosts
+        cmd_parts << "--tests #{tests}" if @tests
+        cmd_parts << "--options-file #{@options_file}" if @options_file
+        cmd_parts << "--type #{@type}" if @type
+        cmd_parts << "--helper #{@helper}" if @helper
+        cmd_parts << "--fail-mode #{@fail_mode}" if @fail_mode
+        cmd_parts.flatten.join(" ")
+      end
+    end
+  end
+end

data/lib/beaker/tasks/test.rb

@@ -0,0 +1,18 @@
+require 'beaker/tasks/rake_task'
+
+Beaker::Tasks::RakeTask.new do |t,args|
+  t.type  = args[:type]
+  t.hosts = args[:hosts]
+end
+
+desc "Run Beaker PE tests"
+Beaker::Tasks::RakeTask.new("beaker:test:pe",:hosts) do |t,args|
+  t.type = 'pe'
+  t.hosts = args[:hosts]
+end
+
+desc "Run Beaker Git tests"
+Beaker::Tasks::RakeTask.new("beaker:test:git",:hosts) do |t,args|
+  t.type = 'git'
+  t.hosts = args[:hosts]
+end

data/lib/beaker/test_case.rb

@@ -52,6 +52,9 @@ module Beaker
     # an instance of {Beaker::Logger}.
     attr_accessor :logger
 
+    #The full log for this test
+    attr_accessor :sublog
+
     # A Hash of 'product name' => 'version installed', only set when
     # products are installed via git or PE install steps. See the 'git' or
     # 'pe' directories within 'ROOT/setup' for examples.
@@ -102,6 +105,7 @@ module Beaker
     def initialize(these_hosts, logger, options={}, path=nil)
       @hosts   = these_hosts
       @logger = logger
+      @sublog = ""
       @options = options
       @path    = path
       @usr_home = options[:home]
@@ -116,6 +120,7 @@ module Beaker
       # defined in the tests don't leak out to other tests.
       class << self
         def run_test
+          @logger.start_sublog
           @runtime = Benchmark.realtime do
             begin
               test = File.read(path)
@@ -139,6 +144,7 @@ module Beaker
               end
             end
           end
+          @sublog = @logger.get_sublog
           return self
         end
 

data/lib/beaker/test_suite.rb

@@ -1,20 +1,279 @@
 # -*- coding: utf-8 -*-
-require 'rexml/document'
+require 'nokogiri'
 require 'fileutils'
 [ 'test_case', 'logger' ].each do |lib|
   require "beaker/#{lib}"
 end
 
 module Beaker
-  # This Class is in need of some cleaning up beyond what can be quickly done.
-  # Things to keep in mind:
-  #   * Global State Change
-  #   * File Creation Relative to CWD  -- Should be a config option
-  #   * Better Method Documentation
+  #A collection of {TestCase} objects are considered a {TestSuite}.
+  #Handles executing the set of {TestCase} instances and reporting results as post summary text and JUnit XML.
   class TestSuite
+
+    #Holds the output of a test suite, formats in plain text or xml
+    class TestSuiteResult
+      attr_accessor :start_time, :stop_time
+
+      #Create a {TestSuiteResult} instance.
+      #@param [Hash{Symbol=>String}] options Options for this object
+      #@option options [Logger] :logger The Logger object to report information to
+      #@param [String] name The name of the {TestSuite} that the results are for
+      def initialize( options, name )
+        @options = options
+        @logger = options[:logger]
+        @name = name
+        @test_cases = []
+        #Set some defaults, just in case you attempt to print without including them
+        start_time = Time.at(0)
+        stop_time = Time.at(1)
+      end
+
+      #Add a {TestCase} to this {TestSuiteResult} instance, used in calculating {TestSuiteResult} data.
+      #@param [TestCase] test_case An individual, completed {TestCase} to be included in this set of {TestSuiteResult}.
+      def add_test_case( test_case )
+        @test_cases << test_case
+      end
+
+      #How many {TestCase} instances are in this {TestSuiteResult}
+      def test_count
+        @test_cases.length
+      end
+
+      #How many passed {TestCase} instances are in this {TestSuiteResult}
+      def passed_tests
+        @test_cases.select { |c| c.test_status == :pass }.length
+      end
+
+      #How many errored {TestCase} instances are in this {TestSuiteResult}
+      def errored_tests
+        @test_cases.select { |c| c.test_status == :error }.length
+      end
+
+      #How many failed {TestCase} instances are in this {TestSuiteResult}
+      def failed_tests
+        @test_cases.select { |c| c.test_status == :fail }.length
+      end
+
+      #How many skipped {TestCase} instances are in this {TestSuiteResult}
+      def skipped_tests
+        @test_cases.select { |c| c.test_status == :skip }.length
+      end
+
+      #How many pending {TestCase} instances are in this {TestSuiteResult}
+      def pending_tests
+        @test_cases.select {|c| c.test_status == :pending}.length
+      end
+
+      #How many {TestCase} instances failed in this {TestSuiteResult}
+      def sum_failed
+        failed_tests + errored_tests
+      end
+
+      #Did all the {TestCase} instances in this {TestSuiteResult} pass?
+      def success?
+        sum_failed == 0
+      end
+
+      #Did one or more {TestCase} instances in this {TestSuiteResult} fail?
+      def failed?
+        !success?
+      end
+
+      #The sum of all {TestCase} runtimes in this {TestSuiteResult}
+      def elapsed_time
+        @test_cases.inject(0.0) {|r, t| r + t.runtime.to_f }
+      end
+
+      #Plain text summay of test suite
+      #@param [Logger] summary_logger The logger we will print the summary to
+      def summarize(summary_logger)
+
+        summary_logger.notify <<-HEREDOC
+      Test Suite: #{@name} @ #{start_time}
+
+      - Host Configuration Summary -
+        HEREDOC
+
+        average_test_time = elapsed_time / test_count
+
+        summary_logger.notify %Q[
+
+              - Test Case Summary for suite '#{@name}' -
+       Total Suite Time: %.2f seconds
+      Average Test Time: %.2f seconds
+              Attempted: #{test_count}
+                 Passed: #{passed_tests}
+                 Failed: #{failed_tests}
+                Errored: #{errored_tests}
+                Skipped: #{skipped_tests}
+                Pending: #{pending_tests}
+
+      - Specific Test Case Status -
+        ] % [elapsed_time, average_test_time]
+
+        grouped_summary = @test_cases.group_by{|test_case| test_case.test_status }
+
+        summary_logger.notify "Failed Tests Cases:"
+        (grouped_summary[:fail] || []).each do |test_case|
+          print_test_result(test_case)
+        end
+
+        summary_logger.notify "Errored Tests Cases:"
+        (grouped_summary[:error] || []).each do |test_case|
+          print_test_result(test_case)
+        end
+
+        summary_logger.notify "Skipped Tests Cases:"
+        (grouped_summary[:skip] || []).each do |test_case|
+          print_test_result(test_case)
+        end
+
+        summary_logger.notify "Pending Tests Cases:"
+        (grouped_summary[:pending] || []).each do |test_case|
+          print_test_result(test_case)
+        end
+
+        summary_logger.notify("\n\n")
+      end
+
+      #A convenience method for printing the results of a {TestCase}
+      #@param [TestCase] test_case The {TestCase} to examine and print results for
+      def print_test_result(test_case)
+        test_reported = if test_case.exception
+                          "reported: #{test_case.exception.inspect}"
+                        else
+                          test_case.test_status
+                        end
+        @logger.notify "  Test Case #{test_case.path} #{test_reported}"
+      end
+
+      #Remove color codes from provided string.  Color codes are of the format /(\e\[\d\d;\d\dm)+/. 
+      #@param [String] text The string to remove color codes from
+      #@return [String] The text without color codes
+      def strip_color_codes(text)
+        text.gsub(/(\e|\^\[)\[(\d*;)*\d*m/, '')
+      end
+
+      #Format and print the {TestSuiteResult} as JUnit XML
+      #@param [String] xml_file The full path to print the output to.
+      #@param [String] stylesheet The full path to a JUnit XML stylesheet
+      def write_junit_xml(xml_file, stylesheet)
+        begin
+
+          #copy stylesheet into xml directory
+          if not File.file?(File.join(File.dirname(xml_file), File.basename(stylesheet)))
+            FileUtils.copy(stylesheet, File.join(File.dirname(xml_file), File.basename(stylesheet)))
+          end
+          suites = nil
+          #check to see if an output file already exists, if it does add or replace test suite data
+          if File.file?(xml_file)
+            doc = Nokogiri::XML( File.open(xml_file, 'r') )
+            suites = doc.at_xpath('testsuites')
+            #remove old data
+            doc.search("//testsuite").each do |node|
+              if node['name'] =~ /#{@name}/
+                node.unlink
+              end
+            end
+          else
+            #no existing file, create a new one
+            doc = Nokogiri::XML::Document.new
+            pi = Nokogiri::XML::ProcessingInstruction.new(doc, "xml-stylesheet", "type=\"text/xsl\" href=\"#{File.basename(stylesheet)}\"")
+            pi.parent = doc
+            suites = Nokogiri::XML::Node.new('testsuites', doc)
+            suites.parent = doc
+          end
+
+          suite = Nokogiri::XML::Node.new('testsuite', doc)
+          suite['name']     = @name
+          suite['tests']    = test_count
+          suite['errors']   = errored_tests
+          suite['failures'] = failed_tests
+          suite['skip']     = skipped_tests
+          suite['pending']  = pending_tests
+          suite['time']     = "%f" % (stop_time - start_time)
+          properties = Nokogiri::XML::Node.new('properties', doc)
+          @options.each_pair do | name, value |
+            property = Nokogiri::XML::Node.new('property', doc)
+            property['name']  = name
+            property['value'] = value
+            properties.add_child(property)
+          end
+          suite.add_child(properties)
+
+          @test_cases.each do |test|
+            item = Nokogiri::XML::Node.new('testcase', doc)
+            item['classname'] = File.dirname(test.path)
+            item['name']      = File.basename(test.path)
+            item['time']      = "%f" % test.runtime
+
+            # Did we fail?  If so, report that.
+            # We need to remove the escape character from colorized text, the
+            # substitution of other entities is handled well by Rexml
+            if test.test_status == :fail || test.test_status == :error then
+              status = Nokogiri::XML::Node.new('failure', doc)
+              status['type'] =  test.test_status.to_s
+              if test.exception then
+                status['message'] = test.exception.to_s.gsub(/\e/, '')
+                status.add_child(status.document.create_cdata(test.exception.backtrace.join('\n')))
+              end
+              item.add_child(status)
+            end
+
+            if test.test_status == :skip
+              status = Nokogiri::XML::Node.new('skip', doc)
+              status['type'] =  test.test_status.to_s
+              item.add_child(status)
+            end
+
+            if test.test_status == :pending
+              status = Nokogiri::XML::Node.new('pending', doc)
+              status['type'] =  test.test_status.to_s
+              item.add_child(status)
+            end
+
+            if test.sublog then
+              stdout = Nokogiri::XML::Node.new('system-out', doc)
+              stdout.add_child(stdout.document.create_cdata(strip_color_codes(test.sublog)))
+              item.add_child(stdout)
+            end
+
+            if test.stderr then
+              stderr = Nokogiri::XML::Node.new('system-err', doc)
+              stderr.add_child(stderr.document.create_cdata(strip_color_codes(test.stderr)))
+              item.add_child(stderr)
+            end
+
+            suite.add_child(item)
+          end
+          suites.add_child(suite)
+
+          # junit/name.xml will be created in a directory relative to the CWD
+          # --  JLS 2/12
+          File.open(xml_file, 'w') { |fh| fh.write(doc.to_xml) }
+
+        rescue Exception => e
+          @logger.error "failure in XML output:\n#{e.to_s}\n" + e.backtrace.join("\n")
+        end
+      end
+
+    end
+
     attr_reader :name, :options, :fail_mode
 
-    def initialize(name, hosts, options, fail_mode = nil)
+    #Create {TestSuite} instance
+    #@param [String] name The name of the {TestSuite}
+    #@param [Array<Host>] hosts An Array of Hosts to act upon.
+    #@param [Hash{Symbol=>String}] options Options for this object
+    #@option options [Logger] :logger The Logger object to report information to
+    #@option options [String] :log_dir The directory where text run logs will be written
+    #@option options [String] :xml_dir The directory where JUnit XML file will be written
+    #@option options [String] :xml_file The name of the JUnit XML file to be written to
+    #@option options [String] :project_root The full path to the Beaker lib directory
+    #@option options [String] :xml_stylesheet The path to a stylesheet to be applied to the generated XML output
+    #@param [Symbol] fail_mode One of :slow, :fast
+    #@param [Time] timestamp Beaker execution start time
+    def initialize(name, hosts, options, timestamp, fail_mode = :slow)
       @logger     = options[:logger]
       @test_cases = []
       @test_files = options[name]
@@ -22,7 +281,9 @@ module Beaker
       @hosts      = hosts
       @run        = false
       @options    = options
-      @fail_mode  = options[:fail_mode] || fail_mode
+      @fail_mode  = fail_mode
+      @test_suite_results = TestSuiteResult.new(@options, name)
+      @timestamp = timestamp
 
       report_and_raise(@logger, RuntimeError.new("#{@name}: no test files found..."), "TestSuite: initialize") if @test_files.empty?
 
@@ -30,18 +291,30 @@ module Beaker
       report_and_raise(@logger, e, "TestSuite: initialize")
     end
 
+    #Execute all the {TestCase} instances and then report the results as both plain text and xml.  The text result
+    #is reported to a newly created run log.
+    #Execution is dependent upon the fail_mode.  If mode is :fast then stop running any additional {TestCase} instances
+    #after first failure, if mode is :slow continue execution no matter what {TestCase} results are.
     def run
       @run = true
-      @start_time = Time.now
+      start_time = Time.now
 
-      configure_logging
+      #Create a run log for this TestSuite.
+      run_log = log_path(@timestamp, "#{@name}-run.log", @options[:log_dir])
+      @logger.add_destination(run_log)
+
+      # This is an awful hack to maintain backward compatibility until tests
+      # are ported to use logger.  Still in use in PuppetDB tests
+      Beaker.const_set(:Log, @logger) unless defined?( Log )
+
+      @test_suite_results.start_time = start_time
 
       @test_files.each do |test_file|
-        @logger.notify
         @logger.notify "Begin #{test_file}"
         start = Time.now
         test_case = TestCase.new(@hosts, @logger, options, test_file).run_test
         duration = Time.now - start
+        @test_suite_results.add_test_case(test_case)
         @test_cases << test_case
 
         state = test_case.test_status == :skip ? 'skipp' : test_case.test_status
@@ -53,27 +326,33 @@ module Beaker
           @logger.debug msg
         when :fail
           @logger.error msg
-          break if fail_mode !~ /slow/ #all failure modes except slow cause us to kick out early on failure
+          break if @fail_mode !~ /slow/ #all failure modes except slow cause us to kick out early on failure
         when :error
           @logger.warn msg
-          break if fail_mode !~ /slow/ #all failure modes except slow cause us to kick out early on failure
+          break if @fail_mode !~ /slow/ #all failure modes except slow cause us to kick out early on failure
         end
       end
+      @test_suite_results.stop_time = Time.now
 
       # REVISIT: This changes global state, breaking logging in any future runs
       # of the suite – or, at least, making them highly confusing for anyone who
       # has not studied the implementation in detail. --daniel 2011-03-14
-      summarize
-      write_junit_xml if options[:xml]
+      @test_suite_results.summarize( Logger.new(log_path(@timestamp, "#{name}-summary.txt", @options[:log_dir]), STDOUT) )
+      @test_suite_results.write_junit_xml( log_path(@timestamp, @options[:xml_file], @options[:xml_dir]), File.join(@options[:project_root], @options[:xml_stylesheet]) )
+
+      #All done with this run, remove run log
+      @logger.remove_destination(run_log)
 
       # Allow chaining operations...
       return self
     end
 
+    #Execute all the TestCases in this suite.
+    #This is a wrapper that catches any failures generated during TestSuite::run.
     def run_and_raise_on_failure
       begin
         run
-        return self if success?
+        return self if @test_suite_results.success?
       rescue => e
         #failed during run
         report_and_raise(@logger, e, "TestSuite :run_and_raise_on_failure")
@@ -83,187 +362,33 @@ module Beaker
       end
     end
 
-    def fail_without_test_run
-      report_and_raise(@logger, RuntimeError.new("#{@name}: you have not run the tests yet"), "TestSuite: fail_without_test_run") unless @run
-    end
-
-    def success?
-      fail_without_test_run
-      sum_failed == 0
-    end
-
-    def failed?
-      !success?
-    end
-
-    def test_count
-      @test_count ||= @test_cases.length
-    end
-
-    def passed_tests
-      @passed_tests ||= @test_cases.select { |c| c.test_status == :pass }.length
-    end
-
-    def errored_tests
-      @errored_tests ||= @test_cases.select { |c| c.test_status == :error }.length
-    end
-
-    def failed_tests
-      @failed_tests ||= @test_cases.select { |c| c.test_status == :fail }.length
-    end
-
-    def skipped_tests
-      @skipped_tests ||= @test_cases.select { |c| c.test_status == :skip }.length
-    end
-
-    def pending_tests
-      @pending_tests ||= @test_cases.select {|c| c.test_status == :pending}.length
-    end
-
-    private
-
-    def sum_failed
-      @sum_failed ||= failed_tests + errored_tests
-    end
-
-    def write_junit_xml
-      # This should be a configuration option
-      File.directory?('junit') or FileUtils.mkdir('junit')
-
-      begin
-        doc   = REXML::Document.new
-        doc.add(REXML::XMLDecl.new(1.0))
-
-        suite = REXML::Element.new('testsuite', doc)
-        suite.add_attribute('name',     name)
-        suite.add_attribute('tests',    test_count)
-        suite.add_attribute('errors',   errored_tests)
-        suite.add_attribute('failures', failed_tests)
-        suite.add_attribute('skip',     skipped_tests)
-        suite.add_attribute('pending',  pending_tests)
-
-        @test_cases.each do |test|
-          item = REXML::Element.new('testcase', suite)
-          item.add_attribute('classname', File.dirname(test.path))
-          item.add_attribute('name',      File.basename(test.path))
-          item.add_attribute('time',      test.runtime)
-
-          # Did we fail?  If so, report that.
-          # We need to remove the escape character from colorized text, the
-          # substitution of other entities is handled well by Rexml
-          if test.test_status == :fail || test.test_status == :error then
-            status = REXML::Element.new('failure', item)
-            status.add_attribute('type', test.test_status.to_s)
-            if test.exception then
-              status.add_attribute('message', test.exception.to_s.gsub(/\e/, ''))
-              status.text = test.exception.backtrace.join("\n")
-            end
-          end
-
-          if test.stdout then
-            REXML::Element.new('system-out', item).text =
-              test.stdout.gsub(/\e/, '')
-          end
-
-          if test.stderr then
-            text = REXML::Element.new('system-err', item)
-            text.text = test.stderr.gsub(/\e/, '')
-          end
-        end
-
-        # junit/name.xml will be created in a directory relative to the CWD
-        # --  JLS 2/12
-        File.open("junit/#{name}.xml", 'w') { |fh| doc.write(fh) }
-      rescue Exception => e
-        @logger.error "failure in XML output:\n#{e.to_s}\n" + e.backtrace.join("\n")
-      end
-    end
-
-    def summarize
-      fail_without_test_run
-
-      summary_logger = Logger.new(log_path("#{name}-summary.txt"), STDOUT)
-
-      summary_logger.notify <<-HEREDOC
-    Test Suite: #{name} @ #{@start_time}
-
-    - Host Configuration Summary -
-      HEREDOC
-
-      elapsed_time = @test_cases.inject(0.0) {|r, t| r + t.runtime.to_f }
-      average_test_time = elapsed_time / test_count
-
-      summary_logger.notify %Q[
-
-            - Test Case Summary for suite '#{name}' -
-     Total Suite Time: %.2f seconds
-    Average Test Time: %.2f seconds
-            Attempted: #{test_count}
-               Passed: #{passed_tests}
-               Failed: #{failed_tests}
-              Errored: #{errored_tests}
-              Skipped: #{skipped_tests}
-              Pending: #{pending_tests}
-
-    - Specific Test Case Status -
-      ] % [elapsed_time, average_test_time]
-
-      grouped_summary = @test_cases.group_by{|test_case| test_case.test_status }
-
-      summary_logger.notify "Failed Tests Cases:"
-      (grouped_summary[:fail] || []).each do |test_case|
-        print_test_failure(test_case)
-      end
-
-      summary_logger.notify "Errored Tests Cases:"
-      (grouped_summary[:error] || []).each do |test_case|
-        print_test_failure(test_case)
-      end
-
-      summary_logger.notify "Skipped Tests Cases:"
-      (grouped_summary[:skip] || []).each do |test_case|
-        print_test_failure(test_case)
-      end
-
-      summary_logger.notify "Pending Tests Cases:"
-      (grouped_summary[:pending] || []).each do |test_case|
-        print_test_failure(test_case)
-      end
-
-      summary_logger.notify("\n\n")
-    end
-
-    def print_test_failure(test_case)
-      test_reported = if test_case.exception
-                        "reported: #{test_case.exception.inspect}"
-                      else
-                        test_case.test_status
-                      end
-      @logger.notify "  Test Case #{test_case.path} #{test_reported}"
-    end
-
-    def log_path(name)
-      @@log_dir ||= File.join("log", @start_time.strftime("%F_%H_%M_%S"))
-      unless File.directory?(@@log_dir) then
-        FileUtils.mkdir_p(@@log_dir)
-
-        latest = File.join("log", "latest")
+    #Create a full file path for output to be written to, using the provided timestamp, name and output directory.
+    #@param [Time] timestamp The time that we are making this path with
+    #@param [String] name The file name that we want to write to.
+    #@param [String] basedir The desired output directory.  A subdirectory tagged with the time will be created which will contain
+    #                        the output file (./basedir/timestamp/).  
+    #                        A symlink will be made from that to ./basedir/timestamp/latest.
+    #@example
+    #  log_path('2014-06-02 16:31:22 -0700','output.txt', 'log')
+    #
+    #    This will create the structure:
+    #
+    #  ./log/2014-06-02_16_31_22/output.txt
+    #  ./log/latest -> 2014-06-02_16_31_22
+    def log_path(timestamp, name, basedir)
+      log_dir = File.join(basedir, timestamp.strftime("%F_%H_%M_%S"))
+      unless File.directory?(log_dir) then
+        FileUtils.mkdir_p(log_dir)
+
+        latest = File.join(basedir, "latest")
         if !File.exist?(latest) or File.symlink?(latest) then
           File.delete(latest) if File.exist?(latest)
-          File.symlink(File.basename(@@log_dir), latest)
+          File.symlink(File.basename(log_dir), latest)
         end
       end
 
-      File.join('log', 'latest', name)
+      File.join(basedir, 'latest', name)
     end
 
-    # Setup log dir
-    def configure_logging
-      @logger.add_destination(log_path("#{@name}-run.log"))
-      #
-      # This is an awful hack to maintain backward compatibility until tests
-      # are ported to use logger.
-      Beaker.const_set(:Log, @logger) unless defined?( Log )
-    end
   end
 end