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/add.py

@@ -0,0 +1,182 @@
+from typing import Any
+from zrb.builtin.group import project_add_group
+from zrb import Task, python_task, ResourceMaker, runner
+from zrb.builtin.generator.common.task_input import (
+    project_dir_input, app_name_input, app_image_name_input, env_prefix_input,
+    http_port_input
+)
+from zrb.builtin.generator.common.helper import (
+    validate_existing_project_dir, validate_inexisting_automation
+)
+from zrb.builtin.generator.common.task_factory import create_register_module
+from zrb.builtin.generator.project_task.task_factory import (
+    create_ensure_project_tasks, create_add_build_images_upstream,
+    create_add_deploy_upstream, create_add_destroy_upstream,
+    create_add_push_images_upstream, create_add_remove_containers_upstream,
+    create_add_start_containers_upstream, create_add_start_upstream,
+    create_add_stop_containers_upstream
+)
+
+import os
+
+CURRENT_DIR = os.path.dirname(__file__)
+SNAKE_APP_NAME_TPL = '{{util.to_snake_case(input.app_name)}}'
+KEBAB_APP_NAME_TPL = '{{util.to_kebab_case(app_name)}}'
+
+###############################################################################
+# Task Definitions
+###############################################################################
+
+
+@python_task(
+    name='validate',
+    inputs=[
+        project_dir_input,
+        app_name_input
+    ],
+)
+async def validate(*args: Any, **kwargs: Any):
+    project_dir = kwargs.get('project_dir')
+    validate_existing_project_dir(project_dir)
+    app_name = kwargs.get('app_name')
+    validate_inexisting_automation(project_dir, app_name)
+    source_dir = os.path.join(project_dir, 'src', f'{KEBAB_APP_NAME_TPL}')
+    if os.path.exists(source_dir):
+        raise Exception(f'Source already exists: {source_dir}')
+
+
+copy_resource = ResourceMaker(
+    name='copy-resource',
+    inputs=[
+        project_dir_input,
+        app_name_input,
+        app_image_name_input,
+        http_port_input,
+        env_prefix_input,
+    ],
+    upstreams=[validate],
+    replacements={
+        'zrbAppName': '{{input.app_name}}',
+        'zrbAppHttpPort': '{{util.coalesce(input.http_port, "3000")}}',
+        'ZRB_ENV_PREFIX': '{{util.coalesce(input.env_prefix, "MY").upper()}}',
+        'zrb-app-image-name': '{{input.app_image_name}}'
+    },
+    template_path=os.path.join(CURRENT_DIR, 'template'),
+    destination_path='{{ input.project_dir }}',
+    excludes=[
+        '*/deployment/venv',
+        '*/__pycache__',
+    ]
+)
+
+register_local_module = create_register_module(
+    module_path=f'_automate.{SNAKE_APP_NAME_TPL}.local',
+    alias=f'{SNAKE_APP_NAME_TPL}_local',
+    inputs=[app_name_input],
+    upstreams=[copy_resource]
+)
+
+register_container_module = create_register_module(
+    module_path=f'_automate.{SNAKE_APP_NAME_TPL}.container',
+    alias=f'{SNAKE_APP_NAME_TPL}_container',
+    inputs=[app_name_input],
+    upstreams=[register_local_module]
+)
+
+register_image_module = create_register_module(
+    module_path=f'_automate.{SNAKE_APP_NAME_TPL}.image',
+    alias=f'{SNAKE_APP_NAME_TPL}_image',
+    inputs=[app_name_input],
+    upstreams=[register_container_module]
+)
+
+register_deployment_module = create_register_module(
+    module_path=f'_automate.{SNAKE_APP_NAME_TPL}.deployment',
+    alias=f'{SNAKE_APP_NAME_TPL}_deployment',
+    inputs=[app_name_input],
+    upstreams=[register_image_module]
+)
+
+ensure_project_tasks = create_ensure_project_tasks(
+    upstreams=[copy_resource]
+)
+
+add_start_upstream = create_add_start_upstream(
+    upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.local',
+    upstream_task_var=f'start_{SNAKE_APP_NAME_TPL}',
+    upstreams=[ensure_project_tasks],
+    inputs=[app_name_input]
+)
+
+add_start_container_upstream = create_add_start_containers_upstream(
+    upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.container',
+    upstream_task_var=f'start_{SNAKE_APP_NAME_TPL}_container',
+    upstreams=[ensure_project_tasks],
+    inputs=[app_name_input]
+)
+
+add_stop_container_upstream = create_add_stop_containers_upstream(
+    upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.container',
+    upstream_task_var=f'stop_{SNAKE_APP_NAME_TPL}_container',
+    upstreams=[ensure_project_tasks],
+    inputs=[app_name_input]
+)
+
+add_remove_container_upstream = create_add_remove_containers_upstream(
+    upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.container',
+    upstream_task_var=f'remove_{SNAKE_APP_NAME_TPL}_container',
+    upstreams=[ensure_project_tasks],
+    inputs=[app_name_input]
+)
+
+add_build_image_upstream = create_add_build_images_upstream(
+    upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.image',
+    upstream_task_var=f'build_{SNAKE_APP_NAME_TPL}_image',
+    upstreams=[ensure_project_tasks],
+    inputs=[app_name_input]
+)
+
+add_push_image_upstream = create_add_push_images_upstream(
+    upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.image',
+    upstream_task_var=f'push_{SNAKE_APP_NAME_TPL}_image',
+    upstreams=[ensure_project_tasks],
+    inputs=[app_name_input]
+)
+
+add_deploy_upstream = create_add_deploy_upstream(
+    upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.deployment',
+    upstream_task_var=f'deploy_{SNAKE_APP_NAME_TPL}',
+    upstreams=[ensure_project_tasks],
+    inputs=[app_name_input]
+)
+
+add_destroy_upstream = create_add_destroy_upstream(
+    upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.deployment',
+    upstream_task_var=f'destroy_{SNAKE_APP_NAME_TPL}',
+    upstreams=[ensure_project_tasks],
+    inputs=[app_name_input]
+)
+
+
+@python_task(
+    name='simple-python-app',
+    group=project_add_group,
+    upstreams=[
+        register_local_module,
+        register_container_module,
+        register_image_module,
+        register_deployment_module,
+        add_start_upstream,
+        add_start_container_upstream,
+        add_stop_container_upstream,
+        add_remove_container_upstream,
+        add_build_image_upstream,
+        add_push_image_upstream,
+        add_deploy_upstream,
+        add_destroy_upstream
+    ],
+    runner=runner
+)
+async def add_simple_python_app(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get('_task')
+    task.print_out('Success')

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/_common.py

@@ -0,0 +1,38 @@
+from zrb import BoolInput, StrInput
+import os
+
+###############################################################################
+# Constants
+###############################################################################
+
+CURRENT_DIR = os.path.dirname(__file__)
+PROJECT_DIR = os.path.abspath(os.path.join(CURRENT_DIR, '..', '..'))
+RESOURCE_DIR = os.path.join(PROJECT_DIR, 'src', 'kebab-zrb-app-name')
+DEPLOYMENT_DIR = os.path.join(RESOURCE_DIR, 'deployment')
+APP_DIR = os.path.join(RESOURCE_DIR, 'src')
+TEMPLATE_ENV_FILE_NAME = os.path.join(APP_DIR, 'template.env')
+
+###############################################################################
+# Input Definitions
+###############################################################################
+
+local_input = BoolInput(
+    name='local-kebab-zrb-app-name',
+    description='Use "kebab-zrb-app-name" on local machine',
+    prompt='Use "kebab-zrb-app-name" on local machine?',
+    default=True
+)
+
+https_input = BoolInput(
+    name='kebab-zrb-app-name-https',
+    description='Whether "kebab-zrb-app-name" run on HTTPS',
+    prompt='Is "kebab-zrb-app-name" run on HTTPS?',
+    default=False
+)
+
+host_input = StrInput(
+    name='kebab-zrb-app-name-host',
+    description='Hostname of "kebab-zrb-app-name"',
+    prompt='Hostname of "kebab-zrb-app-name"',
+    default='localhost'
+)

zrb/builtin/generator/{fastapp/template/_automate/snake_zrb_app_name/cmd/prepare-load-test.sh → app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/cmd/app-activate-venv.sh}

@@ -1,5 +1,3 @@
-PYTHONUNBUFFERED=1
-
 if [ ! -d .venv ]
 then
   echo "Init virtual environment"
@@ -7,7 +5,3 @@ then
 fi
 echo "Activate virtual environment"
 source .venv/bin/activate
-
-echo "Install packages"
-pip install -r requirements.txt
-

zrb/builtin/generator/{simple_python_app/template/_automate/snake_zrb_app_name/cmd/start.sh → app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/cmd/app-start.sh}

@@ -1,13 +1,4 @@
 PYTHONUNBUFFERED=1
-
-if [ ! -d .venv ]
-then
-  echo "Init virtual environment"
-  python -m venv .venv
-fi
-echo "Activate virtual environment"
-source .venv/bin/activate
-
 echo "Install packages"
 pip install -r requirements.txt
 

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/cmd/pulumi-destroy.sh

@@ -0,0 +1 @@
+pulumi destroy --skip-preview

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/cmd/pulumi-init-stack.sh

@@ -0,0 +1 @@
+(pulumi stack select {{input.snake_zrb_app_name_pulumi_stack}} || pulumi stack init {{input.snake_zrb_app_name_pulumi_stack}})

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/cmd/pulumi-up.sh

@@ -0,0 +1 @@
+pulumi up --skip-preview

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/container.py

@@ -0,0 +1,148 @@
+from zrb import (
+    DockerComposeTask, Env, EnvFile, HTTPChecker, ServiceConfig, runner
+)
+from zrb.builtin.group import project_group
+from ._common import (
+    RESOURCE_DIR, APP_DIR, local_input, host_input, https_input
+)
+from .image import (
+    image_input, image_env, build_snake_zrb_app_name_image
+)
+import os
+
+###############################################################################
+# Env File Definitions
+###############################################################################
+
+compose_env_file = EnvFile(
+    env_file=os.path.join(RESOURCE_DIR, 'docker-compose.env'),
+    prefix='CONTAINER_ZRB_ENV_PREFIX'
+)
+
+###############################################################################
+# Env Definitions
+###############################################################################
+
+host_port_env = Env(
+    name='HOST_PORT',
+    os_name='CONTAINER_ZRB_ENV_PREFIX_HOST_PORT',
+    default='zrbAppHttpPort'
+)
+
+###############################################################################
+# Service Config Definitions
+###############################################################################
+
+snake_zrb_app_name_service_config = ServiceConfig(
+    env_files=[
+        EnvFile(
+            env_file=os.path.join(APP_DIR, 'template.env'),
+            prefix='CONTAINER_ZRB_ENV_PREFIX'
+        )
+    ]
+)
+
+###############################################################################
+# Task Definitions
+###############################################################################
+
+remove_snake_zrb_app_name_container = DockerComposeTask(
+    icon='💨',
+    name='remove-kebab-zrb-app-name-container',
+    description='Remove human readable zrb app name container',
+    group=project_group,
+    cwd=RESOURCE_DIR,
+    compose_cmd='down',
+    compose_env_prefix='CONTAINER_ZRB_ENV_PREFIX',
+    compose_service_configs={
+        'snake_zrb_app_name': snake_zrb_app_name_service_config
+    },
+    env_files=[compose_env_file],
+    envs=[
+        image_env,
+        host_port_env,
+    ],
+)
+runner.register(remove_snake_zrb_app_name_container)
+
+stop_snake_zrb_app_name_container = DockerComposeTask(
+    icon='⛔',
+    name='stop-kebab-zrb-app-name-container',
+    description='Stop human readable zrb app name container',
+    group=project_group,
+    cwd=RESOURCE_DIR,
+    compose_cmd='stop',
+    compose_env_prefix='CONTAINER_ZRB_ENV_PREFIX',
+    compose_service_configs={
+        'snake_zrb_app_name': snake_zrb_app_name_service_config
+    },
+    env_files=[compose_env_file],
+    envs=[
+        image_env,
+        host_port_env,
+    ],
+)
+runner.register(stop_snake_zrb_app_name_container)
+
+init_snake_zrb_app_name_container = DockerComposeTask(
+    icon='🔥',
+    name='init-kebab-zrb-app-name-container',
+    inputs=[
+        local_input,
+        host_input,
+        image_input,
+    ],
+    skip_execution='{{not input.local_snake_zrb_app_name}}',
+    upstreams=[
+        build_snake_zrb_app_name_image,
+        remove_snake_zrb_app_name_container
+    ],
+    cwd=RESOURCE_DIR,
+    compose_cmd='up',
+    compose_flags=['-d'],
+    compose_env_prefix='CONTAINER_ZRB_ENV_PREFIX',
+    compose_service_configs={
+        'snake_zrb_app_name': snake_zrb_app_name_service_config
+    },
+    env_files=[compose_env_file],
+    envs=[
+        image_env,
+        host_port_env,
+    ],
+)
+
+start_snake_zrb_app_name_container = DockerComposeTask(
+    icon='🐳',
+    name='start-kebab-zrb-app-name-container',
+    description='Start human readable zrb app name container',
+    group=project_group,
+    inputs=[
+        local_input,
+        host_input,
+        https_input,
+        image_input,
+    ],
+    skip_execution='{{not input.local_snake_zrb_app_name}}',
+    upstreams=[init_snake_zrb_app_name_container],
+    cwd=RESOURCE_DIR,
+    compose_cmd='logs',
+    compose_flags=['-f'],
+    compose_env_prefix='CONTAINER_ZRB_ENV_PREFIX',
+    compose_service_configs={
+        'snake_zrb_app_name': snake_zrb_app_name_service_config
+    },
+    env_files=[compose_env_file],
+    envs=[
+        image_env,
+        host_port_env,
+    ],
+    checkers=[
+        HTTPChecker(
+            name='check-kebab-zrb-app-name',
+            host='{{input.snake_zrb_app_name_host}}',
+            port='{{env.HOST_PORT}}',
+            is_https='{{input.snake_zrb_app_name_https}}'
+        )
+    ]
+)
+runner.register(start_snake_zrb_app_name_container)

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/deployment.py

@@ -0,0 +1,108 @@
+from zrb import CmdTask, Env, EnvFile, IntInput, StrInput, runner
+from zrb.builtin.group import project_group
+from .image import push_snake_zrb_app_name_image, image_input, image_env
+from ._common import (
+    CURRENT_DIR, DEPLOYMENT_DIR, TEMPLATE_ENV_FILE_NAME
+)
+import os
+
+###############################################################################
+# Input Definitions
+###############################################################################
+
+replica_input = IntInput(
+    name='kebab-zrb-app-name-replica',
+    description='Replica of "kebab-zrb-app-name"',
+    prompt='Replica of "kebab-zrb-app-name"',
+    default=1,
+)
+
+pulumi_stack_input = StrInput(
+    name='kebab-zrb-app-name-pulumi-stack',
+    description='Pulumi stack name for "kebab-zrb-app-name"',
+    prompt='Pulumi stack name for "kebab-zrb-app-name"',
+    default=os.getenv('ZRB_ENV', 'dev')
+)
+
+###############################################################################
+# Env File Definitions
+###############################################################################
+
+deployment_app_env_file = EnvFile(
+    env_file=TEMPLATE_ENV_FILE_NAME, prefix='DEPLOYMENT_APP_ZRB_ENV_PREFIX'
+)
+
+###############################################################################
+# Env Definitions
+###############################################################################
+
+pulumi_backend_url_env = Env(
+    name='PULUMI_BACKEND_URL',
+    os_name='PULUMI_ZRB_ENV_PREFIX_BACKEND_URL',
+    default=f'file://{DEPLOYMENT_DIR}/state'
+)
+
+pulumi_config_passphrase_env = Env(
+    name='PULUMI_CONFIG_PASSPHRASE',
+    os_name='PULUMI_ZRB_ENV_PREFIX_CONFIG_PASSPHRASE',
+    default='secret'
+)
+
+deployment_replica_env = Env(
+    name='REPLICA',
+    os_name='DEPLOYMENT_ZRB_ENV_PREFIX',
+    default='{{input.snake_zrb_app_name_replica}}'
+)
+
+###############################################################################
+# Task Definitions
+###############################################################################
+
+deploy_snake_zrb_app_name = CmdTask(
+    icon='🚧',
+    name='deploy-kebab-zrb-app-name',
+    description='Deploy human readable zrb app name',
+    group=project_group,
+    inputs=[
+        image_input,
+        replica_input,
+        pulumi_stack_input,
+    ],
+    upstreams=[push_snake_zrb_app_name_image],
+    cwd=DEPLOYMENT_DIR,
+    env_files=[deployment_app_env_file],
+    envs=[
+        pulumi_backend_url_env,
+        pulumi_config_passphrase_env,
+        image_env,
+        deployment_replica_env,
+    ],
+    cmd_path=[
+        os.path.join(CURRENT_DIR, 'cmd', 'pulumi-init-stack.sh'),
+        os.path.join(CURRENT_DIR, 'cmd', 'pulumi-up.sh'),
+    ]
+)
+runner.register(deploy_snake_zrb_app_name)
+
+destroy_snake_zrb_app_name = CmdTask(
+    icon='💨',
+    name='destroy-kebab-zrb-app-name',
+    description='Remove human readable zrb app name deployment',
+    group=project_group,
+    inputs=[
+        pulumi_stack_input,
+    ],
+    cwd=DEPLOYMENT_DIR,
+    env_files=[deployment_app_env_file],
+    envs=[
+        pulumi_backend_url_env,
+        pulumi_config_passphrase_env,
+        image_env,
+        deployment_replica_env,
+    ],
+    cmd_path=[
+        os.path.join(CURRENT_DIR, 'cmd', 'pulumi-init-stack.sh'),
+        os.path.join(CURRENT_DIR, 'cmd', 'pulumi-destroy.sh'),
+    ]
+)
+runner.register(destroy_snake_zrb_app_name)

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/image.py

@@ -0,0 +1,68 @@
+from zrb import DockerComposeTask, Env, StrInput, runner
+from zrb.builtin.group import project_group
+from ._common import (
+    RESOURCE_DIR, local_input
+)
+
+###############################################################################
+# Input Definitions
+###############################################################################
+
+image_input = StrInput(
+    name='kebab-zrb-app-name-image',
+    description='Image name of "kebab-zrb-app-name"',
+    prompt='Image name of "kebab-zrb-app-name"',
+    default='zrb-app-image-name:latest'
+)
+
+
+###############################################################################
+# Env Definitions
+###############################################################################
+
+image_env = Env(
+    name='IMAGE',
+    os_name='CONTAINER_ZRB_ENV_PREFIX_IMAGE',
+    default='{{input.snake_zrb_app_name_image}}'
+)
+
+###############################################################################
+# Task Definitions
+###############################################################################
+
+build_snake_zrb_app_name_image = DockerComposeTask(
+    icon='🏭',
+    name='build-kebab-zrb-app-name-image',
+    description='Build human readable zrb app name image',
+    group=project_group,
+    inputs=[
+        local_input,
+        image_input,
+    ],
+    envs=[image_env],
+    skip_execution='{{not input.local_snake_zrb_app_name}}',
+    cwd=RESOURCE_DIR,
+    compose_cmd='build',
+    compose_flags=[
+        '--no-cache'
+    ],
+    compose_env_prefix='CONTAINER_ZRB_ENV_PREFIX',
+)
+runner.register(build_snake_zrb_app_name_image)
+
+push_snake_zrb_app_name_image = DockerComposeTask(
+    icon='📰',
+    name='push-kebab-zrb-app-name-image',
+    description='Push human readable zrb app name image',
+    group=project_group,
+    inputs=[
+        local_input,
+        image_input,
+    ],
+    envs=[image_env],
+    upstreams=[build_snake_zrb_app_name_image],
+    cwd=RESOURCE_DIR,
+    compose_cmd='push',
+    compose_env_prefix='CONTAINER_ZRB_ENV_PREFIX',
+)
+runner.register(push_snake_zrb_app_name_image)

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/local.py

@@ -0,0 +1,54 @@
+from zrb import CmdTask, Env, EnvFile, HTTPChecker, runner
+from zrb.builtin.group import project_group
+from ._common import (
+    CURRENT_DIR, APP_DIR, TEMPLATE_ENV_FILE_NAME,
+    local_input, host_input, https_input
+)
+import os
+
+###############################################################################
+# Env File Definitions
+###############################################################################
+
+app_env_file = EnvFile(
+    env_file=TEMPLATE_ENV_FILE_NAME, prefix='ZRB_ENV_PREFIX'
+)
+
+###############################################################################
+# Task Definitions
+###############################################################################
+
+start_snake_zrb_app_name = CmdTask(
+    icon='🚤',
+    name='start-kebab-zrb-app-name',
+    description='Start human readable zrb app name',
+    group=project_group,
+    inputs=[
+        local_input,
+        host_input,
+        https_input
+    ],
+    skip_execution='{{not input.local_snake_zrb_app_name}}',
+    cwd=APP_DIR,
+    env_files=[app_env_file],
+    envs=[
+        Env(
+            name='APP_PORT',
+            os_name='ZRB_ENV_PREFIX_APP_PORT',
+            default='zrbAppHttpPort'
+        )
+    ],
+    cmd_path=[
+        os.path.join(CURRENT_DIR, 'cmd', 'app-activate-venv.sh'),
+        os.path.join(CURRENT_DIR, 'cmd', 'app-start.sh'),
+    ],
+    checkers=[
+        HTTPChecker(
+            name='check-kebab-zrb-app-name',
+            host='{{input.snake_zrb_app_name_host}}',
+            port='{{env.APP_PORT}}',
+            is_https='{{input.snake_zrb_app_name_https}}'
+        )
+    ]
+)
+runner.register(start_snake_zrb_app_name)

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

@@ -0,0 +1 @@
+._docker-compose.*.runtime.yml

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

@@ -0,0 +1,2 @@
+*.pyc
+venv/

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/deployment/Pulumi.yaml

@@ -0,0 +1,6 @@
+name: kebab-zrb-app-name
+runtime:
+  name: python
+  options:
+    virtualenv: venv
+description: A minimal Kubernetes Python Pulumi program