vars.api.SkiaVarsApi Class Reference

Inheritance diagram for vars.api.SkiaVarsApi:

Public Member Functions
def	setup (self)
def	is_linux (self)
def	swarming_bot_id (self)
def	swarming_task_id (self)

Public Attributes
	builder_name
	workdir
	build_dir
	default_env
	cache_dir
	swarming_out_dir
	tmp_dir
	builder_cfg
	role
	configuration
	extra_tokens
	patch_storage
	issue
	patchset
	is_trybot
	internal_hardware_label
	is_internal_bot

Detailed Description

Definition at line 16 of file api.py.

Member Function Documentation

is_linux()

def vars.api.SkiaVarsApi.is_linux

(

self

)

Definition at line 88 of file api.py.

  def is_linux(self):
    return (
        'Ubuntu' in self.builder_name
     or 'Debian' in self.builder_name
     or 'Housekeeper' in self.builder_name
    )
 

setup()

def vars.api.SkiaVarsApi.setup

(

self

)

Prepare the variables.

Definition at line 18 of file api.py.

  def setup(self):
    """Prepare the variables."""
    # Hack start_dir to remove the "k" directory which is added by Kitchen.
    # Otherwise, we can't get to the CIPD packages, caches, and isolates which
    # were put into the task workdir.
    if self.m.path.basename(self.m.path.start_dir) == 'k':  # pragma: nocover
      self.m.path._start_dir = self.m.path._start_dir[:-2]
 
    # Setup
    self.builder_name = self.m.properties['buildername']
 
    self.workdir = self.m.path.start_dir
 
    # Special input/output directories.
    self.build_dir = self.workdir.join('build')
 
    self.default_env = self.m.context.env
    self.default_env['CHROME_HEADLESS'] = '1'
    self.default_env['PATH'] = self.m.path.pathsep.join([
        self.default_env.get('PATH', '%(PATH)s'),
        str(self.m.bot_update.repo_resource()),
    ])
    self.cache_dir = self.workdir.join('cache')
 
    self.swarming_out_dir = self.workdir.join(
        self.m.properties.get('swarm_out_dir', 'tmp'))
 
    self.tmp_dir = self.m.path.start_dir.join('tmp')
 
    self.builder_cfg = self.m.builder_name_schema.DictForBuilderName(
        self.builder_name)
    self.role = self.builder_cfg['role']
    if self.role == self.m.builder_name_schema.BUILDER_ROLE_HOUSEKEEPER:
      self.configuration = CONFIG_RELEASE
    else:
      self.configuration = self.builder_cfg.get('configuration', CONFIG_DEBUG)
    arch = (self.builder_cfg.get('arch') or self.builder_cfg.get('target_arch'))
    if ('Win' in self.builder_cfg.get('os', '') and arch == 'x86_64'):
      self.configuration += '_x64'
 
    self.extra_tokens = []
    if len(self.builder_cfg.get('extra_config', '')) > 0:
      if self.builder_cfg['extra_config'].startswith('SK'):
        assert self.builder_cfg['extra_config'].isupper()
        self.extra_tokens = [self.builder_cfg['extra_config']]
      else:
        self.extra_tokens = self.builder_cfg['extra_config'].split('_')
 
    self.patch_storage = self.m.properties.get('patch_storage', 'gerrit')
    self.issue = None
    self.patchset = None
    self.is_trybot = False
    if (self.m.properties.get('patch_issue', '') and
        self.m.properties['patch_issue'] != '0' and
        self.m.properties.get('patch_set', '') and
        self.m.properties['patch_set'] != '0' and
        self.m.properties.get('patch_ref', '')):
      self.is_trybot = True
      self.issue = self.m.properties['patch_issue']
      self.patchset = self.m.properties['patch_set']
 
    self._swarming_bot_id = None
    self._swarming_task_id = None
 
    # Internal bot support.
    self.internal_hardware_label = (
        self.m.properties.get('internal_hardware_label'))
    self.is_internal_bot = self.internal_hardware_label is not None
 

swarming_bot_id()

def vars.api.SkiaVarsApi.swarming_bot_id

(

self

)

Definition at line 96 of file api.py.

  def swarming_bot_id(self):
    if not self._swarming_bot_id:
      script = self.resource('get_env_var.py')
      step_stdout = self.m.step(
          name='get swarming bot id',
          cmd=['python3', script, 'SWARMING_BOT_ID'],
          stdout=self.m.raw_io.output()).stdout.decode('utf-8')
      self._swarming_bot_id = step_stdout.rstrip() if step_stdout else ''
    return self._swarming_bot_id
 

swarming_task_id()

def vars.api.SkiaVarsApi.swarming_task_id

(

self

)

Definition at line 107 of file api.py.

  def swarming_task_id(self):
    if not self._swarming_task_id:
      script = self.resource('get_env_var.py')
      step_stdout = self.m.step(
          name='get swarming task id',
          cmd=['python3', script, 'SWARMING_TASK_ID'],
          stdout=self.m.raw_io.output()).stdout.decode('utf-8')
      self._swarming_task_id = step_stdout.rstrip() if step_stdout else ''
    return self._swarming_task_id

Member Data Documentation

build_dir

vars.api.SkiaVarsApi.build_dir

Definition at line 32 of file api.py.

builder_cfg

vars.api.SkiaVarsApi.builder_cfg

Definition at line 47 of file api.py.

builder_name

vars.api.SkiaVarsApi.builder_name

Definition at line 27 of file api.py.

cache_dir

vars.api.SkiaVarsApi.cache_dir

Definition at line 40 of file api.py.

configuration

vars.api.SkiaVarsApi.configuration

Definition at line 51 of file api.py.

default_env

vars.api.SkiaVarsApi.default_env

Definition at line 34 of file api.py.

extra_tokens

vars.api.SkiaVarsApi.extra_tokens

Definition at line 58 of file api.py.

internal_hardware_label

vars.api.SkiaVarsApi.internal_hardware_label

Definition at line 83 of file api.py.

is_internal_bot

vars.api.SkiaVarsApi.is_internal_bot

Definition at line 85 of file api.py.

is_trybot

vars.api.SkiaVarsApi.is_trybot

Definition at line 69 of file api.py.

issue

vars.api.SkiaVarsApi.issue

Definition at line 67 of file api.py.

patch_storage

vars.api.SkiaVarsApi.patch_storage

Definition at line 66 of file api.py.

patchset

vars.api.SkiaVarsApi.patchset

Definition at line 68 of file api.py.

role

vars.api.SkiaVarsApi.role

Definition at line 49 of file api.py.

swarming_out_dir

vars.api.SkiaVarsApi.swarming_out_dir

Definition at line 42 of file api.py.

tmp_dir

vars.api.SkiaVarsApi.tmp_dir

Definition at line 45 of file api.py.

workdir

vars.api.SkiaVarsApi.workdir

Definition at line 29 of file api.py.

---

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

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