build-tool 0.0.3 → 0.1.0

data/lib/build-tool/errors.rb

@@ -0,0 +1,9 @@
+module BuildTool
+
+    # Base class for all BuildTool Errors
+    class Error < StandardError; end
+
+    # A configuration error happened.
+    class ConfigurationError < Error; end
+
+end

data/lib/build-tool/module.rb

@@ -0,0 +1,366 @@
+# require 'gbs_signal_slot'
+require 'mj/tools/ssh'
+require 'ftools'
+
+
+module BuildTool
+
+    #
+    # Represents the information associated with a buildable module.
+    #
+    class Module
+
+        # Create a module
+        def initialize( name, parent = nil )
+            if name.nil?
+                raise StandardError, "Module name is required!"
+            end
+            @name = name
+            @parent = parent
+            @local_path = nil
+            @build_prefix = nil
+            @remote_path = nil
+            @environment = nil
+            @build_system = nil
+            @repository = nil
+            @install_prefix = nil
+            @is_template = false
+            @vcs_configuration = nil
+        end
+
+        #
+        ### ATTRIBUTES
+        #
+
+        # not inherited
+        def build_directory
+            "#{build_prefix_required}/bld/#{local_path}"
+        end
+
+        def build_prefix=( path )
+            if path
+                @build_prefix = Pathname.new( File.expand_path( path ) )
+            else
+                @build_prefix = nil
+            end
+        end
+
+        def build_prefix
+            # Return our own buildsystem if there is one
+            return @build_prefix if @build_prefix
+            # Return our parents buildsystem if there is one
+            return @parent.build_prefix if @parent && @parent.build_prefix
+            # Nothing
+            nil
+        end
+
+        # Will throw a exception if build_prefix is not set
+        def build_prefix_required
+            return self.build_prefix if self.build_prefix
+            raise ConfigurationError, "No build prefix configured for #{name}!"
+        end
+
+        # Build system
+        attr_writer :build_system
+
+        def build_system
+            # Return our own buildsystem if there is one
+            return @build_system if @build_system
+            # Return our parents buildsystem if there is one
+            if @parent && @parent.build_system
+                @build_system = @parent.build_system.dup
+                @build_system.module = self
+                return @build_system
+            end
+            # Nothing
+            nil
+        end
+
+        # Will throw a exception if build_system is not set
+        def build_system_required
+            return self.build_system if self.build_system
+            # *TODO* try to guess the build system
+            raise ConfigurationError, "No build system configured for #{name}!"
+        end
+
+        def checkedout?
+            vcs_required.checkedout?
+        end
+
+        def configured?
+            build_system_required.configured?
+        end
+
+        def description
+            @description || "no description"
+        end
+
+        # Environment
+        attr_writer :environment
+
+        def environment
+            # Return our own buildsystem if there is one
+            return @environment if @environment
+            # Return our parents buildsystem if there is one
+            return @parent.environment if @parent && @parent.environment
+            # Nothing
+            nil
+        end
+
+        # Will throw a exception if environment is not set
+        def environment_required
+            return self.environment if self.environment
+            raise ConfigurationError, "No environment configured for #{name}!"
+        end
+
+        # Installation prefix
+        def install_prefix=( path )
+            if path
+                @install_prefix = Pathname.new( File.expand_path( path.to_s ) )
+            else
+                @install_prefix = nil
+            end
+        end
+
+        def install_prefix
+            # Return our own buildsystem if there is one
+            return @install_prefix if @install_prefix
+            # Return our parents buildsystem if there is one
+            return @parent.install_prefix if @parent && @parent.install_prefix
+            # Nothing
+            nil
+        end
+
+        # Will throw a exception if install_prefix is not set
+        def install_prefix_required
+            return self.install_prefix if self.install_prefix
+            raise ConfigurationError, "No install prefix configured for #{name}!"
+        end
+
+        attr_writer :is_template
+        def is_template?
+            @is_template
+        end
+
+        def local_path=( local_path )
+            raise ConfigurationError, "Attempt to set local_path for module template #{name}" if is_template?
+            @local_path = local_path
+        end
+
+        def local_path
+            @local_path || @name
+        end
+
+        # The module name
+        attr_reader :name
+
+        # Remote path
+        def remote_path=( remote_path )
+            raise ConfigurationError, "Attempt to set remote_path for module template #{name}" if is_template?
+            @remote_path = remote_path
+        end
+
+        def remote_path
+            @remote_path || @name
+        end
+
+        # Repository
+        def repository=( repository )
+            @repository = repository
+        end
+
+        def repository
+            return @repository if @repository
+            return @parent.repository if @parent && @parent.repository
+        end
+
+        def repository_required
+            repo = self.repository
+            return repo if repo
+            raise ConfigurationError, "No repository configured for #{name}!"
+        end
+
+        def source_directory
+            "#{build_prefix_required}/src/#{local_path}"
+        end
+        alias source_directory_required source_directory
+
+        def vcs
+            return vcs_configuration.vcs( self ) if vcs_configuration
+            nil
+        end
+
+        attr_writer :vcs_configuration
+        def vcs_configuration
+            return @vcs_configuration if @vcs_configuration
+            return @parent.vcs_configuration if @parent
+            nil
+        end
+
+        def vcs_configuration_required
+            if @vcs_configuration
+                vc = @vcs_configuration
+            elsif @parent
+                vc = @parent.vcs_configuration
+            else
+                vc = nil
+            end
+            if vc.nil?
+                raise ConfigurationError, "No version control system configure for module #{name}."
+            end
+            return vc
+        end
+
+        def vcs_required
+            if repository.nil?
+                raise ConfigurationError, "No repository specified for module #{name}."
+            end
+            if remote_path.nil?
+                raise ConfigurationError, "No remote path specified for module #{name}."
+            end
+            if source_directory.nil?
+                raise ConfigurationError, "No source directory specified for module #{name}."
+            end
+            return vcs_configuration_required.vcs( self )
+        end
+
+        #
+        ### ACTIONS
+        #
+        def clean( logdir, remove_build_directory = false )
+            while_logging_to logdir, '10_clean' do
+                if remove_build_directory
+                    logger.info "Removing build directory."
+                    build_system_required.remove_build_directory
+                else
+                    logger.info "Cleaning build directory."
+                    build_system_required.make( "clean" )
+                end
+            end
+        end
+
+
+        # Clone the repository.
+        def clone( logdir )
+            while_logging_to logdir, '20_fetch' do
+                logger.info "Creating local checkout."
+                vcs_required.clone
+            end
+        end
+
+        # Fetch changes from the remote repository. Do not change the local
+        # checkout.
+        def fetch( logdir )
+            if !vcs_required.fetching_supported?
+                logger.info "Fetching/Rebase not supported by vcs #{vcs.name}. Doing it in one step."
+            end
+            while_logging_to logdir, '20_fetch' do
+                logger.info "Fetching remote changes."
+                vcs.fetch
+            end
+        end
+
+        # Update the local changes with remote changes. Do not fetch changes
+        # from the remote repository.
+        def rebase( logdir )
+            if !vcs_required.fetching_supported?
+                logger.info "Fetching not supported by vcs #{vcs.name}."
+                return
+            end
+            while_logging_to logdir, '30_rebase' do
+                logger.info "Rebasing against remote changes."
+                vcs.rebase
+            end
+        end
+
+        def configure( logdir )
+            while_logging_to logdir, '40_configure' do
+                logger.info "Configuring."
+                if !$noop and !vcs_required.checkedout?
+                    raise ConfigurationError, "Failed to configure: Module is not checked out."
+                end
+                build_system_required.configure
+            end
+        end
+
+        def reconfigure( logdir )
+            while_logging_to logdir, '40_configure' do
+                logger.info "Recreating configuration."
+                if !$noop and !vcs_required.checkedout?
+                    raise ConfigurationError, "Module is not checked out. Enable updating."
+                end
+                build_system_required.reconfigure
+            end
+        end
+
+        # Call make
+        def make( logdir, target = nil )
+            while_logging_to logdir, '50_build' do
+                logger.info "Building module."
+                build_system_required.make( target )
+            end
+        end
+
+        def install( logdir, fast = false )
+            while_logging_to logdir, '60_install' do
+                logger.info "Installing module."
+                build_system_required.install( fast )
+            end
+        end
+
+        # Check if an ssh-key is required and active it if necessary
+        def prepare_for_vcs_access
+            if key = repository_required.sshkey
+                if !MJ::Tools::SSH::has_key? key.file
+                    MJ::Tools::SSH::add_key key.file
+               end
+            end
+            return true
+        end
+
+        def prepare_for_installation
+            prefix = install_prefix_required
+            if !prefix.exist? or !prefix.writable?
+                begin
+                    FileUtils.mkdir_p prefix.to_s
+                rescue Errno::EACCES => e
+                    logger.error "#{name}: The directory #{prefix.to_s} is not writable! Installation will fail!"
+                    return false
+                end
+            end
+            return true
+        end
+
+    #########
+    protected
+    #########
+
+        def while_logging_to( logdir, fname, level = :trace, &block )
+            dirname = "#{logdir}/#{name}"
+            FileUtils.mkdir_p( dirname )
+            Logging.logger['root'].add_appenders(
+                Logging.appenders.file(
+                    fname,
+                    :filename => dirname + '/' + fname,
+                    :layout => Logging::Layouts::Pattern.new( :pattern => '%m\n' ),
+                    :level => level ))
+
+            begin
+                yield
+            rescue Interrupt => e
+                logger.error "User Interrupt!"
+                raise e
+            rescue Exception => e
+                logger.error   "#{e.class}:#{e.message}"
+                got_exception = true
+                raise e
+            ensure
+                Logging.logger['root'].remove_appenders( fname )
+                logger.info("More information in #{dirname}/#{fname}") if got_exception
+            end
+        end
+
+    end # Module
+
+
+end # module BuildTool

data/lib/build-tool/pluginbase.rb

@@ -0,0 +1,43 @@
+module BuildTool
+
+
+    #
+    # Mixin which implements basic plugin functionality.
+    #
+    module PluginBase
+
+        # Class methods
+        module ClassMethods
+
+            def register_plugin( child )
+                logger.debug "Registering plugin #{child}"
+                child.registered_plugins << child
+            end
+
+            # Called if the class is inherited
+            def inherited( child )
+                child.register_plugin( child )
+            end
+
+            def registered_plugins
+                @@registered_plugins
+            end
+
+            def registered_plugins=( val )
+                @@registered_plugins = val
+            end
+
+        end
+
+
+        # Mixin the class methods
+        def self.included( base )
+            base.extend( ClassMethods )
+            base.registered_plugins = Array.new
+            # puts "#{base} #{base.registered_plugins.inspect}"
+        end
+
+    end # class PluginBase
+
+
+end

data/lib/build-tool/recipe.rb

@@ -0,0 +1,180 @@
+require 'yaml'
+
+module BuildTool
+
+    #
+    #
+    #
+    class Recipe
+
+        attr_accessor :name
+        attr_accessor :global_path
+        attr_reader   :settings
+
+        def initialize( name )
+            raise StandardError if name.nil?
+            @name = name
+            @metainfo_loaded = false
+            @short_description = "no description"
+            @long_description = "no description"
+            @global_path = Recipe.find_recipe( @name )
+        end
+
+        def browse_repository
+            return @browse_repository if @metainfo_loaded
+            load_metainfo
+            @browse_repository
+        end
+
+        # We look in
+        #   local_config_file_path()/
+        #   global_config_file_path()/
+        # for the file name @name. Name is allowed to be a path
+        def find_first_config_file( name )
+            if (pn = local_config_file_path( name )).exist?
+                return pn
+            end
+            if (pn = global_config_file_path( name )).exist?
+                return pn
+            end
+            return nil
+        end
+
+        def long_description
+            return @long_description if @metainfo_loaded
+            load_metainfo
+            @long_description
+        end
+
+        def load_metainfo
+            begin
+                file = YAML.load_file( metainfo_file_path )
+                @long_description = file['LONG']
+                @short_description = file['SHORT']
+                @website = file['WEBSITE']
+                @repository = file['REPOSITORY']
+                @browse_repository = file['BROWSE_REPOSITORY']
+            rescue Errno::ENOENT => e
+                logger.verbose "No description file found for recipe #{name}."
+                @short_description = "No description file provided!"
+            rescue ArgumentError => e
+                logger.verbose "Invalid description file found for  for recipe #{name}."
+                @short_description = "Description File invalid!"
+            end
+            @metainfo_loaded = true
+        end
+
+        def load( local_config_name, settings )
+            @local_config_name = local_config_name
+            raise StandardError, "Usage: recipe.load( settings )" if settings.nil?
+            @settings = settings
+            configuration = Configuration.new( self )
+
+            # Load the recipe
+            logger.debug "Loading #{global_config_file_path( "recipe" )}"
+            configuration = load_from_file( global_config_file_path( "recipe" ), configuration )
+
+            # Load the local modifications to the recipe if any
+            local_config_file = local_config_file_path( "recipe" )
+            if local_config_file.exist?
+                logger.debug "Loading #{local_config_file}"
+                load_from_file( local_config_file, configuration )
+            end
+            configuration
+        end
+
+        def load_from_file( file, configuration )
+            # Get the file content
+            recipe = File.read( file )
+            # Create the parser
+            parser = Cfg::Parser.new( configuration )
+            # Create the ERB
+            erb = ERB.new( recipe, nil, "%<>" )
+            # Fill the env for ERB
+            b = binding
+            settings = @settings
+            # Call the parser with the ERBed file content and return the
+            # result
+            conf = parser.parse_string( erb.result(b), file )
+        end
+
+        def local_config_file_path(name)
+            Pathname.new( BuildTool::Application::instance.local_configuration_dir ).
+                join( @local_config_name, name)
+        end
+
+        def global_config_file_path( name )
+            return @global_path.join(name)
+        end
+
+        def repository
+            return @repository if @metainfo_loaded
+            load_metainfo
+            @repository
+        end
+
+        def short_description
+            return @short_description if @metainfo_loaded
+            load_metainfo
+            @short_description
+        end
+
+        def metainfo_file_path
+            return @global_path.join('info.yaml')
+        end
+
+        def files_path
+            return @global_path.join('files')
+        end
+
+        def website
+            return @website if @metainfo_loaded
+            load_metainfo
+            @website
+        end
+
+        #################
+        # CLASS METHODS #
+        #################
+        def self.config_directories
+            return [
+                Pathname.new( BuildTool::Application::instance.local_configuration_dir ).join( "recipes" ),
+                Pathname.new( BuildTool::Application::instance.application_root ).join( "recipes" )
+            ]
+        end
+
+        def self.all_recipes
+            recipes = {}
+            self.config_directories.each do |dir|
+                # Skip directories that don't exist
+                next if !dir.exist?
+                Dir.foreach( dir ) { |name|
+                    next if name == '..'
+                    next if name == '.'
+                    pn = Pathname.new(dir).join(name)
+                    next if !pn.directory?
+                    next if recipes.has_key?(name)
+                    recipes[name] = Recipe.new(name)
+                }
+            end
+            recipes
+        end
+
+        # Find recipe name. We look in
+        # 1. <local_configuration_dir>/recipes/<name>
+        # 2. <application_root>/recipes/<name>
+        #
+        # The first one found is returned
+        def self.find_recipe( name )
+            self.config_directories.each do |dir|
+                recipe = dir.join( name )
+                return recipe if recipe.join('recipe').exist?
+            end
+            raise ConfigurationError, "Recipe #{name} not found!";
+        end
+
+
+    end # class Recipe
+
+
+end # module BuildTool