lib/puppet/provider/vcsrepo/git.rb

   1 require File.join(File.dirname(__FILE__), '..', 'vcsrepo')
   2
   3 Puppet::Type.type(:vcsrepo).provide(:git, :parent => Puppet::Provider::Vcsrepo) do
   4   desc "Supports Git repositories"
   5
   6   ##TODO modify the commands below so that the su - is included
   7   optional_commands :git => 'git'
   8   defaultfor :git => :exists
   9   has_features :bare_repositories, :reference_tracking, :ssh_identity, :multiple_remotes
  10
  11   def create
  12     if !@resource.value(:source)
  13       init_repository(@resource.value(:path))
  14     else
  15       clone_repository(@resource.value(:source), @resource.value(:path))
  16       if @resource.value(:revision)
  17         if @resource.value(:ensure) == :bare
  18           notice "Ignoring revision for bare repository"
  19         else
  20           checkout
  21         end
  22       end
  23       if @resource.value(:ensure) != :bare
  24         update_submodules
  25       end
  26     end
  27     update_owner_and_excludes
  28   end
  29
  30   def destroy
  31     FileUtils.rm_rf(@resource.value(:path))
  32   end
  33
  34   def latest?
  35     at_path do
  36       return self.revision == self.latest
  37     end
  38   end
  39
  40   def latest
  41     branch = on_branch?
  42     if branch == 'master'
  43       return get_revision("#{@resource.value(:remote)}/HEAD")
  44     elsif branch == '(no branch)'
  45       return get_revision('HEAD')
  46     else
  47       return get_revision("#{@resource.value(:remote)}/%s" % branch)
  48     end
  49   end
  50
  51   def revision
  52     update_references
  53     current = at_path { git_with_identity('rev-parse', 'HEAD').chomp }
  54     return current unless @resource.value(:revision)
  55
  56     if tag_revision?(@resource.value(:revision))
  57       canonical = at_path { git_with_identity('show', @resource.value(:revision)).scan(/commit (.*)/).to_s }
  58     else
  59       canonical = at_path { git_with_identity('rev-parse', @resource.value(:revision)).chomp }
  60     end
  61
  62     if current == canonical
  63       @resource.value(:revision)
  64     else
  65       current
  66     end
  67   end
  68
  69   def revision=(desired)
  70     checkout(desired)
  71     if local_branch_revision?(desired)
  72       # reset instead of pull to avoid merge conflicts. assuming remote is
  73       # authoritative.
  74       # might be worthwhile to have an allow_local_changes param to decide
  75       # whether to reset or pull when we're ensuring latest.
  76       at_path { git_with_identity('reset', '--hard', "#{@resource.value(:remote)}/#{desired}") }
  77     end
  78     if @resource.value(:ensure) != :bare
  79       update_submodules
  80     end
  81     update_owner_and_excludes
  82   end
  83
  84   def bare_exists?
  85     bare_git_config_exists? && !working_copy_exists?
  86   end
  87
  88   def working_copy_exists?
  89     File.directory?(File.join(@resource.value(:path), '.git'))
  90   end
  91
  92   def exists?
  93     working_copy_exists? || bare_exists?
  94   end
  95
  96   def update_references
  97     at_path do
  98       git_with_identity('fetch', '--tags', @resource.value(:remote))
  99       update_owner_and_excludes
 100     end
 101   end
 102
 103   private
 104
 105   def bare_git_config_exists?
 106     File.exist?(File.join(@resource.value(:path), 'config'))
 107   end
 108
 109   def clone_repository(source, path)
 110     check_force
 111     args = ['clone']
 112     if @resource.value(:ensure) == :bare
 113       args << '--bare'
 114     end
 115     if !File.exist?(File.join(@resource.value(:path), '.git'))
 116       args.push(source, path)
 117       git_with_identity(*args)
 118     else
 119       notice "Repo has already been cloned"
 120     end
 121   end
 122
 123   def check_force
 124     if path_exists?
 125       if @resource.value(:force)
 126         notice "Removing %s to replace with vcsrepo." % @resource.value(:path)
 127         destroy
 128       else
 129         raise Puppet::Error, "Could not create repository (non-repository at path)"
 130       end
 131     end
 132   end
 133
 134   def init_repository(path)
 135     check_force
 136     if @resource.value(:ensure) == :bare && working_copy_exists?
 137       convert_working_copy_to_bare
 138     elsif @resource.value(:ensure) == :present && bare_exists?
 139       convert_bare_to_working_copy
 140     else
 141       # normal init
 142       FileUtils.mkdir(@resource.value(:path))
 143       args = ['init']
 144       if @resource.value(:ensure) == :bare
 145         args << '--bare'
 146       end
 147       at_path do
 148         git_with_identity(*args)
 149       end
 150     end
 151   end
 152
 153   # Convert working copy to bare
 154   #
 155   # Moves:
 156   #   <path>/.git
 157   # to:
 158   #   <path>/
 159   def convert_working_copy_to_bare
 160     notice "Converting working copy repository to bare repository"
 161     FileUtils.mv(File.join(@resource.value(:path), '.git'), tempdir)
 162     FileUtils.rm_rf(@resource.value(:path))
 163     FileUtils.mv(tempdir, @resource.value(:path))
 164   end
 165
 166   # Convert bare to working copy
 167   #
 168   # Moves:
 169   #   <path>/
 170   # to:
 171   #   <path>/.git
 172   def convert_bare_to_working_copy
 173     notice "Converting bare repository to working copy repository"
 174     FileUtils.mv(@resource.value(:path), tempdir)
 175     FileUtils.mkdir(@resource.value(:path))
 176     FileUtils.mv(tempdir, File.join(@resource.value(:path), '.git'))
 177     if commits_in?(File.join(@resource.value(:path), '.git'))
 178       reset('HEAD')
 179       git_with_identity('checkout', '-f')
 180       update_owner_and_excludes
 181     end
 182   end
 183
 184   def commits_in?(dot_git)
 185     Dir.glob(File.join(dot_git, 'objects/info/*'), File::FNM_DOTMATCH) do |e|
 186       return true unless %w(. ..).include?(File::basename(e))
 187     end
 188     false
 189   end
 190
 191   def checkout(revision = @resource.value(:revision))
 192     if !local_branch_revision? && remote_branch_revision?
 193       at_path { git_with_identity('checkout', '-b', revision, '--track', "#{@resource.value(:remote)}/#{revision}") }
 194     else
 195       at_path { git_with_identity('checkout', '--force', revision) }
 196     end
 197   end
 198
 199   def reset(desired)
 200     at_path do
 201       git_with_identity('reset', '--hard', desired)
 202     end
 203   end
 204
 205   def update_submodules
 206     at_path do
 207       git_with_identity('submodule', 'init')
 208       git_with_identity('submodule', 'update')
 209       git_with_identity('submodule', 'foreach', 'git', 'submodule', 'init')
 210       git_with_identity('submodule', 'foreach', 'git', 'submodule', 'update')
 211     end
 212   end
 213
 214   def remote_branch_revision?(revision = @resource.value(:revision))
 215     # git < 1.6 returns '#{@resource.value(:remote)}/#{revision}'
 216     # git 1.6+ returns 'remotes/#{@resource.value(:remote)}/#{revision}'
 217     branch = at_path { branches.grep /(remotes\/)?#{@resource.value(:remote)}\/#{revision}/ }
 218     if branch.length > 0
 219       return branch
 220     end
 221   end
 222
 223   def local_branch_revision?(revision = @resource.value(:revision))
 224     at_path { branches.include?(revision) }
 225   end
 226
 227   def tag_revision?(revision = @resource.value(:revision))
 228     at_path { tags.include?(revision) }
 229   end
 230
 231   def branches
 232     at_path { git_with_identity('branch', '-a') }.gsub('*', ' ').split(/\n/).map { |line| line.strip }
 233   end
 234
 235   def on_branch?
 236     at_path { git_with_identity('branch', '-a') }.split(/\n/).grep(/\*/).first.to_s.gsub('*', '').strip
 237   end
 238
 239   def tags
 240     at_path { git_with_identity('tag', '-l') }.split(/\n/).map { |line| line.strip }
 241   end
 242
 243   def set_excludes
 244     at_path { open('.git/info/exclude', 'w') { |f| @resource.value(:excludes).each { |ex| f.write(ex + "\n") }}}
 245   end
 246
 247   def get_revision(rev)
 248     if !working_copy_exists?
 249       create
 250     end
 251     at_path do
 252       git_with_identity('fetch', @resource.value(:remote))
 253       git_with_identity('fetch', '--tags', @resource.value(:remote))
 254     end
 255     current = at_path { git_with_identity('rev-parse', rev).strip }
 256     if @resource.value(:revision)
 257       if local_branch_revision?
 258         canonical = at_path { git_with_identity('rev-parse', @resource.value(:revision)).strip }
 259       elsif remote_branch_revision?
 260         canonical = at_path { git_with_identity('rev-parse', "#{@resource.value(:remote)}/" + @resource.value(:revision)).strip }
 261       end
 262       current = @resource.value(:revision) if current == canonical
 263     end
 264     update_owner_and_excludes
 265     return current
 266   end
 267
 268   def update_owner_and_excludes
 269     if @resource.value(:owner) or @resource.value(:group)
 270       set_ownership
 271     end
 272     if @resource.value(:excludes)
 273       set_excludes
 274     end
 275   end
 276
 277   def git_with_identity(*args)
 278     if @resource.value(:identity)
 279       Tempfile.open('git-helper') do |f|
 280         f.puts '#!/bin/sh'
 281         f.puts "exec ssh -i #{@resource.value(:identity)} $*"
 282         f.close
 283
 284         FileUtils.chmod(0755, f.path)
 285         env_save = ENV['GIT_SSH']
 286         ENV['GIT_SSH'] = f.path
 287
 288         ret = git(*args)
 289
 290         ENV['GIT_SSH'] = env_save
 291
 292         return ret
 293       end
 294     else
 295       git(*args)
 296     end
 297   end
 298 end