zrb 0.0.38__tar.gz → 0.0.40__tar.gz

{zrb-0.0.38 → zrb-0.0.40}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 0.0.38
+Version: 0.0.40
 Summary: Your faithful companion
 Author-email: Go Frendi Gunawan <gofrendiasgard@gmail.com>
 Requires-Python: >=3.8

{zrb-0.0.38 → zrb-0.0.40}/playground-template/generate-project.sh

@@ -32,6 +32,12 @@ zrb project add simple-python-app \
     --app-name "simple" \
     --http-port 3001
 
+echo '🤖 Add fastapp'
+zrb project add fastapp \
+    --project-dir . \
+    --app-name "fastapp" \
+    --http-port 3002
+
 
 echo '🤖 Add test-project task'
 echo '' >> zrb_init.py
@@ -43,11 +49,8 @@ echo '        run_cmd.run_cmd,' >> zrb_init.py
 echo '        run_container.run_container,' >> zrb_init.py
 echo '        run_python.run_python,' >> zrb_init.py
 echo '        simple_local.start_simple,' >> zrb_init.py
+echo '        fastapp_local.start_fastapp,' >> zrb_init.py
 echo '    ]' >> zrb_init.py
 echo ')' >> zrb_init.py
 echo 'runner.register(test_project)' >> zrb_init.py
-echo '' >> zrb_init.py
-
-
-echo '🤖 Test project'
-zrb test-project
+echo '' >> zrb_init.py

{zrb-0.0.38 → zrb-0.0.40}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "zrb"
-version = "0.0.38"
+version = "0.0.40"
 authors = [
   { name="Go Frendi Gunawan", email="gofrendiasgard@gmail.com" },
 ]

{zrb-0.0.38 → zrb-0.0.40}/requirements.txt

@@ -23,3 +23,4 @@ pytest-xdist==3.2.0
 # Other dependencies (just for auto-completion)
 pulumi==3.56.0
 pulumi-kubernetes==3.24.1
+fastapi==0.93.0

{zrb-0.0.38 → zrb-0.0.40}/src/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-0.0.38 → zrb-0.0.40}/src/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-0.0.40/src/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-0.0.40/src/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-0.0.40/src/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-0.0.40/src/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-0.0.40/src/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-0.0.40/src/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-0.0.40/src/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-0.0.40/src/zrb/builtin/generator/fastapp/template/src/kebab-app-name/docker-compose.yml

@@ -0,0 +1,82 @@
+version: '3'
+services:
+
+
+  redpanda:
+    image: docker.redpanda.com/redpandadata/redpanda:v22.3.11
+    hostname: redpanda
+    command:
+      - redpanda start
+      - --smp 1
+      - --reserve-memory 0M
+      - --overprovisioned
+      - --node-id 1
+      - --kafka-addr PLAINTEXT://0.0.0.0:29092,OUTSIDE://0.0.0.0:9092
+      - --advertise-kafka-addr PLAINTEXT://redpanda:29092,OUTSIDE://localhost:9092
+      - --pandaproxy-addr PLAINTEXT://0.0.0.0:28082,OUTSIDE://0.0.0.0:8082
+      - --advertise-pandaproxy-addr PLAINTEXT://redpanda:28082,OUTSIDE://localhost:8082
+      - --rpc-addr 0.0.0.0:33145
+      - --advertise-rpc-addr redpanda:33145
+    ports:
+      - 8082:8082
+      - ${KAFKA_OUTSIDE_HOST_PORT:-9092}:9092
+      - 28082:28082
+      - ${KAFKA_PLAINTEXT_HOST_PORT:-29092}:29092
+    restart: on-failure
+    profiles:
+      - kafka
+    healthcheck:
+      test: ["CMD", "redpanda", "admin", "check"]
+      interval: 5s
+      timeout: 1s
+      retries: 30
+
+
+  redpanda-console:
+    image: docker.redpanda.com/redpandadata/console:v2.2.2
+    hostname: redpanda-console
+    ports:
+      - ${REDPANDA_CONSOLE_HOST_PORT:-9000}:8080
+    environment:
+      - KAFKA_BROKERS=redpanda:29092
+    profiles:
+      - kafka
+    depends_on:
+      - redpanda
+    restart: on-failure
+
+
+  rabbitmq:
+    image: rabbitmq:3-management
+    hostname: rabbitmq
+    ports:
+      - "${RABBITMQ_HOST_PORT:-5672}:5672"
+      - "${RABBITMQ_MANAGEMENT_HOST_PORT:-15672}:15672"
+    # volumes:
+    #   - rabbitmq:/var/lib/rabbitmq/mnesia
+    environment:
+      - RABBITMQ_DEFAULT_USER=guest
+      - RABBITMQ_DEFAULT_PASS=guest
+    restart: on-failure
+    profiles:
+      - rabbitmq
+    healthcheck:
+      test: ["CMD", "rabbitmqctl", "status"]
+      interval: 5s
+      timeout: 1s
+      retries: 30
+
+
+  snake_app_name:
+    build: src
+    image: ${IMAGE:-kebab-app-name}
+    container_name: snake_app_name
+    hostname: snake_app_name
+    env_file: 'src/template.env'
+    environment:
+      APP_PORT: ${APP_PORT:-8080}
+    ports:
+      - "${APP_HOST_PORT:-8080}:${APP_PORT:-8080}"
+    restart: on-failure
+    profiles:
+      - monolith

zrb-0.0.40/src/zrb/builtin/generator/fastapp/template/src/kebab-app-name/src/component/app.py

@@ -0,0 +1,51 @@
+from fastapi import status
+from fastapi.responses import JSONResponse
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi import FastAPI
+from config import (
+    cors_allow_credentials, cors_allow_headers, cors_allow_methods,
+    cors_allow_origin_regex, cors_allow_origins, cors_expose_headers,
+    cors_max_age
+)
+from component.app_state import app_state
+
+app = FastAPI()
+
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=cors_allow_origins,
+    allow_origin_regex=cors_allow_origin_regex,
+    allow_methods=cors_allow_methods,
+    allow_headers=cors_allow_headers,
+    allow_credentials=cors_allow_credentials,
+    expose_headers=cors_expose_headers,
+    max_age=cors_max_age,
+)
+
+
+@app.head('/liveness')
+@app.get('/liveness')
+def handle_liveness():
+    if app_state.get_liveness():
+        return JSONResponse(
+            content={'message': 'Service is alive'},
+            status_code=status.HTTP_200_OK
+        )
+    return JSONResponse(
+        content={'message': 'Service is not alive'},
+        status_code=status.HTTP_503_SERVICE_UNAVAILABLE
+    )
+
+
+@app.head('/readiness')
+@app.get('/readiness')
+def handle_readiness():
+    if app_state.get_readiness():
+        return JSONResponse(
+            content={'message': 'Service is ready'},
+            status_code=status.HTTP_200_OK
+        )
+    return JSONResponse(
+        content={'message': 'Service is not ready'},
+        status_code=status.HTTP_503_SERVICE_UNAVAILABLE
+    )