Linting and additional test case

Author: adam-murray

djangocms_snippet/cms_config.py

@@ -1,7 +1,6 @@
 from django.conf import settings
 
 from cms.app_base import CMSAppConfig
-from cms.views import render_object_preview
 
 from djangocms_snippet.models import Snippet
 from djangocms_snippet.rendering import render_snippet
@@ -24,7 +23,7 @@ class SnippetCMSAppConfig(CMSAppConfig):
     )
 
     cms_enabled = True
-    cms_toolbar_enabled_models = [(Snippet, render_snippet),]
+    cms_toolbar_enabled_models = [(Snippet, render_snippet), ]
 
     if djangocms_moderation_enabled and djangocms_moderation_installed:
         moderated_models = [Snippet]

djangocms_snippet/urls.py

@@ -1,7 +1,4 @@
 from django.conf.urls import url
-from django.urls import include, path
-
-from cms.views import render_object_preview
 
 from djangocms_snippet.models import Snippet
 from djangocms_snippet.views import SnippetPreviewView

djangocms_snippet/views.py

@@ -1,4 +1,4 @@
-from django.shortcuts import get_object_or_404
+from django.http import Http404
 from django.views.generic import TemplateView
 
 from djangocms_snippet.models import Snippet
@@ -9,8 +9,12 @@ class SnippetPreviewView(TemplateView):
 
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
-        snippet_qs = Snippet._base_manager.filter(pk=self.kwargs.get("snippet_id"))
-        snippet = snippet_qs[0]
+
+        try:
+            snippet = Snippet._base_manager.get(pk=self.kwargs.get("snippet_id"))
+        except Snippet.DoesNotExist:
+            raise Http404
+
         context.update({
             "snippet": snippet,
             "opts": Snippet._meta

tests/requirements/dj22_cms37.txt

@@ -7,16 +7,32 @@
 class PreviewViewTestCase(CMSTestCase):
     def setUp(self):
         self.snippet = SnippetWithVersionFactory(html="<h1>Test Title</h1><br><p>Test paragraph</p>")
-        self.preview_url = admin_reverse(
+        self.user = self.get_superuser()
+
+    def test_preview_renders_html(self):
+        """
+        Check that our snippet HTML is rendered, unescaped, on the page
+        """
+        preview_url = admin_reverse(
             "djangocms_snippet_snippet_preview",
             kwargs={"snippet_id": self.snippet.id},
         )
-
-    def test_preview_renders_html(self):
-        self.snippet.versions.last().publish(user=self.get_superuser())
-        with self.login_user_context(self.get_superuser()):
-            response = self.client.get(self.preview_url)
+        with self.login_user_context(self.user):
+            response = self.client.get(preview_url)
 
         self.assertEqual(self.snippet.html, "<h1>Test Title</h1><br><p>Test paragraph</p>")
         self.assertEqual(response.status_code, 200)
         self.assertContains(response, "<h1>Test Title</h1><br><p>Test paragraph</p>")
+
+    def test_preview_raises_404_no_snippet(self):
+        """
+        With no Snippet to preview, a 404 will be raised
+        """
+        preview_url = admin_reverse(
+            "djangocms_snippet_snippet_preview",
+            kwargs={"snippet_id": 999},  # Non existent PK!
+        )
+        with self.login_user_context(self.user):
+            response = self.client.get(preview_url)
+
+        self.assertEqual(response.status_code, 404)