__main__.py

#!/usr/bin/env python3
# Copyright 2024 HTCondor Team, Computer Sciences Department,
# University of Wisconsin-Madison, WI.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Usage: run the exerciser with a variety of options
"""

__author__ = 'Ryan James Boone <rboone3@wisc.edu>'

import argparse
import sys
import os

sys.path.append(os.path.join(os.path.dirname(__file__), "src"))
from src import general


def parse_cla() -> argparse.Namespace:
    """
    Usage: command line argument parser
    @return: parsed arguments in argparse.Namespace object
    """
    parser = argparse.ArgumentParser()

    parser.add_argument(
        "tests",
        nargs="*",
        default=[],
        help="Comma separated list of specific tests to execute. "
        + "If not specified all available tests are executed.",
    )

    parser.add_argument(
        "-f",
        "--flush-all",
        action="store_true",
        dest="flush_all",
        help="Clears out all previous exerciser execution subdirectories "
        + "from the specified working directory.",
    )

    parser.add_argument(
        "-d",
        "--flush-by-date",
        metavar="YYYY-MM-DD_hh-mm",
        dest="flush_by_date",
        help=f"Removes all exerciser execution subdirectories in the specified "
        + "working directory older than the specified date/time. Note: "
        + "date/time can be any level of specificity from just YYYY to full "
        + "YYYY-MM-DD_hh-mm format.",
    )

    parser.add_argument(
        "-p",
        "--print-tests",
        action="store_true",
        dest="print_tests",
        help="Prints the list of all available tests found in the specified test directory.",
    )

    parser.add_argument(
        "-s",
        "--snapshot",
        action="store_true",
        dest="snapshot",
        help="Prints a list of all currently available resources in the pool.",
    )

    parser.add_argument(
        "-w",
        "--working-dir",
        metavar="directory_path",
        dest="working_dir",
        help="Specify a specific working directory for the exerciser to execute in.",
    )

    parser.add_argument(
        "-t",
        "--test-dir",
        metavar="directory_path",
        dest="test_dir",
        help="Specifies a directory containing available exerciser tests to execute.",
    )

    parser.add_argument(
        "-b",
        "--block-run",
        action="store_false",
        dest="run",
        help="Disables execution of tests.",
    )

    parser.add_argument(
        "-r",
        "--resource-sample-size",
        metavar="size",
        dest="resource_sample_size",
        type=float,
        default=0.05,
        help="Specifies the percent of machines in each resource to send tests to. Argument value "
        + "should be a float between 0.0 (exclusive) and 1.0 (inclusive).",
    )

    parser.add_argument(
        "-cm",
        "--central-manager",
        metavar="cm.pool.domain",
        dest="central_manager",
        type=str,
        default="cm-1.ospool.osg-htc.org",
        help="Specifies the address of the HTCondor Central Manager."
        + "Used for querying the resources available in the corresponding HTC pool."
    )

    return parser.parse_args()


def process_cla(args: argparse.Namespace):
    """
    Usage: verification and processing of args returned by parse_cla()
    @param args: argparse.Namespace object returned by parse_cla()
    """
    if args.snapshot and args.print_tests:
        print("Error: Cannot select both --snapshot and --print-tests options at the same time")
        sys.exit(1)

    if (args.resource_sample_size <= 0.0) or (args.resource_sample_size > 1.0):
        print("Error: Resource sample size must be between 0.0 (exclusive) and 1.0 (inclusive)")
        sys.exit(1)

    # process tests arg
    # split the list around commas and remove duplicates
    for item in args.tests:
        if "," in item:
            args.tests.extend(item.split(","))
            args.tests.remove(item)
    args.tests = list(set(args.tests))
    if "" in args.tests:
        args.tests.remove("")


def main():
    """
    Usage: run the thing
    """
    args = parse_cla()
    process_cla(args)
    general.run_exerciser(args)


if __name__ == "__main__":
    sys.exit(main())