Source code for spicerack.interactive

"""Interactive module."""
import getpass
import logging
import os
import sys

from spicerack.exceptions import SpicerackError

logger = logging.getLogger(__name__)  # pylint: disable=invalid-name

[docs]def ask_confirmation(message: str) -> None: """Ask the use for confirmation in interactive mode. Arguments: message (str): the message to be printed before asking for confirmation. Raises: SpicerackError: on too many invalid answers or if not in a TTY. """ if not sys.stdout.isatty(): raise SpicerackError('Not in a TTY, unable to ask for confirmation') print(message) print('Type "done" to proceed') for _ in range(3): resp = input('> ') if resp == 'done': break print('Invalid response, please type "done" to proceed. After 3 wrong answers the task will be aborted.') else: raise SpicerackError('Too many invalid confirmation answers')
[docs]def get_username() -> str: """Detect and return the name of the effective running user even if run as root. Returns: str: the name of the effective running user or ``-`` if unable to detect it. """ user = os.getenv('USER') sudo_user = os.getenv('SUDO_USER') if sudo_user is not None and sudo_user != 'root': return sudo_user if user is not None: return user return '-'
[docs]def ensure_shell_is_durable() -> None: """Ensure it is running either in non-interactive mode or in a screen/tmux session, raise otherwise. Raises: spicerack.exceptions.SpicerackError: if in a non-durable shell session. """ # STY is for screen, TMUX is for tmux. Not using `getenv('NAME') is not None` to check they are not empty. # TODO: verify if the check on TERM is redundant. if (sys.stdout.isatty() and not os.getenv('STY', '') and not os.getenv('TMUX', '') and 'screen' not in os.getenv('TERM', '')): raise SpicerackError('Must be run in non-interactive mode or inside a screen or tmux.')
[docs]def get_management_password() -> str: """Get the management password either from the environment or asking for it. Returns: str: the password. Raises: spicerack.exceptions.SpicerackError: if the password is empty. """ password = os.getenv('MGMT_PASSWORD') if password is None: logger.debug('MGMT_PASSWORD environment variable not found') # Ask for a password, raise exception if not a tty password = get_secret('Management Password') else:'Using Management Password from the MGMT_PASSWORD environment variable') if not password: raise SpicerackError('Empty Management Password') return password
[docs]def get_secret(title: str, *, confirm: bool = False) -> str: """Ask the user for a secret e.g. password. Arguments: title (str): The message to show the user. confirm (bool, optional): If :py:data:`True` ask the user to confirm the password. Returns: str: the secret. """ new_secret = getpass.getpass(prompt='{}: '.format(title)) while len(new_secret) < MIN_SECRET_SIZE: new_secret = getpass.getpass( prompt='Secret must be at least {} characters. try again: '.format(MIN_SECRET_SIZE)) if confirm and new_secret != getpass.getpass(prompt='Again, just to be sure: '): raise SpicerackError('{}: Passwords did not match'.format(title)) return new_secret