Skip to content

E
edx-val
Unverified Commit f7a077bd by irfanuddinahmad Committed by GitHub
Options

Merge pull request #137 from edx/iahmad/atomic_transcript 

moved delete transcript after create
parents 00b8ded8 034091c9
Showing with 78 additions and 53 deletions
edxval/models.py
......@@ -491,35 +491,37 @@ class VideoTranscript(TimeStampedModel):
Returns:
Returns a tuple of (video_transcript, created).
"""
video_transcript, created = cls.objects.get_or_create(video=video, language_code=language_code)
try:
video_transcript = cls.objects.get(video=video, language_code=language_code)
retrieved = True
except cls.DoesNotExist:
video_transcript = cls(video=video, language_code=language_code)
retrieved = False
for prop, value in metadata.iteritems():
if prop in ['language_code', 'file_format', 'provider']:
setattr(video_transcript, prop, value)
transcript_name = metadata.get('file_name')
if transcript_name:
video_transcript.transcript.name = transcript_name
elif file_data:
# Delete the existing transcript file and
# recreate with the new content
if not created:
video_transcript.transcript.delete()
with closing(file_data) as transcript_file_data:
file_name = '{uuid}.{ext}'.format(uuid=uuid4().hex, ext=video_transcript.file_format)
try:
try:
if transcript_name:
video_transcript.transcript.name = transcript_name
elif file_data:
with closing(file_data) as transcript_file_data:
file_name = '{uuid}.{ext}'.format(uuid=uuid4().hex, ext=video_transcript.file_format)
video_transcript.transcript.save(file_name, transcript_file_data)
except Exception:
logger.exception(
'[VAL] Transcript save failed to storage for video_id "%s" language code "%s"',
video.edx_video_id,
language_code
)
raise
video_transcript.save()
return video_transcript, created
video_transcript.save()
except Exception:
logger.exception(
'[VAL] Transcript save failed to storage for video_id "%s" language code "%s"',
video.edx_video_id,
language_code
)
raise
return video_transcript, not retrieved
def url(self):
"""
......
edxval/tests/test_api.py
......@@ -2480,6 +2480,60 @@ class TranscriptTest(TestCase):
self.assertEqual(transcript_exception.exception.message, exception_message)
@mock.patch.object(VideoTranscript, 'save')
def test_create_or_update_transcript_exception_on_update(self, mock_save):
"""
Verify `create_or_update_video_transcript` api function does not update transcript on exception
"""
file_data = ContentFile(constants.TRANSCRIPT_DATA['overwatch'])
language_code = 'en'
edx_video_id = 'super-soaker'
mock_save.side_effect = DatabaseError
with self.assertRaises(DatabaseError):
api.create_or_update_video_transcript(
video_id=edx_video_id,
language_code=language_code,
metadata=dict(
provider=TranscriptProviderType.THREE_PLAY_MEDIA,
file_name=None,
file_format=utils.TranscriptFormat.SRT
),
file_data=file_data
)
# Assert that there are no updates to the transcript data
video_transcript = VideoTranscript.objects.get(video__edx_video_id=edx_video_id,
language_code=language_code)
with open(video_transcript.transcript.name) as saved_transcript:
self.assertNotEqual(saved_transcript.read(), constants.TRANSCRIPT_DATA['overwatch'])
@mock.patch.object(VideoTranscript, 'save')
def test_create_or_update_transcript_exception_on_create(self, mock_save):
"""
Verify `create_or_update_video_transcript` api function does not create transcript on exception.
"""
file_data = ContentFile(constants.TRANSCRIPT_DATA['overwatch'])
language_code = 'ar'
edx_video_id = 'super-soaker'
mock_save.side_effect = DatabaseError
with self.assertRaises(DatabaseError):
api.create_or_update_video_transcript(
video_id=edx_video_id,
language_code=language_code,
metadata=dict(
provider=TranscriptProviderType.THREE_PLAY_MEDIA,
file_name=None,
file_format=utils.TranscriptFormat.SRT
),
file_data=file_data
)
# Assert that there is no transcript record
with self.assertRaises(VideoTranscript.DoesNotExist):
VideoTranscript.objects.get(video__edx_video_id=edx_video_id, language_code=language_code)
def test_create_video_transcript(self):
"""
Verify that `create_video_transcript` api function creates transcript as expected.
......@@ -2541,37 +2595,6 @@ class TranscriptTest(TestCase):
self.assertIn(exception_msg, unicode(transcript_exception.exception.message))
def test_video_transcript_deletion(self):
"""
Test video transcript deletion works as expected.
"""
edx_video_id = 'super-soaker'
# get an existing video transcript
video_transcript = VideoTranscript.objects.get(video__edx_video_id=edx_video_id, language_code='en')
existing_transcript_url = video_transcript.url()
# This will replace the transcript for an existing video and delete the existing transcript
new_transcript_url = api.create_or_update_video_transcript(
video_id=edx_video_id,
language_code='en',
metadata=dict(provider=TranscriptProviderType.CIELO24),
file_data=ContentFile(constants.TRANSCRIPT_DATA['overwatch'])
)
# Verify that new transcript is set to video
video_transcript = VideoTranscript.objects.get(video__edx_video_id=edx_video_id, language_code='en')
self.assertEqual(video_transcript.url(), new_transcript_url)
# verify that new data is written correctly
with open(video_transcript.transcript.name) as saved_transcript:
self.assertEqual(saved_transcript.read(), constants.TRANSCRIPT_DATA['overwatch'])
# Verify that an exception is raised if we try to open a deleted transcript file
with self.assertRaises(IOError) as file_open_exception:
File(open(existing_transcript_url))
self.assertEqual(file_open_exception.exception.strerror, u'No such file or directory')
def test_get_available_transcript_languages(self):
"""
Verify that `get_available_transcript_languages` works as expected.
......
setup.py
......@@ -41,7 +41,7 @@ def load_requirements(*requirements_paths):
setup(
name='edxval',
version='0.1.13',
version='0.1.14',
author='edX',
url='http://github.com/edx/edx-val',
description='edx-val',
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment