budtestlibrary 1.0.0__py3-none-any.whl

budtestlibrary/__init__.py

@@ -0,0 +1,54 @@
+"""
+budtestlibrary - Bud Test Automation Framework.
+
+A comprehensive test framework providing:
+- BudTestCase: Base class for test cases with lifecycle management, assertions, and logging
+- BloomMetaData: Bloom PLM integration for test case traceability (*-TC-*)
+- FlashEvent: Firmware flashing abstraction with success/failure handling
+
+Backend: Bud TMP
+PLM/PLM: Bloom PLM
+
+Copyright (c) 2026 EmbedLabs
+"""
+
+from importlib.metadata import version
+from pathlib import Path
+
+from budtestlibrary.bloom_metadata import BloomMetaData
+from budtestlibrary.budtestcase import BudTestCase
+from budtestlibrary.config import BudConfig, get_default_config
+from budtestlibrary.flash_event import FlashEvent, FlashFailure, FlashSuccess
+
+
+def _get_version():
+    """Reads version from pyproject.toml."""
+    try:
+        return version("budtestlibrary")
+    except Exception:
+        pass
+
+    try:
+        pyproject_path = Path(__file__).parent.parent / "pyproject.toml"
+        if pyproject_path.exists():
+            for line in pyproject_path.read_text().splitlines():
+                if line.startswith("version = "):
+                    return line.split("=")[1].strip().strip('"')
+    except Exception:
+        pass
+    return "unknown"
+
+
+__version__ = _get_version()
+__author__ = "EmbedLabs"
+__email__ = "dev@embedlabs.net"
+
+__all__ = [
+    "BudTestCase",
+    "BloomMetaData",
+    "FlashEvent",
+    "FlashSuccess",
+    "FlashFailure",
+    "BudConfig",
+    "get_default_config",
+]

budtestlibrary/bloom_metadata.py

@@ -0,0 +1,49 @@
+"""
+BloomMetadata - Direct linkage to Bloom PLM Test Cases (*-TC-*).
+"""
+
+import re
+from dataclasses import dataclass
+from typing import Any, Optional
+
+_TC_ID_SUFFIX_PATTERN = re.compile(r"^[a-zA-Z0-9_-]+$")
+
+
+@dataclass
+class BloomMetaData:
+    """
+    Metadata linking a test class to a Test Case in Bloom PLM.
+    Standard Format: {Project}-TC-{ID}
+    """
+
+    project: str
+    tc_id_suffix: str
+    description: Optional[str] = None
+
+    def __post_init__(self):
+        if not self.project or not self.project.strip():
+            raise ValueError("BloomMetaData.project must be a non-empty string")
+        if not self.tc_id_suffix or not self.tc_id_suffix.strip():
+            raise ValueError("BloomMetaData.tc_id_suffix must be a non-empty string")
+        if not _TC_ID_SUFFIX_PATTERN.match(self.tc_id_suffix):
+            raise ValueError(
+                f"BloomMetaData.tc_id_suffix must match '{_TC_ID_SUFFIX_PATTERN.pattern}', "
+                f"got '{self.tc_id_suffix}'"
+            )
+
+    def get_full_tc_id(self) -> str:
+        """Returns the full standard ID: *-TC-*"""
+        return f"{self.project}-TC-{self.tc_id_suffix}"
+
+    def get_url(self, base_url: str = "") -> str:
+        """Get the direct URL to the test case."""
+        return f"{base_url.rstrip('/')}/projects/{self.project}/test-cases/{self.tc_id_suffix}"
+
+    def to_dict(self) -> dict[str, Any]:
+        return {
+            "project": self.project,
+            "tc_id": self.get_full_tc_id(),
+            "display_id": self.get_full_tc_id(),
+            "description": self.description,
+            "url": self.get_url(),
+        }