Add tests and better file structure (#2)

* Update pre-commit

* Update settings

* Update logger and add more tests

Author: ross-tsenov

.env.sample

@@ -1,2 +1,3 @@
 ENV="dev"
-OTHER_VAR="OIHER VAR"
+LOGGER_NAME="project_logger"
+LOGGING_LEVEL="INFO"

.pre-commit-config.yaml

@@ -11,7 +11,6 @@ repos:
   - id: end-of-file-fixer
   - id: trailing-whitespace
   - id: check-case-conflict
-  - id: check-docstring-first
   - id: name-tests-test
   - id: detect-private-key
 
@@ -47,14 +46,14 @@ repos:
       args: ["--ignore-missing-imports"]
       require_serial: true
 
-- repo: local
-  hooks:
-    - id: pytest
-      name: run tests
-      description: ""
-      entry: poetry run pytest tests
-      pass_filenames: false
-      language: python
-      types_or: [python, pyi]
-      args: []
-      require_serial: true
+# - repo: local
+#   hooks:
+#     - id: pytest
+#       name: run tests
+#       description: ""
+#       entry: poetry run pytest tests
+#       pass_filenames: false
+#       language: python
+#       types_or: [python, pyi]
+#       args: []
+#       require_serial: true

main.py

@@ -0,0 +1,10 @@
+from src.logger import logger
+from src.settings import settings
+
+
+def main() -> None:
+    logger.info(settings)
+
+
+if __name__ == "__main__":
+    main()

poetry.lock

@@ -47,7 +47,6 @@ build-backend = "poetry.core.masonry.api"
 [tool.ruff]
 line-length = 122
 target-version = "py310"
-# All options here: https://github.com/charliermarsh/ruff#supported-rules
 select = [
     "A",
     "B",
@@ -71,24 +70,24 @@ select = [
 ]
 
 
-[tool.ruff.per-file-ignores]
-"**/tests/*" = ["S101"]
+[tool.ruff.lint.per-file-ignores]
+"**/tests/*" = ["S101", "SIM117"]
 "*init*.py" = ["F401"]
 
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 combine-as-imports = true
 force-wrap-aliases = true
 
 
-[tool.ruff.pylint]
+[tool.ruff.lint.pylint]
 max-args = 8
 max-branches = 25
 max-returns = 9
 max-statements = 30
 
 
-[tool.isort]
+[tool.lint.isort]
 profile = "black"
 line_length=122
 multi_line_output=3

pyproject.toml

@@ -0,0 +1,13 @@
+def get_version_from_pyproject(filename: str) -> str:
+    """Loads version from .toml file."""
+    with open(filename) as file:
+        for line in file:
+            if not line.strip().startswith("version"):
+                continue
+            version = line.split("=")[1].strip().strip('"').strip("'")
+            return version
+
+    return ""
+
+
+__version__ = get_version_from_pyproject("./pyproject.toml")

src/__init__.py

@@ -0,0 +1,30 @@
+import logging
+
+from .settings import settings
+
+__all__ = [
+    "logger",
+]
+
+
+def _create_logger() -> logging.Logger:
+    """Creates generic logger with the given `logger_name` and `logging_level`"""
+
+    logger = logging.getLogger(settings.logger_name)
+    logger.setLevel(settings.logging_level)
+
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(settings.logging_level)
+
+    formatter = logging.Formatter(
+        fmt="%(levelname)s [%(asctime)s %(name)s]: %(message)s",
+        datefmt="%m/%d %H:%M:%S",
+    )
+    console_handler.setFormatter(formatter)
+
+    logger.addHandler(console_handler)
+    return logger
+
+
+logger = _create_logger()
+"""Logger that can be imported and be used globally."""

src/logger.py

@@ -1,19 +1,38 @@
-from enum import StrEnum
+from enum import StrEnum, auto
+from typing import Literal
 
 from dotenv import load_dotenv
 from pydantic_settings import BaseSettings
 
+__all__ = [
+    "Environment",
+    "settings",
+]
+
 
 class Environment(StrEnum):
-    DEV = "dev"
-    PROD = "prod"
+    DEV = auto()
+    PROD = auto()
+
+
+LoggingLevel = Literal[
+    "CRITICAL",
+    "FATAL",
+    "ERROR",
+    "WARNING",
+    "WARN",
+    "INFO",
+    "DEBUG",
+    "NOTSET",
+]
 
 
 class Settings(BaseSettings):
     """Global application settings loaded from the .env file."""
 
     env: Environment = Environment.DEV
-    other_var: str = "other"
+    logger_name: str = "project_logger"
+    logging_level: LoggingLevel = "INFO"
 
 
 load_dotenv(override=True)

src/main.py

@@ -0,0 +1,7 @@
+def test_logger_logging() -> None:
+    """Test if the logger correctly logs a message."""
+    from src.logger import logger
+
+    test_message = "This is a test message"
+    logger.info(test_message)
+    logger.setLevel("DEBUG")

src/settings.py

@@ -0,0 +1,30 @@
+import os
+from unittest.mock import patch
+
+import pytest
+from pydantic_core import ValidationError
+
+from src.settings import Environment, Settings
+
+
+def test_environment_override() -> None:
+    """Test overriding settings through environment variables."""
+    with patch.dict(os.environ, {"ENV": "prod", "LOGGER_NAME": "test_logger", "LOGGING_LEVEL": "DEBUG"}):
+        settings = Settings()
+        assert settings.env == Environment.PROD
+        assert settings.logger_name == "test_logger"
+        assert settings.logging_level == "DEBUG"
+
+
+def test_invalid_environment() -> None:
+    """Test setting an invalid environment variable."""
+    with patch.dict(os.environ, {"ENV": "INVALID_ENV"}):
+        with pytest.raises(ValidationError):
+            Settings()
+
+
+def test_invalid_logging_level() -> None:
+    """Test setting an invalid logging level."""
+    with patch.dict(os.environ, {"LOGGING_LEVEL": "INVALID_LEVEL"}):
+        with pytest.raises(ValidationError):
+            Settings()

tests/core/__init__.py

@@ -0,0 +1,30 @@
+from pathlib import Path
+
+import pytest
+
+from src import get_version_from_pyproject
+
+
+def path_to_pyproject(tmp_path: Path) -> Path:
+    temp_dir = tmp_path / "sub"
+    temp_dir.mkdir()
+    file = temp_dir / "pyproject.toml"
+    return file
+
+
+def test_get_version_from_pyproject(path_to_pyproject: Path) -> None:
+    version = "1.2.3"
+    path_to_pyproject.write_text(f"version = '{version}'")
+    result = get_version_from_pyproject(str(path_to_pyproject))
+    assert version == result
+
+
+def test_get_version_from_empty_pyproject(path_to_pyproject: Path) -> None:
+    path_to_pyproject.write_text("")
+    version = get_version_from_pyproject(str(path_to_pyproject))
+    assert version == ""
+
+
+def test_get_version_from_nonexistent_file() -> None:
+    with pytest.raises(FileNotFoundError):
+        get_version_from_pyproject("nonexistent_file.toml")