ddeutil-workflow 0.0.34__py3-none-any.whl → 0.0.36__py3-none-any.whl

ddeutil/workflow/__about__.py

@@ -1 +1 @@
-__version__: str = "0.0.34"
+__version__: str = "0.0.36"

ddeutil/workflow/__init__.py

@@ -9,7 +9,7 @@ from .audit import (
     Audit,
     get_audit,
 )
-from .call import (
+from .caller import (
     ReturnTagFunc,
     TagFunc,
     extract_call,
@@ -37,8 +37,15 @@ from .exceptions import (
 )
 from .job import (
     Job,
+    RunsOn,
     Strategy,
 )
+from .logs import (
+    TraceData,
+    TraceLog,
+    get_dt_tznow,
+    get_trace,
+)
 from .params import (
     ChoiceParam,
     DatetimeParam,
@@ -49,9 +56,7 @@ from .params import (
 from .result import (
     Result,
     Status,
-    TraceLog,
     default_gen_id,
-    get_dt_tznow,
 )
 from .scheduler import (
     Schedule,

ddeutil/workflow/api/api.py

@@ -11,7 +11,11 @@ from datetime import datetime, timedelta
 from typing import TypedDict
 
 from dotenv import load_dotenv
-from fastapi import FastAPI
+from fastapi import FastAPI, Request
+from fastapi import status as st
+from fastapi.encoders import jsonable_encoder
+from fastapi.exceptions import RequestValidationError
+from fastapi.middleware.cors import CORSMiddleware
 from fastapi.middleware.gzip import GZipMiddleware
 from fastapi.responses import UJSONResponse
 
@@ -20,6 +24,7 @@ from ..conf import config, get_logger
 from ..scheduler import ReleaseThread, ReleaseThreads
 from ..workflow import ReleaseQueue, WorkflowTask
 from .repeat import repeat_at
+from .routes import job, log
 
 load_dotenv()
 logger = get_logger("ddeutil.workflow")
@@ -60,39 +65,57 @@ async def lifespan(a: FastAPI) -> AsyncIterator[State]:
 
 
 app = FastAPI(
-    titile="Workflow API",
+    titile="Workflow",
     description=(
-        "This is workflow FastAPI web application that use to manage manual "
-        "execute or schedule workflow via RestAPI."
+        "This is a workflow FastAPI application that use to manage manual "
+        "execute, logging, and schedule workflow via RestAPI."
     ),
     version=__version__,
     lifespan=lifespan,
     default_response_class=UJSONResponse,
 )
 app.add_middleware(GZipMiddleware, minimum_size=1000)
+origins: list[str] = [
+    "http://localhost",
+    "http://localhost:88",
+    "http://localhost:80",
+]
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=origins,
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
 
 
 @app.get("/")
 async def health():
-    return {"message": "Workflow API already start up"}
+    """Index view that not return any template without json status."""
+    return {"message": "Workflow already start up with healthy status."}
+
 
+# NOTE Add the jobs and logs routes by default.
+app.include_router(job, prefix=config.prefix_path)
+app.include_router(log, prefix=config.prefix_path)
 
-# NOTE: Enable the workflow route.
+
+# NOTE: Enable the workflows route.
 if config.enable_route_workflow:
-    from .route import workflow_route
+    from .routes import workflow
 
-    app.include_router(workflow_route, prefix=config.prefix_path)
+    app.include_router(workflow, prefix=config.prefix_path)
 
 
-# NOTE: Enable the schedule route.
+# NOTE: Enable the schedules route.
 if config.enable_route_schedule:
     from ..audit import get_audit
     from ..scheduler import schedule_task
-    from .route import schedule_route
+    from .routes import schedule
 
-    app.include_router(schedule_route, prefix=config.prefix_path)
+    app.include_router(schedule, prefix=config.prefix_path)
 
-    @schedule_route.on_event("startup")
+    @schedule.on_event("startup")
     @repeat_at(cron="* * * * *", delay=2)
     def scheduler_listener():
         """Schedule broker every minute at 02 second."""
@@ -106,12 +129,13 @@ if config.enable_route_schedule:
                 stop=datetime.now(config.tz) + timedelta(minutes=1),
                 queue=app.state.workflow_queue,
                 threads=app.state.workflow_threads,
-                log=get_audit(),
+                audit=get_audit(),
             )
 
-    @schedule_route.on_event("startup")
+    @schedule.on_event("startup")
     @repeat_at(cron="*/5 * * * *", delay=10)
     def monitoring():
+        """Monitoring workflow thread that running in the background."""
         logger.debug("[MONITOR]: Start monitoring threading.")
         snapshot_threads: list[str] = list(app.state.workflow_threads.keys())
         for t_name in snapshot_threads:
@@ -121,3 +145,23 @@ if config.enable_route_schedule:
             # NOTE: remove the thread that running success.
             if not thread_release["thread"].is_alive():
                 app.state.workflow_threads.pop(t_name)
+
+
+@app.exception_handler(RequestValidationError)
+async def validation_exception_handler(
+    request: Request, exc: RequestValidationError
+):
+    return UJSONResponse(
+        status_code=st.HTTP_422_UNPROCESSABLE_ENTITY,
+        content=jsonable_encoder({"detail": exc.errors(), "body": exc.body}),
+    )
+
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(
+        app,
+        host="0.0.0.0",
+        port=80,
+    )

ddeutil/workflow/api/repeat.py

@@ -21,17 +21,26 @@ logger = get_logger("ddeutil.workflow")
 def get_cronjob_delta(cron: str) -> float:
     """This function returns the time delta between now and the next cron
     execution time.
+
+    :rtype: float
     """
     now: datetime = datetime.now(tz=config.tz)
     cron = CronJob(cron)
     return (cron.schedule(now).next - now).total_seconds()
 
 
-def cron_valid(cron: str):
+def cron_valid(cron: str, raise_error: bool = True) -> bool:
+    """Check this crontab string value is valid with its cron syntax.
+
+    :rtype: bool
+    """
     try:
         CronJob(cron)
+        return True
     except Exception as err:
-        raise ValueError(f"Crontab value does not valid, {cron}") from err
+        if raise_error:
+            raise ValueError(f"Crontab value does not valid, {cron}") from err
+        return False
 
 
 async def run_func(
@@ -41,6 +50,7 @@ async def run_func(
     raise_exceptions: bool = False,
     **kwargs,
 ):
+    """Run function inside the repeat decorator functions."""
     try:
         if is_coroutine:
             await func(*args, **kwargs)
@@ -62,11 +72,11 @@ def repeat_at(
     """This function returns a decorator that makes a function execute
     periodically as per the cron expression provided.
 
-    :param cron: str
-        Cron-style string for periodic execution, eg. '0 0 * * *' every midnight
-    :param delay:
-    :param raise_exceptions: bool (default False)
-        Whether to raise exceptions or log them
+    :param cron: (str) A Cron-style string for periodic execution, e.g.
+        '0 0 * * *' every midnight
+    :param delay: (float) A delay seconds value.
+    :param raise_exceptions: (bool) A raise exception flag. Whether to raise
+        exceptions or log them if raise was set be false.
     :param max_repetitions: int (default None)
         Maximum number of times to repeat the function. If None, repeat
         indefinitely.
@@ -81,12 +91,12 @@ def repeat_at(
 
         @wraps(func)
         def wrapper(*_args, **_kwargs):
-            repititions: int = 0
+            repetitions: int = 0
             cron_valid(cron)
 
             async def loop(*args, **kwargs):
-                nonlocal repititions
-                while max_repetitions is None or repititions < max_repetitions:
+                nonlocal repetitions
+                while max_repetitions is None or repetitions < max_repetitions:
                     sleep_time = get_cronjob_delta(cron) + delay
                     await asyncio.sleep(sleep_time)
                     await run_func(
@@ -96,7 +106,7 @@ def repeat_at(
                         raise_exceptions=raise_exceptions,
                         **kwargs,
                     )
-                    repititions += 1
+                    repetitions += 1
 
             ensure_future(loop(*_args, **_kwargs))
 

ddeutil/workflow/api/routes/__init__.py

@@ -0,0 +1,9 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) 2022 Korawich Anuttra. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for
+# license information.
+# ------------------------------------------------------------------------------
+from .job import job_route as job
+from .logs import log_route as log
+from .schedules import schedule_route as schedule
+from .workflows import workflow_route as workflow

ddeutil/workflow/api/routes/job.py

@@ -0,0 +1,73 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) 2022 Korawich Anuttra. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for
+# license information.
+# ------------------------------------------------------------------------------
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from fastapi import APIRouter
+from fastapi.responses import UJSONResponse
+from pydantic import BaseModel
+
+from ...__types import DictData
+from ...conf import get_logger
+from ...exceptions import JobException
+from ...job import Job
+from ...result import Result
+
+logger = get_logger("ddeutil.workflow")
+
+
+job_route = APIRouter(
+    prefix="/job",
+    tags=["job"],
+    default_response_class=UJSONResponse,
+)
+
+
+class ResultPost(BaseModel):
+    context: DictData
+    run_id: str
+    parent_run_id: Optional[str] = None
+
+
+@job_route.post(path="/execute/")
+async def job_execute(
+    result: ResultPost,
+    job: Job,
+    params: dict[str, Any],
+):
+    """Execute job via API."""
+    rs: Result = Result(
+        context=result.context,
+        run_id=result.run_id,
+        parent_run_id=result.parent_run_id,
+    )
+    try:
+        job.set_outputs(
+            job.execute(
+                params=params,
+                run_id=rs.run_id,
+                parent_run_id=rs.parent_run_id,
+            ).context,
+            to=params,
+        )
+    except JobException as err:
+        rs.trace.error(f"[WORKFLOW]: {err.__class__.__name__}: {err}")
+
+    return {
+        "message": "Start execute job via API.",
+        "result": {
+            "run_id": rs.run_id,
+            "parent_run_id": rs.parent_run_id,
+        },
+        "job": job.model_dump(
+            by_alias=True,
+            exclude_none=True,
+            exclude_unset=True,
+            exclude_defaults=True,
+        ),
+        "params": params,
+    }

ddeutil/workflow/api/routes/logs.py

@@ -0,0 +1,64 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) 2022 Korawich Anuttra. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for
+# license information.
+# ------------------------------------------------------------------------------
+"""This route include audit and trace log paths."""
+from __future__ import annotations
+
+from fastapi import APIRouter
+from fastapi.responses import UJSONResponse
+
+from ...audit import get_audit
+from ...logs import get_trace_obj
+
+log_route = APIRouter(
+    prefix="/logs",
+    tags=["logs", "trace", "audit"],
+    default_response_class=UJSONResponse,
+)
+
+
+@log_route.get(path="/trace/")
+async def get_traces():
+    """Get all trace logs."""
+    return {
+        "message": "Getting trace logs",
+        "traces": list(get_trace_obj().find_logs()),
+    }
+
+
+@log_route.get(path="/trace/{run_id}")
+async def get_trace_with_id(run_id: str):
+    """Get trace log with specific running ID."""
+    return get_trace_obj().find_log_with_id(run_id)
+
+
+@log_route.get(path="/audit/")
+async def get_audits():
+    """Get all audit logs."""
+    return {
+        "message": "Getting audit logs",
+        "audits": list(get_audit().find_audits(name="demo")),
+    }
+
+
+@log_route.get(path="/audit/{workflow}/")
+async def get_audit_with_workflow(workflow: str):
+    """Get all audit logs."""
+    return {
+        "message": f"Getting audit logs with workflow name {workflow}",
+        "audits": list(get_audit().find_audits(name="demo")),
+    }
+
+
+@log_route.get(path="/audit/{workflow}/{release}")
+async def get_audit_with_workflow_release(workflow: str, release: str):
+    """Get all audit logs."""
+    return {
+        "message": (
+            f"Getting audit logs with workflow name {workflow} and release "
+            f"{release}"
+        ),
+        "audits": list(get_audit().find_audits(name="demo")),
+    }

ddeutil/workflow/api/{route.py → routes/schedules.py}

@@ -6,30 +6,17 @@
 from __future__ import annotations
 
 import copy
-from dataclasses import asdict
 from datetime import datetime, timedelta
-from typing import Any
 
 from fastapi import APIRouter, HTTPException, Request
 from fastapi import status as st
 from fastapi.responses import UJSONResponse
-from pydantic import BaseModel
 
-from ..__types import DictData
-from ..audit import Audit, get_audit
-from ..conf import Loader, config, get_logger
-from ..result import Result
-from ..scheduler import Schedule
-from ..workflow import Workflow
+from ...conf import config, get_logger
+from ...scheduler import Schedule
 
 logger = get_logger("ddeutil.workflow")
 
-workflow_route = APIRouter(
-    prefix="/workflows",
-    tags=["workflows"],
-    default_response_class=UJSONResponse,
-)
-
 schedule_route = APIRouter(
     prefix="/schedules",
     tags=["schedules"],
@@ -37,124 +24,9 @@ schedule_route = APIRouter(
 )
 
 
-@workflow_route.get(path="/")
-async def get_workflows() -> DictData:
-    """Return all workflow workflows that exists in config path."""
-    workflows: DictData = dict(Loader.finds(Workflow))
-    return {
-        "message": f"Getting all workflows: {len(workflows)}",
-        "count": len(workflows),
-        "workflows": workflows,
-    }
-
-
-@workflow_route.get(path="/{name}")
-async def get_workflow_by_name(name: str) -> DictData:
-    """Return model of workflow that passing an input workflow name."""
-    try:
-        workflow: Workflow = Workflow.from_loader(name=name, externals={})
-    except ValueError as err:
-        logger.exception(err)
-        raise HTTPException(
-            status_code=st.HTTP_404_NOT_FOUND,
-            detail=(
-                f"Workflow workflow name: {name!r} does not found in /conf path"
-            ),
-        ) from None
-    return workflow.model_dump(
-        by_alias=True,
-        exclude_none=True,
-        exclude_unset=True,
-        exclude_defaults=True,
-    )
-
-
-class ExecutePayload(BaseModel):
-    params: dict[str, Any]
-
-
-@workflow_route.post(path="/{name}/execute", status_code=st.HTTP_202_ACCEPTED)
-async def execute_workflow(name: str, payload: ExecutePayload) -> DictData:
-    """Return model of workflow that passing an input workflow name."""
-    try:
-        workflow: Workflow = Workflow.from_loader(name=name, externals={})
-    except ValueError:
-        raise HTTPException(
-            status_code=st.HTTP_404_NOT_FOUND,
-            detail=(
-                f"Workflow workflow name: {name!r} does not found in /conf path"
-            ),
-        ) from None
-
-    # NOTE: Start execute manually
-    try:
-        result: Result = workflow.execute(params=payload.params)
-    except Exception as err:
-        raise HTTPException(
-            status_code=st.HTTP_500_INTERNAL_SERVER_ERROR,
-            detail=f"{type(err)}: {err}",
-        ) from None
-
-    return asdict(result)
-
-
-@workflow_route.get(path="/{name}/logs")
-async def get_workflow_logs(name: str):
-    try:
-        return {
-            "message": f"Getting workflow {name!r} logs",
-            "logs": [
-                log.model_dump(
-                    by_alias=True,
-                    exclude_none=True,
-                    exclude_unset=True,
-                    exclude_defaults=True,
-                )
-                for log in get_audit().find_audits(name=name)
-            ],
-        }
-    except FileNotFoundError:
-        raise HTTPException(
-            status_code=st.HTTP_404_NOT_FOUND,
-            detail=f"Does not found log for workflow {name!r}",
-        ) from None
-
-
-@workflow_route.get(path="/{name}/logs/{release}")
-async def get_workflow_release_log(name: str, release: str):
-    try:
-        log: Audit = get_audit().find_audit_with_release(
-            name=name, release=datetime.strptime(release, "%Y%m%d%H%M%S")
-        )
-    except FileNotFoundError:
-        raise HTTPException(
-            status_code=st.HTTP_404_NOT_FOUND,
-            detail=(
-                f"Does not found log for workflow {name!r} "
-                f"with release {release!r}"
-            ),
-        ) from None
-    return {
-        "message": f"Getting workflow {name!r} log in release {release}",
-        "log": log.model_dump(
-            by_alias=True,
-            exclude_none=True,
-            exclude_unset=True,
-            exclude_defaults=True,
-        ),
-    }
-
-
-@workflow_route.delete(
-    path="/{name}/logs/{release}",
-    status_code=st.HTTP_204_NO_CONTENT,
-)
-async def del_workflow_release_log(name: str, release: str):
-    return {"message": f"Deleted workflow {name!r} log in release {release}"}
-
-
 @schedule_route.get(path="/{name}")
 async def get_schedules(name: str):
+    """Get schedule object."""
     try:
         schedule: Schedule = Schedule.from_loader(name=name, externals={})
     except ValueError:

ddeutil/workflow/api/routes/workflows.py

@@ -0,0 +1,137 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) 2022 Korawich Anuttra. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for
+# license information.
+# ------------------------------------------------------------------------------
+from __future__ import annotations
+
+from dataclasses import asdict
+from datetime import datetime
+from typing import Any
+
+from fastapi import APIRouter, HTTPException
+from fastapi import status as st
+from fastapi.responses import UJSONResponse
+from pydantic import BaseModel
+
+from ...__types import DictData
+from ...audit import Audit, get_audit
+from ...conf import Loader, get_logger
+from ...result import Result
+from ...workflow import Workflow
+
+logger = get_logger("ddeutil.workflow")
+
+workflow_route = APIRouter(
+    prefix="/workflows",
+    tags=["workflows"],
+    default_response_class=UJSONResponse,
+)
+
+
+@workflow_route.get(path="/")
+async def get_workflows() -> DictData:
+    """Return all workflow workflows that exists in config path."""
+    workflows: DictData = dict(Loader.finds(Workflow))
+    return {
+        "message": f"Getting all workflows: {len(workflows)}",
+        "count": len(workflows),
+        "workflows": workflows,
+    }
+
+
+@workflow_route.get(path="/{name}")
+async def get_workflow_by_name(name: str) -> DictData:
+    """Return model of workflow that passing an input workflow name."""
+    try:
+        workflow: Workflow = Workflow.from_loader(name=name, externals={})
+    except ValueError as err:
+        logger.exception(err)
+        raise HTTPException(
+            status_code=st.HTTP_404_NOT_FOUND,
+            detail=(
+                f"Workflow workflow name: {name!r} does not found in /conf path"
+            ),
+        ) from None
+    return workflow.model_dump(
+        by_alias=True,
+        exclude_none=True,
+        exclude_unset=True,
+        exclude_defaults=True,
+    )
+
+
+class ExecutePayload(BaseModel):
+    params: dict[str, Any]
+
+
+@workflow_route.post(path="/{name}/execute", status_code=st.HTTP_202_ACCEPTED)
+async def execute_workflow(name: str, payload: ExecutePayload) -> DictData:
+    """Return model of workflow that passing an input workflow name."""
+    try:
+        workflow: Workflow = Workflow.from_loader(name=name, externals={})
+    except ValueError:
+        raise HTTPException(
+            status_code=st.HTTP_404_NOT_FOUND,
+            detail=(
+                f"Workflow workflow name: {name!r} does not found in /conf path"
+            ),
+        ) from None
+
+    # NOTE: Start execute manually
+    try:
+        result: Result = workflow.execute(params=payload.params)
+    except Exception as err:
+        raise HTTPException(
+            status_code=st.HTTP_500_INTERNAL_SERVER_ERROR,
+            detail=f"{type(err)}: {err}",
+        ) from None
+
+    return asdict(result)
+
+
+@workflow_route.get(path="/{name}/audits")
+async def get_workflow_audits(name: str):
+    try:
+        return {
+            "message": f"Getting workflow {name!r} audits",
+            "audits": [
+                audit.model_dump(
+                    by_alias=True,
+                    exclude_none=True,
+                    exclude_unset=True,
+                    exclude_defaults=True,
+                )
+                for audit in get_audit().find_audits(name=name)
+            ],
+        }
+    except FileNotFoundError:
+        raise HTTPException(
+            status_code=st.HTTP_404_NOT_FOUND,
+            detail=f"Does not found audit for workflow {name!r}",
+        ) from None
+
+
+@workflow_route.get(path="/{name}/audits/{release}")
+async def get_workflow_release_audit(name: str, release: str):
+    try:
+        audit: Audit = get_audit().find_audit_with_release(
+            name=name, release=datetime.strptime(release, "%Y%m%d%H%M%S")
+        )
+    except FileNotFoundError:
+        raise HTTPException(
+            status_code=st.HTTP_404_NOT_FOUND,
+            detail=(
+                f"Does not found audit for workflow {name!r} "
+                f"with release {release!r}"
+            ),
+        ) from None
+    return {
+        "message": f"Getting workflow {name!r} audit in release {release}",
+        "audit": audit.model_dump(
+            by_alias=True,
+            exclude_none=True,
+            exclude_unset=True,
+            exclude_defaults=True,
+        ),
+    }