build-tool 0.0.3 → 0.1.0

data/lib/build-tool/repository.rb

@@ -0,0 +1,59 @@
+require 'build-tool/errors'
+
+module BuildTool
+
+    # Encapsulates a source code repository.
+    class Repository
+
+        # Repository name
+        attr_reader   :name
+
+        # The server this repository is hosted
+        attr_accessor :server
+
+        # The relative path on the server
+        attr_accessor :path
+
+        # The relative path on the server
+        attr_accessor :user
+
+        # The associated ssh-key
+        attr_accessor :sshkey
+
+        # Create a repository
+        def initialize(name)
+            if name.nil?
+                raise StandardError, "The repository name has to be set"
+            end
+            @name = name
+            @server = nil
+            @sshkey = nil
+        end
+
+        def url
+            if !server
+                raise ConfigurationError, "No server specified for repository #{name}"
+            end
+            if !server.host
+                raise ConfigurationError, "No host specified for rserver #{server.name}"
+            end
+
+            url = server.host
+            if server.path
+                url = "#{url}/#{server.path}"
+            end
+            if user
+                url = "#{user}@#{url}"
+            end
+            if server.protocol
+                url = "#{server.protocol}://#{url}"
+            end
+            if path
+                url = "#{url}/#{path}"
+            end
+            url
+        end
+
+    end # class Repository
+
+end # module BuildTool

data/lib/build-tool/server.rb

@@ -0,0 +1,43 @@
+module BuildTool
+
+    class Server
+
+        # The host this repository is hosted
+        attr_accessor :host
+
+        # Repository name
+        attr_reader   :name
+
+        # The relative path on the server
+        attr_accessor :path
+
+        # The protocol used to access the repository
+        attr_accessor :protocol
+
+        # Create a repository
+        def initialize(name)
+            if name.nil?
+                raise StandardError, "The server name has to be set"
+            end
+            @name = name
+        end
+
+        def url
+            if !host
+                raise ConfigurationError, "No host specified for server #{name}"
+            end
+
+            url = host
+            if protocol
+                url = "#{protocol}://#{url}"
+            end
+            if path
+                url = "#{url}/#{path}"
+            end
+            url
+        end
+
+    end # class Server
+
+
+end # module BuildTool

data/lib/build-tool/singleton.rb

@@ -0,0 +1,50 @@
+module BuildTool
+
+    class Singleton
+
+        def self.inherited( child )
+            if child.superclass == Singleton
+                child.class_eval <<-EOS
+                    def self.instance;       instance_variable_get( "@instance" ); end
+                    def self.instance=( x ); instance_variable_set( "@instance", x ); end
+                EOS
+            else
+                child.class_eval <<-EOS
+                    def self.instance;       superclass.instance; end
+                    def self.instance=( x ); superclass.instance = x; end
+                EOS
+            end
+            child.instance_variable_set( "@instance", nil )
+        end
+
+        def initialize
+            if !self.class.instance.nil?
+                raise StandardError, "More than one instance of #{self.class} created!"
+            end
+            self.class.instance = self
+        end
+
+
+        def self.instance
+            raise StandardError, "No instance of #{self} created"
+        end
+
+        def destroy
+            cls = self.class
+            while cls.superclass != Singleton
+                cls = cls.superclass
+            end
+            cls.instance = nil
+        end
+
+        def instance
+            cls = self.class
+            while cls.superclass != Singleton
+                cls = cls.superclass
+            end
+            cls.instance
+        end
+
+    end
+
+end # module BuildTool

data/lib/build-tool/sshkey.rb

@@ -0,0 +1,22 @@
+module BuildTool
+    #
+    # Encapsulates a ssh key
+    #
+    class SshKey
+
+        def initialize(name, file = nil)
+            @name = name
+            @file = file
+        end
+
+        attr_reader :name
+
+        attr_accessor :file
+
+        def to_s
+            @file
+        end
+
+    end # class SshKey
+
+end # module BuildTool

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

@@ -0,0 +1,105 @@
+require 'mj/tools/subprocess.rb'
+
+require 'build-tool/errors'
+
+module BuildTool; module VCS
+
+    class BaseConfiguration
+
+        attr_reader :module
+
+        def initialize( mod = nil )
+            @module = mod
+        end
+
+        def remote_path
+            @module.remote_path
+        end
+
+        def repository
+            @module.repository
+        end
+
+        def local_path
+            @module.source_directory
+        end
+
+        def module
+            @module
+        end
+
+    end
+
+    #
+    # Base class for Version Control System implementations
+    #
+    class Base
+
+        class VcsError < BuildTool::Error; end
+
+        include MJ::Tools::SubProcess
+
+        # # Create a repository
+        def initialize( config )
+            @config = config
+        end
+
+        #
+        ### ATTRIBUTES
+        #
+        attr_reader :config
+
+        def local_path
+            local_path = @config.local_path
+            raise ConfigurationError, "#{self.class}.local_path not set" if local_path.nil?
+            local_path
+        end
+
+        def remote_path
+            remote_path = @config.remote_path
+            raise ConfigurationError, "#{self.class}.remote_path not set" if remote_path.nil?
+            remote_path
+        end
+
+        def repository
+            repository = @config.repository
+            raise ConfigurationError, "#{self.class}.repository not set" if repository.nil?
+            repository
+        end
+
+        #
+        ### METHODS
+        #
+
+        # checks if path exists and is a directory
+        def local_path_exist?
+            !local_path.nil? and File.exist? local_path and File.directory? local_path
+        end
+
+        def configure
+            logger.debug "VCS #{name} did not implement configure!"
+        end
+
+        #
+        ### VIRTUAL FUNCTIONS
+        #
+        for method in [
+            :checkedout?,
+            :clone,
+            :fetch,
+            :name ,
+            :rebase,
+            :fetching_supported?,
+            :[]=,
+            :[]
+        ] do
+            class_eval <<-EOS
+                def #{method}
+                    raise NotImplementedError, "Method #{method} is not implemented for class #{self}"
+                end
+            EOS
+        end
+
+    end # class Base
+
+end; end # module BuildTool::VCS

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

@@ -0,0 +1,154 @@
+require 'build-tool/vcs/svn'
+require 'build-tool/vcs/git'
+
+module BuildTool; module VCS
+
+
+    class GitSvnConfiguration < GitConfiguration
+
+        def name
+            "git-svn"
+        end
+
+        attr_reader :externals
+
+        def initialize( mod = nil )
+            super( mod )
+            @externals = {}
+        end
+
+        def vcs( mod )
+            @module = mod
+            GitSvn.new( self )
+        end
+
+        def add_external( local, target )
+            @externals[local] = target
+        end
+
+    end
+
+    #
+    # Implementation for the git-svn version control system.
+    #
+    class GitSvn < Base
+
+        class GitSvnError < BuildTool::Error; end
+
+        def initialize( *args )
+            super( *args )
+        end
+
+        #
+        ### ATTRIBUTES
+        #
+        def name
+            "git-svn"
+        end
+
+        def fetching_supported?
+            true
+        end
+
+        #
+        ### METHOD
+        #
+
+        def checkedout?
+            return false if !local_path_exist?
+            if !Pathname.new( local_path ).join( ".git" ).exist?
+                raise Base::VcsError, "Checkout path #{local_path} is not a git repo!"
+            end
+            return true
+        end
+
+        def clone
+            if local_path_exist?
+                raise GitSvnError, "Failed to create repository at '#{local_path}': Path exists"
+            end
+            # Create the directory
+            FileUtils.mkdir_p( local_path ) if !$noop
+            # Init the repository
+            if 0 != ( git_svn "init #{repository.url}/#{remote_path}" )
+                raise GitSvnError, "Error while initializing the repo `git svn init '#{repository}/#{remote_path}'`: #{$?}"
+            end
+            fetch( "HEAD" )
+        end
+
+        def configure
+            git.configure
+        end
+
+        # Fetch from +repository+
+        #
+        # Initializes the local clone if it does not exist.
+        def fetch( revision = nil )
+            if !checkedout? and !$noop # Beware of looping
+                clone
+            end
+            if revision
+                cmd = "fetch -r#{revision}"
+            else
+                cmd = "fetch"
+            end
+            if ( rc = git_svn( cmd ) ) != 0
+                raise GitSvnError, "Error while fetching: #{rc}"
+            end
+            update_externals
+        end
+
+        def git
+            if @git.nil?
+                @git = Git.new( config )
+            end
+            @git
+        end
+
+        # Call git-svn with command
+        def git_svn( command, wd = local_path, &block )
+            rc = self.class.execute( "git svn " + command, wd, &block )
+            if rc != 0
+                raise GitSvnError, "git svn #{command || "" } failed with error code #{rc}";
+            end
+            rc
+        end
+
+        def rebase
+            git.git( "rebase git-svn" )
+        end
+
+        def update_externals
+            config.externals.each do |local, remote|
+                VCS::Svn::svn( "checkout #{remote}@HEAD #{local}", wd = local_path  )
+            end
+        end
+
+        def[]( var )
+            case var
+
+            when 'external'
+                return @externals
+
+            else
+                # *TODO* raise correct exception
+                raise NotImplementedError, "#{var}"
+            end
+        end
+
+        def[]=( var, val )
+            case var
+
+            when 'external'
+                tmp = val.split( /#/ )
+                @externals[tmp[0]] = tmp[1]
+
+            else
+                # *TODO* raise correct exception
+                raise NotImplementedError, "#{var}"
+            end
+        end
+
+    end # class GitSvn
+
+
+end; end # module BuildTool::VCS

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

@@ -0,0 +1,187 @@
+require 'build-tool/vcs/base'
+require 'build-tool/errors'
+
+module BuildTool; module VCS
+
+    class GitError < BuildTool::Error; end
+
+    class GitConfiguration < BaseConfiguration
+
+        def name
+            "git"
+        end
+
+        attr_accessor :remote
+
+        def initialize( mod = nil )
+            super( mod )
+            @remote = {}
+        end
+
+        def vcs( mod )
+            @module = mod
+            Git.new( self )
+        end
+
+        def track_remote
+            rc = self.module.remote_path.split('/')
+            # If there is only one string we assume it is the branch name from
+            # origin
+            return "origin" if rc.length == 1
+            return rc[0]
+        end
+
+        def track_branch
+            rc = self.module.remote_path.split('/')
+            # If there is only one string we assume it is the branch name from
+            # origin
+            return rc[0] if rc.length == 1
+            return rc[1..-1].join( '/' )
+        end
+
+
+    end
+
+    #
+    # Implementation for the git version control system.
+    #
+    class Git < Base
+
+        def initialize( config )
+            super( config )
+            @remote = {}
+            @vcs = nil
+        end
+
+        #
+        ### ATTRIBUTES
+        #
+        def name
+            "git"
+        end
+
+        def fetching_supported?
+            true
+        end
+
+        #
+        ### METHODS
+        #
+
+        def checkedout?
+            return false if !local_path_exist?
+            if !Pathname.new( local_path ).join( ".git" ).exist?
+                raise Base::VcsError, "Checkout path #{local_path} is not a git repo!"
+            end
+            return true
+        end
+
+        # Initialize the local repository
+        def clone
+            # Check if path exists
+            if local_path_exist?
+                raise GitError, "Failed to create repository at '#{local_path}': Path exists"
+            end
+
+            # Create the directory
+            FileUtils.mkdir_p( local_path ) if !$noop
+
+            # Initialize the repository
+            if git( "init", local_path ) != 0
+                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
+            end
+
+            cmd = "remote add origin #{repository.url}"
+            if git( cmd, local_path ) != 0
+                raise GitError, "Error while initializing the repo `#{cmd}`: #{$?}"
+            end
+
+            logger.info <<-EOS
+The following command sometimes fails when issued from this script. Reason unknown. The
+best chance you have is issuing the command manually!
+#{local_path}: #{cmd}
+#{local_path}: git checkout -b #{config.track_branch} #{config.track_remote}/#{config.track_branch}
+            EOS
+
+            fetch()
+
+            cmd = "checkout -b #{config.track_branch} #{config.track_remote}/#{config.track_branch}"
+            if git( cmd, local_path ) != 0
+                raise GitError, "Error while initializing the repo `#{cmd}`: #{$?}"
+            end
+
+        end
+
+        def remote?( name )
+            found = false
+            git( "remote" ) do |line|
+                found = true if line == name
+            end
+            return found
+        end
+
+        # Fetch from +repository+
+        #
+        # Initializes the local clone if it does not exist.
+        def fetch()
+            if !checkedout? and !$noop
+                clone
+            end
+            cmd = "fetch #{config.track_remote}"
+            if ( rc = git( cmd ) ) != 0
+                raise GitError, "Error while fetching: #{rc}"
+            end
+        end
+
+        def git( command, wd = local_path, &block )
+            rc = self.class.execute "git #{command}", wd, &block
+            if rc != 0
+                raise GitError, "git #{command || "" } failed with error code #{rc}";
+            end
+            rc
+        end
+
+        def rebase
+            if 0 != ( git "rebase #{config.track_remote}/#{config.track_branch}" )
+                raise GitSvnError, "Error while rebasing the repo with `git rebase git-svn: #{$?}"
+            end
+        end
+
+    end # class Git
+
+    class GitRemote
+
+        attr_accessor :server
+        attr_accessor :path
+        attr_reader   :name
+
+        def initialize( name )
+            @name = name
+            @path = nil
+        end
+
+        def url
+            url = ""
+            if @server
+                url = @server.url
+            end
+            if @path
+                url = "#{url}/#{path}"
+            end
+            url
+        end
+
+        def to_s
+            "REMOTE: #{name} #{url}"
+        end
+
+    end # class Remote
+
+end; end # module BuildTool::VCS
+