qemu/tests/functional/qemu_test/ports.py
Thomas Huth b7edbbf432 tests/functional: Extract the find_free_ports() function into a helper file
We'll need this functionality in other functional tests, too, so
let's extract it into the qemu_test module.
Also add  an __enter__ and __exit__ function that can be used for
using this functionality in a locked context, so that tests that
are running in parallel don't try to compete for the same ports
later.
Also make sure to only use ports in the "Dynamic Ports" range
(see https://www.rfc-editor.org/rfc/rfc6335) and "randomize" the
start of the probed range with the PID of the test process to
further avoid possible clashes with other competing processes.

Message-ID: <20241218131439.255841-5-thuth@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>
2025-01-02 08:58:08 +01:00

56 lines
1.6 KiB
Python

#!/usr/bin/env python3
#
# Simple functional tests for VNC functionality
#
# Copyright 2018, 2024 Red Hat, Inc.
#
# This work is licensed under the terms of the GNU GPL, version 2 or
# later. See the COPYING file in the top-level directory.
import fcntl
import os
import socket
import sys
import tempfile
from .config import BUILD_DIR
from typing import List
class Ports():
PORTS_ADDR = '127.0.0.1'
PORTS_RANGE_SIZE = 1024
PORTS_START = 49152 + ((os.getpid() * PORTS_RANGE_SIZE) % 16384)
PORTS_END = PORTS_START + PORTS_RANGE_SIZE
def __enter__(self):
lock_file = os.path.join(BUILD_DIR, "tests", "functional", "port_lock")
self.lock_fh = os.open(lock_file, os.O_CREAT)
fcntl.flock(self.lock_fh, fcntl.LOCK_EX)
return self
def __exit__(self, exc_type, exc_value, traceback):
fcntl.flock(self.lock_fh, fcntl.LOCK_UN)
os.close(self.lock_fh)
def check_bind(self, port: int) -> bool:
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
try:
sock.bind((self.PORTS_ADDR, port))
except OSError:
return False
return True
def find_free_ports(self, count: int) -> List[int]:
result = []
for port in range(self.PORTS_START, self.PORTS_END):
if self.check_bind(port):
result.append(port)
if len(result) >= count:
break
assert len(result) == count
return result
def find_free_port(self) -> int:
return self.find_free_ports(1)[0]