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   has_features :bare_repositories, :reference_tracking, :ssh_identity, :multiple_remotes, :user
  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', @resource.value(:remote))
  99       git_with_identity('fetch', '--tags', @resource.value(:remote))
 100       update_owner_and_excludes
 101     end
 102   end
 103
 104   private
 105
 106   def bare_git_config_exists?
 107     File.exist?(File.join(@resource.value(:path), 'config'))
 108   end
 109
 110   def clone_repository(source, path)
 111     check_force
 112     args = ['clone']
 113     if @resource.value(:ensure) == :bare
 114       args << '--bare'
 115     end
 116     if !File.exist?(File.join(@resource.value(:path), '.git'))
 117       args.push(source, path)
 118       git_with_identity(*args)
 119     else
 120       notice "Repo has already been cloned"
 121     end
 122   end
 123
 124   def check_force
 125     if path_exists?
 126       if @resource.value(:force)
 127         notice "Removing %s to replace with vcsrepo." % @resource.value(:path)
 128         destroy
 129       else
 130         raise Puppet::Error, "Could not create repository (non-repository at path)"
 131       end
 132     end
 133   end
 134
 135   def init_repository(path)
 136     check_force
 137     if @resource.value(:ensure) == :bare && working_copy_exists?
 138       convert_working_copy_to_bare
 139     elsif @resource.value(:ensure) == :present && bare_exists?
 140       convert_bare_to_working_copy
 141     else
 142       # normal init
 143       FileUtils.mkdir(@resource.value(:path))
 144       args = ['init']
 145       if @resource.value(:ensure) == :bare
 146         args << '--bare'
 147       end
 148       at_path do
 149         git_with_identity(*args)
 150       end
 151     end
 152   end
 153
 154   # Convert working copy to bare
 155   #
 156   # Moves:
 157   #   <path>/.git
 158   # to:
 159   #   <path>/
 160   def convert_working_copy_to_bare
 161     notice "Converting working copy repository to bare repository"
 162     FileUtils.mv(File.join(@resource.value(:path), '.git'), tempdir)
 163     FileUtils.rm_rf(@resource.value(:path))
 164     FileUtils.mv(tempdir, @resource.value(:path))
 165   end
 166
 167   # Convert bare to working copy
 168   #
 169   # Moves:
 170   #   <path>/
 171   # to:
 172   #   <path>/.git
 173   def convert_bare_to_working_copy
 174     notice "Converting bare repository to working copy repository"
 175     FileUtils.mv(@resource.value(:path), tempdir)
 176     FileUtils.mkdir(@resource.value(:path))
 177     FileUtils.mv(tempdir, File.join(@resource.value(:path), '.git'))
 178     if commits_in?(File.join(@resource.value(:path), '.git'))
 179       reset('HEAD')
 180       git_with_identity('checkout', '-f')
 181       update_owner_and_excludes
 182     end
 183   end
 184
 185   def commits_in?(dot_git)
 186     Dir.glob(File.join(dot_git, 'objects/info/*'), File::FNM_DOTMATCH) do |e|
 187       return true unless %w(. ..).include?(File::basename(e))
 188     end
 189     false
 190   end
 191
 192   def checkout(revision = @resource.value(:revision))
 193     if !local_branch_revision? && remote_branch_revision?
 194       at_path { git_with_identity('checkout', '-b', revision, '--track', "#{@resource.value(:remote)}/#{revision}") }
 195     else
 196       at_path { git_with_identity('checkout', '--force', revision) }
 197     end
 198   end
 199
 200   def reset(desired)
 201     at_path do
 202       git_with_identity('reset', '--hard', desired)
 203     end
 204   end
 205
 206   def update_submodules
 207     at_path do
 208       git_with_identity('submodule', 'update', '--init', '--recursive')
 209     end
 210   end
 211
 212   def remote_branch_revision?(revision = @resource.value(:revision))
 213     # git < 1.6 returns '#{@resource.value(:remote)}/#{revision}'
 214     # git 1.6+ returns 'remotes/#{@resource.value(:remote)}/#{revision}'
 215     branch = at_path { branches.grep /(remotes\/)?#{@resource.value(:remote)}\/#{revision}/ }
 216     if branch.length > 0
 217       return branch
 218     end
 219   end
 220
 221   def local_branch_revision?(revision = @resource.value(:revision))
 222     at_path { branches.include?(revision) }
 223   end
 224
 225   def tag_revision?(revision = @resource.value(:revision))
 226     at_path { tags.include?(revision) }
 227   end
 228
 229   def branches
 230     at_path { git_with_identity('branch', '-a') }.gsub('*', ' ').split(/\n/).map { |line| line.strip }
 231   end
 232
 233   def on_branch?
 234     at_path { git_with_identity('branch', '-a') }.split(/\n/).grep(/\*/).first.to_s.gsub('*', '').strip
 235   end
 236
 237   def tags
 238     at_path { git_with_identity('tag', '-l') }.split(/\n/).map { |line| line.strip }
 239   end
 240
 241   def set_excludes
 242     at_path { open('.git/info/exclude', 'w') { |f| @resource.value(:excludes).each { |ex| f.write(ex + "\n") }}}
 243   end
 244
 245   def get_revision(rev)
 246     if !working_copy_exists?
 247       create
 248     end
 249     at_path do
 250       git_with_identity('fetch', @resource.value(:remote))
 251       git_with_identity('fetch', '--tags', @resource.value(:remote))
 252     end
 253     current = at_path { git_with_identity('rev-parse', rev).strip }
 254     if @resource.value(:revision)
 255       if local_branch_revision?
 256         canonical = at_path { git_with_identity('rev-parse', @resource.value(:revision)).strip }
 257       elsif remote_branch_revision?
 258         canonical = at_path { git_with_identity('rev-parse', "#{@resource.value(:remote)}/" + @resource.value(:revision)).strip }
 259       end
 260       current = @resource.value(:revision) if current == canonical
 261     end
 262     update_owner_and_excludes
 263     return current
 264   end
 265
 266   def update_owner_and_excludes
 267     if @resource.value(:owner) or @resource.value(:group)
 268       set_ownership
 269     end
 270     if @resource.value(:excludes)
 271       set_excludes
 272     end
 273   end
 274
 275   def git_with_identity(*args)
 276     if @resource.value(:identity)
 277       Tempfile.open('git-helper') do |f|
 278         f.puts '#!/bin/sh'
 279         f.puts "exec ssh -oStrictHostKeyChecking=no -oPasswordAuthentication=no -oKbdInteractiveAuthentication=no -oChallengeResponseAuthentication=no -i #{@resource.value(:identity)} $*"
 280         f.close
 281
 282         FileUtils.chmod(0755, f.path)
 283         env_save = ENV['GIT_SSH']
 284         ENV['GIT_SSH'] = f.path
 285
 286         ret = git(*args)
 287
 288         ENV['GIT_SSH'] = env_save
 289
 290         return ret
 291       end
 292     elsif @resource.value(:user)
 293       su(@resource.value(:user), '-c', "git #{args.join(' ')}" )
 294     else
 295       git(*args)
 296     end
 297   end
 298 end