add basic tests with pytest

Add some basic tests

Author: rettinghaus

.github/workflows/ci.yml

@@ -40,4 +40,19 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - run: pip install build setuptools wheel
       - run: python -m build
-      - run: python -m pip install .
+      - run: python -m pip install .
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install pytest pytest-cov
+      - run: pip install .
+      - run: pytest --cov=src --cov-report=xml --cov-report=term

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

csv2cmi.py

@@ -417,7 +417,7 @@ def create_date(date_string: Optional[str]) -> Optional[Element]:
         raise ValueError(f'unable to parse "{date_string}" as TEI date')
 
     @staticmethod
-    def create_place_name(place_name_text: str, geonames_uri: str | None = None) -> Element:
+    def create_place_name(place_name_text: str, geonames_uri: Optional[str] = None) -> Element:
         """Create a placeName element."""
         place_name = Element("placeName")
         place_name_text = place_name_text.strip()

tests/tests.csv tests/data/test.csvtests/tests.csv renamed to tests/data/test.csv

@@ -0,0 +1,46 @@
+import pytest
+
+import csv2cmi
+
+
+@pytest.fixture
+def table():
+    table
+
+
+def test_create_date_valid():
+    assert csv2cmi.CMI.create_date("2016-04-01").attrib["when"] == "2016-04-01"
+    assert csv2cmi.CMI.create_date("1673-05").attrib["when"] == "1673-05"
+    assert csv2cmi.CMI.create_date("[..1760-12-03]").attrib["notAfter"] == "1760-12-03"
+    assert csv2cmi.CMI.create_date("[1760-12..]").attrib["notBefore"] == "1760-12"
+    assert csv2cmi.CMI.create_date("1979-10-12/").attrib["from"] == "1979-10-12"
+    assert csv2cmi.CMI.create_date("/1985-04-12").attrib["to"] == "1985-04-12"
+    assert csv2cmi.CMI.create_date("{-0400,-0390,-0370}") is not None
+
+
+def test_create_date_invalid():
+    with pytest.raises(ValueError):
+        csv2cmi.CMI.create_date("not-a-date")
+
+
+def test_create_place_name():
+    tei_placename = csv2cmi.CMI.create_place_name("Berlin")
+    assert tei_placename.tag == "placeName"
+    assert tei_placename.text == "Berlin"
+
+
+def test_create_place_name_with_uri():
+    tei_placename = csv2cmi.CMI.create_place_name("Mokhdān", "https://www.geonames.org/123456")
+    assert tei_placename.tag == "placeName"
+    assert tei_placename.attrib["ref"] == "https://www.geonames.org/123456"
+    assert tei_placename.text == "Mokhdān"
+
+
+def test_generate_id_and_uuid():
+    id1 = csv2cmi.CMI.generate_id("test")
+    id2 = csv2cmi.CMI.generate_id("test")
+    assert id1 != id2
+    cmi = csv2cmi.CMI()
+    uuid1 = cmi.generate_uuid()
+    uuid2 = cmi.generate_uuid()
+    assert uuid1 != uuid2

tests/test_cmi_methods.py

@@ -0,0 +1,38 @@
+import runpy
+import sys
+from pathlib import Path
+from xml.etree.ElementTree import parse
+
+import pytest
+
+
+@pytest.fixture
+def csv_file() -> Path:
+    csv_path = Path(__file__).parent / "data" / "test.csv"
+    return csv_path
+
+
+@pytest.fixture
+def temp_output_file(tmp_path: Path) -> Path:
+    return tmp_path / "output.xml"
+
+
+def test_cli_conversion(csv_file: Path, temp_output_file: Path, monkeypatch: pytest.MonkeyPatch):
+    # Simulate CLI call
+    sys_argv = ["csv2cmi.py", str(csv_file), "-o", str(temp_output_file)]
+    monkeypatch.setattr(sys, "argv", sys_argv)
+    runpy.run_module("csv2cmi", run_name="__main__")
+    assert temp_output_file.exists()
+    # Check XML root
+    tree = parse(temp_output_file)
+    root = tree.getroot()
+    assert root.tag == "{http://www.tei-c.org/ns/1.0}TEI"
+
+
+def test_missing_file(monkeypatch: pytest.MonkeyPatch):
+    sys_argv = ["csv2cmi.py", "nonexistent.csv"]
+    monkeypatch.setattr(sys, "argv", sys_argv)
+    with pytest.raises(SystemExit):
+        import runpy
+
+        runpy.run_module("csv2cmi", run_name="__main__")