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
  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_or_reset
  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('origin/HEAD')
  44     elsif branch == '(no branch)'
  45       return get_revision('HEAD')
  46     else
  47       return get_revision('origin/%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_or_reset(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', "origin/#{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', 'origin')
  99     end
 100   end
 101
 102   private
 103
 104   def bare_git_config_exists?
 105     File.exist?(File.join(@resource.value(:path), 'config'))
 106   end
 107
 108   def clone_repository(source, path)
 109     check_force
 110     args = ['clone']
 111     if @resource.value(:ensure) == :bare
 112       args << '--bare'
 113     end
 114     if !File.exist?(File.join(@resource.value(:path), '.git'))
 115       args.push(source, path)
 116       git_with_identity(*args)
 117     else
 118       notice "Repo has already been cloned"
 119     end
 120   end
 121
 122   def check_force
 123     if path_exists?
 124       if @resource.value(:force)
 125         notice "Removing %s to replace with vcsrepo." % @resource.value(:path)
 126         destroy
 127       else
 128         raise Puppet::Error, "Could not create repository (non-repository at path)"
 129       end
 130     end
 131   end
 132
 133   def init_repository(path)
 134     check_force
 135     if @resource.value(:ensure) == :bare && working_copy_exists?
 136       convert_working_copy_to_bare
 137     elsif @resource.value(:ensure) == :present && bare_exists?
 138       convert_bare_to_working_copy
 139     else
 140       # normal init
 141       FileUtils.mkdir(@resource.value(:path))
 142       args = ['init']
 143       if @resource.value(:ensure) == :bare
 144         args << '--bare'
 145       end
 146       at_path do
 147         git_with_identity(*args)
 148       end
 149     end
 150   end
 151
 152   # Convert working copy to bare
 153   #
 154   # Moves:
 155   #   <path>/.git
 156   # to:
 157   #   <path>/
 158   def convert_working_copy_to_bare
 159     notice "Converting working copy repository to bare repository"
 160     FileUtils.mv(File.join(@resource.value(:path), '.git'), tempdir)
 161     FileUtils.rm_rf(@resource.value(:path))
 162     FileUtils.mv(tempdir, @resource.value(:path))
 163   end
 164
 165   # Convert bare to working copy
 166   #
 167   # Moves:
 168   #   <path>/
 169   # to:
 170   #   <path>/.git
 171   def convert_bare_to_working_copy
 172     notice "Converting bare repository to working copy repository"
 173     FileUtils.mv(@resource.value(:path), tempdir)
 174     FileUtils.mkdir(@resource.value(:path))
 175     FileUtils.mv(tempdir, File.join(@resource.value(:path), '.git'))
 176     if commits_in?(File.join(@resource.value(:path), '.git'))
 177       reset('HEAD')
 178       git_with_identity('checkout', '-f')
 179       update_owner_and_excludes
 180     end
 181   end
 182
 183   def commits_in?(dot_git)
 184     Dir.glob(File.join(dot_git, 'objects/info/*'), File::FNM_DOTMATCH) do |e|
 185       return true unless %w(. ..).include?(File::basename(e))
 186     end
 187     false
 188   end
 189
 190   def checkout_or_reset(revision = @resource.value(:revision))
 191     if local_branch_revision?
 192       reset(revision)
 193     elsif tag_revision?
 194       at_path { git_with_identity('checkout', revision) }
 195     elsif remote_branch_revision?
 196       at_path { git_with_identity('checkout', '-b', revision, '--track', "origin/#{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', 'init')
 209       git_with_identity('submodule', 'update')
 210       git_with_identity('submodule', 'foreach', 'git', 'submodule', 'init')
 211       git_with_identity('submodule', 'foreach', 'git', 'submodule', 'update')
 212     end
 213   end
 214
 215   def remote_branch_revision?(revision = @resource.value(:revision))
 216     # git < 1.6 returns 'origin/#{revision}'
 217     # git 1.6+ returns 'remotes/origin/#{revision}'
 218     branch = at_path { branches.grep /(remotes\/)?origin\/#{revision}/ }
 219     if branch.length > 0
 220       return branch
 221     end
 222   end
 223
 224   def local_branch_revision?(revision = @resource.value(:revision))
 225     at_path { branches.include?(revision) }
 226   end
 227
 228   def tag_revision?(revision = @resource.value(:revision))
 229     at_path { tags.include?(revision) }
 230   end
 231
 232   def branches
 233     at_path { git_with_identity('branch', '-a') }.gsub('*', ' ').split(/\n/).map { |line| line.strip }
 234   end
 235
 236   def on_branch?
 237     at_path { git_with_identity('branch', '-a') }.split(/\n/).grep(/\*/).first.to_s.gsub('*', '').strip
 238   end
 239
 240   def tags
 241     at_path { git_with_identity('tag', '-l') }.split(/\n/).map { |line| line.strip }
 242   end
 243
 244   def set_excludes
 245     at_path { open('.git/info/exclude', 'w') { |f| @resource.value(:excludes).each { |ex| f.write(ex + "\n") }}}
 246   end
 247
 248   def get_revision(rev)
 249     if !working_copy_exists?
 250       create
 251     end
 252     at_path do
 253       git_with_identity('fetch', 'origin')
 254       git_with_identity('fetch', '--tags', 'origin')
 255     end
 256     current = at_path { git_with_identity('rev-parse', rev).strip }
 257     if @resource.value(:revision)
 258       if local_branch_revision?
 259         canonical = at_path { git_with_identity('rev-parse', @resource.value(:revision)).strip }
 260       elsif remote_branch_revision?
 261         canonical = at_path { git_with_identity('rev-parse', 'origin/' + @resource.value(:revision)).strip }
 262       end
 263       current = @resource.value(:revision) if current == canonical
 264     end
 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