# -*- coding: utf-8 -*-

from pyckles import AutoPycklet


class ExecuteShell(AutoPycklet):
    """Execute a single command. The command will be processed through the shell, so it will reckognize environment
     variables like ``$HOME``,  and can be used to do shell operation like "<", ">", etc.

     Behind the scenes, this uses the ['shell' Ansible module](https://docs.ansible.com/ansible/latest/modules/shell_module.html),
     so check its documentation for more details.

       Args:
         become_user: The user to execute this command as.
         chdir: The working directory.
         command: The command to execute.
         environment: A dictionary of environment variables to add/set.
         ignore_error: Whether to ignore any potential errors.
         no_log: Whether to hide the log of this command (because for example the command contains sensitive information).
         shell_executable: The (absolute path to the) shell executable to use.

    """

    FRECKLET_ID = "execute-shell"

    def __init__(
        self,
        become_user=None,
        chdir=None,
        command=None,
        environment=None,
        ignore_error=None,
        no_log=None,
        shell_executable=None,
    ):

        super(ExecuteShell, self).__init__(
            var_names=[
                "become_user",
                "chdir",
                "command",
                "environment",
                "ignore_error",
                "no_log",
                "shell_executable",
            ]
        )
        self._become_user = become_user
        self._chdir = chdir
        self._command = command
        self._environment = environment
        self._ignore_error = ignore_error
        self._no_log = no_log
        self._shell_executable = shell_executable

    @property
    def become_user(self):
        return self._become_user

    @become_user.setter
    def become_user(self, become_user):
        self._become_user = become_user

    @property
    def chdir(self):
        return self._chdir

    @chdir.setter
    def chdir(self, chdir):
        self._chdir = chdir

    @property
    def command(self):
        return self._command

    @command.setter
    def command(self, command):
        self._command = command

    @property
    def environment(self):
        return self._environment

    @environment.setter
    def environment(self, environment):
        self._environment = environment

    @property
    def ignore_error(self):
        return self._ignore_error

    @ignore_error.setter
    def ignore_error(self, ignore_error):
        self._ignore_error = ignore_error

    @property
    def no_log(self):
        return self._no_log

    @no_log.setter
    def no_log(self, no_log):
        self._no_log = no_log

    @property
    def shell_executable(self):
        return self._shell_executable

    @shell_executable.setter
    def shell_executable(self, shell_executable):
        self._shell_executable = shell_executable