fix fail-on-template-vars errors

[dantagg]

Fixes nearly all errors from running pytest --fail-on-template-vars as requested in issue #2802.

string_if_invalid
when setting pytest --fail-on-template-vars, pytest-django overwrites the template option string_if_invalid to an exception. This causes a lot of errors of the form
'string_if_invalid' in TEMPLATES OPTIONS must be a string but got: ... 33e3abf removes this error by not running the system check templates.E002 when testing.

required_css_class
The dc_base_theme repository's field.html template expects the form to have a required_css_class property. eb15152 and 6a98de9 add those properties to the relevant forms. It may be that a better solution is to remove the expectation of that property from the template.

CANONICAL_URL
The base_full.html template expects CANONICAL_URL in its context. 0af9439 creates a context_processor to add CANONICAL_URL to context. 9330d48 adds this context processor to the list of context processors and adds the setting variable CANONICAL_URL to base_settings.py. This will need to be overridden in production.

Undefined template variable 'media'
The outstanding error is Failed: Undefined template variable 'media' in '.../site-packages/pipeline/templates/pipeline/css.html'.

[GeoWill]

Thanks for this @dantagg.

It essentially looks good, but there are a couple of changes before merging. If you don't have time to do them I'm happy to, just let me know 🙂 .

• First off, until I understand it better I'd drop 33e3ab. We're not running checks regularly with --fail-on-template so I don't want to risk hiding errors that we'd want to surface. If this is a problem with how pytest-django overwrites string_if_invalid then I'd rather raise an issue there. Saying that I haven't wrapped my head around it properly so happy to hear otherwise.
• I think the CANONICAL_URL variable should point to our domain root. Though as I said in my comment perhaps we should bin the tag entirely.

Style and GNit picks:

• Squash f1fd3d into eb1515
• Make sure Travis passes - this will be black and pyflakes issues. You can run black . and pytest --flakes locally.
• Reformat commits so that the first line is 50 characters and the body wraps at 72.

Thanks again, and let me know if any of that doesn't make sense, or how to do it.

[GeoWill]

I think this should line should be:

CANONICAL_URL= 'https://wheredoivote.co.uk'

However this is all so that we can see how well our links are shared on fb, which I'm not sure we'll ever do. Anyway for now at least having the right url seems sensible.

[dantagg]

Hi Will, Happy to make the changes as you suggest. I'll get them done some time over the next week and send another pull request. Have a nice weekend Dan

…

On Fri, 13 Nov 2020 at 16:58, Will Roper ***@***.***> wrote: ***@***.**** requested changes on this pull request. Thanks for this @dantagg <https://github.com/dantagg>. It essentially looks good, but there are a couple of changes before merging. If you don't have time to do them I'm happy to, just let me know 🙂 . - First off, until I understand it better I'd drop 33e3ab. We're not running checks regularly with --fail-on-template so I don't want to risk hiding errors that we'd want to surface. If this is a problem with how pytest-django overwrites string_if_invalid then I'd rather raise an issue there. Saying that I haven't wrapped my head around it properly so happy to hear otherwise. - I think the CANONICAL_URL variable should point to our domain root. Though as I said in my comment perhaps we should bin the tag entirely. Style and GNit picks: - Squash f1fd3d into eb1515 - Make sure Travis passes - this will be black and pyflakes issues. You can run black . and pytest --flakes locally. - Reformat commits so that the first line is 50 characters and the body wraps at 72. Thanks again, and let me know if any of that doesn't make sense, or how to do it. ------------------------------ In polling_stations/settings/base.py <#2899 (comment)> : > @@ -301,3 +302,5 @@ # importing test settings file if necessary (TODO chould be done better) if len(sys.argv) > 1 and sys.argv[1] in ["test", "harvest"]: from .testing import * # noqa + +CANONICAL_URL= '' I think this should line should be: CANONICAL_URL= 'https://wheredoivote.co.uk' However this is all so that we can see how well our links are shared on fb, which I'm not sure we'll ever do. Anyway for now at least having the right url seems sensible. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2899 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AADICUA46NNQSZD74MN2FZLSPVQU7ANCNFSM4TEB3SIA> .

-- Wildman and Herring Limited, Registered Office: 4 Beau Street, Bath, United Kingdom, BA1 1QY, Company no: 05766374

[GeoWill]

send another pull request.

Feel free to force push to this one 🙂