beaker 4.40.0 → 5.0.0

data/lib/beaker/test_suite.rb

@@ -1,29 +1,27 @@
-# -*- coding: utf-8 -*-
 require 'fileutils'
-[ 'test_case', 'logger', 'test_suite_result'].each do |lib|
+%w[test_case logger test_suite_result].each do |lib|
   require "beaker/#{lib}"
 end
 
 module Beaker
-  #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.
+  # 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
-
     attr_reader :name, :options, :fail_mode
 
-    #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=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 = nil)
       @logger     = options[:logger]
       @test_cases = []
       @test_files = options[name]
@@ -36,26 +34,25 @@ module Beaker
       @timestamp = timestamp
 
       report_and_raise(@logger, RuntimeError.new("#{@name}: no test files found..."), "TestSuite: initialize") if @test_files.empty?
-
     rescue => e
       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.
+    # 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
 
-      #Create a run log for this TestSuite.
+      # Create a run log for this TestSuite.
       run_log = log_path("#{@name}-run.log", @options[:log_dated_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 )
+      Beaker.const_set(:Log, @logger) unless defined?(Log)
 
       @test_suite_results.start_time = start_time
       @test_suite_results.total_tests = @test_files.length
@@ -77,10 +74,10 @@ module Beaker
           @logger.warn msg
         when :fail
           @logger.error msg
-          break if !@fail_mode.to_s.include?('slow') #all failure modes except slow cause us to kick out early on failure
+          break if !@fail_mode.to_s.include?('slow') # all failure modes except slow cause us to kick out early on failure
         when :error
           @logger.warn msg
-          break if !@fail_mode.to_s.include?('slow') #all failure modes except slow cause us to kick out early on failure
+          break if !@fail_mode.to_s.include?('slow') # all failure modes except slow cause us to kick out early on failure
         end
       end
       @test_suite_results.stop_time = Time.now
@@ -88,37 +85,37 @@ module Beaker
       # 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
-      @test_suite_results.summarize( Logger.new(log_path("#{name}-summary.txt", @options[:log_dated_dir]), STDOUT) )
+      @test_suite_results.summarize(Logger.new(log_path("#{name}-summary.txt", @options[:log_dated_dir]), STDOUT))
 
-      junit_file_log  = log_path(@options[:xml_file], @options[:xml_dated_dir])
+      junit_file_log = log_path(@options[:xml_file], @options[:xml_dated_dir])
       if @options[:xml_time_enabled]
         junit_file_time = log_path(@options[:xml_time], @options[:xml_dated_dir])
-        @test_suite_results.write_junit_xml( junit_file_log, @options[:xml_time] )
-        @test_suite_results.write_junit_xml( junit_file_time, @options[:xml_file], true )
+        @test_suite_results.write_junit_xml(junit_file_log, @options[:xml_time])
+        @test_suite_results.write_junit_xml(junit_file_time, @options[:xml_file], true)
       else
-        @test_suite_results.write_junit_xml( junit_file_log )
+        @test_suite_results.write_junit_xml(junit_file_log)
       end
 
       @test_suite_results.persist_test_results(@options[:test_results_file])
 
-      #All done with this run, remove run log
+      # 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.
+    # 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 @test_suite_results.success?
       rescue => e
-        #failed during run
+        # failed during run
         report_and_raise(@logger, e, "TestSuite :run_and_raise_on_failure")
       else
-        #failed during test
+        # failed during test
         report_and_raise(@logger, RuntimeError.new("Failed while running the #{name} suite"), "TestSuite: report_and_raise_on_failure")
       end
     end
@@ -147,7 +144,7 @@ module Beaker
 
       base_dir = log_dir
       link_dir = ''
-      while File.dirname(base_dir) != '.' do
+      while File.dirname(base_dir) != '.'
         link_dir = link_dir == '' ? File.basename(base_dir) : File.join(File.basename(base_dir), link_dir)
         base_dir = File.dirname(base_dir)
       end
@@ -160,6 +157,5 @@ module Beaker
 
       File.join(log_dir, name)
     end
-
   end
 end

data/lib/beaker/test_suite_result.rb

@@ -1,94 +1,92 @@
-# -*- coding: utf-8 -*-
 require 'fileutils'
-[ 'test_case', 'logger' , 'test_suite', 'logger_junit'].each do |lib|
+%w[test_case logger test_suite logger_junit].each do |lib|
   require "beaker/#{lib}"
 end
 
 module Beaker
-  #Holds the output of a test suite, formats in plain text or xml
+  # Holds the output of a test suite, formats in plain text or xml
   class TestSuiteResult
     attr_accessor :start_time, :stop_time, :total_tests
 
-    #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 )
+    # 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 = []
     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 )
+    # 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}
+    # How many {TestCase} instances are in this {TestSuiteResult}
     def test_count
       @test_cases.length
     end
 
-    #How many passed {TestCase} instances are in this {TestSuiteResult}
+    # How many passed {TestCase} instances are in this {TestSuiteResult}
     def passed_tests
       @test_cases.count { |c| c.test_status == :pass }
     end
 
-    #How many errored {TestCase} instances are in this {TestSuiteResult}
+    # How many errored {TestCase} instances are in this {TestSuiteResult}
     def errored_tests
       @test_cases.count { |c| c.test_status == :error }
     end
 
-    #How many failed {TestCase} instances are in this {TestSuiteResult}
+    # How many failed {TestCase} instances are in this {TestSuiteResult}
     def failed_tests
       @test_cases.count { |c| c.test_status == :fail }
     end
 
-    #How many skipped {TestCase} instances are in this {TestSuiteResult}
+    # How many skipped {TestCase} instances are in this {TestSuiteResult}
     def skipped_tests
       @test_cases.count { |c| c.test_status == :skip }
     end
 
-    #How many pending {TestCase} instances are in this {TestSuiteResult}
+    # How many pending {TestCase} instances are in this {TestSuiteResult}
     def pending_tests
-      @test_cases.count {|c| c.test_status == :pending}
+      @test_cases.count { |c| c.test_status == :pending }
     end
 
-    #How many {TestCase} instances failed in this {TestSuiteResult}
+    # 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?
+    # 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?
+    # Did one or more {TestCase} instances in this {TestSuiteResult} fail?
     def failed?
       !success?
     end
 
-    #The sum of all {TestCase} runtimes in this {TestSuiteResult}
+    # The sum of all {TestCase} runtimes in this {TestSuiteResult}
     def elapsed_time
-      @test_cases.inject(0.0) {|r, t| r + t.runtime.to_f }
+      @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
+    # 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
+      HEREDOC
 
       average_test_time = elapsed_time / test_count
 
-      summary_logger.notify %Q[
+      summary_logger.notify format(%[
 
               - Test Case Summary for suite '#{@name}' -
        Total Suite Time: %.2f seconds
@@ -102,9 +100,9 @@ module Beaker
                   Total: #{@total_tests}
 
       - Specific Test Case Status -
-        ] % [elapsed_time, average_test_time]
+        ], elapsed_time, average_test_time)
 
-      grouped_summary = @test_cases.group_by{|test_case| test_case.test_status }
+      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|
@@ -129,8 +127,8 @@ module Beaker
       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
+    # 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)
       if test_case.exception
         test_file_trace = ""
@@ -154,7 +152,7 @@ module Beaker
     def persist_test_results(filepath)
       return if filepath.empty?
 
-      results = @test_cases.select { |c| [:fail, :error].include? c.test_status }.map(&:path)
+      results = @test_cases.select { |c| %i[fail error].include? c.test_status }.map(&:path)
       File.open(filepath, 'w') { |file| file.puts JSON.dump(results) }
     end
 
@@ -176,44 +174,45 @@ module Beaker
 
       begin
         LoggerJunit.write_xml(xml_file, stylesheet) do |_doc, suites|
-
           meta_info = suites.add_element(REXML::Element.new('meta_test_info'))
-          unless file_to_link.nil?
-            time_sort ? meta_info.add_attribute('page_active', 'performance') : meta_info.add_attribute('page_active', 'execution')
-            meta_info.add_attribute('link_url', file_to_link)
-          else
+          if file_to_link.nil?
             meta_info.add_attribute('page_active', 'no-links')
             meta_info.add_attribute('link_url', '')
+          else
+            time_sort ? meta_info.add_attribute('page_active', 'performance') : meta_info.add_attribute('page_active', 'execution')
+            meta_info.add_attribute('link_url', file_to_link)
           end
 
           suite = suites.add_element(REXML::Element.new('testsuite'))
           suite.add_attributes(
             [
-              ['name' , @name],
+              ['name', @name],
               ['tests', test_count],
               ['errors', errored_tests],
               ['failures', failed_tests],
               ['skipped', skipped_tests],
               ['pending', pending_tests],
               ['total', @total_tests],
-              ['time', "%f" % (stop_time - start_time)]
-          ])
+              ['time', format("%f", (stop_time - start_time))],
+            ],
+          )
           properties = suite.add_element(REXML::Element.new('properties'))
-          @options.each_pair do |name,value|
+          @options.each_pair do |name, value|
             property = properties.add_element(REXML::Element.new('property'))
             property.add_attributes([['name', name], ['value', value.to_s || '']])
           end
 
           test_cases_to_report = @test_cases
-          test_cases_to_report = @test_cases.sort { |x,y| y.runtime <=> x.runtime } if time_sort
+          test_cases_to_report = @test_cases.sort { |x, y| y.runtime <=> x.runtime } if time_sort
           test_cases_to_report.each do |test|
             item = suite.add_element(REXML::Element.new('testcase'))
             item.add_attributes(
               [
                 ['classname', File.dirname(test.path)],
                 ['name', File.basename(test.path)],
-                ['time', "%f" % test.runtime]
-              ])
+                ['time', "%f" % test.runtime],
+              ],
+            )
 
             test.exports.each do |export|
               export.keys.each do |key|
@@ -221,7 +220,7 @@ module Beaker
               end
             end
 
-            #Report failures
+            # Report failures
             if test.test_status == :fail || test.test_status == :error
               status = item.add_element(REXML::Element.new('failure'))
               status.add_attribute('type', test.test_status.to_s)
@@ -259,6 +258,5 @@ module Beaker
         @logger.error "failure in XML output: \n#{e}" + e.backtrace.join("\n")
       end
     end
-
   end
 end

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '4.40.0'
+    STRING = '5.0.0'
   end
 end

data/lib/beaker.rb

@@ -1,11 +1,10 @@
 require 'rubygems' unless defined?(Gem)
 module Beaker
-
-  %w( version platform test_suite test_suite_result result command options network_manager cli perf logger_junit subcommand ).each do |lib|
+  %w(version platform test_suite test_suite_result result command options network_manager cli perf logger_junit subcommand).each do |lib|
     begin
       require "beaker/#{lib}"
     rescue LoadError
-      require File.expand_path(File.join(File.dirname(__FILE__), 'beaker', lib))
+      require File.expand_path(File.join(__dir__, 'beaker', lib))
     end
   end
   # These really are our sub-systems that live within the harness today
@@ -22,13 +21,13 @@ module Beaker
   require 'beaker/hypervisor'
   #
   # How we manage connecting to hosts and hypervisors
-  #require 'beaker/connectivity'
+  # require 'beaker/connectivity'
   #
   # Our test runner, suite, test cases and steps
-  #require 'beaker/runner'
+  # require 'beaker/runner'
   #
   # Common setup and testing steps
-  #require 'beaker/steps'
+  # require 'beaker/steps'
 
   # InParallel, for executing in parallel
   require 'in_parallel'