Replace nose with pytest

.github/CODEOWNERS

@@ -23,8 +23,7 @@
 /corehq/sql_db/ @snopoke @calellowitz
 /corehq/sql_proxy_accessors/ @snopoke
 /corehq/sql_proxy_standby_accessors/ @snopoke
-/corehq/tests/nose.py @millerdev
-/corehq/tests/noseplugins/ @millerdev
+/corehq/tests/ @millerdev
 /corehq/util/couch.py @esoergel
 /corehq/util/couch_helpers.py @millerdev
 /corehq/util/datadog/lockmeter.py @millerdev

.pytest.ini

@@ -0,0 +1,22 @@
+[pytest]
+minversion = 8.1
+
+addopts =
+    --strict-markers
+    -pcorehq.tests.pytest_hooks
+    # HQ has its own (incompatible) warnings system
+    -pno:warnings
+
+empty_parameter_set_mark = xfail
+xfail_strict = true
+
+norecursedirs =
+    docker
+    node_modules
+    staticfiles
+
+pythonpath =
+    .
+
+required_plugins = pytest-django
+DJANGO_SETTINGS_MODULE = testsettings

corehq/apps/es/transient_util.py

@@ -88,7 +88,6 @@ def populate_doc_adapter_map():
         from pillowtop.tests.utils import TEST_ES_TYPE, TEST_ES_MAPPING, TEST_ES_INDEX
         add_dynamic_adapter("PillowTop", TEST_ES_INDEX, TEST_ES_TYPE, TEST_ES_MAPPING)
 
-        import corehq.tests.pytest_compat  # noqa: F401 - to be removed after switch to pytest
         from corehq.apps.es.tests.utils import TEST_ES_INFO, TEST_ES_MAPPING
         add_dynamic_adapter("UtilES", TEST_ES_INFO.alias, TEST_ES_INFO.type,
                         TEST_ES_MAPPING)

corehq/tests/nosecompat.py

@@ -0,0 +1,13 @@
+import sys
+
+from .tools import nottest as nottest_tool
+
+
+def create_nose_virtual_package():
+    sys.modules['nose.tools'] = VirtualNose.tools
+
+
+class VirtualNose:
+    """Legacy namespace for tests written before pytest"""
+    class tools:
+        nottest = nottest_tool

corehq/tests/noseplugins/__init__.py

@@ -1 +0,0 @@
-import corehq.tests.pytest_compat  # noqa: F401

corehq/tests/pytest_hooks.py

@@ -0,0 +1,41 @@
+import os
+
+import pytest
+
+
+@pytest.hookimpl(tryfirst=True)
+def pytest_load_initial_conftests():
+    assert not hasattr(pytest_load_initial_conftests, 'loaded'), "Already loaded"
+    pytest_load_initial_conftests.loaded = True
+    os.environ.setdefault('CCHQ_TESTING', '1')
+
+    from manage import init_hq_python_path, run_patches
+    init_hq_python_path()
+    run_patches()
+
+    from corehq.warnings import configure_warnings
+    configure_warnings(is_testing=True)
+
+    from .nosecompat import create_nose_virtual_package
+    create_nose_virtual_package()
+
+
+def pytest_pycollect_makeitem(collector, name, obj):
+    """Fail on common mistake that results in masked tests"""
+    if (
+        "Test" in name
+        and not isinstance(obj, type)
+        and isinstance(wrapped := _get_wrapped(obj), type)
+        and any(n.startswith("test_") for n in dir(wrapped))
+    ):
+        return pytest.fail(
+            f"{obj.__module__}.{name} appears to be a test class that has "
+            "been wrapped with a decorator that masks its tests."
+        )
+    return None
+
+
+def _get_wrapped(obj):
+    while hasattr(obj, "__wrapped__"):
+        obj = obj.__wrapped__
+    return obj

corehq/warnings.py

@@ -21,13 +21,9 @@
     # warnings that may be resolved with a library upgrade
     ("bs4.builder", "option of HTMLParser() has never done anything"),
     ("couchdbkit.schema.properties", "'collections.abc'"),
-    ("ddtrace.internal.module", "the imp module is deprecated"),
+    ("ddtrace.internal.module", "pkg_resources is deprecated as an API"),
     ("eulxml", "pkg_resources is deprecated as an API"),
-    ("nose.importer", "the imp module is deprecated"),
-    ("nose.util", "inspect.getargspec() is deprecated"),
     ("pkg_resources", "pkg_resources.declare_namespace"),
-    ("nose.suite", "'collections.abc'"),
-    ("nose.plugins.collect", "'collections.abc'"),
     ("", "", RemovedInDjango50Warning),
     ("", "", RemovedInDjango51Warning),
 
@@ -54,8 +50,6 @@
         "elasticsearch6.connection.http_urllib3",
         "HTTPResponse.getheaders() is deprecated and will be removed in urllib3 v2.1.0."
     ),
-    # Should be removed when Nose is updated
-    ("nose.plugins.manager", "pkg_resources is deprecated as an API."),
 
     # other, resolution not obvious
     ("IPython.core.interactiveshell", "install IPython inside the virtualenv.", UserWarning),
@@ -72,7 +66,7 @@
 ]
 
 
-def configure_warnings(is_testing):
+def configure_warnings(is_testing=False):
     strict = is_testing or os.environ.get("CCHQ_STRICT_WARNINGS")
     if strict:
         augment_warning_messages()

manage.py

@@ -8,6 +8,9 @@
 
 
 def main():
+    if len(sys.argv) > 1 and sys.argv[1] == 'test':
+        sys.exit("pytest is used to run HQ tests. See 'pytest --help' for options")
+
     # important to apply gevent monkey patches before running any other code
     # applying this later can lead to inconsistencies and threading issues
     # but compressor doesn't like it
@@ -40,10 +43,9 @@ def main():
     run_patches()
 
     from corehq.warnings import configure_warnings
-    configure_warnings(is_testing(sys.argv))
+    configure_warnings()
 
     set_default_settings_path(sys.argv)
-    set_nosetests_verbosity(sys.argv)
     from django.core.management import execute_from_command_line
     execute_from_command_line(sys.argv)
 
@@ -159,51 +161,12 @@ def unpatch_sys_modules():
 
 
 def set_default_settings_path(argv):
-    if is_testing(argv):
-        os.environ.setdefault('CCHQ_TESTING', '1')
+    if os.environ.get('CCHQ_TESTING') == '1':
         module = 'testsettings'
     else:
         module = 'settings'
     os.environ.setdefault("DJANGO_SETTINGS_MODULE", module)
 
 
-def is_testing(argv):
-    return len(argv) > 1 and argv[1] == 'test' or os.environ.get('CCHQ_TESTING') == '1'
-
-
-def set_nosetests_verbosity(argv):
-    """Increase nose output verbosity with -v... argument
-
-        -v: print test names
-        -vv: do not capture stdout
-        -vvv: do not capture logging
-        -vvvv: enable nose internal logging
-    """
-    import logging
-
-    def set_verbosity(arg, i):
-        args = []
-        verbosity = sum(1 for c in arg if c == "v") + 1
-        if len(arg) > verbosity:
-            # preserve other single-letter arguments (ex: -xv)
-            args.append("".join(c for c in arg if c != "v"))
-        if verbosity > 2:
-            args.append("--nocapture")
-        if verbosity > 3:
-            verbosity -= 1
-            args.append("--nologcapture")
-            logging.basicConfig(level=logging.NOTSET)
-            logging.getLogger().info(
-                "Adjust logging with testsettings._set_logging_levels")
-        args.append("--nose-verbosity=%s" % verbosity)
-        argv[i:i + 1] = args
-
-    if len(argv) > 1 and argv[1] == 'test':
-        for i, arg in reversed(list(enumerate(argv))):
-            if arg[:1] == "-" and arg[1] != "-" and any(c == 'v' for c in arg):
-                set_verbosity(arg, i)
-                break
-
-
 if __name__ == "__main__":
     main()

requirements/test-requirements.in

@@ -1,9 +1,6 @@
 -r requirements.in
 
-django-nose @ https://github.com/dimagi/django-nose/raw/fast-first-1.4.6.1/releases/django_nose-1.4.6.1-py2.py3-none-any.whl
 fakecouch
-nose
-nose-exclude
 pip-tools>=6.8.0
 testil
 requests-mock
@@ -12,5 +9,9 @@ Faker
 flaky
 freezegun
 radon>=5.0  # v5 no longer depends on flake8-polyfill
+# pytest is pinned to a git commit until 8.4 is released.
+# `minversion = 8.4` should also be set in .pytest.ini at that time.
+pytest @ git+https://github.com/pytest-dev/pytest.git@85760bff2776989b365167c7aeb35c86308ab76b
+pytest-django
 coverage
 uWSGI

testsettings.py

@@ -2,7 +2,8 @@
 from warnings import filterwarnings
 
 import settingshelper as helper
-from settings import *  # noqa: F403
+assert helper.is_testing(), 'test mode is required before importing settings'
+from settings import *  # noqa: E402, F403
 
 # Commenting out temporarily for tests
 # if os.environ.get('ELASTICSEARCH_MAJOR_VERSION'):
@@ -53,45 +54,12 @@
 # it can be reverted whenever that's figured out.
 # https://github.com/dimagi/commcare-hq/pull/10034#issuecomment-174868270
 INSTALLED_APPS = (
-    'django_nose',
     'testapps.test_elasticsearch',
     'testapps.test_pillowtop',
 ) + tuple(INSTALLED_APPS)  # noqa: F405
 
-TEST_RUNNER = 'django_nose.BasicNoseRunner'
-NOSE_ARGS = [
-    #'--no-migrations' # trim ~120s from test run with db tests
-    #'--with-fixture-bundling',
-]
-NOSE_PLUGINS = [
-    'corehq.tests.nose.HqTestFinderPlugin',
-    'corehq.tests.noseplugins.classcleanup.ClassCleanupPlugin',
-    'corehq.tests.noseplugins.dbtransaction.DatabaseTransactionPlugin',
-    'corehq.tests.noseplugins.dividedwerun.DividedWeRunPlugin',
-    'corehq.tests.noseplugins.djangomigrations.DjangoMigrationsPlugin',
-    'corehq.tests.noseplugins.cmdline_params.CmdLineParametersPlugin',
-    'corehq.tests.noseplugins.patches.PatchesPlugin',
-    'corehq.tests.noseplugins.redislocks.RedisLockTimeoutPlugin',
-    'corehq.tests.noseplugins.uniformresult.UniformTestResultPlugin',
-
-    # The following are not enabled by default
-    'corehq.tests.noseplugins.logfile.LogFilePlugin',
-    'corehq.tests.noseplugins.timing.TimingPlugin',
-    'corehq.tests.noseplugins.output.OutputPlugin',
-    'corehq.tests.noseplugins.elasticsnitch.ElasticSnitchPlugin',
-
-    # Uncomment to debug tests. Plugins have nice hooks for inspecting state
-    # before/after each test or context setup/teardown, etc.
-    #'corehq.tests.noseplugins.debug.DebugPlugin',
-]
-
 # these settings can be overridden with environment variables
 for key, value in {
-    'NOSE_DB_TEST_CONTEXT': 'corehq.tests.nose.HqdbContext',
-    'NOSE_NON_DB_TEST_CONTEXT': 'corehq.tests.nose.ErrorOnDbAccessContext',
-    'NOSE_IGNORE_FILES': '^localsettings',
-    'NOSE_EXCLUDE_DIRS': 'scripts',
-
     'DD_DOGSTATSD_DISABLE': 'true',
     'DD_TRACE_ENABLED': 'false',
 }.items():
@@ -146,7 +114,6 @@ def _set_logging_levels(levels):
     'urllib3': 'WARNING',
 })
 
-# use empty LOGGING dict with --debug=nose,nose.plugins to debug test discovery
 # TODO empty logging config (and fix revealed deprecation warnings)
 LOGGING = {
     'disable_existing_loggers': False,