Merge pull request #120 from discord-modmail/exclusive-test-env

Tests: patch os.environ to exclude tests

Author: onerandomusername

.gitignore

@@ -105,6 +105,7 @@ celerybeat.pid
 
 # Environments
 .env
+!/tests/modmail/test.env
 .venv
 env/
 venv/

tests/modmail/conftest.py

@@ -1,3 +1,8 @@
+import os
+import pathlib
+import unittest.mock
+
+import dotenv
 import pytest
 
 
@@ -12,3 +17,23 @@ def patch_embeds():
     import modmail.utils.embeds
 
     modmail.utils.embeds.patch_embed()
+
+
+def _get_env():
+    return pathlib.Path(__file__).parent / "test.env"
+
+
+def pytest_configure():
+    """Check that the test specific env file exists, and cancel the run if it does not exist."""
+    env = _get_env()
+    if not env.is_file():
+        pytest.exit(f"Testing specific {env} does not exist. Cancelling test run.", 2)
+
+
+@pytest.fixture(autouse=True, scope="package")
+def standardize_environment():
+    """Clear environment variables except for the test.env file."""
+    env = _get_env()
+    with unittest.mock.patch.dict(os.environ, clear=True):
+        dotenv.load_dotenv(env)
+        yield

tests/modmail/test.env

@@ -0,0 +1 @@
+MODMAIL_BOT_TOKEN='NjQzOTQ1MjY0ODY4MDk4MDQ5.342b.4inDLBILY69LOLfyi6jk420dpyjoEVsCoModM'