1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
|
from __future__ import annotations
import argparse
import logging
import re
import time
from contextlib import nullcontext
from operator import eq, gt, lt
from typing import TYPE_CHECKING, Any
from unittest.mock import Mock, call, patch
import freezegun
import pytest
import requests.cookies
from streamlink.options import Options
from streamlink.plugin import (
HIGH_PRIORITY,
NORMAL_PRIORITY,
Plugin,
PluginArgument,
PluginArguments,
PluginError,
pluginargument,
pluginmatcher,
)
# noinspection PyProtectedMember
from streamlink.plugin.plugin import (
_COOKIE_KEYS, # noqa: PLC2701
_PLUGINARGUMENT_TYPE_REGISTRY, # noqa: PLC2701
Matcher,
parse_params,
stream_weight,
)
if TYPE_CHECKING:
from streamlink.session import Streamlink
class FakePlugin(Plugin):
def _get_streams(self):
pass # pragma: no cover
class RenamedPlugin(FakePlugin):
__module__ = "foo.bar.baz"
class CustomConstructorOnePlugin(FakePlugin):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
class CustomConstructorTwoPlugin(FakePlugin):
def __init__(self, session, url):
super().__init__(session, url)
class TestPlugin:
@pytest.mark.parametrize(
("pluginclass", "module", "logger"),
[
(Plugin, "plugin", "streamlink.plugin.plugin"),
(FakePlugin, "test_plugin", "tests.test_plugin"),
(RenamedPlugin, "baz", "foo.bar.baz"),
(CustomConstructorOnePlugin, "test_plugin", "tests.test_plugin"),
(CustomConstructorTwoPlugin, "test_plugin", "tests.test_plugin"),
],
)
def test_constructor(
self,
monkeypatch: pytest.MonkeyPatch,
caplog: pytest.LogCaptureFixture,
pluginclass: type[Plugin],
module: str,
logger: str,
session: Streamlink,
):
mock_cache = Mock()
mock_load_cookies = Mock()
monkeypatch.setattr("streamlink.plugin.plugin.Cache", mock_cache)
monkeypatch.setattr(pluginclass, "load_cookies", mock_load_cookies)
plugin = pluginclass(session, "http://localhost")
assert not caplog.records
assert plugin.session is session
assert plugin.url == "http://localhost"
assert plugin.module == module
assert isinstance(plugin.logger, logging.Logger)
assert plugin.logger.name == logger
assert mock_cache.call_args_list == [call(filename="plugin-cache.json", key_prefix=module, disabled=False)]
assert plugin.cache == mock_cache()
assert mock_load_cookies.call_args_list == [call()]
def test_constructor_options(self):
one = FakePlugin(Mock(), "https://mocked", Options({"key": "val"}))
two = FakePlugin(Mock(), "https://mocked")
assert one.get_option("key") == "val"
assert two.get_option("key") is None
one.set_option("key", "other")
assert one.get_option("key") == "other"
assert two.get_option("key") is None
@pytest.mark.parametrize(
("session", "expected"),
[
pytest.param({}, False, id="default"),
pytest.param({"no-plugin-cache": False}, False, id="not-disabled"),
pytest.param({"no-plugin-cache": True}, True, id="disabled"),
],
indirect=["session"],
)
def test_disabled_cache(self, session: Streamlink, expected: bool):
plugin = FakePlugin(session, "https://mocked")
assert plugin.cache._disabled is expected
class TestPluginMatcher:
# noinspection PyUnusedLocal
def test_decorator(self):
class MyPlugin:
pass
with pytest.raises(TypeError) as cm:
# noinspection PyTypeChecker
pluginmatcher(re.compile(r""))(MyPlugin)
assert str(cm.value) == "MyPlugin is not a Plugin"
def test_named_duplicate(self):
class MyPlugin(FakePlugin):
pass
matcher = pluginmatcher(re.compile(r"http://foo"), name="foo")
with pytest.raises(ValueError, match=r"^A matcher named 'foo' has already been registered$"):
matcher(matcher(MyPlugin))
def test_no_matchers(self):
class MyPlugin(FakePlugin):
pass
plugin = MyPlugin(Mock(), "http://foo")
assert plugin.url == "http://foo"
assert plugin.matchers == []
assert plugin.matches == []
assert plugin.matcher is None
assert plugin.match is None
def test_matchers(self):
@pluginmatcher(re.compile(r"foo", re.VERBOSE))
@pluginmatcher(re.compile(r"bar"), priority=HIGH_PRIORITY)
@pluginmatcher(re.compile(r"baz"), priority=HIGH_PRIORITY, name="baz")
class MyPlugin(FakePlugin):
pass
assert MyPlugin.matchers == [
Matcher(re.compile(r"foo", re.VERBOSE), NORMAL_PRIORITY),
Matcher(re.compile(r"bar"), HIGH_PRIORITY),
Matcher(re.compile(r"baz"), HIGH_PRIORITY, "baz"),
]
def test_matchers_inheritance(self):
@pluginmatcher(re.compile(r"foo"))
@pluginmatcher(re.compile(r"bar"))
class PluginOne(FakePlugin):
pass
@pluginmatcher(re.compile(r"baz"))
@pluginmatcher(re.compile(r"qux"))
class PluginTwo(PluginOne):
pass
assert PluginOne.matchers is not PluginTwo.matchers
assert PluginOne.matchers == [
Matcher(re.compile(r"foo"), NORMAL_PRIORITY),
Matcher(re.compile(r"bar"), NORMAL_PRIORITY),
]
assert PluginTwo.matchers == [
Matcher(re.compile(r"baz"), NORMAL_PRIORITY),
Matcher(re.compile(r"qux"), NORMAL_PRIORITY),
Matcher(re.compile(r"foo"), NORMAL_PRIORITY),
Matcher(re.compile(r"bar"), NORMAL_PRIORITY),
]
# noinspection PyUnusedLocal
def test_matchers_inheritance_named_duplicate(self):
@pluginmatcher(name="foo", pattern=re.compile(r"foo"))
class PluginOne(FakePlugin):
pass
with pytest.raises(ValueError, match=r"^A matcher named 'foo' has already been registered$"):
@pluginmatcher(name="foo", pattern=re.compile(r"foo"))
class PluginTwo(PluginOne):
pass
def test_matchers_not_matching(self):
@pluginmatcher(re.compile(r"http://foo"))
class MyPlugin(FakePlugin):
pass
with pytest.raises(PluginError, match=r"^The input URL did not match any of this plugin's matchers$"):
MyPlugin(Mock(), "http://bar")
def test_no_matchers_not_matching(self):
plugin = FakePlugin(Mock(), "")
assert plugin.match is None
def test_url_setter(self):
@pluginmatcher(re.compile(r"http://(foo)"))
@pluginmatcher(re.compile(r"http://(bar)"))
@pluginmatcher(re.compile(r"http://(baz)"))
class MyPlugin(FakePlugin):
pass
plugin = MyPlugin(Mock(), "http://foo")
assert plugin.url == "http://foo"
assert [m is not None for m in plugin.matches] == [True, False, False]
assert plugin.matcher is plugin.matchers[0].pattern
assert plugin.match.group(1) == "foo"
plugin.url = "http://bar"
assert plugin.url == "http://bar"
assert [m is not None for m in plugin.matches] == [False, True, False]
assert plugin.matcher is plugin.matchers[1].pattern
assert plugin.match.group(1) == "bar"
plugin.url = "http://baz"
assert plugin.url == "http://baz"
assert [m is not None for m in plugin.matches] == [False, False, True]
assert plugin.matcher is plugin.matchers[2].pattern
assert plugin.match.group(1) == "baz"
plugin.url = "http://qux"
assert plugin.url == "http://qux"
assert [m is not None for m in plugin.matches] == [False, False, False]
assert plugin.matcher is None
assert plugin.match is None
def test_named_matchers_and_matches(self):
@pluginmatcher(re.compile(r"http://foo"), name="foo")
@pluginmatcher(re.compile(r"http://bar"), name="bar")
class MyPlugin(FakePlugin):
pass
plugin = MyPlugin(Mock(), "http://foo")
assert plugin.matchers["foo"] is plugin.matchers[0]
assert plugin.matchers["bar"] is plugin.matchers[1]
with pytest.raises(IndexError):
plugin.matchers.__getitem__(2)
with pytest.raises(KeyError):
plugin.matchers.__getitem__("baz")
assert plugin.matches["foo"] is plugin.matches[0]
assert plugin.matches["bar"] is plugin.matches[1]
assert plugin.matches["foo"] is not None
assert plugin.matches["bar"] is None
with pytest.raises(IndexError):
plugin.matches.__getitem__(2)
with pytest.raises(KeyError):
plugin.matches.__getitem__("baz")
plugin.url = "http://bar"
assert plugin.matches["foo"] is None
assert plugin.matches["bar"] is not None
plugin.url = "http://baz"
assert plugin.matches["foo"] is None
assert plugin.matches["bar"] is None
class TestPluginArguments:
@pluginargument("foo", dest="_foo", help="FOO")
@pluginargument("bar", dest="_bar", help="BAR")
@pluginargument("baz", dest="_baz", help="BAZ")
class DecoratedPlugin(FakePlugin):
pass
class ClassAttrPlugin(FakePlugin):
arguments = PluginArguments(
PluginArgument("foo", dest="_foo", help="FOO"),
PluginArgument("bar", dest="_bar", help="BAR"),
PluginArgument("baz", dest="_baz", help="BAZ"),
)
def test_pluginargument_type_registry(self):
assert _PLUGINARGUMENT_TYPE_REGISTRY
assert all(callable(value) for value in _PLUGINARGUMENT_TYPE_REGISTRY.values())
@pytest.mark.parametrize("pluginclass", [DecoratedPlugin, ClassAttrPlugin])
def test_arguments(self, pluginclass):
assert pluginclass.arguments is not None
assert tuple(arg.name for arg in pluginclass.arguments) == ("foo", "bar", "baz"), "Argument name"
assert tuple(arg.dest for arg in pluginclass.arguments) == ("_foo", "_bar", "_baz"), "Argument keyword"
assert tuple(arg.options.get("help") for arg in pluginclass.arguments) == ("FOO", "BAR", "BAZ"), "argparse keyword"
@pytest.mark.parametrize("pluginclass", [DecoratedPlugin, ClassAttrPlugin])
def test_arguments_mixed(self, pluginclass):
@pluginargument("qux")
class MixedPlugin(pluginclass):
pass
assert tuple(arg.name for arg in MixedPlugin.arguments) == ("qux", "foo", "bar", "baz")
def test_arguments_inheritance(self):
@pluginargument("foo", help="FOO")
@pluginargument("bar", help="BAR")
class PluginOne(FakePlugin):
pass
@pluginargument("baz", help="BAZ")
@pluginargument("qux", help="QUX")
class PluginTwo(PluginOne):
pass
assert PluginOne.arguments is not PluginTwo.arguments
assert tuple(arg.name for arg in PluginOne.arguments) == ("foo", "bar")
assert tuple(arg.name for arg in PluginTwo.arguments) == ("baz", "qux", "foo", "bar")
@pytest.mark.parametrize(
("options", "args", "expected", "raises"),
[
pytest.param(
{"type": "int"},
["--myplugin-foo", "123"],
123,
nullcontext(),
id="int",
),
pytest.param(
{"type": "float"},
["--myplugin-foo", "123.456"],
123.456,
nullcontext(),
id="float",
),
pytest.param(
{"type": "bool"},
["--myplugin-foo", "yes"],
True,
nullcontext(),
id="bool",
),
pytest.param(
{"type": "keyvalue"},
["--myplugin-foo", "key=value"],
("key", "value"),
nullcontext(),
id="keyvalue",
),
pytest.param(
{"type": "comma_list_filter", "type_args": (["one", "two", "four"],)},
["--myplugin-foo", "one,two,three,four"],
["one", "two", "four"],
nullcontext(),
id="comma_list_filter - args",
),
pytest.param(
{"type": "comma_list_filter", "type_kwargs": {"acceptable": ["one", "two", "four"]}},
["--myplugin-foo", "one,two,three,four"],
["one", "two", "four"],
nullcontext(),
id="comma_list_filter - kwargs",
),
pytest.param(
{"type": "hours_minutes_seconds"},
["--myplugin-foo", "1h2m3s"],
3723,
nullcontext(),
id="hours_minutes_seconds",
),
pytest.param(
{"type": "UNKNOWN"},
None,
None,
pytest.raises(TypeError),
id="UNKNOWN",
),
],
)
def test_type_argument_map(self, options: dict, args: list, expected: Any, raises: nullcontext):
class MyPlugin(FakePlugin):
pass
with raises:
pluginargument("foo", **options)(MyPlugin)
assert MyPlugin.arguments is not None
pluginarg = MyPlugin.arguments.get("foo")
assert pluginarg
parser = argparse.ArgumentParser()
parser.add_argument(pluginarg.argument_name("myplugin"), **pluginarg.options)
namespace = parser.parse_args(args)
assert namespace.myplugin_foo == expected
def test_decorator_typeerror(self, monkeypatch: pytest.MonkeyPatch):
class NotAPluginMeta(type):
def __repr__(self) -> str:
return self.__name__
with pytest.raises(TypeError, match=r"^NotAPlugin is not a Plugin$"):
# noinspection PyUnusedLocal
@pluginargument("foo") # type: ignore[arg-type]
class NotAPlugin(metaclass=NotAPluginMeta):
pass
def test_empty(self):
assert FakePlugin.arguments is not None
assert tuple(iter(FakePlugin.arguments)) == ()
@pytest.mark.parametrize("attr", ["id", "author", "category", "title"])
def test_plugin_metadata(attr):
plugin = FakePlugin(Mock(), "https://foo.bar/")
getter = getattr(plugin, f"get_{attr}")
assert callable(getter)
assert getattr(plugin, attr) is None
assert getter() is None
setattr(plugin, attr, " foo bar ")
assert getter() == "foo bar"
class Foo:
def __str__(self):
return " baz qux "
setattr(plugin, attr, Foo())
assert getter() == "baz qux"
class TestCookies:
@staticmethod
def create_cookie_dict(name, value, expires=None):
return dict(
version=0,
name=name,
value=value,
port=None,
domain="test.se",
path="/",
secure=False,
expires=expires,
discard=True,
comment=None,
comment_url=None,
rest={"HttpOnly": None},
rfc2109=False,
)
@pytest.fixture()
def pluginclass(self):
class MyPlugin(FakePlugin):
__module__ = "myplugin"
return MyPlugin
@pytest.fixture()
def plugincache(self, request):
with patch("streamlink.plugin.plugin.Cache") as mock_cache:
cache = mock_cache("plugin-cache.json", "myplugin")
cache.get_all.return_value = request.param
yield cache
@pytest.fixture()
def logger(self, pluginclass: type[Plugin]):
with patch("streamlink.plugin.plugin.logging") as mock_logging:
yield mock_logging.getLogger(pluginclass.__module__)
@pytest.fixture()
def plugin(self, pluginclass: type[Plugin], session: Streamlink, plugincache: Mock, logger: Mock):
plugin = pluginclass(session, "http://test.se")
assert plugin.cache is plugincache
assert plugin.logger is logger
return plugin
@staticmethod
def _cookie_to_dict(cookie):
r = {name: getattr(cookie, name, None) for name in _COOKIE_KEYS}
r["rest"] = getattr(cookie, "rest", getattr(cookie, "_rest", None))
return r
def _cookies_to_list(self, cookies):
return [self._cookie_to_dict(cookie) for cookie in cookies]
@pytest.mark.parametrize(
"plugincache",
[
{
"__cookie:test-name1:test.se:80:/": create_cookie_dict("test-name1", "test-value1"),
"__cookie:test-name2:test.se:80:/": create_cookie_dict("test-name2", "test-value2"),
"unrelated": "data",
},
],
indirect=True,
)
def test_load(self, session: Streamlink, plugin: Plugin, plugincache: Mock, logger: Mock):
assert self._cookies_to_list(session.http.cookies) == self._cookies_to_list([
requests.cookies.create_cookie("test-name1", "test-value1", domain="test.se"),
requests.cookies.create_cookie("test-name2", "test-value2", domain="test.se"),
])
assert logger.debug.call_args_list == [call("Restored cookies: test-name1, test-name2")]
@pytest.mark.parametrize("plugincache", [{}], indirect=True)
def test_save(self, session: Streamlink, plugin: Plugin, plugincache: Mock, logger: Mock):
cookie1 = requests.cookies.create_cookie("test-name1", "test-value1", domain="test.se")
cookie2 = requests.cookies.create_cookie("test-name2", "test-value2", domain="test.se")
session.http.cookies.set_cookie(cookie1)
session.http.cookies.set_cookie(cookie2)
plugin.save_cookies(lambda cookie: cookie.name == "test-name1", default_expires=3600)
assert plugincache.set.call_args_list == [
call(
"__cookie:test-name1:test.se:80:/",
self.create_cookie_dict("test-name1", "test-value1", None),
3600,
),
]
assert logger.debug.call_args_list == [call("Saved cookies: test-name1")]
@freezegun.freeze_time("1970-01-01T00:00:00Z")
@pytest.mark.parametrize("plugincache", [{}], indirect=True)
def test_save_expires(self, session: Streamlink, plugin: Plugin, plugincache: Mock):
cookie = requests.cookies.create_cookie(
"test-name",
"test-value",
domain="test.se",
expires=time.time() + 3600,
rest={"HttpOnly": None},
)
session.http.cookies.set_cookie(cookie)
plugin.save_cookies(default_expires=60)
assert plugincache.set.call_args_list == [
call(
"__cookie:test-name:test.se:80:/",
self.create_cookie_dict("test-name", "test-value", 3600),
3600,
),
]
@pytest.mark.parametrize(
"plugincache",
[
{
"__cookie:test-name1:test.se:80:/": create_cookie_dict("test-name1", "test-value1", None),
"__cookie:test-name2:test.se:80:/": create_cookie_dict("test-name2", "test-value2", None),
"unrelated": "data",
},
],
indirect=True,
)
def test_clear(self, session: Streamlink, plugin: Plugin, plugincache: Mock):
assert tuple(session.http.cookies.keys()) == ("test-name1", "test-name2")
plugin.clear_cookies()
assert call("__cookie:test-name1:test.se:80:/", None, 0) in plugincache.set.call_args_list
assert call("__cookie:test-name2:test.se:80:/", None, 0) in plugincache.set.call_args_list
assert len(session.http.cookies.keys()) == 0
@pytest.mark.parametrize(
"plugincache",
[
{
"__cookie:test-name1:test.se:80:/": create_cookie_dict("test-name1", "test-value1", None),
"__cookie:test-name2:test.se:80:/": create_cookie_dict("test-name2", "test-value2", None),
"unrelated": "data",
},
],
indirect=True,
)
def test_clear_filter(self, session: Streamlink, plugin: Plugin, plugincache: Mock):
assert tuple(session.http.cookies.keys()) == ("test-name1", "test-name2")
plugin.clear_cookies(lambda cookie: cookie.name == "test-name2")
assert call("__cookie:test-name1:test.se:80:/", None, 0) not in plugincache.set.call_args_list
assert call("__cookie:test-name2:test.se:80:/", None, 0) in plugincache.set.call_args_list
assert tuple(session.http.cookies.keys()) == ("test-name1",)
@pytest.mark.parametrize(
("params", "expected"),
[
(
None,
{},
),
(
"foo=bar",
dict(foo="bar"),
),
(
"verify=False",
dict(verify=False),
),
(
"timeout=123.45",
dict(timeout=123.45),
),
(
"verify=False params={'key': 'a value'}",
dict(verify=False, params=dict(key="a value")),
),
(
"\"conn=['B:1', 'S:authMe', 'O:1', 'NN:code:1.23', 'NS:flag:ok', 'O:0']",
dict(conn=["B:1", "S:authMe", "O:1", "NN:code:1.23", "NS:flag:ok", "O:0"]),
),
],
)
def test_parse_params(params, expected):
assert parse_params(params) == expected
@pytest.mark.parametrize(
("weight", "expected"),
[
("720p", (720, "pixels")),
("720p+", (721, "pixels")),
("720p60", (780, "pixels")),
],
)
def test_stream_weight_value(weight, expected):
assert stream_weight(weight) == expected
@pytest.mark.parametrize(
("weight_a", "operator", "weight_b"),
[
("720p+", gt, "720p"),
("720p_3000k", gt, "720p_2500k"),
("720p60_3000k", gt, "720p_3000k"),
("3000k", gt, "2500k"),
("720p", eq, "720p"),
("720p_3000k", lt, "720p+_3000k"),
# with audio
("720p+a256k", gt, "720p+a128k"),
("720p+a256k", gt, "360p+a256k"),
("720p+a128k", gt, "360p+a256k"),
],
)
def test_stream_weight(weight_a, weight_b, operator):
assert operator(stream_weight(weight_a), stream_weight(weight_b))
|