Configure pytest marks in a central location in pyproject.toml (#275)

Author: nathanjmcdougall

pins/tests/conftest.py

@@ -14,9 +14,6 @@
 
 PATH_TO_MANIFEST_BOARD = files("pins") / "tests/pin-board"
 
-# Based on https://github.com/machow/siuba/blob/main/siuba/tests/helpers.py
-BACKEND_MARKS = ["fs_s3", "fs_file", "fs_gcs", "fs_abfs", "fs_rsc"]
-
 # parameters that can be used more than once per session
 params_safe = [
     pytest.param(lambda: BoardBuilder("file"), id="file", marks=m.fs_file),
@@ -82,12 +79,3 @@ def tmp_data_dir():
 
 def pytest_addoption(parser):
     parser.addoption("--snapshot-update", action="store_true")
-
-
-def pytest_configure(config):
-    # TODO: better way to define all marks? Can we iterate over params above?
-    for mark_name in BACKEND_MARKS:
-        fs_name = mark_name.split("_")[-1]
-        config.addinivalue_line(
-            "markers", f"{mark_name}: mark test to only run on {fs_name} filesystem."
-        )

pyproject.toml

@@ -73,10 +73,18 @@ find = { namespaces = false }
 universal = 1
 
 [tool.pytest.ini_options]
+markers = [
+    "fs_file: mark test to only run on local filesystem",
+    "fs_s3: mark test to only run on AWS S3 bucket filesytem",
+    "fs_gcs: mark test to only run on Google Cloud Storage bucket filesystem",
+    "fs_abfs: mark test to only run on Azure Datalake filesystem",
+    "fs_rsc: mark test to only run on Posit Connect filesystem",
+    "skip_on_github: skip this test if running on GitHub",
+]
 testpaths = ["pins"]
 addopts = "--doctest-modules"
 doctest_optionflags = "NORMALIZE_WHITESPACE"
-markers = ["skip_on_github: skip this test if running on github"]
+
 [tool.ruff]
 line-length = 90
 extend-exclude = ["docs"]