uhd/host/tests/devtest/run_testsuite.py

#!/usr/bin/env python3
#
# Copyright 2015-2016 Ettus Research LLC
# Copyright 2018 Ettus Research, a National Instruments Company
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
"""
Device test runner.
"""

import os
import sys
import subprocess
import argparse
import logging
from usrp_probe import get_usrp_list
import importlib.util

def setup_parser():
    """ Set up argparser """
    parser = argparse.ArgumentParser(description="Test utility for UHD/USRP.")
    parser.add_argument('--devtest-pattern', '-p', default='*', help='e.g. b2xx')
    parser.add_argument('--args', '-a', default='', help='Device address arguments')
    parser.add_argument('--log-dir', '-l', default='.')
    parser.add_argument('--src-dir', default='.',
                        help='Directory where the test sources are stored')
    parser.add_argument('--build-dir', help='Build dir (where examples/ and utils/ are)')
    parser.add_argument('--build-type', default='Release')
    parser.add_argument('--python-interp', default=sys.executable)
    parser.add_argument('--xml', '-x', dest='xml', action='store_true', default=False,
                        help='Generate XML report (using Python module unittest-xml-reporting)')
    return parser

def setup_env(args):
    " Add build dir into lib + exe paths, depending on OS "
    def setup_env_win(env, build_dir, build_type):
        " Add build dir into paths (Windows)"
        env['PATH'] = f"{build_dir}/lib/{build_type};" \
                      f"{build_dir}/examples/{build_type};" \
                      f"{build_dir}/utils/{build_type};{env.get('PATH', '')}"
        env['LIBPATH'] = f"{build_dir}/lib/{build_type};{env.get('LIBPATH', '')}"
        env['LIB'] = f"{build_dir}/lib/{build_type};{env.get('LIB', '')}"
        env['PYTHONPATH'] = f"{build_dir}/python"
        return env
    def setup_env_unix(env, build_dir):
        " Add build dir into paths (Unices)"
        env['PATH'] = f"{build_dir}/examples:{build_dir}/utils:{env.get('PATH', '')}"
        env['LD_LIBRARY_PATH'] = f"{build_dir}/lib:{env.get('LD_LIBRARY_PATH', '')}"
        env['PYTHONPATH'] = f"{build_dir}/python"
        return env
    def setup_env_osx(env, build_dir):
        " Add build dir into paths (OS X)"
        env['PATH'] = f"{build_dir}/examples:{build_dir}/utils:{env.get('PATH', '')}"
        env['DYLD_LIBRARY_PATH'] = f"{build_dir}/lib:{env.get('DYLD_LIBRARY_PATH', '')}"
        env['PYTHONPATH'] = f"{build_dir}/python"
        return env
    ### Go
    env = os.environ
    if sys.platform.startswith('linux'):
        env = setup_env_unix(env, args.build_dir)
    elif sys.platform.startswith('win'):
        env = setup_env_win(env, args.build_dir, args.build_type)
    elif sys.platform.startswith('darwin'):
        env = setup_env_osx(env, args.build_dir)
    else:
        print(f"Devtest not supported on this platform ({sys.platform}).")
        exit(1)
    return env

def main():
    " Go, go, go! "
    args = setup_parser().parse_args()
    env = setup_env(args)
    devtest_pattern = f"devtest_{args.devtest_pattern}.py"
    uhd_args_list = get_usrp_list(args.args, env)
    arg_dict = dict(arg.split('=') for arg in args.args.strip(',').split(','))
    if len(uhd_args_list) == 0:
        print("No devices found. Exiting.")
        exit(1)
    tests_passed = True
    for uhd_idx, uhd_info in enumerate(uhd_args_list):
        print(f"--- Running all tests for device {uhd_idx} "
              f"({uhd_info.get('product', 'USRP')}, Serial: {uhd_info.get('serial')}).")
        print('--- This will take some time. Better grab a cup of tea.')
        sys.stdout.flush()
        args_str = uhd_info['args']
        args_suffix = args_str.replace('type=', '_').replace('serial=', '_').replace(',', '')
        logfile_name = f"log{args_suffix}.log"
        resultsfile_name = f"results{args_suffix}.log"
        if 'addr' in arg_dict:
            args_str += f",addr={arg_dict['addr']}"
        if 'master_clock_rate' in arg_dict:
            args_str += f",master_clock_rate={arg_dict['master_clock_rate']}"
        env['_UHD_TEST_ARGS_STR'] = args_str
        env['_UHD_TEST_LOGFILE'] = os.path.join(args.log_dir, logfile_name)
        env['_UHD_TEST_RESULTSFILE'] = os.path.join(args.log_dir, resultsfile_name)
        env['_UHD_TEST_LOG_LEVEL'] = str(logging.INFO)
        env['_UHD_TEST_PRINT_LEVEL'] = str(logging.WARNING)
        env['_UHD_BUILD_DIR'] = str(args.build_dir)
        env['_UHD_DEVTEST_SRC_DIR'] = str(args.src_dir)
        if args.xml:
            if not importlib.util.find_spec("xmlrunner"):
                print("Error: XML report is requested but Python unittest-xml-reporting (aka. xmlrunner)\n" \
                      "       is not installed. Typically you can install it with:\n" \
                      "       pip3 install unittest-xml-reporting")
                sys.exit(1)
            test_module = "xmlrunner"
        else:
            test_module = "unittest"
        proc = subprocess.Popen(
            [
                args.python_interp, "-m", test_module, "discover", "-v",
                "-s", args.src_dir,
                "-p", devtest_pattern,
            ],
            env=env,
            stdin=subprocess.PIPE,
            stdout=subprocess.PIPE,
            stderr=subprocess.STDOUT,
            universal_newlines=True
        )
        print(proc.communicate()[0])
        sys.stdout.flush()
        if proc.returncode != 0:
            tests_passed = False
    print('--- Done testing all attached devices.')
    return tests_passed

if __name__ == "__main__":
    exit(not main())