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
|
import asyncio
import contextlib
import contextvars
import functools
import importlib
import io
import os
import platform
import re
import socket
import sqlite3
import sys
import tempfile
import threading
import time
from asyncio import events
from pathlib import Path
from typing import Any, Callable, Iterator, TypeVar
import pytest
import requests
import tests
from blockbuster import BlockBuster, BlockingError, blockbuster_ctx
from tests import subpackage
_T = TypeVar("_T")
async def to_thread(func: Callable[..., _T], /, *args: Any, **kwargs: Any) -> _T:
loop = events.get_running_loop()
ctx = contextvars.copy_context()
func_call = functools.partial(ctx.run, func, *args, **kwargs)
return await loop.run_in_executor(None, func_call)
@pytest.fixture(autouse=True)
def blockbuster() -> Iterator[BlockBuster]:
with blockbuster_ctx() as bb:
yield bb
@pytest.fixture
def test_file() -> Iterator[Path]:
with tempfile.NamedTemporaryFile(delete=False) as f:
path = Path(f.name)
yield path
os.unlink(path)
async def test_time_sleep() -> None:
with pytest.raises(BlockingError, match="Blocking call to time.sleep"):
time.sleep(1) # noqa: ASYNC251
PORT = 65432
def tcp_server() -> None:
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
s.bind(("127.0.0.1", PORT))
s.listen()
conn, _addr = s.accept()
with conn:
conn.sendall(b"Hello, world")
with contextlib.suppress(ConnectionResetError):
conn.recv(1024)
async def test_socket_connect() -> None:
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s, pytest.raises(
BlockingError, match="Blocking call to socket.socket.connect"
):
s.connect(("127.0.0.1", PORT))
async def test_socket_send() -> None:
tcp_server_task = asyncio.create_task(to_thread(tcp_server))
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
while True:
with contextlib.suppress(ConnectionRefusedError):
await asyncio.sleep(0.1)
await to_thread(s.connect, ("127.0.0.1", PORT))
break
with pytest.raises(BlockingError, match="Blocking call to socket.socket.send"):
s.send(b"Hello, world")
await tcp_server_task
async def test_socket_send_non_blocking() -> None:
tcp_server_task = asyncio.create_task(to_thread(tcp_server))
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
while True:
with contextlib.suppress(ConnectionRefusedError):
await asyncio.sleep(0.1)
await to_thread(s.connect, ("127.0.0.1", PORT))
break
blocking = False
s.setblocking(blocking)
s.send(b"Hello, world")
await tcp_server_task
async def test_ssl_socket(blockbuster: BlockBuster) -> None:
blockbuster.functions["socket.socket.connect"].deactivate()
blockbuster.functions["os.stat"].deactivate()
with pytest.raises(BlockingError, match="Blocking call to ssl.SSLSocket.send"):
requests.get("https://google.com", timeout=10) # noqa: ASYNC210
async def test_file_text(test_file: Path) -> None:
with test_file.open(mode="r+", encoding="utf-8") as f:
assert isinstance(f, io.TextIOWrapper)
with pytest.raises(
BlockingError, match="Blocking call to io.TextIOWrapper.write"
):
f.write("foo")
with pytest.raises(
BlockingError, match="Blocking call to io.TextIOWrapper.read"
):
f.read(1)
async def test_file_random(test_file: Path) -> None:
with test_file.open(mode="r+b") as f:
assert isinstance(f, io.BufferedRandom)
with pytest.raises(
BlockingError, match="Blocking call to io.BufferedRandom.write"
):
f.write(b"foo")
with pytest.raises(
BlockingError, match="Blocking call to io.BufferedRandom.read"
):
f.read(1)
async def test_file_read_bytes(test_file: Path) -> None:
with test_file.open(mode="rb") as f:
assert isinstance(f, io.BufferedReader)
with pytest.raises(BlockingError, match="io.BufferedReader.read"):
f.read(1)
async def test_file_write_bytes(test_file: Path) -> None:
with test_file.open(mode="wb") as f:
assert isinstance(f, io.BufferedWriter)
with pytest.raises(
BlockingError, match="Blocking call to io.BufferedWriter.write"
):
f.write(b"foo")
async def test_write_std() -> None:
sys.stdout.write("test")
sys.stderr.write("test")
async def test_sqlite_connnection_execute() -> None:
with contextlib.closing(sqlite3.connect(":memory:")) as connection, pytest.raises(
BlockingError, match="Blocking call to sqlite3.Connection.execute"
):
connection.execute("SELECT 1")
async def test_sqlite_cursor_execute() -> None:
with contextlib.closing(
sqlite3.connect(":memory:")
) as connection, contextlib.closing(connection.cursor()) as cursor, pytest.raises(
BlockingError, match="Blocking call to sqlite3.Cursor.execute"
):
cursor.execute("SELECT 1")
async def test_lock() -> None:
lock = threading.Lock()
assert lock.acquire() is True
with pytest.raises(BlockingError, match="Blocking call to lock.acquire"):
lock.acquire()
async def test_lock_timeout_zero() -> None:
lock = threading.Lock()
assert lock.acquire() is True
assert lock.acquire(timeout=0) is False
async def test_lock_non_blocking() -> None:
lock = threading.Lock()
assert lock.acquire() is True
assert lock.acquire(blocking=False) is False
async def test_thread_start() -> None:
t = threading.Thread(target=lambda: None)
t.start()
t.join()
async def test_import_module() -> None:
importlib.reload(requests)
def allowed_read(test_file: Path) -> None:
with test_file.open(mode="rb") as f:
f.read(1)
async def test_custom_stack_exclude(blockbuster: BlockBuster, test_file: Path) -> None:
blockbuster.functions["io.BufferedReader.read"].can_block_functions.append(
("tests/test_blockbuster.py", {"allowed_read"})
)
allowed_read(test_file)
async def test_cleanup(blockbuster: BlockBuster, test_file: Path) -> None:
blockbuster.deactivate()
with test_file.open(mode="wb") as f:
f.write(b"foo")
async def test_scanned_modules(blockbuster: BlockBuster, test_file: Path) -> None:
blockbuster.deactivate()
# Multiple scanned packages
with blockbuster_ctx(["tests.subpackage"]):
# Call not from subpackage doesn't trigger BlockingError
with test_file.open(mode="wb") as f:
f.write(b"foo")
# Call from subpackage triggers BlockingError
with pytest.raises(BlockingError):
subpackage.bar(test_file)
# Single scanned package
with blockbuster_ctx("tests.subpackage"), pytest.raises(BlockingError):
subpackage.bar(test_file)
# Scanned module file
with blockbuster_ctx(["tests.subpackage.foo"]), pytest.raises(BlockingError):
subpackage.bar(test_file)
# Scanned module object
with blockbuster_ctx(tests.subpackage.foo), pytest.raises(BlockingError):
subpackage.bar(test_file)
subpackage.bar(test_file)
# Excluded module name
with blockbuster_ctx("tests.subpackage", excluded_modules=["tests.subpackage.foo"]):
subpackage.bar(test_file)
# Excluded module object
with blockbuster_ctx("tests.subpackage", excluded_modules=[tests.subpackage.foo]):
subpackage.bar(test_file)
async def test_os_read() -> None:
fd = os.open(os.devnull, os.O_RDONLY)
with pytest.raises(BlockingError, match="Blocking call to os.read"):
os.read(fd, 1)
@pytest.mark.skipif(
platform.system() == "Windows", reason="O_NONBLOCK not supported on Windows"
)
async def test_os_read_non_blocking() -> None:
fd = os.open(os.devnull, os.O_NONBLOCK | os.O_RDONLY)
os.read(fd, 1)
async def test_os_write() -> None:
fd = os.open(os.devnull, os.O_RDWR)
with pytest.raises(BlockingError, match="Blocking call to os.write"):
os.write(fd, b"foo")
@pytest.mark.skipif(
platform.system() == "Windows", reason="O_NONBLOCK not supported on Windows"
)
async def test_os_write_non_blocking() -> None:
fd = os.open(os.devnull, os.O_NONBLOCK | os.O_RDWR)
os.write(fd, b"foo")
async def test_os_stat() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.stat"):
os.stat("/1")
async def test_os_getcwd() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.getcwd"):
os.getcwd()
@pytest.mark.skipif(not hasattr(os, "statvfs"), reason="statvfs is not available")
async def test_os_statvfs() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.statvfs"):
os.statvfs("/")
@pytest.mark.skipif(not hasattr(os, "sendfile"), reason="sendfile is not available")
async def test_os_sendfile() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.sendfile"):
os.sendfile(0, 1, 0, 1)
async def test_os_rename() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.rename"):
os.rename("/1", "/2")
async def test_os_renames() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.(stat|rename)"):
os.renames("/1", "/2")
async def test_os_replace() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.replace"):
os.replace("/1", "/2")
async def test_os_unlink() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.unlink"):
os.unlink("/1")
async def test_os_mkdir() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.mkdir"):
os.mkdir("/1")
async def test_os_makedirs() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.(stat|mkdir)"):
os.makedirs("/1")
async def test_os_rmdir() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.rmdir"):
os.rmdir("/1")
async def test_os_removedirs() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.rmdir"):
os.removedirs("/1")
async def test_os_link() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.link"):
os.link("/1", "/2")
async def test_os_symlink() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.symlink"):
os.symlink("/1", "/2")
async def test_os_readlink() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.readlink"):
os.readlink("/1")
async def test_os_listdir() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.listdir"):
os.listdir("/1")
@pytest.mark.skipif(sys.version_info < (3, 9), reason="requires Python 3.9+")
async def test_os_scandir() -> None:
with os.scandir(tempfile.tempdir) as files, pytest.raises(
BlockingError, match="Blocking call to ScandirIterator.__next__"
):
next(files)
async def test_os_access() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.access"):
os.access("/1", os.F_OK)
@pytest.mark.skipif(
platform.system() == "Windows",
reason="os.path.exists not detected on Windows at the moment",
)
async def test_os_path_exists() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.stat"):
os.path.exists("/1")
@pytest.mark.skipif(
platform.system() == "Windows",
reason="os.path.isfile not detected on Windows at the moment",
)
async def test_os_path_isfile() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.stat"):
os.path.isfile("/1")
@pytest.mark.skipif(
platform.system() == "Windows",
reason="os.path.isdir not detected on Windows at the moment",
)
async def test_os_path_isdir() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.stat"):
os.path.isdir("/1")
async def test_os_path_islink() -> None:
with pytest.raises(BlockingError, match="path.islink"):
os.path.islink("/1")
async def test_os_path_ismount() -> None:
with pytest.raises(BlockingError, match="path.ismount"):
os.path.ismount("/1")
async def test_os_path_getsize() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.stat"):
os.path.getsize("/1")
async def test_os_path_getmtime() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.stat"):
os.path.getmtime("/1")
async def test_os_path_getatime() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.stat"):
os.path.getatime("/1")
async def test_os_path_getctime() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.stat"):
os.path.getctime("/1")
async def test_os_path_samefile() -> None:
with pytest.raises(BlockingError, match="Blocking call to os.stat"):
os.path.samefile("/1", "/2")
async def test_os_path_sameopenfile() -> None:
with pytest.raises(BlockingError, match="path.sameopenfile"):
os.path.sameopenfile(0, 0)
async def test_os_path_samestat(blockbuster: BlockBuster) -> None:
blockbuster.functions["os.stat"].deactivate()
with pytest.raises(BlockingError, match="path.samestat"):
os.path.samestat(os.stat(0), os.stat(0))
async def test_os_path_abspath() -> None:
with pytest.raises(BlockingError, match="path.abspath"):
os.path.abspath("/1")
async def test_builtins_input() -> None:
with pytest.raises(
BlockingError, match=re.escape("Blocking call to builtins.input")
):
input()
def test_can_block_in_builder(blockbuster: BlockBuster) -> None:
blockbuster.functions["os.stat"].can_block_in("foo.py", {"bar"}).can_block_in(
"baz.py", "qux"
)
assert ("foo.py", {"bar"}) in blockbuster.functions["os.stat"].can_block_functions
assert ("baz.py", {"qux"}) in blockbuster.functions["os.stat"].can_block_functions
|