#!/usr/bin/python
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

import json
from argparse import ArgumentParser

ALL_HARNESSES = [
    "common",  # Harnesses without a specific package will look here.
    "condprof",
    "mochitest",
    "reftest",
    "xpcshell",
    "cppunittest",
    "jittest",
    "mozbase",
    "web-platform",
    "talos",
    "raptor",
    "awsy",
    "gtest",
    "updater-dep",
    "jsreftest",
    "perftests",
    "fuzztest",
    "trainhop",
]

PACKAGE_SPECIFIED_HARNESSES = [
    "condprof",
    "cppunittest",
    "mochitest",
    "reftest",
    "xpcshell",
    "web-platform",
    "talos",
    "raptor",
    "awsy",
    "updater-dep",
    "jittest",
    "jsreftest",
    "perftests",
    "fuzztest",
    "trainhop",
]

# These packages are not present for every build configuration.
OPTIONAL_PACKAGES = [
    "gtest",
]

# Harnesses that load the train-hop NSS/libxul bundle at runtime
# (see testing/mochitest/runtests.py for the consumer). Other harnesses
# must not pull this in: on macOS aarch64 the trainhop archive contains
# x86_64-only dylibs that overwrite the universal libnss3.dylib from
# target.jsshell.zip and break jit-test (bug 1986386).
HARNESSES_NEEDING_TRAINHOP = {
    "mochitest",
    "trainhop",
}


def parse_args():
    parser = ArgumentParser(
        description="Generate a test_packages.json file to tell automation which harnesses "
        "require which test packages."
    )
    parser.add_argument(
        "--common",
        required=True,
        action="store",
        dest="tests_common",
        help='Name of the "common" archive, a package to be used by all harnesses.',
    )
    parser.add_argument(
        "--jsshell",
        required=True,
        action="store",
        dest="jsshell",
        help="Name of the jsshell zip.",
    )
    for harness in PACKAGE_SPECIFIED_HARNESSES:
        parser.add_argument(
            "--%s" % harness,
            required=False,
            action="store",
            dest=harness,
            help="Name of the %s zip." % harness,
        )
    for harness in OPTIONAL_PACKAGES:
        parser.add_argument(
            "--%s" % harness,
            required=False,
            action="store",
            dest=harness,
            help="Name of the %s zip." % harness,
        )
    parser.add_argument(
        "--dest-file",
        required=True,
        action="store",
        dest="destfile",
        help="Path to the output file to be written.",
    )
    return parser.parse_args()


def generate_package_data(args):
    # Generate a dictionary mapping test harness names (exactly as they're known to
    # mozharness and testsuite-targets.mk, ideally) to the set of archive names that
    # harness depends on to run.
    # mozharness will use this file to determine what test zips to download,
    # which will be an optimization once parts of the main zip are split to harness
    # specific zips.
    tests_common = args.tests_common
    jsshell = args.jsshell

    harness_requirements = dict([(k, [tests_common]) for k in ALL_HARNESSES])

    condprof = args.condprof
    trainhop = args.trainhop

    if args.jittest:
        harness_requirements["jittest"].append(jsshell)

    if args.jsreftest and args.reftest:
        harness_requirements["jsreftest"].append(args.reftest)

    if condprof:
        harness_requirements["common"].append(condprof)

    for harness in PACKAGE_SPECIFIED_HARNESSES + OPTIONAL_PACKAGES:
        pkg_name = getattr(args, harness, None)
        if pkg_name is None:
            continue
        harness_requirements[harness].append(pkg_name)
        if condprof:
            harness_requirements[harness].append(condprof)
        if harness in HARNESSES_NEEDING_TRAINHOP and trainhop:
            harness_requirements[harness].append(trainhop)
    return harness_requirements


if __name__ == "__main__":
    args = parse_args()
    packages_data = generate_package_data(args)
    with open(args.destfile, "w") as of:
        json.dump(packages_data, of, indent=4)