Class ShellScriptAction

st2common/st2common/models/system/action.py:225–331

class ShellScriptAction(ShellCommandAction):
    def __init__(
        self,
        name,
        action_exec_id,
        script_local_path_abs,
        named_args=None,
        positional_args=None,
        env_vars=None,
        user=None,
        sudo=False,
        timeout=None,
        cwd=None,
        sudo_password=None,
    ):
        super(ShellScriptAction, self).__init__(
            name=name,
            action_exec_id=action_exec_id,
            command=None,
            user=user,
            env_vars=env_vars,
            sudo=sudo,
            timeout=timeout,
            cwd=cwd,
            sudo_password=sudo_password,
        )
        self.script_local_path_abs = script_local_path_abs
        self.named_args = named_args
        self.positional_args = positional_args

    def get_full_command_string(self):
        return self._format_command()

    def _format_command(self):
        script_arguments = self._get_script_arguments(
            named_args=self.named_args, positional_args=self.positional_args
        )
        if self.sudo:
            if script_arguments:
                command = quote_unix(
                    "%s %s" % (self.script_local_path_abs, script_arguments)
                )
            else:
                command = quote_unix(self.script_local_path_abs)

            sudo_arguments = " ".join(self._get_common_sudo_arguments())
            command = "sudo %s -- bash -c %s" % (sudo_arguments, command)
        else:
            if self.user and self.user != LOGGED_USER_USERNAME:
                # Need to use sudo to run as a different user
                user = quote_unix(self.user)

                if script_arguments:
                    command = quote_unix(
                        "%s %s" % (self.script_local_path_abs, script_arguments)
                    )
                else:
                    command = quote_unix(self.script_local_path_abs)