zrb 0.26.2__tar.gz → 0.27.0__tar.gz

{zrb-0.26.2 → zrb-0.27.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 0.26.2
+Version: 0.27.0
 Summary: A Framework to Enhance Your Workflow
 Home-page: https://github.com/state-alchemists/zrb
 License: AGPL-3.0-or-later
-Keywords: Automation,Task Runner,Code Generator,Low Code
+Keywords: Automation,Task Runner,Code Generator,Monorepo,Low Code
 Author: Go Frendi Gunawan
 Author-email: gofrendiasgard@gmail.com
 Requires-Python: >=3.10.0,<4.0.0

{zrb-0.26.2 → zrb-0.27.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zrb"
-version = "0.26.2"
+version = "0.27.0"
 description = "A Framework to Enhance Your Workflow"
 authors = ["Go Frendi Gunawan <gofrendiasgard@gmail.com>"]
 license = "AGPL-3.0-or-later"
@@ -8,7 +8,34 @@ readme = "README.md"
 homepage = "https://github.com/state-alchemists/zrb"
 repository = "https://github.com/state-alchemists/zrb"
 documentation = "https://github.com/state-alchemists/zrb"
-keywords = ["Automation", "Task Runner", "Code Generator", "Low Code"]
+keywords = ["Automation", "Task Runner", "Code Generator", "Monorepo", "Low Code"]
+exclude = [
+    "__pycache__",
+    "_images",
+    ".github",
+    ".pytest_cache",
+    ".venv",
+    ".vscode",
+    "dist",
+    "docker",
+    "docs",
+    "htmlcov",
+    "playground",
+    "test",
+    ".coverage",
+    ".coveragerc",
+    ".cprofile.prof",
+    ".cprofile.svg",
+    ".env",
+    ".flake8",
+    ".gitignore",
+    ".python-version",
+    "install.sh",
+    "project.sh",
+    "README.md",
+    "template.env",
+    "zrb_init.py"
+]
 
 [tool.poetry.dependencies]
 python = ">=3.10.0,<4.0.0"

{zrb-0.26.2 → zrb-0.27.0}/src/zrb/__init__.py

@@ -10,7 +10,6 @@ from zrb.task.any_task_event_handler import (
     OnTriggered,
     OnWaiting,
 )
-from zrb.task.base_remote_cmd_task import BaseRemoteCmdTask, RemoteConfig
 from zrb.task.checker import Checker
 from zrb.task.cmd_task import CmdTask
 from zrb.task.decorator import python_task
@@ -69,8 +68,6 @@ assert CmdTask
 assert DockerComposeTask
 assert DockerComposeStartTask
 assert ServiceConfig
-assert BaseRemoteCmdTask
-assert RemoteConfig
 assert RemoteCmdTask
 assert RsyncTask
 assert Notifier

{zrb-0.26.2 → zrb-0.27.0}/src/zrb/task/docker_compose_task.py

@@ -33,32 +33,33 @@ from zrb.task_input.any_input import AnyInput
 
 logger.debug(colored("Loading zrb.task.docker_compose_task", attrs=["dark"]))
 
+TDockerComposeTask = TypeVar("TDockerComposeTask", bound="DockerComposeTask")
 
-def _get_ensure_zrb_network_task(backend: str):
-    CURRENT_DIR = os.path.dirname(__file__)
-    SHELL_SCRIPT_DIR = os.path.join(CURRENT_DIR, "..", "shell-scripts")
-    ensure_container_backend = CmdTask(
-        name="ensure-compose-backend",
-        cmd_path=[
-            os.path.join(SHELL_SCRIPT_DIR, "_common-util.sh"),
-            os.path.join(SHELL_SCRIPT_DIR, f"ensure-{backend}-is-installed.sh"),
-        ],
-        preexec_fn=None,
-        should_print_cmd_result=False,
-    )
-    return CmdTask(
-        name="ensure-zrb-network",
-        cmd=[
-            f"{backend} network inspect zrb >/dev/null 2>&1 || \\",
-            f"{backend} network create -d bridge zrb",
-        ],
-        upstreams=[ensure_container_backend],
-        should_print_cmd_result=False,
-    )
-
+CURRENT_DIR = os.path.dirname(__file__)
+SHELL_SCRIPT_DIR = os.path.join(CURRENT_DIR, "..", "shell-scripts")
 
-TDockerComposeTask = TypeVar("TDockerComposeTask", bound="DockerComposeTask")
-ensure_zrb_network_task = _get_ensure_zrb_network_task(CONTAINER_BACKEND)
+ensure_container_backend = CmdTask(
+    name="ensure-compose-backend",
+    cmd_path=[
+        os.path.join(SHELL_SCRIPT_DIR, "_common-util.sh"),
+        os.path.join(SHELL_SCRIPT_DIR, f"ensure-{CONTAINER_BACKEND}-is-installed.sh"),
+    ],
+    preexec_fn=None,
+    should_print_cmd_result=False,
+    should_show_cmd=False,
+    should_show_working_directory=False,
+)
+ensure_zrb_network_task = CmdTask(
+    name="ensure-zrb-network",
+    cmd=[
+        f"{CONTAINER_BACKEND} network inspect zrb >/dev/null 2>&1 || \\",
+        f"{CONTAINER_BACKEND} network create -d bridge zrb",
+    ],
+    upstreams=[ensure_container_backend],
+    should_print_cmd_result=False,
+    should_show_cmd=False,
+    should_show_working_directory=False,
+)
 
 
 @typechecked
@@ -120,14 +121,13 @@ class DockerComposeTask(CmdTask):
         should_show_cmd: bool = True,
         should_show_working_directory: bool = True,
     ):
-        combined_env_files = list(env_files)
         CmdTask.__init__(
             self,
             name=name,
             group=group,
             inputs=inputs,
             envs=envs,
-            env_files=combined_env_files,
+            env_files=env_files,
             icon=icon,
             color=color,
             description=description,

{zrb-0.26.2 → zrb-0.27.0}/src/zrb/task/remote_cmd_task.py

@@ -6,6 +6,7 @@ from typing import Any, Optional, Union
 from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import JinjaTemplate
 from zrb.task.any_task import AnyTask
 from zrb.task.any_task_event_handler import (
     OnFailed,
@@ -16,7 +17,6 @@ from zrb.task.any_task_event_handler import (
     OnTriggered,
     OnWaiting,
 )
-from zrb.task.base_remote_cmd_task import BaseRemoteCmdTask, RemoteConfig
 from zrb.task.cmd_task import CmdTask, CmdVal
 from zrb.task_env.env import Env
 from zrb.task_env.env_file import EnvFile
@@ -37,15 +37,17 @@ ensure_ssh_is_installed = CmdTask(
         os.path.join(_SHELL_SCRIPT_DIR, "ensure-ssh-is-installed.sh"),
     ],
     preexec_fn=None,
+    should_print_cmd_result=False,
+    should_show_cmd=False,
+    should_show_working_directory=False,
 )
 
 
 @typechecked
-class RemoteCmdTask(BaseRemoteCmdTask):
+class RemoteCmdTask(CmdTask):
     def __init__(
         self,
         name: str,
-        remote_configs: Iterable[RemoteConfig],
         group: Optional[Group] = None,
         inputs: Iterable[AnyInput] = [],
         envs: Iterable[Env] = [],
@@ -54,9 +56,15 @@ class RemoteCmdTask(BaseRemoteCmdTask):
         color: Optional[str] = None,
         description: str = "",
         executable: Optional[str] = None,
+        remote_host: JinjaTemplate = "localhost",
+        remote_port: Union[JinjaTemplate, int] = 22,
+        remote_user: JinjaTemplate = "root",
+        remote_password: JinjaTemplate = "",
+        remote_ssh_key: JinjaTemplate = "",
         cmd: CmdVal = "",
         cmd_path: CmdVal = "",
         cwd: Optional[Union[str, pathlib.Path]] = None,
+        should_render_cwd: bool = True,
         upstreams: Iterable[AnyTask] = [],
         fallbacks: Iterable[AnyTask] = [],
         on_triggered: Optional[OnTriggered] = None,
@@ -74,18 +82,14 @@ class RemoteCmdTask(BaseRemoteCmdTask):
         max_error_line: int = 1000,
         preexec_fn: Optional[Callable[[], Any]] = os.setsid,
         should_execute: Union[bool, str, Callable[..., bool]] = True,
+        return_upstream_result: bool = False,
+        should_print_cmd_result: bool = True,
+        should_show_cmd: bool = True,
+        should_show_working_directory: bool = True,
     ):
-        pre_cmd = "\n".join(
-            [
-                _SSH_UTIL_SCRIPT,
-                "_SCRIPT=\"$(cat <<'ENDSCRIPT'",
-            ]
-        )
-        post_cmd = "\n".join(["ENDSCRIPT", ')"', 'auth_ssh "$_SCRIPT"'])
-        BaseRemoteCmdTask.__init__(
+        CmdTask.__init__(
             self,
             name=name,
-            remote_configs=remote_configs,
             group=group,
             inputs=inputs,
             envs=envs,
@@ -94,11 +98,10 @@ class RemoteCmdTask(BaseRemoteCmdTask):
             color=color,
             description=description,
             executable=executable,
-            pre_cmd=pre_cmd,
             cmd=cmd,
             cmd_path=cmd_path,
-            post_cmd=post_cmd,
             cwd=cwd,
+            should_render_cwd=should_render_cwd,
             upstreams=[ensure_ssh_is_installed] + upstreams,
             fallbacks=fallbacks,
             on_triggered=on_triggered,
@@ -116,4 +119,40 @@ class RemoteCmdTask(BaseRemoteCmdTask):
             max_error_line=max_error_line,
             preexec_fn=preexec_fn,
             should_execute=should_execute,
+            return_upstream_result=return_upstream_result,
+            should_print_cmd_result=should_print_cmd_result,
+            should_show_cmd=should_show_cmd,
+            should_show_working_directory=should_show_working_directory,
+        )
+        self._remote_host = remote_host
+        self._remote_port = remote_port
+        self._remote_user = remote_user
+        self._remote_password = remote_password
+        self._remote_ssh_key = remote_ssh_key
+
+    def get_cmd_script(self, *args: Any, **kwargs: Any) -> str:
+        cmd_script = self._create_cmd_script(self._cmd_path, self._cmd, *args, **kwargs)
+        cmd_script = "\n".join(
+            [
+                "_SCRIPT=$(cat << 'ENDSCRIPT'",
+                cmd_script,
+                "ENDSCRIPT",
+                ")",
+            ]
         )
+        ssh_command = self._get_ssh_command()
+        return "\n".join([cmd_script, ssh_command])
+
+    def _get_ssh_command(self) -> str:
+        host = self.render_str(self._remote_host)
+        port = self.render_str(self._remote_port)
+        user = self.render_str(self._remote_user)
+        password = self.render_str(self._remote_password)
+        key = self.render_str(self._remote_ssh_key)
+        if key != "" and password != "":
+            return f'sshpass -p "{password}" ssh -t -p "{port}" -i "{key}" "{user}@{host}" "$_SCRIPT"'  # noqa
+        if key != "":
+            return f'ssh -t -p "{port}" -i "{key}" "{user}@{host}" "$_SCRIPT"'
+        if password != "":
+            return f'sshpass -p "{password}" ssh -t -p "{port}" "{user}@{host}" "$_SCRIPT"'  # noqa
+        return f'ssh -t -p "{port}" "{user}@{host}" "$_SCRIPT"'

{zrb-0.26.2 → zrb-0.27.0}/src/zrb/task/rsync_task.py

@@ -17,7 +17,6 @@ from zrb.task.any_task_event_handler import (
     OnTriggered,
     OnWaiting,
 )
-from zrb.task.base_remote_cmd_task import BaseRemoteCmdTask, RemoteConfig
 from zrb.task.cmd_task import CmdTask
 from zrb.task_env.env import Env
 from zrb.task_env.env_file import EnvFile
@@ -39,19 +38,17 @@ ensure_rsync_is_installed = CmdTask(
         os.path.join(_SHELL_SCRIPT_DIR, "ensure-rsync-is-installed.sh"),
     ],
     preexec_fn=None,
+    should_print_cmd_result=False,
+    should_show_cmd=False,
+    should_show_working_directory=False,
 )
 
 
 @typechecked
-class RsyncTask(BaseRemoteCmdTask):
+class RsyncTask(CmdTask):
     def __init__(
         self,
         name: str,
-        remote_configs: Iterable[RemoteConfig],
-        src: JinjaTemplate,
-        dst: JinjaTemplate,
-        src_is_remote: bool = False,
-        dst_is_remote: bool = True,
         group: Optional[Group] = None,
         inputs: Iterable[AnyInput] = [],
         envs: Iterable[Env] = [],
@@ -60,7 +57,17 @@ class RsyncTask(BaseRemoteCmdTask):
         color: Optional[str] = None,
         description: str = "",
         executable: Optional[str] = None,
-        cwd: Optional[Union[str, pathlib.Path]] = None,
+        remote_host: JinjaTemplate = "localhost",
+        remote_port: Union[JinjaTemplate, int] = 22,
+        remote_user: JinjaTemplate = "root",
+        remote_password: JinjaTemplate = "",
+        remote_ssh_key: JinjaTemplate = "",
+        src_path: JinjaTemplate = ".",
+        src_is_remote: bool = False,
+        dst_path: JinjaTemplate = ".",
+        dst_is_remote: bool = True,
+        cwd: Optional[Union[JinjaTemplate, pathlib.Path]] = None,
+        should_render_cwd: bool = True,
         upstreams: Iterable[AnyTask] = [],
         fallbacks: Iterable[AnyTask] = [],
         on_triggered: Optional[OnTriggered] = None,
@@ -78,14 +85,14 @@ class RsyncTask(BaseRemoteCmdTask):
         max_error_line: int = 1000,
         preexec_fn: Optional[Callable[[], Any]] = os.setsid,
         should_execute: Union[bool, str, Callable[..., bool]] = True,
+        return_upstream_result: bool = False,
+        should_print_cmd_result: bool = True,
+        should_show_cmd: bool = True,
+        should_show_working_directory: bool = True,
     ):
-        parsed_src = self._get_parsed_path(src_is_remote, src)
-        parsed_dst = self._get_parsed_path(dst_is_remote, dst)
-        cmd = f'auth_rsync "{parsed_src}" "{parsed_dst}"'
-        BaseRemoteCmdTask.__init__(
+        CmdTask.__init__(
             self,
             name=name,
-            remote_configs=remote_configs,
             group=group,
             inputs=inputs,
             envs=envs,
@@ -94,9 +101,8 @@ class RsyncTask(BaseRemoteCmdTask):
             color=color,
             description=description,
             executable=executable,
-            pre_cmd=_RSYNC_UTIL_SCRIPT,
-            cmd=cmd,
             cwd=cwd,
+            should_render_cwd=should_render_cwd,
             upstreams=[ensure_rsync_is_installed] + upstreams,
             fallbacks=fallbacks,
             on_triggered=on_triggered,
@@ -114,9 +120,39 @@ class RsyncTask(BaseRemoteCmdTask):
             max_error_line=max_error_line,
             preexec_fn=preexec_fn,
             should_execute=should_execute,
+            return_upstream_result=return_upstream_result,
+            should_print_cmd_result=should_print_cmd_result,
+            should_show_cmd=should_show_cmd,
+            should_show_working_directory=should_show_working_directory,
         )
+        self._remote_host = remote_host
+        self._remote_port = remote_port
+        self._remote_user = remote_user
+        self._remote_password = remote_password
+        self._remote_ssh_key = remote_ssh_key
+        self._src_path = src_path
+        self._src_is_remote = src_is_remote
+        self._dst_path = dst_path
+        self._dst_is_remote = dst_is_remote
+
+    def get_cmd_script(self, *args: Any, **kwargs: Any) -> str:
+        port = self.render_str(self._remote_port)
+        password = self.render_str(self._remote_password)
+        key = self.render_str(self._remote_ssh_key)
+        src = self._get_path(self._src_path, self._src_is_remote)
+        dst = self._get_path(self._dst_path, self._dst_is_remote)
+        if key != "" and password != "":
+            return f'sshpass -p "{password}" rsync --mkpath -avz -e "ssh -i {key} -p {port}" {src} {dst}'  # noqa
+        if key != "":
+            return f'rsync --mkpath -avz -e "ssh -i {key} -p {port}" {src} {dst}'
+        if password != "":
+            return f'sshpass -p "{password}" rsync --mkpath -avz -e "ssh -p {port}" {src} {dst}'  # noqa
+        return f'rsync --mkpath -avz -e "ssh -p {port}" {src} {dst}'
 
-    def _get_parsed_path(self, is_remote: bool, path: str) -> str:
-        if not is_remote:
-            return path
-        return "${_CONFIG_USER}@${_CONFIG_HOST}:" + path
+    def _get_path(self, resource_path: str, is_remote: bool) -> str:
+        rendered_path = self.render_str(resource_path)
+        if is_remote:
+            host = self.render_str(self._remote_host)
+            user = self.render_str(self._remote_user)
+            return f"{user}@{host}:{rendered_path}"
+        return rendered_path