Andal.LND/edx-platform
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: TNL-9460 differentiated API GET

Browse Source 
CMS youtube transcript tests call GET twice & need different responses on each of the two calls

Current solution (setup_caption_responses) decides what to return on basis of call number.

Former solution (mock_request_get()) decided what to return on the basis of kwargs, which would differ on first vs. second call
This commit is contained in:
Bernard Szabo
2022-12-07 12:00:56 -05:00
parent 6b0dce2911
commit c3c8f725dc
5 changed files with 126 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
cms/djangoapps/contentstore/tests/test_transcripts_utils.py
View File

@@ -1,8 +1,8 @@
""" Tests for transcripts_utils. """
import copy
import json
import re
import tempfile
import textwrap
import unittest
@@ -15,7 +15,7 @@ from django.conf import settings
from django.test.utils import override_settings
from django.utils import translation
from cms.djangoapps.contentstore.tests.utils import mock_requests_get
from cms.djangoapps.contentstore.tests.utils import setup_caption_responses
from common.djangoapps.student.tests.factories import UserFactory
from xmodule.contentstore.content import StaticContent # lint-amnesty, pylint: disable=wrong-import-order
from xmodule.contentstore.django import contentstore # lint-amnesty, pylint: disable=wrong-import-order
@@ -222,7 +222,7 @@ class TestDownloadYoutubeSubs(TestYoutubeSubsBase):
def test_success_downloading_subs(self):
response = textwrap.dedent("""<?xml version="1.0" encoding="utf-8" ?>
caption_response_string = textwrap.dedent("""<?xml version="1.0" encoding="utf-8" ?>
<transcript>
<text start="0" dur="0.27"></text>
<text start="0.27" dur="2.45">Test text 1.</text>
@@ -233,12 +233,16 @@ class TestDownloadYoutubeSubs(TestYoutubeSubsBase):
good_youtube_sub = 'good_id_2'
self.clear_sub_content(good_youtube_sub)
language_code = 'en'
with patch('xmodule.video_module.transcripts_utils.requests.get') as mock_get:
mock_get.return_value = Mock(status_code=200, text=response, content=response.encode('utf-8'))
# Check transcripts_utils.GetTranscriptsFromYouTubeException not thrown
setup_caption_responses(mock_get, language_code, caption_response_string)
transcripts_utils.download_youtube_subs(good_youtube_sub, self.course, settings)
mock_get.assert_any_call('http://video.google.com/timedtext', params={'lang': 'en', 'v': 'good_id_2'})
self.assertEqual(2, len(mock_get.mock_calls))
args, kwargs = mock_get.call_args_list[0]
self.assertEqual(args[0], 'https://www.youtube.com/watch?v=good_id_2')
args, kwargs = mock_get.call_args_list[1]
self.assertTrue(re.match(r"^https://www\.youtube\.com/api/timedtext.*", args[0]))
def test_subs_for_html5_vid_with_periods(self):
"""
@@ -256,7 +260,8 @@ class TestDownloadYoutubeSubs(TestYoutubeSubsBase):
@patch('xmodule.video_module.transcripts_utils.requests.get')
def test_fail_downloading_subs(self, mock_get):
mock_get.return_value = Mock(status_code=404, text='Error 404')
track_status_code = 404
setup_caption_responses(mock_get, 'en', 'Error 404', track_status_code)
bad_youtube_sub = 'BAD_YOUTUBE_ID2'
self.clear_sub_content(bad_youtube_sub)
@@ -287,20 +292,6 @@ class TestDownloadYoutubeSubs(TestYoutubeSubsBase):
self.clear_sub_content(good_youtube_sub)
@patch('xmodule.video_module.transcripts_utils.requests.get', side_effect=mock_requests_get)
def test_downloading_subs_using_transcript_name(self, mock_get):
"""
Download transcript using transcript name in url
"""
good_youtube_sub = 'good_id_2'
self.clear_sub_content(good_youtube_sub)
transcripts_utils.download_youtube_subs(good_youtube_sub, self.course, settings)
mock_get.assert_any_call(
'http://video.google.com/timedtext',
params={'lang': 'en', 'v': 'good_id_2', 'name': 'Custom'}
)
class TestGenerateSubsFromSource(TestDownloadYoutubeSubs): # lint-amnesty, pylint: disable=test-inherits-tests
"""Tests for `generate_subs_from_source` function."""
@@ -469,20 +460,21 @@ class TestYoutubeTranscripts(unittest.TestCase):
"""
@patch('xmodule.video_module.transcripts_utils.requests.get')
def test_youtube_bad_status_code(self, mock_get):
mock_get.return_value = Mock(status_code=404, text='test')
track_status_code = 404
setup_caption_responses(mock_get, 'en', 'test', track_status_code)
youtube_id = 'bad_youtube_id'
with self.assertRaises(transcripts_utils.GetTranscriptsFromYouTubeException):
transcripts_utils.get_transcripts_from_youtube(youtube_id, settings, translation)
@patch('xmodule.video_module.transcripts_utils.requests.get')
def test_youtube_empty_text(self, mock_get):
mock_get.return_value = Mock(status_code=200, text='')
setup_caption_responses(mock_get, 'en', '')
youtube_id = 'bad_youtube_id'
with self.assertRaises(transcripts_utils.GetTranscriptsFromYouTubeException):
transcripts_utils.get_transcripts_from_youtube(youtube_id, settings, translation)
def test_youtube_good_result(self):
response = textwrap.dedent("""<?xml version="1.0" encoding="utf-8" ?>
caption_response_string = textwrap.dedent("""<?xml version="1.0" encoding="utf-8" ?>
<transcript>
<text start="0" dur="0.27"></text>
<text start="0.27" dur="2.45">Test text 1.</text>
@@ -496,11 +488,17 @@ class TestYoutubeTranscripts(unittest.TestCase):
'text': ['Test text 1.', 'Test text 2.', 'Test text 3.']
}
youtube_id = 'good_youtube_id'
language_code = 'en'
with patch('xmodule.video_module.transcripts_utils.requests.get') as mock_get:
mock_get.return_value = Mock(status_code=200, text=response, content=response.encode('utf-8'))
setup_caption_responses(mock_get, language_code, caption_response_string)
transcripts = transcripts_utils.get_transcripts_from_youtube(youtube_id, settings, translation)
self.assertEqual(transcripts, expected_transcripts)
mock_get.assert_called_with('http://video.google.com/timedtext', params={'lang': 'en', 'v': 'good_youtube_id'})
self.assertEqual(2, len(mock_get.mock_calls))
args, kwargs = mock_get.call_args_list[0]
self.assertEqual(args[0], f'https://www.youtube.com/watch?v={youtube_id}')
args, kwargs = mock_get.call_args_list[1]
self.assertTrue(re.match(r"^https://www\.youtube\.com/api/timedtext.*", args[0]))
class TestTranscript(unittest.TestCase):