test: debug tests

Author: afinkbeiner86

scripts/bump-version.py

@@ -1,6 +1,13 @@
 #!/usr/bin/env python3
 """
 bump-version.py - Automatically bump version in .toc and .lua files
+Usage: python bump-version.py <new_version>
+Example: python bump-version.py 2.9.0
+
+Exit codes:
+  0 - Success
+  1 - Invalid arguments or version format
+  2 - File operation error
 """
 
 import os
@@ -9,6 +16,7 @@
 from pathlib import Path
 
 
+# ANSI color codes (disabled in CI)
 class Colors:
     RED = "\033[0;31m"
     GREEN = "\033[0;32m"
@@ -30,18 +38,21 @@ def get_current_version() -> str:
     """Get current version from .toc file"""
     toc_path = Path("ConsumableManager.toc")
     if not toc_path.exists():
-        print(f"{Colors.RED}Error: {toc_path.name} not found{Colors.NC}")
+        print(f"{Colors.RED}Error: ConsumableManager.toc not found{Colors.NC}")
+        return "unknown"
+    try:
+        content = toc_path.read_text(encoding="utf-8")
+        for line in content.splitlines():
+            if line.startswith("## Version:"):
+                return line.split(":", 1)[1].strip()
+    except Exception as e:
+        print(f"{Colors.RED}Error reading version: {e}{Colors.NC}")
         return "unknown"
-
-    content = toc_path.read_text(encoding="utf-8")
-    for line in content.splitlines():
-        if line.startswith("## Version:"):
-            return line.split(":", 1)[1].strip()
     return "unknown"
 
 
 def update_file(filepath: str, old_content: str, new_content: str) -> bool:
-    """Update file content using pathlib and return success status"""
+    """Update file content and return success status"""
     path = Path(filepath)
     if old_content == new_content:
         print(f"{Colors.YELLOW}ℹ{Colors.NC}  No changes needed: {path.name}")
@@ -56,50 +67,60 @@ def update_file(filepath: str, old_content: str, new_content: str) -> bool:
 
 
 def bump_version(new_version: str) -> int:
-    """Bump version in .toc and .lua files"""
+    """
+    Bump version in .toc and .lua files
+    Returns: 0 on success, 2 on error
+    """
+
     print(f"{Colors.YELLOW}Bumping version to: {Colors.GREEN}{new_version}{Colors.NC}")
 
     current_version = get_current_version()
     print(f"Current version: {Colors.YELLOW}{current_version}{Colors.NC}")
-    print(f"New version:     {Colors.GREEN}{new_version}{Colors.NC}\n")
+    print(f"New version:     {Colors.GREEN}{new_version}{Colors.NC}")
+    print()
 
+    success = True
     toc_path = Path("ConsumableManager.toc")
     lua_path = Path("ConsumableManager.lua")
-    success = True
 
-    # Update TOC
+    # Update ConsumableManager.toc
     if toc_path.exists():
-        content = toc_path.read_text(encoding="utf-8")
-        new_content = re.sub(
+        toc_content = toc_path.read_text(encoding="utf-8")
+        new_toc = re.sub(
             r"^## Version:.*$",
             f"## Version: {new_version}",
-            content,
+            toc_content,
             flags=re.MULTILINE,
         )
-        if update_file(str(toc_path), content, new_content):
+
+        if update_file(str(toc_path), toc_content, new_toc):
             print(f"{Colors.GREEN}✓{Colors.NC} Updated: {toc_path.name}")
         else:
             success = False
     else:
         print(f"{Colors.RED}✗{Colors.NC} File not found: {toc_path.name}")
         success = False
 
-    # Update LUA
+    # Update ConsumableManager.lua
     if lua_path.exists():
-        content = lua_path.read_text(encoding="utf-8")
-        new_content = re.sub(
+        lua_content = lua_path.read_text(encoding="utf-8")
+
+        # Update header comment
+        new_lua = re.sub(
             r"^-- Version:.*$",
             f"-- Version: {new_version}",
-            content,
+            lua_content,
             flags=re.MULTILINE,
         )
-        new_content = re.sub(
-            r'local version = HexColor\("v[\d.]+',
-            f'local version = HexColor("v{new_version}',
-            new_content,
+
+        # Update status display version (Improved regex to catch quoted versions)
+        new_lua = re.sub(
+            r"v\d+\.\d+\.\d+",
+            f"v{new_version}",
+            new_lua,
         )
 
-        if update_file(str(lua_path), content, new_content):
+        if update_file(str(lua_path), lua_content, new_lua):
             print(
                 f"{Colors.GREEN}✓{Colors.NC} Updated: {lua_path.name} (header + status)"
             )
@@ -109,25 +130,32 @@ def bump_version(new_version: str) -> int:
         print(f"{Colors.RED}✗{Colors.NC} File not found: {lua_path.name}")
         success = False
 
+    # Summary
+    print()
     if success:
-        print(f"\n{Colors.GREEN}✓ Version bump complete!{Colors.NC}")
+        print(f"{Colors.GREEN}✓ Version bump complete!{Colors.NC}")
         return 0
-
-    print(f"\n{Colors.RED}✗ Version bump failed!{Colors.NC}")
-    return 2
+    else:
+        print(f"{Colors.RED}✗ Version bump failed!{Colors.NC}")
+        return 2
 
 
 def main():
     if len(sys.argv) != 2:
         print(f"{Colors.RED}Error: No version specified{Colors.NC}")
+        print(f"Usage: {sys.argv[0]} <new_version>")
+        print(f"Example: {sys.argv[0]} 2.9.0")
         sys.exit(1)
 
     new_version = sys.argv[1]
+
     if not validate_version(new_version):
         print(f"{Colors.RED}Error: Invalid version format{Colors.NC}")
+        print("Please use semantic versioning: X.Y.Z (e.g., 2.9.0)")
         sys.exit(1)
 
-    sys.exit(bump_version(new_version))
+    exit_code = bump_version(new_version)
+    sys.exit(exit_code)
 
 
 if __name__ == "__main__":

tests/test_bump_version.py

@@ -1,5 +1,10 @@
 #!/usr/bin/env python3
+"""
+Unit tests for bump-version.py
+"""
+
 import importlib.util
+import os
 import sys
 import tempfile
 import unittest
@@ -10,6 +15,8 @@
 
 spec = importlib.util.spec_from_file_location("bump_version", str(SCRIPT_PATH))
 bump_version = importlib.util.module_from_spec(spec)
+# Assigning spec to the module is required for importlib.reload() to work
+bump_version.__spec__ = spec
 sys.modules["bump_version"] = bump_version
 spec.loader.exec_module(bump_version)
 
@@ -18,16 +25,14 @@ class BaseBumpTest(unittest.TestCase):
     """Shared environment setup for file-based tests."""
 
     def setUp(self):
+        """Create temporary directory and switch CWD"""
         self.tmp_dir = tempfile.TemporaryDirectory()
         self.test_path = Path(self.tmp_dir.name)
         self.original_cwd = Path.cwd()
-        import os
-
         os.chdir(self.test_path)
 
     def tearDown(self):
-        import os
-
+        """Restore CWD and cleanup temp files"""
         os.chdir(self.original_cwd)
         self.tmp_dir.cleanup()
 
@@ -42,10 +47,13 @@ def create_mock_project(self, version="2.8.0"):
 
 
 class TestVersionValidation(unittest.TestCase):
+    """Test version format validation"""
+
     def test_validation(self):
+        """Test that valid and invalid semantic versions are handled"""
         cases = [
             ("1.0.0", True),
-            ("0.0.1", True),
+            ("2.9.0", True),
             ("1.0", False),
             ("v1.0.0", False),
             ("", False),
@@ -56,6 +64,8 @@ def test_validation(self):
 
 
 class TestBumpLogic(BaseBumpTest):
+    """Test the core version bumping functionality"""
+
     def test_successful_bump(self):
         """Test happy path: reading current and updating to new version."""
         self.create_mock_project("2.8.0")
@@ -75,12 +85,14 @@ def test_missing_files(self):
 
 
 class TestCIEnvironment(unittest.TestCase):
+    """Test behavior in CI environment"""
+
     def test_colors_disabled_in_ci(self):
         """Verify reload() functionality with registered sys.modules."""
         import importlib
-        import os
 
         os.environ["CI"] = "true"
+        # Reloading now works because __spec__ was assigned during import
         importlib.reload(bump_version)
         try:
             self.assertEqual(bump_version.Colors.RED, "")