Class: Screengrab::Runner

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

Constant Summary collapse

NEEDED_PERMISSIONS =
[
  'android.permission.READ_EXTERNAL_STORAGE',
  'android.permission.WRITE_EXTERNAL_STORAGE',
  'android.permission.CHANGE_CONFIGURATION'
].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(executor = FastlaneCore::CommandExecutor, config = Screengrab.config, android_env = Screengrab.android_environment) ⇒ Runner

Returns a new instance of Runner.


16
17
18
19
20
21
22
23
# File 'screengrab/lib/screengrab/runner.rb', line 16

def initialize(executor = FastlaneCore::CommandExecutor,
               config = Screengrab.config,
               android_env = Screengrab.android_environment)

  @executor = executor
  @config = config
  @android_env = android_env
end

Instance Attribute Details

#number_of_retriesObject

Returns the value of attribute number_of_retries


14
15
16
# File 'screengrab/lib/screengrab/runner.rb', line 14

def number_of_retries
  @number_of_retries
end

Instance Method Details

#clear_device_previous_screenshots(device_serial, device_screenshots_paths) ⇒ Object


153
154
155
156
157
158
159
160
161
162
163
# File 'screengrab/lib/screengrab/runner.rb', line 153

def clear_device_previous_screenshots(device_serial, device_screenshots_paths)
  UI.message('Cleaning screenshots on device')

  device_screenshots_paths.each do |device_path|
    if_device_path_exists(device_serial, device_path) do |path|
      run_adb_command("adb -s #{device_serial} shell rm -rf #{path}",
                      print_all: true,
                      print_command: true)
    end
  end
end

#clear_local_previous_screenshots(device_type_dir_name) ⇒ Object


121
122
123
124
125
126
127
128
129
130
131
132
# File 'screengrab/lib/screengrab/runner.rb', line 121

def clear_local_previous_screenshots(device_type_dir_name)
  if @config[:clear_previous_screenshots]
    UI.message("Clearing #{device_type_dir_name} within #{@config[:output_directory]}")

    # We'll clear the temporary directory where screenshots wind up after being pulled from
    # the device as well, in case those got stranded on a previous run/failure
    ['screenshots', device_type_dir_name].each do |dir_name|
      files = screenshot_file_names_in(@config[:output_directory], dir_name)
      File.delete(*files)
    end
  end
end

#determine_external_screenshots_path(device_serial) ⇒ Object


138
139
140
141
142
143
144
145
146
147
# File 'screengrab/lib/screengrab/runner.rb', line 138

def determine_external_screenshots_path(device_serial)
  # macOS evaluates $foo in `echo $foo` before executing the command,
  # Windows doesn't - hence the double backslash vs. single backslash
  command = Helper.windows? ? "shell echo \$EXTERNAL_STORAGE " : "shell echo \\$EXTERNAL_STORAGE"
  device_ext_storage = run_adb_command("adb -s #{device_serial} #{command}",
                                       print_all: true,
                                       print_command: true)
  device_ext_storage = device_ext_storage.strip
  File.join(device_ext_storage, @config[:app_package_name], 'screengrab')
end

#determine_internal_screenshots_pathObject


149
150
151
# File 'screengrab/lib/screengrab/runner.rb', line 149

def determine_internal_screenshots_path
  "/data/data/#{@config[:app_package_name]}/app_screengrab"
end

#grant_permissions(device_serial) ⇒ Object


209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'screengrab/lib/screengrab/runner.rb', line 209

def grant_permissions(device_serial)
  UI.message('Granting the permission necessary to change locales on the device')
  run_adb_command("adb -s #{device_serial} shell pm grant #{@config[:app_package_name]} android.permission.CHANGE_CONFIGURATION",
                  print_all: true,
                  print_command: true)

  device_api_version = run_adb_command("adb -s #{device_serial} shell getprop ro.build.version.sdk",
                                       print_all: true,
                                       print_command: true).to_i

  if device_api_version >= 23
    UI.message('Granting the permissions necessary to access device external storage')
    run_adb_command("adb -s #{device_serial} shell pm grant #{@config[:app_package_name]} android.permission.WRITE_EXTERNAL_STORAGE",
                    print_all: true,
                    print_command: true)
    run_adb_command("adb -s #{device_serial} shell pm grant #{@config[:app_package_name]} android.permission.READ_EXTERNAL_STORAGE",
                    print_all: true,
                    print_command: true)
  end
end

#if_device_path_exists(device_serial, device_path) ⇒ Object

Some device commands fail if executed against a device path that does not exist, so this helper method provides a way to conditionally execute a block only if the provided path exists on the device.


343
344
345
346
347
348
349
350
351
352
# File 'screengrab/lib/screengrab/runner.rb', line 343

def if_device_path_exists(device_serial, device_path)
  return if run_adb_command("adb -s #{device_serial} shell ls #{device_path}",
                            print_all: false,
                            print_command: false).include?('No such file')

  yield(device_path)
rescue
  # Some versions of ADB will have a non-zero exit status for this, which will cause the executor to raise.
  # We can safely ignore that and treat it as if it returned 'No such file'
end

#install_apks(device_serial, app_apk_path, tests_apk_path) ⇒ Object


183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'screengrab/lib/screengrab/runner.rb', line 183

def install_apks(device_serial, app_apk_path, tests_apk_path)
  UI.message('Installing app APK')
  apk_install_output = run_adb_command("adb -s #{device_serial} install -t -r #{app_apk_path.shellescape}",
                                       print_all: true,
                                       print_command: true)
  UI.user_error!("App APK could not be installed") if apk_install_output.include?("Failure [")

  UI.message('Installing tests APK')
  apk_install_output = run_adb_command("adb -s #{device_serial} install -t -r #{tests_apk_path.shellescape}",
                                       print_all: true,
                                       print_command: true)
  UI.user_error!("Tests APK could not be installed") if apk_install_output.include?("Failure [")
end

#move_pulled_screenshots(pull_dir, device_type_dir_name) ⇒ Object


309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'screengrab/lib/screengrab/runner.rb', line 309

def move_pulled_screenshots(pull_dir, device_type_dir_name)
  # Glob pattern that finds the pulled screenshots directory for each locale
  # Possible matches:
  #   [pull_dir]/en-US/images/screenshots
  #   [pull_dir]/screengrab/en-US/images/screenshots
  screenshots_dir_pattern = File.join(pull_dir, '**', "screenshots")

  Dir.glob(screenshots_dir_pattern, File::FNM_CASEFOLD).each do |screenshots_dir|
    src_screenshots = Dir.glob(File.join(screenshots_dir, '*.png'), File::FNM_CASEFOLD)

    # The :output_directory is the final location for the screenshots, so we begin by replacing
    # the temp directory portion of the path, with the output directory
    dest_dir = screenshots_dir.gsub(pull_dir, @config[:output_directory])

    # Different versions of adb are inconsistent about whether they will pull down the containing
    # directory for the screenshots, so we'll try to remove that path from the directory name when
    # creating the destination path.
    # See: https://github.com/fastlane/fastlane/pull/4915#issuecomment-236368649
    dest_dir = dest_dir.gsub(%r{(app_)?screengrab/}, '')

    # We then replace the last segment of the screenshots directory path with the device_type
    # specific name, as expected by supply
    #
    # (Moved to: fastlane/metadata/android/en-US/images/phoneScreenshots)
    dest_dir = File.join(File.dirname(dest_dir), device_type_dir_name)

    FileUtils.mkdir_p(dest_dir)
    FileUtils.cp_r(src_screenshots, dest_dir)
    UI.success("Screenshots copied to #{dest_dir}")
  end
end

#pull_screenshots_from_device(device_serial, device_screenshots_paths, device_type_dir_name) ⇒ Object


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
# File 'screengrab/lib/screengrab/runner.rb', line 270

def pull_screenshots_from_device(device_serial, device_screenshots_paths, device_type_dir_name)
  UI.message("Pulling captured screenshots from the device")
  starting_screenshot_count = screenshot_file_names_in(@config[:output_directory], device_type_dir_name).length

  UI.verbose("Starting screenshot count is: #{starting_screenshot_count}")

  # Make a temp directory into which to pull the screenshots before they are moved to their final location.
  # This makes directory cleanup easier, as the temp directory will be removed when the block completes.
  Dir.mktmpdir do |tempdir|
    device_screenshots_paths.each do |device_path|
      if_device_path_exists(device_serial, device_path) do |path|
        run_adb_command("adb -s #{device_serial} pull #{path} #{tempdir}",
                        print_all: false,
                        print_command: true)
      end
    end

    # The SDK can't 100% determine what kind of device it is running on relative to the categories that
    # supply and Google Play care about (phone, 7" tablet, TV, etc.).
    #
    # Therefore, we'll move the pulled screenshots from their genericly named folder to one named by the
    # user provided device_type option value to match the directory structure that supply expects
    move_pulled_screenshots(tempdir, device_type_dir_name)
  end

  ending_screenshot_count = screenshot_file_names_in(@config[:output_directory], device_type_dir_name).length

  UI.verbose("Ending screenshot count is: #{ending_screenshot_count}")

  # Because we can't guarantee the screenshot output directory will be empty when we pull, we determine
  # success based on whether there are more screenshots there than when we started.
  if starting_screenshot_count == ending_screenshot_count
    UI.error("Make sure you've used Screengrab.screenshot() in your tests and that your expected tests are being run.")
    UI.abort_with_message!("No screenshots were detected 📷❌")
  end

  ending_screenshot_count - starting_screenshot_count
end

#runObject


25
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'screengrab/lib/screengrab/runner.rb', line 25

def run
  FastlaneCore::PrintTable.print_values(config: @config, hide_keys: [], title: "Summary for screengrab #{Fastlane::VERSION}")

  app_apk_path = @config.fetch(:app_apk_path, ask: false)
  tests_apk_path = @config.fetch(:tests_apk_path, ask: false)
  discovered_apk_paths = Dir[File.join('**', '*.apk')]

  apk_paths_provided = app_apk_path && !app_apk_path.empty? && tests_apk_path && !tests_apk_path.empty?

  unless apk_paths_provided || discovered_apk_paths.any?
    UI.error('No APK paths were provided and no APKs could be found')
    UI.error("Please provide APK paths with 'app_apk_path' and 'tests_apk_path' and make sure you have assembled APKs prior to running this command.")
    return
  end

  test_classes_to_use = @config[:use_tests_in_classes]
  test_packages_to_use = @config[:use_tests_in_packages]

  if test_classes_to_use && test_classes_to_use.any? && test_packages_to_use && test_packages_to_use.any?
    UI.error("'use_tests_in_classes' and 'use_tests_in_packages' can not be combined. Please use one or the other.")
    return
  end

  if (test_classes_to_use.nil? || test_classes_to_use.empty?) && (test_packages_to_use.nil? || test_packages_to_use.empty?)
    UI.important('Limiting the test classes run by `screengrab` to just those that generate screenshots can make runs faster.')
    UI.important('Consider using the :use_tests_in_classes or :use_tests_in_packages option, and organize your tests accordingly.')
  end

  device_type_dir_name = "#{@config[:device_type]}Screenshots"
  clear_local_previous_screenshots(device_type_dir_name)

  device_serial = select_device

  device_screenshots_paths = [
    determine_external_screenshots_path(device_serial),
    determine_internal_screenshots_path
  ]

  clear_device_previous_screenshots(device_serial, device_screenshots_paths)

  app_apk_path ||= select_app_apk(discovered_apk_paths)
  tests_apk_path ||= select_tests_apk(discovered_apk_paths)

  validate_apk(app_apk_path)

  run_tests(device_serial, app_apk_path, tests_apk_path, test_classes_to_use, test_packages_to_use, @config[:launch_arguments])

  number_of_screenshots = pull_screenshots_from_device(device_serial, device_screenshots_paths, device_type_dir_name)

  ReportsGenerator.new.generate

  UI.success("Captured #{number_of_screenshots} screenshots! 📷✨")
end

#run_adb_command(command, print_all: false, print_command: false) ⇒ Object


354
355
356
357
358
359
360
361
362
363
# File 'screengrab/lib/screengrab/runner.rb', line 354

def run_adb_command(command, print_all: false, print_command: false)
  adb_path = @android_env.adb_path.chomp("adb")
  output = @executor.execute(command: adb_path + command,
                             print_all: print_all,
                             print_command: print_command) || ''
  output.lines.reject do |line|
    # Debug/Warning output from ADB}
    line.start_with?('adb: ')
  end.join('') # Lines retain their newline chars
end

#run_tests(device_serial, app_apk_path, tests_apk_path, test_classes_to_use, test_packages_to_use, launch_arguments) ⇒ Object


230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
# File 'screengrab/lib/screengrab/runner.rb', line 230

def run_tests(device_serial, app_apk_path, tests_apk_path, test_classes_to_use, test_packages_to_use, launch_arguments)
  unless @config[:reinstall_app]
    install_apks(device_serial, app_apk_path, tests_apk_path)
    grant_permissions(device_serial)
  end

  @config[:locales].each do |locale|
    if @config[:reinstall_app]
      uninstall_apks(device_serial, @config[:app_package_name], @config[:tests_package_name])
      install_apks(device_serial, app_apk_path, tests_apk_path)
      grant_permissions(device_serial)
    end
    run_tests_for_locale(locale, device_serial, test_classes_to_use, test_packages_to_use, launch_arguments)
  end
end

#run_tests_for_locale(locale, device_serial, test_classes_to_use, test_packages_to_use, launch_arguments) ⇒ Object


246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'screengrab/lib/screengrab/runner.rb', line 246

def run_tests_for_locale(locale, device_serial, test_classes_to_use, test_packages_to_use, launch_arguments)
  UI.message("Running tests for locale: #{locale}")

  instrument_command = ["adb -s #{device_serial} shell am instrument --no-window-animation -w",
                        "-e testLocale #{locale.tr('-', '_')}",
                        "-e endingLocale #{@config[:ending_locale].tr('-', '_')}"]
  instrument_command << "-e class #{test_classes_to_use.join(',')}" if test_classes_to_use
  instrument_command << "-e package #{test_packages_to_use.join(',')}" if test_packages_to_use
  instrument_command << launch_arguments.map { |item| '-e ' + item }.join(' ') if launch_arguments
  instrument_command << "#{@config[:tests_package_name]}/#{@config[:test_instrumentation_runner]}"

  test_output = run_adb_command(instrument_command.join(" \\\n"),
                                print_all: true,
                                print_command: true)

  if test_output.include?("FAILURES!!!")
    if @config[:exit_on_test_failure]
      UI.test_failure!("Tests failed for locale #{locale} on device #{device_serial}")
    else
      UI.error("Tests failed")
    end
  end
end

#screenshot_file_names_in(output_directory, device_type) ⇒ Object


134
135
136
# File 'screengrab/lib/screengrab/runner.rb', line 134

def screenshot_file_names_in(output_directory, device_type)
  Dir.glob(File.join(output_directory, '**', device_type, '*.png'), File::FNM_CASEFOLD)
end

#select_app_apk(discovered_apk_paths) ⇒ Object


111
112
113
114
# File 'screengrab/lib/screengrab/runner.rb', line 111

def select_app_apk(discovered_apk_paths)
  UI.important("To not be asked about this value, you can specify it using 'app_apk_path'")
  UI.select('Select your debug app APK', discovered_apk_paths)
end

#select_deviceObject


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'screengrab/lib/screengrab/runner.rb', line 79

def select_device
  devices = run_adb_command("adb devices -l", print_all: true, print_command: true).split("\n")
  # the first output by adb devices is "List of devices attached" so remove that and any adb startup output
  devices.reject! do |device|
    [
      'server is out of date',    # The adb server is out of date and must be restarted
      'unauthorized',             # The device has not yet accepted ADB control
      'offline',                  # The device is offline, skip it
      '* daemon',                 # Messages printed when the daemon is starting up
      'List of devices attached', # Header of table for data we want
      "doesn't match this client" # Message printed when there is an ADB client/server version mismatch
    ].any? { |status| device.include?(status) }
  end

  UI.user_error!('There are no connected and authorized devices or emulators') if devices.empty?

  devices.select! { |d| d.include?(@config[:specific_device]) } if @config[:specific_device]

  UI.user_error!("No connected devices matched your criteria: #{@config[:specific_device]}") if devices.empty?

  if devices.length > 1
    UI.important("Multiple connected devices, selecting the first one")
    UI.important("To specify which connected device to use, use the -s (specific_device) config option")
  end

  # grab the serial number. the lines of output can look like these:
  # 00c22d4d84aec525       device usb:2148663295X product:bullhead model:Nexus_5X device:bullhead
  # 192.168.1.100:5555       device usb:2148663295X product:bullhead model:Nexus_5X device:genymotion
  # emulator-5554       device usb:2148663295X product:bullhead model:Nexus_5X device:emulator
  devices[0].match(/^\S+/)[0]
end

#select_tests_apk(discovered_apk_paths) ⇒ Object


116
117
118
119
# File 'screengrab/lib/screengrab/runner.rb', line 116

def select_tests_apk(discovered_apk_paths)
  UI.important("To not be asked about this value, you can specify it using 'tests_apk_path'")
  UI.select('Select your debug tests APK', discovered_apk_paths)
end

#uninstall_apks(device_serial, app_package_name, tests_package_name) ⇒ Object


197
198
199
200
201
202
203
204
205
206
207
# File 'screengrab/lib/screengrab/runner.rb', line 197

def uninstall_apks(device_serial, app_package_name, tests_package_name)
  UI.message('Uninstalling app APK')
  run_adb_command("adb -s #{device_serial} uninstall #{app_package_name}",
                  print_all: true,
                  print_command: true)

  UI.message('Uninstalling tests APK')
  run_adb_command("adb -s #{device_serial} uninstall #{tests_package_name}",
                  print_all: true,
                  print_command: true)
end

#validate_apk(app_apk_path) ⇒ Object


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'screengrab/lib/screengrab/runner.rb', line 165

def validate_apk(app_apk_path)
  unless @android_env.aapt_path
    UI.important("The `aapt` command could not be found on your system, so your app APK could not be validated")
    return
  end

  UI.message('Validating app APK')
  apk_permissions = @executor.execute(command: "#{@android_env.aapt_path} dump permissions #{app_apk_path}",
                                      print_all: true,
                                      print_command: true)

  missing_permissions = NEEDED_PERMISSIONS.reject { |needed| apk_permissions.include?(needed) }

  if missing_permissions.any?
    UI.user_error!("The needed permission(s) #{missing_permissions.join(', ')} could not be found in your app APK")
  end
end