Add support for coverage 4.2.1+

Includes tests.

Fixes #1

Author: jayvdb

.gitignore

@@ -0,0 +1,44 @@
+# Files that can appear anywhere in the tree.
+*.pyc
+*.pyo
+*$py.class
+*.pyd
+*.so
+*.bak
+.coverage
+.coverage.*
+coverage.xml
+.metacov
+.metacov.*
+*.swp
+
+# Stuff generated by editors.
+.idea/
+.vimtags
+
+# Stuff in the root.
+build
+*.egg-info
+dist
+htmlcov
+MANIFEST
+setuptools-*.egg
+.tox*
+.noseids
+.cache
+.pytest_cache
+.hypothesis
+
+# Stuff in the test directory.
+zipmods.zip
+
+# Stuff in the doc directory.
+_build
+_spell
+sample_html_beta
+
+# Stuff in the ci directory.
+*.token
+
+# OS junk
+.DS_Store

.travis.yml

@@ -0,0 +1,17 @@
+dist: xenial
+language: python
+
+cache: pip
+python:
+  - '2.7'
+  - '3.4'
+  - '3.5'
+  - '3.6'
+  - '3.7'
+  - 'pypy2.7-6.0'
+  - 'pypy3.5-6.0'
+
+install:
+  - pip install tox-travis
+script:
+  - tox

CHANGELOG.md

@@ -0,0 +1,17 @@
+Changes
+-------
+
+* v0.3.0
+  - Support for coverage 4.4.2+
+  - All logic moved into PluginBase and ConfigReloadPlugin
+    which is registered as a plugin using either noop or
+    configurer plugin types.
+  - Tests for all coverage patch versions 4.0 - 5.0a,
+    CPython 2.7 and 3.4 - 3.7 and PyPy 6.0
+  - Add LICENSE to distributions
+
+* v0.2.0
+  - Python 2 support
+
+* v0.1.0
+  - Initial version

MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include tox.ini
+include tests/*.py

README.md

@@ -1,4 +1,14 @@
 # coverage config reload plugin
 
+This is a plugin for coveragepy that forces it to reload its
+configuration.  Typically this is used when the config file needs to
+be dynamic, or the environment which is used when parsing the
+config file.
+
 Place as the last plugin to be loaded, this plugin will
-reloads the configuration files after other plugins have been loaded.
+reloads the configuration files after other plugins have been loaded
+and performed their changes to the configuration file or environment.
+
+This plugin was developed as a helper for
+[coverage-env-plugin](https://github.com/jayvdb/coverage_env_plugin/),
+so it does not need worry about the internals of coveragepy.

coverage_config_reload_plugin.py

@@ -1,30 +1,137 @@
-"""Coverage Config reload Plugin"""
+"""Coverage Config reload Plugin
+
+config.from_file was broken in coveragepy 4.4.1
+https://bitbucket.org/ned/coveragepy/issues/616
+
+add_configurer was added in coveragepy 4.5, but also included
+a few easter eggs to make this plugin a tiny bit harder.
+"""
 import sys
 
-__version__ = '0.2.0'
+import coverage
+from coverage.backward import configparser
+
+__version__ = '0.3.0'
+
+
+class PluginBase(coverage.CoveragePlugin):
+
+    @classmethod
+    def _register(cls, reg, options, now=True):
+        config = get_coverage_config()
+        plugin = cls(reg, options, config, now)
+
+        # Try using coverage 4.5
+        try:
+            reg.add_configurer(plugin)
+            return plugin
+        except AttributeError:
+            pass
+
+        # Fallback to using noop added v4.0
+        try:
+            reg.add_noop(plugin)
+        except Exception:
+            reg._add_plugin(plugin, None)
+        return plugin
+
+    def __init__(self, reg, options, config=None, now=False):
+        self._name = self.__class__.__name__.lower().replace('plugin', '')
+        self.reg = reg
+        self.options = options
+        self.config = config
+        self.done = False
+        self.status = None
+        if now:
+            self.do()
+
+    def configure(self, config):
+        if isinstance(config, coverage.Coverage):
+            config = config.config
+        self.config = config
+
+        self.do()
+
+    def do(self):
+        if not self.done:
+            self._do()
+            self.done = True
+
+    def sys_info(self):
+        if not self.done:
+            try:
+                self.do()
+            except:
+                pass
+        return [(self._name,
+                 str(self.status) if self.status else str(self.done))]
+
+
+class ConfigReloadPlugin(PluginBase):
+
+    def _do(self):
+        read_config_files(self.config)
 
 
 def get_coverage_config():
     """Get coverage config from stack."""
     # Stack
     # 1. get_coverage_config (i.e. this function)
-    # 2. coverage_init
-    # 3. load_plugins
-    frame = sys._getframe(2)
+    # 2. PluginBase._register
+    # 3. coverage_init
+    # 4. load_plugins
+    frame = sys._getframe(3)
     config = frame.f_locals['config']
     return config
 
 
+def read_config_file(config, filename):
+    if filename == '.coveragerc':
+       rc_file = True
+    elif filename in ('tox.ini', 'setup.cfg'):
+       rc_file = False
+    else:
+       # Very likely all other config files are 'own rc' files.
+       # However the cost here is minimal for correctness and this
+       # reduces the chance it can be broken by future childishness :P
+       parser = configparser.RawConfigParser()
+       parser.read(filename)
+       sections = parser.sections()
+       rc_file = not any(section.startswith('coverage:')
+                         for section in sections)
+
+    # Try the old pre 4.4.1 invocation
+    try:
+        return config.from_file(
+            filename,
+            section_prefix='' if rc_file else 'coverage:'
+        )
+    except TypeError:
+        pass
+
+    # coverage 5+
+    if hasattr(config, 'config_file'):
+        config.config_file = filename
+
+    # coverage 4.4.1+
+    return config.from_file(filename, our_file=rc_file)
+
+
 def read_config_files(config):
+    if not hasattr(config, 'config_files'):
+        if config.config_file:
+            rv = read_config_file(config, config.config_file)
+            assert rv is True
+            return
+
     config_filenames = config.config_files[:]
     for filename in config_filenames:
-        prefix = '' if filename == '.coveragerc' else 'coverage:'
-        config.from_file(filename, section_prefix=prefix)
+        rv = read_config_file(config, filename)
+        assert rv is True
 
     # restore original as from_file appends to the config_files list
     config.config_files = config_filenames
 
 
 def coverage_init(reg, options):
-    config = get_coverage_config()
-    read_config_files(config)
+    ConfigReloadPlugin._register(reg, options)

setup.py

@@ -11,16 +11,17 @@
 Programming Language :: Python :: 3.4
 Programming Language :: Python :: 3.5
 Programming Language :: Python :: 3.6
+Programming Language :: Python :: 3.7
 Programming Language :: Python :: Implementation :: CPython
 Programming Language :: Python :: Implementation :: PyPy
 Topic :: Software Development :: Quality Assurance
 Topic :: Software Development :: Testing
-Development Status :: 3 - Alpha
+Development Status :: 4 - Beta
 """
 
 setup(
-    name='coverage_config_reload_plugin',
-    version='0.2.0',
+    name='coverage-config-reload-plugin',
+    version='0.3.0',
     description='coverage.py config reload plugin',
     author='John Vandenberg',
     author_email='[email protected]',
@@ -29,6 +30,8 @@
     install_requires=[
         'coverage >= 4.0',
     ],
+    tests_require=['unittest-mixins'],
+    test_suite='tests',
     license='MIT License',
     classifiers=classifiers.splitlines(),
 )

tests/__init__.py

@@ -0,0 +1,103 @@
+from distutils.version import LooseVersion
+from unittest import TestCase
+
+from unittest_mixins import TempDirMixin
+
+
+from coverage import __version__ as coverage_version
+from coverage.backward import StringIO
+from coverage.control import Coverage
+
+
+class ConfigReloadPluginTest(TempDirMixin, TestCase):
+    """Test plugin through the Coverage class."""
+
+    def test_no_reload_plugin(self):
+        debug_out = StringIO()
+        cov = Coverage(debug=['sys'])
+        cov._debug_file = debug_out
+        cov.set_option('run:plugins', [])
+        cov.start()
+        cov.stop()
+
+        out_lines = [line.strip() for line in debug_out.getvalue().splitlines()]
+        self.assertIn('plugins.file_tracers: -none-', out_lines)
+
+        expected_end = [
+            '-- end -------------------------------------------------------',
+        ]
+        self.assertEqual(expected_end, out_lines[-len(expected_end):])
+
+        if LooseVersion(coverage_version) >= LooseVersion('4.6'):
+            self.assertIn('plugins.configurers: -none-', out_lines)
+
+        assert cov.config.get_option('report:ignore_errors') is False
+
+    def test_plugin_init(self):
+        self.make_file('coveragerc_test_config', '')
+
+        debug_out = StringIO()
+        cov = Coverage(config_file='coveragerc_test_config', debug=['sys'])
+        cov._debug_file = debug_out
+        cov.set_option('run:plugins', ['coverage_config_reload_plugin'])
+        cov.start()
+        cov.stop()
+
+        out_lines = [line.strip() for line in debug_out.getvalue().splitlines()]
+        self.assertIn('plugins.file_tracers: -none-', out_lines)
+
+        expected_end = [
+            '-- sys: coverage_config_reload_plugin.ConfigReloadPlugin -----',
+            'configreload: True',
+            '-- end -------------------------------------------------------',
+        ]
+        self.assertEqual(expected_end, out_lines[-len(expected_end):])
+
+        if LooseVersion(coverage_version) >= LooseVersion('4.6'):
+            self.assertIn('plugins.configurers: coverage_config_reload_plugin.ConfigReloadPlugin', out_lines)
+
+    def _check_config(self, filename, own_rc):
+        section = 'report' if own_rc else 'coverage:report'
+
+        # Force own rc for pre 4.4.1
+        if LooseVersion(coverage_version) < LooseVersion('4.4.1'):
+            self.make_file(filename, """\
+                [report]
+                ignore_errors = true
+                """)
+        else:
+            self.make_file(filename, """\
+                [{}]
+                ignore_errors = true
+                """.format(section))
+
+        debug_out = StringIO()
+        cov = Coverage(config_file=filename, debug=['sys'])
+        assert cov.config.get_option('report:ignore_errors') is True
+        cov._debug_file = debug_out
+
+        self.make_file(filename, """\
+            [{}]
+            ignore_errors = off
+            """.format(section))
+
+        cov.set_option('run:plugins', ['coverage_config_reload_plugin'])
+        cov.start()
+        cov.stop()
+
+        assert cov.config.get_option('report:ignore_errors') is False
+
+    def test_reload_config_rc(self):
+        self._check_config('coveragerc_test_config', True)
+
+    def test_reload_config_not_rc(self):
+        self._check_config('coveragerc_test_config', False)
+
+    def test_reload_config_toxini(self):
+        self._check_config('tox.ini', False)
+
+    def test_reload_config_setupcfg(self):
+        self._check_config('setup.cfg', False)
+
+    def test_reload_config_coveragerc(self):
+        self._check_config('.coveragerc', True)