run.api.SkiaStepApi Class Reference

Inheritance diagram for run.api.SkiaStepApi:

Public Member Functions
	__init__ (self, *args, **kwargs)
	check_failure (self)
	failed_steps (self)
	run_once (self, fn, *args, **kwargs)
	readfile (self, filename, *args, **kwargs)
	writefile (self, filename, contents)
	rmtree (self, path)
	asset_version (self, asset_name, skia_dir, test_data=None)
	__call__ (self, steptype, name, abort_on_failure=True, fail_build_on_failure=True, **kwargs)
	with_retry (self, steptype, name, attempts, between_attempts_fn=None, abort_on_failure=True, fail_build_on_failure=True, **kwargs)

Protected Attributes
	_already_ran
	_ccache
	_checked_for_ccache
	_failed

Detailed Description

Definition at line 14 of file api.py.

Constructor & Destructor Documentation

__init__()

run.api.SkiaStepApi.__init__	(		self,
		*	args,
		**	kwargs
	)

Initialize the recipe module.

Definition at line 16 of file api.py.

  def __init__(self, *args, **kwargs):
    """Initialize the recipe module."""
    super(SkiaStepApi, self).__init__(*args, **kwargs)
 
    self._already_ran = {}
    self._ccache = None
    self._checked_for_ccache = False
    self._failed = []
 

Member Function Documentation

__call__()

run.api.SkiaStepApi.__call__	(		self,
			steptype,
			name,
			abort_on_failure = True,
			fail_build_on_failure = True,
		**	kwargs
	)

Run a step. If it fails, keep going but mark the build status failed.

Definition at line 69 of file api.py.

               fail_build_on_failure=True, **kwargs):
    """Run a step. If it fails, keep going but mark the build status failed."""
    try:
      with self.m.env(self.m.vars.default_env):
        return steptype(name=name, **kwargs)
    except self.m.step.StepFailure as e:
      if fail_build_on_failure:
        self._failed.append(e)
      if abort_on_failure:
        raise
 

asset_version()

run.api.SkiaStepApi.asset_version	(		self,
			asset_name,
			skia_dir,
			test_data = None
	)

Return the contents of VERSION for the given asset as a string.

If test_data is not specified, reads the property
'test_<asset_name>_version' or if not present, uses
TEST_DEFAULT_ASSET_VERSION.

Definition at line 54 of file api.py.

  def asset_version(self, asset_name, skia_dir, test_data=None):
    """Return the contents of VERSION for the given asset as a string.
 
    If test_data is not specified, reads the property
    'test_<asset_name>_version' or if not present, uses
    TEST_DEFAULT_ASSET_VERSION."""
    version_file = skia_dir.join(
        'infra', 'bots', 'assets', asset_name, 'VERSION')
    if not test_data:
      test_data = self.m.properties.get(
          'test_%s_version' % asset_name, TEST_DEFAULT_ASSET_VERSION)
    return self.m.file.read_text('Get %s VERSION' % asset_name,
                                 version_file,
                                 test_data=test_data).rstrip()
 

check_failure()

run.api.SkiaStepApi.check_failure

(

self

)

Raise an exception if any step failed.

Definition at line 25 of file api.py.

  def check_failure(self):
    """Raise an exception if any step failed."""
    if self._failed:
      raise self.m.step.StepFailure('Failed build steps: %s' %
                                    ', '.join([f.name for f in self._failed]))
 

failed_steps()

run.api.SkiaStepApi.failed_steps

(

self

)

Definition at line 32 of file api.py.

  def failed_steps(self):
    return self._failed[:]
 

readfile()

run.api.SkiaStepApi.readfile	(		self,
			filename,
		*	args,
		**	kwargs
	)

Convenience function for reading files.

Definition at line 40 of file api.py.

  def readfile(self, filename, *args, **kwargs):
    """Convenience function for reading files."""
    name = kwargs.pop('name', 'read %s' % self.m.path.basename(filename))
    return self.m.file.read_text(name, filename, *args, **kwargs)
 

rmtree()

run.api.SkiaStepApi.rmtree	(		self,
			path
	)

Wrapper around api.file.rmtree.

Definition at line 50 of file api.py.

  def rmtree(self, path):
    """Wrapper around api.file.rmtree."""
    self.m.file.rmtree('rmtree %s' % self.m.path.basename(path), path)
 

run_once()

run.api.SkiaStepApi.run_once	(		self,
			fn,
		*	args,
		**	kwargs
	)

Definition at line 35 of file api.py.

  def run_once(self, fn, *args, **kwargs):
    if not fn.__name__ in self._already_ran:
      self._already_ran[fn.__name__] = fn(*args, **kwargs)
    return self._already_ran[fn.__name__]
 

with_retry()

run.api.SkiaStepApi.with_retry	(		self,
			steptype,
			name,
			attempts,
			between_attempts_fn = None,
			abort_on_failure = True,
			fail_build_on_failure = True,
		**	kwargs
	)

Definition at line 81 of file api.py.

                 abort_on_failure=True, fail_build_on_failure=True, **kwargs):
    for attempt in range(attempts):
      step_name = name
      if attempt > 0:
        step_name += ' (attempt %d)' % (attempt + 1)
      try:
        res = self(steptype, name=step_name, abort_on_failure=True,
                   fail_build_on_failure=fail_build_on_failure, **kwargs)
        if attempt > 0 and fail_build_on_failure:
          del self._failed[-attempt:]
        return res
      except self.m.step.StepFailure:
        if between_attempts_fn:
          between_attempts_fn(attempt+1)
        if (attempt == attempts - 1) and abort_on_failure:
            raise

writefile()

run.api.SkiaStepApi.writefile	(		self,
			filename,
			contents
	)

Convenience function for writing files.

Definition at line 45 of file api.py.

  def writefile(self, filename, contents):
    """Convenience function for writing files."""
    return self.m.file.write_text('write %s' % self.m.path.basename(filename),
                                  filename, contents)
 

Member Data Documentation

_already_ran

run.api.SkiaStepApi._already_ran

protected

Definition at line 20 of file api.py.

_ccache

run.api.SkiaStepApi._ccache

protected

Definition at line 21 of file api.py.

_checked_for_ccache

run.api.SkiaStepApi._checked_for_ccache

protected

Definition at line 22 of file api.py.

_failed

run.api.SkiaStepApi._failed

protected

Definition at line 23 of file api.py.

---

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

• third_party/skia/infra/bots/recipe_modules/run/api.py