src/testing/end_to_end/mobly_driver/main.py

#!/usr/bin/env fuchsia-vendored-python
# Copyright 2023 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Entry point of Mobly Driver which conducts Mobly test execution."""

import argparse
import os
import sys
import signal

import mobly_driver
from mobly_driver import driver_factory

parser = argparse.ArgumentParser()
parser.add_argument(
    "mobly_test_path",
    help="path to the Mobly test archive produced by the GN build system.",
)
parser.add_argument(
    "-config_yaml_path",
    default=None,
    help="path to the Mobly test config YAML file.",
)
parser.add_argument(
    "-params_yaml_path",
    default=None,
    help="path to the Mobly test params YAML file.",
)
parser.add_argument(
    "-test_timeout_sec",
    default=None,
    help="integer to specify number of seconds before a Mobly test times out.",
)
parser.add_argument(
    "-test_data_path",
    default=None,
    help="path to directory containing test-time data dependencies.",
)
parser.add_argument("-ffx_path", default=None, help="path to FFX.")
parser.add_argument(
    "-ssh_path",
    default=None,
    help="path to SSH binary used by test connectivity labs access points.",
)
parser.add_argument(
    "-ffx_subtools_search_path",
    default=None,
    help="path to FFX subtools search path.",
)
parser.add_argument(
    "-transport",
    default=None,
    help="value to use in mobly config for host->device transport type.",
)
parser.add_argument(
    "-multi_device",
    action="store_const",
    const=True,
    default=False,
    help="Whether the mobly test requires 2+ Fuchsia devices to run.",
)
parser.add_argument(
    "-v",
    action="store_const",
    const=True,
    default=False,
    help="run the mobly test with the -v flag.",
)
args = parser.parse_args()


def main() -> None:
    """Executes the Mobly test via Mobly Driver.

    This function determines the appropriate Mobly Driver implementation to use
    based on the execution environment, and uses the Mobly Driver to run the
    underlying Mobly test.
    """
    factory = driver_factory.DriverFactory(
        ffx_path=os.path.abspath(args.ffx_path),
        transport=args.transport,
        multi_device=args.multi_device,
        config_path=args.config_yaml_path,
        params_path=args.params_yaml_path,
        ffx_subtools_search_path=os.path.abspath(args.ffx_subtools_search_path)
        if args.ffx_subtools_search_path
        else None,
        ssh_path=os.path.abspath(args.ssh_path) if args.ssh_path else None,
    )
    driver = factory.get_driver()

    signal.signal(signal.SIGINT, driver.teardown)
    signal.signal(signal.SIGTERM, driver.teardown)

    # Use the same Python runtime for Mobly test execution as the one that's
    # currently running this Mobly driver script.
    mobly_driver.run(
        driver=driver,
        python_path=sys.executable,
        test_path=args.mobly_test_path,
        timeout_sec=args.test_timeout_sec,
        test_data_path=args.test_data_path,
        verbose=args.v,
    )