zrb 0.0.38__py3-none-any.whl → 0.0.40__py3-none-any.whl

zrb/builtin/__init__.py

@@ -12,6 +12,7 @@ from .generator.cmd_task import add as generate_cmd_task
 from .generator.docker_compose_task import add as generate_docker_compose_task
 from .generator.python_task import add as generate_python_task
 from .generator.simple_python_app import add as generate_simple_python_app
+from .generator.fastapp import add as generate_fastapp
 
 assert base64
 assert env
@@ -27,3 +28,4 @@ assert generate_cmd_task
 assert generate_docker_compose_task
 assert generate_python_task
 assert generate_simple_python_app
+assert generate_fastapp

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

@@ -31,7 +31,10 @@ snake_task_name = DockerComposeTask(
         ),
     ],
     checkers=[
-        HTTPChecker(port='{{env.HOST_PORT}}')
+        HTTPChecker(
+            name='check-kebab-app-name',
+            port='{{env.HOST_PORT}}'
+        )
     ]
 )
 runner.register(snake_task_name)

zrb/builtin/generator/fastapp/add.py

@@ -0,0 +1,131 @@
+from typing import Any
+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 import (
+    default_app_inputs, project_dir_input, app_name_input,
+    validate_project_dir, create_register_local_app_module,
+    create_register_container_app_module, create_register_image_app_module,
+    create_register_deployment_app_module, get_default_app_replacements,
+    get_default_app_replacement_middlewares, new_app_scaffold_lock
+)
+from ..project_task.task_factory import (
+    create_add_project_automation, create_register_app_start,
+    create_register_app_start_container, create_register_app_stop_container,
+    create_register_app_remove_container, create_register_app_build_image,
+    create_register_app_push_image, create_register_app_deploy,
+    create_register_app_destroy
+)
+from ....helper import util
+
+import os
+
+# Common definitions
+
+current_dir = os.path.dirname(__file__)
+
+
+@python_task(
+    name='task-validate-create',
+    inputs=[project_dir_input, app_name_input],
+)
+async def validate(*args: Any, **kwargs: Any):
+    project_dir = kwargs.get('project_dir')
+    validate_project_dir(project_dir)
+    app_name = kwargs.get('app_name')
+    automation_dir = os.path.join(
+        project_dir, '_automate', util.to_snake_case(app_name)
+    )
+    if os.path.isdir(automation_dir):
+        raise Exception(f'Directory already exists: {automation_dir}')
+
+
+copy_resource = ResourceMaker(
+    name='copy-resource',
+    inputs=default_app_inputs,
+    upstreams=[validate],
+    replacements=get_default_app_replacements(),
+    replacement_middlewares=get_default_app_replacement_middlewares(),
+    template_path=os.path.join(current_dir, 'template'),
+    destination_path='{{ input.project_dir }}',
+    scaffold_locks=[new_app_scaffold_lock],
+    excludes=['*/deployment/venv']
+)
+
+register_local_app_module = create_register_local_app_module(
+    upstreams=[copy_resource]
+)
+
+register_container_app_module = create_register_container_app_module(
+    upstreams=[copy_resource]
+)
+
+register_image_app_module = create_register_image_app_module(
+    upstreams=[copy_resource]
+)
+
+register_deployment_app_module = create_register_deployment_app_module(
+    upstreams=[copy_resource]
+)
+
+add_project_task = create_add_project_automation(
+    upstreams=[copy_resource]
+)
+
+register_start = create_register_app_start(
+    upstreams=[add_project_task]
+)
+
+register_start_container = create_register_app_start_container(
+    upstreams=[add_project_task]
+)
+
+register_stop_container = create_register_app_stop_container(
+    upstreams=[add_project_task]
+)
+
+register_remove_container = create_register_app_remove_container(
+    upstreams=[add_project_task]
+)
+
+register_push_image = create_register_app_push_image(
+    upstreams=[add_project_task]
+)
+
+register_build_image = create_register_app_build_image(
+    upstreams=[add_project_task]
+)
+
+register_deploy = create_register_app_deploy(
+    upstreams=[add_project_task]
+)
+
+register_destroy = create_register_app_destroy(
+    upstreams=[add_project_task]
+)
+
+
+@python_task(
+    name='fastapp',
+    group=project_add_group,
+    upstreams=[
+        register_local_app_module,
+        register_container_app_module,
+        register_image_app_module,
+        register_deployment_app_module,
+        register_start,
+        register_start_container,
+        register_stop_container,
+        register_remove_container,
+        register_build_image,
+        register_push_image,
+        register_deploy,
+        register_destroy
+    ],
+    runner=runner
+)
+async def add_simple_python_app(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get('_task')
+    task.print_out('Success')

zrb/builtin/generator/fastapp/template/_automate/snake_app_name/app/app_env.py

@@ -0,0 +1,16 @@
+from zrb import Env, EnvFile
+from ..common import TEMPLATE_ENV_FILE_NAME
+
+app_env_file = EnvFile(env_file=TEMPLATE_ENV_FILE_NAME, prefix='ENV_PREFIX')
+app_envs = [
+    Env(
+        name='APP_PORT',
+        os_name='ENV_PREFIX_APP_PORT',
+        default='httpPort'
+    ),
+    Env(
+        name='APP_BROKER_TYPE',
+        os_name='ENV_PREFIX_APP_BROKER_TYPE',
+        default='rabbitmq'
+    )
+]

zrb/builtin/generator/fastapp/template/_automate/snake_app_name/cmd/pulumi-destroy.sh

@@ -0,0 +1,2 @@
+(pulumi stack select {{input.snake_app_name_pulumi_stack}} || pulumi stack init {{input.snake_app_name_pulumi_stack}})
+pulumi destroy --skip-preview

zrb/builtin/generator/fastapp/template/_automate/snake_app_name/cmd/pulumi-up.sh

@@ -0,0 +1,2 @@
+(pulumi stack select {{input.snake_app_name_pulumi_stack}} || pulumi stack init {{input.snake_app_name_pulumi_stack}})
+pulumi up --skip-preview

zrb/builtin/generator/fastapp/template/_automate/snake_app_name/cmd/start.sh

@@ -0,0 +1,15 @@
+PYTHONUNBUFFERED=1
+
+if [ ! -d venv ]
+then
+  echo "Init venv"
+  python -m venv venv
+fi
+echo "Activate venv"
+source venv/bin/activate
+
+echo "Install packages"
+pip install -r requirements.txt
+
+echo "Start app"
+uvicorn main:app --host {{env.get("APP_HOST", "0.0.0.0")}} --port {{env.get("APP_PORT", "8080")}} {{ "--reload" if util.to_boolean(env.get("APP_RELOAD", "true")) else "" }}

zrb/builtin/generator/fastapp/template/_automate/snake_app_name/common.py

@@ -0,0 +1,81 @@
+from zrb import BoolInput, IntInput, StrInput, Env
+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-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')
+
+# Inputs
+
+local_input = BoolInput(
+    name='local-kebab-app-name',
+    description='Use local "kebab-app-name"',
+    prompt='Use local "kebab-app-name"?',
+    default=True
+)
+
+https_input = BoolInput(
+    name='kebab-app-name-https',
+    description='Whether "kebab-app-name" run on HTTPS',
+    prompt='Is "kebab-app-name" run on HTTPS?',
+    default=False
+)
+
+host_input = StrInput(
+    name='kebab-app-name-host',
+    description='Hostname of "kebab-app-name"',
+    prompt='Hostname of "kebab-app-name"',
+    default='localhost'
+)
+
+image_input = StrInput(
+    name='kebab-app-name-image',
+    description='Image name of "kebab-app-name"',
+    prompt='Image name of "kebab-app-name"',
+    default='app-image-name:latest'
+)
+
+replica_input = IntInput(
+    name='kebab-app-name-replica',
+    description='Replica of "kebab-app-name"',
+    prompt='Replica of "kebab-app-name"',
+    default=1,
+)
+
+pulumi_stack_input = StrInput(
+    name='kebab-app-name-pulumi-stack',
+    description='Pulumi stack name for "kebab-app-name"',
+    prompt='Pulumi stack name for "kebab-app-name"',
+    default=os.getenv('ZRB_ENV', 'dev')
+)
+
+# Envs
+
+image_env = Env(
+    name='IMAGE',
+    os_name='CONTAINER_ENV_PREFIX_IMAGE',
+    default='{{input.snake_app_name_image}}'
+)
+
+pulumi_backend_url_env = Env(
+    name='PULUMI_BACKEND_URL',
+    os_name='PULUMI_ENV_PREFIX_BACKEND_URL',
+    default=f'file://{DEPLOYMENT_DIR}/state'
+)
+
+pulumi_config_passphrase_env = Env(
+    name='PULUMI_CONFIG_PASSPHRASE',
+    os_name='PULUMI_ENV_PREFIX_CONFIG_PASSPHRASE',
+    default='secret'
+)
+
+deployment_replica_env = Env(
+    name='REPLICA',
+    os_name='DEPLOYMENT_ENV_PREFIX',
+    default='{{input.snake_app_name_replica}}'
+)

zrb/builtin/generator/fastapp/template/_automate/snake_app_name/compose/compose_checker.py

@@ -0,0 +1,49 @@
+from zrb import HTTPChecker, PortChecker
+
+rabbitmq_management_checker = HTTPChecker(
+    name='check-rabbitmq-management',
+    port='{{env.get("RABBITMQ_MANAGEMENT_HOST_PORT", "15672")}}',
+    is_https='{{input.snake_app_name_https}}',
+    skip_execution='{{env.get("APP_BROKER_TYPE", "rabbitmq") != "rabbitmq"}}'
+)
+
+rabbitmq_checker = PortChecker(
+    name='check-rabbitmq',
+    port='{{env.get("RABBITMQ_HOST_PORT", "5672")}}',
+    skip_execution='{{env.get("APP_BROKER_TYPE", "rabbitmq") != "rabbitmq"}}'
+)
+
+redpanda_console_checker = HTTPChecker(
+    name='check-redpanda-console',
+    port='{{env.get("REDPANDA_CONSOLE_HOST_PORT", "9000")}}',
+    is_https='{{input.snake_app_name_https}}',
+    skip_execution='{{env.get("APP_BROKER_TYPE", "rabbitmq") != "kafka"}}'
+)
+
+kafka_plaintext_checker = HTTPChecker(
+    name='check-kafka-plaintext',
+    port='{{env.get("KAFKA_PLAINTEXT_HOST_PORT", "29092")}}',
+    is_https='{{input.snake_app_name_https}}',
+    skip_execution='{{env.get("APP_BROKER_TYPE", "rabbitmq") != "kafka"}}'
+)
+
+kafka_outside_checker = HTTPChecker(
+    name='check-kafka-outside',
+    port='{{env.get("KAFKA_OUTSIDE_HOST_PORT", "9092")}}',
+    is_https='{{input.snake_app_name_https}}',
+    skip_execution='{{env.get("APP_BROKER_TYPE", "rabbitmq") != "kafka"}}'
+)
+
+pandaproxy_plaintext_checker = HTTPChecker(
+    name='check-pandaproxy-plaintext',
+    port='{{env.get("PANDAPROXY_PLAINTEXT_HOST_PORT", "29092")}}',
+    is_https='{{input.snake_app_name_https}}',
+    skip_execution='{{env.get("APP_BROKER_TYPE", "rabbitmq") != "kafka"}}'
+)
+
+pandaproxy_outside_checker = HTTPChecker(
+    name='check-pandaproxy-outside',
+    port='{{env.get("PANDAPROXY_OUTSIDE_HOST_PORT", "9092")}}',
+    is_https='{{input.snake_app_name_https}}',
+    skip_execution='{{env.get("APP_BROKER_TYPE", "rabbitmq") != "kafka"}}'
+)

zrb/builtin/generator/fastapp/template/_automate/snake_app_name/compose/compose_env.py

@@ -0,0 +1,52 @@
+from zrb import Env
+from ..common import image_env
+
+compose_env_prefix = 'CONTAINER_ENV_PREFIX'
+compose_envs = [
+    image_env,
+    Env(
+        name='APP_BROKER_TYPE',
+        os_name='CONTAINER_ENV_PREFIX_APP_BROKER_TYPE',
+        default='rabbitmq'
+    ),
+    Env(
+        name='APP_HOST_PORT',
+        os_name='CONTAINER_ENV_PREFIX_APP_HOST_PORT',
+        default='httpPort'
+    ),
+    Env(
+        name='RABBITMQ_HOST_PORT',
+        os_name='CONTAINER_ENV_PREFIX_RABBITMQ_HOST_PORT',
+        default='5672'
+    ),
+    Env(
+        name='RABBITMQ_MANAGEMENT_HOST_PORT',
+        os_name='CONTAINER_ENV_PREFIX_RABBITMQ_MANAGEMENT_HOST_PORT',
+        default='15672'
+    ),
+    Env(
+        name='REDPANDA_CONSOLE_HOST_PORT',
+        os_name='CONTAINER_ENV_PREFIX_REDPANDA_CONSOLE_HOST_PORT',
+        default='9000'
+    ),
+    Env(
+        name='KAFKA_PLAINTEXT_HOST_PORT',
+        os_name='CONTAINER_ENV_PREFIX_KAFKA_PLAINTEXT_HOST_PORT',
+        default='29092'
+    ),
+    Env(
+        name='KAFKA_OUTSIDE_HOST_PORT',
+        os_name='CONTAINER_ENV_PREFIX_KAFKA_OUTSIDE_HOST_PORT',
+        default='9092'
+    ),
+    Env(
+        name='PANDAPROXY_PLAINTEXT_HOST_PORT',
+        os_name='CONTAINER_ENV_PREFIX_PANDAPROXY_PLAINTEXT_HOST_PORT',
+        default='29092'
+    ),
+    Env(
+        name='PANDAPROXY_OUTSIDE_HOST_PORT',
+        os_name='CONTAINER_ENV_PREFIX_PANDAPROXY_OUTSIDE_HOST_PORT',
+        default='9092'
+    ),
+]

zrb/builtin/generator/fastapp/template/_automate/snake_app_name/container.py

@@ -0,0 +1,91 @@
+from zrb import DockerComposeTask, Env, HTTPChecker, runner
+from zrb.builtin._group import project_group
+from .common import (
+    RESOURCE_DIR,
+    local_input, host_input, https_input, image_input
+)
+from .image import build_snake_app_name_image
+from .compose.compose_env import compose_env_prefix, compose_envs
+from .compose.compose_checker import (
+    rabbitmq_checker, rabbitmq_management_checker,
+    redpanda_console_checker, kafka_outside_checker,
+    kafka_plaintext_checker, pandaproxy_outside_checker,
+    pandaproxy_plaintext_checker
+)
+
+
+remove_snake_app_name_container = DockerComposeTask(
+    icon='💨',
+    name='remove-kebab-app-name-container',
+    description='Rumove human readable app name container',
+    group=project_group,
+    cwd=RESOURCE_DIR,
+    compose_cmd='down',
+    compose_env_prefix=compose_env_prefix,
+    envs=compose_envs,
+)
+runner.register(remove_snake_app_name_container)
+
+start_snake_app_name_container = DockerComposeTask(
+    icon='🐳',
+    name='start-kebab-app-name-container',
+    description='Start human readable app name container',
+    group=project_group,
+    inputs=[
+        local_input,
+        host_input,
+        https_input,
+        image_input,
+    ],
+    skip_execution='{{not input.local_snake_app_name}}',
+    upstreams=[
+        build_snake_app_name_image,
+        remove_snake_app_name_container
+    ],
+    cwd=RESOURCE_DIR,
+    compose_cmd='up',
+    compose_env_prefix=compose_env_prefix,
+    envs=compose_envs + [
+        Env(
+            name='COMPOSE_PROFILES',
+            os_name='',
+            default=' '.join([
+                '{{',
+                '",".join([',
+                '  env.get("APP_BROKER_TYPE", "rabbitmq"),',
+                '  "monolith"',
+                '])',
+                '}}'
+            ])
+        )
+    ],
+    checkers=[
+        HTTPChecker(
+            name='check-kebab-app-name-monolith',
+            host='{{input.snake_app_name_host}}',
+            url='/readiness',
+            port='{{env.get("HOST_PORT", "httpPort")}}',
+            is_https='{{input.snake_app_name_https}}'
+        ),
+        rabbitmq_checker,
+        rabbitmq_management_checker,
+        kafka_outside_checker,
+        kafka_plaintext_checker,
+        redpanda_console_checker,
+        pandaproxy_outside_checker,
+        pandaproxy_plaintext_checker,
+    ]
+)
+runner.register(start_snake_app_name_container)
+
+stop_snake_app_name_container = DockerComposeTask(
+    icon='⛔',
+    name='stop-kebab-app-name-container',
+    description='Stop human readable app name container',
+    group=project_group,
+    cwd=RESOURCE_DIR,
+    compose_cmd='stop',
+    compose_env_prefix=compose_env_prefix,
+    envs=compose_envs,
+)
+runner.register(stop_snake_app_name_container)

zrb/builtin/generator/fastapp/template/_automate/snake_app_name/deployment.py

@@ -0,0 +1,55 @@
+from typing import List
+from zrb import Input, CmdTask, Env, EnvFile, runner
+from zrb.builtin._group import project_group
+from .image import push_snake_app_name_image
+from .common import (
+    CURRENT_DIR, DEPLOYMENT_DIR, TEMPLATE_ENV_FILE_NAME,
+    image_input, pulumi_stack_input, replica_input, image_env,
+    deployment_replica_env, pulumi_backend_url_env,
+    pulumi_config_passphrase_env
+)
+import os
+
+app_env_file = EnvFile(
+    env_file=TEMPLATE_ENV_FILE_NAME, prefix='DEPLOYMENT_APP_ENV_PREFIX'
+)
+
+deployment_inputs: List[Input] = [
+    image_input,
+    replica_input,
+    pulumi_stack_input,
+]
+
+deployment_envs: List[Env] = [
+    pulumi_backend_url_env,
+    pulumi_config_passphrase_env,
+    image_env,
+    deployment_replica_env,
+]
+
+deploy_snake_app_name = CmdTask(
+    icon='🚧',
+    name='deploy-kebab-app-name',
+    description='Deploy human readable app name',
+    group=project_group,
+    inputs=deployment_inputs,
+    upstreams=[push_snake_app_name_image],
+    cwd=DEPLOYMENT_DIR,
+    env_files=[app_env_file],
+    envs=deployment_envs,
+    cmd_path=os.path.join(CURRENT_DIR, 'cmd', 'pulumi-up.sh'),
+)
+runner.register(deploy_snake_app_name)
+
+destroy_snake_app_name = CmdTask(
+    icon='💨',
+    name='destroy-kebab-app-name',
+    description='Remove human readable app name deployment',
+    group=project_group,
+    inputs=deployment_inputs,
+    cwd=DEPLOYMENT_DIR,
+    env_files=[app_env_file],
+    envs=deployment_envs,
+    cmd_path=os.path.join(CURRENT_DIR, 'cmd', 'pulumi-destroy.sh'),
+)
+runner.register(destroy_snake_app_name)

zrb/builtin/generator/fastapp/template/_automate/snake_app_name/image.py

@@ -0,0 +1,44 @@
+from typing import List
+from zrb import Input, DockerComposeTask, runner
+from zrb.builtin._group import project_group
+from .common import (
+    RESOURCE_DIR,
+    local_input, image_input, image_env
+)
+
+compose_inputs: List[Input] = [
+    local_input,
+    image_input,
+]
+compose_env_prefix = 'CONTAINER_ENV_PREFIX'
+
+build_snake_app_name_image = DockerComposeTask(
+    icon='🏭',
+    name='build-kebab-app-name-image',
+    description='Build human readable app name image',
+    group=project_group,
+    inputs=compose_inputs,
+    envs=[image_env],
+    skip_execution='{{not input.local_snake_app_name}}',
+    cwd=RESOURCE_DIR,
+    compose_cmd='build',
+    compose_flags=[
+        '--no-cache'
+    ],
+    compose_env_prefix=compose_env_prefix,
+)
+runner.register(build_snake_app_name_image)
+
+push_snake_app_name_image = DockerComposeTask(
+    icon='📰',
+    name='push-kebab-app-name-image',
+    description='Push human readable app name image',
+    group=project_group,
+    inputs=compose_inputs,
+    envs=[image_env],
+    upstreams=[build_snake_app_name_image],
+    cwd=RESOURCE_DIR,
+    compose_cmd='push',
+    compose_env_prefix=compose_env_prefix,
+)
+runner.register(push_snake_app_name_image)

zrb/builtin/generator/fastapp/template/_automate/snake_app_name/local.py

@@ -0,0 +1,92 @@
+from zrb import CmdTask, DockerComposeTask, Env, HTTPChecker, runner
+from zrb.builtin._group import project_group
+from .common import (
+    CURRENT_DIR, APP_DIR, RESOURCE_DIR,
+    local_input, host_input, https_input, image_input
+)
+from .image import build_snake_app_name_image
+from .app.app_env import app_env_file, app_envs
+from .container import remove_snake_app_name_container
+from .compose.compose_env import compose_env_prefix, compose_envs
+from .compose.compose_checker import (
+    rabbitmq_checker, rabbitmq_management_checker,
+    redpanda_console_checker, kafka_outside_checker,
+    kafka_plaintext_checker, pandaproxy_outside_checker,
+    pandaproxy_plaintext_checker
+)
+import os
+
+start_snake_app_name_support_container = DockerComposeTask(
+    icon='🐳',
+    name='start-kebab-app-name-support-container',
+    description='Start human readable app name container',
+    inputs=[
+        local_input,
+        host_input,
+        https_input,
+        image_input,
+    ],
+    skip_execution=' '.join([
+        '{{',
+        'not input.local_snake_app_name',
+        'or env.get("APP_BROKER_TYPE") == "mock"',
+        '}}',
+    ]),
+    upstreams=[
+        build_snake_app_name_image,
+        remove_snake_app_name_container
+    ],
+    cwd=RESOURCE_DIR,
+    compose_cmd='up',
+    compose_env_prefix=compose_env_prefix,
+    envs=compose_envs + app_envs + [
+        Env(
+            name='COMPOSE_PROFILES',
+            os_name='',
+            default=' '.join([
+                '{{',
+                '",".join([',
+                '  env.get("APP_BROKER_TYPE", "rabbitmq"),',
+                '])',
+                '}}'
+            ])
+        )
+    ],
+    checkers=[
+        rabbitmq_checker,
+        rabbitmq_management_checker,
+        kafka_outside_checker,
+        kafka_plaintext_checker,
+        redpanda_console_checker,
+        pandaproxy_outside_checker,
+        pandaproxy_plaintext_checker,
+    ]
+)
+
+start_snake_app_name = CmdTask(
+    icon='🚤',
+    name='start-kebab-app-name',
+    description='Start human readable app name',
+    group=project_group,
+    inputs=[
+        local_input,
+        host_input,
+        https_input
+    ],
+    skip_execution='{{not input.local_snake_app_name}}',
+    upstreams=[start_snake_app_name_support_container],
+    cwd=APP_DIR,
+    env_files=[app_env_file],
+    envs=app_envs,
+    cmd_path=os.path.join(CURRENT_DIR, 'cmd', 'start.sh'),
+    checkers=[
+        HTTPChecker(
+            name='check-kebab-app-name',
+            host='{{input.snake_app_name_host}}',
+            url='/readiness',
+            port='{{env.APP_PORT}}',
+            is_https='{{input.snake_app_name_https}}'
+        )
+    ]
+)
+runner.register(start_snake_app_name)

zrb/builtin/generator/fastapp/template/src/kebab-app-name/deployment/.gitignore

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

zrb/builtin/generator/fastapp/template/src/kebab-app-name/deployment/Pulumi.yaml

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