Source code for bouwer.core

#
# Copyright (C) 2012 Niek Linnenbank
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

"""
Bouwer core functionality
"""

import os
import os.path
import sys
import logging
import bouwer.cli
import bouwer.plugin
import bouwer.config
import bouwer.builder
import bouwer.action

def execute():
    """
    Execute Bouwfiles with the current configuration
    """

    # Traverse current directory to the top-level Bouwfile
    while os.path.exists('..' + os.sep + 'Bouwfile'):
        os.chdir(os.getcwd() + os.sep + '..' + os.sep)

    # Create command line interface object
    cli = bouwer.cli.CommandLine().Instance()

    # Initialize logging
    logging.basicConfig(
        format   = '[%(asctime)s] [%(name)s] %(levelname)s -- %(message)s',
        level    = getattr(logging, cli.args.log_level),
        filename = cli.args.log )

    # (Re)load configuration
    conf = bouwer.config.Configuration.Instance(cli)

    # Initialize the builder manager
    build = bouwer.builder.BuilderManager.Instance()

    # Load all plugins
    plugins = bouwer.plugin.PluginManager.Instance()

    # Generate final list of command line arguments

    # TODO: we probably want to output the list of possible targets in the help too!
    # documented using PyDoc :-) Fancy!
    
    # e.g. overwrite the print_help() method of argparse:
    # http://stackoverflow.com/questions/4042452/display-help-message-with-python-argparse-when-script-is-called-without-any-argu

    # OR: we let buildermanager initialize first somehow and then e.g. build.target_list()
    # BUT: buildermanager also needs the final conf.args...
    
    conf.args = cli.parse()
    # TODO: the default output plugin is PrettyOutput... wrong location to do it here.
    try:
        getattr(conf.args, 'output_plugin')
    except AttributeError:
        cli.args.output_plugin = plugins.plugins['PrettyOutput']

    # If we have a configuration plugin enabled by cli, invoke it
    conf_plugin = None
    try:
        conf_plugin = conf.args.config_plugin
    except AttributeError:
        pass

    if conf_plugin is not None:
        sys.exit(conf_plugin.configure(conf))

    # Execute each target in turn.
    for target in conf.args.targets:

        # TODO: generate an error if no targets are executed.

        # TODO: execute tree's in parallel?
        # Traverse Bouwfiles for each custom tree
        if len(conf.trees) > 1:
            for tree_name, tree in conf.trees.items():
                if tree_name != 'DEFAULT':
                    build.execute(target, tree)

        # Use the default tree
        else:
            build.execute(target, conf.trees.get('DEFAULT'))

    # Flush all caches
    bouwer.util.Cache.FlushAll()