fixed tests and defaults
[mediagoblin.git] / mediagoblin / tests / test_submission.py
index 7c3727451abfb7358fbf7c61b017d99a04730915..f6ecd58aaf0697919931dbf6a34272f0c63d2857 100644 (file)
@@ -1,5 +1,5 @@
 # GNU MediaGoblin -- federated, autonomous media hosting
-# Copyright (C) 2011 MediaGoblin contributors.  See AUTHORS.
+# Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import urlparse
-import pkg_resources
+import sys
+reload(sys)
+sys.setdefaultencoding('utf-8')
 
-from nose.tools import assert_equal, assert_true, assert_false
+import urlparse
+import os
+import pytest
 
-from mediagoblin.tests.tools import setup_fresh_app, get_test_app, \
-    fixture_add_user
+from mediagoblin.tests.tools import fixture_add_user
 from mediagoblin import mg_globals
-from mediagoblin.tools import template, common
+from mediagoblin.db.models import MediaEntry, User
+from mediagoblin.db.base import Session
+from mediagoblin.tools import template
+from mediagoblin.media_types.image import ImageMediaManager
+from mediagoblin.media_types.pdf.processing import check_prerequisites as pdf_check_prerequisites
+
+from .resources import GOOD_JPG, GOOD_PNG, EVIL_FILE, EVIL_JPG, EVIL_PNG, \
+    BIG_BLUE, GOOD_PDF, GPS_JPG, MED_PNG
 
-GOOD_JPG = pkg_resources.resource_filename(
-  'mediagoblin.tests', 'test_submission/good.jpg')
-GOOD_PNG = pkg_resources.resource_filename(
-  'mediagoblin.tests', 'test_submission/good.png')
-EVIL_FILE = pkg_resources.resource_filename(
-  'mediagoblin.tests', 'test_submission/evil')
-EVIL_JPG = pkg_resources.resource_filename(
-  'mediagoblin.tests', 'test_submission/evil.jpg')
-EVIL_PNG = pkg_resources.resource_filename(
-  'mediagoblin.tests', 'test_submission/evil.png')
+GOOD_TAG_STRING = u'yin,yang'
+BAD_TAG_STRING = unicode('rage,' + 'f' * 26 + 'u' * 26)
 
-GOOD_TAG_STRING = 'yin,yang'
-BAD_TAG_STRING = 'rage,' + 'f' * 26 + 'u' * 26
+FORM_CONTEXT = ['mediagoblin/submit/start.html', 'submit_form']
+REQUEST_CONTEXT = ['mediagoblin/user_pages/user.html', 'request']
 
 
 class TestSubmission:
-    def setUp(self):
-        self.test_app = get_test_app()
+    @pytest.fixture(autouse=True)
+    def setup(self, test_app):
+        self.test_app = test_app
 
         # TODO: Possibly abstract into a decorator like:
         # @as_authenticated_user('chris')
@@ -49,215 +51,352 @@ class TestSubmission:
 
         self.test_user = test_user
 
+        self.login()
+
+    def login(self):
         self.test_app.post(
             '/auth/login/', {
                 'username': u'chris',
                 'password': 'toast'})
 
+    def logout(self):
+        self.test_app.get('/auth/logout/')
+
+    def do_post(self, data, *context_keys, **kwargs):
+        url = kwargs.pop('url', '/submit/')
+        do_follow = kwargs.pop('do_follow', False)
+        template.clear_test_template_context()
+        response = self.test_app.post(url, data, **kwargs)
+        if do_follow:
+            response.follow()
+        context_data = template.TEMPLATE_TEST_CONTEXT
+        for key in context_keys:
+            context_data = context_data[key]
+        return response, context_data
+
+    def upload_data(self, filename):
+        return {'upload_files': [('file', filename)]}
+
+    def check_comments(self, request, media_id, count):
+        comments = request.db.MediaComment.query.filter_by(media_entry=media_id)
+        assert count == len(list(comments))
+
     def test_missing_fields(self):
         # Test blank form
         # ---------------
-        template.clear_test_template_context()
-        response = self.test_app.post(
-            '/submit/', {})
-        context = template.TEMPLATE_TEST_CONTEXT['mediagoblin/submit/start.html']
-        form = context['submit_form']
+        response, form = self.do_post({}, *FORM_CONTEXT)
         assert form.file.errors == [u'You must provide a file.']
 
         # Test blank file
         # ---------------
-        template.clear_test_template_context()
-        response = self.test_app.post(
-            '/submit/', {
-                'title': 'test title'})
-        context = template.TEMPLATE_TEST_CONTEXT['mediagoblin/submit/start.html']
-        form = context['submit_form']
+        response, form = self.do_post({'title': u'test title'}, *FORM_CONTEXT)
         assert form.file.errors == [u'You must provide a file.']
 
-
-    def test_normal_uploads(self):
-        # Test JPG
-        # --------
-        template.clear_test_template_context()
-        response = self.test_app.post(
-            '/submit/', {
-                'title': 'Normal upload 1'
-                }, upload_files=[(
-                    'file', GOOD_JPG)])
-
-        # User should be redirected
-        response.follow()
-        assert_equal(
-            urlparse.urlsplit(response.location)[2],
-            '/u/chris/')
-        assert template.TEMPLATE_TEST_CONTEXT.has_key(
-            'mediagoblin/user_pages/user.html')
-
-        # Test PNG
-        # --------
-        template.clear_test_template_context()
-        response = self.test_app.post(
-            '/submit/', {
-                'title': 'Normal upload 2'
-                }, upload_files=[(
-                    'file', GOOD_PNG)])
-
-        response.follow()
-        assert_equal(
-            urlparse.urlsplit(response.location)[2],
-            '/u/chris/')
-        assert template.TEMPLATE_TEST_CONTEXT.has_key(
-            'mediagoblin/user_pages/user.html')
+    def check_url(self, response, path):
+        assert urlparse.urlsplit(response.location)[2] == path
+
+    def check_normal_upload(self, title, filename):
+        response, context = self.do_post({'title': title}, do_follow=True,
+                                         **self.upload_data(filename))
+        self.check_url(response, '/u/{0}/'.format(self.test_user.username))
+        assert 'mediagoblin/user_pages/user.html' in context
+        # Make sure the media view is at least reachable, logged in...
+        url = '/u/{0}/m/{1}/'.format(self.test_user.username,
+                                     title.lower().replace(' ', '-'))
+        self.test_app.get(url)
+        # ... and logged out too.
+        self.logout()
+        self.test_app.get(url)
+
+    def user_upload_limits(self, uploaded=None, upload_limit=None):
+        if uploaded:
+            self.test_user.uploaded = uploaded
+        if upload_limit:
+            self.test_user.upload_limit = upload_limit
+
+        self.test_user.save()
+
+        # Reload
+        self.test_user = User.query.filter_by(
+            username=self.test_user.username
+        ).first()
+
+        # ... and detach from session:
+        Session.expunge(self.test_user)
+
+    def test_normal_jpg(self):
+        # User uploaded should be 0
+        assert self.test_user.uploaded == 0
+
+        self.check_normal_upload(u'Normal upload 1', GOOD_JPG)
+
+        # User uploaded should be the same as GOOD_JPG size in Mb
+        file_size = os.stat(GOOD_JPG).st_size / (1024.0 * 1024)
+        file_size = float('{0:.2f}'.format(file_size))
+
+        # Reload user
+        self.test_user = User.query.filter_by(
+            username=self.test_user.username
+        ).first()
+        assert self.test_user.uploaded == file_size
+
+    def test_normal_png(self):
+        self.check_normal_upload(u'Normal upload 2', GOOD_PNG)
+
+    @pytest.mark.skipif("not pdf_check_prerequisites()")
+    def test_normal_pdf(self):
+        response, context = self.do_post({'title': u'Normal upload 3 (pdf)'},
+                                         do_follow=True,
+                                         **self.upload_data(GOOD_PDF))
+        self.check_url(response, '/u/{0}/'.format(self.test_user.username))
+        assert 'mediagoblin/user_pages/user.html' in context
+
+    def test_default_upload_limits(self):
+        self.user_upload_limits(uploaded=500)
+
+        # User uploaded should be 500
+        assert self.test_user.uploaded == 500
+
+        response, context = self.do_post({'title': u'Normal upload 4'},
+                                         do_follow=True,
+                                         **self.upload_data(GOOD_JPG))
+        self.check_url(response, '/u/{0}/'.format(self.test_user.username))
+        assert 'mediagoblin/user_pages/user.html' in context
+
+        # Reload user
+        self.test_user = User.query.filter_by(
+            username=self.test_user.username
+        ).first()
+
+        # Shouldn't have uploaded
+        assert self.test_user.uploaded == 500
+
+    def test_user_upload_limit(self):
+        self.user_upload_limits(uploaded=25, upload_limit=25)
+
+        # User uploaded should be 25
+        assert self.test_user.uploaded == 25
+
+        response, context = self.do_post({'title': u'Normal upload 4'},
+                                         do_follow=True,
+                                         **self.upload_data(GOOD_JPG))
+        self.check_url(response, '/u/{0}/'.format(self.test_user.username))
+        assert 'mediagoblin/user_pages/user.html' in context
+
+        # Reload user
+        self.test_user = User.query.filter_by(
+            username=self.test_user.username
+        ).first()
+
+        # Shouldn't have uploaded
+        assert self.test_user.uploaded == 25
+
+    def test_user_under_limit(self):
+        self.user_upload_limits(uploaded=499)
+
+        # User uploaded should be 499
+        assert self.test_user.uploaded == 499
+
+        response, context = self.do_post({'title': u'Normal upload 6'},
+                                         do_follow=False,
+                                         **self.upload_data(MED_PNG))
+        form = context['mediagoblin/submit/start.html']['submit_form']
+        assert form.file.errors == [u'Sorry, uploading this file will put you'
+                                    ' over your upload limit.']
+
+        # Reload user
+        self.test_user = User.query.filter_by(
+            username=self.test_user.username
+        ).first()
+
+        # Shouldn't have uploaded
+        assert self.test_user.uploaded == 499
+
+        # Reload user
+        self.test_user = User.query.filter_by(
+            username=self.test_user.username
+        ).first()
+
+        # Shouldn't have uploaded
+        assert self.test_user.uploaded == 499
+
+    def check_media(self, request, find_data, count=None):
+        media = MediaEntry.query.filter_by(**find_data)
+        if count is not None:
+            assert media.count() == count
+            if count == 0:
+                return
+        return media[0]
 
     def test_tags(self):
         # Good tag string
         # --------
-        template.clear_test_template_context()
-        response = self.test_app.post(
-            '/submit/', {
-                'title': 'Balanced Goblin',
-                'tags': GOOD_TAG_STRING
-                }, upload_files=[(
-                    'file', GOOD_JPG)])
+        response, request = self.do_post({'title': u'Balanced Goblin 2',
+                                          'tags': GOOD_TAG_STRING},
+                                         *REQUEST_CONTEXT, do_follow=True,
+                                         **self.upload_data(GOOD_JPG))
+        media = self.check_media(request, {'title': u'Balanced Goblin 2'}, 1)
+        assert media.tags[0]['name'] == u'yin'
+        assert media.tags[0]['slug'] == u'yin'
 
-        # New media entry with correct tags should be created
-        response.follow()
-        context = template.TEMPLATE_TEST_CONTEXT['mediagoblin/user_pages/user.html']
-        request = context['request']
-        media = request.db.MediaEntry.find({'title': 'Balanced Goblin'})[0]
-        assert_equal(media['tags'],
-                     [{'name': u'yin', 'slug': u'yin'},
-                                            {'name': u'yang', 'slug': u'yang'}])
+        assert media.tags[1]['name'] == u'yang'
+        assert media.tags[1]['slug'] == u'yang'
 
         # Test tags that are too long
         # ---------------
-        template.clear_test_template_context()
-        response = self.test_app.post(
-            '/submit/', {
-                'title': 'Balanced Goblin',
-                'tags': BAD_TAG_STRING
-                }, upload_files=[(
-                    'file', GOOD_JPG)])
-
-        # Too long error should be raised
-        context = template.TEMPLATE_TEST_CONTEXT['mediagoblin/submit/start.html']
-        form = context['submit_form']
+        response, form = self.do_post({'title': u'Balanced Goblin 2',
+                                       'tags': BAD_TAG_STRING},
+                                      *FORM_CONTEXT,
+                                      **self.upload_data(GOOD_JPG))
         assert form.tags.errors == [
-            u'Tags must be shorter than 50 characters.  Tags that are too long'\
-             ': ffffffffffffffffffffffffffuuuuuuuuuuuuuuuuuuuuuuuuuu']
+                u'Tags must be shorter than 50 characters.  ' \
+                    'Tags that are too long: ' \
+                    'ffffffffffffffffffffffffffuuuuuuuuuuuuuuuuuuuuuuuuuu']
 
     def test_delete(self):
-        template.clear_test_template_context()
-        response = self.test_app.post(
-            '/submit/', {
-                'title': 'Balanced Goblin',
-                }, upload_files=[(
-                    'file', GOOD_JPG)])
-
-        # Post image
-        response.follow()
-
-        request = template.TEMPLATE_TEST_CONTEXT[
-            'mediagoblin/user_pages/user.html']['request']
-
-        media = request.db.MediaEntry.find({'title': 'Balanced Goblin'})[0]
-
-        # Does media entry exist?
-        assert_true(media)
+        self.user_upload_limits(uploaded=50)
+        response, request = self.do_post({'title': u'Balanced Goblin'},
+                                         *REQUEST_CONTEXT, do_follow=True,
+                                         **self.upload_data(GOOD_JPG))
+        media = self.check_media(request, {'title': u'Balanced Goblin'}, 1)
+        media_id = media.id
+
+        # render and post to the edit page.
+        edit_url = request.urlgen(
+            'mediagoblin.edit.edit_media',
+            user=self.test_user.username, media_id=media_id)
+        self.test_app.get(edit_url)
+        self.test_app.post(edit_url,
+            {'title': u'Balanced Goblin',
+             'slug': u"Balanced=Goblin",
+             'tags': u''})
+        media = self.check_media(request, {'title': u'Balanced Goblin'}, 1)
+        assert media.slug == u"balanced-goblin"
+
+        # Add a comment, so we can test for its deletion later.
+        self.check_comments(request, media_id, 0)
+        comment_url = request.urlgen(
+            'mediagoblin.user_pages.media_post_comment',
+            user=self.test_user.username, media_id=media_id)
+        response = self.do_post({'comment_content': 'i love this test'},
+                                url=comment_url, do_follow=True)[0]
+        self.check_comments(request, media_id, 1)
 
         # Do not confirm deletion
         # ---------------------------------------------------
-        response = self.test_app.post(
-            request.urlgen('mediagoblin.user_pages.media_confirm_delete',
-                           # No work: user=media.uploader().username,
-                           user=self.test_user.username,
-                           media=media._id),
-            # no value means no confirm
-            {})
-
-        response.follow()
-
-        request = template.TEMPLATE_TEST_CONTEXT[
-            'mediagoblin/user_pages/user.html']['request']
-
-        media = request.db.MediaEntry.find({'title': 'Balanced Goblin'})[0]
-
-        # Does media entry still exist?
-        assert_true(media)
+        delete_url = request.urlgen(
+            'mediagoblin.user_pages.media_confirm_delete',
+            user=self.test_user.username, media_id=media_id)
+        # Empty data means don't confirm
+        response = self.do_post({}, do_follow=True, url=delete_url)[0]
+        media = self.check_media(request, {'title': u'Balanced Goblin'}, 1)
+        media_id = media.id
 
         # Confirm deletion
         # ---------------------------------------------------
-        response = self.test_app.post(
-            request.urlgen('mediagoblin.user_pages.media_confirm_delete',
-                           # No work: user=media.uploader().username,
-                           user=self.test_user.username,
-                           media=media._id),
-            {'confirm': 'y'})
+        response, request = self.do_post({'confirm': 'y'}, *REQUEST_CONTEXT,
+                                         do_follow=True, url=delete_url)
+        self.check_media(request, {'id': media_id}, 0)
+        self.check_comments(request, media_id, 0)
 
-        response.follow()
+        # Reload user
+        self.test_user = User.query.filter_by(
+            username = self.test_user.username
+        ).first()
 
-        request = template.TEMPLATE_TEST_CONTEXT[
-            'mediagoblin/user_pages/user.html']['request']
+        # Check that user.uploaded is the same as before the upload
+        assert self.test_user.uploaded == 50
 
-        # Does media entry still exist?
-        assert_false(
-            request.db.MediaEntry.find(
-                {'_id': media._id}).count())
-
-    def test_malicious_uploads(self):
+    def test_evil_file(self):
         # Test non-suppoerted file with non-supported extension
         # -----------------------------------------------------
+        response, form = self.do_post({'title': u'Malicious Upload 1'},
+                                      *FORM_CONTEXT,
+                                      **self.upload_data(EVIL_FILE))
+        assert len(form.file.errors) == 1
+        assert 'Sorry, I don\'t support that file type :(' == \
+                str(form.file.errors[0])
+
+
+    def test_get_media_manager(self):
+        """Test if the get_media_manger function returns sensible things
+        """
+        response, request = self.do_post({'title': u'Balanced Goblin'},
+                                         *REQUEST_CONTEXT, do_follow=True,
+                                         **self.upload_data(GOOD_JPG))
+        media = self.check_media(request, {'title': u'Balanced Goblin'}, 1)
+
+        assert media.media_type == u'mediagoblin.media_types.image'
+        assert isinstance(media.media_manager, ImageMediaManager)
+        assert media.media_manager.entry == media
+
+
+    def test_sniffing(self):
+        '''
+        Test sniffing mechanism to assert that regular uploads work as intended
+        '''
         template.clear_test_template_context()
         response = self.test_app.post(
             '/submit/', {
-                'title': 'Malicious Upload 1'
+                'title': u'UNIQUE_TITLE_PLS_DONT_CREATE_OTHER_MEDIA_WITH_THIS_TITLE'
                 }, upload_files=[(
-                    'file', EVIL_FILE)])
+                    'file', GOOD_JPG)])
+
+        response.follow()
+
+        context = template.TEMPLATE_TEST_CONTEXT['mediagoblin/user_pages/user.html']
+
+        request = context['request']
+
+        media = request.db.MediaEntry.query.filter_by(
+            title=u'UNIQUE_TITLE_PLS_DONT_CREATE_OTHER_MEDIA_WITH_THIS_TITLE').first()
 
-        context = template.TEMPLATE_TEST_CONTEXT['mediagoblin/submit/start.html']
-        form = context['submit_form']
-        assert form.file.errors == [u'Invalid file type.']
+        assert media.media_type == 'mediagoblin.media_types.image'
 
+    def check_false_image(self, title, filename):
         # NOTE: The following 2 tests will ultimately fail, but they
         #   *will* pass the initial form submission step.  Instead,
         #   they'll be caught as failures during the processing step.
-
+        response, context = self.do_post({'title': title}, do_follow=True,
+                                         **self.upload_data(filename))
+        self.check_url(response, '/u/{0}/'.format(self.test_user.username))
+        entry = mg_globals.database.MediaEntry.query.filter_by(title=title).first()
+        assert entry.state == 'failed'
+        assert entry.fail_error == u'mediagoblin.processing:BadMediaFail'
+
+    def test_evil_jpg(self):
         # Test non-supported file with .jpg extension
         # -------------------------------------------
-        template.clear_test_template_context()
-        response = self.test_app.post(
-           '/submit/', {
-               'title': 'Malicious Upload 2'
-               }, upload_files=[(
-                   'file', EVIL_JPG)])
-        response.follow()
-        assert_equal(
-            urlparse.urlsplit(response.location)[2],
-            '/u/chris/')
-
-        entry = mg_globals.database.MediaEntry.find_one(
-            {'title': 'Malicious Upload 2'})
-        assert_equal(entry['state'], 'failed')
-        assert_equal(
-            entry['fail_error'],
-            u'mediagoblin.processing:BadMediaFail')
+        self.check_false_image(u'Malicious Upload 2', EVIL_JPG)
 
+    def test_evil_png(self):
         # Test non-supported file with .png extension
         # -------------------------------------------
-        template.clear_test_template_context()
-        response = self.test_app.post(
-           '/submit/', {
-               'title': 'Malicious Upload 3'
-               }, upload_files=[(
-                   'file', EVIL_PNG)])
-        response.follow()
-        assert_equal(
-            urlparse.urlsplit(response.location)[2],
-            '/u/chris/')
-
-        entry = mg_globals.database.MediaEntry.find_one(
-            {'title': 'Malicious Upload 3'})
-        assert_equal(entry['state'], 'failed')
-        assert_equal(
-            entry['fail_error'],
-            u'mediagoblin.processing:BadMediaFail')
+        self.check_false_image(u'Malicious Upload 3', EVIL_PNG)
+
+    def test_media_data(self):
+        self.check_normal_upload(u"With GPS data", GPS_JPG)
+        media = self.check_media(None, {"title": u"With GPS data"}, 1)
+        assert media.media_data.gps_latitude == 59.336666666666666
+
+    def test_processing(self):
+        public_store_dir = mg_globals.global_config[
+            'storage:publicstore']['base_dir']
+
+        data = {'title': u'Big Blue'}
+        response, request = self.do_post(data, *REQUEST_CONTEXT, do_follow=True,
+                                         **self.upload_data(BIG_BLUE))
+        media = self.check_media(request, data, 1)
+        last_size = 1024 ** 3  # Needs to be larger than bigblue.png
+        for key, basename in (('original', 'bigblue.png'),
+                              ('medium', 'bigblue.medium.png'),
+                              ('thumb', 'bigblue.thumbnail.png')):
+            # Does the processed image have a good filename?
+            filename = os.path.join(
+                public_store_dir,
+                *media.media_files[key])
+            assert filename.endswith('_' + basename)
+            # Is it smaller than the last processed image we looked at?
+            size = os.stat(filename).st_size
+            assert last_size > size
+            last_size = size