feat: improve template coverage cfg (ietf-tools#9230)

* feat: template coverage ignores using path

* refactor: reduce repeatitive redundancy

* chore: copyrights

* refactor: use pathlib to compute BASE_DIR

* feat: settings.PROJECT_DIR

* fix: glob from PROJECT_DIR not BASE_DIR

* chore: remove reference code

Author: jennifer-richards

ietf/settings.py

@@ -1,4 +1,4 @@
-# Copyright The IETF Trust 2007-2024, All Rights Reserved
+# Copyright The IETF Trust 2007-2025, All Rights Reserved
 # -*- coding: utf-8 -*-
 
 
@@ -9,6 +9,7 @@
 import os
 import sys
 import datetime
+import pathlib
 import warnings
 from hashlib import sha384
 from typing import Any, Dict, List, Tuple # pyflakes:ignore
@@ -27,8 +28,12 @@
 warnings.filterwarnings("ignore", message="Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated", module="bleach")
 warnings.filterwarnings("ignore", message="HTTPResponse.getheader\\(\\) is deprecated", module='selenium.webdriver')
 
-BASE_DIR = os.path.dirname(os.path.abspath(__file__))
-sys.path.append(os.path.abspath(BASE_DIR + "/.."))
+base_path = pathlib.Path(__file__).resolve().parent
+BASE_DIR = str(base_path)
+
+project_path = base_path.parent
+PROJECT_DIR = str(project_path)  
+sys.path.append(PROJECT_DIR)
 
 from ietf import __version__
 import debug
@@ -717,12 +722,13 @@ def skip_unreadable_post(record):
 ]
 
 # These are filename globs.  They are used by test_parse_templates() and
-# get_template_paths()
+# get_template_paths(). Globs are applied via pathlib.Path().match, using
+# the path to the template from the project root.
 TEST_TEMPLATE_IGNORE = [
-    ".*",                             # dot-files
-    "*~",                             # tilde temp-files
-    "#*",                             # files beginning with a hashmark
-    "500.html"                        # isn't loaded by regular loader, but checked by test_500_page()
+    ".*",  # dot-files
+    "*~",  # tilde temp-files
+    "#*",  # files beginning with a hashmark
+    "500.html",  # isn't loaded by regular loader, but checked by test_500_page()
 ]
 
 TEST_COVERAGE_MAIN_FILE = os.path.join(BASE_DIR, "../release-coverage.json")

ietf/utils/test_runner.py

@@ -1,4 +1,4 @@
-# Copyright The IETF Trust 2009-2020, All Rights Reserved
+# Copyright The IETF Trust 2009-2025, All Rights Reserved
 # -*- coding: utf-8 -*-
 #
 # Portion Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
@@ -54,7 +54,6 @@
 import urllib3
 import warnings
 
-from fnmatch import fnmatch
 from typing import Callable, Optional
 from urllib.parse import urlencode
 
@@ -414,8 +413,9 @@ def do_append(res, p0, p1, item):
             res.append((str(item.pattern), item))
     return res
 
+
 _all_templates = None
-def get_template_paths(apps=None):
+def get_template_paths(apps=None) -> list[str]:
     global _all_templates
     if not _all_templates:
         # TODO: Add app templates to the full list, if we are using
@@ -424,25 +424,26 @@ def get_template_paths(apps=None):
         templatepaths = settings.TEMPLATES[0]['DIRS']
         for templatepath in templatepaths:
             for dirpath, dirs, files in os.walk(templatepath):
-                if ".svn" in dirs:
-                    dirs.remove(".svn")
-                relative_path = dirpath[len(templatepath)+1:]
-                for file in files:
-                    ignore = False
-                    for pattern in settings.TEST_TEMPLATE_IGNORE:
-                        if fnmatch(file, pattern):
-                            ignore = True
-                            break
-                    if ignore:
-                        continue
-                    if relative_path != "":
-                        file = os.path.join(relative_path, file)
-                    templates.add(file)
-        if apps:
-            templates = [ t for t in templates if t.split(os.path.sep)[0] in apps ]
-        _all_templates = templates
+                # glob against path from PROJECT_DIR
+                project_path = pathlib.Path(
+                    dirpath.removeprefix(settings.PROJECT_DIR).lstrip("/") 
+                )
+                # label entries with name relative to templatepath
+                relative_path = pathlib.Path(
+                    dirpath.removeprefix(templatepath).lstrip("/")
+                )
+                if apps and relative_path.parts[0] not in apps:
+                    continue  # skip uninteresting apps
+                for filename in files:
+                    file_path = project_path / filename
+                    if not any(
+                        file_path.match(pat) for pat in settings.TEST_TEMPLATE_IGNORE
+                    ):
+                        templates.add(relative_path / filename)
+        _all_templates = [str(t) for t in templates]
     return _all_templates
 
+
 def save_test_results(failures, test_labels):
     # Record the test result in a file, in order to be able to check the
     # results and avoid re-running tests if we've already run them with OK

ietf/utils/tests.py

@@ -19,7 +19,6 @@
 from email.mime.image import MIMEImage
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
-from fnmatch import fnmatch
 from importlib import import_module
 from textwrap import dedent
 from tempfile import mkdtemp
@@ -320,7 +319,7 @@ class TemplateChecksTestCase(TestCase):
     def setUp(self):
         super().setUp()
         set_coverage_checking(False)
-        self.paths = list(get_template_paths())
+        self.paths = get_template_paths()  # already filtered ignores
         self.paths.sort()
         for path in self.paths:
             try:
@@ -335,11 +334,7 @@ def tearDown(self):
     def test_parse_templates(self):
         errors = []
         for path in self.paths:
-            for pattern in settings.TEST_TEMPLATE_IGNORE:
-                if fnmatch(path, pattern):
-                    continue
-            if not path in self.templates:
-
+            if path not in self.templates:
                 try:
                     get_template(path)
                 except Exception as e: