Increased test coverage (#42)

* improve test coverage

* fix flake

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:
@@ -27,8 +28,6 @@ matrix:
       env: DJANGO='dj22' CMS='cms37'
     - python: 3.7
       env: DJANGO='dj22' CMS='cms37'
-      dist: xenial
-      sudo: true
 
 install:
   - pip install coverage isort tox

CHANGELOG.rst

@@ -3,6 +3,13 @@ Changelog
 =========
 
 
+2.3.1 (unreleased)
+==================
+
+* Added further tests to raise coverage
+* Fixed smaller issues found during testing
+
+
 2.3.0 (2019-04-30)
 ==================
 

LICENSE.txt renamed to LICENSE

@@ -1,4 +1,4 @@
-include LICENSE.txt
+include LICENSE
 include README.rst
 recursive-include djangocms_file/locale *
 recursive-include djangocms_file/templates *

MANIFEST.in

@@ -13,7 +13,7 @@ def migrate_to_filer(apps, schema_editor):
     FileInstance = apps.get_model('djangocms_file', 'File')
     plugins = FileInstance.objects.all()
 
-    for plugin in plugins:
+    for plugin in plugins:  # pragma: no cover
         if plugin.file:
             filesrc = File.objects.get_or_create(
                 file=plugin.file.file,

djangocms_file/migrations/0006_migrate_to_filer.py

@@ -0,0 +1,123 @@
+import os
+from tempfile import mkdtemp
+
+from django.core.files import File
+
+from filer.models.filemodels import File as FilerFile
+from filer.models.foldermodels import Folder as FilerFolder
+from filer.models.imagemodels import Image as FilerImage
+from filer.utils.compatibility import PILImage, PILImageDraw
+
+
+# from https://github.com/divio/django-filer/blob/develop/tests/helpers.py#L46-L52
+def create_image(mode="RGB", size=(800, 600)):
+    """
+    Creates a usable image file using PIL
+    :returns: PIL Image instance
+    """
+    image = PILImage.new(mode, size)
+    draw = PILImageDraw.Draw(image)
+    x_bit, y_bit = size[0] // 10, size[1] // 10
+    draw.rectangle((x_bit, y_bit * 2, x_bit * 7, y_bit * 3), "red")
+    draw.rectangle((x_bit * 2, y_bit, x_bit * 3, y_bit * 8), "red")
+
+    return image
+
+
+def get_image(image_name="test_file.jpg"):
+    """
+    Creates and stores an image to the file system using PILImage
+
+    :param image_name: the name for the file (default "test_file.jpg")
+    :returns: dict {name, image, path}
+    """
+    image = create_image()
+    image_path = os.path.join(
+        mkdtemp(),
+        image_name,
+    )
+    image.save(image_path, "JPEG")
+
+    return {
+        "name": image_name,
+        "image": image,
+        "path": image_path,
+    }
+
+
+def get_file(file_name="test_file.pdf"):
+    """
+    Creates and stores an arbitrary file into a temporary dir
+
+    :param file_name: the name for the file (default "test_file.pdf")
+    :returns: dict {name, image, path}
+    """
+    file_path = os.path.join(
+        mkdtemp(),
+        file_name,
+    )
+    data = open(file_path, "a")
+
+    return {
+        "name": file_name,
+        "file": data,
+        "path": file_path,
+    }
+
+
+def get_filer_image(image_name="test_file.jpg"):
+    """
+    Creates and stores an image to filer and returns it
+
+    :param image_name: the name for the file (default "test_file.jpg")
+    :returns: filer image instance
+    """
+    image = get_image(image_name)
+    filer_file = File(
+        open(image.get("path"), "rb"),
+        name=image.get("name"),
+    )
+    filer_object = FilerImage.objects.create(
+        original_filename=image.get("name"),
+        file=filer_file,
+    )
+
+    return filer_object
+
+
+def get_filer_file(file_name="test_file.pdf", folder=None):
+    """
+    Creates and stores a file to filer and returns it
+
+    :param file_name: the name for the file (default "test_file.pdf")
+    :param folder: optionally provide a folder instance
+    :returns: filer file instance
+    """
+    data = get_file(file_name)
+    filer_file = File(
+        open(data.get("path"), "rb"),
+        name=data.get("name"),
+    )
+    filer_object = FilerFile.objects.create(
+        original_filename=data.get("name"),
+        file=filer_file,
+        folder=folder,
+    )
+
+    return filer_object
+
+
+def get_filer_folder(folder_name="test_folder", parent=None):
+    """
+    Creates and returns a filer folder
+
+    :param folder_name: the name of the folder to be used (default "folder_name")
+    :param parent: optionally provide a parent folder
+    :returns: filer folder instance
+    """
+    filer_object = FilerFolder.objects.create(
+        parent=parent,
+        name=folder_name,
+    )
+
+    return filer_object

tests/helpers.py

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

tests/requirements.txt

@@ -1,37 +1,108 @@
 # -*- coding: utf-8 -*-
+from django.conf import settings
 from django.test import TestCase
 
-from filer.models import File as FilerFile
-from filer.models import Folder as FilerFolder
+from djangocms_file.models import LINK_TARGET, File, Folder, get_templates
 
-from djangocms_file.models import File
+from .helpers import get_filer_file, get_filer_folder
 
 
-class FileTestCase(TestCase):
+class CommonModelTestCase(TestCase):
+
+    def test_settings(self):
+        self.assertEqual(get_templates(), [('default', 'Default')])
+        settings.DJANGOCMS_FILE_TEMPLATES = [('feature', 'Feature')]
+        self.assertEqual(get_templates(), [('default', 'Default'), ('feature', 'Feature')])
+
+
+class FileModelTestCase(TestCase):
 
     def setUp(self):
-        filer_file = FilerFile.objects.create(
-            file='test.jpg',
-        )
-        File.objects.create(
-            file_src=filer_file,
-            file_name='test',
-        )
+        self.file = get_filer_file()
+
+    def tearDown(self):
+        if self.file:
+            self.file.delete()
+            del self.file
+            with self.assertRaises(AttributeError):
+                print(self.file)
+        File.objects.filter(pk=1).delete()
+        self.assertEqual(File.objects.all().count(), 0)
 
     def test_file_instance(self):
-        """File instance has been created"""
-        test_file = File.objects.get(file_name='test')
-        self.assertEqual(test_file.file_name, 'test')
+        File.objects.create(
+            template="default",
+            file_src=self.file,
+            file_name="some file",
+            link_target=LINK_TARGET[0][0],
+            link_title="some link title",
+            show_file_size=True,
+            attributes="{'data-type', 'file'}",
+        )
+        instance = File.objects.all()
+        self.assertEqual(len(instance), 1)
+        instance = File.objects.get(pk=1)
+        self.assertEqual(instance.template, "default")
+        self.assertEqual(instance.file_src, self.file)
+        self.assertEqual(instance.file_name, "some file")
+        self.assertEqual(instance.link_target, "_self")
+        self.assertEqual(instance.show_file_size, True)
+        self.assertEqual(instance.attributes, "{'data-type', 'file'}")
+        # old copy relation and test methods
+        instance.copy_relations(instance)
+        self.assertEqual(instance.__str__(), "test_file.pdf")
+        self.assertEqual(instance.get_short_description(), "some file")
+        instance.file_name = None
+        self.assertEqual(instance.get_short_description(), "test_file.pdf")
+        instance.file_src = None
+        self.assertEqual(instance.__str__(), "1")
+        self.assertEqual(instance.get_short_description(), "<file is missing>")
 
 
-class FolderTestCase(TestCase):
+class FolderModelTestCase(TestCase):
 
     def setUp(self):
-        FilerFolder.objects.create(
-            name='test',
-        )
+        self.folder = get_filer_folder()
+        self.file = get_filer_file()
+
+    def tearDown(self):
+        if self.file:
+            self.file.delete()
+            del self.file
+            with self.assertRaises(AttributeError):
+                print(self.file)
+        Folder.objects.filter(pk=1).delete()
+        self.assertEqual(File.objects.all().count(), 0)
 
     def test_folder_instance(self):
-        """Folder instance has been created"""
-        test_folder = FilerFolder.objects.get(name='test')
-        self.assertEqual(test_folder.name, 'test')
+        Folder.objects.create(
+            template="default",
+            folder_src=self.folder,
+            link_target=LINK_TARGET[0][0],
+            show_file_size=True,
+            attributes="{'data-type', 'folder'}",
+        )
+        instance = Folder.objects.all()
+        self.assertEqual(len(instance), 1)
+        instance = Folder.objects.get(pk=1)
+        self.assertEqual(instance.template, "default")
+        self.assertEqual(instance.folder_src, self.folder)
+        self.assertEqual(instance.link_target, "_self")
+        self.assertEqual(instance.show_file_size, True)
+        self.assertEqual(instance.attributes, "{'data-type', 'folder'}")
+        # old copy relation and test methods
+        instance.copy_relations(instance)
+        self.assertEqual(instance.__str__(), "test_folder")
+        self.assertEqual(instance.get_short_description(), "test_folder")
+        instance.folder_src = None
+        self.assertEqual(instance.__str__(), "1")
+        self.assertEqual(instance.get_short_description(), "<folder is missing>")
+        # get files
+        self.assertEqual(instance.get_files(), [])
+        self.file = get_filer_file(
+            folder=self.folder
+        )
+        instance = Folder.objects.create(
+            folder_src=self.folder,
+        )
+        self.assertEqual(instance.get_files(), [self.file])