pytest-embedded 2.2.1__tar.gz → 2.4.0__tar.gz

{pytest_embedded-2.2.1 → pytest_embedded-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-embedded
-Version: 2.2.1
+Version: 2.4.0
 Summary: A pytest plugin that designed for embedded testing.
 Author-email: Fu Hanxi <fuhanxi@espressif.com>
 Requires-Python: >=3.10

{pytest_embedded-2.2.1 → pytest_embedded-2.4.0}/pytest_embedded/__init__.py

@@ -6,4 +6,4 @@ from .dut_factory import DutFactory
 
 __all__ = ['App', 'Dut', 'DutFactory']
 
-__version__ = '2.2.1'
+__version__ = '2.4.0'

{pytest_embedded-2.2.1 → pytest_embedded-2.4.0}/pytest_embedded/plugin.py

@@ -153,6 +153,10 @@ def pytest_addoption(parser):
     base_group.addoption(
         '--logfile-extension', default='.log', help='set the extension format of the log files. (Default: ".log")'
     )
+    base_group.addoption(
+        '--metric-path',
+        help='Path to openmetrics txt file to log metrics. (Default: None)',
+    )
 
     serial_group = parser.getgroup('embedded-serial')
     serial_group.addoption('--port', help='serial port. (Env: "ESPPORT" if service "esp" specified, Default: "None")')
@@ -634,6 +638,55 @@ def port_app_cache() -> dict[str, str]:
     return {}
 
 
+@pytest.fixture(scope='session')
+def metric_path(request: FixtureRequest) -> str | None:
+    """
+    Get the metric file path from the command line option.
+
+    :param request: pytest request object
+    :return: The path to the metric file, or None if not provided.
+    """
+    return request.config.getoption('metric_path', None)
+
+
+@pytest.fixture(scope='session')
+def log_metric(metric_path: str | None) -> t.Callable[..., None]:
+    """
+    Provides a function to log metrics in OpenMetrics format.
+
+    The file is cleared at the beginning of the test session.
+
+    :param metric_path: Path to the metric file, from the ``--metric-path`` option.
+    :return: A function to log metrics, or a no-op function if the path is not provided.
+    """
+    if not metric_path:
+
+        def no_op(key: str, value: t.Any, **kwargs: t.Any) -> None:  # noqa: ARG001
+            warnings.warn('`--metric-path` is not specified, `log_metric` does nothing.')
+
+        return no_op
+
+    if os.path.exists(metric_path):
+        os.remove(metric_path)
+    elif os.path.dirname(metric_path):
+        os.makedirs(os.path.dirname(metric_path), exist_ok=True)
+
+    def _log_metric_impl(key: str, value: t.Any, **kwargs: t.Any) -> None:
+        labels = ''
+        if kwargs:
+            label_str = ','.join(f'{k}="{v}"' for k, v in kwargs.items())
+            labels = f'{{{label_str}}}'
+
+        line = f'{key}{labels} {value}\n'
+
+        lock = filelock.FileLock(f'{metric_path}.lock')
+        with lock:
+            with open(metric_path, 'a') as f:
+                f.write(line)
+
+    return _log_metric_impl
+
+
 @pytest.fixture(scope='session', autouse=True)
 def _mp_manager():
     manager = MessageQueueManager()

{pytest_embedded-2.2.1 → pytest_embedded-2.4.0}/tests/test_base.py

@@ -792,3 +792,32 @@ class TestTargetMarkers:
 
         result.assert_outcomes(passed=1)
         assert 'Unknown pytest.mark.esp32 - is this a typo?' not in result.stdout.str()
+
+
+def test_log_metric_with_path(pytester):
+    metric_file = pytester.path / 'metrics.txt'
+    pytester.makepyfile("""
+        def test_metric(log_metric):
+            log_metric('my_metric', 123.45, label1='value1', target='esp32')
+    """)
+
+    result = pytester.runpytest(f'--metric-path={metric_file}')
+    result.assert_outcomes(passed=1)
+
+    with open(metric_file) as f:
+        content = f.read()
+
+    assert content == 'my_metric{label1="value1",target="esp32"} 123.45\n'
+
+
+def test_log_metric_without_path(pytester):
+    pytester.makepyfile("""
+        import pytest
+
+        def test_metric_no_path(log_metric):
+            with pytest.warns(UserWarning, match='`--metric-path` is not specified, `log_metric` does nothing.'):
+                log_metric('my_metric', 123.45)
+    """)
+
+    result = pytester.runpytest()
+    result.assert_outcomes(passed=1)