wexample-wex-addon-services-db 0.0.3__py3-none-any.whl

wexample_wex_addon_services_db/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from wexample_wex_addon_services_db.services_db_addon_manager import (
+    ServicesDbAddonManager,
+)
+
+__all__ = ["ServicesDbAddonManager"]

wexample_wex_addon_services_db/services/elasticsearch/app_service.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from wexample_wex_addon_app.service.app_service import AppService as BaseAppService
+
+
+class AppService(BaseAppService):
+    def get_workdir_contribution(self) -> dict:
+        from wexample_filestate.const.disk import DiskItemType
+
+        # Elasticsearch container runs as uid 1000 (elasticsearch user)
+        es_mode = {"owner": "1000:1000", "permissions": "750", "recursive": True}
+
+        return {
+            "children": [
+                {
+                    "name": "elasticsearch",
+                    "type": DiskItemType.DIRECTORY,
+                    "should_exist": True,
+                    "children": [
+                        {
+                            "name": "data",
+                            "type": DiskItemType.DIRECTORY,
+                            "should_exist": True,
+                            "mode": es_mode,
+                        },
+                    ],
+                },
+            ]
+        }

wexample_wex_addon_services_db/services/elasticsearch/commands/service/install.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(
+    type=COMMAND_TYPE_SERVICE,
+    description="Configure elasticsearch service in app config",
+)
+def elasticsearch__service__install(
+    context: ExecutionContext,
+    service: AppService,
+) -> None:
+    app_name = service.app_workdir.get_config().search("global.name").get_str()
+    config_file = service.app_workdir.get_config_file()
+    config = config_file.read_config()
+
+    config.set_by_path(f"service.{service.name}.host", f"{app_name}_{service.name}")
+    config.set_by_path(f"service.{service.name}.port", 9200)
+
+    config_file.write_config(config)
+    service.app_workdir.get_runtime_config(rebuild=True)
+
+    context.io.log(f"Configured elasticsearch service for app '{app_name}'")

wexample_wex_addon_services_db/services/elasticsearch/commands/service/ready.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+if TYPE_CHECKING:
+    from wexample_app.response.boolean_response import BooleanResponse
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(
+    type=COMMAND_TYPE_SERVICE, description="Check if elasticsearch service is ready"
+)
+def elasticsearch__service__ready(
+    context: ExecutionContext,
+    service: AppService,
+) -> BooleanResponse:
+    import subprocess
+
+    from wexample_app.response.boolean_response import BooleanResponse
+
+    runtime = service.app_workdir.get_runtime_config()
+    app_project_name = runtime.search("app.project_name").get_str()
+    container_name = f"{app_project_name}_{service.name}"
+
+    result = subprocess.run(
+        [
+            "docker",
+            "exec",
+            container_name,
+            "curl",
+            "-sf",
+            "http://localhost:9200/_cluster/health",
+        ],
+        capture_output=True,
+    )
+
+    return BooleanResponse(kernel=context.kernel, content=result.returncode == 0)

wexample_wex_addon_services_db/services/elasticsearch/docker/docker-compose.yml

@@ -0,0 +1,27 @@
+services:
+  elasticsearch:
+    container_name: ${APP_PROJECT_NAME}_elasticsearch
+    image: elasticsearch:9.1.4
+    environment:
+      - node.name=elasticsearch
+      - cluster.name=${APP_PROJECT_NAME}-logging
+      - discovery.type=single-node
+      - bootstrap.memory_lock=true
+      - "ES_JAVA_OPTS=-Xms1g -Xmx1g"
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+    volumes:
+      - ${APP_PATH}elasticsearch/data:/usr/share/elasticsearch/data
+    ports:
+      - "9200:9200"
+      - "9300:9300"
+    networks:
+      - wex_net
+    deploy:
+      resources:
+        limits:
+          memory: 6g
+        reservations:
+          memory: 3g

wexample_wex_addon_services_db/services/elasticsearch/service.yml

@@ -0,0 +1,6 @@
+name: elasticsearch
+tags:
+  - db
+  - search
+docker:
+  compose: docker/docker-compose.yml

wexample_wex_addon_services_db/services/maria/commands/__init__.py

@@ -0,0 +1 @@
+

wexample_wex_addon_services_db/services/maria/commands/config/__init__.py

@@ -0,0 +1 @@
+

wexample_wex_addon_services_db/services/maria/commands/config/runtime.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+from wexample_wex_addon_services_db.services.mysql.commands.config.runtime import (
+    mysql__config__runtime,
+)
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(type=COMMAND_TYPE_SERVICE, description="Write maria runtime configuration")
+def maria__config__runtime(
+    context: ExecutionContext,
+    service: AppService,
+) -> None:
+    return mysql__config__runtime(context=context, service=service)

wexample_wex_addon_services_db/services/maria/commands/db/__init__.py

@@ -0,0 +1 @@
+

wexample_wex_addon_services_db/services/maria/commands/db/connect.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+from wexample_wex_addon_services_db.services.mysql.commands.db.connect import (
+    mysql__db__connect,
+)
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(
+    type=COMMAND_TYPE_SERVICE, description="Return maria connection arguments string"
+)
+def maria__db__connect(
+    context: ExecutionContext,
+    service: AppService,
+) -> str:
+    return mysql__db__connect(context=context, service=service)

wexample_wex_addon_services_db/services/maria/commands/db/destroy.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+from wexample_wex_core.decorator.option import option
+
+from wexample_wex_addon_services_db.services.mysql.commands.db.destroy import (
+    mysql__db__destroy,
+)
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@option(
+    name="database",
+    type=str,
+    required=False,
+    description="Database name (defaults to db.main from runtime config)",
+)
+@command(type=COMMAND_TYPE_SERVICE, description="Drop and recreate the maria database")
+def maria__db__destroy(
+    context: ExecutionContext,
+    service: AppService,
+    database: str | None = None,
+) -> None:
+    return mysql__db__destroy(context=context, service=service, database=database)

wexample_wex_addon_services_db/services/maria/commands/db/dump.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+from wexample_wex_core.decorator.option import option
+
+from wexample_wex_addon_services_db.services.mysql.commands.db.dump import (
+    mysql__db__dump,
+)
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@option(
+    name="file_name",
+    type=str,
+    required=True,
+    description="Dump file name (without extension)",
+)
+@command(
+    type=COMMAND_TYPE_SERVICE, description="Dump the maria database to a .sql file"
+)
+def maria__db__dump(
+    context: ExecutionContext,
+    service: AppService,
+    file_name: str,
+) -> str:
+    return mysql__db__dump(context=context, service=service, file_name=file_name)

wexample_wex_addon_services_db/services/maria/commands/db/dumps_list.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+from wexample_wex_core.decorator.option import option
+
+from wexample_wex_addon_services_db.services.mysql.commands.db.dumps_list import (
+    mysql__db__dumps_list,
+)
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@option(
+    name="database",
+    short_name="d",
+    type=str,
+    required=False,
+    description="Database name (unused, reserved for future multi-db support)",
+)
+@command(type=COMMAND_TYPE_SERVICE, description="List available maria dump files")
+def maria__db__dumps_list(
+    context: ExecutionContext,
+    service: AppService,
+    database: str | None = None,
+) -> list[str]:
+    return mysql__db__dumps_list(context=context, service=service, database=database)

wexample_wex_addon_services_db/services/maria/commands/db/exec.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+from wexample_wex_core.decorator.option import option
+
+from wexample_wex_addon_services_db.services.mysql.commands.db.exec import (
+    mysql__db__exec,
+)
+
+if TYPE_CHECKING:
+    from wexample_app.response.abstract_response import AbstractResponse
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@option(
+    name="sql",
+    type=str,
+    required=True,
+    description="SQL command to execute",
+)
+@command(type=COMMAND_TYPE_SERVICE, description="Execute a SQL command in maria")
+def maria__db__exec(
+    context: ExecutionContext,
+    service: AppService,
+    sql: str,
+) -> AbstractResponse:
+    return mysql__db__exec(context=context, service=service, sql=sql)

wexample_wex_addon_services_db/services/maria/commands/db/go.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+from wexample_wex_addon_services_db.services.mysql.commands.db.go import mysql__db__go
+
+if TYPE_CHECKING:
+    from wexample_app.response.abstract_response import AbstractResponse
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(
+    type=COMMAND_TYPE_SERVICE,
+    description="Open an interactive MariaDB CLI in the container",
+)
+def maria__db__go(
+    context: ExecutionContext,
+    service: AppService,
+) -> AbstractResponse:
+    return mysql__db__go(context=context, service=service)

wexample_wex_addon_services_db/services/maria/commands/db/restore.py

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+from wexample_wex_core.decorator.option import option
+
+from wexample_wex_addon_services_db.services.mysql.commands.db.restore import (
+    mysql__db__restore,
+)
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@option(
+    name="file_name",
+    type=str,
+    required=True,
+    description="SQL dump file name (without path, must be in /var/www/dumps/)",
+)
+@option(
+    name="database",
+    type=str,
+    required=False,
+    description="Database name (defaults to db.main from runtime config)",
+)
+@command(
+    type=COMMAND_TYPE_SERVICE, description="Restore a maria database from a .sql dump"
+)
+def maria__db__restore(
+    context: ExecutionContext,
+    service: AppService,
+    file_name: str,
+    database: str | None = None,
+) -> None:
+    return mysql__db__restore(
+        context=context,
+        service=service,
+        file_name=file_name,
+        database=database,
+    )

wexample_wex_addon_services_db/services/maria/commands/service/__init__.py

@@ -0,0 +1 @@
+

wexample_wex_addon_services_db/services/maria/commands/service/install.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+from wexample_wex_addon_services_db.services.mysql.commands.service.install import (
+    mysql__service__install,
+)
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(
+    type=COMMAND_TYPE_SERVICE,
+    description="Configure maria service in app config",
+)
+def maria__service__install(
+    context: ExecutionContext,
+    service: AppService,
+) -> None:
+    return mysql__service__install(context=context, service=service)

wexample_wex_addon_services_db/services/maria/commands/service/ready.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+from wexample_wex_addon_services_db.services.mysql.commands.service.ready import (
+    mysql__service__ready,
+)
+
+if TYPE_CHECKING:
+    from wexample_app.response.boolean_response import BooleanResponse
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(type=COMMAND_TYPE_SERVICE, description="Check if maria service is ready")
+def maria__service__ready(
+    context: ExecutionContext,
+    service: AppService,
+) -> BooleanResponse:
+    return mysql__service__ready(context=context, service=service)

wexample_wex_addon_services_db/services/maria/docker/docker-compose.yml

@@ -0,0 +1,18 @@
+services:
+  maria:
+    container_name: ${APP_PROJECT_NAME}_maria
+    image: mariadb:10.9
+    environment:
+      - MYSQL_ROOT_HOST=%
+      - MYSQL_PASSWORD=${SERVICE_MARIA_PASSWORD}
+      - MYSQL_DATABASE=${SERVICE_MARIA_NAME}
+      - MYSQL_ROOT_PASSWORD=${SERVICE_MARIA_PASSWORD}
+      - MYSQL_USER=${SERVICE_MARIA_USER}
+    volumes:
+      - ${APP_SETUP_PATH}maria/data:/var/lib/mysql
+      - ${APP_SETUP_PATH}maria/dumps:/var/www/dumps
+      - ${APP_SETUP_PATH}tmp/mysql.cnf:/tmp/mysql.cnf
+    ports:
+      - ${SERVICE_MARIA_PORT}:3306
+    networks:
+      - wex_net

wexample_wex_addon_services_db/services/maria/samples/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  maria:
+    extends:
+      file: ${SERVICE_MARIA_COMPOSE}
+      service: maria

wexample_wex_addon_services_db/services/maria/samples/maria/data/.gitkeep

@@ -0,0 +1 @@
+

wexample_wex_addon_services_db/services/maria/samples/maria/dumps/.gitkeep

@@ -0,0 +1 @@
+

wexample_wex_addon_services_db/services/maria/samples/maria/my.cnf

@@ -0,0 +1 @@
+

wexample_wex_addon_services_db/services/maria/service.yml

@@ -0,0 +1,4 @@
+name: maria
+extends: mysql
+docker:
+  compose: docker/docker-compose.yml

wexample_wex_addon_services_db/services/mongo/app_service.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from wexample_wex_addon_app.service.app_service import AppService as BaseAppService
+
+
+class AppService(BaseAppService):
+    def get_workdir_contribution(self) -> dict:
+        from wexample_filestate.const.disk import DiskItemType
+
+        return {
+            "children": [
+                {
+                    "name": "logs",
+                    "type": DiskItemType.DIRECTORY,
+                    "should_exist": True,
+                    "mode": {
+                        "owner": "999:999",
+                        "permissions": "750",
+                        "recursive": True,
+                    },
+                },
+                {
+                    "name": "mongo-keyfile",
+                    "type": DiskItemType.FILE,
+                    "should_exist": True,
+                    "mode": {
+                        "owner": "999:999",
+                        "permissions": "400",
+                    },
+                },
+            ]
+        }

wexample_wex_addon_services_db/services/mongo/commands/__init__.py

@@ -0,0 +1 @@
+

wexample_wex_addon_services_db/services/mongo/commands/config/__init__.py

@@ -0,0 +1 @@
+

wexample_wex_addon_services_db/services/mongo/commands/config/runtime.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(type=COMMAND_TYPE_SERVICE, description="Write mongo runtime configuration")
+def mongo__config__runtime(
+    context: ExecutionContext,
+    service: AppService,
+) -> None:
+    from wexample_config.config_value.nested_config_value import NestedConfigValue
+    from wexample_helpers.helpers.dict import dict_merge
+
+    config = service.app_workdir.get_config()
+    db_name = config.search(f"service.{service.name}.name").get_str_or_default(
+        service.name
+    )
+
+    base = service.app_workdir.build_runtime_config_value().to_dict()
+    merged = dict_merge(base, {"db": {"main": db_name}})
+    service.app_workdir.get_runtime_config_file().write_config(
+        NestedConfigValue(raw=merged)
+    )
+
+    context.io.log(f"mongo config/runtime: written (db.main={db_name})")

wexample_wex_addon_services_db/services/mongo/commands/db/__init__.py

@@ -0,0 +1 @@
+