Increased test coverage (#63)

* added 100% coverage

* update tests

Author: FinalAngel

.gitignore

@@ -4,6 +4,7 @@
 *.log
 *.pot
 .DS_Store
+.coverage
 .coverage/
 .eggs/
 .idea/

.travis.yml

@@ -1,5 +1,6 @@
 language: python
 
+dist: xenial
 sudo: false
 
 matrix:
@@ -25,12 +26,9 @@ matrix:
     # Django 2.2
     - python: 3.6
       env: DJANGO='dj22' CMS='cms37'
-      dist: xenial
-      sudo: true
     - python: 3.7
       env: DJANGO='dj22' CMS='cms37'
-      dist: xenial
-      sudo: true
+
 
 install:
   - pip install coverage isort tox

CHANGELOG.rst

@@ -8,6 +8,9 @@ Changelog
 
 * Fixed an issue where render requires a dict instead of a context
 * Added ``DJANGOCMS_SNIPPET_CACHE`` cache settings for snippets
+* Added further tests to raise coverage
+* Fixed smaller issues found during testing
+* Fixed alt attribute not rendering correctly
 
 
 2.2.0 (2019-05-06)

djangocms_snippet/migrations/0003_auto_data_fill_slug.py

@@ -13,7 +13,7 @@ def auto_fill_slugs(apps, schema_editor):
     """
     Snippet = apps.get_model("djangocms_snippet", "Snippet")
     SlugCounter = Counter()
-    for snippet_item in Snippet.objects.all():
+    for snippet_item in Snippet.objects.all():  # pragma: no cover
         if not snippet_item.slug:
             snippet_item.slug = slugify(snippet_item.name)
             # Avoid duplicate slug, adding slug occurence count to the slug

djangocms_snippet/templatetags/snippet_tags.py

@@ -69,7 +69,7 @@ def render(self, context):
             if isinstance(snippet_instance, six.string_types):
                 snippet_instance = Snippet.objects.get(slug=snippet_instance)
             # Assume this is an id
-            elif isinstance(snippet_instance, int):
+            elif isinstance(snippet_instance, int):  # pragma: no cover
                 snippet_instance = Snippet.objects.get(pk=snippet_instance)
 
             return mark_safe(self.get_content_render(context,
@@ -88,18 +88,20 @@ def get_content_render(self, context, instance):
         })
         try:
             if instance.template:
-                t = template.loader.get_template(instance.template)
                 context.update({
                     'html': mark_safe(instance.html)
                 })
-                content = t.render(template.Context(context))
+                content = template.loader.render_to_string(
+                    instance.template,
+                    context.flatten(),
+                )
             else:
                 t = template.Template(instance.html)
                 content = t.render(template.Context(context))
         except template.TemplateDoesNotExist:
             content = _('Template %(template)s does not exist.') % {
                 'template': instance.template}
-        except Exception as e:
+        except Exception as e:  # pragma: no cover
             content = escape(str(e))
             if self.parse_until:
                 # In case we are running 'exceptionless'

tests/requirements.txt

@@ -1,4 +1,7 @@
-# other requirements
 djangocms-helper
 tox
 coverage
+isort
+flake8
+# override "pyflakes<2.1" from djangocms-helper
+pyflakes>=2.1.0

tests/test_models.py

@@ -1,81 +1,46 @@
 # -*- coding: utf-8 -*-
-from cms.api import add_plugin, create_page
-from cms.test_utils.testcases import CMSTestCase
+from django.test import TestCase
 
-from djangocms_snippet.models import Snippet
+from djangocms_snippet.models import Snippet, SnippetPtr, SEARCH_ENABLED
 
 
-class SnippetTestCase(CMSTestCase):
+class SnippetModelTestCase(TestCase):
 
     def setUp(self):
-        self.superuser = self.get_superuser()
-        self.home = create_page(
-            title="home",
-            template="page.html",
-            language="en",
-        )
-        self.home.publish("en")
-        self.page = create_page(
-            title="help",
-            template="page.html",
-            language="en",
-        )
+        pass
 
     def tearDown(self):
-        self.page.delete()
-        self.home.delete()
+        pass
+
+    def test_settings(self):
+        self.assertEqual(SEARCH_ENABLED, False)
 
     def test_snippet_instance(self):
-        """Snippet instance has been created"""
         Snippet.objects.create(
-            name="snippet",
+            name="test snippet",
+            html="<p>hello world</p>",
+            slug="test_snippet",
         )
-        snippet = Snippet.objects.get(name="snippet")
-        self.assertEqual(snippet.name, "snippet")
-
-    def test_html_rendering(self):
+        instance = Snippet.objects.all()
+        self.assertEqual(instance.count(), 1)
+        instance = Snippet.objects.first()
+        self.assertEqual(instance.name, "test snippet")
+        self.assertEqual(instance.html, "<p>hello world</p>")
+        self.assertEqual(instance.slug, "test_snippet")
+        # test strings
+        self.assertEqual(str(instance), "test snippet")
+
+    def test_snippet_ptr_instance(self):
         snippet = Snippet.objects.create(
-            name="plugin_snippet",
-            html="<p>Hello World</p>",
-            slug="plugin_snippet",
+            name="test snippet",
+            html="<p>hello world</p>",
+            slug="test_snippet",
         )
-        plugin = add_plugin(
-            self.page.placeholders.get(slot="content"),
-            "SnippetPlugin",
-            "en",
+        SnippetPtr.objects.create(
             snippet=snippet,
         )
-        self.page.publish("en")
-        self.assertEqual(plugin.snippet.name, "plugin_snippet")
-        self.assertEqual(plugin.snippet.html, "<p>Hello World</p>")
-        self.assertEqual(plugin.snippet.slug, "plugin_snippet")
-
-        with self.login_user_context(self.superuser):
-            response = self.client.get(self.page.get_absolute_url('en'))
-
-        self.assertIn(b"<p>Hello World</p>", response.content)
-
-    def test_file_rendering(self):
-        template = "snippet.html"
-        snippet = Snippet.objects.create(
-            name="plugin_snippet",
-            template=template,
-            slug="plugin_snippet",
-        )
-        plugin = add_plugin(
-            self.page.placeholders.get(slot="content"),
-            "SnippetPlugin",
-            "en",
-            snippet=snippet,
-        )
-        self.page.publish("en")
-        self.assertEqual(plugin.snippet.name, "plugin_snippet")
-        self.assertEqual(plugin.snippet.slug, "plugin_snippet")
-
-        with self.login_user_context(self.superuser):
-            response = self.client.get(self.page.get_absolute_url('en'))
-
-        self.assertNotIn("Template {} does not exist".format(template).encode(), response.content)
-        self.assertNotIn(b"context must be a dict rather than Context", response.content)
-        self.assertNotIn(b"context must be a dict rather than PluginContext", response.content)
-        self.assertContains(response, "<p>Hello World Template</p>")
+        instance = SnippetPtr.objects.all()
+        self.assertEqual(instance.count(), 1)
+        instance = SnippetPtr.objects.first()
+        # test strings
+        self.assertEqual(str(instance), "test snippet")

tests/test_plugins.py

@@ -0,0 +1,123 @@
+# -*- coding: utf-8 -*-
+from cms.api import add_plugin, create_page
+from cms.test_utils.testcases import CMSTestCase
+
+from djangocms_snippet.models import Snippet
+
+
+class SnippetPluginsTestCase(CMSTestCase):
+
+    def setUp(self):
+        self.language = "en"
+        self.home = create_page(
+            title="home",
+            template="page.html",
+            language=self.language,
+        )
+        self.home.publish(self.language)
+        self.page = create_page(
+            title="help",
+            template="page.html",
+            language=self.language,
+        )
+        self.page.publish(self.language)
+        self.placeholder = self.page.placeholders.get(slot="content")
+        self.superuser = self.get_superuser()
+
+    def tearDown(self):
+        self.page.delete()
+        self.home.delete()
+        self.superuser.delete()
+
+    def test_html_rendering(self):
+        request_url = self.page.get_absolute_url(self.language) + "?toolbar_off=true"
+        snippet = Snippet.objects.create(
+            name="plugin_snippet",
+            html="<p>Hello World</p>",
+            slug="plugin_snippet",
+        )
+        plugin = add_plugin(
+            self.page.placeholders.get(slot="content"),
+            "SnippetPlugin",
+            self.language,
+            snippet=snippet,
+        )
+        self.page.publish(self.language)
+        self.assertEqual(plugin.snippet.name, "plugin_snippet")
+        self.assertEqual(plugin.snippet.html, "<p>Hello World</p>")
+        self.assertEqual(plugin.snippet.slug, "plugin_snippet")
+
+        with self.login_user_context(self.superuser):
+            response = self.client.get(request_url)
+
+        self.assertIn(b"<p>Hello World</p>", response.content)
+
+    def test_failing_html_rendering(self):
+        request_url = self.page.get_absolute_url(self.language) + "?toolbar_off=true"
+        snippet = Snippet.objects.create(
+            name="plugin_snippet",
+            html="{% import weirdness %}",
+            slug="plugin_snippet",
+        )
+        add_plugin(
+            self.page.placeholders.get(slot="content"),
+            "SnippetPlugin",
+            self.language,
+            snippet=snippet,
+        )
+        self.page.publish(self.language)
+
+        with self.login_user_context(self.superuser):
+            response = self.client.get(request_url)
+
+        self.assertContains(response, "Invalid block tag on line 1")
+        self.assertContains(response, "Did you forget to register or load this tag?")
+
+    def test_template_rendering(self):
+        request_url = self.page.get_absolute_url(self.language) + "?toolbar_off=true"
+        template = "snippet.html"
+        snippet = Snippet.objects.create(
+            name="plugin_snippet",
+            template=template,
+            slug="plugin_snippet",
+        )
+        snippet.save()
+        plugin = add_plugin(
+            self.page.placeholders.get(slot="content"),
+            "SnippetPlugin",
+            self.language,
+            snippet=snippet,
+        )
+        self.page.publish(self.language)
+        self.assertEqual(plugin.snippet.name, "plugin_snippet")
+        self.assertEqual(plugin.snippet.slug, "plugin_snippet")
+
+        with self.login_user_context(self.superuser):
+            response = self.client.get(request_url)
+
+        self.assertNotIn("Template {} does not exist".format(template).encode(), response.content)
+        self.assertNotIn(b"context must be a dict rather than Context", response.content)
+        self.assertNotIn(b"context must be a dict rather than PluginContext", response.content)
+        self.assertContains(response, "<p>Hello World Template</p>")
+
+    def test_failing_template_rendering(self):
+        request_url = self.page.get_absolute_url(self.language) + "?toolbar_off=true"
+        template = "some_template"
+        snippet = Snippet.objects.create(
+            name="plugin_snippet",
+            template=template,
+            slug="plugin_snippet",
+        )
+        snippet.save()
+        add_plugin(
+            self.page.placeholders.get(slot="content"),
+            "SnippetPlugin",
+            self.language,
+            snippet=snippet,
+        )
+        self.page.publish(self.language)
+
+        with self.login_user_context(self.superuser):
+            response = self.client.get(request_url)
+
+        self.assertContains(response, "Template some_template does not exist")