Class: Scan::Runner

Inherits:
Object
  • Object
show all
Defined in:
scan/lib/scan/runner.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Runner

Returns a new instance of Runner.



17
18
19
20
 
# File 'scan/lib/scan/runner.rb', line 17

def initialize
  @test_command_generator = TestCommandGenerator.new
  @device_boot_datetime = DateTime.now
end

Instance Method Details

#copy_simulator_logs ⇒ Object 



267
268
269
270
271
272
273
274
275
 
# File 'scan/lib/scan/runner.rb', line 267

def copy_simulator_logs
  return unless Scan.config[:include_simulator_logs]

  UI.header("Collecting system logs")
  Scan.devices.each do |device|
    log_identity = "#{device.name}_#{device.os_type}_#{device.os_version}"
    FastlaneCore::Simulator.copy_logs(device, log_identity, Scan.config[:output_directory], @device_boot_datetime)
  end
end

#copy_xctestrun ⇒ Object 



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
 
# File 'scan/lib/scan/runner.rb', line 207

def copy_xctestrun
  return unless Scan.config[:output_xctestrun]

  # Gets :derived_data_path/Build/Products directory for coping .xctestrun file
  derived_data_path = Scan.config[:derived_data_path]
  path = File.join(derived_data_path, "Build", "Products")

  # Gets absolute path of output directory
  output_directory = File.absolute_path(Scan.config[:output_directory])
  output_path = File.join(output_directory, "settings.xctestrun")

  # Caching path for action to put into lane_context
  Scan.cache[:output_xctestrun] = output_path

  # Copy .xctestrun file and moves it to output directory
  UI.message("Copying .xctestrun file")
  xctestrun_file = Dir.glob("#{path}/*.xctestrun").first

  if xctestrun_file
    FileUtils.cp(xctestrun_file, output_path)
    UI.message("Successfully copied xctestrun file: #{output_path}")
  else
    UI.user_error!("Could not find .xctextrun file to copy")
  end
end

#execute(retries: 0) ⇒ Object 



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
86
87
88
89
90
91
92
93
94
95
96
 
# File 'scan/lib/scan/runner.rb', line 57

def execute(retries: 0)
  Scan.cache[:retry_attempt] = Scan.config[:number_of_retries] - retries

  command = @test_command_generator.generate

  prefix_hash = [
    {
      prefix: "Running Tests: ",
      block: proc do |value|
        value.include?("Touching")
      end
    }
  ]
  exit_status = 0

  FastlaneCore::CommandExecutor.execute(command: command,
                                      print_all: true,
                                  print_command: true,
                                         prefix: prefix_hash,
                                        loading: "Loading...",
                                suppress_output: Scan.config[:suppress_xcode_output],
                                          error: proc do |error_output|
                                            begin
                                              exit_status = $?.exitstatus
                                              if retries > 0
                                                # If there are retries remaining, run the tests again
                                                return retry_execute(retries: retries, error_output: error_output)
                                              else
                                                ErrorHandler.handle_build_error(error_output, @test_command_generator.xcodebuild_log_path)
                                              end
                                            rescue => ex
                                              SlackPoster.new.run({
                                                build_errors: 1
                                              })
                                              raise ex
                                            end
                                          end)

  exit_status
end

#force_quit_simulator_processes ⇒ Object 



277
278
279
280
 
# File 'scan/lib/scan/runner.rb', line 277

def force_quit_simulator_processes
  # Silently execute and kill, verbose flags will show this command occurring
  Fastlane::Actions.sh("killall Simulator &> /dev/null || true", log: false)
end

#handle_results(tests_exit_status) ⇒ Object 



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
170
171
172
173
174
175
176
177
178
179
 
# File 'scan/lib/scan/runner.rb', line 138

def handle_results(tests_exit_status)
  if Scan.config[:disable_xcpretty]
    unless tests_exit_status == 0
      UI.test_failure!("Test execution failed. Exit status: #{tests_exit_status}")
    end
    return
  end

  result = TestResultParser.new.parse_result(test_results)
  SlackPoster.new.run(result)

  if result[:failures] > 0
    failures_str = result[:failures].to_s.red
  else
    failures_str = result[:failures].to_s.green
  end

  puts(Terminal::Table.new({
    title: "Test Results",
    rows: [
      ["Number of tests", result[:tests]],
      ["Number of failures", failures_str]
    ]
  }))
  puts("")

  copy_simulator_logs
  zip_build_products
  copy_xctestrun

  if result[:failures] > 0
    open_report

    UI.test_failure!("Tests have failed")
  end

  unless tests_exit_status == 0
    UI.test_failure!("Test execution failed. Exit status: #{tests_exit_status}")
  end

  open_report
end

#open_report ⇒ Object 



181
182
183
184
185
 
# File 'scan/lib/scan/runner.rb', line 181

def open_report
  if !Helper.ci? && Scan.cache[:open_html_report_path]
    `open --hide '#{Scan.cache[:open_html_report_path]}'`
  end
end

#prelaunch_simulators ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'scan/lib/scan/runner.rb', line 249

def prelaunch_simulators
  return unless Scan.devices.to_a.size > 0 # no devices selected, no sims to launch

  # Return early unless the user wants to prelaunch simulators. Or if the user wants simulator logs
  # then we must prelaunch simulators because Xcode's headless
  # mode launches and shutsdown the simulators before we can collect the logs.
  return unless Scan.config[:prelaunch_simulator] || Scan.config[:include_simulator_logs]

  devices_to_shutdown = []
  Scan.devices.each do |device|
    devices_to_shutdown << device if device.state == "Shutdown"
    device.boot
  end
  at_exit do
    devices_to_shutdown.each(&:shutdown)
  end
end

#retry_execute(retries:, error_output: "") ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'scan/lib/scan/runner.rb', line 98

def retry_execute(retries:, error_output: "")
  tests = retryable_tests(error_output)

  if tests.empty?
    UI.crash!("Failed to find failed tests to retry (could not parse error output)")
  end

  Scan.config[:only_testing] = tests
  UI.important("Retrying tests: #{Scan.config[:only_testing].join(', ')}")

  retries -= 1
  UI.important("Number of retries remaining: #{retries}")

  return execute(retries: retries)
end

#retryable_tests(input) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'scan/lib/scan/runner.rb', line 114

def retryable_tests(input)
  input = Helper.strip_ansi_colors(input)

  retryable_tests = []

  failing_tests = input.split("Failing tests:\n").fetch(1, [])
                       .split("\n\n").first

  suites = failing_tests.split(/(?=\n\s+[\w\s]+:\n)/)

  suites.each do |suite|
    suite_name = suite.match(/\s*([\w\s\S]+):/).captures.first

    test_cases = suite.split(":\n").fetch(1, []).split("\n").each
                      .select { |line| line.match?(/^\s+/) }
                      .map { |line| line.strip.gsub(".", "/").gsub("()", "") }
                      .map { |line| suite_name + "/" + line }

    retryable_tests += test_cases
  end

  return retryable_tests.uniq
end

#run ⇒ Object 



22
23
24
 
# File 'scan/lib/scan/runner.rb', line 22

def run
  handle_results(test_app)
end

#test_app ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'scan/lib/scan/runner.rb', line 26

def test_app
  force_quit_simulator_processes if Scan.config[:force_quit_simulator]

  if Scan.devices
    if Scan.config[:reset_simulator]
      Scan.devices.each do |device|
        FastlaneCore::Simulator.reset(udid: device.udid)
      end
    end

    if Scan.config[:disable_slide_to_type]
      Scan.devices.each do |device|
        FastlaneCore::Simulator.disable_slide_to_type(udid: device.udid)
      end
    end
  end

  prelaunch_simulators

  if Scan.config[:reinstall_app]
    app_identifier = Scan.config[:app_identifier]
    app_identifier ||= UI.input("App Identifier: ")

    Scan.devices.each do |device|
      FastlaneCore::Simulator.uninstall_app(app_identifier, device.name, device.udid)
    end
  end

  execute(retries: Scan.config[:number_of_retries])
end

#test_results ⇒ Object 



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'scan/lib/scan/runner.rb', line 233

def test_results
  temp_junit_report = Scan.cache[:temp_junit_report]
  return File.read(temp_junit_report) if temp_junit_report && File.file?(temp_junit_report)

  # Something went wrong with the temp junit report for the test success/failures count.
  # We'll have to regenerate from the xcodebuild log, like we did before version 2.34.0.
  UI.message("Generating test results. This may take a while for large projects.")

  reporter_options_generator = XCPrettyReporterOptionsGenerator.new(false, [], [], "", false, nil)
  reporter_options = reporter_options_generator.generate_reporter_options
  xcpretty_args_options = reporter_options_generator.generate_xcpretty_args_options
  cmd = "cat #{@test_command_generator.xcodebuild_log_path.shellescape} | xcpretty #{reporter_options.join(' ')} #{xcpretty_args_options} &> /dev/null"
  system(cmd)
  File.read(Scan.cache[:temp_junit_report])
end

#zip_build_products ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'scan/lib/scan/runner.rb', line 187

def zip_build_products
  return unless Scan.config[:should_zip_build_products]

  # Gets :derived_data_path/Build/Products directory for zipping zip
  derived_data_path = Scan.config[:derived_data_path]
  path = File.join(derived_data_path, "Build/Products")

  # Gets absolute path of output directory
  output_directory = File.absolute_path(Scan.config[:output_directory])
  output_path = File.join(output_directory, "build_products.zip")

  # Caching path for action to put into lane_context
  Scan.cache[:zip_build_products_path] = output_path

  # Zips build products and moves it to output directory
  UI.message("Zipping build products")
  FastlaneCore::Helper.zip_directory(path, output_path, contents_only: true, overwrite: true, print: false)
  UI.message("Successfully zipped build products: #{output_path}")
end