flavor.ssh.SSHFlavor Class Reference

Inheritance diagram for flavor.ssh.SSHFlavor:

Public Member Functions
	__init__ (self, m, app_name)
	user_ip (self)
	ssh (self, title, *cmd, **kwargs)
	ensure_device_dir (self, path)
	install (self)
	create_clean_device_dir (self, path)
	read_file_on_device (self, path, **kwargs)
	remove_file_on_device (self, path)
	scp_device_path (self, device_path)
	copy_file_to_device (self, host_path, device_path)
	step (self, name, cmd, **kwargs)
Public Member Functions inherited from flavor.default.DefaultFlavor
	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)
	create_clean_host_dir (self, path)
	cleanup_steps (self)

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

Protected Attributes
	_user_ip
Protected Attributes inherited from flavor.default.DefaultFlavor
	_chrome_path

Additional Inherited Members
Protected Member Functions inherited from flavor.default.DefaultFlavor
	_run (self, title, cmd, infra_step=False, **kwargs)
	_py (self, title, script, infra_step=True, args=())

Detailed Description

Definition at line 18 of file ssh.py.

Constructor & Destructor Documentation

__init__()

flavor.ssh.SSHFlavor.__init__	(		self,
			m,
			app_name
	)

Reimplemented from flavor.default.DefaultFlavor.

Reimplemented in flavor.chromebook.ChromebookFlavor.

Definition at line 20 of file ssh.py.

  def __init__(self, m, app_name):
    super(SSHFlavor, self).__init__(m, app_name)
    self._user_ip = ''
 

Member Function Documentation

copy_file_to_device()

flavor.ssh.SSHFlavor.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 72 of file ssh.py.

  def copy_file_to_device(self, host_path, device_path):
    device_path = self.scp_device_path(device_path)
    self._run('scp %s %s' % (host_path, device_path),
              ['scp', host_path, device_path], infra_step=True)
 

create_clean_device_dir()

flavor.ssh.SSHFlavor.create_clean_device_dir	(		self,
			path
	)

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

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 54 of file ssh.py.

  def create_clean_device_dir(self, path):
    # use -f to silently return if path doesn't exist
    self.ssh('rm %s' % path, 'rm', '-rf', path)
    self.ensure_device_dir(path)
 

ensure_device_dir()

flavor.ssh.SSHFlavor.ensure_device_dir	(		self,
			path
	)

Definition at line 42 of file ssh.py.

  def ensure_device_dir(self, path):
    self.ssh('mkdir %s' % path, 'mkdir', '-p', path)
 

install()

flavor.ssh.SSHFlavor.install

(

self

)

Run device-specific installation steps.

Reimplemented from flavor.default.DefaultFlavor.

Reimplemented in flavor.chromebook.ChromebookFlavor.

Definition at line 45 of file ssh.py.

  def install(self):
    self.ensure_device_dir(self.device_dirs.resource_dir)
    if self.app_name:
      self.create_clean_device_dir(self.device_dirs.bin_dir)
      host_path = self.host_dirs.bin_dir.join(self.app_name)
      device_path = self.device_path_join(self.device_dirs.bin_dir, self.app_name)
      self.copy_file_to_device(host_path, device_path)
      self.ssh('make %s executable' % self.app_name, 'chmod', '+x', device_path)
 

read_file_on_device()

flavor.ssh.SSHFlavor.read_file_on_device	(		self,
			path,
		**	kwargs
	)

Reads the specified file.

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 59 of file ssh.py.

  def read_file_on_device(self, path, **kwargs):
    rv = self.ssh('read %s' % path,
                   'cat', path, stdout=self.m.raw_io.output(),
                   **kwargs)
    return rv.stdout.decode('utf-8').rstrip() if rv and rv.stdout else None
 

remove_file_on_device()

flavor.ssh.SSHFlavor.remove_file_on_device	(		self,
			path
	)

Removes the specified file.

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 65 of file ssh.py.

  def remove_file_on_device(self, path):
    # use -f to silently return if path doesn't exist
    self.ssh('rm %s' % path, 'rm', '-f', path)
 

scp_device_path()

flavor.ssh.SSHFlavor.scp_device_path	(		self,
			device_path
	)

Definition at line 69 of file ssh.py.

  def scp_device_path(self, device_path):
    return '%s:%s' % (self.user_ip, device_path)
 

ssh()

flavor.ssh.SSHFlavor.ssh	(		self,
			title,
		*	cmd,
		**	kwargs
	)

Definition at line 33 of file ssh.py.

  def ssh(self, title, *cmd, **kwargs):
    if 'infra_step' not in kwargs:
      kwargs['infra_step'] = True
 
    ssh_cmd = ['ssh', '-oConnectTimeout=15', '-oBatchMode=yes',
               '-t', '-t', self.user_ip] + list(cmd)
 
    return self._run(title, ssh_cmd, **kwargs)
 

step()

flavor.ssh.SSHFlavor.step	(		self,
			name,
			cmd,
		**	kwargs
	)

Reimplemented from flavor.default.DefaultFlavor.

Definition at line 83 of file ssh.py.

  def step(self, name, cmd, **kwargs):
    # Run cmd (installed above)
    cmd[0] = self.device_path_join(self.device_dirs.bin_dir, cmd[0])
    self.ssh(str(name), *cmd)

user_ip()

flavor.ssh.SSHFlavor.user_ip

(

self

)

Definition at line 25 of file ssh.py.

  def user_ip(self):
    if not self._user_ip:
      path = '/tmp/ssh_machine.json'
      ssh_info = self.m.file.read_json('read ssh_machine.json', path,
                                       test_data={'user_ip':'foo@127.0.0.1'})
      self._user_ip = ssh_info.get(u'user_ip')
    return self._user_ip
 

Member Data Documentation

_user_ip

flavor.ssh.SSHFlavor._user_ip

protected

Definition at line 22 of file ssh.py.

app_name

flavor.ssh.SSHFlavor.app_name

Definition at line 52 of file ssh.py.

user_ip

flavor.ssh.SSHFlavor.user_ip

Definition at line 70 of file ssh.py.

---

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

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