Class: RunLoop::CoreSimulator

Inherits:
Object
  • Object
show all
Includes:
Shell
Defined in:
lib/run_loop/core_simulator.rb

Overview

A class to manage interactions with CoreSimulators.

Constant Summary collapse

DEFAULT_OPTIONS =

These options control various aspects of an app’s life cycle on the iOS Simulator.

You can override these values if they do not work in your environment.

For cucumber users, the best place to override would be in your features/support/env.rb.

For example:

RunLoop::CoreSimulator::DEFAULT_OPTIONS = 60

{
  # In most cases 30 seconds is a reasonable amount of time to wait for an
  # install.  When testing larger apps, on slow machines, or in CI, this
  # value may need to be higher.  120 is the default for CI.
  :install_app_timeout => RunLoop::Environment.ci? ? 120 : 30,
  :uninstall_app_timeout => RunLoop::Environment.ci? ? 120 : 30,
  :launch_app_timeout => RunLoop::Environment.ci? ? 120 : 30,
  :wait_for_state_timeout => RunLoop::Environment.ci? ? 120 : 30,
  :app_launch_retries => RunLoop::Environment.ci? ? 5 : 3
}

Instance Method Summary collapse

Methods included from Shell

run_shell_command, #run_shell_command

Methods included from Encoding

#transliterate

Constructor Details

#initialize(device, app, options = {}) ⇒ CoreSimulator

Returns a new instance of CoreSimulator.

Parameters:

  • device (RunLoop::Device) —

    The device.

  • app (RunLoop::App) —

    The application.

  • options (Hash) (defaults to: {}) —

    Controls the behavior of this class.

Options Hash (options):

  • :quit_sim_on_init (Object) — default: true —

    If true, quit any running

  • :xcode (Object) —

    An instance of Xcode to use simulators in the initialize method.



318
319
320
321
322
323
324
325
 
# File 'lib/run_loop/core_simulator.rb', line 318

def initialize(device, app, options={})
  @app = app
  @device = device
  @xcode = options[:xcode]

  # stdio.pipe - can cause problems finding the SHA of a simulator
  rm_instruments_pipe
end

Instance Method Details

#app_is_installed? ⇒ Boolean

Is this app installed?

Returns:

  • (Boolean) 


460
461
462
 
# File 'lib/run_loop/core_simulator.rb', line 460

def app_is_installed?
  !installed_app_bundle_dir.nil?
end

#install ⇒ Object

Install the app.

  1. If the app is not installed, it is installed.

  2. Does nothing, if the app is the same as the one that is installed.

  3. Installs the app if it is different from the installed app.

The app sandbox is not touched.



446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/run_loop/core_simulator.rb', line 446

def install
  installed_app_bundle = installed_app_bundle_dir

  # App is not installed. Use simctl interface to install.
  if !installed_app_bundle
    installed_app_bundle = install_app_with_simctl
  else
    ensure_app_same
  end

  installed_app_bundle
end

#launch ⇒ Object

Launch the app on the simulator.

  1. If the app is not installed, it is installed.

  2. If the app is different from the app that is installed, it is installed.



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/run_loop/core_simulator.rb', line 399

def launch
  install

  # If the app is the same, install will not launch the simulator.
  # In order to launch the app, the simulator needs to be running.
  # launch_simulator ensures that the sim is launched and will not
  # relaunch it.
  launch_simulator

  tries = app_launch_retries

  RunLoop.log_debug("Trying #{tries} times to launch #{app.bundle_identifier} on #{device}")

  last_error = try_to_launch_app_n_times(tries)

  if last_error
    raise RuntimeError, %Q[
Could not launch #{app.bundle_identifier} on #{device} after trying #{tries} times:

#{last_error}:

#{last_error.message}

]
  end

  wait_for_app_launch
end

#launch_simulator(options = {}) ⇒ Object

Launch the simulator indicated by device.



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/run_loop/core_simulator.rb', line 354

def launch_simulator(options={})
  merged_options = {
    :wait_for_stable => true
  }.merge(options)

  if !simulator_requires_relaunch?
    RunLoop.log_debug("Simulator is running and does not require a relaunch.")
    return
  end

  RunLoop::CoreSimulator.quit_simulator

  args = ['open', '-g', '-a', sim_app_path, '--args',
          '-CurrentDeviceUDID', device.udid, "LAUNCHED_BY_RUN_LOOP"]

  RunLoop.log_debug("Launching #{device} with:")
  RunLoop.log_unix_cmd("xcrun #{args.join(' ')}")

  start_time = Time.now

  pid = Process.spawn('xcrun', *args)
  Process.detach(pid)

  options = { :timeout => 5, :raise_on_timeout => true }
  RunLoop::ProcessWaiter.new(sim_name, options).wait_for_any

  # open -g no longer launches application in the background. We want the
  # Simulator to open in the background because when it is opened in the
  # foreground, it steals (key application) focus which is disruptive.
  send_simulator_to_background

  if merged_options[:wait_for_stable]
    device.simulator_wait_for_stable_state
  end

  elapsed = Time.now - start_time
  RunLoop.log_debug("Took #{elapsed} seconds to launch the simulator")

  true
end

#reset_app_sandbox ⇒ Object

Resets the app sandbox.

Does nothing if the app is not installed.



467
468
469
470
471
472
473
474
 
# File 'lib/run_loop/core_simulator.rb', line 467

def reset_app_sandbox
  return true if !app_is_installed?

  RunLoop::CoreSimulator.quit_simulator
  RunLoop::CoreSimulator.wait_for_simulator_state(device, "Shutdown")

  reset_app_sandbox_internal
end

#uninstall_app_and_sandbox ⇒ Object

Uninstalls the app and clears the sandbox.



477
478
479
480
481
482
 
# File 'lib/run_loop/core_simulator.rb', line 477

def uninstall_app_and_sandbox
  return true if !app_is_installed?

  uninstall_app_with_simctl
  true
end