From 22c1f4d693f8c47d204ecd1262aeae7f47086f0b Mon Sep 17 00:00:00 2001
From: "Schinckel, Matthew" <matt.schinckel@oracle.com>
Date: Thu, 30 May 2024 11:52:07 +0930
Subject: [PATCH 1/2] Allow ignoring script tags.

---
 README.rst                       | 12 ++++++
 django_coverage_plugin/plugin.py | 42 ++++++++++++++++++++-
 tests/test_simple.py             | 64 ++++++++++++++++++++++++++++++++
 3 files changed, 116 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index 7ce3fd4..f6ce08e 100644
--- a/README.rst
+++ b/README.rst
@@ -101,6 +101,18 @@ If you use ``pyproject.toml`` for tool configuration use::
     [tool.coverage.django_coverage_plugin]
     template_extensions = 'html, txt, tex, email'
 
+By default, <script> tags will be marked as covered if they were rendered. If you are collecting
+in-browser coverage data, you can instruct the plugin not to count the content of the script tags
+as covered::
+
+    [run]
+    plugins = django_coverage_plugin
+
+    [django_coverage_plugin]
+    ignore_script_tags = true
+
+
+
 Caveats
 ~~~~~~~
 
diff --git a/django_coverage_plugin/plugin.py b/django_coverage_plugin/plugin.py
index 158ee9a..b16c973 100644
--- a/django_coverage_plugin/plugin.py
+++ b/django_coverage_plugin/plugin.py
@@ -5,6 +5,7 @@
 
 import os.path
 import re
+import html.parser
 
 try:
     from coverage.exceptions import NoSource
@@ -158,6 +159,8 @@ def __init__(self, options):
 
         self.source_map = {}
 
+        self.ignore_script_tags = options.get('ignore_script_tags', False)
+
     # --- CoveragePlugin methods
 
     def sys_info(self):
@@ -184,7 +187,7 @@ def file_tracer(self, filename):
         return None
 
     def file_reporter(self, filename):
-        return FileReporter(filename)
+        return FileReporter(filename, ignore_script_tags=self.ignore_script_tags)
 
     def find_executable_files(self, src_dir):
         # We're only interested in files that look like reasonable HTML
@@ -291,12 +294,37 @@ def get_line_map(self, filename):
         return self.source_map[filename]
 
 
+class ScriptParser(html.parser.HTMLParser):
+    # We never have nested script tags, so we are all good.
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.script_lines = []
+        self.in_script = False
+
+    def handle_starttag(self, tag, attrs):
+        if tag == 'script':
+            self.in_script = True
+
+    def handle_endtag(self, tag):
+        if tag == 'script':
+            self.in_script = False
+
+    def handle_data(self, data):
+        if self.in_script:
+            start_line = self.getpos()[0]
+            self.script_lines.extend([
+                line + start_line + 1 for line in range(data.rstrip().count('\n'))
+            ])
+
+
 class FileReporter(coverage.plugin.FileReporter):
-    def __init__(self, filename):
+    def __init__(self, filename, *, ignore_script_tags=False):
         super().__init__(filename)
         # TODO: html filenames are absolute.
 
         self._source = None
+        self.ignore_script_tags = ignore_script_tags
 
     def source(self):
         if self._source is None:
@@ -306,6 +334,16 @@ def source(self):
                 raise NoSource(f"Couldn't read {self.filename}: {exc}")
         return self._source
 
+    def translate_lines(self, lines):
+        if self.ignore_script_tags:
+            # Initially, we'll only support "simple" script contents, ie,
+            # they may not have any django template directives within them.
+            parser = ScriptParser()
+            parser.feed(self.source())
+            return {line for line in lines if line not in parser.script_lines}
+
+        return super().translate_lines(lines)
+
     def lines(self):
         source_lines = set()
 
diff --git a/tests/test_simple.py b/tests/test_simple.py
index a09ecb7..10044d1 100644
--- a/tests/test_simple.py
+++ b/tests/test_simple.py
@@ -238,6 +238,70 @@ def test_with(self):
         self.assertEqual(text, "\nalpha = 1, beta = 2.\n\n")
         self.assert_analysis([1, 2])
 
+    def test_script_tag_ignored(self):
+        self.make_file(".coveragerc", """\
+            [run]
+            plugins = django_coverage_plugin
+            [django_coverage_plugin]
+            ignore_script_tags = true
+            """)
+
+        template = """{% if 1 %}
+        {% url 'xxx' as yyy %}
+        <div class="x"
+             id="y"
+             {% if qux %}data-element="true"{% endif %}>
+            xxx
+
+        </div>
+        <script>
+         this should be a JS error.
+         and these lines should not be covered.
+
+
+        </script>
+        {% endif %}
+        <div>
+          yyy
+        </div>"""
+        self.make_template(template)
+        self.run_django_coverage()
+        report = self.cov.report()
+        lines = len(template.split('\n'))
+        self.assertEqual(report, 100.0 * (lines - 2) / lines)
+
+    def test_script_tag_not_ignored(self):
+        self.make_file(".coveragerc", """\
+            [run]
+            plugins = django_coverage_plugin
+            [django_coverage_plugin]
+            ignore_script_tags = false
+            """)
+
+        template = """{% if 1 %}
+        {% url 'xxx' as yyy %}
+        <div class="x"
+             id="y"
+             {% if qux %}data-element="true"{% endif %}>
+            xxx
+
+        </div>
+        <script>
+         this should be a JS error.
+         and these lines should not be covered.
+
+
+        </script>
+        {% endif %}
+        <div>
+          yyy
+        </div>"""
+        self.make_template(template)
+        self.run_django_coverage()
+        report = self.cov.report()
+        lines = len(template.split('\n'))
+        self.assertEqual(report, 100.0)
+
 
 class StringTemplateTest(DjangoPluginTestCase):
 

From d445907121c0efc75d0490d4989081ac2120d207 Mon Sep 17 00:00:00 2001
From: "Schinckel, Matthew" <matt.schinckel@oracle.com>
Date: Fri, 31 May 2024 14:15:03 +0930
Subject: [PATCH 2/2] Use script_blocks as an interim for script_lines

---
 django_coverage_plugin/plugin.py | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

diff --git a/django_coverage_plugin/plugin.py b/django_coverage_plugin/plugin.py
index b16c973..1f088bd 100644
--- a/django_coverage_plugin/plugin.py
+++ b/django_coverage_plugin/plugin.py
@@ -159,7 +159,7 @@ def __init__(self, options):
 
         self.source_map = {}
 
-        self.ignore_script_tags = options.get('ignore_script_tags', False)
+        self.ignore_script_tags = options.get('ignore_script_tags', False) in (True, 'True', 'true')
 
     # --- CoveragePlugin methods
 
@@ -298,13 +298,16 @@ class ScriptParser(html.parser.HTMLParser):
     # We never have nested script tags, so we are all good.
 
     def __init__(self, *args, **kwargs):
+        self.script_checker = kwargs.pop('script_checker', lambda attrs: True)
         super().__init__(*args, **kwargs)
-        self.script_lines = []
+        self.script_blocks = []
         self.in_script = False
+        self.script_lines_cache = None
 
     def handle_starttag(self, tag, attrs):
         if tag == 'script':
-            self.in_script = True
+            attrs = dict(attrs)
+            self.in_script = self.script_checker(attrs) and attrs.get('type', 'text/javascript') == 'text/javascript'
 
     def handle_endtag(self, tag):
         if tag == 'script':
@@ -313,9 +316,17 @@ def handle_endtag(self, tag):
     def handle_data(self, data):
         if self.in_script:
             start_line = self.getpos()[0]
-            self.script_lines.extend([
-                line + start_line + 1 for line in range(data.rstrip().count('\n'))
-            ])
+            self.script_blocks.append((start_line + 1, start_line + 1 + data.rstrip().count('\n')))
+
+    def _script_lines(self):
+        for block in self.script_blocks:
+            yield from range(block[0], block[1])
+
+    @property
+    def script_lines(self):
+        if self.script_lines_cache is None:
+            self.script_lines_cache = list(self._script_lines())
+        return self.script_lines_cache
 
 
 class FileReporter(coverage.plugin.FileReporter):