hello world
", + slug="test_snippet", + ) + self.snippet.versions.last().publish(user=self.get_superuser()) + self.snippet_grouper = self.snippet.snippet_grouper + SnippetPluginFactory(snippet_grouper=self.snippet_grouper, language=["en"]) def test_settings(self): self.assertEqual(SEARCH_ENABLED, False) def test_snippet_instance(self): - Snippet.objects.create( - name="test snippet", - html="hello world
", - slug="test_snippet", - ) instance = Snippet.objects.all() + self.assertEqual(instance.count(), 1) + instance = Snippet.objects.first() + self.assertEqual(instance.name, "test snippet") self.assertEqual(instance.html, "hello world
") self.assertEqual(instance.slug, "test_snippet") @@ -30,16 +34,11 @@ def test_snippet_instance(self): self.assertEqual(str(instance), "test snippet") def test_snippet_ptr_instance(self): - snippet = Snippet.objects.create( - name="test snippet", - html="hello world
", - slug="test_snippet", - ) - SnippetPtr.objects.create( - snippet=snippet, - ) instance = SnippetPtr.objects.all() + self.assertEqual(instance.count(), 1) + instance = SnippetPtr.objects.first() + # test strings self.assertEqual(str(instance), "test snippet") diff --git a/tests/test_plugins.py b/tests/test_plugins.py index 2e971d10..db1a0fe3 100644 --- a/tests/test_plugins.py +++ b/tests/test_plugins.py @@ -1,46 +1,70 @@ from cms.api import add_plugin, create_page from cms.test_utils.testcases import CMSTestCase -from djangocms_snippet.models import Snippet +from .utils.factories import ( + SnippetWithVersionFactory, +) class SnippetPluginsTestCase(CMSTestCase): def setUp(self): self.language = "en" + self.superuser = self.get_superuser() self.home = create_page( title="home", template="page.html", language=self.language, + created_by=self.superuser, ) self.page = create_page( title="help", template="page.html", language=self.language, + created_by=self.superuser, ) - self.pagecontent = self.page.pagecontent_set.first() - self.placeholder = self.pagecontent.placeholders.get(slot="content") - self.superuser = self.get_superuser() + # Publish our page content + self._publish(self.page) + self._publish(self.home) + self.pagecontent = self.page.pagecontent_set.last() + self.home_pagecontent = self.page.pagecontent_set.last() def tearDown(self): self.page.delete() self.home.delete() self.superuser.delete() + def _publish(self, grouper, language=None): + from djangocms_versioning.constants import DRAFT + version = self._get_version(grouper, DRAFT, language) + version.publish(self.superuser) + + def _get_version(self, grouper, version_state, language=None): + language = language or self.language + + from djangocms_versioning.models import Version + versions = Version.objects.filter_by_grouper(grouper).filter(state=version_state) + for version in versions: + if hasattr(version.content, 'language') and version.content.language == language: + return version + def test_html_rendering(self): - request_url = self.page.get_absolute_url(self.language) + "?toolbar_off=true" - snippet = Snippet.objects.create( + snippet = SnippetWithVersionFactory( name="plugin_snippet", html="Hello World
", slug="plugin_snippet", ) + snippet_grouper = snippet.snippet_grouper plugin = add_plugin( self.pagecontent.placeholders.get(slot="content"), "SnippetPlugin", self.language, - snippet=snippet, + snippet_grouper=snippet_grouper, ) + snippet.versions.last().publish(user=self.get_superuser()) + request_url = self.page.get_absolute_url("en") + self.assertEqual(plugin.snippet.name, "plugin_snippet") self.assertEqual(plugin.snippet.html, "Hello World
") self.assertEqual(plugin.snippet.slug, "plugin_snippet") @@ -52,16 +76,19 @@ def test_html_rendering(self): def test_failing_html_rendering(self): request_url = self.page.get_absolute_url(self.language) + "?toolbar_off=true" - snippet = Snippet.objects.create( + snippet = SnippetWithVersionFactory( name="plugin_snippet", html="{% import weirdness %}", slug="plugin_snippet", ) + snippet_grouper = snippet.snippet_grouper + snippet.versions.last().publish(user=self.get_superuser()) + add_plugin( self.pagecontent.placeholders.get(slot="content"), "SnippetPlugin", self.language, - snippet=snippet, + snippet_grouper=snippet_grouper, ) with self.login_user_context(self.superuser): @@ -71,20 +98,22 @@ def test_failing_html_rendering(self): 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" + request_url = self.page.get_absolute_url() template = "snippet.html" - snippet = Snippet.objects.create( + snippet = SnippetWithVersionFactory( name="plugin_snippet", template=template, slug="plugin_snippet", ) - snippet.save() + snippet_grouper = snippet.snippet_grouper + snippet.versions.last().publish(user=self.get_superuser()) plugin = add_plugin( self.pagecontent.placeholders.get(slot="content"), "SnippetPlugin", self.language, - snippet=snippet, + snippet_grouper=snippet_grouper, ) + self.assertEqual(plugin.snippet.name, "plugin_snippet") self.assertEqual(plugin.snippet.slug, "plugin_snippet") @@ -99,17 +128,18 @@ def test_template_rendering(self): 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( + snippet = SnippetWithVersionFactory( name="plugin_snippet", template=template, slug="plugin_snippet", ) - snippet.save() + snippet_grouper = snippet.snippet_grouper + snippet.versions.last().publish(user=self.get_superuser()) add_plugin( self.pagecontent.placeholders.get(slot="content"), "SnippetPlugin", self.language, - snippet=snippet, + snippet_grouper=snippet_grouper, ) with self.login_user_context(self.superuser): diff --git a/tests/test_templatetags.py b/tests/test_templatetags.py index b1bb45b5..468a7408 100644 --- a/tests/test_templatetags.py +++ b/tests/test_templatetags.py @@ -1,22 +1,23 @@ from django.core.exceptions import ObjectDoesNotExist from django.template import Context, Template from django.template.exceptions import TemplateSyntaxError -from django.test import TestCase -from djangocms_snippet.models import Snippet, SnippetPtr +from cms.test_utils.testcases import CMSTestCase +from .utils.factories import SnippetPluginFactory, SnippetWithVersionFactory -class SnippetTemplateTagTestCase(TestCase): + +class SnippetTemplateTagTestCase(CMSTestCase): def test_html_rendered(self): - snippet = Snippet.objects.create( + snippet = SnippetWithVersionFactory( name="test snippet", html="hello {{ title }}
", slug="test_snippet", ) - SnippetPtr.objects.create( - snippet=snippet, - ) + snippet.versions.last().publish(user=self.get_superuser()) + snippet_grouper = snippet.snippet_grouper + SnippetPluginFactory(snippet_grouper=snippet_grouper, language=["en"]) context = Context({"title": "world"}) template_to_render = Template( @@ -24,6 +25,7 @@ def test_html_rendered(self): '{% snippet_fragment "test_snippet" %}' ) rendered_template = template_to_render.render(context) + self.assertInHTML('hello world
', rendered_template) # test html errors @@ -38,14 +40,15 @@ def test_html_rendered(self): def test_template_rendered(self): template = "snippet.html" - snippet = Snippet.objects.create( + snippet = SnippetWithVersionFactory( name="test snippet", + html="hello {{ title }}
", template=template, slug="test_snippet", ) - SnippetPtr.objects.create( - snippet=snippet, - ) + snippet.versions.last().publish(user=self.get_superuser()) + snippet_grouper = snippet.snippet_grouper + SnippetPluginFactory(snippet_grouper=snippet_grouper, language=["en"]) # use a string to identify context = Context({}) @@ -76,14 +79,15 @@ def test_template_rendered(self): def test_template_errors(self): template = "does_not_exist.html" - snippet = Snippet.objects.create( + snippet = SnippetWithVersionFactory( name="test snippet", + html="hello {{ title }}
", template=template, slug="test_snippet", ) - SnippetPtr.objects.create( - snippet=snippet, - ) + snippet.versions.last().publish(user=self.get_superuser()) + snippet_grouper = snippet.snippet_grouper + SnippetPluginFactory(snippet_grouper=snippet_grouper, language=["en"]) context = Context({}) template_to_render = Template( diff --git a/tests/utils/factories.py b/tests/utils/factories.py new file mode 100644 index 00000000..9d6210c6 --- /dev/null +++ b/tests/utils/factories.py @@ -0,0 +1,124 @@ +import string + +from django.contrib.auth.models import User +from django.contrib.contenttypes.models import ContentType + +from cms.models import Placeholder + +import factory +from djangocms_versioning.models import Version +from factory.fuzzy import FuzzyInteger, FuzzyText + +from djangocms_snippet.models import Snippet, SnippetGrouper, SnippetPtr + + +class UserFactory(factory.django.DjangoModelFactory): + username = FuzzyText(length=12) + first_name = factory.Faker("first_name") + last_name = factory.Faker("last_name") + email = factory.LazyAttribute( + lambda u: "%s.%s@example.com" % (u.first_name.lower(), u.last_name.lower()) + ) + + class Meta: + model = User + + @classmethod + def _create(cls, model_class, *args, **kwargs): + """Override the default ``_create`` with our custom call.""" + manager = cls._get_manager(model_class) + # The default would use ``manager.create(*args, **kwargs)`` + return manager.create_user(*args, **kwargs) + + +class AbstractVersionFactory(factory.django.DjangoModelFactory): + object_id = factory.SelfAttribute("content.id") + content_type = factory.LazyAttribute( + lambda o: ContentType.objects.get_for_model(o.content) + ) + created_by = factory.SubFactory(UserFactory) + + class Meta: + exclude = ["content"] + abstract = True + + +class PlaceholderFactory(factory.django.DjangoModelFactory): + default_width = FuzzyInteger(0, 25) + slot = FuzzyText(length=2, chars=string.digits) + # NOTE: When using this factory you will probably want to set + # the source field manually + + class Meta: + model = Placeholder + + +class SnippetGrouperFactory(factory.django.DjangoModelFactory): + + class Meta: + model = SnippetGrouper + + +class AbstractSnippetFactory(factory.django.DjangoModelFactory): + name = FuzzyText(length=12) + slug = FuzzyText(length=12) + snippet_grouper = factory.SubFactory(SnippetGrouperFactory) + html = "" + template = "" + + class Meta: + abstract = True + + +class SnippetFactory(AbstractSnippetFactory): + class Meta: + model = Snippet + + +class SnippetVersionFactory(AbstractVersionFactory): + content = factory.SubFactory(SnippetFactory) + + class Meta: + model = Version + + +class SnippetWithVersionFactory(AbstractSnippetFactory): + @factory.post_generation + def version(self, create, extracted, **kwargs): + # NOTE: Use this method as below to define version attributes: + # PageContentWithVersionFactory(version__label='label1') + if not create: + # Simple build, do nothing. + return + SnippetVersionFactory(content=self, **kwargs) + + class Meta: + model = Snippet + + +def get_plugin_position(plugin): + """Helper function to correctly calculate the plugin position. + Use this in plugin factory classes + """ + offset = plugin.placeholder.get_last_plugin_position(plugin.language) or 0 + return offset + 1 + + +def get_plugin_language(plugin): + """Helper function to get the language from a plugin's relationships. + Use this in plugin factory classes + """ + if plugin.placeholder.source: + return plugin.placeholder.source.language + + +class SnippetPluginFactory(factory.django.DjangoModelFactory): + plugin_type = "SnippetPlugin" + parent = None + snippet_grouper = factory.SubFactory(SnippetGrouperFactory) + placeholder = factory.SubFactory(PlaceholderFactory) + position = factory.LazyAttribute(get_plugin_position) + language = factory.LazyAttribute(get_plugin_language) + + class Meta: + model = SnippetPtr