Inheritance diagram for flavor.api.SkiaFlavorApi:

Public Member Functions
	get_flavor (self, vars_api, app_name)

	setup (self, app_name)

	step (self, name, cmd, **kwargs)

	device_path_join (self, *args)

	copy_directory_contents_to_device (self, host_dir, device_dir)

	copy_directory_contents_to_host (self, device_dir, host_dir)

	copy_file_to_device (self, host_path, device_path)

	create_clean_host_dir (self, path)

	create_clean_device_dir (self, path)

	read_file_on_device (self, path, **kwargs)

	remove_file_on_device (self, path)

	install (self, skps=False, images=False, lotties=False, svgs=False, resources=False, mskps=False, texttraces=False)

	cleanup_steps (self)

Public Attributes
	device_dirs

	host_dirs

Protected Member Functions
	_copy_dir (self, host_version, version_file, tmp_dir, host_path, device_path)

	_copy_images (self)

	_copy_lotties (self)

	_copy_skps (self)

	_copy_svgs (self)

	_copy_mskps (self)

	_copy_texttraces (self)

Protected Attributes
	_f

	_skia_dir

Detailed Description

Definition at line 55 of file api.py.

Member Function Documentation

◆ _copy_dir()

flavor.api.SkiaFlavorApi._copy_dir	(	self,
		host_version,
		version_file,
		tmp_dir,
		host_path,
		device_path
	)

protected

Definition at line 128 of file api.py.

                host_path, device_path):
    actual_version_file = self.m.path.join(tmp_dir, version_file)
    # Copy to device.
    device_version_file = self.device_path_join(
        self.device_dirs.tmp_dir, version_file)
    if str(actual_version_file) != str(device_version_file):
      device_version = self.read_file_on_device(device_version_file,
                                                abort_on_failure=False,
                                                fail_build_on_failure=False)
      if not device_version:
        device_version = VERSION_NONE
      if device_version != host_version:
        self.remove_file_on_device(device_version_file)
        self.create_clean_device_dir(device_path)
        self.copy_directory_contents_to_device(
            host_path, device_path)
 
        # Copy the new version file.
        self.copy_file_to_device(actual_version_file, device_version_file)
 

◆ _copy_images()

flavor.api.SkiaFlavorApi._copy_images ( self )

protected

Copy test images if needed.

Definition at line 149 of file api.py.

  def _copy_images(self):
    """Copy test images if needed."""
    version = self.m.run.asset_version('skimage', self._skia_dir)
    self.m.run.writefile(
        self.m.path.join(self.m.vars.tmp_dir, VERSION_FILE_SK_IMAGE),
        version)
    self._copy_dir(
        version,
        VERSION_FILE_SK_IMAGE,
        self.m.vars.tmp_dir,
        self.host_dirs.images_dir,
        self.device_dirs.images_dir)
    return version
 

◆ _copy_lotties()

flavor.api.SkiaFlavorApi._copy_lotties ( self )

protected

Copy test lotties if needed.

Definition at line 163 of file api.py.

  def _copy_lotties(self):
    """Copy test lotties if needed."""
    version = self.m.run.asset_version('lottie-samples', self._skia_dir)
    self.m.run.writefile(
        self.m.path.join(self.m.vars.tmp_dir, VERSION_FILE_LOTTIE),
        version)
    self._copy_dir(
        version,
        VERSION_FILE_LOTTIE,
        self.m.vars.tmp_dir,
        self.host_dirs.lotties_dir,
        self.device_dirs.lotties_dir)
    return version
 

◆ _copy_mskps()

flavor.api.SkiaFlavorApi._copy_mskps ( self )

protected

Copy the MSKPs if needed.

Definition at line 205 of file api.py.

  def _copy_mskps(self):
    """Copy the MSKPs if needed."""
    version = self.m.run.asset_version('mskp', self._skia_dir)
    self.m.run.writefile(
        self.m.path.join(self.m.vars.tmp_dir, VERSION_FILE_MSKP),
        version)
    self._copy_dir(
        version,
        VERSION_FILE_MSKP,
        self.m.vars.tmp_dir,
        self.host_dirs.mskp_dir,
        self.device_dirs.mskp_dir)
    return version
 

◆ _copy_skps()

flavor.api.SkiaFlavorApi._copy_skps ( self )

protected

Copy the SKPs if needed.

Definition at line 177 of file api.py.

  def _copy_skps(self):
    """Copy the SKPs if needed."""
    version = self.m.run.asset_version('skp', self._skia_dir)
    self.m.run.writefile(
        self.m.path.join(self.m.vars.tmp_dir, VERSION_FILE_SKP),
        version)
    self._copy_dir(
        version,
        VERSION_FILE_SKP,
        self.m.vars.tmp_dir,
        self.host_dirs.skp_dir,
        self.device_dirs.skp_dir)
    return version
 

◆ _copy_svgs()

flavor.api.SkiaFlavorApi._copy_svgs ( self )

protected

Copy the SVGs if needed.

Definition at line 191 of file api.py.

  def _copy_svgs(self):
    """Copy the SVGs if needed."""
    version = self.m.run.asset_version('svg', self._skia_dir)
    self.m.run.writefile(
        self.m.path.join(self.m.vars.tmp_dir, VERSION_FILE_SVG),
        version)
    self._copy_dir(
        version,
        VERSION_FILE_SVG,
        self.m.vars.tmp_dir,
        self.host_dirs.svg_dir,
        self.device_dirs.svg_dir)
    return version
 

◆ _copy_texttraces()

flavor.api.SkiaFlavorApi._copy_texttraces ( self )

protected

Copy the text traces if needed.

Definition at line 219 of file api.py.

  def _copy_texttraces(self):
    """Copy the text traces if needed."""
    version = self.m.run.asset_version('text_blob_traces', self._skia_dir)
    self.m.run.writefile(
        self.m.path.join(self.m.vars.tmp_dir, VERSION_FILE_TEXTTRACES),
        version)
    self._copy_dir(
        version,
        VERSION_FILE_TEXTTRACES,
        self.m.vars.tmp_dir,
        self.host_dirs.texttraces_dir,
        self.device_dirs.texttraces_dir)
    return version

◆ cleanup_steps()

flavor.api.SkiaFlavorApi.cleanup_steps ( self )

Definition at line 125 of file api.py.

  def cleanup_steps(self):
    return self._f.cleanup_steps()
 

◆ copy_directory_contents_to_device()

flavor.api.SkiaFlavorApi.copy_directory_contents_to_device	(	self,
		host_dir,
		device_dir
	)

Definition at line 81 of file api.py.

  def copy_directory_contents_to_device(self, host_dir, device_dir):
    return self._f.copy_directory_contents_to_device(host_dir, device_dir)
 

◆ copy_directory_contents_to_host()

flavor.api.SkiaFlavorApi.copy_directory_contents_to_host	(	self,
		device_dir,
		host_dir
	)

Definition at line 84 of file api.py.

  def copy_directory_contents_to_host(self, device_dir, host_dir):
    return self._f.copy_directory_contents_to_host(device_dir, host_dir)
 

◆ copy_file_to_device()

flavor.api.SkiaFlavorApi.copy_file_to_device	(	self,
		host_path,
		device_path
	)

Definition at line 87 of file api.py.

  def copy_file_to_device(self, host_path, device_path):
    return self._f.copy_file_to_device(host_path, device_path)
 

◆ create_clean_device_dir()

flavor.api.SkiaFlavorApi.create_clean_device_dir	(	self,
		path
	)

Definition at line 93 of file api.py.

  def create_clean_device_dir(self, path):
    return self._f.create_clean_device_dir(path)
 

◆ create_clean_host_dir()

flavor.api.SkiaFlavorApi.create_clean_host_dir	(	self,
		path
	)

Definition at line 90 of file api.py.

  def create_clean_host_dir(self, path):
    return self._f.create_clean_host_dir(path)
 

◆ device_path_join()

flavor.api.SkiaFlavorApi.device_path_join	(		self,
		*	args
	)

Definition at line 78 of file api.py.

  def device_path_join(self, *args):
    return self._f.device_path_join(*args)
 

◆ get_flavor()

flavor.api.SkiaFlavorApi.get_flavor	(	self,
		vars_api,
		app_name
	)

Return a flavor utils object specific to the given builder.

Definition at line 56 of file api.py.

  def get_flavor(self, vars_api, app_name):
    """Return a flavor utils object specific to the given builder."""
    if is_chromebook(vars_api):
      return chromebook.ChromebookFlavor(self, app_name)
    if is_android(vars_api):
      return android.AndroidFlavor(self, app_name)
    elif is_ios(vars_api):
      return ios.iOSFlavor(self, app_name)
    elif is_valgrind(vars_api):
      return valgrind.ValgrindFlavor(self, app_name)
    else:
      return default.DefaultFlavor(self, app_name)
 

◆ install()

flavor.api.SkiaFlavorApi.install	(	self,
		skps = `False`,
		images = `False`,
		lotties = `False`,
		svgs = `False`,
		resources = `False`,
		mskps = `False`,
		texttraces = `False`
	)

Definition at line 102 of file api.py.

              resources=False, mskps=False, texttraces=False):
    self._f.install()
 
    if texttraces:
      self._copy_texttraces()
    # TODO(borenet): Only copy files which have changed.
    if resources:
      self.copy_directory_contents_to_device(
          self.m.path['start_dir'].join('skia', 'resources'),
          self.device_dirs.resource_dir)
 
    if skps:
      self._copy_skps()
    if images:
      self._copy_images()
    if lotties:
      self._copy_lotties()
    if svgs:
      self._copy_svgs()
    if mskps:
      self._copy_mskps()
 

◆ read_file_on_device()

flavor.api.SkiaFlavorApi.read_file_on_device	(		self,
			path,
		**	kwargs
	)

Definition at line 96 of file api.py.

  def read_file_on_device(self, path, **kwargs):
    return self._f.read_file_on_device(path, **kwargs)
 

◆ remove_file_on_device()

flavor.api.SkiaFlavorApi.remove_file_on_device	(	self,
		path
	)

Definition at line 99 of file api.py.

  def remove_file_on_device(self, path):
    return self._f.remove_file_on_device(path)
 

◆ setup()

flavor.api.SkiaFlavorApi.setup	(	self,
		app_name
	)

Definition at line 69 of file api.py.

  def setup(self, app_name):
    self._f = self.get_flavor(self.m.vars, app_name)
    self.device_dirs = self._f.device_dirs
    self.host_dirs = self._f.host_dirs
    self._skia_dir = self.m.path['start_dir'].join('skia')
 

◆ step()

flavor.api.SkiaFlavorApi.step	(		self,
			name,
			cmd,
		**	kwargs
	)

Definition at line 75 of file api.py.

  def step(self, name, cmd, **kwargs):
    return self._f.step(name, cmd, **kwargs)
 

Member Data Documentation

◆ _f

flavor.api.SkiaFlavorApi._f

protected

Definition at line 70 of file api.py.

◆ _skia_dir

flavor.api.SkiaFlavorApi._skia_dir

protected

Definition at line 73 of file api.py.

◆ device_dirs

flavor.api.SkiaFlavorApi.device_dirs

Definition at line 71 of file api.py.

◆ host_dirs

flavor.api.SkiaFlavorApi.host_dirs

Definition at line 72 of file api.py.

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

third_party/skia/infra/bots/recipe_modules/flavor/api.py

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _copy_dir()

◆ _copy_images()

◆ _copy_lotties()

◆ _copy_mskps()

◆ _copy_skps()

◆ _copy_svgs()

◆ _copy_texttraces()

◆ cleanup_steps()

◆ copy_directory_contents_to_device()

◆ copy_directory_contents_to_host()

◆ copy_file_to_device()

◆ create_clean_device_dir()

◆ create_clean_host_dir()

◆ device_path_join()

◆ get_flavor()

◆ install()

◆ read_file_on_device()

◆ remove_file_on_device()

◆ setup()

◆ step()

Member Data Documentation

◆ _f

◆ _skia_dir

◆ device_dirs

◆ host_dirs