Add a new rule for detecting nested jinja mustache syntax

[europ]

A new rule for ansible lint was added that provides nested jinja bracket pattern detection. Nesting jinja patterns can lead to failures and other problems.

\cc @amarza-rh

[webknjaz]

Overall looks okay but it's better to also add tests before merging.

[webknjaz]

recheck

[ssbarnea]

recheck

[webknjaz]

@europ could you please also submit tests for this feature? It'd be hard to keep it working/healthy/supported without any CI checks in place.

[europ]

Good evening @webknjaz,

Thank you for your added patches.

I am sorry that I did not add the tests yet. I am struggling with other current tasks. I will add it soon.

Best regards.

[europ]

📌 TODO: add tests

[europ]

✔️ tests added

[europ]

Hi @webknjaz, I have added the tests as soon as I could. I am sorry for the delay.

[webknjaz]

@europ it's alright. No need to rush. Could you please check the failing CI jobs? Looks like the tests are failing.

[europ]

There is some warning RemovedInSphinx30Warning due to that docs build fails.

 The HTML pages are in _build/html.
/home/runner/work/ansible-lint/ansible-lint/docs/docsite/_themes/sphinx_rtd_theme/search.html:21: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a <script> tag directly in your theme instead.
  {% endblock %}
make[1]: Leaving directory '/home/runner/work/ansible-lint/ansible-lint/docs/docsite'
ERROR: Building docs changed tracked files, include them in commit to avoid this failure.
Makefile:38: recipe for target 'htmldocs' failed
make: *** [htmldocs] Error 1
make: Leaving directory '/home/runner/work/ansible-lint/ansible-lint/docs/docsite'
ERROR: InvocationError for command /usr/bin/make -C docs/docsite htmldocs (exited with code 2)

I tried some of the shared advice I found but I didn't succeed.

• https://stackoverflow.com/questions/57401254/fix-sphinx-removedinsphinx30warning
• Sphinx deprecation warning readthedocs/sphinx_rtd_theme#739
• RemovedInSphinx30Warning building docs with sphinx 2.0 gevent/gevent#1404

I am not very familiar with jekyll / sphinx, do you have any idea how to fix this warning? It might be needed to rewrite some parts of the documentation to fix this.

[webknjaz]

I think those sphinx errors are not related to your change. But there's failures in other jobs that might be.

[webknjaz]

Just to be on the safe side, rebase your branch on top of the fresh master

[webknjaz]

Oh, it looks like you need to regenerate default_rules.rst:

cd ../../lib/ansiblelint; python ./generate_docs.py
../../docs/docsite/rst/rules/default_rules.rst file written
...
ERROR: Building docs changed tracked files, include them in commit to avoid this failure.

[webknjaz]

You used Czech diacritics/letters w/ accents. They are subset of Unicode and Python 2 doesn't know what to do with them and fails expecting plain ASCII.
If you want to use Unicode in modules under Python 2, you must specify the encoding at the top so that the parser would know what to do.

==================================== ERRORS ====================================
_________________ ERROR collecting test/TestNestedJinjaRule.py _________________
.tox/ansible27/lib/python2.7/site-packages/py/_path/local.py:701: in pyimport
    __import__(modname)
E     File "/home/runner/work/ansible-lint/ansible-lint/test/TestNestedJinjaRule.py", line 1
E   SyntaxError: Non-ASCII character '\xc3' in file /home/runner/work/ansible-lint/ansible-lint/test/TestNestedJinjaRule.py on line 1, but no encoding declared; see http://python.org/dev/peps/pep-0263/ for details

[europ]

BTW, should I squash the commits into one?

[webknjaz]

@europ looks like test/TestRunner.py::test_runner[test/become.yml-exclude4-0] is failing. Also, I think it'd be great to use ids= arg in @pytest.mark.parametrize() because autogenerated test param names (like test/become.yml-exclude4-0) are not very informative in the test run report, in logs. Would you improve this, please?

[webknjaz]

Oh, wait... You didn't touch TestRunner.py. So you don't have to fix its IDs. But it looks like your code broke that test meaning you introduced a bug that should be fixed before proceeding: https://github.com/ansible/ansible-lint/pull/686/checks?check_run_id=778145463#step:9:299.

Also, please mark your PR as "Ready for review" once the CI checks are green.

[europ]

Hmm... TypeError: sequence item 2: expected str instance, bool found. Going to fix it. Yes, I did not touch that file TestRunner.py

[webknjaz]

This could be

Suggested change

	value
	str(value)

but also for some types it may be misleading. Like b'something' may be turned into "b'something'". So you may want to be careful here — bytes should be converted differently.

[webknjaz]

This shouldn't explain how the code works. Reading it is pretty obvious. Code comments must be used to explain why this code is here.

[webknjaz]

I guess this is not very important atm so I won't wait for the rephrase.

[webknjaz]

I didn't take into account that we have a custom dynamic rule importer and the class won't match. Reverting that.

[webknjaz]

Great job, @europ!

[europ]

@webknjaz thanks for the help & review!