3e5d0784b9
This changes intends to reduce the bar to the kernel unit-testing by
introducing a new kernel-testing framework ("ktest") based on Netlink,
loadable test modules and python test suite integration.
This framework provides the following features:
* Integration to the FreeBSD test suite
* Automatic test discovery
* Automatic test module loading
* Minimal boiler-plate code in both kernel and userland
* Passing any metadata to the test
* Convenient environment pre-setup using python testing framework
* Streaming messages from the kernel to the userland
* Running tests in the dedicated taskqueues
* Skipping or parametrizing tests
Differential Revision: https://reviews.freebsd.org/D39385
MFC after: 2 weeks
84 lines
2.5 KiB
Python
84 lines
2.5 KiB
Python
#!/usr/bin/env python3
|
|
import os
|
|
import pwd
|
|
from ctypes import CDLL
|
|
from ctypes import get_errno
|
|
from ctypes.util import find_library
|
|
from typing import Dict
|
|
from typing import List
|
|
from typing import Optional
|
|
|
|
import pytest
|
|
|
|
|
|
def nodeid_to_method_name(nodeid: str) -> str:
|
|
"""file_name.py::ClassName::method_name[parametrize] -> method_name"""
|
|
return nodeid.split("::")[-1].split("[")[0]
|
|
|
|
|
|
class LibCWrapper(object):
|
|
def __init__(self):
|
|
path: Optional[str] = find_library("c")
|
|
if path is None:
|
|
raise RuntimeError("libc not found")
|
|
self._libc = CDLL(path, use_errno=True)
|
|
|
|
def modfind(self, mod_name: str) -> int:
|
|
if self._libc.modfind(bytes(mod_name, encoding="ascii")) == -1:
|
|
return get_errno()
|
|
return 0
|
|
|
|
def kldload(self, kld_name: str) -> int:
|
|
if self._libc.kldload(bytes(kld_name, encoding="ascii")) == -1:
|
|
return get_errno()
|
|
return 0
|
|
|
|
def jail_attach(self, jid: int) -> int:
|
|
if self._libc.jail_attach(jid) != 0:
|
|
return get_errno()
|
|
return 0
|
|
|
|
|
|
libc = LibCWrapper()
|
|
|
|
|
|
class BaseTest(object):
|
|
NEED_ROOT: bool = False # True if the class needs root privileges for the setup
|
|
TARGET_USER = None # Set to the target user by the framework
|
|
REQUIRED_MODULES: List[str] = []
|
|
|
|
def _check_modules(self):
|
|
for mod_name in self.REQUIRED_MODULES:
|
|
error_code = libc.modfind(mod_name)
|
|
if error_code != 0:
|
|
err_str = os.strerror(error_code)
|
|
pytest.skip(
|
|
"kernel module '{}' not available: {}".format(mod_name, err_str)
|
|
)
|
|
@property
|
|
def atf_vars(self) -> Dict[str, str]:
|
|
px = "_ATF_VAR_"
|
|
return {k[len(px):]: v for k, v in os.environ.items() if k.startswith(px)}
|
|
|
|
def drop_privileges_user(self, user: str):
|
|
uid = pwd.getpwnam(user)[2]
|
|
print("Dropping privs to {}/{}".format(user, uid))
|
|
os.setuid(uid)
|
|
|
|
def drop_privileges(self):
|
|
if self.TARGET_USER:
|
|
if self.TARGET_USER == "unprivileged":
|
|
user = self.atf_vars["unprivileged-user"]
|
|
else:
|
|
user = self.TARGET_USER
|
|
self.drop_privileges_user(user)
|
|
|
|
@property
|
|
def test_id(self) -> str:
|
|
# 'test_ip6_output.py::TestIP6Output::test_output6_pktinfo[ipandif] (setup)'
|
|
return os.environ.get("PYTEST_CURRENT_TEST").split(" ")[0]
|
|
|
|
def setup_method(self, method):
|
|
"""Run all pre-requisits for the test execution"""
|
|
self._check_modules()
|