feat(posfilter): Adds config model for Position Filtering

src/gnatss/configs/main.py

@@ -17,6 +17,7 @@
 )
 
 from .io import OutputPath
+from .posfilter import PositionFilter
 from .solver import Solver
 
 CONFIG_FILE = "config.yaml"
@@ -118,12 +119,16 @@ class Configuration(BaseConfiguration):
     site_id: str = Field(..., description="The site identification for processing")
     # TODO: Separate settings out to core plugin
     solver: Optional[Solver] = Field(None, description="Solver configurations")
-    output: OutputPath
+    posfilter: Optional[PositionFilter] = Field(
+        None, description="Position filter configurations"
+    )
+    output: Optional[OutputPath] = Field(None, description="Output path configurations")
 
     def __init__(self, **data):
         super().__init__(**data)
 
-        # Set the transponders pxp id based on the site id
-        transponders = self.solver.transponders
-        for idx in range(len(transponders)):
-            transponders[idx].pxp_id = "-".join([self.site_id, str(idx + 1)])
+        if self.solver is not None:
+            # Set the transponders pxp id based on the site id
+            transponders = self.solver.transponders
+            for idx in range(len(transponders)):
+                transponders[idx].pxp_id = "-".join([self.site_id, str(idx + 1)])

src/gnatss/configs/posfilter.py

@@ -0,0 +1,25 @@
+"""posfilter.py
+
+The posfilter module containing base models for
+position filtering configuration
+"""
+
+from pydantic import BaseModel, Field
+
+from .io import InputData
+
+
+class PositionFilterInputs(BaseModel):
+    roll_pitch_heading: InputData = Field(
+        ..., description="Roll Pitch Heading (RPH) data path specification."
+    )
+
+
+class PositionFilter(BaseModel):
+    """
+    Position filter base model for position filtering routine
+    """
+
+    input_files: PositionFilterInputs = Field(
+        ..., description="Input files for position filtering routine."
+    )

tests/configs/test_main.py

@@ -0,0 +1,44 @@
+from pathlib import Path
+
+import pytest
+
+from gnatss.configs.main import Configuration
+
+
+def test_env_configuration_main(blank_env: None) -> None:
+    """Testing a simple configuration class
+    with environment variables.
+
+    See root/conftest.py for fixture definition.
+    """
+    with pytest.warns(
+        UserWarning,
+        match=(
+            "Configuration file `config.yaml` not found. "
+            "Will attempt to retrieve configuration from environment variables."
+        ),
+    ):
+        config = Configuration()
+
+    assert config.site_id == "test_site"
+
+
+def test_env_main_posfilter(blank_csv_test_file: Path, blank_env: None) -> None:
+    """Testing setting RPS input file path
+    with environment variables
+
+    See root/conftest.py for fixture definition.
+    """
+    test_path = str(blank_csv_test_file)
+
+    with pytest.warns(
+        UserWarning,
+        match=(
+            "Configuration file `config.yaml` not found. "
+            "Will attempt to retrieve configuration from environment variables."
+        ),
+    ):
+        config = Configuration()
+
+    assert config.posfilter is not None
+    assert config.posfilter.input_files.roll_pitch_heading.path == test_path

tests/configs/test_posfilter.py

@@ -0,0 +1,24 @@
+from pathlib import Path
+
+import pytest
+
+from gnatss.configs.io import InputData
+from gnatss.configs.posfilter import PositionFilter, PositionFilterInputs
+
+
+def test_position_filter_input(blank_csv_test_file: Path) -> None:
+    """Testing the PositionFilterInputs class.
+
+    See root/conftest.py for fixture definition.
+    """
+    test_path = str(blank_csv_test_file)
+
+    # Test initialization of PositionFilter
+    inputs = PositionFilterInputs(roll_pitch_heading=InputData(path=test_path))
+    pos_filter = PositionFilter(input_files=inputs)
+    assert pos_filter.input_files.roll_pitch_heading.path == test_path
+
+    # Test invalid initialization of PositionFilter
+    with pytest.raises(Exception) as e:
+        pos_filter = PositionFilter()
+        assert "1 validation error for PositionFilter\ninput_files\n" in str(e)

tests/conftest.py

@@ -0,0 +1,25 @@
+import os
+from pathlib import Path
+
+import pytest
+
+
+@pytest.fixture
+def blank_csv_test_file() -> Path:
+    # Create test file
+    test_file = Path(__file__).parent / "test_data.csv"
+    test_file.touch()
+    # This will yield and return until the end of the test
+    yield test_file
+    # Delete test file
+    test_file.unlink()
+
+
+@pytest.fixture
+def blank_env(blank_csv_test_file: Path) -> None:
+    # Set environment variables
+    os.environ.setdefault("GNATSS_SITE_ID", "test_site")
+    os.environ.setdefault(
+        "GNATSS_POSFILTER__INPUT_FILES__ROLL_PITCH_HEADING__PATH",
+        str(blank_csv_test_file),
+    )