gui/build.py

"""
Helper script to work with mozregression-gui.

See python build.py --help
"""

import argparse
import glob
import os
import shlex
import shutil
import subprocess
import sys
import tarfile
from pathlib import Path

IS_WIN = os.name == "nt"
IS_MAC = sys.platform == "darwin"


def call(*args, **kwargs):
    print("Executing `%s`" % " ".join(shlex.quote(a) for a in args))
    subprocess.check_call(args, **kwargs)


def py_script(script_name):
    python_dir = os.path.dirname(sys.executable)
    if IS_WIN:
        return os.path.join(python_dir, "Scripts", script_name + ".exe")
    else:
        return os.path.join(python_dir, script_name)


def do_uic(options, force=False):
    for uifile in glob.glob("mozregui/ui/*.ui"):
        pyfile = os.path.splitext(uifile)[0] + ".py"
        if (
            force
            or not os.path.isfile(pyfile)
            or (os.path.getmtime(uifile) > os.path.getmtime(pyfile))
        ):
            print("uic'ing %s -> %s" % (uifile, pyfile))
            os.system("pyside6-uic {} > {}".format(uifile, pyfile))


def do_rcc(options, force=False):
    rccfile = "resources.qrc"
    pyfile = "resources_rc.py"
    if (
        force
        or not os.path.isfile(pyfile)
        or (os.path.getmtime(rccfile) > os.path.getmtime(pyfile))
    ):
        print("rcc'ing %s -> %s" % (rccfile, pyfile))
        call("pyside6-rcc", "-o", pyfile, rccfile)


def do_run(options):
    do_uic(options)
    do_rcc(options)
    call(sys.executable, "mozregression-gui.py")


def do_test(options):
    do_uic(options)
    do_rcc(options)
    print("Running tests...")
    import pytest

    sys.exit(pytest.main(["tests", "-v"]))


def do_bundle(options):
    do_uic(options, True)
    do_rcc(options, True)

    # clean previous runs
    for dirname in ("build", "dist"):
        if os.path.isdir(dirname):
            shutil.rmtree(dirname)

    # create a bundle for the application
    call("pyinstaller", "gui.spec")

    # create an installer
    if IS_WIN:
        if options.upx_path:
            call(
                options.upx_path,
                os.path.join("dist", "mozregression-gui", "mozregression-gui.exe"),
            )
        makensis_path = os.path.join(options.nsis_path, "makensis.exe")
        call(makensis_path, "wininst.nsi", cwd="wininst")
    elif IS_MAC:
        Path("dist/mozregression GUI").unlink()
        with tarfile.open("mozregression-gui-app-bundle.tar.gz", "w:gz") as tar:
            tar.add(r"dist", arcname="mozregression-gui-app-bundle")
    else:
        # seems like some qml stuff is also bundled on Linux
        try:
            shutil.rmtree(os.path.join("dist", "mozregression-gui", "PySide6", "qml"))
        except FileNotFoundError:
            pass
        with tarfile.open("mozregression-gui.tar.gz", "w:gz") as tar:
            tar.add(r"dist/mozregression-gui", arcname="mozregression-gui")


def parse_args():
    parser = argparse.ArgumentParser()
    subparsers = parser.add_subparsers()

    uic = subparsers.add_parser("uic", help="build uic files")
    uic.set_defaults(func=do_uic)

    rcc = subparsers.add_parser("rcc", help="build rcc files")
    rcc.set_defaults(func=do_rcc)

    run = subparsers.add_parser("run", help="run the application")
    run.set_defaults(func=do_run)

    test = subparsers.add_parser("test", help="run the unit tests")
    test.set_defaults(func=do_test)

    bundle = subparsers.add_parser("bundle", help="bundle the application (freeze)")
    if IS_WIN:
        bundle.add_argument(
            "--nsis-path",
            default="C:\\NSIS",
            help="your NSIS path on the" " system(default: %(default)r)",
        )
        bundle.add_argument("--upx-path", default=None, help="Path to upx executable")

    bundle.set_defaults(func=do_bundle)

    return parser.parse_args()


def main():
    # chdir in this folder
    os.chdir(os.path.dirname(os.path.realpath(__file__)))

    options = parse_args()
    try:
        options.func(options)
    except Exception as e:
        sys.exit("ERROR: %s" % e)


if __name__ == "__main__":
    main()