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