test the 3 run command modes- local,ssh and docker (#12)

* test the 3 run command modes- local,ssh and docker
* Add emptylines at the end of file

Signed-off-by: Divyashree Jayaram <divyashreej15@gmail.com>

Author: divyashreej

binnacle/__init__.py

@@ -1,4 +1,7 @@
-from binnacle.core import debug, show_summary
-from binnacle.plugins.http import http_get, http_post, http_put, http_delete, validated_json, http_base_url, http_set_header
-from binnacle.plugins.commands import command_run
-from binnacle.plugins.compare import compare_equal, compare_not_equal
+from binnacle.core import debug, show_summary
+from binnacle.plugins.http import http_get, http_post, http_put, http_delete, validated_json, http_base_url, http_set_header
+from binnacle.plugins.commands import (
+   command_run, command_mode, command_node, command_ssh_user,
+   command_ssh_sudo, command_ssh_pem_file, command_port, command_container
+)
+from binnacle.plugins.compare import compare_equal, compare_not_equal

binnacle/plugins/commands.py

@@ -1,62 +1,78 @@
-import subprocess
-
-from binnacle.core import binnacle_task
-
-
-def escaped_cmd(cmd):
-    return cmd.replace("'", """'"'"'""")
-
-
-def escaped_ssh_cmd(cmd):
-    cmd = f"/bin/bash -c '{escaped_cmd(cmd)}'"
-    cmd = f"sudo {cmd}" if _command_config.sudo else cmd
-
-    return escaped_cmd(cmd)
-
-
-def full_cmd(cmd):
-    if _command_config.mode in ["", "local"] or _command_config.node in ["", "local"]:
-        return cmd
-    
-    if _command_config.mode == "ssh":
-        return f"""ssh {_command_config.ssh_user}@{_command_config.node} \
-        -i {_command_config.ssh_pem_file} -p {_command_config.ssh_port}  \
-        '{escaped_ssh_cmd(cmd)}'
-        """
-    elif _command_config.mode == 'docker':
-        return f"""docker exec -i {_command_config.node} /bin/bash -c '{escaped_cmd(cmd)}'"""
-
-    return cmd
-
-
-@binnacle_task
-def command_run(cmd, ret = 0, task=None):
-    result = subprocess.run(cmd, shell=True, capture_output=True, universal_newlines=True)
-    task.ok = result.returncode == ret
-    if not task.ok:
-        task.info(f"Return code: {result.returncode}\n" + result.stderr.strip())
-    return result.stdout
-
-
-class CommandConfig:
-    def __init__(self):
-        self.node = ""
-        self.mode = ""
-        self.ssh_user = "root"
-        self.ssh_pem_file = ""
-
-
-_command_config = CommandConfig()
-
-
-def command_node(name):
-    _command_config.node = name
-
-
-def command_container(name):
-    _command_config.node = name
-
-
-def command_mode(name):
-    _command_config.mode = name
-
+import subprocess
+
+from binnacle.core import binnacle_task
+
+
+def escaped_cmd(cmd):
+    return cmd.replace("'", """'"'"'""")
+
+
+def escaped_ssh_cmd(cmd):
+    cmd = f"/bin/bash -c '{escaped_cmd(cmd)}'"
+    cmd = f"sudo {cmd}" if _command_config.sudo else cmd
+
+    return escaped_cmd(cmd)
+
+
+def full_cmd(cmd):
+    if _command_config.mode in ["", "local"] or _command_config.node in ["", "local"]:
+        return cmd
+    
+    if _command_config.mode == "ssh":
+        return f"""ssh {_command_config.ssh_user}@{_command_config.node} \
+        -i {_command_config.ssh_pem_file} -p {_command_config.ssh_port}  \
+        '{escaped_ssh_cmd(cmd)}'
+        """ 
+
+    elif _command_config.mode == 'docker':
+        return f"""docker exec -i {_command_config.node} /bin/bash -c '{escaped_cmd(cmd)}'"""
+
+    return cmd
+
+
+@binnacle_task
+def command_run(cmd, ret = 0, task=None):
+    cmd = full_cmd(cmd)
+    result = subprocess.run(cmd, shell=True, capture_output=True, universal_newlines=True)
+    task.ok = result.returncode == ret
+    if not task.ok:
+        task.info(f"Return code: {result.returncode}\n" + result.stderr.strip())
+    return result.stdout
+
+
+class CommandConfig:
+    def __init__(self):
+        self.node = ""
+        self.mode = ""
+        self.ssh_user = "root"
+        self.ssh_pem_file = ""
+        self.ssh_port = ""
+
+
+_command_config = CommandConfig()
+
+
+def command_node(name):
+    _command_config.node = name
+
+
+def command_container(name):
+    _command_config.node = name
+
+
+def command_mode(name):
+    _command_config.mode = name
+
+
+def command_ssh_user(name):
+    _command_config.ssh_user = name
+    
+def command_ssh_sudo(name):
+    _command_config.sudo = name
+
+def command_ssh_pem_file(name):
+    _command_config.ssh_pem_file = name
+
+def command_port(name):
+    _command_config.ssh_port = name
+    

test_commands_docker.py

@@ -0,0 +1,11 @@
+from binnacle import *
+
+#mode 3: docker
+command_mode("docker")
+command_container("server1")
+
+# Check if report is generated or a file exists in a container
+command_run("echo 'Hello World!' > /root/reports.txt")
+command_run("stat /root/reports.txt") #report exixts
+command_run("stat /root/reports1.txt 2>/dev/null && echo 'File exists' || echo 'File does not exist'") #report1 does not exixt
+

test_commands_local.py

@@ -0,0 +1,7 @@
+from binnacle import *
+
+#mode1: local
+validated_json('{"name": 100}')
+command_run("ls /tmp")
+command_run("stat /home/ubuntu/reports.pdf")
+

test_commands_ssh.py

@@ -0,0 +1,16 @@
+from binnacle import *
+
+#mode2: ssh
+command_mode("ssh")
+command_node("192.168.29.65")
+command_ssh_user("test1")
+command_ssh_sudo(False) 
+command_ssh_pem_file("~/.ssh/id_rsa")
+command_port("22")
+
+# All the future command_run will be executed as ssh command
+# unless command_node("local")
+command_run("cat /tmp/hello")
+show_summary()
+
+