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
|
"""Test the commands."""
from __future__ import annotations
from typing import Any, Literal
from unittest.mock import AsyncMock, call
import pytest
from aiovlc.client import Client
from aiovlc.exceptions import (
AuthError,
CommandError,
CommandParameterError,
CommandParseError,
)
async def test_clear_command(
transport: AsyncMock,
client_connected: Client,
) -> None:
"""Test the clear command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = b"> "
await client_connected.clear()
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"clear\n")
assert mock_reader.readuntil.call_count == 1
@pytest.mark.parametrize(
("read", "length"),
[(b"372\r\n> ", 372), (b"\r\n> ", 0)],
)
async def test_get_length_command(
transport: AsyncMock,
client_connected: Client,
read: list[bytes],
length: int,
) -> None:
"""Test the get length command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = read
output = await client_connected.get_length()
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"get_length\n")
assert mock_reader.readuntil.call_count == 1
assert output
assert output.length == length
@pytest.mark.parametrize(
("read", "error", "error_message"),
[
(b"> ", CommandParseError, "Could not get length."),
(
b"unexpected\r\n> ",
CommandParseError,
"Could not get length.",
),
],
)
async def test_get_length_command_error(
transport: AsyncMock,
client_connected: Client,
read: list[bytes],
error: type[Exception],
error_message: str,
) -> None:
"""Test the get length command errors."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = read
with pytest.raises(error) as err:
await client_connected.get_length()
assert str(err.value) == error_message
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"get_length\n")
assert mock_reader.readuntil.call_count == 1
@pytest.mark.parametrize(
("read", "time_result"),
[(b"8\r\n> ", 8), (b"\r\n> ", 0)],
)
async def test_get_time_command(
transport: AsyncMock,
client_connected: Client,
read: list[bytes],
time_result: int,
) -> None:
"""Test the get time command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = read
output = await client_connected.get_time()
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"get_time\n")
assert mock_reader.readuntil.call_count == 1
assert output
assert output.time == time_result
@pytest.mark.parametrize(
("read", "error", "error_message"),
[
(b"> ", CommandParseError, "Could not get time."),
(
b"unexpected\r\n> ",
CommandParseError,
"Could not get time.",
),
],
)
async def test_get_time_command_error(
transport: AsyncMock,
client_connected: Client,
read: list[bytes],
error: type[Exception],
error_message: str,
) -> None:
"""Test the get time command errors."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = read
with pytest.raises(error) as err:
await client_connected.get_time()
assert str(err.value) == error_message
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"get_time\n")
assert mock_reader.readuntil.call_count == 1
async def test_info_command(
transport: AsyncMock,
client_connected: Client,
) -> None:
"""Test the info command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = (
b"+----[ Meta data ]\r\n"
b"|\r\n"
b"| filename: test_song.mp3\r\n"
b"|\r\n"
b"+----[ Stream 0 ]\r\n"
b"|\r\n"
b"| Channels: Stereo\r\n"
b"| Codec: MPEG Audio layer 1/2 (mpga)\r\n"
b"| Bits per sample: 32\r\n"
b"| Type: Audio\r\n"
b"| Sample rate: 44100 Hz\r\n"
b"|\r\n"
b"+----[ end of stream info ]\r\n"
b"> "
)
output = await client_connected.info()
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"info\n")
assert mock_reader.readuntil.call_count == 1
assert output
assert output.data == {
0: {
"Bits per sample": 32,
"Channels": "Stereo",
"Codec": "MPEG Audio layer 1/2 (mpga)",
"Sample rate": "44100 Hz",
"Type": "Audio",
},
"data": {"filename": "test_song.mp3"},
}
async def test_info_command_error(
transport: AsyncMock,
client_connected: Client,
) -> None:
"""Test the info command error."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = b"unexpected\r\n> "
with pytest.raises(CommandError) as err:
await client_connected.info()
assert str(err.value) == "Unexpected line in info output: unexpected"
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"info\n")
assert mock_reader.readuntil.call_count == 1
async def test_next_command(
transport: AsyncMock,
client_connected: Client,
) -> None:
"""Test the next command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = b"> "
await client_connected.next()
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"next\n")
assert mock_reader.readuntil.call_count == 1
@pytest.mark.parametrize(
("read", "read_call_count"),
[([b"Welcome, Master\r\n", b"> "], 4), ([b"Welcome, Master> \r\n"], 3)],
)
async def test_password_command(
transport: AsyncMock,
client_connected: Client,
read: list[bytes],
read_call_count: int,
) -> None:
"""Test the password command."""
password = "test-password" # noqa: S105
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.side_effect = [
b"VLC media player 3.0.9.2 Vetinari\nPassword: ",
b"\xff\xfb\x01\xff\xfc\x01\r\n",
*read,
]
output = await client_connected.login()
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(f"{password}\n".encode())
assert mock_reader.readuntil.call_count == read_call_count
assert output
assert output.response == "Welcome, Master"
@pytest.mark.parametrize(
("read", "error", "error_message"),
[
([b"Wrong password\r\n"], AuthError, "Failed to login to VLC."),
(
[b"unexpected reply\r\n"],
CommandError,
"Unexpected password response: unexpected reply",
),
([b"\r\n"], CommandError, "Empty password response"),
],
)
async def test_password_command_error(
transport: AsyncMock,
client_connected: Client,
read: list[bytes],
error: type[Exception],
error_message: str,
) -> None:
"""Test the password command errors."""
password = "test-password" # noqa: S105
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.side_effect = [
b"VLC media player 3.0.9.2 Vetinari\nPassword: ",
b"\xff\xfb\x01\xff\xfc\x01\r\n",
*read,
]
with pytest.raises(error) as err:
await client_connected.login()
assert str(err.value) == error_message
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(f"{password}\n".encode())
async def test_pause_command(
transport: AsyncMock,
client_connected: Client,
) -> None:
"""Test the pause command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = b"> "
await client_connected.pause()
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"pause\n")
assert mock_reader.readuntil.call_count == 1
async def test_play_command(
transport: AsyncMock,
client_connected: Client,
) -> None:
"""Test the play command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = b"> "
await client_connected.play()
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"play\n")
assert mock_reader.readuntil.call_count == 1
async def test_prev_command(
transport: AsyncMock,
client_connected: Client,
) -> None:
"""Test the prev command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = b"> "
await client_connected.prev()
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"prev\n")
assert mock_reader.readuntil.call_count == 1
@pytest.mark.parametrize(
("mode", "call_argument"),
[
("on", " on"),
("off", " off"),
(None, ""),
],
)
async def test_random_command(
transport: AsyncMock,
client_connected: Client,
mode: Literal["on", "off"] | None,
call_argument: str,
) -> None:
"""Test the random command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = b"> "
await client_connected.random(mode)
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(f"random{call_argument}\n".encode())
assert mock_reader.readuntil.call_count == 1
@pytest.mark.parametrize(
("mode", "error", "error_message"),
[
(
"bad_mode",
CommandParameterError,
f"Parameter mode not in {(None, 'on', 'off')}",
),
(
42,
CommandParameterError,
f"Parameter mode not in {(None, 'on', 'off')}",
),
],
)
async def test_random_command_error(
transport: AsyncMock,
client_connected: Client,
mode: Any,
error: type[Exception],
error_message: str,
) -> None:
"""Test the random command errors."""
mock_reader, mock_writer = transport.return_value
with pytest.raises(error) as err:
await client_connected.random(mode)
assert str(err.value) == error_message
assert mock_reader.readuntil.call_count == 0
assert mock_writer.write.call_count == 0
async def test_set_volume_command(
transport: AsyncMock,
client_connected: Client,
) -> None:
"""Test the set volume command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = b"> "
await client_connected.set_volume(300)
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"volume 300\n")
assert mock_reader.readuntil.call_count == 1
@pytest.mark.parametrize(
("volume", "error", "error_message"),
[
("bad_volume", CommandParameterError, "Invalid volume parameter: bad_volume"),
(
9000,
CommandParameterError,
f"Parameter volume not in {range(500)}",
),
],
)
async def test_set_volume_command_error(
transport: AsyncMock,
client_connected: Client,
volume: Any,
error: type[Exception],
error_message: str,
) -> None:
"""Test the set volume command errors."""
mock_reader, mock_writer = transport.return_value
with pytest.raises(error) as err:
await client_connected.set_volume(volume)
assert str(err.value) == error_message
assert mock_reader.readuntil.call_count == 0
assert mock_writer.write.call_count == 0
@pytest.mark.parametrize(
("read", "audio_volume", "state", "input_loc"),
[
(b"( audio volume: 0 )\r\n( state stopped )\r\n> ", 0, "stopped", None),
(b"( audio volume: 0.0 )\r\n( state stopped )\r\n> ", 0, "stopped", None),
(b"( audio volume: 0,0 )\r\n( state stopped )\r\n> ", 0, "stopped", None),
(
(
b"( new input: file:///path/to/music.mp3 )\r\n"
b"( audio volume: 128.0 )\r\n( state paused )\r\n> "
),
128,
"paused",
"file:///path/to/music.mp3",
),
(
(
b"( new input: file:///home/felix/Musik/Madonna - Jump.ogg )\r\n"
b"( audio volume: 256.0 )\r\n( state playing )\r\n> "
),
256,
"playing",
"file:///home/felix/Musik/Madonna%20-%20Jump.ogg",
),
],
)
async def test_status_command(
transport: AsyncMock,
client_connected: Client,
read: list[bytes],
audio_volume: int,
state: str,
input_loc: str | None,
) -> None:
"""Test the status command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = read
output = await client_connected.status()
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"status\n")
assert mock_reader.readuntil.call_count == 1
assert output
assert output.audio_volume == audio_volume
assert output.state == state
assert output.input_loc == input_loc
async def test_stop_command(
transport: AsyncMock,
client_connected: Client,
) -> None:
"""Test the stop command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = b"> "
await client_connected.stop()
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"stop\n")
assert mock_reader.readuntil.call_count == 1
@pytest.mark.parametrize(
("read", "audio_volume"),
[
(b"0\r\n> ", 0),
(b"0.0\r\n> ", 0),
(b"0,0\r\n> ", 0),
(b"128.0\r\n> ", 128),
],
)
async def test_volume_command(
transport: AsyncMock,
client_connected: Client,
read: list[bytes],
audio_volume: int,
) -> None:
"""Test the volume command."""
mock_reader, mock_writer = transport.return_value
mock_reader.readuntil.return_value = read
output = await client_connected.volume()
assert mock_writer.write.call_count == 1
assert mock_writer.write.call_args == call(b"volume\n")
assert mock_reader.readuntil.call_count == 1
assert output
assert output.audio_volume == audio_volume
|