feat: bash with shell (#4966)

Author: shahargl

docs/snippets/providers/bash-snippet-autogenerated.mdx

@@ -1,4 +1,4 @@
-{/* This snippet is automatically generated using scripts/docs_render_provider_snippets.py 
+{/* This snippet is automatically generated using scripts/docs_render_provider_snippets.py
 Do not edit it manually, as it will be overwritten */}
 
 
@@ -14,8 +14,9 @@ steps:
       provider: bash
       config: "{{ provider.my_provider_name }}"
       with:
-        timeout: {value}  
-        command: {value}  
+        timeout: {value}
+        command: {value}
+        shell: {value}
 ```
 
 

keep/providers/bash_provider/bash_provider.py

@@ -1,6 +1,7 @@
 """
 BashProvider is a class that implements the BaseOutputProvider.
 """
+
 import shlex
 import subprocess
 
@@ -20,80 +21,104 @@ def validate_config(self):
         pass
 
     def _query(
-            self,
-            timeout: int = 60,
-            command: str = "",
-            **kwargs
-            ):
+        self, timeout: int = 60, command: str = "", shell: bool = False, **kwargs
+    ):
         """Bash provider eval shell command to get results
 
         Returns:
             _type_: _description_
         """
-        # timeout = kwargs.get("timeout", 60)
-        # command = kwargs.get("command", "")
         parsed_command = self.io_handler.parse(command)
-        # parse by pipes
-        parsed_commands = parsed_command.split("|")
-        # Initialize the input for the first command
-        input_stream = None
-
-        processes = []
-
-        for cmd in parsed_commands:
-            # Split the command string into a list of arguments
-            cmd_args = shlex.split(cmd.strip())
-
-            # Run the command and pipe its output to the next command, capturing stderr
-            process = subprocess.Popen(
-                cmd_args,
-                stdin=input_stream,
-                stdout=subprocess.PIPE,
-                stderr=subprocess.PIPE,
-            )
-
-            if input_stream is not None:
-                # Close the input_stream (output of the previous command)
-                input_stream.close()
-
-            # Update input_stream to be the output of the current command
-            input_stream = process.stdout
-
-            # Append the current process to the list of processes
-            processes.append(process)
-
-        # Get the final output
-        try:
-            stdout, stderr = processes[-1].communicate(timeout=timeout)
-            return_code = processes[-1].returncode
-            # stdout and stderr are strings or None
-            if stdout or stdout == b"":
-                stdout = stdout.decode()
-
-            if stderr or stderr == b"":
-                stderr = stderr.decode()
-        except subprocess.TimeoutExpired:
-            # use check_output to get the output of the last process
-            # this is some MacOS bug, where communicate() doesn't work and raise TimeoutExpired (idk why but it works on Linux)
+
+        if shell:
+            # Use shell=True for complex commands
+            try:
+                result = subprocess.run(
+                    parsed_command,
+                    shell=True,
+                    capture_output=True,
+                    timeout=timeout,
+                    text=True,
+                )
+                return {
+                    "stdout": result.stdout,
+                    "stderr": result.stderr,
+                    "return_code": result.returncode,
+                }
+            except subprocess.TimeoutExpired:
+                try:
+                    self.logger.warning(
+                        "TimeoutExpired, using check_output - MacOS bug?"
+                    )
+                    stdout = subprocess.check_output(
+                        parsed_command,
+                        stderr=subprocess.STDOUT,
+                        timeout=timeout,
+                        shell=True,
+                    ).decode()
+                    return {
+                        "stdout": stdout,
+                        "stderr": None,
+                        "return_code": 0,
+                    }
+                except Exception as e:
+                    return {
+                        "stdout": None,
+                        "stderr": str(e),
+                        "return_code": -1,
+                    }
+        else:
+            # Original logic for simple commands
+            parsed_commands = parsed_command.split("|")
+            input_stream = None
+            processes = []
+
+            for cmd in parsed_commands:
+                cmd_args = shlex.split(cmd.strip())
+                process = subprocess.Popen(
+                    cmd_args,
+                    stdin=input_stream,
+                    stdout=subprocess.PIPE,
+                    stderr=subprocess.PIPE,
+                )
+
+                if input_stream is not None:
+                    input_stream.close()
+
+                input_stream = process.stdout
+                processes.append(process)
+
             try:
-                self.logger.warning("TimeoutExpired, using check_output - MacOS bug?")
-                stdout = subprocess.check_output(
-                    cmd, stderr=subprocess.STDOUT, timeout=timeout, shell=True
-                ).decode()
-                stderr = None
-                return_code = 0
-                self.logger.warning("check_output worked")
-            # todo: fix that
-            except Exception as e:
-                stdout = None
-                stderr = e.args[1].decode()
-                return_code = e.args[0]
-
-        return {
-            "stdout": str(stdout),
-            "stderr": str(stderr),
-            "return_code": return_code,
-        }
+                stdout, stderr = processes[-1].communicate(timeout=timeout)
+                return_code = processes[-1].returncode
+
+                if stdout or stdout == b"":
+                    stdout = stdout.decode()
+                if stderr or stderr == b"":
+                    stderr = stderr.decode()
+            except subprocess.TimeoutExpired:
+                try:
+                    self.logger.warning(
+                        "TimeoutExpired, using check_output - MacOS bug?"
+                    )
+                    stdout = subprocess.check_output(
+                        parsed_command,
+                        stderr=subprocess.STDOUT,
+                        timeout=timeout,
+                        shell=True,
+                    ).decode()
+                    stderr = None
+                    return_code = 0
+                except Exception as e:
+                    stdout = None
+                    stderr = str(e)
+                    return_code = -1
+
+            return {
+                "stdout": str(stdout),
+                "stderr": str(stderr),
+                "return_code": return_code,
+            }
 
     def dispose(self):
         """

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "keep"
-version = "0.45.0"
+version = "0.45.1"
 description = "Alerting. for developers, by developers."
 authors = ["Keep Alerting LTD"]
 packages = [{include = "keep"}]