chore(dev): tidy dependencies, ensure coverage/type-check run cleanly (#15)

* ci: add Python 3.13 support

* ci(pytest): set coverage threshold at 75%

* ci(ruff): add linter

* ci(ruff): add project section in pyproject
required by ruff

* test: remove unused imports

* refactor: tidy imports and improve type hints

Author: bcdady

.github/workflows/ci.yaml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
     - uses: actions/checkout@v4
@@ -27,8 +27,17 @@ jobs:
         pip install poetry twine
         poetry install --with dev
         
-    - name: Run tests
-      run: poetry run pytest
+    - name: Lint with Ruff
+      run: poetry run ruff check .
+        
+    - name: Run tests with coverage
+      run: |
+        poetry run pytest --cov=tfsumpy --cov-report=term
+        poetry run coverage report --fail-under=75
+
+    - name: Coverage reminder
+      if: success()
+      run: echo "::notice ::Current threshold is 75%. PRs that raise coverage are welcome!"
 
     - name: Build package
       run: poetry build

pyproject.toml

@@ -1,3 +1,8 @@
+[project]
+name = "tfsumpy"
+version = "0.2.0"
+requires-python = ">=3.10,<4.0"
+
 [tool.poetry]
 name = "tfsumpy"
 version = "0.2.0"
@@ -16,6 +21,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Software Development :: Build Tools",
     "Topic :: System :: Systems Administration"
 ]
@@ -35,13 +41,18 @@ jinja2 = "^3.1.6"
 [tool.poetry.group.dev.dependencies]
 pytest-cov = ">=4.1.0"
 pytest-mock = ">=3.6.1"
+ruff = ">=0.4.0"
+mypy = ">=1.10.0"
+types-colorama = "*"
 coverage = ">=7.2.0"
 
 [tool.poetry.extras]
 dev = [
     "pytest-cov",
     "pytest-mock",
-    "coverage"
+    "coverage",
+    "ruff",
+    "mypy"
 ]
 
 [tool.poetry.scripts]

tests/plan/test_plan_reporter.py

@@ -1,9 +1,8 @@
 import pytest
-from unittest.mock import Mock, patch
+from unittest.mock import patch
 from tfsumpy.plan.reporter import PlanReporter
 import re
 import json
-from datetime import datetime
 
 @pytest.fixture
 def reporter():

tfsumpy/__main__.py

@@ -1,7 +1,6 @@
 import logging
 import argparse
 import warnings
-from pathlib import Path
 from .plan.analyzer import PlanAnalyzer
 from .plan.reporter import PlanReporter
 from .context import Context

tfsumpy/analyzer.py

@@ -1,5 +1,10 @@
+from __future__ import annotations
+
 from abc import ABC, abstractmethod
-from typing import Dict, List, Any
+from typing import Any, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .context import Context
 from dataclasses import dataclass
 
 @dataclass

tfsumpy/context.py

@@ -1,14 +1,14 @@
 import json
 import logging
 import os
-from typing import Dict, List, Type, Any
+from typing import Dict, List, Any, Optional
 from .analyzer import AnalyzerInterface, AnalyzerResult
 from .reporter import ReporterInterface
 
 class Context:
     """Application context that manages analyzers and configuration."""
 
-    def __init__(self, config_path: str = None, debug: bool = False):
+    def __init__(self, config_path: Optional[str] = None, debug: bool = False):
         self.config_path = config_path
         self.debug = debug
 
@@ -21,13 +21,13 @@ def __init__(self, config_path: str = None, debug: bool = False):
         )
 
         # Initialize components
-        self.sensitive_patterns = []
-        self.config = {}
+        self.sensitive_patterns: List[tuple[str, str]] = []
+        self.config: Dict[str, Any] = {}
 
         # Initialize analyzer registry
         self._analyzers: Dict[str, List[AnalyzerInterface]] = {}
         self._reporters: Dict[str, List[ReporterInterface]] = {}
-        self.plan_data = None
+        self.plan_data: Optional[Dict[str, Any]] = None
 
     def register_analyzer(self, analyzer: AnalyzerInterface) -> None:
         """Register an analyzer in its category.
@@ -90,7 +90,7 @@ def set_plan_data(self, plan_data: Dict) -> None:
         """
         self.plan_data = plan_data
 
-    def get_plan_data(self) -> Dict:
+    def get_plan_data(self) -> Optional[Dict[str, Any]]:
         """Retrieve stored plan data.
         
         Returns:
@@ -122,6 +122,7 @@ def _merge_external_config(self) -> None:
         """Merge external configuration with default configuration"""
         self.logger.debug(f"Merging external config file: {self.config_path}")
         try:
+            assert self.config_path is not None
             with open(self.config_path, 'r') as f:
                 external_config = json.load(f)
 

tfsumpy/plan/analyzer.py

@@ -1,6 +1,11 @@
+from __future__ import annotations
+
 import json
 import logging
-from typing import Dict, List
+from typing import List, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ..context import Context
 from ..resource import ResourceChange
 from ..analyzer import AnalyzerInterface, AnalyzerResult
 

tfsumpy/resource.py

@@ -1,23 +1,14 @@
-from dataclasses import dataclass
-from typing import List, Dict
+from dataclasses import dataclass, field
+from typing import Dict, Any
 
 @dataclass
 class ResourceChange:
+    """Represents a single Terraform resource change."""
+
     action: str
     resource_type: str
     identifier: str
-    changes: List[str]
-    module: str = 'root'
-    before: dict = None
-    after: dict = None
-
-    def __init__(self, action: str, resource_type: str, identifier: str, 
-                 changes: dict, module: str = 'root', before: dict = None, 
-                 after: dict = None):
-        self.action = action
-        self.resource_type = resource_type
-        self.identifier = identifier
-        self.changes = changes
-        self.module = module
-        self.before = before or {}
-        self.after = after or {}
+    changes: Dict[str, Any] = field(default_factory=dict)
+    module: str = "root"
+    before: Dict[str, Any] = field(default_factory=dict)
+    after: Dict[str, Any] = field(default_factory=dict)