Add waffle switch to toggle video thumbnail feature.

cms/djangoapps/contentstore/views/tests/test_videos.py

@@ -6,6 +6,7 @@ import csv
 import json
 import re
 from datetime import datetime
+from functools import wraps
 from StringIO import StringIO
 
 import dateutil.parser
@@ -21,11 +22,10 @@ from contentstore.models import VideoUploadConfig
 from contentstore.tests.utils import CourseTestCase
 from contentstore.utils import reverse_course_url
 from contentstore.views.videos import (
-    KEY_EXPIRATION_IN_SECONDS,
-    StatusDisplayStrings,
-    convert_video_status,
     _get_default_video_image_url,
-    validate_video_image
+    validate_video_image,
+    VIDEO_IMAGE_UPLOAD_ENABLED,
+    WAFFLE_SWITCHES,
 )
 from contentstore.views.videos import KEY_EXPIRATION_IN_SECONDS, StatusDisplayStrings, convert_video_status
 from xmodule.modulestore.tests.factories import CourseFactory
@@ -33,6 +33,24 @@ from xmodule.modulestore.tests.factories import CourseFactory
 from openedx.core.djangoapps.profile_images.tests.helpers import make_image_file
 
 
+def override_switch(switch, active):
+    """
+    Overrides the given waffle switch to `active` boolean.
+
+    Arguments:
+        switch(str): switch name
+        active(bool): A boolean representing (to be overridden) value
+    """
+    def decorate(function):
+        @wraps(function)
+        def inner(*args, **kwargs):
+            with WAFFLE_SWITCHES.override(switch, active=active):
+                function(*args, **kwargs)
+        return inner
+
+    return decorate
+
+
 class VideoUploadTestBase(object):
     """
     Test cases for the video upload feature
@@ -576,6 +594,16 @@ class VideoImageTestCase(VideoUploadTestBase, CourseTestCase):
         self.assertIn('error', response)
         self.assertEqual(response['error'], error_message)
 
+    @override_switch(VIDEO_IMAGE_UPLOAD_ENABLED, False)
+    def test_video_image_upload_disabled(self):
+        """
+        Tests the video image upload when the feature is disabled.
+        """
+        video_image_upload_url = self.get_url_for_course_key(self.course.id, {'edx_video_id': 'test_vid_id'})
+        response = self.client.post(video_image_upload_url, {'file': 'dummy_file'}, format='multipart')
+        self.assertEqual(response.status_code, 404)
+
+    @override_switch(VIDEO_IMAGE_UPLOAD_ENABLED, True)
     def test_video_image(self):
         """
         Test video image is saved.
@@ -597,6 +625,7 @@ class VideoImageTestCase(VideoUploadTestBase, CourseTestCase):
 
         self.assertNotEqual(image_url1, image_url2)
 
+    @override_switch(VIDEO_IMAGE_UPLOAD_ENABLED, True)
     def test_video_image_no_file(self):
         """
         Test that an error error message is returned if upload request is incorrect.
@@ -625,6 +654,7 @@ class VideoImageTestCase(VideoUploadTestBase, CourseTestCase):
             error = validate_video_image(image_file)
             self.assertEquals(error, 'This image file is corrupted.')
 
+    @override_switch(VIDEO_IMAGE_UPLOAD_ENABLED, True)
     def test_no_video_image(self):
         """
         Test image url is set to None if no video image.
@@ -800,6 +830,7 @@ class VideoImageTestCase(VideoUploadTestBase, CourseTestCase):
         )
     )
     @ddt.unpack
+    @override_switch(VIDEO_IMAGE_UPLOAD_ENABLED, True)
     def test_video_image_validation_message(self, image_data, error_message):
         """
         Test video image validation gives proper error message.

cms/djangoapps/contentstore/views/videos.py

@@ -2,10 +2,7 @@
 Views related to the video upload feature
 """
 from contextlib import closing
-from datetime import datetime, timedelta
-import logging
 
-from boto import s3
 import csv
 import logging
 from datetime import datetime, timedelta
@@ -31,6 +28,7 @@ from edxval.api import (
     update_video_image
 )
 from opaque_keys.edx.keys import CourseKey
+from openedx.core.djangoapps.waffle_utils import WaffleSwitchNamespace
 
 from contentstore.models import VideoUploadConfig
 from contentstore.utils import reverse_course_url
@@ -44,6 +42,12 @@ __all__ = ['videos_handler', 'video_encodings_download', 'video_images_handler']
 
 LOGGER = logging.getLogger(__name__)
 
+# Waffle switches namespace for videos
+WAFFLE_NAMESPACE = 'videos'
+WAFFLE_SWITCHES = WaffleSwitchNamespace(name=WAFFLE_NAMESPACE)
+
+# Waffle switch for enabling/disabling video image upload feature
+VIDEO_IMAGE_UPLOAD_ENABLED = 'video_image_upload_enabled'
 
 # Default expiration, in seconds, of one-time URLs used for uploading videos.
 KEY_EXPIRATION_IN_SECONDS = 86400
@@ -210,6 +214,11 @@ def validate_video_image(image_file):
 @login_required
 @require_POST
 def video_images_handler(request, course_key_string, edx_video_id=None):
+
+    # respond with a 404 if image upload is not enabled.
+    if not WAFFLE_SWITCHES.is_enabled(VIDEO_IMAGE_UPLOAD_ENABLED):
+        return HttpResponseNotFound()
+
     if 'file' not in request.FILES:
         return JsonResponse({'error': _(u'No file provided for video image')}, status=400)
 
@@ -428,6 +437,7 @@ def videos_index_html(course):
             'video_supported_file_formats': VIDEO_SUPPORTED_FILE_FORMATS.keys(),
             'video_upload_max_file_size': VIDEO_UPLOAD_MAX_FILE_SIZE_GB,
             'video_image_settings': {
+                'video_image_upload_enabled': WAFFLE_SWITCHES.is_enabled(VIDEO_IMAGE_UPLOAD_ENABLED),
                 'max_size': settings.VIDEO_IMAGE_SETTINGS['VIDEO_IMAGE_MAX_BYTES'],
                 'min_size': settings.VIDEO_IMAGE_SETTINGS['VIDEO_IMAGE_MIN_BYTES'],
                 'max_width': settings.VIDEO_IMAGE_MAX_WIDTH,