Adds tests for invalid template variables #222

codingjoe · 2015-03-22T19:04:48Z

Django catches all VariableDoesNotExist exceptions to replace
them in templates with a modifiable string that you can define in
your settings.
Sadly that doesn't allow you to find them in unit tests.

_fail_for_invalid_template_variable sets the setting
TEMPLATE_STRING_IF_INVALID to a custom class that not only fails
the current test but prints a pretty message including the template
name.

A new marker allows disabling this behavior, eg:

@pytest.mark.ignore_template_errors
def test_something():
    pass

This marker sets the setting to None, if you want it to be a string,
you can use the settings fixture to set it to your desired value.

codingjoe · 2015-03-22T23:45:43Z

I honestly don't know why the tests for 1.8 are failing. Does anyone have a clue to why the marker does not work?

blueyed · 2015-03-23T00:33:19Z

This changed in 1.8: https://docs.djangoproject.com/en/1.8/ref/templates/upgrading/

It should only be deprecated, but maybe there's a bug with that, so that e.g. TEMPLATE_STRING_IF_INVALID does not get mapped properly.

blueyed · 2015-03-23T00:35:13Z

The problem is likely that you would need to change the TEMPLATE setting for Django 1.8+, because you configure it after Django has applied its translation into the new setting.

codingjoe · 2015-03-23T08:58:56Z

@blueyed thanks, I'll look into that and tie it up.

codingjoe · 2015-03-23T21:30:34Z

@blueyed I fixed the django 18 issue and added documentation. Have fun!

blueyed · 2015-03-23T22:09:32Z

pytest_django/plugin.py

+    """Fixture that fails for invalid variables in templates.
+
+    This fixture will fail each test that uses django template rendering
+    should at template contain an invalid template variable.


blueyed · 2015-03-23T22:16:57Z

Very nice, I've left a few comments.

codingjoe · 2015-03-24T10:23:24Z

@blueyed thanks, I updated my commit.

pelme · 2015-03-29T19:47:35Z

This would be very useful!

I think this should be opt-in (maybe as a pytest.ini setting+marker for local overrides?). Just enabling it for everyone will probably break a lot of existing tests.

Maybe this (InvalidVarException) can be contributed back to Django somehow too, maybe it can be useful outside of pytest too.

codingjoe · 2015-03-30T08:47:24Z

@pelme I don't really think that Django has any interest in that patch. They actually have an exception that they always catch.

Regarding opt-in/out: I think this is an exceptable change for a minor version. And yes, some people will have to fix some templates upgrading. But only if there templates are wrong ;)

If you want me to make this an opt-in feature, let me know, I'll update my code and doc.

pelme · 2015-03-30T09:17:18Z

This is similar to DEBUG_PROPAGATE_EXCEPTIONS = True that used to be set by pytest-django, but it broke peoples test suites: #26. Yes, Django has some bad defaults here, and everyone should be better of by fixing these problems, but just changing this and breaking existing test suites is not nice. :/

Therefore I think that this feature must be opt-in, but it is certainly something I'd like to use myself.

codingjoe · 2015-03-30T13:34:15Z

@pelme sure, I'll update my PR

codingjoe · 2015-03-30T17:32:45Z

@blueyed @pelme there you go. I added a command line option --test-templates to opt-in.

blueyed · 2015-03-31T00:08:22Z

@codingjoe
Thanks! I'd like to see a (config file) option for this, too.

pelme · 2015-03-31T05:55:11Z

@codingjoe Very nice!

What about naming the option a bit less generic than --test-templates, maybe something like --fail-on-template-vars ?

codingjoe · 2015-03-31T08:20:30Z

Sure, will do. Might actually be a good Idea as I'm thinking about writing more template tests like a py.test wrapper for tidy-html5.

codingjoe · 2015-04-13T16:55:13Z

@blueyed all done.

blueyed · 2015-04-23T00:18:10Z

pytest_django/plugin.py

+    # Configure FAIL_INVALID_TEMPLATE_VARS
+    itv = (options.itv or
+           early_config.getini(INVALID_TEMPLATE_VARS_ENV) or
+           os.environ.get(INVALID_TEMPLATE_VARS_ENV))


This should be changed to prefer the environment variable before the config, see #199.

landscape-bot · 2015-04-27T18:20:58Z

Repository health decreased by 0.87% when pulling 194ac51 on codingjoe:master into 85bc9d5 on pytest-dev:master.

5 new problems were found (including 0 errors and 5 code smells).
1 problem was fixed (including 0 errors and 1 code smell).

codingjoe · 2015-04-30T08:19:05Z

@blueyed I swapped the config.

landscape-bot · 2015-04-30T08:26:14Z

Repository health decreased by 2% when pulling cc7cc10 on codingjoe:master into 24a114f on pytest-dev:master.

9 new problems were found (including 0 errors and 8 code smells).
1 problem was fixed (including 0 errors and 1 code smell).

landscape-bot · 2015-06-01T14:06:48Z

Repository health decreased by 2% when pulling cab769a on codingjoe:master into b48c02d on pytest-dev:master.

9 new problems were found (including 0 errors and 8 code smells).
1 problem was fixed (including 0 errors and 1 code smell).

landscape-bot · 2015-06-01T15:02:00Z

Repository health decreased by 2% when pulling e21193a on codingjoe:master into b48c02d on pytest-dev:master.

9 new problems were found (including 0 errors and 8 code smells).
1 problem was fixed (including 0 errors and 1 code smell).

codingjoe · 2015-06-01T15:02:09Z

@blueyed oh yes, sorry, I fixed that.

blueyed · 2015-06-01T21:52:38Z

@blueyed oh yes, sorry, I fixed that.

I think it might be good if it would use "1" for the environment variable, and allow "0" to disable it.
Currently it seems to be "set and non-empty" => True, otherwise False.
Seems to be confusing to use "True", if "False" would be also True.

Django catches all `VariableDoesNotExist` exceptions to replace them in templates with a modifiable string that you can define in your settings. Sadly that doesn't allow you to find them in unit tests. `_fail_for_invalid_template_variable` sets the setting `TEMPLATE_STRING_IF_INVALID` to a custom class that not only fails the current test but prints a pretty message including the template name. This behavior can be used with the new `--test-templates` command line option. A new marker allows disabling this behavior, eg: @pytest.mark.ignore_template_errors def test_something(): pass This marker sets the setting to None, if you want it to be a string, you can use the `settings` fixture to set it to your desired value.

codingjoe · 2015-06-03T14:59:45Z

@blueyed I hope that does fixes the issue. Please feel free to fix any typos while merging. I'm dyslexic and going into a 20th-ish review cycle is somewhat disencouraging.

landscape-bot · 2015-06-03T15:00:45Z

Repository health decreased by 0.53% when pulling 954081f on codingjoe:master into b48c02d on pytest-dev:master.

3 new problems were found (including 0 errors and 3 code smells).
No problems were fixed.

codingjoe · 2015-07-23T10:36:19Z

@blueyed @pelme anything that is stopping this from being merged?

Make it possible to fail tests for invalid template variables. Thanks to Johannes Hoppe for the patch and Daniel Hahler for review.

pelme · 2015-07-25T07:49:36Z

@codingjoe Thanks a lot for fixing all the comments and sticking with it. This is a great feature that I will use myself. Sorry for the slow response, but now it is merged and will be included in the next version (which probably will be out during/after this weekend).

blueyed · 2015-07-25T12:03:03Z

@codingjoe
I'm also sorry for forgetting about this.
And thanks indeed for sticking with me/us and providing this great feature! 🌷

coveralls · 2016-11-04T15:08:54Z

Changes Unknown when pulling 954081f on codingjoe:master into * on pytest-dev:master*.

blueyed · 2017-03-17T17:22:19Z

pytest_django/plugin.py

+            else:
+                msg = "Undefined template variable '%s'" % var
+            if self.fail:
+                pytest.fail(msg, pytrace=False)


@codingjoe
Do you remember why you used pytrace=False here?
I think it is very valuable to have a traceback in case of errors, isn't it?
(it might need to be massaged a bit to make it shorter though).
(via #470)

Nope, I don't. I think back then there trace didn't give you much information, because the template engine worked differently. That was before you could switch engines, if I remember correctly.

@codingjoe
Thanks for your feedback, enabled it in 760fb18 (#470).

Ref: pytest-dev#222 (comment)

Ref: pytest-dev/pytest-django#222 (comment)

codingjoe force-pushed the master branch 3 times, most recently from e7b1e95 to 8d90b0f Compare March 22, 2015 19:36

codingjoe force-pushed the master branch 5 times, most recently from 9ce0665 to e73eade Compare March 23, 2015 21:21

blueyed reviewed Mar 23, 2015
View reviewed changes

codingjoe force-pushed the master branch from e73eade to 61a1f1b Compare March 24, 2015 09:22

codingjoe force-pushed the master branch from 61a1f1b to 37150d7 Compare March 30, 2015 17:29

blueyed added the enhancement label Mar 31, 2015

blueyed reviewed Apr 23, 2015
View reviewed changes

codingjoe force-pushed the master branch from 194ac51 to cc7cc10 Compare April 30, 2015 08:17

codingjoe force-pushed the master branch from cc7cc10 to cab769a Compare June 1, 2015 14:02

codingjoe force-pushed the master branch from cab769a to e21193a Compare June 1, 2015 14:55

codingjoe force-pushed the master branch from e21193a to 954081f Compare June 3, 2015 14:57

pelme added a commit that referenced this pull request Jul 25, 2015

Merge pull request #222 from codingjoe/master

adedb06

Make it possible to fail tests for invalid template variables. Thanks to Johannes Hoppe for the patch and Daniel Hahler for review.

pelme merged commit adedb06 into pytest-dev:master Jul 25, 2015

blueyed reviewed Mar 17, 2017

View reviewed changes

blueyed added a commit to blueyed/pytest-django that referenced this pull request Mar 17, 2017

Do not hide traceback with failures from --fail-on-template-vars

760fb18

Ref: pytest-dev#222 (comment)

blueyed added a commit to blueyed/pytest-django that referenced this pull request Apr 17, 2017

Do not hide traceback with failures from --fail-on-template-vars

369e519

Ref: pytest-dev#222 (comment)

mfa pushed a commit to aexeagmbh/pytest-django that referenced this pull request May 17, 2017

Do not hide traceback with failures from --fail-on-template-vars

0339d51

Ref: pytest-dev#222 (comment)

dulacp pushed a commit to dulacp/pytest-django that referenced this pull request Dec 2, 2017

Do not hide traceback with failures from --fail-on-template-vars

022e20f

Ref: pytest-dev#222 (comment)

timb07 pushed a commit to timb07/pytest-django that referenced this pull request May 26, 2018

Do not hide traceback with failures from --fail-on-template-vars

f11e4a1

Ref: pytest-dev#222 (comment)

beyondgeeks added a commit to beyondgeeks/django-pytest that referenced this pull request Sep 6, 2022

Do not hide traceback with failures from --fail-on-template-vars

e4bcd53

Ref: pytest-dev/pytest-django#222 (comment)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds tests for invalid template variables #222

Adds tests for invalid template variables #222

codingjoe commented Mar 22, 2015

codingjoe commented Mar 22, 2015

blueyed commented Mar 23, 2015

blueyed commented Mar 23, 2015

codingjoe commented Mar 23, 2015

codingjoe commented Mar 23, 2015

blueyed Mar 23, 2015

blueyed commented Mar 23, 2015

codingjoe commented Mar 24, 2015

pelme commented Mar 29, 2015

codingjoe commented Mar 30, 2015

pelme commented Mar 30, 2015

codingjoe commented Mar 30, 2015

codingjoe commented Mar 30, 2015

blueyed commented Mar 31, 2015

pelme commented Mar 31, 2015

codingjoe commented Mar 31, 2015

codingjoe commented Apr 13, 2015

blueyed Apr 23, 2015

landscape-bot commented Apr 27, 2015

codingjoe commented Apr 30, 2015

landscape-bot commented Apr 30, 2015

landscape-bot commented Jun 1, 2015

landscape-bot commented Jun 1, 2015

codingjoe commented Jun 1, 2015

blueyed commented Jun 1, 2015

codingjoe commented Jun 3, 2015

landscape-bot commented Jun 3, 2015

codingjoe commented Jul 23, 2015

pelme commented Jul 25, 2015

blueyed commented Jul 25, 2015

coveralls commented Nov 4, 2016 •

edited

Loading

blueyed Mar 17, 2017 •

edited

Loading

codingjoe Mar 17, 2017

blueyed Mar 17, 2017 •

edited

Loading

Adds tests for invalid template variables #222

Adds tests for invalid template variables #222

Conversation

codingjoe commented Mar 22, 2015

codingjoe commented Mar 22, 2015

blueyed commented Mar 23, 2015

blueyed commented Mar 23, 2015

codingjoe commented Mar 23, 2015

codingjoe commented Mar 23, 2015

blueyed Mar 23, 2015

Choose a reason for hiding this comment

blueyed commented Mar 23, 2015

codingjoe commented Mar 24, 2015

pelme commented Mar 29, 2015

codingjoe commented Mar 30, 2015

pelme commented Mar 30, 2015

codingjoe commented Mar 30, 2015

codingjoe commented Mar 30, 2015

blueyed commented Mar 31, 2015

pelme commented Mar 31, 2015

codingjoe commented Mar 31, 2015

codingjoe commented Apr 13, 2015

blueyed Apr 23, 2015

Choose a reason for hiding this comment

landscape-bot commented Apr 27, 2015

codingjoe commented Apr 30, 2015

landscape-bot commented Apr 30, 2015

landscape-bot commented Jun 1, 2015

landscape-bot commented Jun 1, 2015

codingjoe commented Jun 1, 2015

blueyed commented Jun 1, 2015

codingjoe commented Jun 3, 2015

landscape-bot commented Jun 3, 2015

codingjoe commented Jul 23, 2015

pelme commented Jul 25, 2015

blueyed commented Jul 25, 2015

coveralls commented Nov 4, 2016 • edited Loading

blueyed Mar 17, 2017 • edited Loading

Choose a reason for hiding this comment

codingjoe Mar 17, 2017

Choose a reason for hiding this comment

blueyed Mar 17, 2017 • edited Loading

Choose a reason for hiding this comment

coveralls commented Nov 4, 2016 •

edited

Loading

blueyed Mar 17, 2017 •

edited

Loading

blueyed Mar 17, 2017 •

edited

Loading