fix: don't find HTML report as templates

Author: nedbat

README.rst

@@ -138,6 +138,9 @@ reading during the reporting phase, ending execution.  This failure is now
 raised in a way that can be ignored with a .coveragerc setting of ``[report]
 ignore_errors=True`` (`issue 78`_).
 
+When using ``source=.``, an existing coverage HTML report directory would be
+found and believed to be unmeasured HTML template files.  This is now fixed.
+
 .. _issue 78: https://github.com/nedbat/django_coverage_plugin/issues/78
 
 

django_coverage_plugin/__init__.py

@@ -8,4 +8,6 @@
 
 
 def coverage_init(reg, options):
-    reg.add_file_tracer(DjangoTemplatePlugin(options))
+    plugin = DjangoTemplatePlugin(options)
+    reg.add_file_tracer(plugin)
+    reg.add_configurer(plugin)

django_coverage_plugin/plugin.py

@@ -184,6 +184,9 @@ def sys_info(self):
             )),
         ]
 
+    def configure(self, config):
+        self.html_report_dir = os.path.abspath(config.get_option("html:directory"))
+
     def file_tracer(self, filename):
         if os.path.normcase(filename).startswith(self.django_template_dir):
             if not self.debug_checked:
@@ -204,6 +207,9 @@ def find_executable_files(self, src_dir):
         rx = r"^[^.#~!$@%^&*()+=,]+\.(" + "|".join(self.extensions) + r")$"
 
         for (dirpath, dirnames, filenames) in os.walk(src_dir):
+            if dirpath == self.html_report_dir:
+                # Don't confuse the HTML report with HTML templates.
+                continue
             for filename in filenames:
                 if re.search(rx, filename):
                     yield os.path.join(dirpath, filename)

tests/test_source.py

@@ -134,3 +134,41 @@ def test_non_utf8_ignored(self):
         self.assert_measured_files("main.html", "static{}changelog.txt".format(os.sep))
         self.assert_analysis([1], name="main.html")
         self.cov.html_report()
+
+    def test_htmlcov_isnt_measured(self):
+        # We used to find the HTML report and think it was template files.
+        self.make_file(".coveragerc", """\
+            [run]
+            plugins = django_coverage_plugin
+            source = .
+            """)
+        self.make_template(name="main.html", text="Hello")
+        text = self.run_django_coverage(name="main.html")
+        self.assertEqual(text, "Hello")
+
+        self.assert_measured_files("main.html")
+        self.cov.html_report()
+
+        # Run coverage again with an HTML report on disk.
+        text = self.run_django_coverage(name="main.html")
+        self.assert_measured_files("main.html")
+
+    def test_custom_html_report_isnt_measured(self):
+        # We used to find the HTML report and think it was template files.
+        self.make_file(".coveragerc", """\
+            [run]
+            plugins = django_coverage_plugin
+            source = .
+            [html]
+            directory = my_html_report
+            """)
+        self.make_template(name="main.html", text="Hello")
+        text = self.run_django_coverage(name="main.html")
+        self.assertEqual(text, "Hello")
+
+        self.assert_measured_files("main.html")
+        self.cov.html_report()
+
+        # Run coverage again with an HTML report on disk.
+        text = self.run_django_coverage(name="main.html")
+        self.assert_measured_files("main.html")