Class: PDK::Test::Unit
- Inherits:
-
Object
- Object
- PDK::Test::Unit
- Defined in:
- lib/pdk/tests/unit.rb
Class Method Summary collapse
- .cmd(tests, opts = {}) ⇒ Object
- .invoke(report, options = {}) ⇒ Object
-
.list ⇒ Object
Array of { :id, :full_description }.
- .merge_json_results(json_data, duration) ⇒ Object
- .parallel_with_no_tests?(ran_in_parallel, json_result, result) ⇒ Boolean
- .parse_output(report, json_data) ⇒ Object
- .print_failure(result, exception) ⇒ Object
- .rake(task, spinner_text, environment = {}) ⇒ Object
- .rake_bin ⇒ Object
- .setup ⇒ Object
- .tear_down ⇒ Object
Class Method Details
.cmd(tests, opts = {}) ⇒ Object
9 10 11 12 13 |
# File 'lib/pdk/tests/unit.rb', line 9 def self.cmd(tests, opts = {}) rake_args = opts.key?(:parallel) ? 'parallel_spec_standalone' : 'spec_standalone' rake_args += "[#{tests}]" unless tests.nil? rake_args end |
.invoke(report, options = {}) ⇒ Object
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/pdk/tests/unit.rb', line 66 def self.invoke(report, = {}) PDK::Util::Bundler.ensure_binstubs!('rake', 'rspec-core') setup tests = .fetch(:tests) spinner_msg = .key?(:parallel) ? _('Running unit tests in parallel.') : _('Running unit tests.') result = rake(cmd(tests, ), spinner_msg, 'CI_SPEC_OPTIONS' => '--format j') json_result = if .key?(:parallel) PDK::Util.find_all_json_in(result[:stdout]) else PDK::Util.find_first_json_in(result[:stdout]) end if parallel_with_no_tests?(.key?(:parallel), json_result, result) json_result = [{ 'messages' => ['No examples found.'] }] result[:exit_code] = 0 end raise PDK::CLI::FatalError, _('Unit test output did not contain a valid JSON result: %{output}') % { output: result[:stdout] } if json_result.nil? || json_result.empty? json_result = merge_json_results(json_result, result[:duration]) if .key?(:parallel) parse_output(report, json_result) result[:exit_code] ensure tear_down if [:'clean-fixtures'] end |
.list ⇒ Object
Returns array of { :id, :full_description }.
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 |
# File 'lib/pdk/tests/unit.rb', line 184 def self.list PDK::Util::Bundler.ensure_binstubs!('rake') command_argv = [File.join(PDK::Util.module_root, 'bin', 'rake'), 'spec_list_json'] command_argv.unshift(File.join(PDK::Util::RubyVersion.bin_path, 'ruby.exe')) if Gem.win_platform? list_command = PDK::CLI::Exec::Command.new(*command_argv) list_command.context = :module output = list_command.execute! rspec_json = PDK::Util.find_first_json_in(output[:stdout]) raise PDK::CLI::FatalError, _('Failed to find valid JSON in output from rspec: %{output}' % { output: output[:stdout] }) unless rspec_json if rspec_json['examples'].empty? = rspec_json['messages'][0] return [] if == 'No examples found.' raise PDK::CLI::FatalError, _('Unable to enumerate examples. rspec reported: %{message}' % { message: }) else examples = [] rspec_json['examples'].each do |example| examples << { file_path: example['file_path'], id: example['id'], full_description: example['full_description'] } end examples end end |
.merge_json_results(json_data, duration) ⇒ Object
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/pdk/tests/unit.rb', line 146 def self.merge_json_results(json_data, duration) merged_json_result = {} # Merge messages = Set.new json_data.each do |json| next unless json['messages'] |= json['messages'] end merged_json_result['messages'] = .to_a # Merge examples all_examples = [] json_data.each do |json| next unless json['examples'] all_examples.concat json['examples'] end merged_json_result['examples'] = all_examples # Merge summaries summary_hash = { 'duration' => duration, 'example_count' => 0, 'failure_count' => 0, 'pending_count' => 0, } json_data.each do |json| next unless json['summary'] summary_hash['example_count'] += json['summary']['example_count'] summary_hash['failure_count'] += json['summary']['failure_count'] summary_hash['pending_count'] += json['summary']['pending_count'] end merged_json_result['summary'] = summary_hash merged_json_result end |
.parallel_with_no_tests?(ran_in_parallel, json_result, result) ⇒ Boolean
32 33 34 35 36 |
# File 'lib/pdk/tests/unit.rb', line 32 def self.parallel_with_no_tests?(ran_in_parallel, json_result, result) ran_in_parallel && json_result.empty? && ((!result[:exit_code].zero? && result[:stderr].strip =~ %r{Pass files or folders to run$}) || result[:stderr].strip =~ %r{No files for parallel_spec to run against$}) end |
.parse_output(report, json_data) ⇒ Object
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 139 140 141 142 143 144 |
# File 'lib/pdk/tests/unit.rb', line 97 def self.parse_output(report, json_data) # Output messages to stderr. json_data['messages'] && json_data['messages'].each { |msg| $stderr.puts msg } example_results = { # Only possibilities are passed, failed, pending: # https://github.com/rspec/rspec-core/blob/master/lib/rspec/core/example.rb#L548 'passed' => [], 'failed' => [], 'pending' => [], } json_data['examples'] && json_data['examples'].each do |ex| example_results[ex['status']] << ex if example_results.key?(ex['status']) end example_results.each do |result, examples| # Translate rspec example results to JUnit XML testcase results state = case result when 'passed' then :passed when 'failed' then :failure when 'pending' then :skipped end examples.each do |ex| report.add_event( source: 'rspec', state: state, file: ex['file_path'], line: ex['line_number'], test: ex['full_description'], severity: ex['status'], message: ex['pending_message'] || (ex['exception'] && ex['exception']['message']) || nil, trace: (ex['exception'] && ex['exception']['backtrace']) || nil, ) end end return unless json_data['summary'] # TODO: standardize summary output $stderr.puts ' ' << _('Evaluated %{total} tests in %{duration} seconds: %{failures} failures, %{pending} pending.') % { total: json_data['summary']['example_count'], duration: json_data['summary']['duration'], failures: json_data['summary']['failure_count'], pending: json_data['summary']['pending_count'], } end |
.print_failure(result, exception) ⇒ Object
38 39 40 41 42 43 44 |
# File 'lib/pdk/tests/unit.rb', line 38 def self.print_failure(result, exception) $stderr.puts '' result[:stdout].each_line { |line| $stderr.puts line.rstrip } unless result[:stdout].nil? result[:stderr].each_line { |line| $stderr.puts line.rstrip } unless result[:stderr].nil? $stderr.puts '' raise PDK::CLI::FatalError, exception end |
.rake(task, spinner_text, environment = {}) ⇒ Object
19 20 21 22 23 24 25 26 27 28 29 30 |
# File 'lib/pdk/tests/unit.rb', line 19 def self.rake(task, spinner_text, environment = {}) argv = [rake_bin, task] argv.unshift(File.join(PDK::Util::RubyVersion.bin_path, 'ruby.exe')) if Gem.win_platform? command = PDK::CLI::Exec::Command.new(*argv).tap do |c| c.context = :module c.add_spinner(spinner_text) c.environment = environment end command.execute! end |
.rake_bin ⇒ Object
15 16 17 |
# File 'lib/pdk/tests/unit.rb', line 15 def self.rake_bin @rake ||= File.join(PDK::Util.module_root, 'bin', 'rake') end |
.setup ⇒ Object
55 56 57 58 59 60 61 62 63 64 |
# File 'lib/pdk/tests/unit.rb', line 55 def self.setup result = rake('spec_prep', _('Preparing to run the unit tests.')) return if result[:exit_code].zero? tear_down PDK.logger.error(_('The spec_prep rake task failed with the following error(s):')) print_failure(result, _('Failed to prepare to run the unit tests.')) end |
.tear_down ⇒ Object
46 47 48 49 50 51 52 53 |
# File 'lib/pdk/tests/unit.rb', line 46 def self.tear_down result = rake('spec_clean', _('Cleaning up after running unit tests.')) return if result[:exit_code].zero? PDK.logger.error(_('The spec_clean rake task failed with the following error(s):')) print_failure(result, _('Failed to clean up after running unit tests')) end |