Add tests for Jinja template function

The tests mirror the Django template tag tests

Author: HiPhish

src/django_simple_nav/jinja2/django_simple_nav.py

@@ -23,13 +23,15 @@ def django_simple_nav(
         try:
             nav = import_string(nav)()
         except ImportError as err:
-            msg = f"Variable does not exist: {err}"
-            raise TemplateRuntimeError(msg) from err
-
-    if template_name is None:
-        template_name = cast(Nav, nav).template_name
-    if template_name is None:
-        raise TemplateRuntimeError("Navigation object has no template")
-
-    template: Template = loader.load(context.environment, template_name)
-    return template.render(items=cast(Nav, nav).items)
+            raise TemplateRuntimeError(str(err)) from err
+
+    try:
+        if template_name is None:
+            template_name = cast(Nav, nav).template_name
+        if template_name is None:
+            raise TemplateRuntimeError("Navigation object has no template")
+        items = cast(Nav, nav).get_items(context['request'])
+    except Exception as err:
+        raise TemplateRuntimeError(str(err)) from err
+
+    return loader.load(context.environment, template_name).render(items=items)

tests/jinja2/environment.py

@@ -7,5 +7,8 @@
 
 from django_simple_nav.jinja2.django_simple_nav import django_simple_nav
 
-environment = Environment(loader=FileSystemLoader("tests/templates/tests/jinja2/"))
+# Ensure the same template paths are valid for both Jinja2 and Django templates
+loader = FileSystemLoader("tests/jinja2/")
+
+environment = Environment(loader=loader, trim_blocks=True)
 environment.globals.update({"django_simple_nav": django_simple_nav})

tests/templates/tests/jinja2/alternate.html renamed to tests/jinja2/tests/alternate.html

@@ -1,16 +1,137 @@
 from __future__ import annotations
 
-from .jinja2.environment import environment
+import pytest
+from jinja2 import UndefinedError, TemplateRuntimeError
+from django.contrib.auth.models import AnonymousUser
+from django.contrib.auth import get_user_model
 
+from django_simple_nav.nav import NavItem
+from model_bakery import baker
 
-def test_render():
-    """Render the template"""
+from tests.utils import count_anchors
+from tests.navs import DummyNav
+from tests.jinja2.environment import environment
+
+pytestmark = pytest.mark.django_db
+
+
+def test_django_simple_nav_templatetag(req):
+    template = environment.from_string(
+        '{{ django_simple_nav("tests.navs.DummyNav") }}'
+    )
+    req.user = AnonymousUser()
+    rendered_template = template.render(request=req)
+    assert count_anchors(rendered_template) == 7
+
+
+def test_templatetag_with_template_name(req):
+    template = environment.from_string(
+        "{{ django_simple_nav('tests.navs.DummyNav', 'tests/alternate.html') }}"
+    )
+    req.user = AnonymousUser()
+    rendered_template = template.render({"request": req})
+    assert "This is an alternate template." in rendered_template
+
+
+def test_templatetag_with_nav_instance(req):
+    class PlainviewNav(DummyNav):
+        items = [
+            NavItem(title="I drink your milkshake!", url="/milkshake/"),
+        ]
+
+    template = environment.from_string("{{ django_simple_nav(new_nav) }}")
+    req.user = baker.make(get_user_model(), first_name="Daniel", last_name="Plainview")
+    rendered_template = template.render({"request": req, "new_nav": PlainviewNav()})
+    assert "I drink your milkshake!" in rendered_template
+
+
+def test_templatetag_with_nav_instance_and_template_name(req):
+    class DeadParrotNav(DummyNav):
+        items = [
+            NavItem(title="He's pinin' for the fjords!", url="/notlob/"),
+        ]
+
+    template = environment.from_string(
+        "{{ django_simple_nav(new_nav, 'tests/alternate.html') }}"
+    )
+    req.user = baker.make(get_user_model(), first_name="Norwegian", last_name="Blue")
+    rendered_template = template.render({"request": req, "new_nav": DeadParrotNav()})
+    assert "He's pinin' for the fjords!" in rendered_template
+    assert "This is an alternate template." in rendered_template
+
+
+def test_templatetag_with_template_name_on_nav_instance(req):
+    class PinkmanNav(DummyNav):
+        template_name = "tests/alternate.html"
+        items = [
+            NavItem(title="Yeah Mr. White! Yeah science!", url="/science/"),
+        ]
+
+    template = environment.from_string("{{ django_simple_nav(new_nav) }}")
+    req.user = baker.make(get_user_model(), first_name="Jesse", last_name="Pinkman")
+    rendered_template = template.render({"request": req, "new_nav": PinkmanNav()})
+    assert "Yeah Mr. White! Yeah science!" in rendered_template
+    assert "This is an alternate template." in rendered_template
+
+
+def test_templatetag_with_no_arguments(req):
+    req.user = AnonymousUser()
+    with pytest.raises(TypeError):
+        template = environment.from_string("{{ django_simple_nav() }}")
+        template.render({'request': req})
+
+
+def test_templatetag_with_missing_variable(req):
+    req.user = AnonymousUser()
+    template = environment.from_string("{{ django_simple_nav(missing_nav) }}")
+    with pytest.raises(TemplateRuntimeError):
+        template.render({'request': req})
+
+
+def test_nested_templatetag(req):
+    # called twice to simulate a nested call
+    template = environment.from_string(
+        "{{ django_simple_nav('tests.navs.DummyNav') }}"
+        "{{ django_simple_nav('tests.navs.DummyNav') }}"
+    )
+    req.user = AnonymousUser()
+    rendered_template = template.render({"request": req})
+    assert count_anchors(rendered_template) == 14
+
+
+def test_invalid_dotted_string(req):
     template = environment.from_string(
-        '''
-        <p>
-            {{ django_simple_nav("tests.navs.DummyNav", "dummy_nav.html") }}
-        </p>'
-        '''
+        "{{ django_simple_nav('path.to.DoesNotExist') }}"
     )
-    print(template.render(some_var=[1, 2, 3]))
-    assert True
+
+    with pytest.raises(TemplateRuntimeError):
+        template.render({"request": req})
+
+
+class InvalidNav:
+    ...
+
+
+def test_invalid_nav_instance(req):
+    template = environment.from_string(
+        "{{ django_simple_nav('tests.test_templatetags.InvalidNav') }}"
+    )
+    with pytest.raises(TemplateRuntimeError):
+        template.render({"request": req})
+
+
+def test_template_name_variable_does_not_exist(req):
+    template = environment.from_string(
+        "{{ django_simple_nav('tests.navs.DummyNav', nonexistent_template_name_variable) }}"
+    )
+    with pytest.raises(TemplateRuntimeError):
+        template.render({"request": req})
+
+
+def test_request_not_in_context():
+    template = environment.from_string(
+        " {{ django_simple_nav('tests.navs.DummyNav') }}"
+    )
+
+    with pytest.raises(TemplateRuntimeError):
+        template.render()