build-tool 0.5.7 → 0.6.0.rc1

data/lib/build-tool/vcs/git.rb

@@ -1,7 +1,36 @@
+# -*- coding: UTF-8 -*-
+
+require 'mj/mixins/inherited_attributes'
 require 'build-tool/vcs/base'
 require 'build-tool/errors'
 require 'grit'
 
+# :TODO: Push these changes to grit.
+module Grit
+    class RepoConfig < Config
+        def delete(key)
+            @repo.git.config({:file => "#{@repo.path}/config", :unset => true }, key) if @repo
+        end
+        protected
+            def config_lines
+                @repo.git.config({:file => "#{@repo.path}/config", :list => true}).split( /\n/ ) if @repo
+            end
+    end
+
+    class UserConfig < Config
+        def []=(key, value)
+            @repo.git.config({:global => true}, key, value)
+        end
+        def delete(key)
+            @repo.git.config({:global => true, :unset => true }, key)
+        end
+        protected
+            def config_lines
+                @repo.git.config({:list => true, :global => true}).split( /\n/ ) if @repo
+            end
+    end
+end
+
 module BuildTool; module VCS
 
     class GitError < BuildTool::Error; end
@@ -82,19 +111,58 @@ def push_url
     end
 
 
-
+    # Configuration options for the git vcs.
+    #
+    # @attr_reader [String] name returns the name of the vcs.
     class GitConfiguration < BaseConfiguration
 
+        include MJ::Mixins::InheritedAttributes
+
         def name
             "git"
         end
 
+        class << self
+
+            # The global configuration object
+            attr_accessor :global_config
+
+            # Was the global configuration ($HOME/.gitconfig) already checked?
+            attr_accessor :global_config_checked
+        end
+
         attr_accessor :remote
+        def merged_remote
+            return parent.merged_remote.merge( @remote ) if @parent
+            return @remote
+        end
+
+
+        attr_accessor :options
+        def merged_options
+            return @options if self == GitConfiguration.global_config           # This is the global configuration.
+            return parent.merged_options.merge( @options ) if @parent           # We have a parent. Merge with it
+            return GitConfiguration.global_config.options.merge( @options ) if  GitConfiguration.global_config # No parent. Merge with global
+            return @options                                                     # No parent, no global. Just us
+        end
+
+        # @return [Hash<String,String>] the configured global options.
+        attr_accessor :global_options
+
+        def merged_global_options
+            return @global_options if self == GitConfiguration.global_config
+            return @global_options.merge( GitConfiguration.global_config.instance_variable_get( "@global_options" ) ) if  GitConfiguration.global_config
+            return @global_options
+        end
 
         def initialize
             super
             @remote = {}
-            @track = "origin/master"
+            @track = nil
+            @options = {}
+            @global_options = {}
+            @already_checked_config = false
+            @already_checked_user_config = false
         end
 
         def vcs( mod )
@@ -103,9 +171,18 @@ def vcs( mod )
             Git.new( self )
         end
 
-        # The branch to track
-        attr_accessor :track
+        # The remote branch to track.
+        # @return [String] the remote branch.
+        attr_writer :track
+        def track
+            return @track if @track             # Our track
+            return parent.track if @parent      # Out parents track
+            "origin/master"                     # The default
+        end
 
+        # The remote part of #remote.
+        # @see GitConfiguration#remote
+        # @return [String] the remote.
         def track_remote
             rc = track.split('/')
             # If there is only one string we assume it is the branch name from
@@ -114,6 +191,9 @@ def track_remote
             return rc[0]
         end
 
+        # The branch part of #remote
+        # @see #remote
+        # @return [String] the branch.
         def track_branch
             rc = track.split('/')
             # If there is only one string we assume it is the branch name from
@@ -127,6 +207,13 @@ def copy_configuration( other )
             @remote = {}     # Do not copy the remotes
         end
 
+        #######
+        private
+        #######
+
+        @global_config = nil
+        @global_config_checked = false
+
     end
 
     #
@@ -142,15 +229,6 @@ def initialize( config )
 
         class << self
 
-            git_available = nil
-
-            # Is the git executable available?
-            def git_available
-                return @git_available unless @git_available.nil?
-                %x( git --version 2>&1 )
-                @git_available = $?.success?
-                return @git_available
-            end
 
         end
 
@@ -197,14 +275,7 @@ def clone
                 raise GitError, "Error while initializing the repo `git init #{local_path}'`: #{$?}"
             end
 
-            config.remote.each do |name, val|
-                if git( "remote add #{name} #{val.url}" ) != 0
-                    raise GitError, "Error while initializing the repo `git remote add #{name} #{val.url}`: #{$?}"
-                end
-                if val.push_url and git( "remote set-url --push #{name} #{val.push_url}" ) != 0
-                    raise GitError, "Error while initializing the repo `git remote add #{name} #{val.url}`: #{$?}"
-                end
-            end
+            check_config
 
             logger.info <<-EOS
 The following command sometimes fails when issued from this script. Reason unknown. The
@@ -232,6 +303,9 @@ def gc
         def fetch()
             if !checkedout? and !$noop
                 clone
+            else
+                # clone() calls those methods.
+                check_config
             end
             cmd = "fetch -q --prune #{config.track_remote}"
             if ( rc = git( cmd ) ) != 0
@@ -245,48 +319,101 @@ def git( command, wd = local_path, &block )
 
         def prepare_for_fetch
             # If our server has an associated ssh-key, add it to the ssh-agent.
-            return check_for_sshkey( config.remote[ config.track_remote ].server.sshkey )
+            return check_for_sshkey( config.merged_remote[ config.track_remote ].server.sshkey )
         end
 
-        # Check if the module is ready for vcs action
-        def ready_for_access
-
+        def check_user_config
+            return if @already_checked_user_config
+            # :FIXME: It would make sense to do this even if the repo is not existing but grit cannot
+            # handle that
             if checkedout?
+                # Check that the options are the same as configured.
+                if ! GitConfiguration.global_config_checked
+                    gitconfig = Grit::UserConfig.new(repo)
+                    config.merged_global_options.each do |name, val|
+                        if val != gitconfig[name]
+                            if val.empty?
+                                next if gitconfig[name].nil?
+                                logger.info "repo: git-config: Removing #{name}"
+                                gitconfig.delete name if !$noop
+                            else
+                                logger.info "repo: git-config: Setting #{name} to #{val}"
+                                gitconfig[name] = val if !$noop
+                            end
+                        end
+                    end
+                    GitConfiguration.global_config_checked = true
+                end
+            end
+            @already_checked_user_config = true
+        end
 
+        def check_config
+            return if @already_checked_config
+            if checkedout?
                 # Check that the remotes are the same as configured.
-                gitconfig = repo.config
-                config.remote.each do |name, val|
-                    if val.url and val.url != gitconfig["remote.#{name}.url"]
-                        logger.info "#{config.module.name}: Setting remote.origin.url to #{val.url}"
-                        gitconfig["remote.#{name}.url"] = val.url
+                gitconfig = Grit::RepoConfig.new(repo)
+                config.merged_remote.each do |name, val|
+                    if val.url
+                        if gitconfig["remote.#{name}.url"].nil?
+                            if git( "remote add #{name} #{val.url}" ) != 0
+                                raise GitError, "Error while initializing the repo `git remote add #{name} #{val.url}`: #{$?}"
+                            end
+                        elsif val.url != gitconfig["remote.#{name}.url"]
+                            logger.info "repo: Setting remote.origin.url to #{val.url}"
+                            gitconfig["remote.#{name}.url"] = val.url
+                        end
+                    end
+
+                    if val.push_server and val.push_url
+                        if val.push_url != gitconfig["remote.#{name}.pushurl"].nil?
+                            if git( "remote set-url --push #{name} #{val.push_url}" ) != 0
+                                raise GitError, "Error while initializing the repo `git remote add #{name} #{val.url}`: #{$?}"
+                            end
+                        elsif val.push_url != gitconfig["remote.#{name}.pushurl"]
+                            logger.info "repo: Setting remote.origin.pushurl to #{val.push_url}"
+                            gitconfig["remote.#{name}.pushurl"] = val.push_url
+                        end
                     end
-                    if val.push_server and val.push_url != gitconfig["remote.#{name}.pushurl"]
-                        logger.info "#{config.module.name}: Setting remote.origin.pushurl to #{val.push_url}"
-                        gitconfig["remote.#{name}.pushurl"] = val.push_url
+                end
+
+                # Check that the options are the same as configured.
+                config.merged_options.each do |name, val|
+                    if val != gitconfig[name]
+                        if val.empty?
+                            next if gitconfig[name].nil?
+                            logger.info "repo: git-config: Removing #{name}"
+                            gitconfig.delete name if !$noop
+                        else
+                            logger.info "repo: git-config: Setting #{name} to #{val}"
+                            gitconfig[name] = val if !$noop
+                        end
                     end
                 end
 
                 # Check if there is a commit template. If yes add it.
-                if ( not gitconfig["commit.template"] ) && Pathname.new( local_path ).join( '.commit-template' ).exist?
+                if ( not gitconfig["commit.template"] and not config.merged_options["commit.template"] ) and Pathname.new( local_path ).join( '.commit-template' ).exist?
                     logger.info "#{config.module.name}: git-config: Setting commit.template to .commit-template"
-                    gitconfig["commit.template"] = ".commit-template"
-                end
+                    gitconfig["commit.template"] = ".commit-template" if !$noop
 
+                end
+                @already_checked_config = true
             end
         end
 
         def ready_for_fetch
-            if not Git.git_available
-                logger.info( "#{config.module.name}: Calling `git` failed!" )
+            if not MJ::VCS::Git.git_available?
+                logger.error( "#{config.module.name}: Calling `git` failed!" )
+                return false
             end
-            return Git.git_available
+
+            return true
         end
 
         # Check if the module is ready for a rebase.
         def ready_for_rebase
-
+            check_user_config
             if checkedout?
-
                 # Check if the index is dirty.
                 if git( "diff --exit-code" ) != 0
                     logger.info( "#{config.module.name}: A dirty index will prevent the rebase." )
@@ -307,9 +434,18 @@ def ready_for_rebase
             true
         end
 
-        def rebase
-            if 0 != ( git "rebase #{config.track_remote}/#{config.track_branch}" )
-                raise GitError, "Error while rebasing the repo with `#{config.track_remote}/#{config.track_branch}': #{$?}"
+        def rebase( verbose = false )
+            check_config
+            remote_branch = "#{config.track_remote}/#{config.track_branch}"
+
+            if verbose
+                git('log --first-parent HEAD..%s' % remote_branch ) do |line|
+                    logger.info( line )
+                end
+            end
+
+            if 0 != ( git "rebase #{remote_branch}" )
+                raise GitError, "Error while rebasing the repo with `#{remote_branch}': #{$?}"
             end
         end
 

data/lib/build-tool/vcs/mercurial.rb

@@ -1,3 +1,6 @@
+# -*- coding: UTF-8 -*-
+
+require 'mj/mixins/inherited_attributes'
 require 'build-tool/vcs/base'
 require 'build-tool/errors'
 
@@ -7,15 +10,16 @@ class MercurialError < BuildTool::Error; end
 
     class MercurialConfiguration < BaseConfiguration
 
+        include MJ::Mixins::InheritedAttributes
+
         def name
             "mercurial"
         end
 
-        attr_accessor :remote
-
-        def initialize( mod = nil )
-            super( mod )
-            @remote = {}
+        def initialize
+            super
+            @url = nil
+            @track = nil
         end
 
         def vcs( mod )
@@ -24,13 +28,17 @@ def vcs( mod )
             Mercurial.new( self )
         end
 
-        def branch
-            self.module.remote_path
+        attr_writer :track
+        def track
+            return @track if @track
+            return parent.track if @parent
+            return 'default'
         end
 
+        inherited_attr_accessor :url
+
         def copy_configuration( other )
             super
-            @remote = {}     # Do not copy the remote
         end
     end
 
@@ -41,7 +49,6 @@ class Mercurial < Base
 
         def initialize( config )
             super( config )
-            @remote = {}
             @vcs = nil
         end
 
@@ -77,7 +84,7 @@ def clone
             FileUtils.mkdir_p Pathname.new( local_path ).dirname if ! $noop
 
             # Initialize the repository
-            if hg( "clone #{repository.url} #{local_path}", Pathname.new( local_path ).dirname) != 0
+            if hg( "clone #{config.url} #{local_path}", Pathname.new( local_path ).dirname) != 0
                 raise MercurialError, "Error while initializing the repo `hg init #{local_path}'`: #{$?}"
             end
 
@@ -92,7 +99,7 @@ def fetch()
             if !checkedout? and !$noop
                 clone
             end
-            cmd = "pull #{repository.url}"
+            cmd = "pull #{config.url}"
             if ( rc = hg( cmd ) ) != 0
                 raise MercurialError, "Error while fetching: #{rc}"
             end
@@ -106,8 +113,13 @@ def hg( command, wd = local_path, &block )
             rc
         end
 
-        def rebase
-            if 0 != ( hg "update #{config.branch}" )
+        def rebase( verbose = false )
+
+            if verbose
+                logger.info( 'Verbose rebase not yet implemented for mercurial.' )
+            end
+
+            if 0 != ( hg "update #{config.track}" )
                 raise MercurialSvnError, "Error while rebasing the repo with `hg update: #{$?}"
             end
         end

data/lib/build-tool/vcs/svn.rb

@@ -1,9 +1,15 @@
+# -*- coding: UTF-8 -*-
+
 require 'build-tool/vcs/base'
 
+require 'mj/mixins/inherited_attributes'
+
 module BuildTool; module VCS
 
     class SvnConfiguration < BaseConfiguration
 
+        include MJ::Mixins::InheritedAttributes
+
         def initialize
             super
             @only = nil
@@ -18,14 +24,10 @@ def name
         def vcs( mod )
             raise StandardError if @module and ! mod.equal?( @module )
             @module = mod
-            Svn.new( self ) 
+            Svn.new( self )
         end
 
-        attr_reader :only
-        def only=( list )
-            @only = list
-            puts @only.inspect
-        end
+        inherited_attr_accessor :only
 
         def copy_configuration( other )
             super
@@ -34,18 +36,16 @@ def copy_configuration( other )
 
         attr_writer :repository
         def repository
-            if @repository.nil?
-                 raise ConfigurationError, "No repository configured for module #{@module.name}."
-            end
-            @repository
+            return @repository if @repository             # Our repository
+            return parent.repository if @parent       # Our parents repository
+            raise ConfigurationError, "No repository configured for module #{self.module ? self.module.name : 'unknown' }."
         end
 
         attr_writer :remote_path
         def remote_path
-            if @remote_path.nil?
-                return @module.name
-            end
-            @remote_path
+            return @remote_path if @remote_path
+            return parent.remote_path if @parent
+            return @module.name
         end
 
     end
@@ -180,7 +180,12 @@ def self.svn( command, wd, &block )
             rc
         end
 
-        def rebase
+        def rebase( verbose = false )
+
+            if verbose
+                logger.info( 'Verbose rebase not yet implemented for subversion.' )
+            end
+
             # Rebasing is not supported
             0
         end