Class: RunLoop::CoreSimulator

Inherits:
Object
  • Object
show all
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
}

Instance Method Summary collapse

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.



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/run_loop/core_simulator.rb', line 321

def initialize(device, app, options={})
  defaults = { :quit_sim_on_init => true }
  merged = defaults.merge(options)

  @app = app
  @device = device

  @xcode = merged[:xcode]

  if merged[:quit_sim_on_init]
    RunLoop::CoreSimulator.quit_simulator
  end

  # 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) 


468
469
470
 
# File 'lib/run_loop/core_simulator.rb', line 468

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.



454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/run_loop/core_simulator.rb', line 454

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.



397
398
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
427
428
429
430
431
432
433
434
 
# File 'lib/run_loop/core_simulator.rb', line 397

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 = RunLoop::Environment.ci? ? 5 : 3
  last_error = nil

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

  tries.times do |try|
    # Terminates CoreSimulatorService on failures.
    hash = attempt_to_launch_app_with_simctl

    exit_status = hash[:exit_status]
    if exit_status != 0
      # Last argument is how long to sleep after an error.
      last_error = handle_failed_app_launch(hash, try, tries, 0.5)
    else
      last_error = nil
      break
    end
  end

  if last_error
    raise RuntimeError, %Q[Could not launch #{app.bundle_identifier} on #{device}

#{last_error}

]
  end

  wait_for_app_launch
end

#launch_simulator ⇒ 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
 
# File 'lib/run_loop/core_simulator.rb', line 354

def launch_simulator

  if running_simulator_pid != nil
    # There is a running simulator.

    # Did we launch it?
    if running_simulator_pid == RunLoop::CoreSimulator.simulator_pid
      # Nothing to do, we already launched the simulator.
      return
    else
      # We did not launch this simulator; quit it.
      RunLoop::CoreSimulator.quit_simulator
    end
  end

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

  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

  device.simulator_wait_for_stable_state

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

  # Keep track of the pid so we can know if we have already launched this sim.
  RunLoop::CoreSimulator.simulator_pid = running_simulator_pid

  true
end

#reset_app_sandbox ⇒ Object

Resets the app sandbox.

Does nothing if the app is not installed.



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

def reset_app_sandbox
  return true if !app_is_installed?

  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.



484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/run_loop/core_simulator.rb', line 484

def uninstall_app_and_sandbox
  return true if !app_is_installed?

  launch_simulator

  args = ['simctl', 'uninstall', device.udid, app.bundle_identifier]

  timeout = DEFAULT_OPTIONS[:uninstall_app_timeout]
  xcrun.run_command_in_context(args, log_cmd: true, timeout: timeout)

  device.simulator_wait_for_stable_state
  true
end