Merge pull request #5 from GabrielSalla/organize-files

Move main file to src

Author: GabrielSalla

.coveragerc

@@ -1,4 +1,10 @@
 [report]
+omit =
+    src/_monitors/*
+    src/_monitors_load/*
+    src/tmp/*
+    src/main.py
+    src/utils/log.py
 exclude_lines =
     pragma: no cover
     if TYPE_CHECKING:

.github/workflows/ci.yaml

@@ -15,8 +15,8 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
-      - name: Install Docker
-        run: sudo apt install docker docker-compose
+      # - name: Install Docker
+      #   run: sudo apt install docker-compose
       - name: Build image
         run: make build-dev
       - name: Save Docker image
@@ -34,8 +34,8 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
-      - name: Install Docker
-        run: sudo apt install docker docker-compose
+      # - name: Install Docker
+      #   run: sudo apt install docker-compose
       - name: Download Docker image
         uses: actions/download-artifact@v4
         with:
@@ -53,8 +53,8 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
-      - name: Install Docker
-        run: sudo apt install docker docker-compose
+      # - name: Install Docker
+      #   run: sudo apt install docker-compose
       - name: Download Docker image
         uses: actions/download-artifact@v4
         with:
@@ -72,8 +72,8 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
-      - name: Install Docker
-        run: sudo apt install docker docker-compose
+      # - name: Install Docker
+      #   run: sudo apt install docker-compose
       - name: Download Docker image
         uses: actions/download-artifact@v4
         with:

Makefile

@@ -1,38 +1,38 @@
 build-dev:
-	docker-compose -f docker-compose-dev.yaml build sentinela-dev
+	docker compose -f docker-compose-dev.yaml build sentinela-dev
 
 pull-dev:
-	docker-compose -f docker-compose-dev.yaml pull postgres motoserver
+	docker compose -f docker-compose-dev.yaml pull postgres motoserver
 
 migrate-dev:
-	docker-compose -f docker-compose-dev.yaml run --rm --service-ports sentinela-dev alembic upgrade head
+	docker compose -f docker-compose-dev.yaml run --rm --service-ports sentinela-dev alembic upgrade head
 
 run-dev:
-	docker-compose -f docker-compose-dev.yaml up sentinela-dev
+	docker compose -f docker-compose-dev.yaml up sentinela-dev
 
 run-shell-dev:
-	docker-compose -f docker-compose-dev.yaml run --rm --service-ports sentinela-dev /bin/sh
+	docker compose -f docker-compose-dev.yaml run --rm --service-ports sentinela-dev /bin/sh
 
 test-dev:
-	docker-compose -f docker-compose-dev.yaml run --rm sentinela-dev pytest
+	docker compose -f docker-compose-dev.yaml run --rm sentinela-dev pytest
 
 down-dev:
-	docker-compose -f docker-compose-dev.yaml down
+	docker compose -f docker-compose-dev.yaml down
 
 build-local:
-	docker-compose -f docker-compose-local.yaml build sentinela-local
+	docker compose -f docker-compose-local.yaml build sentinela-local
 
 migrate-local:
-	docker-compose -f docker-compose-local.yaml run --rm --service-ports sentinela-local alembic upgrade head
+	docker compose -f docker-compose-local.yaml run --rm --service-ports sentinela-local alembic upgrade head
 
 run-local:
-	docker-compose -f docker-compose-local.yaml up sentinela-local
+	docker compose -f docker-compose-local.yaml up sentinela-local
 
 down-local:
-	docker-compose -f docker-compose-local.yaml down
+	docker compose -f docker-compose-local.yaml down
 
 linter:
-	docker-compose -f docker-compose-dev.yaml run --rm --no-deps sentinela-dev flake8 src/ tests/ monitor_utils/ internal_monitors/ sample_monitors/ tools/ __main__.py
+	docker compose -f docker-compose-dev.yaml run --rm --no-deps sentinela-dev flake8 src/ tests/ internal_monitors/ sample_monitors/ tools/
 
 mypy:
-	docker-compose -f docker-compose-dev.yaml run --rm --no-deps sentinela-dev mypy --install-types --non-interactive src/ tests/ monitor_utils/ internal_monitors/ sample_monitors/ tools/ __main__.py
+	docker compose -f docker-compose-dev.yaml run --rm --no-deps sentinela-dev mypy --install-types --non-interactive src/ tests/ internal_monitors/ sample_monitors/ tools/

configs.yaml

@@ -1,8 +1,8 @@
 # Flag to enable the sample monitors
 load_sample_monitors: true
-# Path relative to the main file where the sample monitors are stored
+# Path relative to the project root, where the sample monitors are stored
 sample_monitors_path: sample_monitors
-# Path relative to the main file where the internal monitors are stored
+# Path relative to the project root, where the internal monitors are stored
 internal_monitors_path: internal_monitors
 # Schedule to reload monitors from the database
 monitors_load_schedule: "*/5 * * * *"

docker-compose-dev.yaml

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

docker-compose-local.yaml

@@ -30,4 +30,4 @@ services:
       - ./internal_monitors:/app/internal_monitors:Z
     depends_on:
       - postgres
-    command: python3 . controller executor
+    command: python3 src/main.py controller executor

docs/usage.md

@@ -64,8 +64,8 @@ The deployment should set the necessary environment variables for all the instan
 Controllers and executors can be started passing them as parameters.
 ```shell
 # Controller
-python3 . controller
+python3 src/main.py controller
 
 # Executor
-python3 . executor
+python3 src/main.py executor
 ```

internal_monitors/active_notification_alert_solved/active_notification_alert_solved.py

@@ -1,5 +1,7 @@
 from typing import Any, TypedDict, cast
 
+from databases import query_application
+from models import Notification, NotificationStatus
 from monitor_utils import (
     AgeRule,
     AlertOptions,
@@ -10,9 +12,6 @@
     read_file,
 )
 
-from src.databases import query_application
-from src.models import Notification, NotificationStatus
-
 monitor_options = MonitorOptions(
     update_cron="*/5 * * * *",
     search_cron="*/30 * * * *",

internal_monitors/monitor_long_time_queued/monitor_long_time_queued.py

@@ -1,5 +1,8 @@
 from typing import Any, TypedDict, cast
 
+from configs import configs
+from databases import query_application
+from models import Monitor
 from monitor_utils import (
     AlertOptions,
     IssueOptions,
@@ -10,10 +13,6 @@
     read_file,
 )
 
-from src.configs import configs
-from src.databases import query_application
-from src.models import Monitor
-
 monitor_options = MonitorOptions(
     update_cron="* * * * *",
     search_cron="*/5 * * * *",

pyproject.toml

@@ -50,6 +50,7 @@ max-line-length = 100
 line-length = 100
 
 [tool.mypy]
+mypy_path = "src"
 ignore_missing_imports = true
 warn_return_any = true
 check_untyped_defs = true
@@ -59,13 +60,14 @@ module = "tests.*"
 disable_error_code = ["arg-type", "empty-body", "misc", "list-item"]
 
 [tool.isort]
-src_paths = ["src", "tests", "__main__.py"]
+src_paths = ["src", "tests"]
 skip = ["alembic", "tmp", "_monitors", "_monitors_load"]
 line_length = 100
 include_trailing_comma = true
 multi_line_output = 3
 
 [tool.pytest.ini_options]
+pythonpath = "src"
 testpaths = "tests"
 addopts = "-rf --show-capture=all --color=yes --cov=src --cov-report=term-missing --cov-fail-under=100"