import copy
from django import VERSION
from django.contrib.auth.models import User
from django.test import TestCase
from ..models import Gallery, Photo
from .factories import (IGNORED_FILES_ZIP_PATH, LANDSCAPE_IMAGE_PATH, SAMPLE_NOT_IMAGE_ZIP_PATH, SAMPLE_ZIP_PATH,
GalleryFactory, PhotoFactory)
class GalleryUploadTest(TestCase):
"""Testing the admin page that allows users to upload zips."""
def setUp(self):
super().setUp()
user = User.objects.create_user('john.doe',
'john.doe@example.com',
'secret')
user.is_staff = True
user.save()
self.assertTrue(self.client.login(username='john.doe', password='secret'))
self.zip_file = open(SAMPLE_ZIP_PATH, mode='rb')
self.sample_form_data = {'zip_file': self.zip_file,
'title': 'This is a test title'}
def tearDown(self):
super().tearDown()
self.zip_file.close()
for photo in Photo.objects.all():
photo.delete()
def test_get(self):
"""We can get the custom admin page."""
response = self.client.get('/admin/photologue/photo/upload_zip/')
self.assertEqual(response.status_code, 200)
self.assertTemplateUsed(response, 'admin/photologue/photo/upload_zip.html')
self.assertContains(response, 'Upload a zip archive of photos')
def test_breadcrumbs(self):
"""Quick check that the breadcrumbs are generated correctly."""
response = self.client.get('/admin/photologue/photo/upload_zip/')
self.assertContains(
response, """<div class="breadcrumbs"><a href="/admin/">Home</a> ›
<a href="/admin/photologue/">Photologue</a> › Photos › Upload </div>""", html=True)
def test_missing_fields(self):
"""Missing fields mean the form is redisplayed with errors."""
test_data = copy.copy(self.sample_form_data)
del test_data['zip_file']
response = self.client.post('/admin/photologue/photo/upload_zip/', test_data)
self.assertEqual(response.status_code, 200)
self.assertTrue(response.context['form'].errors)
def test_good_data(self):
"""Upload a zip with a single file it it: 'sample.jpg'.
It gets assigned to a newly created gallery 'Test'."""
test_data = copy.copy(self.sample_form_data)
response = self.client.post('/admin/photologue/photo/upload_zip/', test_data)
# The redirect Location has changed in Django 1.9 - it used to be an absolute URI, now it returns
# a relative one.
if VERSION[0] == 1 and VERSION[1] <= 8:
location = 'http://testserver/admin/photologue/photo/'
else:
location = '..'
self.assertEqual(response['Location'], location)
self.assertQuerysetEqual(Gallery.objects.all(),
['<Gallery: This is a test title>'],
transform=repr)
self.assertQuerysetEqual(Photo.objects.all(),
['<Photo: This is a test title 1>'],
transform=repr)
# The photo is attached to the gallery.
gallery = Gallery.objects.get(title='This is a test title')
self.assertQuerysetEqual(gallery.photos.all(),
['<Photo: This is a test title 1>'],
transform=repr)
def test_duplicate_gallery(self):
"""If we try to create a Gallery with a title that duplicates an existing title, refuse to load."""
GalleryFactory(title='This is a test title')
test_data = copy.copy(self.sample_form_data)
response = self.client.post('/admin/photologue/photo/upload_zip/', test_data)
self.assertEqual(response.status_code, 200)
self.assertTrue(response.context['form']['title'].errors)
def test_title_or_gallery(self):
"""We should supply either a title field or a gallery."""
test_data = copy.copy(self.sample_form_data)
del test_data['title']
response = self.client.post('/admin/photologue/photo/upload_zip/', test_data)
self.assertEqual(list(response.context['form'].non_field_errors()),
['Select an existing gallery, or enter a title for a new gallery.'])
def test_not_image(self):
"""A zip with a file of the wrong format (.txt).
That file gets ignored."""
test_data = copy.copy(self.sample_form_data)
with open(SAMPLE_NOT_IMAGE_ZIP_PATH, mode='rb') as f:
test_data['zip_file'] = f
response = self.client.post('/admin/photologue/photo/upload_zip/', test_data)
self.assertEqual(response.status_code, 302)
self.assertQuerysetEqual(Gallery.objects.all(),
['<Gallery: This is a test title>'],
transform=repr)
self.assertQuerysetEqual(Photo.objects.all(),
['<Photo: This is a test title 1>'],
transform=repr)
def test_ignored(self):
"""Ignore anything that does not look like a image file.
E.g. hidden files, and folders.
We have two images: one in the top level of the zip, and one in a subfolder.
The second one gets ignored - we only process files at the zip root."""
test_data = copy.copy(self.sample_form_data)
with open(IGNORED_FILES_ZIP_PATH, mode='rb') as f:
test_data['zip_file'] = f
response = self.client.post('/admin/photologue/photo/upload_zip/', test_data)
self.assertEqual(response.status_code, 302)
self.assertQuerysetEqual(Gallery.objects.all(),
['<Gallery: This is a test title>'],
transform=repr)
self.assertQuerysetEqual(Photo.objects.all(),
['<Photo: This is a test title 1>'],
transform=repr)
def test_existing_gallery(self):
"""Add the photos in the zip to an existing gallery."""
existing_gallery = GalleryFactory(title='Existing')
test_data = copy.copy(self.sample_form_data)
test_data['gallery'] = existing_gallery.id
del test_data['title']
response = self.client.post('/admin/photologue/photo/upload_zip/', test_data)
self.assertEqual(response.status_code, 302)
self.assertQuerysetEqual(Gallery.objects.all(),
['<Gallery: Existing>'],
transform=repr)
self.assertQuerysetEqual(Photo.objects.all(),
['<Photo: Existing 1>'],
transform=repr)
# The photo is attached to the existing gallery.
self.assertQuerysetEqual(existing_gallery.photos.all(),
['<Photo: Existing 1>'],
transform=repr)
def test_existing_gallery_custom_title(self):
"""Add the photos in the zip to an existing gallery, but specify a
custom title for the photos."""
existing_gallery = GalleryFactory(title='Existing')
test_data = copy.copy(self.sample_form_data)
test_data['gallery'] = existing_gallery.id
test_data['title'] = 'Custom title'
response = self.client.post('/admin/photologue/photo/upload_zip/', test_data)
self.assertEqual(response.status_code, 302)
self.assertQuerysetEqual(Photo.objects.all(),
['<Photo: Custom title 1>'],
transform=repr)
def test_duplicate_slug(self):
"""Uploading a zip, but a photo already exists with the target slug."""
PhotoFactory(title='This is a test title 1')
PhotoFactory(title='This is a test title 2')
test_data = copy.copy(self.sample_form_data)
response = self.client.post('/admin/photologue/photo/upload_zip/', test_data)
self.assertEqual(response.status_code, 302)
self.assertQuerysetEqual(Photo.objects.all(),
[
'<Photo: This is a test title 1>',
'<Photo: This is a test title 2>',
'<Photo: This is a test title 3>'
],
ordered=False,
transform=repr)
def test_bad_zip(self):
"""Supplied file is not a zip file - tell user."""
test_data = copy.copy(self.sample_form_data)
with open(LANDSCAPE_IMAGE_PATH, mode='rb') as f:
test_data['zip_file'] = f
response = self.client.post('/admin/photologue/photo/upload_zip/', test_data)
self.assertEqual(response.status_code, 200)
self.assertTrue(response.context['form']['zip_file'].errors)