You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/test/lib/ansible_test/_internal/become.py

110 lines
3.1 KiB
Python

"""Become abstraction for interacting with test hosts."""
from __future__ import annotations
import abc
import shlex
import typing as t
from .util import (
get_subclasses,
)
class Become(metaclass=abc.ABCMeta):
"""Base class for become implementations."""
@classmethod
def name(cls):
"""The name of this plugin."""
return cls.__name__.lower()
@property
@abc.abstractmethod
def method(self): # type: () -> str
"""The name of the Ansible become plugin that is equivalent to this."""
@abc.abstractmethod
def prepare_command(self, command): # type: (t.List[str]) -> t.List[str]
"""Return the given command, if any, with privilege escalation."""
class Doas(Become):
"""Become using 'doas'."""
@property
def method(self): # type: () -> str
"""The name of the Ansible become plugin that is equivalent to this."""
raise NotImplementedError('Ansible has no built-in doas become plugin.')
def prepare_command(self, command): # type: (t.List[str]) -> t.List[str]
"""Return the given command, if any, with privilege escalation."""
become = ['doas', '-n']
if command:
become.extend(['sh', '-c', shlex.join(command)])
else:
become.extend(['-s'])
return become
class DoasSudo(Doas):
"""Become using 'doas' in ansible-test and then after bootstrapping use 'sudo' for other ansible commands."""
@classmethod
def name(cls):
"""The name of this plugin."""
return 'doas_sudo'
@property
def method(self): # type: () -> str
"""The name of the Ansible become plugin that is equivalent to this."""
return 'sudo'
class Su(Become):
"""Become using 'su'."""
@property
def method(self): # type: () -> str
"""The name of the Ansible become plugin that is equivalent to this."""
return 'su'
def prepare_command(self, command): # type: (t.List[str]) -> t.List[str]
"""Return the given command, if any, with privilege escalation."""
become = ['su', '-l', 'root']
if command:
become.extend(['-c', shlex.join(command)])
return become
class SuSudo(Su):
"""Become using 'su' in ansible-test and then after bootstrapping use 'sudo' for other ansible commands."""
@classmethod
def name(cls):
"""The name of this plugin."""
return 'su_sudo'
@property
def method(self): # type: () -> str
"""The name of the Ansible become plugin that is equivalent to this."""
return 'sudo'
class Sudo(Become):
"""Become using 'sudo'."""
@property
def method(self): # type: () -> str
"""The name of the Ansible become plugin that is equivalent to this."""
return 'sudo'
def prepare_command(self, command): # type: (t.List[str]) -> t.List[str]
"""Return the given command, if any, with privilege escalation."""
become = ['sudo', '-in']
if command:
become.extend(['sh', '-c', shlex.join(command)])
return become
SUPPORTED_BECOME_METHODS = {cls.name(): cls for cls in get_subclasses(Become)}