config.py

#!/usr/bin/python
# -*- coding: utf-8 -*-

# Copyright (c) 2017, Christopher Pollok <cpollok@uni-bremen.de>
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright
#       notice, this list of conditions and the following disclaimer in the
#       documentation and/or other materials provided with the distribution.
#     * Neither the name of the Institute for Artificial Intelligence/
#       Universitaet Bremen nor the names of its contributors may be used to
#       endorse or promote products derived from this software without
#       specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

import os
import sys
import yaml
import datetime
import operator
import itertools
import argparse
import xml.etree.ElementTree as et

MAX_STACK_LIST = 5
MAX_PKG_LIST = 20

FORMAT_1_DEPEND_TAGS = set([
    # "buildtool_depend",
    "build_depend",
    "run_depend",
    "test_depend"
])

FORMAT_2_DEPEND_TAGS = set([
    "depend",
    # "buildtool_depend",
    "build_depend",
    "exec_depend",
    "test_depend",
    "doc_depend"
])


# Packages in the source directory being configured, mapped to their path (relative from the cwd when executing)
pkg_paths = {}

# Packages to be whitelisted by config()
wl_packages = []

# White- and blacklist. {path:package} if path is directory containing packages, package is None
wl_pkg_paths = {}
bl_pkg_paths = {}


inside_cram_src_msg = """The script has to be run inside the top-level directory of the CRAM repository.
You can only pass packages which are inside the CRAM repository, otherwise the script can't know for which dependencies to configure."""

##################
# Help functions #
##################

def blacklist(dirpath, pkg=None):
    """Add DIRPATH to the blacklist if it's not already CATKIN_IGNOREd."""
    dir_content = os.listdir(dirpath)
    if 'CATKIN_IGNORE' not in dir_content:
        # open(os.path.join(dirpath, 'CATKIN_IGNORE'), 'w')
        bl_pkg_paths[dirpath] = pkg
    # print "Blacklisted: " + dirpath

def whitelist(dirpath, pkg=None):
    """Add DIRPATH to the whitelist if it's CATKIN_IGNOREd."""
    dir_content = os.listdir(dirpath)
    if 'CATKIN_IGNORE' in dir_content:
        # os.remove(os.path.join(dirpath, 'CATKIN_IGNORE')) 
        wl_pkg_paths[dirpath] = pkg
    # print "Whitelisted: " + dirpath


def get_package_name(path):
    """Return the package name stated in the package.xml under PATH."""
    xml_path = os.path.join(path, 'package.xml')
    e = et.parse(xml_path).getroot()
    return e.find('name').text

def get_dependencies(xml):
    """Return the list of dependencies in the XML as strings."""
    # Choose the right set of dependency tags
    depend_tags = set()
    if "format" in xml.attrib and xml.attrib["format"] == "2":
        depend_tags.update(FORMAT_2_DEPEND_TAGS)
    else:
        depend_tags.update(FORMAT_1_DEPEND_TAGS)

    # Find all elements containing dependencies
    dependency_elements = reduce(lambda x, y: x + xml.findall(y), depend_tags, [])

    # Map the elements to their content text, which is the name of the dependency
    dependencies = map(lambda x: x.text, dependency_elements)
    return dependencies

def print_pkg_list(pkg_dict):
    """Print a list of packages in PKG_DICT."""

    # Sort packages and directories in two groups.
    keyfun = lambda x: x[1] == None
    sort = sorted(pkg_dict.items(), key=keyfun)
    groups = []
    keys = []
    for k, g in itertools.groupby(sort, keyfun):
        groups.append(list(g))
        keys.append(k)
    
    pkgs=[]
    dirnames=[]
    if False in keys:
        pkgs = [x[1] for x in groups[keys.index(False)]]
    if True in keys:
        dirnames = [x[0] for x in groups[keys.index(True)]]
    
    # Print the packages.
    step = 5
    if len(pkgs) != 0:
        for i in range(0, min(MAX_PKG_LIST, len(pkgs)), step):
            print("  " + ("{}," * min(step, len(pkgs)-i)).format(*pkgs[i:i+step]))
        if len(pkgs) > MAX_PKG_LIST:
            print("\n   and {} more...".format(len(pkgs) - MAX_PKG_LIST))

    # Print the directories.
    if len(dirnames) != 0:
        print("\n  And also in the sub packages of these directories/stacks:")
        for dirname in dirnames[:MAX_STACK_LIST]:
            print("  " + dirname)
        if len(dirnames) > MAX_STACK_LIST:
            print("\n   and {} more...".format(len(dirnames) - MAX_STACK_LIST))


##################
# Main functions #
##################

def crawl():
    """Traverse the repository and collect all packages in pkg_paths."""
    global pkg_paths
    for dirpath, dirnames, filenames in os.walk('.'):
        if '.git' in dirnames:
            # don't look into .git directories
            del dirnames[dirnames.index('.git')]

        if 'CMakeLists.txt' in filenames and 'package.xml' in filenames:
            # found a package
            pkg_paths[get_package_name(dirpath)] = dirpath
            dirnames[:] = []

def check_package_names():
    """Check if any package name is different from the name of the directory containing it."""
    for pkg_name, dirpath in pkg_paths.items():
        dirname = os.path.basename(dirpath)
        if pkg_name != dirname:
            print "WARNING: Package name and name of containing directory differ: Package '{}' in directory '{}'!".format(pkg_name, dirname)

def check_for_high_level_packages(pkgs):
    """Check if the given packages are existent in the repository."""
    high_lvl_pkgs_in_dir = [x in pkg_paths.keys() for x in pkgs]
    if not all(high_lvl_pkgs_in_dir):
        print("WARNING: Not all packages you passed are existent in the current directory.")
        for pkg_not_found in [x for x in pkgs if not high_lvl_pkgs_in_dir[pkgs.index(x)]]:
            print("WARNING: {} does not designate a package inside {}.".format(pkg_not_found, os.getcwd()))
        return False
    return True

def build_profile(pkgs):
    """Look up the dependecies of the packages in pkgs until reaching the lowest level and thus finding no more dependencies."""
    global wl_packages
    wl_packages = set()
    wl_packages.update(pkgs)
    deps = set()
    while len(pkgs) != 0:
        deps.clear()
        for pkg in pkgs:
            xml_path = os.path.join(pkg_paths[pkg], 'package.xml')
            pkg_xml = et.parse(xml_path).getroot()
            deps.update(get_dependencies(pkg_xml))
            wl_packages.update(deps)
        pkgs = set(deps).intersection(pkg_paths.keys())

def config():
    """Traverse the repository and black-/whitelist the packages/directories."""
    for dirpath, dirnames, filenames in os.walk('.'):
        
        pkgs_in_dir = [x for x in pkg_paths.keys() if pkg_paths[x].startswith(dirpath)]
        if 'CMakeLists.txt' in filenames and 'package.xml' in filenames:
            # found a package, don't recurse deeper
            dirnames[:] = []
            basepath, dirname = os.path.split(dirpath)
            if any(map(lambda x: x == dirname, wl_packages)):
                whitelist(dirpath, pkg=dirname)
            else:
                blacklist(dirpath, pkg=dirname)

        elif len(pkgs_in_dir) != 0:
            if not any([x in wl_packages for x in pkgs_in_dir]):
                blacklist(dirpath)
                ## Uncomment this, if you want to remove CATKIN_IGNOREs in the packages when blacklisting the whole dir. Comment the next line then though.
                # wl_packages.update(pkgs_in_dir)
                dirnames[:] = []
            else:
                whitelist(dirpath)

        if '.git' in dirnames:
            # don't look into .git directories
            del dirnames[dirnames.index('.git')]

def ask_permission():
    """Ask for permission to create and delete CATKIN_IGNORE files."""
    if len(bl_pkg_paths) != 0:
        print("\nThe script will CREATE CATKIN_IGNOREs in these packages:")
        print_pkg_list(bl_pkg_paths)

    if len(wl_pkg_paths) != 0:
        print("\nThe script will DELETE CATKIN_IGNOREs in these packages:")
        print_pkg_list(wl_pkg_paths)

    answer = ""
    possibilities = ['Y', 'y', 'N', 'n']
    while answer not in possibilities:
        if answer != "":
            print("Please type one of '{}', '{}', '{}' or '{}'".format(*possibilities))
        answer = raw_input("Do you want to proceed? (Y/n)") or "Y"
    if answer in ['N', 'n']:
        return False
    return True

def execute():
    """Create CATKIN_IGNOREs in the blacklisted paths and delete those in the whitelisted paths."""
    for dirpath in bl_pkg_paths.keys():
        open(os.path.join(dirpath, 'CATKIN_IGNORE'), 'w')

    for dirpath in wl_pkg_paths.keys():
        os.remove(os.path.join(dirpath, 'CATKIN_IGNORE')) 

def profile_str():
    """Return the profile of white- and blacklisted packages as a string."""
    profile = """Latest configuration ({}):""".format(datetime.datetime.now())
    for pkg, dirpath in sorted(pkg_paths.items(), key=operator.itemgetter(1)):
        profile += "\n  * "
        if pkg in wl_packages:
            profile += "Whitelisted: "
        else:
            profile += "Blacklisted: "
        profile += dirpath
    profile += "\n"
    return profile

def parse_args():
    """Parse the arguments passed to the script."""
    parser = argparse.ArgumentParser(description="Configure a CRAM repository for a set of given packages.",
        epilog=inside_cram_src_msg)

    parser.add_argument("packages", nargs='+', help="The packages to configure for.")
    parser.add_argument("-n3p", "--no_3rdparty", action='store_true', help="This option can be supplied if for some reason not all cram_3rdparty packages should be included in the configuration.")
    return parser.parse_args()

if __name__ == '__main__':
    args = parse_args()

    crawl()
    check_package_names()

    if not check_for_high_level_packages(args.packages):
        print(inside_cram_src_msg)
        sys.exit()

    packages = args.packages
    if not args.no_3rdparty and "cram_3rdparty" not in packages:
        packages.append("cram_3rdparty")
        print("To prevent complications the packages in 'cram_3rdparty' have been included by default.")
    build_profile(packages)
    config()
    if not ask_permission():
        sys.exit()
    execute()

    profile = profile_str()

    with open("latest_config", "w") as f:
        f.write(profile)