[Ex oracle] Improve handling oracle mode(dev/prod/test)

Author: Marishka17

packages/examples/cvat/exchange-oracle/run.py

@@ -4,7 +4,7 @@
 from src.core.config import Config
 
 if __name__ == "__main__":
-    is_dev = Config.environment == "development"
+    is_dev = Config.is_development_mode()
     Config.validate()
     register_in_kvstore()
 

packages/examples/cvat/exchange-oracle/src/__init__.py

@@ -32,6 +32,5 @@ async def startup_event():
     logger.info("Exchange Oracle is up and running!")
 
 
-is_test = Config.environment == "test"
-if not is_test:
+if not Config.is_test_mode():
     setup_cron_jobs(app)

packages/examples/cvat/exchange-oracle/src/core/config.py

@@ -4,7 +4,8 @@
 import inspect
 import os
 from collections.abc import Iterable
-from typing import ClassVar
+from enum import Enum
+from typing import ClassVar, Optional
 
 from attrs.converters import to_bool
 from dotenv import load_dotenv
@@ -295,12 +296,25 @@ def validate(cls) -> None:
                 raise Exception(" ".join([ex_prefix, str(ex)]))
 
 
-class Config:
-    _DEVELOPMENT_MODE = "development"
+class Environment(str, Enum):
+    PRODUCTION = "production"
+    DEVELOPMENT = "development"
+    TEST = "test"
+
+    @classmethod
+    def _missing_(cls, value: str) -> Optional["Environment"]:
+        value = value.lower()
+        for member in cls:
+            if member.value == value:
+                return member
+
+        return None
+
 
+class Config:
     debug = to_bool(os.environ.get("DEBUG", "false"))
     port = int(os.environ.get("PORT", 8000))
-    environment = os.environ.get("ENVIRONMENT", _DEVELOPMENT_MODE)
+    environment = Environment(os.environ.get("ENVIRONMENT", Environment.DEVELOPMENT.value))
     workers_amount = int(os.environ.get("WORKERS_AMOUNT", 1))
     webhook_max_retries = int(os.environ.get("WEBHOOK_MAX_RETRIES", 5))
     webhook_delay_if_failed = int(os.environ.get("WEBHOOK_DELAY_IF_FAILED", 60))
@@ -323,8 +337,19 @@ class Config:
     encryption_config = EncryptionConfig
 
     @classmethod
-    def is_development(cls) -> bool:
-        return cls.environment.lower() == cls._DEVELOPMENT_MODE
+    def is_development_mode(cls) -> bool:
+        """Returns whether the oracle is running in development mode or not"""
+        return cls.environment == Environment.DEVELOPMENT
+
+    @classmethod
+    def is_test_mode(cls) -> bool:
+        """Returns whether the oracle is running in testing mode or not"""
+        return cls.environment == Environment.TEST
+
+    @classmethod
+    def is_production_mode(cls) -> bool:
+        """Returns whether the oracle is running in production mode or not"""
+        return cls.environment == Environment.PRODUCTION
 
     @classmethod
     def validate(cls) -> None:

packages/examples/cvat/exchange-oracle/src/handlers/error_handlers.py

@@ -32,17 +32,15 @@ async def http_exception_handler(_, exc):
             return JSONResponse(content=exc.detail.to_dict(), status_code=exc.status_code)
         if isinstance(error_detail, str):
             return JSONResponse(content={"message": error_detail}, status_code=status_code)
-        if Config.environment == "development":
+        if Config.is_development_mode():
             return JSONResponse(content={"message": str(error_detail)}, status_code=status_code)
 
         return JSONResponse(content={"message": "Something went wrong"}, status_code=status_code)
 
     @app.exception_handler(Exception)
     async def generic_exception_handler(_, exc: Exception):
         message = (
-            "Something went wrong"
-            if Config.environment != "development"
-            else ".".join(map(str, exc.args))
+            "Something went wrong" if Config.is_production_mode() else ".".join(map(str, exc.args))
         )
 
         return JSONResponse(content={"message": message}, status_code=500)

packages/examples/cvat/exchange-oracle/src/handlers/job_creation.py

@@ -210,7 +210,7 @@ def _setup_gt_job_for_cvat_task(
             with annotations_archive_path.open("wb") as annotations_archive:
                 write_dir_to_zip_archive(export_dir, annotations_archive)
 
-            if Config.is_development():
+            if Config.is_development_mode():
                 self._save_cvat_gt_dataset_to_oracle_bucket(
                     gt_dataset_path=annotations_archive_path, file_suffix=f"for_task_{task_id}"
                 )

packages/examples/cvat/exchange-oracle/src/log.py

@@ -16,7 +16,7 @@ def get_logger_name(module_name: str) -> str:
 
 def setup_logging():
     log_level_name = logging.getLevelName(
-        Config.loglevel or (logging.DEBUG if Config.environment == "development" else logging.INFO)
+        Config.loglevel or (logging.DEBUG if Config.is_development_mode() else logging.INFO)
     )
 
     log_config = {