How to find templates that are never executed?

[nedbat]

With .py files, --source will find files that were never even executed once. What's the equivalent for template files?

[jessamynsmith]

I ran into this on one of my projects. I had unit tests on views, but they weren't actually calling views that rendered templates, so I wasn't getting any template coverage. Perhaps the plugin should inspect settings.TEMPLATE_DIRS and report on all files found therein? That will cover cases where the user has templates in unusual places. It might also be possible to leverage settings.TEMPLATE_LOADERS to find all templates in the project. By default, Django checks every app for a templates directory.

[nedbat]

One thing I'm not sure of, is how to know what are template files. With Python files, I can look for .py files. But template files could have any extension. Is it true that every file in the TEMPLATE_DIRS tree is a template? Do we need a configuration option for the plugin which is the extensions to consider as templates?

[PamelaM]

I can't speak for every project, but for ours, every file in TEMPLATE_DIRS is a template.

One could add optional settings for:
(a) template_extensions (defaults to .*, but for most of us it will be .html)
(b) If you open a file, parse it, and there's no template language (e.g. '{%' or '{{'), it's not a template

But I think treating the TEMPLATE_DIRS as containing all templates will be good enough.

[sergei-maertens]

You could inspire yourself on how makemessages works, that one also loops through all the templates and it's an option to specify extensions other than the defaults.

I wrote a library that also loops through all template files in the same way, you could maybe use that as inspiration: https://github.com/sergei-maertens/django-systemjs/blob/develop/systemjs/management/commands/systemjs_bundle.py#L64

Other than that, some .coveragerc options to manually specify directories/files might also be an option?

[edwardotis]

+1 to fix this issue
and +1 for every file in TEMPLATES['DIRS'] can be considered a template file. (people can use omit if they put non-templates in there.)

fyi, I still cannot get this plugin configured to pick up a single template.

[saulshanabrook]

But template files could have any extension. Is it true that every file in the TEMPLATE_DIRS tree is a template?

For all my projects, this is true. I can't think of a reason why you would put a file in there that isn't a template.

[clokep]

Just chiming in that for us every file in TEMPLATE_DIRS is a template...and not all of them have a .html extension (.txt and .subject are common other ones).

[schinckel]

I think the mechanism that is there only looks in settings.TEMPLATES[i][DIRS] - we have apps that have their own templates - those should be included too.

[schinckel]

Oh wait, that's not in the released code - the HEAD in git will find all HTML files in the tested directories.

My comment about APP_DIRS stands though - but then how do we know which apps to include, I suppose? Generally only internal apps are tested in my project.

[charettes]

One way this could be solved is to file a Django feature request to add a method to engines that returns all of their templates.

[schinckel]

Hmm. I think that might work, because I think that coverage will only include files that are inside the coverage source directories. I'm not familiar enough with it to state definitively, but I think that's what I saw yesterday.

[schinckel]

@charettes Will this return all templates that are in the tree, or only those that are actually loaded? I feel like it's the latter...

[charettes]

@schinckel the idea would be for engines to return all valid identifiers they allow. The thing is not all template custom engines are file based; some third-party ones are backed by models for example.

[jambonrose]

Given that #39 was merged and implements the feature, I am closing this issue.

@schinckel : When I run tests with django_coverage_plugin, I am seeing missing template files from app directories, and have not been able to replicate conditions where they are missing. If you're not seeing missing templates when they're in app_name/templates please open a new issue (with code, if possible!). Thank you.

Several people expressed the desire to be able to match files that don't end with .html or .htm. This sounds like a reasonable feature to be, so I will be opening a new issue for that.