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