fix: update buildspec and add tests

.gitignore

@@ -4,4 +4,4 @@ __pycache__
 build
 dist
 *.egg-info
-corsair/_version.py
+.coverage

.pre-commit-config.yaml

@@ -74,11 +74,11 @@ repos:
         pass_filenames: false
         files: ^(.*/)?(poetry\.lock|pyproject\.toml)$
 
-      - id: poetry-install
-        name: poetry-install
-        description: Run poetry install to install dependencies from the lock file
-        entry: poetry install
-        language: python
+      - id: pytest
+        name: Pytest smoke testing
+        description: Run pytest to execute all smoke tests
+        entry: poetry run pytest -m "smoke"
+        language: system
         pass_filenames: false
-        stages: [post-checkout, post-merge]
+        stages: [pre-commit]
         always_run: true

conftest.py

@@ -1,4 +1,15 @@
-import sys
+"""Configuration for pytest."""
 
+from __future__ import annotations
 
-collect_ignore = ['setup.py', 'docs']
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    import pytest
+
+collect_ignore = ["docs"]
+
+
+def pytest_configure(config: pytest.Config) -> None:
+    """Perform initial configuration."""
+    config.addinivalue_line("markers", "smoke: mark test as smoke to run before commiting code")

corsair/cli.py

@@ -37,7 +37,7 @@
 # Disable any rich formated output if user wish (disables color as well)
 if os.getenv("TERM") in ("dumb", "unknown"):
     # Values above are from rich package documentation, but for typer we need to apply them manually
-    typer.core.rich = None
+    typer.core.rich = None  # pyright: ignore [reportAttributeAccessIssue]
     app.pretty_exceptions_enable = False
 
 # Enable verbose output for debugging if user wish
@@ -49,11 +49,13 @@
 @app.command()
 def build(
     spec: Annotated[
-        Path,
+        Path | None,
         typer.Argument(
-            help="Path to a build specification file.",
+            show_default=False,
+            help="Optional path to a build specification file. "
+            "By default, 'crsbuild.toml' or '*.csrbuild.toml' are expected.",
         ),
-    ] = Path("corsair.toml"),
+    ] = Path("csrbuild.toml"),
     targets: Annotated[
         list[str] | None,
         typer.Option(
@@ -100,7 +102,7 @@ def schemas(outdir: Annotated[Path, typer.Argument(help="Path for output files."
     """Dump JSON schemas for all possible user input files."""
     logger.debug("cmd schemas args: %s", locals())
     with utils.chdir(outdir):
-        buildspec_schema = outdir / "corsair.buildspec.json"
+        buildspec_schema = outdir / "csrbuild.schema.json"
         logger.info("Dump schema for the build specification: %s", buildspec_schema)
         input.buildspec.BuildSpecification.to_json_schema_file(buildspec_schema)
 

corsair/input/buildspec.py

@@ -9,11 +9,11 @@
 if TYPE_CHECKING:
     from pathlib import Path
 
-    from .config import GlobalConfig
-    from .target import AnyTarget
-
 from pydantic import BaseModel, Field
 
+from .config import GlobalConfig
+from .target import AnyTarget
+
 if sys.version_info >= (3, 11):
     import tomllib as tomlib
 else:

corsair/input/config.py

@@ -3,10 +3,7 @@
 from __future__ import annotations
 
 from enum import Enum
-from typing import TYPE_CHECKING
-
-if TYPE_CHECKING:
-    from pathlib import Path
+from pathlib import Path
 
 from pydantic import (
     BaseModel,
@@ -50,10 +47,10 @@ class ForceNameCase(str, Enum):
 class GlobalConfig(BaseModel):
     """Global configuration parameters of the Corsair build specification."""
 
-    regmap: Path
+    regmap: Path = Path("csrmap.yaml")
     """Path to a register map to be processed."""
 
-    regmap_parser: str | None = Field(pattern=r"^.*\.py::\w+$", examples=["foo.py::FooParser"])
+    regmap_parser: str | None = Field(default=None, pattern=r"^.+\.py::\w+$", examples=["foo.py::FooParser"])
     """Select register map parser class explicitly.
 
     Parser is selected automatically based on file extension if value is not provided.