Class: Beaker::TestSuite::TestSuiteResult

Inherits:
Object
  • Object
show all
Defined in:
lib/beaker/test_suite.rb

Overview

Holds the output of a test suite, formats in plain text or xml

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options, name) ⇒ TestSuiteResult

Create a Beaker::TestSuite::TestSuiteResult instance.

Parameters:

  • options (Hash{Symbol=>String}) —

    Options for this object

  • name (String) —

    The name of the Beaker::TestSuite that the results are for

Options Hash (options):

  • :logger (Logger) —

    The Logger object to report information to



21
22
23
24
25
26
27
28
29
 
# File 'lib/beaker/test_suite.rb', line 21

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

Instance Attribute Details

#start_time ⇒ Object

Returns the value of attribute start_time.



15
16
17
 
# File 'lib/beaker/test_suite.rb', line 15

def start_time
  @start_time
end

#stop_time ⇒ Object

Returns the value of attribute stop_time.



15
16
17
 
# File 'lib/beaker/test_suite.rb', line 15

def stop_time
  @stop_time
end

#total_tests ⇒ Object

Returns the value of attribute total_tests.



15
16
17
 
# File 'lib/beaker/test_suite.rb', line 15

def total_tests
  @total_tests
end

Instance Method Details

#add_test_case(test_case) ⇒ Object

Add a Beaker::TestCase to this Beaker::TestSuite::TestSuiteResult instance, used in calculating Beaker::TestSuite::TestSuiteResult data.

Parameters:



33
34
35
 
# File 'lib/beaker/test_suite.rb', line 33

def add_test_case( test_case )
  @test_cases << test_case
end

#elapsed_time ⇒ Object

The sum of all Beaker::TestCase runtimes in this Beaker::TestSuite::TestSuiteResult



83
84
85
 
# File 'lib/beaker/test_suite.rb', line 83

def elapsed_time
  @test_cases.inject(0.0) {|r, t| r + t.runtime.to_f }
end

#errored_tests ⇒ Object

How many errored Beaker::TestCase instances are in this Beaker::TestSuite::TestSuiteResult



48
49
50
 
# File 'lib/beaker/test_suite.rb', line 48

def errored_tests
  @test_cases.select { |c| c.test_status == :error }.length
end

#failed? ⇒ Boolean

Did one or more Beaker::TestCase instances in this Beaker::TestSuite::TestSuiteResult fail?

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/beaker/test_suite.rb', line 78

def failed?
  !success?
end

#failed_tests ⇒ Object

How many failed Beaker::TestCase instances are in this Beaker::TestSuite::TestSuiteResult



53
54
55
 
# File 'lib/beaker/test_suite.rb', line 53

def failed_tests
  @test_cases.select { |c| c.test_status == :fail }.length
end

#passed_tests ⇒ Object

How many passed Beaker::TestCase instances are in this Beaker::TestSuite::TestSuiteResult



43
44
45
 
# File 'lib/beaker/test_suite.rb', line 43

def passed_tests
  @test_cases.select { |c| c.test_status == :pass }.length
end

#pending_tests ⇒ Object

How many pending Beaker::TestCase instances are in this Beaker::TestSuite::TestSuiteResult



63
64
65
 
# File 'lib/beaker/test_suite.rb', line 63

def pending_tests
  @test_cases.select {|c| c.test_status == :pending}.length
end

#print_test_result(test_case) ⇒ Object

A convenience method for printing the results of a Beaker::TestCase

Parameters:



142
143
144
145
146
147
148
149
 
# File 'lib/beaker/test_suite.rb', line 142

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

#skipped_tests ⇒ Object

How many skipped Beaker::TestCase instances are in this Beaker::TestSuite::TestSuiteResult



58
59
60
 
# File 'lib/beaker/test_suite.rb', line 58

def skipped_tests
  @test_cases.select { |c| c.test_status == :skip }.length
end

#success? ⇒ Boolean

Did all the Beaker::TestCase instances in this Beaker::TestSuite::TestSuiteResult pass?

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/beaker/test_suite.rb', line 73

def success?
  sum_failed == 0
end

#sum_failed ⇒ Object

How many Beaker::TestCase instances failed in this Beaker::TestSuite::TestSuiteResult



68
69
70
 
# File 'lib/beaker/test_suite.rb', line 68

def sum_failed
  failed_tests + errored_tests
end

#summarize(summary_logger) ⇒ Object

Plain text summay of test suite

Parameters:

  • summary_logger (Logger) —

    The logger we will print the summary to



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/beaker/test_suite.rb', line 89

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}
            Total: #{@total_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

#test_count ⇒ Object

How many Beaker::TestCase instances are in this Beaker::TestSuite::TestSuiteResult



38
39
40
 
# File 'lib/beaker/test_suite.rb', line 38

def test_count
  @test_cases.length
end

#write_junit_xml(xml_file, file_to_link = nil, time_sort = false) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Writes Junit XML of this Beaker::TestSuite::TestSuiteResult

Parameters:

  • xml_file (String) —

    Path to the XML file (from Beaker’s running directory)

  • file_to_link (String) (defaults to: nil) —

    Path to the paired file that should be linked from this one (this is relative to the XML file itself, so it would just be the different file name if they’re in the same directory)

  • time_sort (Boolean) (defaults to: false) —

    Whether the test results should be output in order of time spent in the test, or in the order of test execution (default)

Returns:

  • nil



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/beaker/test_suite.rb', line 164

def write_junit_xml(xml_file, file_to_link = nil, time_sort = false)
  stylesheet = File.join(@options[:project_root], @options[:xml_stylesheet])

  begin
    LoggerJunit.write_xml(xml_file, stylesheet) do |doc, suites|

      meta_info = Nokogiri::XML::Node.new('meta_test_info', doc)
      unless file_to_link.nil?
        meta_info['page_active'] = time_sort ? 'performance' : 'execution'
        meta_info['link_url'] = file_to_link
      else
        meta_info['page_active'] = 'no-links'
        meta_info['link_url'] = ''
      end
      suites.add_child(meta_info)

      suite = Nokogiri::XML::Node.new('testsuite', doc)
      suite['name']     = @name
      suite['tests']    = test_count
      suite['errors']   = errored_tests
      suite['failures'] = failed_tests
      suite['skipped']     = skipped_tests
      suite['pending']  = pending_tests
      suite['total']    = @total_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_to_report = @test_cases
      test_cases_to_report = @test_cases.sort { |x,y| y.runtime <=> x.runtime } if time_sort
      test_cases_to_report.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

        #ugh. nokogiri!!!  item can't take a hash, let alone an array.
        test.exports.each do |export|
          export.keys.each do |key|
            item[key] = export[key]
          end
        end

        # 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/, '')
            data = LoggerJunit.format_cdata(test.exception.backtrace.join('\n'))
            status.add_child(status.document.create_cdata(data))
          end
          item.add_child(status)
        end

        if test.test_status == :skip
          status = Nokogiri::XML::Node.new('skipped', 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)
          data = LoggerJunit.format_cdata(test.sublog)
          stdout.add_child(stdout.document.create_cdata(data))
          item.add_child(stdout)
        end

        if test.last_result and test.last_result.stderr and not test.last_result.stderr.empty? then
          stderr = Nokogiri::XML::Node.new('system-err', doc)
          data = LoggerJunit.format_cdata(test.last_result.stderr)
          stderr.add_child(stderr.document.create_cdata(data))
          item.add_child(stderr)
        end

        suite.add_child(item)
      end
      suites.add_child(suite)
    end
  rescue Exception => e
    @logger.error "failure in XML output:\n#{e.to_s}\n" + e.backtrace.join("\n")
  end

end