getNeuroML.py

"""Script to handle the NeuroML 2 repos"""
from __future__ import print_function
import os
import sys
import os.path as op
import subprocess
from textwrap import dedent


def main():
    """Main"""
    mode = "update"
    switch_to_branch = None
    dont_switch_jneuroml_branch = False

    if len(sys.argv) < 5:
        for arg in sys.argv[1:]:
            if arg == "clean":
                print("Cleaning repos")
                mode = "clean"
            elif arg == "development":
                switch_to_branch = "development"
            elif arg == "experimental":
                switch_to_branch = "experimental"
            elif arg == "master":
                switch_to_branch = "master"
            elif "osb" in arg:
                switch_to_branch = arg
            elif "-dont_switch_jneuroml_branch" in arg:
                dont_switch_jneuroml_branch = True
            else:
                help_info()
                exit()
    else:
        help_info()
        exit()

    neuroml2_spec_repo = ["NeuroML/NeuroML2"]
    libneuroml_repo = ["NeuralEnsemble/libNeuroML"]

    java_neuroml_repos = [
        "NeuroML/org.neuroml.model.injectingplugin",
        "NeuroML/org.neuroml.model",
        "NeuroML/org.neuroml1.model",
        "NeuroML/org.neuroml.export",
        "NeuroML/org.neuroml.import",
        "NeuroML/jNeuroML",
    ]

    neuroml_repos = neuroml2_spec_repo + libneuroml_repo + java_neuroml_repos

    jlems_repo = ["LEMS/jLEMS"]
    lems_spec_repos = ["LEMS/LEMS"]
    pylems_repos = ["LEMS/pylems"]

    java_repos = jlems_repo + java_neuroml_repos
    lems_repos = jlems_repo + lems_spec_repos + pylems_repos

    # Which repos use a development branch?
    dev_branch_repos = neuroml2_spec_repo + java_neuroml_repos + jlems_repo

    all_repos = lems_repos + neuroml_repos

    # Set the preferred method for cloning from GitHub
    github_pref = "HTTP"
    # github_pref = "SSH"
    # github_pref = "Git Read-Only"

    pre_gh = {}
    pre_gh["HTTP"] = "https://github.com/"
    pre_gh["SSH"] = "git@github.com:"
    pre_gh["Git Read-Only"] = "git://github.com/"

    for repo in all_repos:

        local_dir = ".." + os.sep + repo.split("/")[1]

        if mode == "clean":
            print("------ Cleaning: %s -------" % repo)
            if repo in java_repos:
                command = "mvn clean"
                print("It's a Java repository, so cleaning using Maven...")
                info = execute_command_in_dir(command, local_dir)

        if mode == "update":
            print("------ Updating: %s -------" % repo)

            runMvnInstall = False

            if not op.isdir(local_dir):
                command = "git clone %s%s" % (pre_gh[github_pref], repo)
                print(
                    "Creating a new directory: %s by cloning from GitHub" % (local_dir)
                )
                execute_command_in_dir(command, "..")

                runMvnInstall = True

            if switch_to_branch:
                if repo in dev_branch_repos:
                    if "jNeuroML" in repo and dont_switch_jneuroml_branch:
                        print(
                            "NOT switching repo %s to branch: %s"
                            % (repo, switch_to_branch)
                        )
                    else:
                        command = "git checkout %s" % (switch_to_branch)
                        print("Switching to branch: %s" % (switch_to_branch))
                        exit_on_fail = switch_to_branch != "experimental"
                        execute_command_in_dir(command, local_dir, exit_on_fail)
                    runMvnInstall = True

            info = execute_command_in_dir("git branch", local_dir)
            print(info.strip())

            if not ("jNeuroML" in repo and dont_switch_jneuroml_branch):
                return_string = execute_command_in_dir("git pull", local_dir)
            else:
                return_string = ""

            runMvnInstall = (
                runMvnInstall
                or "Already up-to-date" not in return_string
                or not op.isdir(local_dir + os.sep + "target")
                or ("jNeuroML" in repo)
            )

            if (repo in java_repos or repo in neuroml2_spec_repo) \
                    and runMvnInstall:
                command = "mvn install"
                print("It's a Java repository, so installing using Maven...")
                info = execute_command_in_dir(command, local_dir)

                # The code below needs a non trivial rewrite due to python3
                # differences.
                if str("BUILD SUCCESS") in str(info):
                    print("Successful installation using : %s!" % command)
                else:
                    print("Problem installing using : %s!" % command)
                    print(info)
                    exit(1)

    if mode == "update":
        print("All repositories successfully updated & Java modules built!")
        print("You should be able to run examples straight away using jnml: ")
        if os.name != "nt":
            print("  ./jnml " + "-validate ../NeuroML2/examples/NML2_FullNeuroML.nml")
            print("  ./jnml " + "../NeuroML2/LEMSexamples/LEMS_NML2_Ex2_Izh.xml")
        else:
            print("  jnml -validate " + "..\\NeuroML2\\examples\\NML2_FullNeuroML.nml")
            print("  jnml " + "..\\NeuroML2\\LEMSexamples\\LEMS_NML2_Ex2_Izh.xml")
    if mode == "clean":
        print("All repositories successfully cleaned!")


def execute_command_in_dir(command, directory, exit_on_fail=True):
    """Execute a command in specific working directory"""
    if os.name == "nt":
        directory = os.path.normpath(directory)

    print(
        ">>>  Executing: (%s) in dir: %s (%s)"
        % (command, directory, os.path.abspath(directory))
    )

    p = subprocess.Popen(command, cwd=directory, shell=True,
                         stdout=subprocess.PIPE)
    return_str = p.communicate()

    if p.returncode != 0:

        print("Error: %s" % p.returncode)
        print(
            return_str[0].decode("utf-8") if sys.version_info[0] >= 3 else return_str[0]
        )
        if exit_on_fail:
            exit(p.returncode)

    if sys.version_info > (3, 0):
        return return_str[0].decode("utf-8")
    else:
        return return_str[0]


def help_info():
    usage = """\
        Usage: python getNeuroML.py [OPTION]
        Script to install NeuroML libraries.
        Note: requires internet connectivity.

        python getNeuroML.py
            Pull (or clone) the latest version of all NeuroML 2 repos &
            compile/install with Maven if applicable

        python getNeuroML.py clean
            Run 'mvn clean' on all Java repos

        python getNeuroML.py master
            Switch all repos to master branch

        python getNeuroML.py development
            Switch relevant repos to development branch

        python getNeuroML.py experimental
            Switch relevant repos to experimental branch
        """
    print(dedent(usage))


if __name__ == "__main__":
    main()