package.py

# coding: utf-8
"""
packaging script for the albion project

USAGE
    package.py [-h, -i, -u, -t] [directory],

OPTIONS
    -h, --help
        print this help

    -i, --install [directory]
        install the package in the .qgis2 directory, if directory is ommited,
        install in the QGis plugin directory

    -u, --uninstall
        uninstall (remove) the package from .qgis2 directory

    -t
        launch the tests before installing/uninstalling
"""
from __future__ import print_function

from builtins import str
import os
import zipfile
import re
import git
import shutil
import subprocess
from .doc import build as build_doc


# @todo make that work on windows
qgis_plugin_dir = os.path.join(os.path.expanduser("~"), ".local", "share", "QGIS", "QGIS3", "profiles", "default", "python", "plugins")
zipname = "albion"
zipext = ".zip"


def run_tests():
    out, err = subprocess.Popen(
        ["pytest"], stdout=subprocess.PIPE, stderr=subprocess.PIPE
    ).communicate()
    if "0 failed" not in out.splitlines()[-1]:
        print("Can not deploy if test fails.")
        print(out)
        exit(1)


def uninstall(install_dir):
    target_dir = os.path.join(install_dir, "albion")
    if os.path.isdir(target_dir):
        print("uninstall dir {}".format(target_dir))
        shutil.rmtree(target_dir)
    else:
        print("Install directory '{}' not found".format(target_dir))


def install(install_dir, zip_filename):
    uninstall(install_dir)
    with zipfile.ZipFile(zip_filename, "r") as z:
        z.extractall(install_dir)
    print("installed in {}".format(install_dir))


def zip_(zip_filename, with_doc=True):
    """the zip file doesn't include tests, demos or docs"""
    base_dir = os.path.abspath(os.path.dirname(__file__))
    with zipfile.ZipFile(zip_filename, "w") as package:
        for root, dirs, files in os.walk(base_dir):
            if not with_doc and 'doc' in dirs:
                dirs = dirs.remove('doc')

            if not re.match(r".*(test_data|__pycache__).*", root):
                for file_ in files:
                    if (
                        re.match(
                            r".*\.(py|txt|ui|json|sql|png|svg|qml|qgs|html|gif|inv|js|css|zip)$",
                            file_,
                        )
                        and not re.match(r".*(_test|_demo)\.py", file_)
                        and not re.match(r".*albion.zip$", file_)
                        and not re.match(r"(package.py|test.py)", file_)
                    ):
                        fake_root = root.replace(base_dir, "albion")
                        package.write(
                            os.path.join(root, file_), os.path.join(fake_root, file_)
                        )

        # add a commit sha1 for tracability
        repo = git.Repo(search_parent_directories=True)
        sha = repo.head.object.hexsha
        package.writestr(os.path.join("albion", "version"), sha)


if __name__ == "__main__":
    import getopt
    import sys

    try:
        optlist, args = getopt.getopt(
            sys.argv[1:], "hiudtn", ["help", "install", "uninstall", "test", "nodoc"]
        )
    except Exception as e:
        sys.stderr.write(str(e) + "\n")
        exit(1)

    optlist = dict(optlist)

    if "-h" in optlist or "--help" in optlist or not optlist:
        help(sys.modules[__name__])
        exit(0)

    if "-t" in optlist:
        run_tests()

    doc = True
    if "-n" in optlist or "--nodoc" in optlist:
        doc = False

    build_doc()

    zip_filename = os.path.join(os.path.dirname(__file__), zipname + zipext)
    zip_(zip_filename, doc)
    print("created {}".format(zip_filename))
    install_dir = qgis_plugin_dir if len(args) == 0 else args[0]

    if "-u" in optlist or "--uninstall" in optlist:
        uninstall(install_dir)

    if "-i" in optlist or "--install" in optlist:
        install(install_dir, zip_filename)