{% ssi %} doesn't trace its included files. So be it.

Author: nedbat

README.rst

@@ -35,6 +35,12 @@ file.  The ``source=``, ``include=``, and ``omit=`` options control what
 template files are included in the report.
 
 
+Caveats
+-------
+
+The `{% ssi %}` tag does not trace the files it includes.
+
+
 What the? How?
 --------------
 

django_coverage_plugin/plugin.py

@@ -3,6 +3,7 @@
 from __future__ import print_function
 
 import os.path
+
 from six.moves import range
 
 import coverage.plugin
@@ -77,9 +78,7 @@ def dynamic_source_filename(self, filename, frame):
         if 0:
             dump_frame(frame)
         try:
-            source = render_self.source
-            origin = source[0]
-            filename = origin.name
+            filename = render_self.source[0].name
             if filename.startswith("<"):
                 # String templates have a filename of "<unknown source>", and
                 # can't be reported on later, so ignore them.
@@ -91,6 +90,8 @@ def dynamic_source_filename(self, filename, frame):
 
     def line_number_range(self, frame):
         assert frame.f_code.co_name == 'render'
+        if 0:
+            dump_frame(frame, label="line_number_range")
         render_self = frame.f_locals['self']
         source = render_self.source
         if SHOW_TRACING:
@@ -255,14 +256,16 @@ def get_line_number(line_map, offset):
     return -1
 
 
-def dump_frame(frame):
+def dump_frame(frame, label=""):
     """Dump interesting information about this frame."""
-    locals = frame.f_locals
+    locals = dict(frame.f_locals)
     self = locals.get('self', None)
     if "__builtins__" in locals:
         del locals["__builtins__"]
 
-    print("-- frame -----------------------")
+    if label:
+        label = " ( %s ) " % label
+    print("-- frame --%s---------------------" % label)
     print("{}:{}:{}".format(
         os.path.basename(frame.f_code.co_filename),
         frame.f_lineno,
@@ -271,3 +274,4 @@ def dump_frame(frame):
     print(locals)
     if self:
         print("self:", self.__dict__)
+    print("\\--")

tests/plugin_test.py

@@ -26,6 +26,7 @@
         }
     },
     TEMPLATE_DEBUG=True,
+    ALLOWED_INCLUDE_ROOTS=["/"],    # for {% ssi %}
 )
 
 if hasattr(django, "setup"):
@@ -55,7 +56,7 @@ def make_template(self, text, name=None):
         else:
             self.template_file = self.id().rpartition(".")[2] + ".html"
         template_path = self.path(self.template_file)
-        self.make_file(template_path, text)
+        return os.path.abspath(self.make_file(template_path, text))
 
     def run_django_coverage(
         self, name=None, text=None, context=None, options=None,
@@ -117,6 +118,10 @@ def get_analysis(self, name=None):
         _, executable, _, missing, _ = analysis
         return executable, missing
 
+    def measured_files(self):
+        """Get the list of measured files, in relative form."""
+        return [os.path.relpath(f) for f in self.cov.data.measured_files()]
+
     def assert_analysis(self, executable, missing=None, name=None):
         """Assert that the analysis for `name` is right."""
         actual_executable, actual_missing = self.get_analysis(name)

tests/test_extends.py

@@ -1,6 +1,6 @@
 """Tests of template inheritance for django_coverage_plugin."""
 
-from .plugin_test import DjangoPluginTestCase
+from .plugin_test import DjangoPluginTestCase, needs_django
 
 
 class BlockTest(DjangoPluginTestCase):
@@ -143,3 +143,45 @@ def test_include(self):
         self.assertEqual(text, "First\nInside\nJob\n\nLast\n")
         self.assert_analysis([1, 2, 3], name="outer.html")
         self.assert_analysis([1, 2], name="nested.html")
+
+
+# {% ssi %} is in earlier Djangos than 1.5, but doesn't trace properly.
+@needs_django(1, 5)
+class SsiTest(DjangoPluginTestCase):
+    """Test {% ssi %}, which does not trace the included file."""
+
+    def test_ssi_unparsed(self):
+        nested = self.make_template(name="nested.html", text="""\
+            Inside {{ a }}
+            Job
+            """)
+
+        self.make_template(name="outer.html", text="""\
+            First
+            {% ssi "NESTED" %}
+            Last
+            """.replace("NESTED", nested))
+
+        text = self.run_django_coverage(name="outer.html", context={'a': 17})
+        self.assertEqual(text, "First\nInside {{ a }}\nJob\n\nLast\n")
+        self.assert_analysis([1, 2, 3], name="outer.html")
+        # nested.html is not among the measured files:
+        self.assertEqual(self.measured_files(), ["templates/outer.html"])
+
+    def test_ssi_parsed(self):
+        nested = self.make_template(name="nested.html", text="""\
+            Inside {{ a }}
+            Job
+            """)
+
+        self.make_template(name="outer.html", text="""\
+            First
+            {% ssi "NESTED" parsed %}
+            Last
+            """.replace("NESTED", nested))
+
+        text = self.run_django_coverage(name="outer.html", context={'a': 17})
+        self.assertEqual(text, "First\nInside 17\nJob\n\nLast\n")
+        self.assert_analysis([1, 2, 3], name="outer.html")
+        # nested.html is not among the measured files:
+        self.assertEqual(self.measured_files(), ["templates/outer.html"])