|
| 1 | +import requests_mock |
| 2 | +from tests.mock import MagicMock, call, patch |
| 3 | +import unittest |
| 4 | + |
| 5 | +import itertools |
| 6 | +from textwrap import dedent |
| 7 | +from threading import Event, Thread |
| 8 | + |
| 9 | +from streamlink.session import Streamlink |
| 10 | +from streamlink.stream.hls import HLSStream |
| 11 | +from streamlink.stream.hls_filtered import FilteredHLSStreamWriter, FilteredHLSStreamReader |
| 12 | + |
| 13 | + |
| 14 | +class _TestSubjectFilteredHLSStreamWriter(FilteredHLSStreamWriter): |
| 15 | + def __init__(self, *args, **kwargs): |
| 16 | + super(_TestSubjectFilteredHLSStreamWriter, self).__init__(*args, **kwargs) |
| 17 | + self.write_wait = Event() |
| 18 | + self.write_done = Event() |
| 19 | + |
| 20 | + def write(self, *args, **kwargs): |
| 21 | + # only write once per step |
| 22 | + self.write_wait.wait() |
| 23 | + self.write_wait.clear() |
| 24 | + |
| 25 | + # don't write again during cleanup |
| 26 | + if self.closed: |
| 27 | + return |
| 28 | + |
| 29 | + super(_TestSubjectFilteredHLSStreamWriter, self).write(*args, **kwargs) |
| 30 | + |
| 31 | + # notify main thread that writing has finished |
| 32 | + self.write_done.set() |
| 33 | + |
| 34 | + |
| 35 | +class _TestSubjectFilteredHLSReader(FilteredHLSStreamReader): |
| 36 | + __writer__ = _TestSubjectFilteredHLSStreamWriter |
| 37 | + |
| 38 | + |
| 39 | +class _TestSubjectReadThread(Thread): |
| 40 | + """ |
| 41 | + Run the reader on a separate thread, so that each read can be controlled from within the main thread |
| 42 | + """ |
| 43 | + def __init__(self, segments, playlists): |
| 44 | + Thread.__init__(self) |
| 45 | + self.daemon = True |
| 46 | + |
| 47 | + self.mocks = mocks = {} |
| 48 | + self.mock = requests_mock.Mocker() |
| 49 | + self.mock.start() |
| 50 | + |
| 51 | + def addmock(method, url, *args, **kwargs): |
| 52 | + mocks[url] = method(url, *args, **kwargs) |
| 53 | + |
| 54 | + addmock(self.mock.get, TestFilteredHLSStream.url_playlist, [{"text": p} for p in playlists]) |
| 55 | + for i, segment in enumerate(segments): |
| 56 | + addmock(self.mock.get, TestFilteredHLSStream.url_segment.format(i), content=segment) |
| 57 | + |
| 58 | + session = Streamlink() |
| 59 | + session.set_option("hls-live-edge", 2) |
| 60 | + session.set_option("hls-timeout", 0) |
| 61 | + session.set_option("stream-timeout", 0) |
| 62 | + |
| 63 | + self.read_wait = Event() |
| 64 | + self.read_done = Event() |
| 65 | + self.data = [] |
| 66 | + self.error = None |
| 67 | + |
| 68 | + self.stream = HLSStream(session, TestFilteredHLSStream.url_playlist) |
| 69 | + self.reader = _TestSubjectFilteredHLSReader(self.stream) |
| 70 | + self.reader.open() |
| 71 | + |
| 72 | + def run(self): |
| 73 | + while True: |
| 74 | + # only read once per step |
| 75 | + self.read_wait.wait() |
| 76 | + self.read_wait.clear() |
| 77 | + |
| 78 | + # don't read again during cleanup |
| 79 | + if self.reader.closed: |
| 80 | + return |
| 81 | + |
| 82 | + try: |
| 83 | + data = self.reader.read(-1) |
| 84 | + self.data.append(data) |
| 85 | + except IOError as err: |
| 86 | + self.error = err |
| 87 | + return |
| 88 | + finally: |
| 89 | + # notify main thread that reading has finished |
| 90 | + self.read_done.set() |
| 91 | + |
| 92 | + def cleanup(self): |
| 93 | + self.reader.close() |
| 94 | + self.mock.stop() |
| 95 | + # make sure that write and read threads halts on cleanup |
| 96 | + self.reader.writer.write_wait.set() |
| 97 | + self.read_wait.set() |
| 98 | + |
| 99 | + def await_write(self): |
| 100 | + writer = self.reader.writer |
| 101 | + if not writer.closed: |
| 102 | + # make one write call and wait until write call has finished |
| 103 | + writer.write_wait.set() |
| 104 | + writer.write_done.wait() |
| 105 | + writer.write_done.clear() |
| 106 | + |
| 107 | + def await_read(self): |
| 108 | + if not self.reader.closed: |
| 109 | + # make one read call and wait until read call has finished |
| 110 | + self.read_wait.set() |
| 111 | + self.read_done.wait() |
| 112 | + self.read_done.clear() |
| 113 | + |
| 114 | + |
| 115 | +@patch("streamlink.stream.hls.HLSStreamWorker.wait", MagicMock(return_value=True)) |
| 116 | +class TestFilteredHLSStream(unittest.TestCase): |
| 117 | + url_playlist = "http://mocked/path/playlist.m3u8" |
| 118 | + url_segment = "http://mocked/path/stream{0}.ts" |
| 119 | + |
| 120 | + @classmethod |
| 121 | + def get_segments(cls, num): |
| 122 | + return ["[{0}]".format(i).encode("ascii") for i in range(num)] |
| 123 | + |
| 124 | + @classmethod |
| 125 | + def get_playlist(cls, media_sequence, items, filtered=False, end=False): |
| 126 | + playlist = dedent(""" |
| 127 | + #EXTM3U |
| 128 | + #EXT-X-VERSION:5 |
| 129 | + #EXT-X-TARGETDURATION:1 |
| 130 | + #EXT-X-MEDIA-SEQUENCE:{0} |
| 131 | + """.format(media_sequence)) |
| 132 | + |
| 133 | + for item in items: |
| 134 | + playlist += "#EXTINF:1.000,{1}\nstream{0}.ts\n".format(item, "filtered" if filtered else "live") |
| 135 | + |
| 136 | + if end: |
| 137 | + playlist += "#EXT-X-ENDLIST\n" |
| 138 | + |
| 139 | + return playlist |
| 140 | + |
| 141 | + @classmethod |
| 142 | + def filter_sequence(cls, sequence): |
| 143 | + return sequence.segment.title == "filtered" |
| 144 | + |
| 145 | + def subject(self, segments, playlists): |
| 146 | + thread = _TestSubjectReadThread(segments, playlists) |
| 147 | + self.addCleanup(thread.cleanup) |
| 148 | + thread.start() |
| 149 | + |
| 150 | + return thread, thread.reader, thread.reader.writer |
| 151 | + |
| 152 | + @patch("streamlink.stream.hls_filtered.FilteredHLSStreamWriter.should_filter_sequence", new=filter_sequence) |
| 153 | + @patch("streamlink.stream.hls_filtered.log") |
| 154 | + def test_filtered_logging(self, mock_log): |
| 155 | + segments = self.get_segments(8) |
| 156 | + thread, reader, writer = self.subject(segments, [ |
| 157 | + self.get_playlist(0, [0, 1], filtered=True), |
| 158 | + self.get_playlist(2, [2, 3], filtered=False), |
| 159 | + self.get_playlist(4, [4, 5], filtered=True), |
| 160 | + self.get_playlist(6, [6, 7], filtered=False, end=True) |
| 161 | + ]) |
| 162 | + |
| 163 | + self.assertTrue(reader.filter_event.is_set(), "Doesn't let the reader wait if not filtering") |
| 164 | + |
| 165 | + for i in range(2): |
| 166 | + thread.await_write() |
| 167 | + thread.await_write() |
| 168 | + self.assertEqual(len(mock_log.info.mock_calls), i * 2 + 1) |
| 169 | + self.assertEqual(mock_log.info.mock_calls[i * 2 + 0], call("Filtering out segments and pausing stream output")) |
| 170 | + self.assertFalse(reader.filter_event.is_set(), "Lets the reader wait if filtering") |
| 171 | + |
| 172 | + thread.await_write() |
| 173 | + thread.await_write() |
| 174 | + self.assertEqual(len(mock_log.info.mock_calls), i * 2 + 2) |
| 175 | + self.assertEqual(mock_log.info.mock_calls[i * 2 + 1], call("Resuming stream output")) |
| 176 | + self.assertTrue(reader.filter_event.is_set(), "Doesn't let the reader wait if not filtering") |
| 177 | + |
| 178 | + thread.await_read() |
| 179 | + |
| 180 | + self.assertEqual( |
| 181 | + b"".join(thread.data), |
| 182 | + b"".join(list(itertools.chain(segments[2:4], segments[6:8]))), |
| 183 | + "Correctly filters out segments" |
| 184 | + ) |
| 185 | + for i, _ in enumerate(segments): |
| 186 | + self.assertTrue(thread.mocks[TestFilteredHLSStream.url_segment.format(i)].called, "Downloads all segments") |
| 187 | + |
| 188 | + # don't patch should_filter_sequence here (it always returns False) |
| 189 | + def test_not_filtered(self): |
| 190 | + segments = self.get_segments(2) |
| 191 | + thread, reader, writer = self.subject(segments, [ |
| 192 | + self.get_playlist(0, [0, 1], filtered=True, end=True) |
| 193 | + ]) |
| 194 | + |
| 195 | + thread.await_write() |
| 196 | + thread.await_write() |
| 197 | + thread.await_read() |
| 198 | + self.assertEqual(b"".join(thread.data), b"".join(segments[0:2]), "Does not filter by default") |
| 199 | + |
| 200 | + @patch("streamlink.stream.hls_filtered.FilteredHLSStreamWriter.should_filter_sequence", new=filter_sequence) |
| 201 | + def test_filtered_timeout(self): |
| 202 | + segments = self.get_segments(2) |
| 203 | + thread, reader, writer = self.subject(segments, [ |
| 204 | + self.get_playlist(0, [0, 1], filtered=False, end=True) |
| 205 | + ]) |
| 206 | + |
| 207 | + thread.await_write() |
| 208 | + thread.await_read() |
| 209 | + self.assertEqual(thread.data, segments[0:1], "Has read the first segment") |
| 210 | + |
| 211 | + # simulate a timeout by having an empty buffer |
| 212 | + # timeout value is set to 0 |
| 213 | + thread.await_read() |
| 214 | + self.assertIsInstance(thread.error, IOError, "Raises a timeout error when no data is available to read") |
| 215 | + |
| 216 | + @patch("streamlink.stream.hls_filtered.FilteredHLSStreamWriter.should_filter_sequence", new=filter_sequence) |
| 217 | + def test_filtered_no_timeout(self): |
| 218 | + segments = self.get_segments(4) |
| 219 | + thread, reader, writer = self.subject(segments, [ |
| 220 | + self.get_playlist(0, [0, 1], filtered=True), |
| 221 | + self.get_playlist(2, [2, 3], filtered=False, end=True) |
| 222 | + ]) |
| 223 | + |
| 224 | + self.assertTrue(reader.filter_event.is_set(), "Doesn't let the reader wait if not filtering") |
| 225 | + |
| 226 | + thread.await_write() |
| 227 | + thread.await_write() |
| 228 | + self.assertFalse(reader.filter_event.is_set(), "Lets the reader wait if filtering") |
| 229 | + |
| 230 | + # make reader read (no data available yet) |
| 231 | + thread.read_wait.set() |
| 232 | + # once data becomes available, the reader continues reading |
| 233 | + thread.await_write() |
| 234 | + self.assertTrue(reader.filter_event.is_set(), "Reader is not waiting anymore") |
| 235 | + |
| 236 | + thread.read_done.wait() |
| 237 | + thread.read_done.clear() |
| 238 | + self.assertFalse(thread.error, "Doesn't time out when filtering") |
| 239 | + self.assertEqual(thread.data, segments[2:3], "Reads next available buffer data") |
| 240 | + |
| 241 | + thread.await_write() |
| 242 | + thread.await_read() |
| 243 | + self.assertEqual(thread.data, segments[2:4]) |
| 244 | + |
| 245 | + @patch("streamlink.stream.hls_filtered.FilteredHLSStreamWriter.should_filter_sequence", new=filter_sequence) |
| 246 | + def test_filtered_closed(self): |
| 247 | + segments = self.get_segments(2) |
| 248 | + thread, reader, writer = self.subject(segments, [ |
| 249 | + self.get_playlist(0, [0, 1], filtered=True) |
| 250 | + ]) |
| 251 | + |
| 252 | + self.assertTrue(reader.filter_event.is_set(), "Doesn't let the reader wait if not filtering") |
| 253 | + thread.await_write() |
| 254 | + self.assertFalse(reader.filter_event.is_set(), "Lets the reader wait if filtering") |
| 255 | + |
| 256 | + # make reader read (no data available yet) |
| 257 | + thread.read_wait.set() |
| 258 | + |
| 259 | + # close stream while reader is waiting for filtering to end |
| 260 | + thread.reader.close() |
| 261 | + thread.read_done.wait() |
| 262 | + thread.read_done.clear() |
| 263 | + self.assertEqual(thread.data, [b""], "Stops reading on stream close") |
0 commit comments