Move htrun implementation to mbed_os_tools

Author: bridadan

legacy/mbed-host-tests/mbed_host_tests/__init__.py

@@ -25,235 +25,12 @@
 
 """
 
-
-import os
-import imp
-import inspect
-from os import listdir
-from os.path import isfile, join, abspath, basename
-import sys
-from optparse import OptionParser
-from optparse import SUPPRESS_HELP
-from mbed_host_tests import host_tests_plugins
-from mbed_host_tests.host_tests_registry import HostRegistry
-from mbed_host_tests.host_tests import BaseHostTest, event_callback
-
-
-# Set the default baud rate
-DEFAULT_BAUD_RATE = 9600
-
-###############################################################################
-# Functional interface for test supervisor registry
-###############################################################################
-
-
-def get_plugin_caps(methods=None):
-    if not methods:
-        methods = ['CopyMethod', 'ResetMethod']
-    result = {}
-    for method in methods:
-        result[method] = host_tests_plugins.get_plugin_caps(method)
-    return result
-
-
-def init_host_test_cli_params():
-    """! Function creates CLI parser object and returns populated options object.
-    @return Function returns 'options' object returned from OptionParser class
-    @details Options object later can be used to populate host test selector script.
-    """
-    parser = OptionParser()
-
-    parser.add_option("-m", "--micro",
-                      dest="micro",
-                      help="Target microcontroller name",
-                      metavar="MICRO")
-
-    parser.add_option("-p", "--port",
-                      dest="port",
-                      help="Serial port of the target",
-                      metavar="PORT")
-
-    parser.add_option("-d", "--disk",
-                      dest="disk",
-                      help="Target disk (mount point) path",
-                      metavar="DISK_PATH")
-
-    parser.add_option("-t", "--target-id",
-                      dest="target_id",
-                      help="Unique Target Id or mbed platform",
-                      metavar="TARGET_ID")
-
-    parser.add_option("", "--sync",
-                      dest="sync_behavior",
-                      default=2,
-                      type=int,
-                      help="Define how many times __sync packet will be sent to device: 0: none; -1: forever; 1,2,3... - number of times (Default 2 time)",
-                      metavar="SYNC_BEHAVIOR")
-
-    parser.add_option("", "--sync-timeout",
-                      dest="sync_timeout",
-                      default=5,
-                      type=int,
-                      help="Define delay in seconds between __sync packet (Default is 5 seconds)",
-                      metavar="SYNC_TIMEOUT")
-
-    parser.add_option("-f", "--image-path",
-                      dest="image_path",
-                      help="Path with target's binary image",
-                      metavar="IMAGE_PATH")
-
-    copy_methods_str = "Plugin support: " + ', '.join(host_tests_plugins.get_plugin_caps('CopyMethod'))
-
-    parser.add_option("-c", "--copy",
-                      dest="copy_method",
-                      help="Copy (flash the target) method selector. " + copy_methods_str,
-                      metavar="COPY_METHOD")
-
-    parser.add_option("", "--retry-copy",
-                      dest="retry_copy",
-                      default=3,
-                      type=int,
-                      help="Number of attempts to flash the target",
-                      metavar="RETRY_COPY")
-
-    parser.add_option("", "--tag-filters",
-                      dest="tag_filters",
-                      default="",
-                      type=str,
-                      help="Comma seperated list of device tags used when allocating a target to specify required hardware or attributes [--tag-filters tag1,tag2]",
-                      metavar="TAG_FILTERS")
-
-    reset_methods_str = "Plugin support: " + ', '.join(host_tests_plugins.get_plugin_caps('ResetMethod'))
-
-    parser.add_option("-r", "--reset",
-                      dest="forced_reset_type",
-                      help="Forces different type of reset. " + reset_methods_str)
-
-    parser.add_option("-C", "--program_cycle_s",
-                      dest="program_cycle_s",
-                      default=4,
-                      help="Program cycle sleep. Define how many seconds you want wait after copying binary onto target (Default is 4 second)",
-                      type="float",
-                      metavar="PROGRAM_CYCLE_S")
-
-    parser.add_option("-R", "--reset-timeout",
-                      dest="forced_reset_timeout",
-                      default=1,
-                      metavar="NUMBER",
-                      type="float",
-                      help="When forcing a reset using option -r you can set up after reset idle delay in seconds (Default is 1 second)")
-
-    parser.add_option("--process-start-timeout",
-                      dest="process_start_timeout",
-                      default=60,
-                      metavar="NUMBER",
-                      type="float",
-                      help="This sets the maximum time in seconds to wait for an internal process to start. This mostly only affects machines under heavy load (Default is 60 seconds)")
-
-    parser.add_option("-e", "--enum-host-tests",
-                      dest="enum_host_tests",
-                      action="append",
-                      default=["./test/host_tests"],
-                      help="Define directory with local host tests")
-
-    parser.add_option('', '--test-cfg',
-                      dest='json_test_configuration',
-                      help='Pass to host test class data about host test configuration')
-
-    parser.add_option('', '--list',
-                      dest='list_reg_hts',
-                      default=False,
-                      action="store_true",
-                      help='Prints registered host test and exits')
-
-    parser.add_option('', '--plugins',
-                      dest='list_plugins',
-                      default=False,
-                      action="store_true",
-                      help='Prints registered plugins and exits')
-
-    parser.add_option('-g', '--grm',
-                      dest='global_resource_mgr',
-                      help='[Experimental] Global resource manager service module name, IP and port, example remote_client:10.2.123.43:3334')
-
-    # Show --fm option only if "fm_agent" module installed
-    try:
-        imp.find_module('fm_agent')
-    except ImportError:
-        fm_help=SUPPRESS_HELP
-    else:
-        fm_help='Fast Model connection, This option requires mbed-fastmodel-agent module installed, list CONFIGs via "mbedfm"'
-    parser.add_option('', '--fm',
-                      dest='fast_model_connection',
-                      metavar="CONFIG",
-                      default=None,
-                      help=fm_help)
-
-    parser.add_option('', '--run',
-                      dest='run_binary',
-                      default=False,
-                      action="store_true",
-                      help='Runs binary image on target (workflow: flash, reset, output console)')
-
-    parser.add_option('', '--skip-flashing',
-                      dest='skip_flashing',
-                      default=False,
-                      action="store_true",
-                      help='Skips use of copy/flash plugin. Note: target will not be reflashed')
-
-    parser.add_option('', '--skip-reset',
-                      dest='skip_reset',
-                      default=False,
-                      action="store_true",
-                      help='Skips use of reset plugin. Note: target will not be reset')
-
-    parser.add_option('-P', '--polling-timeout',
-                      dest='polling_timeout',
-                      default=60,
-                      metavar="NUMBER",
-                      type="int",
-                      help='Timeout in sec for readiness of mount point and serial port of local or remote device. Default 60 sec')
-
-    parser.add_option('-b', '--send-break',
-                      dest='send_break_cmd',
-                      default=False,
-                      action="store_true",
-                      help='Send reset signal to board on specified port (-p PORT) and print serial output. You can combine this with (-r RESET_TYPE) switch')
-
-    parser.add_option('', '--baud-rate',
-                      dest='baud_rate',
-                      help="Baud rate of target, overrides values from mbed-ls, disk/mount point (-d, --disk-path), and serial port -p <port>:<baud rate>",
-                      metavar="BAUD_RATE")
-
-    parser.add_option('-v', '--verbose',
-                      dest='verbose',
-                      default=False,
-                      action="store_true",
-                      help='More verbose mode')
-
-    parser.add_option('', '--serial-output-file',
-                      dest='serial_output_file',
-                      default=None,
-                      help='Save target serial output to this file.')
-
-    parser.add_option('', '--compare-log',
-                      dest='compare_log',
-                      default=None,
-                      help='Log file to compare with the serial output from target.')
-
-    parser.add_option('', '--version',
-                      dest='version',
-                      default=False,
-                      action="store_true",
-                      help='Prints package version and exits')
-
-    parser.description = """Flash, reset and perform host supervised tests on mbed platforms"""
-    parser.epilog = """Example: mbedhtrun -d E: -p COM5 -f "test.bin" -C 4 -c shell -m K64F"""
-
-    (options, _) = parser.parse_args()
-
-    if len(sys.argv) == 1:
-        parser.print_help()
-        sys.exit()
-
-    return options
+from mbed_os_tools.test import (
+    host_tests_plugins,
+    HostRegistry,
+    BaseHostTest,
+    event_callback,
+    DEFAULT_BAUD_RATE,
+    get_plugin_caps,
+    init_host_test_cli_params,
+)