add support for LEGEND_METADATA_TESTDIR usage in tests for ci

Author: gipert

.github/workflows/main.yml

@@ -32,9 +32,9 @@ jobs:
         run: |
           python -m pip install --upgrade pip wheel setuptools
           python -m pip install --upgrade .[test]
-      - name: Set LEGEND_METADATA variable
+      - name: Set LEGEND_METADATA_TESTDIR variable
         run: |
-          echo "LEGEND_METADATA=$GITHUB_WORKSPACE/legend-metadata" >> $GITHUB_ENV
+          echo "LEGEND_METADATA_TESTDIR=$GITHUB_WORKSPACE/legend-metadata" >> $GITHUB_ENV
       - name: Clone legend-metadata
         if: github.event.pull_request.head.repo.fork == false
         uses: actions/checkout@v4
@@ -43,11 +43,11 @@ jobs:
           fetch-depth: 0
           submodules: recursive
           token: ${{ secrets.READPRIVATE }}
-          path: ${{ env.LEGEND_METADATA }}
+          path: ${{ env.LEGEND_METADATA_TESTDIR }}
       - name: Run unit tests
         if: github.event.pull_request.head.repo.fork == true
         run: |
-          python -m pytest
+          python -m pytest -m "not needs_slowcontrol"
       - name: Run unit tests that need legend-metadata
         if: github.event.pull_request.head.repo.fork == false
         run: |
@@ -68,9 +68,9 @@ jobs:
         run: |
           python -m pip install --upgrade pip wheel setuptools
           python -m pip install --upgrade .[test]
-      - name: Set LEGEND_METADATA variable
+      - name: Set LEGEND_METADATA_TESTDIR variable
         run: |
-          echo "LEGEND_METADATA=$GITHUB_WORKSPACE/legend-metadata" >> $GITHUB_ENV
+          echo "LEGEND_METADATA_TESTDIR=$GITHUB_WORKSPACE/legend-metadata" >> $GITHUB_ENV
       - name: Clone legend-metadata
         if: github.event.pull_request.head.repo.fork == false
         uses: actions/checkout@v4
@@ -79,11 +79,11 @@ jobs:
           fetch-depth: 0
           submodules: recursive
           token: ${{ secrets.READPRIVATE }}
-          path: ${{ env.LEGEND_METADATA }}
+          path: ${{ env.LEGEND_METADATA_TESTDIR }}
       - name: Generate report for unit tests
         if: github.event.pull_request.head.repo.fork == true
         run: |
-          python -m pytest --cov=legendmeta --cov-report=xml
+          python -m pytest --cov=legendmeta --cov-report=xml -m "not needs_slowcontrol"
       - name: Generate report for (all) unit tests
         if: github.event.pull_request.head.repo.fork == false
         run: |

src/legendmeta/core.py

@@ -51,7 +51,7 @@ class LegendMetadata(TextDB):
     """
 
     def __init__(self, path: str | None = None, **kwargs) -> None:
-        if isinstance(path, str):
+        if isinstance(path, (str, Path)):
             self.__repo_path__ = path
         else:
             self.__repo_path__ = os.getenv("LEGEND_METADATA", "")

tests/test_lmeta.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import os
 from datetime import datetime
 
 import pytest
@@ -16,8 +17,13 @@
 
 
 @pytest.fixture
-def metadb():
-    mdata = LegendMetadata(lazy=True)
+def metadb(tmpdir):
+    if os.getenv("LEGEND_METADATA_TESTDIR") is not None:
+        # for the CI
+        mdata = LegendMetadata(os.getenv("LEGEND_METADATA_TESTDIR"), lazy=True)
+    else:
+        # explicit path ignores LEGEND_METADATA
+        mdata = LegendMetadata(str(tmpdir), lazy=True)
     mdata.checkout("main")
     return mdata