From c7fd1bd99fdecca4fe37c7980e14819124b03998 Mon Sep 17 00:00:00 2001 From: Axel Gembe Date: Wed, 11 Oct 2023 18:41:01 +0700 Subject: [PATCH] tests: Clean up the existing tests.py This cleans up the code of `tests.py` and makes it use the new functions from `utils.py`. This also makes the test sleep much less, which is only still required before destroying the pool due to https://github.com/openzfsonwindows/openzfs/issues/282 Signed-off-by: Axel Gembe --- .github/workflows/windows-build-test.yml | 2 +- contrib/windows/tests/tests.py | 538 ++++++----------------- contrib/windows/tests/utils.py | 51 ++- 3 files changed, 192 insertions(+), 399 deletions(-) diff --git a/.github/workflows/windows-build-test.yml b/.github/workflows/windows-build-test.yml index 410f2b66a948..5311c9707bc8 100644 --- a/.github/workflows/windows-build-test.yml +++ b/.github/workflows/windows-build-test.yml @@ -2141,7 +2141,7 @@ jobs: - name: test - run: 'python.exe -u "${{github.workspace}}\contrib\windows\tests\tests.py" -path ${{github.workspace}}\' + run: 'python.exe -u "${{github.workspace}}\contrib\windows\tests\tests.py" --path ${{github.workspace}}\' diff --git a/contrib/windows/tests/tests.py b/contrib/windows/tests/tests.py index 006e2f40b692..552295d9de9d 100644 --- a/contrib/windows/tests/tests.py +++ b/contrib/windows/tests/tests.py @@ -1,413 +1,163 @@ -import os import argparse - -import subprocess - -# from pathlib import Path, PurePosixPath, PureWindowsPath, WindowsPath -from pathlib import PureWindowsPath - -# from pprint import pprint - -import time - -# import json - import logging - -from utils import Size, argparse_as_abspath, allocate_file - -logging.basicConfig(level=logging.DEBUG) - -print("Printed immediately.") - - -def parse_arguments(): - parser = argparse.ArgumentParser(description='Process command line ' - 'arguments.') - parser.add_argument('-path', type=argparse_as_abspath, required=True) - return parser.parse_args() - - -def get_DeviceId(): - magic_number_process = subprocess.run( - ["wmic", "diskdrive", "get", "DeviceId"], - stdout=subprocess.PIPE, - stderr=subprocess.PIPE - ) - -# https://github.com/sir-ragna/dddddd -# get DeviceId - - a = magic_number_process.stdout.decode(encoding='UTF-8', errors='strict') - b = a.replace("\r\r\n", "\r\n") - - c = b.splitlines() - - d = [x.split() for x in c] - - e = [x[0] for x in d if len(x) > 0 and x[0] not in "DeviceID"] - - e.sort() - -# print(e) - -# print([x.encode(encoding='UTF-8') for x in e]) - -# import csv - -# with open('csv_file.csv', 'w', encoding='UTF8') as f: -# writer = csv.writer(f, dialect='excel', quoting=csv.QUOTE_ALL) -# -# for row in e: -# writer.writerow([row]) - - return e - - -def delete_file(name): - if os.path.exists(name): - os.remove(name) - else: - print("The file does not exist") - - -def get_driveletters(): - magic_number_process = subprocess.run( - ["C:\\Program Files\\OpenZFS On Windows\\zfs.exe", "mount"], - stdout=subprocess.PIPE, - stderr=subprocess.PIPE - ) - -# b'test01 H:\\ \r\ntest02 I:\\ \r\n' - - a = magic_number_process.stdout.decode(encoding='UTF-8', errors='strict') - - c = a.splitlines() - - logging.debug("get_driveletters() {}".format(c)) - -# print("get_driveletters() debug",c) - - d = [x.split() for x in c] - - logging.debug("get_driveletters() {}".format(d)) - - return d - -# run: '& "C:\Program Files\OpenZFS On Windows\zfs.exe" mount' - - -def create_pool(name, file): - magic_number_process = subprocess.run( - ["C:\\Program Files\\OpenZFS On Windows\\zpool.exe", "create", "-f", - name, file], - stdout=subprocess.PIPE, - stderr=subprocess.PIPE +import unittest + +from utils import ( + Size, + ZfsContext, + add_common_arguments, + allocate_file, + allocated_files, + get_diskdrive_paths, + get_zfs_mounts, + path_to_unc, + paths_to_unc, + random_key, + run_cmd, + setup_logging, + zpool_create, +) + +args: argparse.Namespace +ctx: ZfsContext + +logger = setup_logging("tests.tests", logging.DEBUG) +tc = unittest.TestCase() + + +def parse_arguments() -> argparse.Namespace: + parser = argparse.ArgumentParser( + description="Process command line arguments." ) - return magic_number_process + add_common_arguments(parser) - -def destroy_pool(name): - magic_number_process = subprocess.run( - ["C:\\Program Files\\OpenZFS On Windows\\zpool.exe", "destroy", - "-f", name], - stdout=subprocess.PIPE, - stderr=subprocess.PIPE - ) - - return magic_number_process - - -def zpool(*args): - magic_number_process = subprocess.run( - ["C:\\Program Files\\OpenZFS On Windows\\zpool.exe", *args], - stdout=subprocess.PIPE, - stderr=subprocess.PIPE - ) - - return magic_number_process - - -def zfs(*args): - magic_number_process = subprocess.run( - ["C:\\Program Files\\OpenZFS On Windows\\zfs.exe", *args], - stdout=subprocess.PIPE, - stderr=subprocess.PIPE - ) - - return magic_number_process - - -def run(args): - d = {"zfs": "C:\\Program Files\\OpenZFS On Windows\\zfs.exe", - "zpool": "C:\\Program Files\\OpenZFS On Windows\\zpool.exe"} - arglist = list(args) - cmd = d[arglist[0]] - result = subprocess.run( - [cmd, *arglist[1:]], - stdout=subprocess.PIPE, - stderr=subprocess.PIPE - ) - - return result - - -def tounc(name): - q = "\\\\?\\" + str(name) - return q - - -def runWithPrint(cmd): - print(" ".join(cmd)) - ret = run(cmd) - logging.debug(str("args={}".format(" ".join(ret.args)))) - logging.debug(str("returncode={}".format(ret.returncode))) - logging.debug(str("stdout={}".format(ret.stdout))) - logging.debug(str("stderr={}".format(ret.stderr))) - - return ret - - -def preTest(testName=None): - print("=" * 20) - if testName is not None: - print("Name:", testName) - - get_driveletters() + return parser.parse_args() -def postTest(): - get_driveletters() - print("=" * 20) +def preTest(test_name=None): + logger.info("=" * 60) + if test_name: + logger.info(f"Running test: {test_name}") def main(): - parsed_args = parse_arguments() - - print("Path:", parsed_args.path) - - p = parsed_args.path - - print("Path object:", p) - - print("Physical devices", get_DeviceId()) - - if p.is_absolute(): - - f1 = PureWindowsPath(p, "test01.dat") - allocate_file(f1, 1 * Size.GIB) - f2 = PureWindowsPath(p, "test02.dat") - allocate_file(f2, 1 * Size.GIB) - f3 = PureWindowsPath(p, "test03.dat") - allocate_file(f3, 1 * Size.GIB) - - preTest() - ret = runWithPrint(["zpool", "create", "-f", "test01", tounc(f1)]) - time.sleep(10) - if ret.returncode != 0: - print("FAIL") - print("Drive letters after pool create:", get_driveletters()) - runWithPrint(["zpool", "destroy", "-f", "test01"]) - time.sleep(10) - postTest() - - preTest() - ret = runWithPrint(["zpool", "create", "-f", "test02", tounc(f1), - tounc(f2)]) - if ret.returncode != 0: - print("FAIL") - time.sleep(10) - print("Drive letters after pool create:", get_driveletters()) - runWithPrint(["zpool", "destroy", "-f", "test02"]) - time.sleep(10) - postTest() - - preTest() - ret = runWithPrint(["zpool", "create", "-f", "test03", tounc(f1), - tounc(f2), tounc(f3)]) - if ret.returncode != 0: - print("FAIL") - time.sleep(10) - print("Drive letters after pool create:", get_driveletters()) - runWithPrint(["zpool", "destroy", "-f", "test03"]) - time.sleep(10) - postTest() - - preTest() - ret = runWithPrint(["zpool", "create", "-f", "test04", "mirror", - tounc(f1), tounc(f2)]) - if ret.returncode != 0: - print("FAIL") - time.sleep(10) - print("Drive letters after pool create:", get_driveletters()) - runWithPrint(["zpool", "destroy", "-f", "test04"]) - time.sleep(10) - postTest() - - preTest() - ret = runWithPrint(["zpool", "create", "-f", "test05", "mirror", - tounc(f1), tounc(f2), tounc(f3)]) - time.sleep(10) - if ret.returncode != 0: - print("FAIL") - print("Drive letters after pool create:", get_driveletters()) - runWithPrint(["zpool", "destroy", "-f", "test05"]) - time.sleep(10) - postTest() - - preTest() - ret = runWithPrint(["zpool", "create", "-f", "test06", "raidz", - tounc(f1), tounc(f2), tounc(f3)]) - if ret.returncode != 0: - print("FAIL") - time.sleep(10) - print("Drive letters after pool create:", get_driveletters()) - runWithPrint(["zpool", "destroy", "-f", "test06"]) - time.sleep(10) - postTest() - - preTest() - ret = runWithPrint(["zpool", "create", "-f", "test07", "raidz1", - tounc(f1), tounc(f2), tounc(f3)]) - if ret.returncode != 0: - print("FAIL") - time.sleep(10) - print("Drive letters after pool create:", get_driveletters()) - runWithPrint(["zpool", "destroy", "-f", "test07"]) - time.sleep(10) - postTest() - - preTest("snapshot no hang:") - - ret = runWithPrint(["zpool", "create", "-f", "testsn01", tounc(f1)]) - if ret.returncode != 0: - print("FAIL") - time.sleep(10) - print("Drive letters after pool create:", get_driveletters()) - - f = PureWindowsPath(get_driveletters()[0][1], "test01.file") - allocate_file(f, 1 * Size.KIB) - - ret = runWithPrint(["zfs", "snapshot", "testsn01@friday"]) - if ret.returncode != 0: - print("FAIL") - - f = PureWindowsPath(get_driveletters()[0][1], "test02.file") - allocate_file(f, 1 * Size.KIB) - - ret = runWithPrint(["zpool", "export", "-a"]) - if ret.returncode != 0: - print("FAIL") - time.sleep(10) - - runWithPrint(["zpool", "destroy", "-f", "testsn01"]) - - time.sleep(10) - postTest() - + global args + global ctx + + args = parse_arguments() + ctx = ZfsContext(args.zfspath) + + logger.debug(f"Path: {args.path}") + logger.debug(f"Physical devices: {get_diskdrive_paths()}") + + def log_dl(when): + logger.info(f"Drive letters {when}: {get_zfs_mounts(ctx)}") + + with allocated_files( + (args.path / f"test{n:02d}.dat", 1 * Size.GIB) for n in range(1, 4) + ) as bf: + ####################################################################### + preTest("create zpool backed by single file") + with zpool_create(ctx, "test01", paths_to_unc(bf[:1])): + log_dl("after test01 pool create") + + ####################################################################### + preTest("create zpool backed by two files") + with zpool_create(ctx, "test02", paths_to_unc(bf[:2])): + log_dl("after test02 pool create") + + ####################################################################### + preTest("create zpool backed by three files") + with zpool_create(ctx, "test03", paths_to_unc(bf)): + log_dl("after test03 pool create") + + ####################################################################### + preTest("create mirror zpool backed by two files") + with zpool_create(ctx, "test04", ["mirror", *paths_to_unc(bf[:2])]): + log_dl("after test04 pool create") + + ####################################################################### + preTest("create mirror zpool backed by three files") + with zpool_create(ctx, "test05", ["mirror", *paths_to_unc(bf)]): + log_dl("after test05 pool create") + + ####################################################################### + preTest("create raidz zpool backed by three files") + with zpool_create(ctx, "test06", ["raidz", *paths_to_unc(bf)]): + log_dl("after test06 pool create") + + ####################################################################### + preTest("create raidz1 zpool backed by three files") + with zpool_create(ctx, "test07", ["raidz1", *paths_to_unc(bf)]): + log_dl("after test07 pool create") + + ####################################################################### + preTest("snapshot no hang") + with zpool_create(ctx, "testsn01", paths_to_unc(bf[:1])) as pool: + log_dl("after testsn01 pool create") + + allocate_file(pool.mount_path / "test01.file", 1 * Size.KIB) + run_cmd(ctx.ZFS, ["snapshot", "testsn01@friday"]) + allocate_file(pool.mount_path / "test02.file", 1 * Size.KIB) + run_cmd(ctx.ZPOOL, ["export", "-a"]) + pool.destroy = False # already exported + + # ####################################################################### # preTest("snapshot hang") - # - # ret = runWithPrint(["zpool", "create", "-f", "testsn02", tounc(f1)]) - # if ret.returncode != 0: - # print("FAIL") - # time.sleep(10) - # print("Drive letters after pool create:", get_driveletters()) - # - # f = PureWindowsPath(get_driveletters()[0][1], "test01.file") - # allocate_file(f, 1 * Size.KIB) - # - # ret = runWithPrint(["zfs", "snapshot", "testsn02@friday"]) - # if ret.returncode != 0: - # print("FAIL") - # - # - # f = PureWindowsPath(get_driveletters()[0][1], "test02.file") - # allocate_file(f, 1 * Size.KIB) - # - # ret = runWithPrint(["zfs", "mount", "testsn02@friday"]) - # if ret.returncode != 0: - # print("FAIL") - # - # - # ret = runWithPrint(["zpool", "export", "-a"]) - # if ret.returncode != 0: - # print("FAIL") - # time.sleep(10) - # - # runWithPrint(["zpool", "destroy", "-f", "testsn02"]) - # time.sleep(10) - # postTest() - - preTest("regex for key file") - - random_bytearray = bytearray(os.urandom(32)) - - key01 = PureWindowsPath(p, "key01.key") - - with open(key01, 'wb') as f: - f.write(random_bytearray) - - nx = "file://" + tounc(key01).replace("\\", "/") - print(nx) + # with zpool_create(ctx, "testsn02", paths_to_unc(bf[:1])) as pool: + # log_dl("after testsn02 pool create") - ret = runWithPrint(["zpool", "create", "-f", "-O", - "encryption=aes-256-ccm", "-O", - "keylocation=" + nx, "-O", "keyformat=raw", - "tank", tounc(f1)]) - if ret.returncode != 0: - print("FAIL") - time.sleep(10) - print("Drive letters after pool create:", get_driveletters()) - - ret = runWithPrint(["zfs", "get", "keylocation", "tank"]) - if ret.returncode != 0: - print("FAIL") - - ret = runWithPrint(["zpool", "export", "tank"]) - if ret.returncode != 0: - print("FAIL") - time.sleep(10) - - print("Drive letters before pool create:", get_driveletters()) - ret = runWithPrint(["zpool", "import", "-f", "-l", "-O", - "encryption=aes-256-ccm", "-O", - "keylocation=" + nx, "-O", "keyformat=raw", - tounc(f1)]) - if ret.returncode != 0: - print("FAIL") - time.sleep(10) - - print("Drive letters after pool create:", get_driveletters()) - runWithPrint(["zpool", "destroy", "-f", "tank"]) - time.sleep(10) - postTest() + # allocate_file(pool.mount_path / "test01.file", 1 * Size.KIB) + # run_cmd(ctx.ZFS, ["snapshot", "testsn02@friday"]) + # allocate_file(pool.mount_path / "test02.file", 1 * Size.KIB) + # run_cmd(ctx.ZFS, ["mount", "testsn02@friday"]) + # run_cmd(ctx.ZPOOL, ["export", "-a"]) + # pool.destroy = False # already exported + ####################################################################### + preTest("regex for key file") + with random_key(args.path / "key01.key", 32) as key01: + key01uri = "file://" + str(path_to_unc(key01)).replace("\\", "/") + + with zpool_create( + ctx, + "tank", + paths_to_unc(bf[:1]), + zfs_options={ + "encryption": "aes-256-ccm", + "keylocation": key01uri, + "keyformat": "raw", + }, + ): + log_dl("after tank pool create") + + run_cmd(ctx.ZFS, ["get", "keylocation", "tank"]) + run_cmd(ctx.ZPOOL, ["export", "tank"]) + + log_dl("before pool import") + + run_cmd( + ctx.ZPOOL, + [ + "import", + "-d", + bf[0].parent.as_posix(), + "-f", + "-l", + "tank", + ], + ) + + log_dl("after pool import") + + ####################################################################### preTest("run out of drive letters") - for i in range(1, 26): - ret = runWithPrint(["zpool", "create", "-f", "tank" + str(i), - tounc(f1)]) - if ret.returncode != 0: - print("FAIL") - time.sleep(10) - - print("Drive letters after pool create:", get_driveletters()) - - f = PureWindowsPath(get_driveletters()[0][1], "test01.file") - try: - allocate_file(f, 1 * Size.KIB) - except Exception: - print("FAIL") - - runWithPrint(["zpool", "destroy", "-f", "tank" + str(i)]) - time.sleep(10) - - postTest() + with zpool_create(ctx, f"tank{i}", paths_to_unc(bf[:1])) as pool: + log_dl(f"after tank{i} pool create") - delete_file(f1) - delete_file(f2) - delete_file(f3) + allocate_file(pool.mount_path / "test01.file", 1 * Size.KIB) if __name__ == "__main__": diff --git a/contrib/windows/tests/utils.py b/contrib/windows/tests/utils.py index f964b2d3e83f..8912e0c89843 100644 --- a/contrib/windows/tests/utils.py +++ b/contrib/windows/tests/utils.py @@ -1,5 +1,6 @@ import argparse import contextlib +import csv import ctypes from ctypes import wintypes import enum @@ -7,8 +8,8 @@ import msvcrt import os import pathlib +import re import subprocess -import time import typing @@ -359,6 +360,17 @@ def allocated_files( os.remove(f[0]) +@contextlib.contextmanager +def random_key(path: pathlib.Path, size: int) -> pathlib.Path: + with open(path, "wb") as f: + f.write(os.urandom(size)) + + try: + yield path + finally: + os.remove(path) + + def options_to_args( flag: str, options: typing.Dict[str, str] ) -> typing.List[str]: @@ -427,9 +439,6 @@ def zpool_create( try: yield pool_info finally: - # TODO: This sleep is to protect against BSOD. Remove this sleep when - # https://github.com/openzfsonwindows/openzfs/issues/282 is fixed - time.sleep(2.0) if pool_info.destroy: res = run_cmd(ctx.ZPOOL, ["destroy", "-f", name]) if res.returncode != 0: @@ -474,3 +483,37 @@ def add_common_arguments(parser: argparse.ArgumentParser): default=False, help="Don't create a zpool, run tests in path", ) + + +ZFS_MOUNT_REGEX = re.compile(r"^([A-Za-z0-9_.\/-]{1,255}) +(.*)$") + + +def get_zfs_mounts(ctx: ZfsContext) -> typing.Dict[str, os.PathLike]: + res = run_cmd(ctx.ZFS, ["mount"], capture_output=True) + ret = {} + for line in decode_console_cp(res.stdout).splitlines(): + m = ZFS_MOUNT_REGEX.match(line) + if m: + ret[m.group(1)] = pathlib.Path(m.group(2)) + return ret + + +def get_diskdrive_paths(): + res = subprocess.run( + ["wmic", "diskdrive", "get", "Caption,DeviceId", "/format:CSV"], + capture_output=True, + ) + + if res.returncode != 0: + raise RuntimeError(f"Failed to get diskdrive paths: {res.stderr}") + + csv_data = csv.DictReader( + decode_console_cp(res.stdout).split("\r\r\n")[1:-1] + ) + + ret = {} + for row in csv_data: + # We don't make it into a pathlib.Path because this adds a backslash + # See https://github.com/python/cpython/pull/102003 + ret[row["DeviceID"]] = row["Caption"] + return ret