Merge ~cjwatson/lazr.delegates:rhinectomy into lazr.delegates: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.

Coverage currently appears fairly terrible, but will improve dramatically once we drop Python 2 support. I could have done Python 2 and 3 runs and combined the coverage output, but it didn't seem worth the complexity when we're likely to be dropping Python 2 support from here soon anyway.

Pre-empting an obvious question: I don't necessarily object to using the `pytest` runner instead, but I thought it better to start by using the same thing as most other lazr.* projects, and we can consider switching them all over in one go later.

Python 2.6 support was already dropped in 2015, but apparently accidentally not removed from `setup.py`, and since I needed to adjust how tests are skipped as part of this work in a way that definitely wouldn't work with Python 2.6 I took the opportunity to update that.

[Jürgen Gmach (jugmac00)]

LGTM

We can drop the very old Python 3 version in another MP.

I have created a MP based on yours with combined coverage - I never did that before, but I thought it would be fun to try out.

I will propose it once your's have landed.

review: Approve

[Jürgen Gmach (jugmac00)]

As you said, the coverage looks much better when combined.

Name Stmts Miss Cover Missing
------------------------------------------------------------------------
lazr/delegates/__init__.py 11 0 100%
lazr/delegates/_delegates.py 32 0 100%
lazr/delegates/_passthrough.py 22 0 100%
lazr/delegates/_python2.py 18 0 100%
lazr/delegates/_python3.py 15 0 100%
lazr/delegates/_version.py 1 0 100%
lazr/delegates/docs/__init__.py 0 0 100%
lazr/delegates/tests/__init__.py 0 0 100%
lazr/delegates/tests/test_api.py 12 3 75% 30-31, 35
lazr/delegates/tests/test_docs.py 19 0 100%
lazr/delegates/tests/test_passthrough.py 46 0 100%
lazr/delegates/tests/test_python2.py 94 4 96% 105, 154-155, 159
------------------------------------------------------------------------
TOTAL 270 7 97%

Missing % in test files usually is a sign of a bogus test setup. I think we should have a look once we drop Python 2.

[Colin Watson (cjwatson)]

Some of these are "else fail" kind of constructs, where I think "# pragma: no cover" would be suitable. But yes, let's check after dropping Python 2.

FYI you can propose MPs based on unlanded ones without having to wait for them to land, by using the "prerequisite branch" facility (this doesn't exist on GitHub so you may not be familiar with it). Though as I mentioned I wonder whether combined coverage is worth the complexity when we'll be dropping Python 2 support anyway?

[Jürgen Gmach (jugmac00)]

Thanks for the info about "MPs on unlanded ones" - this was indeed new.

I know it would not have been necessary to combine coverage, but as I never did that before, this was a nice fun "project" for the weekend.

Though it turned out it is not that complicated - once you know how it works :-)

This "knowledge" could come handy when we have to combine the coverage results for different Python 3 versions (I look at you Python 3.10 :-) ).

see https://code.launchpad.net/~jugmac00/lazr.delegates/+git/lazr.delegates/+merge/412213

diff --git a/.gitignore b/.gitignore
index daeb903..16ba64f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,6 +11,7 @@ build
 dist
 __pycache__
 .coverage
+htmlcov
 .tox
 *.pyc
 lazr/delegates/docs/_build
diff --git a/NEWS.rst b/NEWS.rst
index 731cf96..476c1d4 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -5,6 +5,7 @@ NEWS for lazr.delegates
 2.0.5
 =====
 - Officially add support for Python 3.6, 3.7, and 3.8.
+- Test using ``zope.testrunner`` rather than ``nose``.
 
 
 2.0.4 (2017-10-20)
diff --git a/lazr/delegates/docs/fixture.py b/lazr/delegates/docs/fixture.py
deleted file mode 100644
index 1d4aced..0000000
--- a/lazr/delegates/docs/fixture.py
+++ /dev/null
@@ -1,34 +0,0 @@
-# Copyright 2009-2015 Canonical Ltd.  All rights reserved.
-#
-# This file is part of lazr.delegates
-#
-# lazr.delegates 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.delegates 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.delegates.  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/lazr/delegates/docs/usage_fixture.py b/lazr/delegates/docs/usage_fixture.py
deleted file mode 100644
index 7012cf7..0000000
--- a/lazr/delegates/docs/usage_fixture.py
+++ /dev/null
@@ -1,27 +0,0 @@
-# Copyright 2009-2015 Canonical Ltd.  All rights reserved.
-#
-# This file is part of lazr.delegates
-#
-# lazr.delegates 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.delegates 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.delegates.  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.delegates.docs.fixture import globs
diff --git a/lazr/delegates/tests/test_docs.py b/lazr/delegates/tests/test_docs.py
new file mode 100644
index 0000000..7ca6971
--- /dev/null
+++ b/lazr/delegates/tests/test_docs.py
@@ -0,0 +1,67 @@
+# Copyright 2009-2021 Canonical Ltd.  All rights reserved.
+#
+# This file is part of lazr.delegates.
+#
+# lazr.delegates 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.delegates 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.delegates.  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.delegates", "docs"):
+        for name in resource_listdir("lazr.delegates", "docs"):
+            if name.endswith(".rst"):
+                doctest_files.append(
+                    os.path.abspath(
+                        resource_filename("lazr.delegates", "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/lazr/delegates/tests/test_python2.py b/lazr/delegates/tests/test_python2.py
index 1cc873b..ad3de7e 100644
--- a/lazr/delegates/tests/test_python2.py
+++ b/lazr/delegates/tests/test_python2.py
@@ -63,14 +63,7 @@ class BaseOtherFoo(BaseFoo):
     another = 'yes, another'
 
 
-# Python 2.6 doesn't have skips.
-def skip_python3(cls):
-    if sys.version_info[0] > 2:
-        return None
-    return cls
-
-
-@skip_python3
[e-mail](sys.version_info[0] > 2, "only relevant in Python 2")
 class TestLegacyAPI(unittest.TestCase):
     def test_basic_usage(self):
         class SomeClass(object):
@@ -146,7 +139,7 @@ class TestLegacyAPI(unittest.TestCase):
         self.assertTrue(IOther.providedBy(foo_with_teapot))
 
 
-@skip_python3
[e-mail](sys.version_info[0] > 2, "only relevant in Python 2")
 class TestNewAPI(unittest.TestCase):
     """Test corner cases in Python 2.
 
diff --git a/setup.cfg b/setup.cfg
deleted file mode 100644
index 0af9456..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.delegates
-pdb=1
diff --git a/setup.py b/setup.py
index f0fe050..f8b5b24 100755
--- a/setup.py
+++ b/setup.py
@@ -37,7 +37,6 @@ delegating behavior.
 """,
     license='LGPL v3',
     install_requires=[
-        'nose',
         'setuptools',
         'zope.interface',
         ],
@@ -50,7 +49,6 @@ delegating behavior.
         "Operating System :: OS Independent",
         'Programming Language :: Python',
         'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.6',
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.2',
@@ -64,8 +62,4 @@ delegating behavior.
         extras_require={
             "docs": ["Sphinx"],
         },
-    # nose plugins don't really work with `python setup.py test` so use
-    # `python setup.py nosetests` instead, or just `tox`.  Gosh, we really
-    # should switch to nose2. :/  - BAW 2014-08-20
-    #test_suite='nose.collector',
     )
diff --git a/tox.ini b/tox.ini
index 76a9117..f30fd94 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,8 +1,21 @@
 [tox]
-envlist = py27,py32,py33,py34,py35,py36,py37,py38
+envlist =
+    py27
+    py32
+    py33
+    py34
+    py35
+    py36
+    py37
+    py38
+    coverage
 
 [testenv]
-commands = python setup.py nosetests
+deps =
+    .
+    zope.testrunner
+commands =
+    zope-testrunner --test-path . --tests-pattern ^tests {posargs}
 
 [testenv:docs]
 basepython =
@@ -11,3 +24,19 @@ commands =
     sphinx-build -b html -d lazr/delegates/docs/_build/doctrees lazr/delegates/docs lazr/delegates/docs/_build/html
 deps =
     .[docs]
+
+[testenv:coverage]
+basepython =
+    python3
+deps =
+    coverage
+    zope.testrunner
+commands =
+    coverage erase
+    coverage run -m zope.testrunner --test-path . --tests-pattern ^tests {posargs}
+    coverage html
+    coverage report -m --fail-under=56
+
+[coverage:run]
+source = lazr.delegates
+omit = */docs/conf.py