flavor.ios.iOSFlavor Class Reference

Inheritance diagram for flavor.ios.iOSFlavor:

Public Member Functions
def	__init__ (self, m, app_name)
def	env (self)
def	context (self)
def	install (self)
def	step (self, name, cmd, **kwargs)
def	copy_file_to_device (self, host, device)
def	copy_directory_contents_to_device (self, host, device)
def	copy_directory_contents_to_host (self, device, host)
def	remove_file_on_device (self, path)
def	create_clean_device_dir (self, path)
def	read_file_on_device (self, path, **kwargs)
Public Member Functions inherited from flavor.default.DefaultFlavor
def	__init__ (self, module, app_name)
def	device_path_join (self, *args)
def	copy_directory_contents_to_device (self, host_dir, device_dir)
def	copy_directory_contents_to_host (self, device_dir, host_dir)
def	copy_file_to_device (self, host_path, device_path)
def	create_clean_device_dir (self, path)
def	create_clean_host_dir (self, path)
def	read_file_on_device (self, path, **kwargs)
def	remove_file_on_device (self, path)
def	install (self)
def	cleanup_steps (self)
def	step (self, name, cmd, **unused_kwargs)

Public Attributes
	device_dirs
Public Attributes inherited from flavor.default.DefaultFlavor
	app_name
	module
	m
	device_dirs
	host_dirs

Detailed Description

Definition at line 12 of file ios.py.

Constructor & Destructor Documentation

__init__()

def flavor.ios.iOSFlavor.__init__	(		self,
			m,
			app_name
	)

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 13 of file ios.py.

  def __init__(self, m, app_name):
    super(iOSFlavor, self).__init__(m, app_name)
    self.device_dirs = default.DeviceDirs(
        bin_dir='[unused]',
        dm_dir='dm',
        perf_data_dir='perf',
        resource_dir='resources',
        fonts_dir = 'NOT_SUPPORTED',
        images_dir='images',
        lotties_dir='lotties',
        skp_dir='skps',
        svg_dir='svgs',
        tmp_dir='tmp',
        texttraces_dir='')
 

Member Function Documentation

context()

def flavor.ios.iOSFlavor.context

(

self

)

Definition at line 35 of file ios.py.

  def context(self):
    return self.m.context(env=self.env)
 

copy_directory_contents_to_device()

def flavor.ios.iOSFlavor.copy_directory_contents_to_device	(		self,
			host_dir,
			device_dir
	)

Like shutil.copytree(), but for copying to a connected device.

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 145 of file ios.py.

  def copy_directory_contents_to_device(self, host, device):
    self._run_ios_script('push_if_needed', host, device)
 

copy_directory_contents_to_host()

def flavor.ios.iOSFlavor.copy_directory_contents_to_host	(		self,
			device_dir,
			host_dir
	)

Like shutil.copytree(), but for copying from a connected device.

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 148 of file ios.py.

  def copy_directory_contents_to_host(self, device, host):
    self._run_ios_script('pull_if_needed', device, host)
 

copy_file_to_device()

def flavor.ios.iOSFlavor.copy_file_to_device	(		self,
			host_path,
			device_path
	)

Like shutil.copyfile, but for copying to a connected device.

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 142 of file ios.py.

  def copy_file_to_device(self, host, device):
    self._run_ios_script('push_file', host, device)
 

create_clean_device_dir()

def flavor.ios.iOSFlavor.create_clean_device_dir	(		self,
			path
	)

Like shutil.rmtree() + os.makedirs(), but on a connected device.

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 154 of file ios.py.

  def create_clean_device_dir(self, path):
    self._run_ios_script('rm',    path)
    self._run_ios_script('mkdir', path)
 

env()

def flavor.ios.iOSFlavor.env

(

self

)

Definition at line 29 of file ios.py.

  def env(self):
    return {
      'IOS_BUNDLE_ID': 'com.google.%s' % self.app_name,
      'IOS_MOUNT_POINT': self.m.vars.workdir.join('mnt_iosdevice'),
    }
 

install()

def flavor.ios.iOSFlavor.install

(

self

)

Run device-specific installation steps.

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 47 of file ios.py.

  def install(self):
    with self.context():
      self._install()
 

read_file_on_device()

def flavor.ios.iOSFlavor.read_file_on_device	(		self,
			path,
		**	kwargs
	)

Reads the specified file.

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 158 of file ios.py.

  def read_file_on_device(self, path, **kwargs):
    with self.context():
      full = self.m.path.start_dir.join(
          'skia', 'platform_tools', 'ios', 'bin', 'ios_cat_file')
      rv = self.m.run(self.m.step,
                      name = 'cat_file %s' % path,
                      cmd = [full, path],
                      stdout=self.m.raw_io.output(),
                      infra_step=True,
                      **kwargs)
      return rv.stdout.decode('utf-8').rstrip() if rv and rv.stdout else None

remove_file_on_device()

def flavor.ios.iOSFlavor.remove_file_on_device	(		self,
			path
	)

Removes the specified file.

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 151 of file ios.py.

  def remove_file_on_device(self, path):
    self._run_ios_script('rm', path)
 

step()

def flavor.ios.iOSFlavor.step	(		self,
			name,
			cmd,
		**	kwargs
	)

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 118 of file ios.py.

  def step(self, name, cmd, **kwargs):
    app_name = cmd[0]
    bundle_id = 'com.google.%s' % app_name
    args = [bundle_id] + [str(ele) for ele in cmd[1:]]
    success = False
    with self.context():
      try:
        self.m.run(self.m.step, name, cmd=['idevicedebug', 'run'] + args)
        success = True
      finally:
        if not success:
          self.m.run(
              self.m.step, '%s with full debug output' % name,
              cmd=['python3', self.module.resource('ios_debug_cmd.py')] + args)
 

Member Data Documentation

device_dirs

flavor.ios.iOSFlavor.device_dirs

Definition at line 15 of file ios.py.

---

The documentation for this class was generated from the following file:

• third_party/skia/infra/bots/recipe_modules/flavor/ios.py