zrb 0.0.85__py3-none-any.whl → 0.0.87__py3-none-any.whl

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/deployment/__main__.py

@@ -0,0 +1,79 @@
+'''A Kubernetes Python Pulumi program to deploy kebab-zrb-app-name'''
+
+from dotenv import dotenv_values
+import pulumi
+import pulumi_kubernetes as k8s
+import os
+
+CURRENT_DIR = os.path.dirname(__file__)
+APP_DIR = os.path.abspath(os.path.join(CURRENT_DIR, '..', 'src'))
+TEMPLATE_ENV_FILE_NAME = os.path.join(APP_DIR, 'template.env')
+
+image = os.getenv('IMAGE', 'kebab-zrb-app-name:latest')
+replica = int(os.getenv('REPLICA', '1'))
+app_labels = {'app': 'kebab-zrb-app-name'}
+env_map = dotenv_values(TEMPLATE_ENV_FILE_NAME)
+app_port = int(os.getenv('APP_PORT', env_map.get('APP_PORT', '8080')))
+
+# Pulumi deployment docs:
+# https://www.pulumi.com/registry/packages/kubernetes/api-docs/apps/v1/deployment/
+deployment = k8s.apps.v1.Deployment(
+    resource_name='kebab-zrb-app-name',
+    spec=k8s.apps.v1.DeploymentSpecArgs(
+        selector=k8s.meta.v1.LabelSelectorArgs(match_labels=app_labels),
+        replicas=replica,
+        template=k8s.core.v1.PodTemplateSpecArgs(
+            metadata=k8s.meta.v1.ObjectMetaArgs(labels=app_labels),
+            spec=k8s.core.v1.PodSpecArgs(
+                containers=[
+                    k8s.core.v1.ContainerArgs(
+                        name='kebab-zrb-app-name',
+                        image=image,
+                        env=[
+                            k8s.core.v1.EnvVarArgs(
+                                name=env_name,
+                                value=os.getenv(env_name, default_value)
+                            )
+                            for env_name, default_value in env_map.items()
+                        ],
+                        ports=[
+                            k8s.core.v1.ContainerPortArgs(
+                                container_port=app_port
+                            )
+                        ],
+                        liveness_probe=k8s.core.v1.ProbeArgs(
+                            http_get=k8s.core.v1.HTTPGetActionArgs(
+                                port=app_port
+                            )
+                        ),
+                        readiness_probe=k8s.core.v1.ProbeArgs(
+                            http_get=k8s.core.v1.HTTPGetActionArgs(
+                                port=app_port
+                            )
+                        ),
+                    )
+                ]
+            )
+        )
+    )
+)
+
+# Pulumi services docs:
+# https://www.pulumi.com/registry/packages/kubernetes/api-docs/core/v1/service/
+service = k8s.core.v1.Service(
+    resource_name='kebab-zrb-app-name',
+    spec=k8s.core.v1.ServiceSpecArgs(
+        selector=app_labels,
+        ports=[
+            k8s.core.v1.ServicePortArgs(
+                port=app_port,
+                protocol="TCP",
+                target_port=app_port,
+            )
+        ],
+        type='LoadBalancer',
+    )
+)
+
+pulumi.export('deployment-name', deployment.metadata['name'])
+pulumi.export('service-name', service.metadata['name'])

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/deployment/requirements.txt

@@ -0,0 +1,3 @@
+pulumi>=3.0.0,<4.0.0
+pulumi-kubernetes>=3.0.0,<4.2.0
+python-dotenv==1.0.0

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/docker-compose.env

@@ -0,0 +1,3 @@
+CONTAINER_PREFIX=my
+HOST_PORT=zrbAppHttpPort
+APP_PORT=zrbAppHttpPort

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/docker-compose.yml

@@ -0,0 +1,20 @@
+version: '3'
+networks:
+  zrb:
+    name: zrb
+services:
+  snake_zrb_app_name:
+    build: src
+    image: ${IMAGE:-kebab-zrb-app-name}
+    container_name: ${CONTAINER_PREFIX:-my}-kebab-zrb-app-name
+    hostname: kebab-zrb-app-name
+    ports:
+    - "${HOST_PORT:-8080}:${APP_PORT:-8080}"
+    restart: unless-stopped
+    healthcheck:
+      test: ["CMD-SHELL", "curl --fail http://localhost:${APP_PORT:-8080}/ || exit 1"]
+      interval: 5s
+      timeout: 1s
+      retries: 30
+    networks:
+      - zrb

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/src/.dockerignore

@@ -0,0 +1,3 @@
+.env
+__pycache__
+.venv

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/src/.gitignore

@@ -0,0 +1,3 @@
+.env
+__pycache__
+.venv

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/src/Dockerfile

@@ -0,0 +1,7 @@
+FROM python:3.10-slim
+ENV APP_MESSAGE "Hello, world!"
+ENV APP_PORT 8080
+WORKDIR /home
+COPY . .
+RUN pip install -r requirements.txt
+CMD uvicorn main:app --host "0.0.0.0" --port "$APP_PORT"

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/src/main.py

@@ -0,0 +1,20 @@
+import os
+
+MESSAGE = os.getenv('APP_MESSAGE', 'Hello, world!')
+PORT = int(os.getenv('APP_PORT', '8000'))
+
+
+async def app(scope, receive, send):
+    assert scope['type'] == 'http'
+
+    await send({
+        'type': 'http.response.start',
+        'status': 200,
+        'headers': [
+            [b'content-type', b'text/plain'],
+        ],
+    })
+    await send({
+        'type': 'http.response.body',
+        'body': bytes(MESSAGE, 'utf-8'),
+    })

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/src/requirements.txt

@@ -0,0 +1 @@
+uvicorn==0.20.0

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/src/template.env

@@ -0,0 +1,4 @@
+PYTHONUNBUFFERED=1
+APP_HOST=0.0.0.0
+APP_MESSAGE="Salve Mane"
+APP_PORT="zrbAppHttpPort"

zrb/builtin/generator/cmd_task/add.py

@@ -1,16 +1,18 @@
 from typing import Any
-from ..._group import project_add_group
+from ..common.task_input import project_dir_input, task_name_input
+from ..common.helper import (
+    validate_existing_project_dir, validate_inexisting_automation
+)
+from ..common.task_factory import create_register_module
+from ...group import project_add_group
 from ....task.task import Task
 from ....task.decorator import python_task
 from ....task.resource_maker import ResourceMaker
 from ....runner import runner
-from .._common.input import project_dir_input, task_name_input
-from .._common.helper import validate_project_dir, create_register_task_module
-from ....helper import util
 
 import os
 
-current_dir = os.path.dirname(__file__)
+CURRENT_DIR = os.path.dirname(__file__)
 
 ###############################################################################
 # Task Definitions
@@ -26,13 +28,9 @@ current_dir = os.path.dirname(__file__)
 )
 async def validate(*args: Any, **kwargs: Any):
     project_dir = kwargs.get('project_dir')
-    validate_project_dir(project_dir)
+    validate_existing_project_dir(project_dir)
     task_name = kwargs.get('task_name')
-    automation_file = os.path.join(
-        project_dir, '_automate', f'{util.to_snake_case(task_name)}.py'
-    )
-    if os.path.exists(automation_file):
-        raise Exception(f'Automation file already exists: {automation_file}')
+    validate_inexisting_automation(project_dir, task_name)
 
 
 copy_resource = ResourceMaker(
@@ -45,14 +43,16 @@ copy_resource = ResourceMaker(
     replacements={
         'zrbTaskName': '{{input.task_name}}',
     },
-    template_path=os.path.join(current_dir, 'template'),
+    template_path=os.path.join(CURRENT_DIR, 'template'),
     destination_path='{{ input.project_dir }}',
     excludes=[
         '*/__pycache__',
     ]
 )
 
-register_task_module = create_register_task_module(
+register_module = create_register_module(
+    module_path='_automate.{{util.to_snake_case(input.task_name)}}',
+    inputs=[task_name_input],
     upstreams=[copy_resource]
 )
 
@@ -60,7 +60,7 @@ register_task_module = create_register_task_module(
 @python_task(
     name='cmd-task',
     group=project_add_group,
-    upstreams=[register_task_module],
+    upstreams=[register_module],
     runner=runner
 )
 async def add_cmd_task(*args: Any, **kwargs: Any):

zrb/builtin/generator/cmd_task/template/_automate/snake_zrb_task_name.py

@@ -1,5 +1,5 @@
 from zrb import CmdTask, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 
 ###############################################################################
 # Task Definitions

zrb/builtin/generator/common/helper.py

@@ -0,0 +1,57 @@
+from typing import Optional
+from typeguard import typechecked
+from ....helper.codemod.add_assert_resource import add_assert_resource
+from ....helper.codemod.add_import_module import add_import_module
+from ....helper.file.text import read_text_file_async, write_text_file_async
+from ....helper import util
+import os
+
+
+@typechecked
+def validate_existing_project_dir(project_dir: str):
+    if not os.path.isfile(os.path.join(project_dir, 'zrb_init.py')):
+        raise Exception(f'Not a project: {project_dir}')
+
+
+@typechecked
+def validate_inexisting_automation(project_dir: str, automation_name: str):
+    validate_inexisting_automation_package(project_dir, automation_name)
+    validate_inexisting_automation_module(project_dir, automation_name)
+
+
+@typechecked
+def validate_inexisting_automation_package(
+    project_dir: str, package_name: str
+):
+    package_dir = os.path.join(
+        project_dir, '_automate', f'{util.to_snake_case(package_name)}'
+    )
+    if os.path.exists(package_dir):
+        raise Exception(f'Automation package already exists: {package_dir}')
+
+
+@typechecked
+def validate_inexisting_automation_module(project_dir: str, module_name: str):
+    module_file = os.path.join(
+        project_dir, '_automate', f'{util.to_snake_case(module_name)}.py'
+    )
+    if os.path.exists(module_file):
+        raise Exception(f'Automation module already exists: {module_file}')
+
+
+@typechecked
+async def register_module_to_project(
+    project_dir: str, module_path: str, alias: Optional[str] = None
+):
+    zrb_init_path = os.path.join(project_dir, 'zrb_init.py')
+    code = await read_text_file_async(zrb_init_path)
+    if alias is None:
+        alias = module_path.split('.')[-1]
+    code = add_import_module(
+        code=code,
+        module_path=module_path,
+        alias=alias
+    )
+    code = add_assert_resource(code, alias)
+    await write_text_file_async(zrb_init_path, code)
+    return True

zrb/builtin/generator/common/task_factory.py

@@ -0,0 +1,82 @@
+from typing import Any, List, Optional
+from typeguard import typechecked
+from .task_input import project_dir_input
+from .helper import validate_existing_project_dir, register_module_to_project
+from ....task.decorator import python_task
+from ....task.any_task import AnyTask
+from ....task.task import Task
+from ....task_input.any_input import AnyInput
+from ....helper.file.text import read_text_file_async, write_text_file_async
+from ....helper.codemod.add_import_module import add_import_module
+from ....helper.codemod.add_upstream_to_task import add_upstream_to_task
+import os
+
+
+@typechecked
+def create_register_module(
+    module_path: str,
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None,
+    alias: Optional[str] = None
+) -> Task:
+    @python_task(
+        name='register-module',
+        inputs=[project_dir_input] + inputs if inputs is not None else [],
+        upstreams=upstreams if upstreams is not None else []
+    )
+    async def register_module(*args: Any, **kwargs: Any):
+        task: Task = kwargs.get('_task')
+        project_dir = kwargs.get('project_dir')
+        validate_existing_project_dir(project_dir)
+        rendered_module_path = task.render_str(module_path)
+        rendered_alias: Optional[str] = None
+        if alias is not None:
+            rendered_alias = task.render_str(alias)
+        task.print_out(
+            f'Register module: {rendered_module_path}' +
+            f' as {rendered_alias}' if rendered_alias is not None else ''
+        )
+        await register_module_to_project(
+            project_dir=project_dir,
+            module_path=rendered_module_path,
+            alias=rendered_alias
+        )
+    return register_module
+
+
+@typechecked
+def create_add_upstream(
+    task_file_name: str,
+    task_name: str,
+    upstream_module: str,
+    upstream_task_var: str,
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
+) -> Task:
+    @python_task(
+        name='register-upstream',
+        inputs=[project_dir_input] + inputs if inputs is not None else [],
+        upstreams=upstreams if upstreams is not None else []
+    )
+    async def register_upstream(*args: Any, **kwargs: Any):
+        task: Task = kwargs.get('_task')
+        project_dir = kwargs.get('project_dir', '.')
+        rendered_task_file_name = task.render_str(task_file_name)
+        rendered_task_name = task.render_str(task_name)
+        rendered_upstream_module_path = task.render_str(upstream_module)
+        rendered_upstream_task_var = task.render_str(upstream_task_var)
+        if not os.path.isabs(rendered_task_file_name):
+            rendered_task_file_name = os.path.join(
+                project_dir, rendered_task_file_name
+            )
+        code = await read_text_file_async(rendered_task_file_name)
+        code = add_import_module(
+            code=code,
+            module_path=rendered_upstream_module_path,
+            resource=rendered_upstream_task_var
+        )
+        code = add_upstream_to_task(
+            code, rendered_task_name, rendered_upstream_task_var
+        )
+        await write_text_file_async(rendered_task_file_name, code)
+    return register_upstream

zrb/builtin/generator/{_common/input.py → common/task_input.py}

@@ -3,6 +3,8 @@ from ....task_input.int_input import IntInput
 from ....helper.accessories.name import get_random_name
 import os
 
+SYSTEM_USER = os.getenv('USER', 'incognito')
+
 project_dir_input = StrInput(
     name='project-dir',
     shortcut='d',
@@ -29,7 +31,7 @@ app_name_input = StrInput(
 
 app_image_default_namespace = os.getenv(
     'PROJECT_IMAGE_DEFAULT_NAMESPACE',
-    'docker.io/' + os.getenv('USER', 'library')
+    'docker.io/' + SYSTEM_USER
 )
 app_image_name_input = StrInput(
     name='app-image-name',
@@ -107,3 +109,46 @@ env_prefix_input = StrInput(
     prompt='OS environment prefix',
     default='{{util.to_snake_case(util.coalesce(input.app_name, input.task_name, "MY")).upper()}}',  # noqa
 )
+
+package_name_input = StrInput(
+    name='package-name',
+    shortcut='p',
+    description='Package name',
+    prompt='Package name',
+    default=get_random_name()
+)
+
+package_description_input = StrInput(
+    name='package-description',
+    description='Package description',
+    prompt='Package description',
+    default='My super package'
+)
+
+package_homepage_input = StrInput(
+    name='package-homepage',
+    description='Package homepage',
+    prompt='Package homepage',
+    default='https://github.com/' + SYSTEM_USER + '/{{util.to_kebab_case(input.package_name)}}'  # noqa
+)
+
+package_bug_tracker_input = StrInput(
+    name='package-bug-tracker',
+    description='Package bug tracker',
+    prompt='Package bug tracker',
+    default='https://github.com/' + SYSTEM_USER + '/{{util.to_kebab_case(input.package_name)}}/issues' # noqa
+)
+
+package_author_name_input = StrInput(
+    name='package-author-name',
+    prompt='Package author name',
+    description='Package author name',
+    default=SYSTEM_USER
+)
+
+package_author_email_input = StrInput(
+    name='package-author-email',
+    prompt='Package author email',
+    description='Package author email',
+    default=f'{SYSTEM_USER}@gmail.com'
+)

zrb/builtin/generator/docker_compose_task/add.py

@@ -1,19 +1,22 @@
 from typing import Any
-from ..._group import project_add_group
+from ..common.task_input import (
+   project_dir_input, task_name_input, http_port_input, env_prefix_input
+)
+from ..common.helper import (
+    validate_existing_project_dir, validate_inexisting_automation
+)
+from ..common.task_factory import create_register_module
+from ...group import project_add_group
 from ....task.task import Task
 from ....task.decorator import python_task
 from ....task_input.str_input import StrInput
 from ....task.resource_maker import ResourceMaker
 from ....runner import runner
-from .._common.input import (
-   project_dir_input, task_name_input, http_port_input, env_prefix_input
-)
-from .._common.helper import validate_project_dir, create_register_task_module
 from ....helper import util
 
 import os
 
-current_dir = os.path.dirname(__file__)
+CURRENT_DIR = os.path.dirname(__file__)
 
 ###############################################################################
 # Task Definitions
@@ -29,13 +32,9 @@ current_dir = os.path.dirname(__file__)
 )
 async def validate(*args: Any, **kwargs: Any):
     project_dir = kwargs.get('project_dir')
-    validate_project_dir(project_dir)
+    validate_existing_project_dir(project_dir)
     task_name = kwargs.get('task_name')
-    automation_file = os.path.join(
-        project_dir, '_automate', f'{util.to_snake_case(task_name)}.py'
-    )
-    if os.path.exists(automation_file):
-        raise Exception(f'Automation file already exists: {automation_file}')
+    validate_inexisting_automation(project_dir, task_name)
     source_dir = os.path.join(
         project_dir, 'src', f'{util.to_kebab_case(task_name)}'
     )
@@ -64,11 +63,13 @@ copy_resource = ResourceMaker(
         'zrbComposeCommand': '{{ util.coalesce(input.compose_command, "up") }}', # noqa
         'ZRB_ENV_PREFIX': '{{ util.coalesce(input.env_prefix, "MY").upper() }}', # noqa
     },
-    template_path=os.path.join(current_dir, 'template'),
+    template_path=os.path.join(CURRENT_DIR, 'template'),
     destination_path='{{ input.project_dir }}',
 )
 
-register_task_module = create_register_task_module(
+register_module = create_register_module(
+    module_path='_automate.{{util.to_snake_case(input.task_name)}}',
+    inputs=[task_name_input],
     upstreams=[copy_resource]
 )
 
@@ -76,7 +77,7 @@ register_task_module = create_register_task_module(
 @python_task(
     name='docker-compose-task',
     group=project_add_group,
-    upstreams=[register_task_module],
+    upstreams=[register_module],
     runner=runner
 )
 async def add_docker_compose_task(*args: Any, **kwargs: Any):

zrb/builtin/generator/docker_compose_task/template/_automate/snake_zrb_task_name.py

@@ -1,5 +1,5 @@
 from zrb import DockerComposeTask, HTTPChecker, Env, EnvFile, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 import os
 
 ###############################################################################