File size: 18,338 Bytes
9c6594c |
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 |
#!/usr/bin/env python3
# Copyright (c) 2009, Giampaolo Rodola'. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Tests for testing utils (psutil.tests namespace)."""
import collections
import errno
import os
import socket
import stat
import subprocess
import textwrap
import unittest
import warnings
from unittest import mock
import psutil
import psutil.tests
from psutil import FREEBSD
from psutil import NETBSD
from psutil import POSIX
from psutil._common import open_binary
from psutil._common import open_text
from psutil._common import supports_ipv6
from psutil.tests import CI_TESTING
from psutil.tests import COVERAGE
from psutil.tests import HAS_NET_CONNECTIONS_UNIX
from psutil.tests import HERE
from psutil.tests import PYTHON_EXE
from psutil.tests import PYTHON_EXE_ENV
from psutil.tests import PsutilTestCase
from psutil.tests import TestMemoryLeak
from psutil.tests import bind_socket
from psutil.tests import bind_unix_socket
from psutil.tests import call_until
from psutil.tests import chdir
from psutil.tests import create_sockets
from psutil.tests import fake_pytest
from psutil.tests import filter_proc_net_connections
from psutil.tests import get_free_port
from psutil.tests import is_namedtuple
from psutil.tests import process_namespace
from psutil.tests import pytest
from psutil.tests import reap_children
from psutil.tests import retry
from psutil.tests import retry_on_failure
from psutil.tests import safe_mkdir
from psutil.tests import safe_rmpath
from psutil.tests import system_namespace
from psutil.tests import tcp_socketpair
from psutil.tests import terminate
from psutil.tests import unix_socketpair
from psutil.tests import wait_for_file
from psutil.tests import wait_for_pid
# ===================================================================
# --- Unit tests for test utilities.
# ===================================================================
class TestRetryDecorator(PsutilTestCase):
@mock.patch('time.sleep')
def test_retry_success(self, sleep):
# Fail 3 times out of 5; make sure the decorated fun returns.
@retry(retries=5, interval=1, logfun=None)
def foo():
while queue:
queue.pop()
1 / 0 # noqa: B018
return 1
queue = list(range(3))
assert foo() == 1
assert sleep.call_count == 3
@mock.patch('time.sleep')
def test_retry_failure(self, sleep):
# Fail 6 times out of 5; th function is supposed to raise exc.
@retry(retries=5, interval=1, logfun=None)
def foo():
while queue:
queue.pop()
1 / 0 # noqa: B018
return 1
queue = list(range(6))
with pytest.raises(ZeroDivisionError):
foo()
assert sleep.call_count == 5
@mock.patch('time.sleep')
def test_exception_arg(self, sleep):
@retry(exception=ValueError, interval=1)
def foo():
raise TypeError
with pytest.raises(TypeError):
foo()
assert sleep.call_count == 0
@mock.patch('time.sleep')
def test_no_interval_arg(self, sleep):
# if interval is not specified sleep is not supposed to be called
@retry(retries=5, interval=None, logfun=None)
def foo():
1 / 0 # noqa: B018
with pytest.raises(ZeroDivisionError):
foo()
assert sleep.call_count == 0
@mock.patch('time.sleep')
def test_retries_arg(self, sleep):
@retry(retries=5, interval=1, logfun=None)
def foo():
1 / 0 # noqa: B018
with pytest.raises(ZeroDivisionError):
foo()
assert sleep.call_count == 5
@mock.patch('time.sleep')
def test_retries_and_timeout_args(self, sleep):
with pytest.raises(ValueError):
retry(retries=5, timeout=1)
class TestSyncTestUtils(PsutilTestCase):
def test_wait_for_pid(self):
wait_for_pid(os.getpid())
nopid = max(psutil.pids()) + 99999
with mock.patch('psutil.tests.retry.__iter__', return_value=iter([0])):
with pytest.raises(psutil.NoSuchProcess):
wait_for_pid(nopid)
def test_wait_for_file(self):
testfn = self.get_testfn()
with open(testfn, 'w') as f:
f.write('foo')
wait_for_file(testfn)
assert not os.path.exists(testfn)
def test_wait_for_file_empty(self):
testfn = self.get_testfn()
with open(testfn, 'w'):
pass
wait_for_file(testfn, empty=True)
assert not os.path.exists(testfn)
def test_wait_for_file_no_file(self):
testfn = self.get_testfn()
with mock.patch('psutil.tests.retry.__iter__', return_value=iter([0])):
with pytest.raises(OSError):
wait_for_file(testfn)
def test_wait_for_file_no_delete(self):
testfn = self.get_testfn()
with open(testfn, 'w') as f:
f.write('foo')
wait_for_file(testfn, delete=False)
assert os.path.exists(testfn)
def test_call_until(self):
call_until(lambda: 1)
# TODO: test for timeout
class TestFSTestUtils(PsutilTestCase):
def test_open_text(self):
with open_text(__file__) as f:
assert f.mode == 'r'
def test_open_binary(self):
with open_binary(__file__) as f:
assert f.mode == 'rb'
def test_safe_mkdir(self):
testfn = self.get_testfn()
safe_mkdir(testfn)
assert os.path.isdir(testfn)
safe_mkdir(testfn)
assert os.path.isdir(testfn)
def test_safe_rmpath(self):
# test file is removed
testfn = self.get_testfn()
open(testfn, 'w').close()
safe_rmpath(testfn)
assert not os.path.exists(testfn)
# test no exception if path does not exist
safe_rmpath(testfn)
# test dir is removed
os.mkdir(testfn)
safe_rmpath(testfn)
assert not os.path.exists(testfn)
# test other exceptions are raised
with mock.patch(
'psutil.tests.os.stat', side_effect=OSError(errno.EINVAL, "")
) as m:
with pytest.raises(OSError):
safe_rmpath(testfn)
assert m.called
def test_chdir(self):
testfn = self.get_testfn()
base = os.getcwd()
os.mkdir(testfn)
with chdir(testfn):
assert os.getcwd() == os.path.join(base, testfn)
assert os.getcwd() == base
class TestProcessUtils(PsutilTestCase):
def test_reap_children(self):
subp = self.spawn_testproc()
p = psutil.Process(subp.pid)
assert p.is_running()
reap_children()
assert not p.is_running()
assert not psutil.tests._pids_started
assert not psutil.tests._subprocesses_started
def test_spawn_children_pair(self):
child, grandchild = self.spawn_children_pair()
assert child.pid != grandchild.pid
assert child.is_running()
assert grandchild.is_running()
children = psutil.Process().children()
assert children == [child]
children = psutil.Process().children(recursive=True)
assert len(children) == 2
assert child in children
assert grandchild in children
assert child.ppid() == os.getpid()
assert grandchild.ppid() == child.pid
terminate(child)
assert not child.is_running()
assert grandchild.is_running()
terminate(grandchild)
assert not grandchild.is_running()
@pytest.mark.skipif(not POSIX, reason="POSIX only")
def test_spawn_zombie(self):
_parent, zombie = self.spawn_zombie()
assert zombie.status() == psutil.STATUS_ZOMBIE
def test_terminate(self):
# by subprocess.Popen
p = self.spawn_testproc()
terminate(p)
self.assertPidGone(p.pid)
terminate(p)
# by psutil.Process
p = psutil.Process(self.spawn_testproc().pid)
terminate(p)
self.assertPidGone(p.pid)
terminate(p)
# by psutil.Popen
cmd = [
PYTHON_EXE,
"-c",
"import time; [time.sleep(0.1) for x in range(100)];",
]
p = psutil.Popen(
cmd,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
env=PYTHON_EXE_ENV,
)
terminate(p)
self.assertPidGone(p.pid)
terminate(p)
# by PID
pid = self.spawn_testproc().pid
terminate(pid)
self.assertPidGone(p.pid)
terminate(pid)
# zombie
if POSIX:
parent, zombie = self.spawn_zombie()
terminate(parent)
terminate(zombie)
self.assertPidGone(parent.pid)
self.assertPidGone(zombie.pid)
class TestNetUtils(PsutilTestCase):
def bind_socket(self):
port = get_free_port()
with bind_socket(addr=('', port)) as s:
assert s.getsockname()[1] == port
@pytest.mark.skipif(not POSIX, reason="POSIX only")
def test_bind_unix_socket(self):
name = self.get_testfn()
with bind_unix_socket(name) as sock:
assert sock.family == socket.AF_UNIX
assert sock.type == socket.SOCK_STREAM
assert sock.getsockname() == name
assert os.path.exists(name)
assert stat.S_ISSOCK(os.stat(name).st_mode)
# UDP
name = self.get_testfn()
with bind_unix_socket(name, type=socket.SOCK_DGRAM) as sock:
assert sock.type == socket.SOCK_DGRAM
def test_tcp_socketpair(self):
addr = ("127.0.0.1", get_free_port())
server, client = tcp_socketpair(socket.AF_INET, addr=addr)
with server, client:
# Ensure they are connected and the positions are correct.
assert server.getsockname() == addr
assert client.getpeername() == addr
assert client.getsockname() != addr
@pytest.mark.skipif(not POSIX, reason="POSIX only")
@pytest.mark.skipif(
NETBSD or FREEBSD, reason="/var/run/log UNIX socket opened by default"
)
def test_unix_socketpair(self):
p = psutil.Process()
num_fds = p.num_fds()
assert not filter_proc_net_connections(p.net_connections(kind='unix'))
name = self.get_testfn()
server, client = unix_socketpair(name)
try:
assert os.path.exists(name)
assert stat.S_ISSOCK(os.stat(name).st_mode)
assert p.num_fds() - num_fds == 2
assert (
len(
filter_proc_net_connections(p.net_connections(kind='unix'))
)
== 2
)
assert server.getsockname() == name
assert client.getpeername() == name
finally:
client.close()
server.close()
def test_create_sockets(self):
with create_sockets() as socks:
fams = collections.defaultdict(int)
types = collections.defaultdict(int)
for s in socks:
fams[s.family] += 1
# work around http://bugs.python.org/issue30204
types[s.getsockopt(socket.SOL_SOCKET, socket.SO_TYPE)] += 1
assert fams[socket.AF_INET] >= 2
if supports_ipv6():
assert fams[socket.AF_INET6] >= 2
if POSIX and HAS_NET_CONNECTIONS_UNIX:
assert fams[socket.AF_UNIX] >= 2
assert types[socket.SOCK_STREAM] >= 2
assert types[socket.SOCK_DGRAM] >= 2
@pytest.mark.xdist_group(name="serial")
class TestMemLeakClass(TestMemoryLeak):
@retry_on_failure()
def test_times(self):
def fun():
cnt['cnt'] += 1
cnt = {'cnt': 0}
self.execute(fun, times=10, warmup_times=15)
assert cnt['cnt'] == 26
def test_param_err(self):
with pytest.raises(ValueError):
self.execute(lambda: 0, times=0)
with pytest.raises(ValueError):
self.execute(lambda: 0, times=-1)
with pytest.raises(ValueError):
self.execute(lambda: 0, warmup_times=-1)
with pytest.raises(ValueError):
self.execute(lambda: 0, tolerance=-1)
with pytest.raises(ValueError):
self.execute(lambda: 0, retries=-1)
@retry_on_failure()
@pytest.mark.skipif(CI_TESTING, reason="skipped on CI")
@pytest.mark.skipif(COVERAGE, reason="skipped during test coverage")
def test_leak_mem(self):
ls = []
def fun(ls=ls):
ls.append("x" * 248 * 1024)
try:
# will consume around 60M in total
with pytest.raises(AssertionError, match="extra-mem"):
self.execute(fun, times=100)
finally:
del ls
def test_unclosed_files(self):
def fun():
f = open(__file__) # noqa: SIM115
self.addCleanup(f.close)
box.append(f)
box = []
kind = "fd" if POSIX else "handle"
with pytest.raises(AssertionError, match="unclosed " + kind):
self.execute(fun)
def test_tolerance(self):
def fun():
ls.append("x" * 24 * 1024)
ls = []
times = 100
self.execute(
fun, times=times, warmup_times=0, tolerance=200 * 1024 * 1024
)
assert len(ls) == times + 1
def test_execute_w_exc(self):
def fun_1():
1 / 0 # noqa: B018
self.execute_w_exc(ZeroDivisionError, fun_1)
with pytest.raises(ZeroDivisionError):
self.execute_w_exc(OSError, fun_1)
def fun_2():
pass
with pytest.raises(AssertionError):
self.execute_w_exc(ZeroDivisionError, fun_2)
class TestFakePytest(PsutilTestCase):
def run_test_class(self, klass):
suite = unittest.TestSuite()
suite.addTest(klass)
runner = unittest.TextTestRunner()
result = runner.run(suite)
return result
def test_raises(self):
with fake_pytest.raises(ZeroDivisionError) as cm:
1 / 0 # noqa: B018
assert isinstance(cm.value, ZeroDivisionError)
with fake_pytest.raises(ValueError, match="foo") as cm:
raise ValueError("foo")
try:
with fake_pytest.raises(ValueError, match="foo") as cm:
raise ValueError("bar")
except AssertionError as err:
assert str(err) == '"foo" does not match "bar"'
else:
raise self.fail("exception not raised")
def test_mark(self):
@fake_pytest.mark.xdist_group(name="serial")
def foo():
return 1
assert foo() == 1
@fake_pytest.mark.xdist_group(name="serial")
class Foo:
def bar(self):
return 1
assert Foo().bar() == 1
def test_skipif(self):
class TestCase(unittest.TestCase):
@fake_pytest.mark.skipif(True, reason="reason")
def foo(self):
assert 1 == 1 # noqa: PLR0133
result = self.run_test_class(TestCase("foo"))
assert result.wasSuccessful()
assert len(result.skipped) == 1
assert result.skipped[0][1] == "reason"
class TestCase(unittest.TestCase):
@fake_pytest.mark.skipif(False, reason="reason")
def foo(self):
assert 1 == 1 # noqa: PLR0133
result = self.run_test_class(TestCase("foo"))
assert result.wasSuccessful()
assert len(result.skipped) == 0
def test_skip(self):
class TestCase(unittest.TestCase):
def foo(self):
fake_pytest.skip("reason")
assert 1 == 0 # noqa: PLR0133
result = self.run_test_class(TestCase("foo"))
assert result.wasSuccessful()
assert len(result.skipped) == 1
assert result.skipped[0][1] == "reason"
def test_main(self):
tmpdir = self.get_testfn(dir=HERE)
os.mkdir(tmpdir)
with open(os.path.join(tmpdir, "__init__.py"), "w"):
pass
with open(os.path.join(tmpdir, "test_file.py"), "w") as f:
f.write(textwrap.dedent("""\
import unittest
class TestCase(unittest.TestCase):
def test_passed(self):
pass
""").lstrip())
with mock.patch.object(psutil.tests, "HERE", tmpdir):
with self.assertWarnsRegex(
UserWarning, "Fake pytest module was used"
):
suite = fake_pytest.main()
assert suite.countTestCases() == 1
def test_warns(self):
# success
with fake_pytest.warns(UserWarning):
warnings.warn("foo", UserWarning, stacklevel=1)
# failure
try:
with fake_pytest.warns(UserWarning):
warnings.warn("foo", DeprecationWarning, stacklevel=1)
except AssertionError:
pass
else:
raise self.fail("exception not raised")
# match success
with fake_pytest.warns(UserWarning, match="foo"):
warnings.warn("foo", UserWarning, stacklevel=1)
# match failure
try:
with fake_pytest.warns(UserWarning, match="foo"):
warnings.warn("bar", UserWarning, stacklevel=1)
except AssertionError:
pass
else:
raise self.fail("exception not raised")
class TestTestingUtils(PsutilTestCase):
def test_process_namespace(self):
p = psutil.Process()
ns = process_namespace(p)
ns.test()
fun = next(x for x in ns.iter(ns.getters) if x[1] == 'ppid')[0]
assert fun() == p.ppid()
def test_system_namespace(self):
ns = system_namespace()
fun = next(x for x in ns.iter(ns.getters) if x[1] == 'net_if_addrs')[0]
assert fun() == psutil.net_if_addrs()
class TestOtherUtils(PsutilTestCase):
def test_is_namedtuple(self):
assert is_namedtuple(collections.namedtuple('foo', 'a b c')(1, 2, 3))
assert not is_namedtuple(tuple())
|