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
|
from __future__ import annotations
import logging
import warnings
from datetime import timezone
from errno import EINVAL, EPIPE
from inspect import currentframe, getframeinfo
from io import BytesIO, TextIOWrapper
from pathlib import Path
from typing import TYPE_CHECKING
import freezegun
import pytest
from streamlink import logger
from streamlink.exceptions import StreamlinkDeprecationWarning, StreamlinkWarning
if TYPE_CHECKING:
from collections.abc import Iterable
def getvalue(output: TextIOWrapper, size: int = -1):
output.seek(0)
return output.read(size)
@pytest.fixture()
def output(request: pytest.FixtureRequest):
params = getattr(request, "param", {})
params.setdefault("encoding", "utf-8")
output = TextIOWrapper(BytesIO(), **params)
return output
@pytest.fixture()
def logfile(tmp_path: Path) -> Path:
return tmp_path / "log.txt"
@pytest.fixture()
def log(request: pytest.FixtureRequest, monkeypatch: pytest.MonkeyPatch, output: TextIOWrapper):
params = getattr(request, "param", {})
params.setdefault("format", "[{name}][{levelname}] {message}")
params.setdefault("style", "{")
if "logfile" in request.fixturenames:
params["filename"] = request.getfixturevalue("logfile")
fakeroot = logging.getLogger("streamlink.test")
monkeypatch.setattr("streamlink.logger.root", fakeroot)
monkeypatch.setattr("streamlink.utils.times.LOCAL", timezone.utc)
stream: TextIOWrapper | None = output if params.pop("stream", True) else None
handler = logger.basicConfig(stream=stream, **params)
if stream is None:
assert handler is None
else:
assert isinstance(handler, logging.StreamHandler)
yield fakeroot
logger.capturewarnings(False)
if handler:
handler.close()
fakeroot.removeHandler(handler)
assert not fakeroot.handlers
class TestLogging:
@pytest.fixture()
def log_failure(
self,
request: pytest.FixtureRequest,
monkeypatch: pytest.MonkeyPatch,
log: logging.Logger,
output: TextIOWrapper,
):
params = getattr(request, "param", {})
root = logging.getLogger("streamlink")
monkeypatch.setattr("streamlink.logger.root", root)
with pytest.raises(Exception) as cm: # noqa: PT011
logger.basicConfig(stream=output, **params)
return cm.value
@pytest.mark.parametrize(
("name", "level"),
[
("none", logger.NONE),
("critical", logger.CRITICAL),
("error", logger.ERROR),
("warning", logger.WARNING),
("info", logger.INFO),
("debug", logger.DEBUG),
("trace", logger.TRACE),
("all", logger.ALL),
],
)
def test_level_names(self, name: str, level: int):
assert logging.getLevelName(level) == name
assert logging.getLevelName(name) == level
assert logging.getLevelName(name.upper()) == level
def test_levels_list(self):
assert logger.levels == ["none", "critical", "error", "warning", "info", "debug", "trace", "all"]
def test_default_level(self):
assert logging.getLogger("streamlink").level == logger.WARNING
def test_level(self, log: logging.Logger, output: TextIOWrapper):
log.setLevel("info")
log.debug("test")
output.seek(0)
assert output.tell() == 0
log.setLevel("debug")
log.debug("test")
assert output.tell() != 0
def test_level_none(self, log: logging.Logger, output: TextIOWrapper):
log.setLevel("none")
log.critical("test")
log.error("test")
log.warning("test")
log.info("test")
log.debug("test")
log.trace("test") # type: ignore[attr-defined]
log.trace("paranoid") # type: ignore[attr-defined]
assert not getvalue(output)
def test_output(self, log: logging.Logger, output: TextIOWrapper):
log.setLevel("debug")
log.debug("test")
assert getvalue(output) == "[test][debug] test\n"
@pytest.mark.parametrize(
("loglevel", "calllevel", "expected"),
[
(logger.DEBUG, logger.TRACE, ""),
(logger.TRACE, logger.TRACE, "[test][trace] test\n"),
(logger.TRACE, logger.DEBUG, "[test][debug] test\n"),
(logger.TRACE, logger.ALL, ""),
(logger.ALL, logger.ALL, "[test][all] test\n"),
(logger.ALL, logger.TRACE, "[test][trace] test\n"),
],
)
def test_custom_output(self, log: logging.Logger, output: TextIOWrapper, loglevel: int, calllevel: int, expected: str):
log.setLevel(loglevel)
log.log(calllevel, "test")
assert getvalue(output) == expected
# https://github.com/streamlink/streamlink/issues/4862
@pytest.mark.parametrize(
("level", "levelname"),
[
(logger.TRACE, "trace"),
(logger.ALL, "all"),
],
)
def test_custom_module_name(self, caplog: pytest.LogCaptureFixture, log: logging.Logger, level: int, levelname: str):
caplog.set_level(1)
log = logging.getLogger(self.__class__.__module__)
getattr(log, levelname)("foo")
log.log(level, "bar")
assert [(record.module, record.levelname, record.message) for record in caplog.records] == [
("test_logger", levelname, "foo"),
("test_logger", levelname, "bar"),
]
@pytest.mark.parametrize(
("level", "expected"),
[
(logger.DEBUG, ""),
(logger.INFO, "[test][info] foo\n[test][info] bar\n"),
],
)
def test_iter(self, log: logger.StreamlinkLogger, output: TextIOWrapper, level: int, expected: str):
def iterator():
yield "foo"
yield "bar"
log.setLevel(logger.INFO)
assert list(log.iter(level, iterator())) == ["foo", "bar"]
assert getvalue(output) == expected
@pytest.mark.parametrize(
"log",
[
{"style": "%", "format": "[%(name)s][%(levelname)s] %(message)s"},
],
indirect=True,
)
def test_style_percent(self, log: logging.Logger, output: TextIOWrapper):
log.setLevel("info")
log.info("test")
assert getvalue(output) == "[test][info] test\n"
@pytest.mark.parametrize("log_failure", [{"style": "invalid"}], indirect=True)
def test_style_invalid(self, log_failure):
assert type(log_failure) is ValueError
assert str(log_failure) == "Style must be one of: %,{,$"
@freezegun.freeze_time("2000-01-02T03:04:05.123456Z")
@pytest.mark.parametrize(
"log",
[
{"format": "[{asctime}][{name}][{levelname}] {message}"},
],
indirect=True,
)
def test_datefmt_default(self, log: logging.Logger, output: TextIOWrapper):
log.setLevel("info")
log.info("test")
assert getvalue(output) == "[03:04:05][test][info] test\n"
@freezegun.freeze_time("2000-01-02T03:04:05.123456Z")
@pytest.mark.parametrize(
"log",
[
{"format": "[{asctime}][{name}][{levelname}] {message}", "datefmt": "%H:%M:%S.%f%z"},
],
indirect=True,
)
def test_datefmt_custom(self, log: logging.Logger, output: TextIOWrapper):
log.setLevel("info")
log.info("test")
assert getvalue(output) == "[03:04:05.123456+0000][test][info] test\n"
@pytest.mark.parametrize(
("output", "expected"),
[
pytest.param(
{"encoding": "utf-8"},
"Bär: 🐻",
id="utf-8",
),
pytest.param(
{"encoding": "ascii"},
"B\\xe4r: \\U0001f43b",
id="ascii",
),
pytest.param(
{"encoding": "iso-8859-1"},
"Bär: \\U0001f43b",
id="iso-8859-1",
),
pytest.param(
{"encoding": "shift_jis"},
"B\\xe4r: \\U0001f43b",
id="shift_jis",
),
],
indirect=["output"],
)
def test_logstream_encoding(self, log: logging.Logger, output: TextIOWrapper, expected: str):
log.setLevel("info")
log.info("Bär: 🐻")
assert getvalue(output) == f"[test][info] {expected}\n"
def test_logstream_switch(self, log: logging.Logger, output: TextIOWrapper):
output_ascii = TextIOWrapper(BytesIO(), encoding="ascii", errors="strict")
log.setLevel("info")
log.info("Bär: 🐻")
assert getvalue(output) == "[test][info] Bär: 🐻\n"
assert getvalue(output_ascii) == ""
assert isinstance(log.handlers[0], logging.StreamHandler)
# noinspection PyUnresolvedReferences
log.handlers[0].setStream(output_ascii)
log.info("Bär: 🐻")
assert getvalue(output) == "[test][info] Bär: 🐻\n"
assert getvalue(output_ascii) == "[test][info] B\\xe4r: \\U0001f43b\n"
@pytest.mark.parametrize("log", [pytest.param({"stream": None}, id="no-stdout")], indirect=["log"])
def test_no_stream(self, log: logging.Logger):
assert not log.handlers
@pytest.mark.parametrize(
"errno",
[
pytest.param(EPIPE, id="EPIPE", marks=pytest.mark.posix_only),
pytest.param(EINVAL, id="EINVAL", marks=pytest.mark.windows_only),
],
)
def test_brokenpipeerror(
self,
monkeypatch: pytest.MonkeyPatch,
capsys: pytest.CaptureFixture[str],
log: logging.Logger,
errno: int,
):
def flush(*_, **__):
exception = OSError()
exception.errno = errno
raise exception
streamhandler = log.handlers[0]
assert isinstance(streamhandler, logging.StreamHandler)
monkeypatch.setattr(streamhandler.stream, "flush", flush)
log.setLevel("info")
log.info("foo")
# logging.StreamHandler will write emit()/flush() errors to stderr via handleError()
out, err = capsys.readouterr()
assert not out
assert not err
def test_logfile(self, logfile: Path, log: logging.Logger, output: TextIOWrapper):
log.setLevel("info")
log.info("Hello world, Γειά σου Κόσμε, こんにちは世界") # noqa: RUF001
log.handlers[0].flush()
with logfile.open("r", encoding="utf-8") as fh:
assert fh.read() == "[test][info] Hello world, Γειά σου Κόσμε, こんにちは世界\n" # noqa: RUF001
class TestCaptureWarnings:
@staticmethod
def _warn(messages: Iterable[tuple[str, type[Warning]]], filterwarnings=None):
frame = currentframe()
assert frame
assert frame.f_back
lineno = getframeinfo(frame.f_back).lineno
with warnings.catch_warnings():
warnings.filterwarnings(filterwarnings or "always")
for message, warningclass in messages:
warnings.warn(message, warningclass, stacklevel=2)
return lineno
def test_no_capture(self, log: logging.Logger, output: TextIOWrapper):
with pytest.warns(UserWarning, match=r"^Test warning$"):
self._warn([("Test warning", UserWarning)])
assert getvalue(output) == ""
@pytest.mark.parametrize("log", [{"capture_warnings": True}], indirect=["log"])
@pytest.mark.parametrize(
("warning", "expected", "origin"),
[
(("Test warning", UserWarning), "[warnings][userwarning] Test warning\n", True),
(("Test warning", DeprecationWarning), "[warnings][deprecationwarning] Test warning\n", True),
(("Test warning", FutureWarning), "[warnings][futurewarning] Test warning\n", True),
(("Test warning", StreamlinkWarning), "[warnings][streamlinkwarning] Test warning\n", False),
(("Test warning", StreamlinkDeprecationWarning), "[warnings][streamlinkdeprecation] Test warning\n", False),
],
)
def test_capture(
self,
recwarn: pytest.WarningsRecorder,
log: logging.Logger,
output: TextIOWrapper,
warning: tuple[str, type[Warning]],
expected: str,
origin: bool,
):
lineno = self._warn([warning])
expected += f" {__file__}:{lineno}\n" if origin else ""
assert recwarn.list == []
assert getvalue(output) == expected
@pytest.mark.parametrize("log", [{"capture_warnings": True}], indirect=["log"])
def test_capture_logrecord(
self,
recwarn: pytest.WarningsRecorder,
caplog: pytest.LogCaptureFixture,
log: logging.Logger,
):
lineno = self._warn([("Test warning", UserWarning)])
path = Path(__file__)
assert recwarn.list == []
assert [(r.name, r.levelname, r.pathname, r.filename, r.module, r.lineno, r.message) for r in caplog.records] == [
("warnings", "userwarning", __file__, path.name, path.stem, lineno, f"Test warning\n {__file__}:{lineno}"),
]
@pytest.mark.parametrize("log", [{"capture_warnings": True}], indirect=["log"])
def test_capture_consecutive(
self,
recwarn: pytest.WarningsRecorder,
log: logging.Logger,
output: TextIOWrapper,
):
lineno = self._warn([("foo", DeprecationWarning), ("bar", FutureWarning)])
assert recwarn.list == []
assert getvalue(output) == (
f"[warnings][deprecationwarning] foo\n {__file__}:{lineno}\n"
+ f"[warnings][futurewarning] bar\n {__file__}:{lineno}\n"
)
@pytest.mark.parametrize("log", [{"capture_warnings": True}], indirect=["log"])
def test_capture_consecutive_once(
self,
recwarn: pytest.WarningsRecorder,
log: logging.Logger,
output: TextIOWrapper,
):
lineno = self._warn([("foo", UserWarning), ("foo", UserWarning)], "once")
assert recwarn.list == []
assert getvalue(output) == f"[warnings][userwarning] foo\n {__file__}:{lineno}\n"
@pytest.mark.parametrize("log", [{"capture_warnings": True}], indirect=["log"])
@pytest.mark.parametrize(
"warning",
[
("Test warning", UserWarning),
("Test warning", DeprecationWarning),
("Test warning", FutureWarning),
],
)
def test_ignored(
self,
recwarn: pytest.WarningsRecorder,
log: logging.Logger,
output: TextIOWrapper,
warning: tuple[str, type[Warning]],
):
self._warn([warning], filterwarnings="ignore")
assert recwarn.list == []
assert getvalue(output) == ""
|