Add tests

python · ambv · Mar 6, 2024 · Mar 28, 2023 · Mar 28, 2023 · Mar 28, 2023
commit 535fc6a24f7d7cab160d60a925558b3eea5ac7ea
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,15 @@
+# .coveragerc to control coverage.py
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma:
+    pragma: no cover
+
+    # Don't complain if non-runnable code isn't run:
+    if __name__ == .__main__.:
+    def main
+
+[run]
+omit =
+    **/blurb/__main__.py
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -2,6 +2,9 @@ name: Tests
 
 on: [push, pull_request, workflow_dispatch]
 
+env:
+  FORCE_COLOR: 1
+
 jobs:
   build_ubuntu:
     strategy:
@@ -21,10 +24,23 @@ jobs:
           python --version
           python -m pip install --upgrade pip
           python -m pip install --upgrade flit
+          python -m pip install --upgrade pytest pytest-cov pyfakefs
       - name: install
         run: |
           cd blurb
-          flit install
+          pip install -e .
       - name: test
         run: |
           blurb test
+      - name: pytest
+        # TODO Pending https://github.com/pytest-dev/pyfakefs/issues/770
+        if: matrix.python-version != '3.12-dev'
+        run: |
+          pytest --cov blurb
+      - name: Upload coverage
+        # TODO Pending https://github.com/pytest-dev/pyfakefs/issues/770
+        if: matrix.python-version != '3.12-dev'
+        uses: codecov/codecov-action@v3
+        with:
+          flags: ${{ matrix.python-version }}
+          name: Python ${{ matrix.python-version }}
diff --git a/blurb/tests/test_blurb.py b/blurb/tests/test_blurb.py
@@ -0,0 +1,127 @@
+import pytest
+from pyfakefs.fake_filesystem import FakeFilesystem
+
+import blurb
+
+
+@pytest.mark.parametrize(
+    "section, expected",
+    (
+        ("C API", "C API"),
+        ("Core and Builtins", "Core and Builtins"),
+        ("Library", "Library"),
+        ("Tools/Demos", "Tools-Demos"),
+    ),
+)
+def test_sanitize_section(section: str, expected: str) -> None:
+    sanitized = blurb.sanitize_section(section)
+    assert sanitized == expected
+
+
+@pytest.mark.parametrize(
+    "section, expected",
+    (
+        ("C API", "C API"),
+        ("Core and Builtins", "Core and Builtins"),
+        ("Library", "Library"),
+        ("Tools-Demos", "Tools/Demos"),
+    ),
+)
+def test_unsanitize_section(section: str, expected: str) -> None:
+    unsanitized = blurb.unsanitize_section(section)
+    assert unsanitized == expected
+
+
+def test_glob_blurbs_next(fs: FakeFilesystem) -> None:
+    # Arrange
+    fake_news_entries = (
+        "Misc/NEWS.d/next/Library/2022-04-11-18-34-33.gh-issue-11111.pC7gnM.rst",
+        "Misc/NEWS.d/next/Core and Builtins/2023-03-17-12-09-45.gh-issue-33333.Pf_BI7.rst",
+        "Misc/NEWS.d/next/Tools-Demos/2023-03-21-01-27-07.gh-issue-44444.2F1Byz.rst",
+        "Misc/NEWS.d/next/C API/2023-03-27-22-09-07.gh-issue-66666.3SN8Bs.rst",
+    )
+    fake_readmes = (
+        "Misc/NEWS.d/next/Library/README.rst",
+        "Misc/NEWS.d/next/Core and Builtins/README.rst",
+        "Misc/NEWS.d/next/Tools-Demos/README.rst",
+        "Misc/NEWS.d/next/C API/README.rst",
+    )
+    for fn in fake_news_entries + fake_readmes:
+        fs.create_file(fn)
+
+    # Act
+    filenames = blurb.glob_blurbs("next")
+
+    # Assert
+    assert set(filenames) == set(fake_news_entries)
+
+
+@pytest.mark.parametrize(
+    "news_entry, expected_section",
+    (
+        (
+            "Misc/NEWS.d/next/Library/2022-04-11-18-34-33.gh-issue-11111.pC7gnM.rst",
+            "Library",
+        ),
+        (
+            "Misc/NEWS.d/next/Core and Builtins/2023-03-17-12-09-45.gh-issue-33333.Pf_BI7.rst",
+            "Core and Builtins",
+        ),
+        (
+            "Misc/NEWS.d/next/Tools-Demos/2023-03-21-01-27-07.gh-issue-44444.2F1Byz.rst",
+            "Tools/Demos",
+        ),
+        (
+            "Misc/NEWS.d/next/C API/2023-03-27-22-09-07.gh-issue-66666.3SN8Bs.rst",
+            "C API",
+        ),
+    ),
+)
+def test_load_next(news_entry: str, expected_section: str, fs: FakeFilesystem) -> None:
+    # Arrange
+    fs.create_file(news_entry, contents="testing")
+    blurbs = blurb.Blurbs()
+
+    # Act
+    blurbs.load_next(news_entry)
+
+    # Assert
+    metadata = blurbs[0][0]
+    assert metadata["section"] == expected_section
+
+
+@pytest.mark.parametrize(
+    "news_entry, expected_path",
+    (
+        (
+            "Misc/NEWS.d/next/Library/2022-04-11-18-34-33.gh-issue-11111.pC7gnM.rst",
+            "root/Misc/NEWS.d/next/Library/2022-04-11-18-34-33.gh-issue-11111.pC7gnM.rst",
+        ),
+        (
+            "Misc/NEWS.d/next/Core and Builtins/2023-03-17-12-09-45.gh-issue-33333.Pf_BI7.rst",
+            "root/Misc/NEWS.d/next/Core and Builtins/2023-03-17-12-09-45.gh-issue-33333.Pf_BI7.rst",
+        ),
+        (
+            "Misc/NEWS.d/next/Tools-Demos/2023-03-21-01-27-07.gh-issue-44444.2F1Byz.rst",
+            "root/Misc/NEWS.d/next/Tools-Demos/2023-03-21-01-27-07.gh-issue-44444.2F1Byz.rst",
+        ),
+        (
+            "Misc/NEWS.d/next/C API/2023-03-27-22-09-07.gh-issue-66666.3SN8Bs.rst",
+            "root/Misc/NEWS.d/next/C API/2023-03-27-22-09-07.gh-issue-66666.3SN8Bs.rst",
+        ),
+    ),
+)
+def test_extract_next_filename(
+    news_entry: str, expected_path: str, fs: FakeFilesystem
+) -> None:
+    # Arrange
+    fs.create_file(news_entry, contents="testing")
+    blurb.root = "root"
+    blurbs = blurb.Blurbs()
+    blurbs.load_next(news_entry)
+
+    # Act
+    path = blurbs._extract_next_filename()
+
+    # Assert
+    assert path == expected_path