Merge pull request #160 from boutproject/configure-installed-tests

Set options in conftest.py instead of pytest.ini, install conftest.py

Author: johnomotani

conftest.py

@@ -1,21 +1,5 @@
-import pytest
-
-
-# Add command line option '--long' for pytest, to be used to enable long tests
-def pytest_addoption(parser):
-    parser.addoption(
-        "--long",
-        action="store_true",
-        default=False,
-        help="enable tests marked as 'long'",
-    )
-
-
-def pytest_collection_modifyitems(config, items):
-    if not config.getoption("--long"):
-        # --long not given in cli: skip long tests
-        print("\n    skipping long tests, pass '--long' to enable")
-        skip_long = pytest.mark.skip(reason="need --long option to run")
-        for item in items:
-            if "long" in item.keywords:
-                item.add_marker(skip_long)
+from xbout.conftest import (
+    pytest_configure,
+    pytest_addoption,
+    pytest_collection_modifyitems,
+)

setup.cfg

@@ -50,9 +50,6 @@ calc =
     xhistogram
 docs = sphinx >= 1.4
 
-[options.package_data]
-xbout = tests/pytest.ini
-
 [build_sphinx]
 project = $metadata.name
 version = $metadata.version

xbout/conftest.py

@@ -0,0 +1,73 @@
+import pytest
+
+
+configure_is_imported = False
+
+
+def pytest_configure(config):
+    global configure_is_imported
+    if not configure_is_imported:
+        configure_is_imported = True
+        # filter expected warnings
+        config.addinivalue_line(
+            "filterwarnings",
+            "ignore:No geometry type found, no coordinates will be added:UserWarning",
+        )
+        config.addinivalue_line(
+            "filterwarnings",
+            "ignore:deallocating CachingFileManager.*, but file is not already closed. "
+            "This may indicate a bug.:RuntimeWarning",
+        )
+
+        # register additional markers
+        config.addinivalue_line(
+            "markers",
+            "long: long test, or one of many permutations (disabled by default)",
+        )
+        config.addinivalue_line(
+            "markers",
+            "flaky: xarray uses this mark, adding to avoid warnings about it not being "
+            "defined",
+        )
+        config.addinivalue_line(
+            "markers",
+            "network: xarray uses this mark, adding to avoid warnings about it not "
+            "being defined",
+        )
+        config.addinivalue_line(
+            "markers",
+            "slow: xarray uses this mark, adding to avoid warnings about it not being "
+            "defined",
+        )
+
+
+addoption_is_imported = False
+
+
+def pytest_addoption(parser):
+    # Add command line option '--long' for pytest, to be used to enable long tests
+    global addoption_is_imported
+    if not addoption_is_imported:
+        addoption_is_imported = True
+        parser.addoption(
+            "--long",
+            action="store_true",
+            default=False,
+            help="enable tests marked as 'long'",
+        )
+
+
+collection_is_imported = False
+
+
+def pytest_collection_modifyitems(config, items):
+    global collection_is_imported
+    if not collection_is_imported:
+        collection_is_imported = True
+        if not config.getoption("--long"):
+            # --long not given in cli: skip long tests
+            print("\n    skipping long tests, pass '--long' to enable")
+            skip_long = pytest.mark.skip(reason="need --long option to run")
+            for item in items:
+                if "long" in item.keywords:
+                    item.add_marker(skip_long)