Merge pull request #133 from GabrielSalla/convert-to-scripts

Convert to scripts

Author: GabrielSalla

README.md

@@ -40,7 +40,6 @@ def search():
     #     {
     #       "order_id": 123,
     #       "order_status": "awaiting_delivery",
-    #       "shipment_status": "completed",
     #     },
     #     ...
     #   ]
@@ -59,19 +58,17 @@ def search():
     return issues
 
 def update(issues):
-    # Refreshes order and shipment statuses for the provided order IDs
+    # Refreshes order status for the provided order IDs
     #
     # Example SQL:
     # select
     #   orders.id as order_id,
     #   orders.status as order_status
     # from orders
-    #   left join shipments
-    #     on shipments.order_id = orders.id
     # where
     #   orders.id in (<list_of_order_ids>);
     order_ids = [issue["order_id"] for issue in issues]
-    updated_issues = get_orders_and_shipments_status(order_ids)
+    updated_issues = get_orders_status(order_ids)
     return updated_issues
 
 def is_solved(issue):

docker/docker-compose-dev.yaml

@@ -45,4 +45,4 @@ services:
     depends_on:
       - postgres
       - motoserver
-    command: python3 src/main.py controller executor
+    command: sentinela controller executor

docker/docker-compose-local.yaml

@@ -17,7 +17,7 @@ services:
     ports:
       - 8000:8000
     healthcheck:
-      test: python tools/health_check.py 8000
+      test: health_check 8000
       interval: 10s
       timeout: 1s
       retries: 3
@@ -33,4 +33,4 @@ services:
       - .env.secrets
     depends_on:
       - postgres
-    command: python3 src/main.py controller executor
+    command: sentinela controller executor

docker/docker-compose-scalable.yaml

@@ -28,7 +28,7 @@ services:
     ports:
       - 8000:8000
     healthcheck:
-      test: python tools/health_check.py 8000
+      test: health_check 8000
       interval: 10s
       timeout: 1s
       retries: 3
@@ -45,7 +45,7 @@ services:
     depends_on:
       - postgres
       - motoserver
-    command: python3 src/main.py controller
+    command: sentinela controller
 
   sentinela-executor:
     build:
@@ -61,7 +61,7 @@ services:
     ports:
       - 8001-8100:8000
     healthcheck:
-      test: python tools/health_check.py 8000
+      test: health_check 8000
       interval: 10s
       timeout: 1s
       retries: 3
@@ -78,4 +78,4 @@ services:
     depends_on:
       - postgres
       - motoserver
-    command: python3 src/main.py executor
+    command: sentinela executor

docs/how_to_run.md

@@ -18,8 +18,13 @@ For testing purposes, it can be useful to start a container and execute multiple
     ```shell
     make run-shell-dev
     ```
+2. When inside the container, the application can be run in development mode.
+    ```shell
+    sentinela controller executor
+    ```
+    or omitting the parameters to run both the controller and executor.
 
-The quality checks can also be run.
+The quality checks can also be run using the following commands:
 1. Run the tests.
     ```shell
     make test-dev
@@ -106,7 +111,7 @@ The [Dockerfile](../Dockerfile) is a starting point for building the application
 
 1. Install the dependencies for the application and enabled plugins.
     ```shell
-    poetry install --no-root --only $(python ./tools/get_plugins_list.py)
+    poetry install --no-root --only $(get_plugins_list)
     ```
 
 ### Deploying the Application
@@ -119,9 +124,9 @@ All services must have the environment variables set as specified in the [Config
 Controllers and executors can be run by specifying them as parameters when starting the application:
 1. Run the controller.
     ```shell
-    python3 src/main.py controller
+    sentinela controller
     ```
 2. Run the executor.
     ```shell
-    python3 src/main.py executor
+    sentinela executor
     ```

docs/monitor_registering.md

@@ -58,7 +58,7 @@ To simplify the registration process, a Python script is available in the `tools
 The following example demonstrates how to use the script to register a new monitor:
 
 ```bash
-python tools/register_monitor.py \
+register_monitor \
     my_monitor \
     monitors/my_monitor/my_monitor.py \
     monitors/my_monitor/search_query.sql \

pyproject.toml

@@ -3,13 +3,23 @@ name = "Sentinela"
 version = "0.7.0"
 description = "Sentinela Monitoring Platform"
 authors = [
-    { name = "Gabriel Salla", email = "gabriel.c.salla@gmail.com" }
+    { name = "Gabriel Salla", email = "gabriel.c.salla@gmail.com" },
 ]
 license = { file = "LICENSE.txt" }
 readme = "README.md"
 
 [tool.poetry]
-package-mode = false
+name = "sentinela"
+packages = [
+    {include = "*", from = "src"},
+    {include = "tools"},
+]
+
+[tool.poetry.scripts]
+sentinela = "main:start"
+get_plugins_list = "tools.get_plugins_list:main"
+health_check = "tools.health_check:main"
+register_monitor = "tools.register_monitor:main"
 
 [tool.poetry.dependencies]
 python = "^3.12"
@@ -96,9 +106,9 @@ log_format = "%(asctime)s [%(levelname)s] %(name)s.%(funcName)s.%(lineno)d: %(me
 
 # Disable botocore 'datetime.datetime.utcnow()' deprecation warning
 filterwarnings = [
-    "error",
     "ignore:datetime.datetime.utcnow:DeprecationWarning:botocore",
 ]
+
 [tool.coverage.run]
 branch = true
 

resources/kubernetes_template/controller.yaml

@@ -18,7 +18,7 @@ spec:
       - name: sentinela-controller
         image: sentinela-local:latest
         imagePullPolicy: Never
-        command: ["python3", "src/main.py", "controller"]
+        command: ["sentinela", "controller"]
         ports:
         - containerPort: 8000
         env:

resources/kubernetes_template/executor.yaml

@@ -18,7 +18,7 @@ spec:
       - name: sentinela-executor
         image: sentinela-local:latest
         imagePullPolicy: Never
-        command: ["python3", "src/main.py", "executor"]
+        command: ["sentinela", "executor"]
         ports:
         - containerPort: 8000
         env:

src/main.py

@@ -96,5 +96,5 @@ async def main() -> None:
     )
 
 
-if __name__ == "__main__":
+def start() -> None:
     asyncio.run(main())