Merge ~cjwatson/lazr.config:rhinectomy into lazr.config:main

[Colin Watson]

Test using zope.testrunner rather than nose

`nose` is unmaintained and doesn't work with Python 3.10. There's `nose2`, but using `zope.testrunner` brings this more into line with other lazr.* projects.

[Jürgen Gmach (jugmac00)]

Ok, I had to google rhinectomy but I still laughed :)

Hm, coverage is failing for me as 1% is missing. I am pretty sure you ran it, maybe we run a different Python version for coverage? 3.8.10 for me.

Could you please lower the minimum required coverage?

Thank you.

review: Needs Fixing

[Jürgen Gmach (jugmac00)]

$ tox -e coverage
GLOB sdist-make: /home/jugmac00/Projects/lazr.config/setup.py
coverage inst-nodeps: /home/jugmac00/Projects/lazr.config/.tox/.tmp/package/1/lazr.config-2.2.3.zip
coverage installed: coverage==6.1.2,lazr.config @ file:///home/jugmac00/Projects/lazr.config/.tox/.tmp/package/1/lazr.config-2.2.3.zip,lazr.delegates==2.0.4,nose==1.3.7,six==1.16.0,zope.exceptions==4.4,zope.interface==5.4.0,zope.testrunner==5.4.0
coverage run-test-pre: PYTHONHASHSEED='3527834898'
coverage run-test: commands[0] | python --version
Python 3.8.10
coverage run-test: commands[1] | coverage erase
coverage run-test: commands[2] | coverage run -m zope.testrunner --test-path src --tests-pattern '^tests'
Running zope.testrunner.layer.UnitTests tests:
  Set up zope.testrunner.layer.UnitTests in 0.000 seconds.
  Ran 24 tests with 0 failures, 0 errors and 0 skipped in 0.049 seconds.
Tearing down left over layers:
  Tear down zope.testrunner.layer.UnitTests in 0.000 seconds.
coverage run-test: commands[3] | coverage html
Wrote HTML report to htmlcov/index.html
coverage run-test: commands[4] | coverage report -m --fail-under=97
Name Stmts Miss Cover Missing
----------------------------------------------------------------------------------------------------------------
.tox/coverage/lib/python3.8/site-packages/lazr/config/__init__.py 5 0 100%
.tox/coverage/lib/python3.8/site-packages/lazr/config/_config.py 444 12 97% 55-61, 416, 560, 629, 684, 838, 841, 850
.tox/coverage/lib/python3.8/site-packages/lazr/config/_version.py 1 0 100%
.tox/coverage/lib/python3.8/site-packages/lazr/config/docs/__init__.py 0 0 100%
.tox/coverage/lib/python3.8/site-packages/lazr/config/interfaces.py 52 0 100%
.tox/coverage/lib/python3.8/site-packages/lazr/config/tests/__init__.py 0 0 100%
.tox/coverage/lib/python3.8/site-packages/lazr/config/tests/test_config.py 123 11 91% 31-33, 36-38, 154, 163-165, 172, 176-178
.tox/coverage/lib/python3.8/site-packages/lazr/config/tests/test_docs.py 19 0 100%
.tox/coverage/lib/python3.8/site-packages/lazr/config/tests/testdata/__init__.py 0 0 100%
----------------------------------------------------------------------------------------------------------------
TOTAL 644 23 96%
Coverage failure: total of 96 is less than fail-under=97
ERROR: InvocationError for command /home/jugmac00/Projects/lazr.config/.tox/coverage/bin/coverage report -m --fail-under=97 (exited with code 2)
_________________________________________________________________________________ summary _________________________________________________________________________________
ERROR: coverage: commands failed

[Colin Watson (cjwatson)]

The difference is that src/lazr/config/_config.py:560 is covered when I run the tests but apparently not for you. I'm not quite sure why that would be, but regardless, I've lowered the required percentage slightly for now.

[Jürgen Gmach (jugmac00)]

Thanks! Not going down this rabbit hole :-)

review: Approve

diff --git a/.coverage b/.coverage
deleted file mode 100644
index 33846df..0000000
Binary files a/.coverage and /dev/null differ
diff --git a/.gitignore b/.gitignore
index cff4a80..2964eac 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,4 +12,5 @@ dist
 .tox
 __pycache__
 .coverage
+htmlcov
 src/lazr/config/docs/_build
diff --git a/NEWS.rst b/NEWS.rst
index 58e26ba..d7a814b 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -7,6 +7,7 @@ NEWS for lazr.config
 - Add basic pre-commit configuration.
 - Publish Documentation on Read the Docs.
 - Apply inclusive naming via the woke pre-commit hook.
+- Test using ``zope.testrunner`` rather than ``nose``.
 
 2.2.3 (2021-01-26)
 ==================
diff --git a/setup.cfg b/setup.cfg
deleted file mode 100644
index c7266bb..0000000
--- a/setup.cfg
+++ /dev/null
@@ -1,9 +0,0 @@
-[nosetests]
-verbosity=3
-with-coverage=1
-with-doctest=1
-doctest-extension=.rst
-doctest-options=+ELLIPSIS,+NORMALIZE_WHITESPACE,+REPORT_NDIFF
-doctest-fixtures=_fixture
-cover-package=lazr.config
-pdb=1
diff --git a/src/lazr/config/docs/fixture.py b/src/lazr/config/docs/fixture.py
deleted file mode 100644
index c1e3c1e..0000000
--- a/src/lazr/config/docs/fixture.py
+++ /dev/null
@@ -1,34 +0,0 @@
-# Copyright 2009-2015 Canonical Ltd.  All rights reserved.
-#
-# This file is part of lazr.smtptest
-#
-# lazr.smtptest is free software: you can redistribute it and/or modify it
-# under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, version 3 of the License.
-#
-# lazr.smtptest is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
-# License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with lazr.smtptest.  If not, see <http://www.gnu.org/licenses/>.
-
-"""Doctest fixtures for running under nose."""
-
-from __future__ import absolute_import, print_function, unicode_literals
-
-__metaclass__ = type
-__all__ = [
-    'globs',
-    ]
-
-
-def globs(globs):
-    """Set up globals for doctests."""
-    # Enable future statements to make Python 2 act more like Python 3.
-    globs['absolute_import'] = absolute_import
-    globs['print_function'] = print_function
-    globs['unicode_literals'] = unicode_literals
-    # Provide a convenient way to clean things up at the end of the test.
-    return globs
diff --git a/src/lazr/config/docs/usage_fixture.py b/src/lazr/config/docs/usage_fixture.py
deleted file mode 100644
index 280d5c9..0000000
--- a/src/lazr/config/docs/usage_fixture.py
+++ /dev/null
@@ -1,27 +0,0 @@
-# Copyright 2009-2015 Canonical Ltd.  All rights reserved.
-#
-# This file is part of lazr.smtptest
-#
-# lazr.smtptest is free software: you can redistribute it and/or modify it
-# under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, version 3 of the License.
-#
-# lazr.smtptest is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
-# License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with lazr.smtptest.  If not, see <http://www.gnu.org/licenses/>.
-
-"""Doctest fixtures for running under nose."""
-
-from __future__ import absolute_import, print_function, unicode_literals
-
-__metaclass__ = type
-__all__ = [
-    'globs',
-    ]
-
-
-from lazr.config.docs.fixture import globs
diff --git a/src/lazr/config/tests/test_docs.py b/src/lazr/config/tests/test_docs.py
new file mode 100644
index 0000000..eb44411
--- /dev/null
+++ b/src/lazr/config/tests/test_docs.py
@@ -0,0 +1,67 @@
+# Copyright 2009-2021 Canonical Ltd.  All rights reserved.
+#
+# This file is part of lazr.config.
+#
+# lazr.config is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, version 3 of the License.
+#
+# lazr.config is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with lazr.config.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Test harness for doctests."""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+__metaclass__ = type
+__all__ = []
+
+import atexit
+import doctest
+import os
+
+from pkg_resources import (
+    resource_filename,
+    resource_exists,
+    resource_listdir,
+    cleanup_resources,
+)
+
+
+DOCTEST_FLAGS = (
+    doctest.ELLIPSIS | doctest.NORMALIZE_WHITESPACE | doctest.REPORT_NDIFF
+)
+
+
+def load_tests(loader, tests, pattern):
+    """Load the doc tests (docs/*, if any exist)."""
+    doctest_files = []
+    if resource_exists("lazr.config", "docs"):
+        for name in resource_listdir("lazr.config", "docs"):
+            if name.endswith(".rst"):
+                doctest_files.append(
+                    os.path.abspath(
+                        resource_filename("lazr.config", "docs/%s" % name)
+                    )
+                )
+    atexit.register(cleanup_resources)
+    globs = {
+        "absolute_import": absolute_import,
+        "print_function": print_function,
+        "unicode_literals": unicode_literals,
+    }
+    tests.addTest(
+        doctest.DocFileSuite(
+            *doctest_files,
+            module_relative=False,
+            optionflags=DOCTEST_FLAGS,
+            globs=globs,
+            encoding="UTF-8"
+        )
+    )
+    return tests
diff --git a/tox.ini b/tox.ini
index c6ab782..24f5373 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,13 +1,19 @@
 [tox]
-envlist = py27,py34,py35,py36,py37,py38
+envlist =
+    py27
+    py34
+    py35
+    py36
+    py37
+    py38
+    coverage
 skip_missing_interpreters = True
 
-
 [testenv]
-commands = python -s -m nose -P lazr
 deps =
-     nose
-     coverage
+    zope.testrunner
+commands =
+    zope-testrunner --test-path src --tests-pattern ^tests {posargs}
 
 [testenv:pre-commit]
 commands =
@@ -32,3 +38,19 @@ commands =
     sphinx-build -b html -d src/lazr/config/docs/_build/doctrees src/lazr/config/docs src/lazr/config/docs/_build/html
 deps =
     .[docs]
+
+[testenv:coverage]
+basepython =
+    python3
+deps =
+    coverage
+    zope.testrunner
+commands =
+    coverage erase
+    coverage run -m zope.testrunner --test-path src --tests-pattern ^tests {posargs}
+    coverage html
+    coverage report -m  --fail-under=96
+
+[coverage:run]
+source = lazr.config
+omit = */docs/conf.py