4f5d8b30de
Note that the features in this release are opt-in, and course and video behavior will remain the same unless a course explicitly opts in. Major pieces of functionality with this commit: Allows the listing of a user's enrollments, course videos, and updates. In order to make a course available for mobile use, course staff must explicitly set the Course Advanced Setting "Mobile Course Available" to true. Course staff will always see their own courses through the Mobile API regardless of this setting, but students will only be allowed to see a course through the Mobile API if this setting is set to "true". By default, a Course will *not* be available for mobile use. This is a Django app for video resource management. It is completely optional, and is intended to allow video and operations teams to create new encodings of videos (e.g. low res for mobile) and change CDNs without having to edit course data directly. Course teams can now use a "EdX Video ID" setting for Videos, which will leverage VAL. Video units that do not fill in an "EdX Video ID" will behave exactly as they always have. * The Mobile API is enabled with the ENABLE_MOBILE_REST_API feature flag. * VAL is enabled with the ENABLE_VIDEO_ABSTRACTION_LAYER_API feature flag. * VAL and the Mobile API both require ENABLE_OAUTH2_PROVIDER). * The Mobile API is a read-only API, but VAL requires database migrations. * Applications that make use of either the Mobile API or VAL must be registered with the OAuth2 provider app in Django Admin.
976 lines
37 KiB
Python
976 lines
37 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""Video xmodule tests in mongo."""
|
|
import json
|
|
import unittest
|
|
from collections import OrderedDict
|
|
from mock import patch, PropertyMock, MagicMock
|
|
|
|
from django.conf import settings
|
|
|
|
from xblock.fields import ScopeIds
|
|
from xblock.field_data import DictFieldData
|
|
|
|
from xmodule.video_module import create_youtube_string, VideoDescriptor
|
|
from xmodule.x_module import STUDENT_VIEW
|
|
from xmodule.tests import get_test_descriptor_system
|
|
from xmodule.tests.test_video import VideoDescriptorTestBase
|
|
|
|
from edxval.api import (
|
|
ValVideoNotFoundError,
|
|
get_video_info,
|
|
create_profile,
|
|
create_video
|
|
)
|
|
import mock
|
|
|
|
from . import BaseTestXmodule
|
|
from .test_video_xml import SOURCE_XML
|
|
from .test_video_handlers import TestVideo
|
|
|
|
|
|
class TestVideoYouTube(TestVideo):
|
|
METADATA = {}
|
|
|
|
def test_video_constructor(self):
|
|
"""Make sure that all parameters extracted correctly from xml"""
|
|
context = self.item_descriptor.render(STUDENT_VIEW).content
|
|
sources = json.dumps([u'example.mp4', u'example.webm'])
|
|
|
|
expected_context = {
|
|
'ajax_url': self.item_descriptor.xmodule_runtime.ajax_url + '/save_user_state',
|
|
'autoplay': settings.FEATURES.get('AUTOPLAY_VIDEOS', False),
|
|
'data_dir': getattr(self, 'data_dir', None),
|
|
'display_name': u'A Name',
|
|
'end': 3610.0,
|
|
'id': self.item_descriptor.location.html_id(),
|
|
'show_captions': 'true',
|
|
'handout': None,
|
|
'download_video_link': u'example.mp4',
|
|
'sources': sources,
|
|
'speed': 'null',
|
|
'general_speed': 1.0,
|
|
'start': 3603.0,
|
|
'saved_video_position': 0.0,
|
|
'sub': u'a_sub_file.srt.sjson',
|
|
'track': None,
|
|
'youtube_streams': create_youtube_string(self.item_descriptor),
|
|
'yt_test_timeout': 1500,
|
|
'yt_api_url': 'www.youtube.com/iframe_api',
|
|
'yt_test_url': 'gdata.youtube.com/feeds/api/videos/',
|
|
'transcript_download_format': 'srt',
|
|
'transcript_download_formats_list': [{'display_name': 'SubRip (.srt) file', 'value': 'srt'}, {'display_name': 'Text (.txt) file', 'value': 'txt'}],
|
|
'transcript_language': u'en',
|
|
'transcript_languages': json.dumps(OrderedDict({"en": "English", "uk": u"Українська"})),
|
|
'transcript_translation_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'translation'
|
|
).rstrip('/?'),
|
|
'transcript_available_translations_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'available_translations'
|
|
).rstrip('/?'),
|
|
}
|
|
|
|
self.assertEqual(
|
|
context,
|
|
self.item_descriptor.xmodule_runtime.render_template('video.html', expected_context),
|
|
)
|
|
|
|
|
|
class TestVideoNonYouTube(TestVideo):
|
|
"""Integration tests: web client + mongo."""
|
|
DATA = """
|
|
<video show_captions="true"
|
|
display_name="A Name"
|
|
sub="a_sub_file.srt.sjson"
|
|
download_video="true"
|
|
start_time="01:00:03" end_time="01:00:10"
|
|
>
|
|
<source src="example.mp4"/>
|
|
<source src="example.webm"/>
|
|
</video>
|
|
"""
|
|
MODEL_DATA = {
|
|
'data': DATA,
|
|
}
|
|
METADATA = {}
|
|
|
|
def test_video_constructor(self):
|
|
"""Make sure that if the 'youtube' attribute is omitted in XML, then
|
|
the template generates an empty string for the YouTube streams.
|
|
"""
|
|
context = self.item_descriptor.render(STUDENT_VIEW).content
|
|
sources = json.dumps([u'example.mp4', u'example.webm'])
|
|
|
|
expected_context = {
|
|
'ajax_url': self.item_descriptor.xmodule_runtime.ajax_url + '/save_user_state',
|
|
'data_dir': getattr(self, 'data_dir', None),
|
|
'show_captions': 'true',
|
|
'handout': None,
|
|
'display_name': u'A Name',
|
|
'download_video_link': u'example.mp4',
|
|
'end': 3610.0,
|
|
'id': self.item_descriptor.location.html_id(),
|
|
'sources': sources,
|
|
'speed': 'null',
|
|
'general_speed': 1.0,
|
|
'start': 3603.0,
|
|
'saved_video_position': 0.0,
|
|
'sub': u'a_sub_file.srt.sjson',
|
|
'track': None,
|
|
'youtube_streams': '1.00:OEoXaMPEzfM',
|
|
'autoplay': settings.FEATURES.get('AUTOPLAY_VIDEOS', True),
|
|
'yt_test_timeout': 1500,
|
|
'yt_api_url': 'www.youtube.com/iframe_api',
|
|
'yt_test_url': 'gdata.youtube.com/feeds/api/videos/',
|
|
'transcript_download_format': 'srt',
|
|
'transcript_download_formats_list': [{'display_name': 'SubRip (.srt) file', 'value': 'srt'}, {'display_name': 'Text (.txt) file', 'value': 'txt'}],
|
|
'transcript_language': u'en',
|
|
'transcript_languages': '{"en": "English"}',
|
|
'transcript_translation_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'translation'
|
|
).rstrip('/?'),
|
|
'transcript_available_translations_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'available_translations'
|
|
).rstrip('/?')
|
|
}
|
|
|
|
self.assertEqual(
|
|
context,
|
|
self.item_descriptor.xmodule_runtime.render_template('video.html', expected_context),
|
|
)
|
|
|
|
|
|
class TestGetHtmlMethod(BaseTestXmodule):
|
|
'''
|
|
Make sure that `get_html` works correctly.
|
|
'''
|
|
CATEGORY = "video"
|
|
DATA = SOURCE_XML
|
|
METADATA = {}
|
|
|
|
def setUp(self):
|
|
self.setup_course()
|
|
|
|
def test_get_html_track(self):
|
|
SOURCE_XML = """
|
|
<video show_captions="true"
|
|
display_name="A Name"
|
|
sub="{sub}" download_track="{download_track}"
|
|
start_time="01:00:03" end_time="01:00:10"
|
|
>
|
|
<source src="example.mp4"/>
|
|
<source src="example.webm"/>
|
|
{track}
|
|
{transcripts}
|
|
</video>
|
|
"""
|
|
|
|
cases = [
|
|
{
|
|
'download_track': u'true',
|
|
'track': u'<track src="http://www.example.com/track"/>',
|
|
'sub': u'a_sub_file.srt.sjson',
|
|
'expected_track_url': u'http://www.example.com/track',
|
|
'transcripts': '',
|
|
},
|
|
{
|
|
'download_track': u'true',
|
|
'track': u'',
|
|
'sub': u'a_sub_file.srt.sjson',
|
|
'expected_track_url': u'a_sub_file.srt.sjson',
|
|
'transcripts': '',
|
|
},
|
|
{
|
|
'download_track': u'true',
|
|
'track': u'',
|
|
'sub': u'',
|
|
'expected_track_url': None,
|
|
'transcripts': '',
|
|
},
|
|
{
|
|
'download_track': u'false',
|
|
'track': u'<track src="http://www.example.com/track"/>',
|
|
'sub': u'a_sub_file.srt.sjson',
|
|
'expected_track_url': None,
|
|
'transcripts': '',
|
|
},
|
|
{
|
|
'download_track': u'true',
|
|
'track': u'',
|
|
'sub': u'',
|
|
'expected_track_url': u'a_sub_file.srt.sjson',
|
|
'transcripts': '<transcript language="uk" src="ukrainian.srt" />',
|
|
},
|
|
]
|
|
sources = json.dumps([u'example.mp4', u'example.webm'])
|
|
|
|
expected_context = {
|
|
'data_dir': getattr(self, 'data_dir', None),
|
|
'show_captions': 'true',
|
|
'handout': None,
|
|
'display_name': u'A Name',
|
|
'download_video_link': u'example.mp4',
|
|
'end': 3610.0,
|
|
'id': None,
|
|
'sources': sources,
|
|
'start': 3603.0,
|
|
'saved_video_position': 0.0,
|
|
'sub': u'a_sub_file.srt.sjson',
|
|
'speed': 'null',
|
|
'general_speed': 1.0,
|
|
'track': u'http://www.example.com/track',
|
|
'youtube_streams': '1.00:OEoXaMPEzfM',
|
|
'autoplay': settings.FEATURES.get('AUTOPLAY_VIDEOS', True),
|
|
'yt_test_timeout': 1500,
|
|
'yt_api_url': 'www.youtube.com/iframe_api',
|
|
'yt_test_url': 'gdata.youtube.com/feeds/api/videos/',
|
|
'transcript_download_formats_list': [{'display_name': 'SubRip (.srt) file', 'value': 'srt'}, {'display_name': 'Text (.txt) file', 'value': 'txt'}],
|
|
}
|
|
|
|
for data in cases:
|
|
DATA = SOURCE_XML.format(
|
|
download_track=data['download_track'],
|
|
track=data['track'],
|
|
sub=data['sub'],
|
|
transcripts=data['transcripts'],
|
|
)
|
|
|
|
self.initialize_module(data=DATA)
|
|
track_url = self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'download'
|
|
).rstrip('/?')
|
|
|
|
context = self.item_descriptor.render(STUDENT_VIEW).content
|
|
|
|
expected_context.update({
|
|
'transcript_download_format': None if self.item_descriptor.track and self.item_descriptor.download_track else 'srt',
|
|
'transcript_languages': '{"en": "English"}' if not data['transcripts'] else json.dumps({"uk": u'Українська'}),
|
|
'transcript_language': u'en' if not data['transcripts'] or data.get('sub') else u'uk',
|
|
'transcript_translation_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'translation'
|
|
).rstrip('/?'),
|
|
'transcript_available_translations_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'available_translations'
|
|
).rstrip('/?'),
|
|
'ajax_url': self.item_descriptor.xmodule_runtime.ajax_url + '/save_user_state',
|
|
'track': track_url if data['expected_track_url'] == u'a_sub_file.srt.sjson' else data['expected_track_url'],
|
|
'sub': data['sub'],
|
|
'id': self.item_descriptor.location.html_id(),
|
|
})
|
|
self.assertEqual(
|
|
context,
|
|
self.item_descriptor.xmodule_runtime.render_template('video.html', expected_context),
|
|
)
|
|
|
|
def test_get_html_source(self):
|
|
SOURCE_XML = """
|
|
<video show_captions="true"
|
|
display_name="A Name"
|
|
sub="a_sub_file.srt.sjson" source="{source}"
|
|
download_video="{download_video}"
|
|
start_time="01:00:03" end_time="01:00:10"
|
|
>
|
|
{sources}
|
|
</video>
|
|
"""
|
|
cases = [
|
|
# self.download_video == True
|
|
{
|
|
'download_video': 'true',
|
|
'source': 'example_source.mp4',
|
|
'sources': """
|
|
<source src="example.mp4"/>
|
|
<source src="example.webm"/>
|
|
""",
|
|
'result': {
|
|
'download_video_link': u'example_source.mp4',
|
|
'sources': json.dumps([u'example.mp4', u'example.webm']),
|
|
},
|
|
},
|
|
{
|
|
'download_video': 'true',
|
|
'source': '',
|
|
'sources': """
|
|
<source src="example.mp4"/>
|
|
<source src="example.webm"/>
|
|
""",
|
|
'result': {
|
|
'download_video_link': u'example.mp4',
|
|
'sources': json.dumps([u'example.mp4', u'example.webm']),
|
|
},
|
|
},
|
|
{
|
|
'download_video': 'true',
|
|
'source': '',
|
|
'sources': [],
|
|
'result': {},
|
|
},
|
|
|
|
# self.download_video == False
|
|
{
|
|
'download_video': 'false',
|
|
'source': 'example_source.mp4',
|
|
'sources': """
|
|
<source src="example.mp4"/>
|
|
<source src="example.webm"/>
|
|
""",
|
|
'result': {
|
|
'sources': json.dumps([u'example.mp4', u'example.webm']),
|
|
},
|
|
},
|
|
]
|
|
|
|
initial_context = {
|
|
'data_dir': getattr(self, 'data_dir', None),
|
|
'show_captions': 'true',
|
|
'handout': None,
|
|
'display_name': u'A Name',
|
|
'download_video_link': None,
|
|
'end': 3610.0,
|
|
'id': None,
|
|
'sources': '[]',
|
|
'speed': 'null',
|
|
'general_speed': 1.0,
|
|
'start': 3603.0,
|
|
'saved_video_position': 0.0,
|
|
'sub': u'a_sub_file.srt.sjson',
|
|
'track': None,
|
|
'youtube_streams': '1.00:OEoXaMPEzfM',
|
|
'autoplay': settings.FEATURES.get('AUTOPLAY_VIDEOS', True),
|
|
'yt_test_timeout': 1500,
|
|
'yt_api_url': 'www.youtube.com/iframe_api',
|
|
'yt_test_url': 'gdata.youtube.com/feeds/api/videos/',
|
|
'transcript_download_format': 'srt',
|
|
'transcript_download_formats_list': [{'display_name': 'SubRip (.srt) file', 'value': 'srt'}, {'display_name': 'Text (.txt) file', 'value': 'txt'}],
|
|
'transcript_language': u'en',
|
|
'transcript_languages': '{"en": "English"}',
|
|
}
|
|
|
|
for data in cases:
|
|
DATA = SOURCE_XML.format(
|
|
download_video=data['download_video'],
|
|
source=data['source'],
|
|
sources=data['sources']
|
|
)
|
|
self.initialize_module(data=DATA)
|
|
context = self.item_descriptor.render(STUDENT_VIEW).content
|
|
|
|
expected_context = dict(initial_context)
|
|
expected_context.update({
|
|
'transcript_translation_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'translation'
|
|
).rstrip('/?'),
|
|
'transcript_available_translations_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'available_translations'
|
|
).rstrip('/?'),
|
|
'ajax_url': self.item_descriptor.xmodule_runtime.ajax_url + '/save_user_state',
|
|
'id': self.item_descriptor.location.html_id(),
|
|
})
|
|
expected_context.update(data['result'])
|
|
|
|
self.assertEqual(
|
|
context,
|
|
self.item_descriptor.xmodule_runtime.render_template('video.html', expected_context)
|
|
)
|
|
|
|
|
|
def test_get_html_with_non_existant_edx_video_id(self):
|
|
"""
|
|
Tests the VideoModule get_html where a edx_video_id is given but a video is not found
|
|
"""
|
|
SOURCE_XML = """
|
|
<video show_captions="true"
|
|
display_name="A Name"
|
|
sub="a_sub_file.srt.sjson" source="{source}"
|
|
download_video="{download_video}"
|
|
start_time="01:00:03" end_time="01:00:10"
|
|
edx_video_id="{edx_video_id}"
|
|
>
|
|
{sources}
|
|
</video>
|
|
"""
|
|
no_video_data = {
|
|
'download_video': 'true',
|
|
'source': 'example_source.mp4',
|
|
'sources': """
|
|
<source src="example.mp4"/>
|
|
<source src="example.webm"/>
|
|
""",
|
|
'edx_video_id':"meow",
|
|
'result': {
|
|
'download_video_link': u'example_source.mp4',
|
|
'sources': json.dumps([u'example.mp4', u'example.webm']),
|
|
}
|
|
}
|
|
DATA = SOURCE_XML.format(
|
|
download_video=no_video_data['download_video'],
|
|
source=no_video_data['source'],
|
|
sources=no_video_data['sources'],
|
|
edx_video_id=no_video_data['edx_video_id']
|
|
)
|
|
self.initialize_module(data=DATA)
|
|
|
|
# Referencing a non-existent VAL ID in courseware won't cause an error --
|
|
# it'll just fall back to the values in the VideoDescriptor.
|
|
self.assertIn("example_source.mp4", self.item_descriptor.render(STUDENT_VIEW).content)
|
|
|
|
@mock.patch('edxval.api.get_video_info')
|
|
def test_get_html_with_mocked_edx_video_id(self, mock_get_video_info):
|
|
mock_get_video_info.return_value = {
|
|
'url' : '/edxval/video/example',
|
|
'edx_video_id': u'example',
|
|
'duration': 111.0,
|
|
'client_video_id': u'The example video',
|
|
'encoded_videos': [
|
|
{
|
|
'url': u'http://www.meowmix.com',
|
|
'file_size': 25556,
|
|
'bitrate': 9600,
|
|
'profile': u'desktop_mp4'
|
|
}
|
|
]
|
|
}
|
|
|
|
SOURCE_XML = """
|
|
<video show_captions="true"
|
|
display_name="A Name"
|
|
sub="a_sub_file.srt.sjson" source="{source}"
|
|
download_video="{download_video}"
|
|
start_time="01:00:03" end_time="01:00:10"
|
|
edx_video_id="{edx_video_id}"
|
|
>
|
|
{sources}
|
|
</video>
|
|
"""
|
|
data = {
|
|
'download_video': 'true',
|
|
'source': 'example_source.mp4',
|
|
'sources': """
|
|
<source src="example.mp4"/>
|
|
<source src="example.webm"/>
|
|
""",
|
|
'edx_video_id': "mock item",
|
|
'result': {
|
|
'download_video_link': u'http://www.meowmix.com',
|
|
'sources': json.dumps([u'example.mp4', u'example.webm']),
|
|
}
|
|
}
|
|
|
|
|
|
# Video found for edx_video_id
|
|
initial_context = {
|
|
'data_dir': getattr(self, 'data_dir', None),
|
|
'show_captions': 'true',
|
|
'handout': None,
|
|
'display_name': u'A Name',
|
|
'download_video_link': None,
|
|
'end': 3610.0,
|
|
'id': None,
|
|
'sources': '[]',
|
|
'speed': 'null',
|
|
'general_speed': 1.0,
|
|
'start': 3603.0,
|
|
'saved_video_position': 0.0,
|
|
'sub': u'a_sub_file.srt.sjson',
|
|
'track': None,
|
|
'youtube_streams': '1.00:OEoXaMPEzfM',
|
|
'autoplay': settings.FEATURES.get('AUTOPLAY_VIDEOS', True),
|
|
'yt_test_timeout': 1500,
|
|
'yt_api_url': 'www.youtube.com/iframe_api',
|
|
'yt_test_url': 'gdata.youtube.com/feeds/api/videos/',
|
|
'transcript_download_format': 'srt',
|
|
'transcript_download_formats_list': [{'display_name': 'SubRip (.srt) file', 'value': 'srt'}, {'display_name': 'Text (.txt) file', 'value': 'txt'}],
|
|
'transcript_language': u'en',
|
|
'transcript_languages': '{"en": "English"}',
|
|
}
|
|
|
|
DATA = SOURCE_XML.format(
|
|
download_video=data['download_video'],
|
|
source=data['source'],
|
|
sources=data['sources'],
|
|
edx_video_id=data['edx_video_id']
|
|
)
|
|
self.initialize_module(data=DATA)
|
|
context = self.item_descriptor.render(STUDENT_VIEW).content
|
|
|
|
expected_context = dict(initial_context)
|
|
expected_context.update({
|
|
'transcript_translation_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'translation'
|
|
).rstrip('/?'),
|
|
'transcript_available_translations_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'available_translations'
|
|
).rstrip('/?'),
|
|
'ajax_url': self.item_descriptor.xmodule_runtime.ajax_url + '/save_user_state',
|
|
'id': self.item_descriptor.location.html_id(),
|
|
})
|
|
expected_context.update(data['result'])
|
|
|
|
self.assertEqual(
|
|
context,
|
|
self.item_descriptor.xmodule_runtime.render_template('video.html', expected_context)
|
|
)
|
|
|
|
def test_get_html_with_existing_edx_video_id(self):
|
|
result = create_profile(
|
|
dict(
|
|
profile_name="desktop_mp4",
|
|
extension="mp4",
|
|
width=200,
|
|
height=2001
|
|
)
|
|
)
|
|
self.assertEqual(result, "desktop_mp4")
|
|
result = create_video(
|
|
dict(
|
|
client_video_id="Thunder Cats",
|
|
duration=111,
|
|
edx_video_id="thundercats",
|
|
encoded_videos=[
|
|
dict(
|
|
url="http://fake-video.edx.org/thundercats.mp4",
|
|
file_size=9000,
|
|
bitrate=42,
|
|
profile="desktop_mp4",
|
|
)
|
|
]
|
|
)
|
|
)
|
|
self.assertEqual(result, "thundercats")
|
|
|
|
SOURCE_XML = """
|
|
<video show_captions="true"
|
|
display_name="A Name"
|
|
sub="a_sub_file.srt.sjson" source="{source}"
|
|
download_video="{download_video}"
|
|
start_time="01:00:03" end_time="01:00:10"
|
|
edx_video_id="{edx_video_id}"
|
|
>
|
|
{sources}
|
|
</video>
|
|
"""
|
|
data = {
|
|
'download_video': 'true',
|
|
'source': 'example_source.mp4',
|
|
'sources': """
|
|
<source src="example.mp4"/>
|
|
<source src="example.webm"/>
|
|
""",
|
|
'edx_video_id':"thundercats",
|
|
'result': {
|
|
'download_video_link': u'http://fake-video.edx.org/thundercats.mp4',
|
|
'sources': json.dumps([u'example.mp4', u'example.webm']),
|
|
}
|
|
}
|
|
|
|
# Video found for edx_video_id
|
|
initial_context = {
|
|
'data_dir': getattr(self, 'data_dir', None),
|
|
'show_captions': 'true',
|
|
'handout': None,
|
|
'display_name': u'A Name',
|
|
'download_video_link': None,
|
|
'end': 3610.0,
|
|
'id': None,
|
|
'sources': '[]',
|
|
'speed': 'null',
|
|
'general_speed': 1.0,
|
|
'start': 3603.0,
|
|
'saved_video_position': 0.0,
|
|
'sub': u'a_sub_file.srt.sjson',
|
|
'track': None,
|
|
'youtube_streams': '1.00:OEoXaMPEzfM',
|
|
'autoplay': settings.FEATURES.get('AUTOPLAY_VIDEOS', True),
|
|
'yt_test_timeout': 1500,
|
|
'yt_api_url': 'www.youtube.com/iframe_api',
|
|
'yt_test_url': 'gdata.youtube.com/feeds/api/videos/',
|
|
'transcript_download_format': 'srt',
|
|
'transcript_download_formats_list': [{'display_name': 'SubRip (.srt) file', 'value': 'srt'}, {'display_name': 'Text (.txt) file', 'value': 'txt'}],
|
|
'transcript_language': u'en',
|
|
'transcript_languages': '{"en": "English"}',
|
|
}
|
|
|
|
DATA = SOURCE_XML.format(
|
|
download_video=data['download_video'],
|
|
source=data['source'],
|
|
sources=data['sources'],
|
|
edx_video_id=data['edx_video_id']
|
|
)
|
|
self.initialize_module(data=DATA)
|
|
context = self.item_descriptor.render(STUDENT_VIEW).content
|
|
|
|
expected_context = dict(initial_context)
|
|
expected_context.update({
|
|
'transcript_translation_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'translation'
|
|
).rstrip('/?'),
|
|
'transcript_available_translations_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'available_translations'
|
|
).rstrip('/?'),
|
|
'ajax_url': self.item_descriptor.xmodule_runtime.ajax_url + '/save_user_state',
|
|
'id': self.item_descriptor.location.html_id(),
|
|
})
|
|
expected_context.update(data['result'])
|
|
|
|
self.assertEqual(
|
|
context,
|
|
self.item_descriptor.xmodule_runtime.render_template('video.html', expected_context)
|
|
)
|
|
|
|
@patch('xmodule.video_module.video_module.get_video_from_cdn')
|
|
def test_get_html_cdn_source(self, mocked_get_video):
|
|
"""
|
|
Test if sources got from CDN.
|
|
"""
|
|
def side_effect(*args, **kwargs):
|
|
cdn = {
|
|
'http://example.com/example.mp4': 'http://cdn_example.com/example.mp4',
|
|
'http://example.com/example.webm': 'http://cdn_example.com/example.webm',
|
|
}
|
|
return cdn.get(args[1])
|
|
|
|
mocked_get_video.side_effect = side_effect
|
|
|
|
SOURCE_XML = """
|
|
<video show_captions="true"
|
|
display_name="A Name"
|
|
sub="a_sub_file.srt.sjson" source="{source}"
|
|
download_video="{download_video}"
|
|
start_time="01:00:03" end_time="01:00:10"
|
|
>
|
|
{sources}
|
|
</video>
|
|
"""
|
|
cases = [
|
|
#
|
|
{
|
|
'download_video': 'true',
|
|
'source': 'example_source.mp4',
|
|
'sources': """
|
|
<source src="http://example.com/example.mp4"/>
|
|
<source src="http://example.com/example.webm"/>
|
|
""",
|
|
'result': {
|
|
'download_video_link': u'example_source.mp4',
|
|
'sources': json.dumps(
|
|
[
|
|
u'http://cdn_example.com/example.mp4',
|
|
u'http://cdn_example.com/example.webm'
|
|
]
|
|
),
|
|
},
|
|
},
|
|
]
|
|
|
|
initial_context = {
|
|
'data_dir': getattr(self, 'data_dir', None),
|
|
'show_captions': 'true',
|
|
'handout': None,
|
|
'display_name': u'A Name',
|
|
'download_video_link': None,
|
|
'end': 3610.0,
|
|
'id': None,
|
|
'sources': '[]',
|
|
'speed': 'null',
|
|
'general_speed': 1.0,
|
|
'start': 3603.0,
|
|
'saved_video_position': 0.0,
|
|
'sub': u'a_sub_file.srt.sjson',
|
|
'track': None,
|
|
'youtube_streams': '1.00:OEoXaMPEzfM',
|
|
'autoplay': settings.FEATURES.get('AUTOPLAY_VIDEOS', True),
|
|
'yt_test_timeout': 1500,
|
|
'yt_api_url': 'www.youtube.com/iframe_api',
|
|
'yt_test_url': 'gdata.youtube.com/feeds/api/videos/',
|
|
'transcript_download_format': 'srt',
|
|
'transcript_download_formats_list': [{'display_name': 'SubRip (.srt) file', 'value': 'srt'}, {'display_name': 'Text (.txt) file', 'value': 'txt'}],
|
|
'transcript_language': u'en',
|
|
'transcript_languages': '{"en": "English"}',
|
|
}
|
|
|
|
for data in cases:
|
|
DATA = SOURCE_XML.format(
|
|
download_video=data['download_video'],
|
|
source=data['source'],
|
|
sources=data['sources']
|
|
)
|
|
self.initialize_module(data=DATA)
|
|
self.item_descriptor.xmodule_runtime.user_location = 'CN'
|
|
|
|
context = self.item_descriptor.render('student_view').content
|
|
|
|
expected_context = dict(initial_context)
|
|
expected_context.update({
|
|
'transcript_translation_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'translation'
|
|
).rstrip('/?'),
|
|
'transcript_available_translations_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'available_translations'
|
|
).rstrip('/?'),
|
|
'ajax_url': self.item_descriptor.xmodule_runtime.ajax_url + '/save_user_state',
|
|
'id': self.item_descriptor.location.html_id(),
|
|
})
|
|
expected_context.update(data['result'])
|
|
|
|
self.assertEqual(
|
|
context,
|
|
self.item_descriptor.xmodule_runtime.render_template('video.html', expected_context)
|
|
)
|
|
|
|
|
|
@patch('xmodule.video_module.video_module.get_video_from_cdn')
|
|
def test_get_html_cdn_source(self, mocked_get_video):
|
|
"""
|
|
Test if sources got from CDN.
|
|
"""
|
|
def side_effect(*args, **kwargs):
|
|
cdn = {
|
|
'http://example.com/example.mp4': 'http://cdn_example.com/example.mp4',
|
|
'http://example.com/example.webm': 'http://cdn_example.com/example.webm',
|
|
}
|
|
return cdn.get(args[1])
|
|
|
|
mocked_get_video.side_effect = side_effect
|
|
|
|
SOURCE_XML = """
|
|
<video show_captions="true"
|
|
display_name="A Name"
|
|
sub="a_sub_file.srt.sjson" source="{source}"
|
|
download_video="{download_video}"
|
|
start_time="01:00:03" end_time="01:00:10"
|
|
>
|
|
{sources}
|
|
</video>
|
|
"""
|
|
cases = [
|
|
{
|
|
'download_video': 'true',
|
|
'source': 'example_source.mp4',
|
|
'sources': """
|
|
<source src="http://example.com/example.mp4"/>
|
|
<source src="http://example.com/example.webm"/>
|
|
""",
|
|
'result': {
|
|
'download_video_link': u'example_source.mp4',
|
|
'sources': json.dumps(
|
|
[
|
|
u'http://cdn_example.com/example.mp4',
|
|
u'http://cdn_example.com/example.webm'
|
|
]
|
|
),
|
|
},
|
|
},
|
|
]
|
|
|
|
initial_context = {
|
|
'data_dir': getattr(self, 'data_dir', None),
|
|
'show_captions': 'true',
|
|
'handout': None,
|
|
'display_name': u'A Name',
|
|
'download_video_link': None,
|
|
'end': 3610.0,
|
|
'id': None,
|
|
'sources': '[]',
|
|
'speed': 'null',
|
|
'general_speed': 1.0,
|
|
'start': 3603.0,
|
|
'saved_video_position': 0.0,
|
|
'sub': u'a_sub_file.srt.sjson',
|
|
'track': None,
|
|
'youtube_streams': '1.00:OEoXaMPEzfM',
|
|
'autoplay': settings.FEATURES.get('AUTOPLAY_VIDEOS', True),
|
|
'yt_test_timeout': 1500,
|
|
'yt_api_url': 'www.youtube.com/iframe_api',
|
|
'yt_test_url': 'gdata.youtube.com/feeds/api/videos/',
|
|
'transcript_download_format': 'srt',
|
|
'transcript_download_formats_list': [{'display_name': 'SubRip (.srt) file', 'value': 'srt'}, {'display_name': 'Text (.txt) file', 'value': 'txt'}],
|
|
'transcript_language': u'en',
|
|
'transcript_languages': '{"en": "English"}',
|
|
}
|
|
|
|
for data in cases:
|
|
DATA = SOURCE_XML.format(
|
|
download_video=data['download_video'],
|
|
source=data['source'],
|
|
sources=data['sources']
|
|
)
|
|
self.initialize_module(data=DATA)
|
|
self.item_descriptor.xmodule_runtime.user_location = 'CN'
|
|
|
|
context = self.item_descriptor.render('student_view').content
|
|
|
|
expected_context = dict(initial_context)
|
|
expected_context.update({
|
|
'transcript_translation_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'translation'
|
|
).rstrip('/?'),
|
|
'transcript_available_translations_url': self.item_descriptor.xmodule_runtime.handler_url(
|
|
self.item_descriptor, 'transcript', 'available_translations'
|
|
).rstrip('/?'),
|
|
'ajax_url': self.item_descriptor.xmodule_runtime.ajax_url + '/save_user_state',
|
|
'id': self.item_descriptor.location.html_id(),
|
|
})
|
|
expected_context.update(data['result'])
|
|
|
|
self.assertEqual(
|
|
context,
|
|
self.item_descriptor.xmodule_runtime.render_template('video.html', expected_context)
|
|
)
|
|
|
|
|
|
class TestVideoDescriptorInitialization(BaseTestXmodule):
|
|
"""
|
|
Make sure that module initialization works correctly.
|
|
"""
|
|
CATEGORY = "video"
|
|
DATA = SOURCE_XML
|
|
METADATA = {}
|
|
|
|
def setUp(self):
|
|
self.setup_course()
|
|
|
|
def test_source_not_in_html5sources(self):
|
|
metadata = {
|
|
'source': 'http://example.org/video.mp4',
|
|
'html5_sources': ['http://youtu.be/OEoXaMPEzfM.mp4'],
|
|
}
|
|
|
|
self.initialize_module(metadata=metadata)
|
|
fields = self.item_descriptor.editable_metadata_fields
|
|
|
|
self.assertIn('source', fields)
|
|
self.assertEqual(self.item_descriptor.source, 'http://example.org/video.mp4')
|
|
self.assertTrue(self.item_descriptor.download_video)
|
|
self.assertTrue(self.item_descriptor.source_visible)
|
|
|
|
def test_source_in_html5sources(self):
|
|
metadata = {
|
|
'source': 'http://example.org/video.mp4',
|
|
'html5_sources': ['http://example.org/video.mp4'],
|
|
}
|
|
|
|
self.initialize_module(metadata=metadata)
|
|
fields = self.item_descriptor.editable_metadata_fields
|
|
|
|
self.assertNotIn('source', fields)
|
|
self.assertTrue(self.item_descriptor.download_video)
|
|
self.assertFalse(self.item_descriptor.source_visible)
|
|
|
|
def test_download_video_is_explicitly_set(self):
|
|
with patch(
|
|
'xmodule.editing_module.TabsEditingDescriptor.editable_metadata_fields',
|
|
new_callable=PropertyMock,
|
|
return_value={
|
|
'download_video': {
|
|
'default_value': False,
|
|
'explicitly_set': True,
|
|
'display_name': 'Video Download Allowed',
|
|
'help': 'Show a link beneath the video to allow students to download the video.',
|
|
'type': 'Boolean',
|
|
'value': False,
|
|
'field_name': 'download_video',
|
|
'options': [
|
|
{'display_name': "True", "value": True},
|
|
{'display_name': "False", "value": False}
|
|
],
|
|
},
|
|
'html5_sources': {
|
|
'default_value': [],
|
|
'explicitly_set': False,
|
|
'display_name': 'Video Sources',
|
|
'help': 'A list of filenames to be used with HTML5 video.',
|
|
'type': 'List',
|
|
'value': [u'http://youtu.be/OEoXaMPEzfM.mp4'],
|
|
'field_name': 'html5_sources',
|
|
'options': [],
|
|
},
|
|
'source': {
|
|
'default_value': '',
|
|
'explicitly_set': False,
|
|
'display_name': 'Download Video',
|
|
'help': 'The external URL to download the video.',
|
|
'type': 'Generic',
|
|
'value': u'http://example.org/video.mp4',
|
|
'field_name': 'source',
|
|
'options': [],
|
|
},
|
|
'track': {
|
|
'default_value': '',
|
|
'explicitly_set': False,
|
|
'display_name': 'Download Transcript',
|
|
'help': 'The external URL to download the timed transcript track.',
|
|
'type': 'Generic',
|
|
'value': u'http://some_track.srt',
|
|
'field_name': 'track',
|
|
'options': [],
|
|
},
|
|
'download_track': {
|
|
'default_value': False,
|
|
'explicitly_set': False,
|
|
'display_name': 'Transcript Download Allowed',
|
|
'help': 'Show a link beneath the video to allow students to download the transcript. Note: You must add a link to the HTML5 Transcript field above.',
|
|
'type': 'Generic',
|
|
'value': False,
|
|
'field_name': 'download_track',
|
|
'options': [],
|
|
},
|
|
'transcripts': {},
|
|
'handout': {},
|
|
}
|
|
):
|
|
metadata = {
|
|
'track': u'http://some_track.srt',
|
|
'source': 'http://example.org/video.mp4',
|
|
'html5_sources': ['http://youtu.be/OEoXaMPEzfM.mp4'],
|
|
}
|
|
|
|
self.initialize_module(metadata=metadata)
|
|
|
|
fields = self.item_descriptor.editable_metadata_fields
|
|
self.assertIn('source', fields)
|
|
|
|
self.assertFalse(self.item_descriptor.download_video)
|
|
self.assertTrue(self.item_descriptor.source_visible)
|
|
self.assertTrue(self.item_descriptor.download_track)
|
|
|
|
def test_source_is_empty(self):
|
|
metadata = {
|
|
'source': '',
|
|
'html5_sources': ['http://youtu.be/OEoXaMPEzfM.mp4'],
|
|
}
|
|
|
|
self.initialize_module(metadata=metadata)
|
|
fields = self.item_descriptor.editable_metadata_fields
|
|
|
|
self.assertNotIn('source', fields)
|
|
self.assertFalse(self.item_descriptor.download_video)
|
|
|
|
|
|
class VideoDescriptorTest(VideoDescriptorTestBase):
|
|
"""
|
|
Tests for video descriptor that requires access to django settings.
|
|
"""
|
|
def setUp(self):
|
|
super(VideoDescriptorTest, self).setUp()
|
|
self.descriptor.runtime.handler_url = MagicMock()
|
|
|
|
def test_get_context(self):
|
|
""""
|
|
Test get_context.
|
|
|
|
This test is located here and not in xmodule.tests because get_context calls editable_metadata_fields.
|
|
Which, in turn, uses settings.LANGUAGES from django setttings.
|
|
"""
|
|
correct_tabs = [
|
|
{
|
|
'name': "Basic",
|
|
'template': "video/transcripts.html",
|
|
'current': True
|
|
},
|
|
{
|
|
'name': 'Advanced',
|
|
'template': 'tabs/metadata-edit-tab.html'
|
|
}
|
|
]
|
|
rendered_context = self.descriptor.get_context()
|
|
self.assertListEqual(rendered_context['tabs'], correct_tabs)
|