[PATCH v2 04/15] KVM: selftests: Add option to save selftest runner output to a directory
Vipin Sharma
vipinsh at google.com
Fri Jun 6 16:56:08 PDT 2025
Add a command line flag, --output/-o, to selftest runner which enables to
save individual tests output (stdout & stderr) stream to a directory in
a hierarchical way. Create folder hierarchy same as tests hieararcy
given by --test-files and --test-dirs.
Also, add a command line flag, --append-output-time, which will append
timestamp (format YYYY.M.DD.HH.MM.SS) to the directory name given in
--output flag.
Example:
python3 runner --test-dirs test -o test_result --append_output_time
This will create test_result.2025.06.06.08.45.57 directory.
Signed-off-by: Vipin Sharma <vipinsh at google.com>
---
.../testing/selftests/kvm/runner/__main__.py | 30 ++++++++++++++++--
tools/testing/selftests/kvm/runner/command.py | 31 +++++++++++++++++--
.../testing/selftests/kvm/runner/selftest.py | 8 +++--
.../selftests/kvm/runner/test_runner.py | 17 +++++-----
4 files changed, 72 insertions(+), 14 deletions(-)
diff --git a/tools/testing/selftests/kvm/runner/__main__.py b/tools/testing/selftests/kvm/runner/__main__.py
index f7f679be0e03..54bdc248b13f 100644
--- a/tools/testing/selftests/kvm/runner/__main__.py
+++ b/tools/testing/selftests/kvm/runner/__main__.py
@@ -7,6 +7,8 @@ import argparse
import logging
import os
import sys
+import datetime
+import pathlib
from test_runner import TestRunner
from selftest import SelftestStatus
@@ -41,6 +43,16 @@ def cli():
type=int,
help="Timeout, in seconds, before runner kills the running test. (Default: 120 seconds)")
+ parser.add_argument("-o",
+ "--output",
+ nargs='?',
+ help="Dumps test runner output which includes each test execution result, their stdouts and stderrs hierarchically in the given directory.")
+
+ parser.add_argument("--append-output-time",
+ action="store_true",
+ default=False,
+ help="Appends timestamp to the output directory.")
+
return parser.parse_args()
@@ -71,12 +83,26 @@ def setup_logging(args):
logger = logging.getLogger("runner")
logger.setLevel(logging.INFO)
+ formatter_args = {
+ "fmt": "%(asctime)s | %(message)s",
+ "datefmt": "%H:%M:%S"
+ }
+
ch = logging.StreamHandler()
- ch_formatter = TerminalColorFormatter(fmt="%(asctime)s | %(message)s",
- datefmt="%H:%M:%S")
+ ch_formatter = TerminalColorFormatter(**formatter_args)
ch.setFormatter(ch_formatter)
logger.addHandler(ch)
+ if args.output != None:
+ if (args.append_output_time):
+ args.output += datetime.datetime.now().strftime(".%Y.%m.%d.%H.%M.%S")
+ pathlib.Path(args.output).mkdir(parents=True, exist_ok=True)
+ logging_file = os.path.join(args.output, "log")
+ fh = logging.FileHandler(logging_file)
+ fh_formatter = logging.Formatter(**formatter_args)
+ fh.setFormatter(fh_formatter)
+ logger.addHandler(fh)
+
def fetch_tests_from_dirs(scan_dirs):
test_files = []
diff --git a/tools/testing/selftests/kvm/runner/command.py b/tools/testing/selftests/kvm/runner/command.py
index 44c8e0875779..6f6b1811b490 100644
--- a/tools/testing/selftests/kvm/runner/command.py
+++ b/tools/testing/selftests/kvm/runner/command.py
@@ -4,6 +4,9 @@
# Author: vipinsh at google.com (Vipin Sharma)
import subprocess
+import pathlib
+import contextlib
+import os
class Command:
@@ -12,17 +15,39 @@ class Command:
Returns the exit code, std output and std error of the command.
"""
- def __init__(self, command, timeout):
+ def __init__(self, command, timeout, output_dir):
self.command = command
self.timeout = timeout
+ self.output_dir = output_dir
- def run(self):
+ def _run(self, output=None, error=None):
run_args = {
"universal_newlines": True,
"shell": True,
- "capture_output": True,
"timeout": self.timeout,
}
+ if output is None and error is None:
+ run_args.update({"capture_output": True})
+ else:
+ run_args.update({"stdout": output, "stderr": error})
+
proc = subprocess.run(self.command, **run_args)
return proc.returncode, proc.stdout, proc.stderr
+
+ def run(self):
+ if self.output_dir is not None:
+ pathlib.Path(self.output_dir).mkdir(parents=True, exist_ok=True)
+
+ output = None
+ error = None
+ with contextlib.ExitStack() as stack:
+ if self.output_dir is not None:
+ output_path = os.path.join(self.output_dir, "stdout")
+ output = stack.enter_context(
+ open(output_path, encoding="utf-8", mode="w"))
+
+ error_path = os.path.join(self.output_dir, "stderr")
+ error = stack.enter_context(
+ open(error_path, encoding="utf-8", mode="w"))
+ return self._run(output, error)
diff --git a/tools/testing/selftests/kvm/runner/selftest.py b/tools/testing/selftests/kvm/runner/selftest.py
index 4c72108c47de..664958c693e5 100644
--- a/tools/testing/selftests/kvm/runner/selftest.py
+++ b/tools/testing/selftests/kvm/runner/selftest.py
@@ -32,7 +32,7 @@ class Selftest:
Extract the test execution command from test file and executes it.
"""
- def __init__(self, test_path, executable_dir, timeout):
+ def __init__(self, test_path, executable_dir, timeout, output_dir):
test_command = pathlib.Path(test_path).read_text().strip()
if not test_command:
raise ValueError("Empty test command in " + test_path)
@@ -40,7 +40,11 @@ class Selftest:
test_command = os.path.join(executable_dir, test_command)
self.exists = os.path.isfile(test_command.split(maxsplit=1)[0])
self.test_path = test_path
- self.command = command.Command(test_command, timeout)
+
+ if output_dir is not None:
+ output_dir = os.path.join(output_dir, test_path.lstrip("/"))
+ self.command = command.Command(test_command, timeout, output_dir)
+
self.status = SelftestStatus.NO_RUN
self.stdout = ""
self.stderr = ""
diff --git a/tools/testing/selftests/kvm/runner/test_runner.py b/tools/testing/selftests/kvm/runner/test_runner.py
index 1409e1cfe7d5..0501d77a9912 100644
--- a/tools/testing/selftests/kvm/runner/test_runner.py
+++ b/tools/testing/selftests/kvm/runner/test_runner.py
@@ -13,19 +13,22 @@ logger = logging.getLogger("runner")
class TestRunner:
def __init__(self, test_files, args):
self.tests = []
+ self.output_dir = args.output
for test_file in test_files:
- self.tests.append(Selftest(test_file, args.executable, args.timeout))
+ self.tests.append(Selftest(test_file, args.executable,
+ args.timeout, args.output))
def _log_result(self, test_result):
logger.log(test_result.status,
f"[{test_result.status}] {test_result.test_path}")
- logger.info("************** STDOUT BEGIN **************")
- logger.info(test_result.stdout)
- logger.info("************** STDOUT END **************")
- logger.info("************** STDERR BEGIN **************")
- logger.info(test_result.stderr)
- logger.info("************** STDERR END **************")
+ if (self.output_dir is None):
+ logger.info("************** STDOUT BEGIN **************")
+ logger.info(test_result.stdout)
+ logger.info("************** STDOUT END **************")
+ logger.info("************** STDERR BEGIN **************")
+ logger.info(test_result.stderr)
+ logger.info("************** STDERR END **************")
def start(self):
ret = 0
--
2.50.0.rc0.604.gd4ff7b7c86-goog
More information about the linux-arm-kernel
mailing list