Class: TestCenter::Helper::CorrectingScanHelper

Inherits:
Object
  • Object
show all
Defined in:
lib/fastlane/plugin/test_center/helper/correcting_scan_helper.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(multi_scan_options) ⇒ CorrectingScanHelper

Returns a new instance of CorrectingScanHelper.



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/fastlane/plugin/test_center/helper/correcting_scan_helper.rb', line 9

def initialize(multi_scan_options)
  @batch_count = multi_scan_options[:batch_count] || 1
  @output_directory = multi_scan_options[:output_directory] || 'test_results'
  @try_count = multi_scan_options[:try_count]
  @retry_total_count = 0
  @testrun_completed_block = multi_scan_options[:testrun_completed_block]
  @given_custom_report_file_name = multi_scan_options[:custom_report_file_name]
  @given_output_types = multi_scan_options[:output_types]
  @given_output_files = multi_scan_options[:output_files]
  @scan_options = multi_scan_options.reject do |option, _|
    %i[
      output_directory
      only_testing
      skip_testing
      clean
      try_count
      batch_count
      custom_report_file_name
      fail_build
      testrun_completed_block
    ].include?(option)
  end
  @scan_options[:clean] = false
  @test_collector = TestCollector.new(multi_scan_options)
end

Instance Attribute Details

#retry_total_count ⇒ Object (readonly)

Returns the value of attribute retry_total_count.



7
8
9
 
# File 'lib/fastlane/plugin/test_center/helper/correcting_scan_helper.rb', line 7

def retry_total_count
  @retry_total_count
end

Instance Method Details

#collate_reports(output_directory, reportnamer) ⇒ Object 



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
 
# File 'lib/fastlane/plugin/test_center/helper/correcting_scan_helper.rb', line 94

def collate_reports(output_directory, reportnamer)
  report_files = Dir.glob("#{output_directory}/#{reportnamer.junit_fileglob}").map do |relative_filepath|
    File.absolute_path(relative_filepath)
  end
  if report_files.size > 1
    config = FastlaneCore::Configuration.create(
      Fastlane::Actions::CollateJunitReportsAction.available_options,
      {
        reports: report_files.sort { |f1, f2| File.mtime(f1) <=> File.mtime(f2) },
        collated_report: File.absolute_path(File.join(output_directory, reportnamer.junit_reportname))
      }
    )
    Fastlane::Actions::CollateJunitReportsAction.run(config)
  end
  retried_junit_reportfiles = Dir.glob("#{output_directory}/#{reportnamer.junit_numbered_fileglob}")
  FileUtils.rm_f(retried_junit_reportfiles)

  if reportnamer.includes_html?
    report_files = Dir.glob("#{output_directory}/#{reportnamer.html_fileglob}").map do |relative_filepath|
      File.absolute_path(relative_filepath)
    end
    if report_files.size > 1
      config = FastlaneCore::Configuration.create(
        Fastlane::Actions::CollateHtmlReportsAction.available_options,
        {
          reports: report_files.sort { |f1, f2| File.mtime(f1) <=> File.mtime(f2) },
          collated_report: File.absolute_path(File.join(output_directory, reportnamer.html_reportname))
        }
      )
      Fastlane::Actions::CollateHtmlReportsAction.run(config)
    end
    retried_html_reportfiles = Dir.glob("#{output_directory}/#{reportnamer.html_numbered_fileglob}")
    FileUtils.rm_f(retried_html_reportfiles)
  end
end

#correcting_scan(scan_run_options, batch, reportnamer) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/fastlane/plugin/test_center/helper/correcting_scan_helper.rb', line 130

def correcting_scan(scan_run_options, batch, reportnamer)
  scan_options = @scan_options.merge(scan_run_options)
  try_count = 0
  tests_passed = true
  begin
    try_count += 1
    config = FastlaneCore::Configuration.create(
      Fastlane::Actions::ScanAction.available_options,
      scan_options.merge(reportnamer.scan_options)
    )
    quit_simulators
    Fastlane::Actions::ScanAction.run(config)
    @testrun_completed_block && @testrun_completed_block.call(
      testrun_info(batch, try_count, reportnamer, scan_options[:output_directory])
    )
    tests_passed = true
  rescue FastlaneCore::Interface::FastlaneTestFailure => e
    FastlaneCore::UI.verbose("Scan failed with #{e}")
    if try_count < @try_count
      @retry_total_count += 1

      info = testrun_info(batch, try_count, reportnamer, scan_options[:output_directory])
      @testrun_completed_block && @testrun_completed_block.call(
        info
      )
      scan_options[:only_testing] = info[:failed].map(&:shellescape)
      FastlaneCore::UI.message('Re-running scan on only failed tests')
      if @scan_options[:result_bundle]
        built_test_result, moved_test_result = test_result_bundlepaths(
          scan_options[:output_directory], reportnamer
        )
        FileUtils.mv(built_test_result, moved_test_result)
      end
      reportnamer.increment
      retry
    end
    tests_passed = false
  end
  tests_passed
end

#quit_simulators ⇒ Object 



195
196
197
198
199
200
201
202
203
 
# File 'lib/fastlane/plugin/test_center/helper/correcting_scan_helper.rb', line 195

def quit_simulators
  Fastlane::Actions.sh("killall -9 'iPhone Simulator' 'Simulator' 'SimulatorBridge' &> /dev/null || true", log: false)
  launchctl_list_count = 0
  while Fastlane::Actions.sh('launchctl list | grep com.apple.CoreSimulator.CoreSimulatorService || true', log: false) != ''
    break if (launchctl_list_count += 1) > 10
    Fastlane::Actions.sh('launchctl remove com.apple.CoreSimulator.CoreSimulatorService &> /dev/null || true', log: false)
    sleep(1)
  end
end

#scan ⇒ Object 



35
36
37
38
39
40
41
42
 
# File 'lib/fastlane/plugin/test_center/helper/correcting_scan_helper.rb', line 35

def scan
  tests_passed = true
  @testables_count = @test_collector.testables.size
  @test_collector.testables.each do |testable|
    tests_passed = scan_testable(testable) && tests_passed
  end
  tests_passed
end

#scan_testable(testable) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/fastlane/plugin/test_center/helper/correcting_scan_helper.rb', line 44

def scan_testable(testable)
  tests_passed = true
  reportnamer = ReportNameHelper.new(
    @given_output_types,
    @given_output_files,
    @given_custom_report_file_name
  )
  output_directory = @output_directory
  testable_tests = @test_collector.testables_tests[testable]
  if @batch_count > 1 || @testables_count > 1
    current_batch = 1
    testable_tests.each_slice((testable_tests.length / @batch_count.to_f).round).to_a.each do |tests_batch|
      if @testables_count > 1
        output_directory = File.join(@output_directory, "results-#{testable}")
      end
      FastlaneCore::UI.header("Starting test run on testable '#{testable}'")
      if @scan_options[:result_bundle]
        FastlaneCore::UI.message("Clearing out previous test_result bundles in #{output_directory}")
        FileUtils.rm_rf(Dir.glob("#{output_directory}/*.test_result"))
      end

      tests_passed = correcting_scan(
        {
          only_testing: tests_batch,
          output_directory: output_directory
        },
        current_batch,
        reportnamer
      ) && tests_passed
      current_batch += 1
      reportnamer.increment
    end
  else
    options = {
      output_directory: output_directory,
      only_testing: testable_tests
    }
    tests_passed = correcting_scan(options, 1, reportnamer) && tests_passed
  end
  collate_reports(output_directory, reportnamer)
  tests_passed
end

#test_result_bundlepaths(output_directory, reportnamer) ⇒ Object 



87
88
89
90
91
92
 
# File 'lib/fastlane/plugin/test_center/helper/correcting_scan_helper.rb', line 87

def test_result_bundlepaths(output_directory, reportnamer)
  [
    File.join(output_directory, @scan_options[:scheme]) + '.test_result',
    File.join(output_directory, @scan_options[:scheme]) + "_#{reportnamer.report_count}.test_result"
  ]
end

#testrun_info(batch, try_count, reportnamer, output_directory) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/fastlane/plugin/test_center/helper/correcting_scan_helper.rb', line 171

def testrun_info(batch, try_count, reportnamer, output_directory)
  report_filepath = File.join(output_directory, reportnamer.junit_last_reportname)
  config = FastlaneCore::Configuration.create(
    Fastlane::Actions::TestsFromJunitAction.available_options,
    {
      junit: File.absolute_path(report_filepath)
    }
  )
  junit_results = Fastlane::Actions::TestsFromJunitAction.run(config)

  info = {
    failed: junit_results[:failed],
    passing: junit_results[:passing],
    batch: batch,
    try_count: try_count,
    report_filepath: report_filepath
  }
  if reportnamer.includes_html?
    html_report_filepath = File.join(output_directory, reportnamer.html_last_reportname)
    info[:html_report_filepath] = html_report_filepath
  end
  info
end