4623f8e1cf3acc54015d57a486294fe859287ffd
[puppet_vcsrepo.git] / 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   commands :git => 'git'
7
8   has_features :bare_repositories, :reference_tracking, :ssh_identity, :multiple_remotes, :user, :depth, :branch, :submodules
9
10   def create
11     if @resource.value(:revision) and @resource.value(:ensure) == :bare
12       fail("Cannot set a revision (#{@resource.value(:revision)}) on a bare repository")
13     end
14     if !@resource.value(:source)
15       init_repository(@resource.value(:path))
16     else
17       clone_repository(default_url, @resource.value(:path))
18       update_remotes
19
20       if @resource.value(:revision)
21         checkout
22       end
23       if @resource.value(:ensure) != :bare && @resource.value(:submodules) == :true
24         update_submodules
25       end
26
27     end
28     update_owner_and_excludes
29   end
30
31   def destroy
32     FileUtils.rm_rf(@resource.value(:path))
33   end
34
35   # Checks to see if the current revision is equal to the revision on the
36   # remote (whether on a branch, tag, or reference)
37   #
38   # @return [Boolean] Returns true if the repo is on the latest revision
39   def latest?
40     return revision == latest_revision
41   end
42
43   # Just gives the `should` value that we should be setting the repo to if
44   # latest? returns false
45   #
46   # @return [String] Returns the target sha/tag/branch
47   def latest
48     if not @resource.value(:revision) and branch = on_branch?
49       return branch
50     else
51       return @resource.value(:revision)
52     end
53   end
54
55   # Get the current revision of the repo (tag/branch/sha)
56   #
57   # @return [String] Returns the branch/tag if the current sha matches the
58   #                  remote; otherwise returns the current sha.
59   def revision
60     #HEAD is the default, but lets just be explicit here.
61     get_revision('HEAD')
62   end
63
64   # Is passed the desired reference, whether a tag, rev, or branch. Should
65   # handle transitions from a rev/branch/tag to a rev/branch/tag. Detached
66   # heads should be treated like bare revisions.
67   #
68   # @param [String] desired The desired revision to which the repo should be
69   #                         set.
70   def revision=(desired)
71     #just checkout tags and shas; fetch has already happened so they should be updated.
72     checkout(desired)
73     #branches require more work.
74     if local_branch_revision?(desired)
75       #reset instead of pull to avoid merge conflicts. assuming remote is
76       #updated and authoritative.
77       #TODO might be worthwhile to have an allow_local_changes param to decide
78       #whether to reset or pull when we're ensuring latest.
79       if @resource.value(:source)
80         at_path { git_with_identity('reset', '--hard', "#{@resource.value(:remote)}/#{desired}") }
81       else
82         at_path { git_with_identity('reset', '--hard', "#{desired}") }
83       end
84     end
85     #TODO Would this ever reach here if it is bare?
86     if @resource.value(:ensure) != :bare && @resource.value(:submodules) == :true
87       update_submodules
88     end
89     update_owner_and_excludes
90   end
91
92   def bare_exists?
93     bare_git_config_exists? && !working_copy_exists?
94   end
95
96   # If :source is set to a hash (for supporting multiple remotes),
97   # we search for the URL for :remote. If it doesn't exist,
98   # we throw an error. If :source is just a string, we use that
99   # value for the default URL.
100   def default_url
101     if @resource.value(:source).is_a?(Hash)
102       if @resource.value(:source).has_key?(@resource.value(:remote))
103         @resource.value(:source)[@resource.value(:remote)]
104       else
105         fail("You must specify the URL for #{@resource.value(:remote)} in the :source hash")
106       end
107     else
108       @resource.value(:source)
109     end
110   end
111
112   def working_copy_exists?
113     if @resource.value(:source) and File.exists?(File.join(@resource.value(:path), '.git', 'config'))
114       File.readlines(File.join(@resource.value(:path), '.git', 'config')).grep(/#{Regexp.escape(default_url)}/).any?
115     else
116       File.directory?(File.join(@resource.value(:path), '.git'))
117     end
118   end
119
120   def exists?
121     working_copy_exists? || bare_exists?
122   end
123
124   def update_remote_url(remote_name, remote_url)
125     do_update = false
126     current = git_with_identity('config', '-l')
127
128     unless remote_url.nil?
129       # Check if remote exists at all, regardless of URL.
130       # If remote doesn't exist, add it
131       if not current.include? "remote.#{remote_name}.url"
132         git_with_identity('remote','add', remote_name, remote_url)
133         return true
134
135       # If remote exists, but URL doesn't match, update URL
136       elsif not current.include? "remote.#{remote_name}.url=#{remote_url}"
137         git_with_identity('remote','set-url', remote_name, remote_url)
138         return true
139       else
140         return false
141       end
142     end
143
144   end
145
146   def update_remotes
147     do_update = false
148
149     # If supplied source is a hash of remote name and remote url pairs, then
150     # we loop around the hash. Otherwise, we assume single url specified
151     # in source property
152     if @resource.value(:source).is_a?(Hash)
153       @resource.value(:source).keys.sort.each do |remote_name|
154         remote_url = @resource.value(:source)[remote_name]
155         at_path { do_update |= update_remote_url(remote_name, remote_url) }
156       end
157     else
158       at_path { do_update |= update_remote_url(@resource.value(:remote), @resource.value(:source)) }
159     end
160
161     # If at least one remote was added or updated, then we must
162     # call the 'git remote update' command
163     if do_update == true
164       at_path { git_with_identity('remote','update') }
165     end
166
167   end
168
169   def update_references
170     at_path do
171       update_remotes
172       git_with_identity('fetch', @resource.value(:remote))
173       git_with_identity('fetch', '--tags', @resource.value(:remote))
174       update_owner_and_excludes
175     end
176   end
177
178   private
179
180   # @!visibility private
181   def bare_git_config_exists?
182     File.exist?(File.join(@resource.value(:path), 'config'))
183   end
184
185   # @!visibility private
186   def clone_repository(source, path)
187     check_force
188     args = ['clone']
189     if @resource.value(:depth) and @resource.value(:depth).to_i > 0
190       args.push('--depth', @resource.value(:depth).to_s)
191       if @resource.value(:revision)
192         args.push('--branch', @resource.value(:revision).to_s)
193       end
194     end
195     if @resource.value(:branch)
196       args.push('--branch', @resource.value(:branch).to_s)
197     end
198     if @resource.value(:ensure) == :bare
199       args << '--bare'
200     end
201     if @resource.value(:remote) != 'origin'
202       args.push('--origin', @resource.value(:remote))
203     end
204     if !working_copy_exists?
205       args.push(source, path)
206       Dir.chdir("/") do
207         git_with_identity(*args)
208       end
209     else
210       notice "Repo has already been cloned"
211     end
212   end
213
214   # @!visibility private
215   def check_force
216     if path_exists? and not path_empty?
217       if @resource.value(:force)
218         notice "Removing %s to replace with vcsrepo." % @resource.value(:path)
219         destroy
220       else
221         raise Puppet::Error, "Could not create repository (non-repository at path)"
222       end
223     end
224   end
225
226   # @!visibility private
227   def init_repository(path)
228     check_force
229     if @resource.value(:ensure) == :bare && working_copy_exists?
230       convert_working_copy_to_bare
231     elsif @resource.value(:ensure) == :present && bare_exists?
232       convert_bare_to_working_copy
233     else
234       # normal init
235       FileUtils.mkdir(@resource.value(:path))
236       FileUtils.chown(@resource.value(:user), nil, @resource.value(:path)) if @resource.value(:user)
237       args = ['init']
238       if @resource.value(:ensure) == :bare
239         args << '--bare'
240       end
241       at_path do
242         git_with_identity(*args)
243       end
244     end
245   end
246
247   # Convert working copy to bare
248   #
249   # Moves:
250   #   <path>/.git
251   # to:
252   #   <path>/
253   # @!visibility private
254   def convert_working_copy_to_bare
255     notice "Converting working copy repository to bare repository"
256     FileUtils.mv(File.join(@resource.value(:path), '.git'), tempdir)
257     FileUtils.rm_rf(@resource.value(:path))
258     FileUtils.mv(tempdir, @resource.value(:path))
259   end
260
261   # Convert bare to working copy
262   #
263   # Moves:
264   #   <path>/
265   # to:
266   #   <path>/.git
267   # @!visibility private
268   def convert_bare_to_working_copy
269     notice "Converting bare repository to working copy repository"
270     FileUtils.mv(@resource.value(:path), tempdir)
271     FileUtils.mkdir(@resource.value(:path))
272     FileUtils.mv(tempdir, File.join(@resource.value(:path), '.git'))
273     if commits_in?(File.join(@resource.value(:path), '.git'))
274       reset('HEAD')
275       git_with_identity('checkout', '--force')
276       update_owner_and_excludes
277     end
278   end
279
280   # @!visibility private
281   def commits_in?(dot_git)
282     Dir.glob(File.join(dot_git, 'objects/info/*'), File::FNM_DOTMATCH) do |e|
283       return true unless %w(. ..).include?(File::basename(e))
284     end
285     false
286   end
287
288   # Will checkout a rev/branch/tag using the locally cached versions. Does not
289   # handle upstream branch changes
290   # @!visibility private
291   def checkout(revision = @resource.value(:revision))
292     if !local_branch_revision?(revision) && remote_branch_revision?(revision)
293       #non-locally existant branches (perhaps switching to a branch that has never been checked out)
294       at_path { git_with_identity('checkout', '--force', '-b', revision, '--track', "#{@resource.value(:remote)}/#{revision}") }
295     else
296       #tags, locally existant branches (perhaps outdated), and shas
297       at_path { git_with_identity('checkout', '--force', revision) }
298     end
299   end
300
301   # @!visibility private
302   def reset(desired)
303     at_path do
304       git_with_identity('reset', '--hard', desired)
305     end
306   end
307
308   # @!visibility private
309   def update_submodules
310     at_path do
311       git_with_identity('submodule', 'update', '--init', '--recursive')
312     end
313   end
314
315   # Determins if the branch exists at the upstream but has not yet been locally committed
316   # @!visibility private
317   def remote_branch_revision?(revision = @resource.value(:revision))
318     # git < 1.6 returns '#{@resource.value(:remote)}/#{revision}'
319     # git 1.6+ returns 'remotes/#{@resource.value(:remote)}/#{revision}'
320     branch = at_path { branches.grep /(remotes\/)?#{@resource.value(:remote)}\/#{revision}/ }
321     branch unless branch.empty?
322   end
323
324   # Determins if the branch is already cached locally
325   # @!visibility private
326   def local_branch_revision?(revision = @resource.value(:revision))
327     at_path { branches.include?(revision) }
328   end
329
330   # @!visibility private
331   def tag_revision?(revision = @resource.value(:revision))
332     at_path { tags.include?(revision) }
333   end
334
335   # @!visibility private
336   def branches
337     at_path { git_with_identity('branch', '-a') }.gsub('*', ' ').split(/\n/).map { |line| line.strip }
338   end
339
340   # git < 2.4 returns 'detached from'
341   # git 2.4+ returns 'HEAD detached at'
342   # @!visibility private
343   def on_branch?
344     at_path {
345       matches = git_with_identity('branch', '-a').match /\*\s+(.*)/
346       matches[1] unless matches[1].match /(\(detached from|\(HEAD detached at|\(no branch)/
347     }
348   end
349
350   # @!visibility private
351   def tags
352     at_path { git_with_identity('tag', '-l') }.split(/\n/).map { |line| line.strip }
353   end
354
355   # @!visibility private
356   def set_excludes
357     # Excludes may be an Array or a String.
358     at_path do
359       open('.git/info/exclude', 'w') do |f|
360         if @resource.value(:excludes).respond_to?(:each)
361           @resource.value(:excludes).each { |ex| f.puts ex }
362         else
363           f.puts @resource.value(:excludes)
364         end
365       end
366     end
367   end
368
369   # Finds the latest revision or sha of the current branch if on a branch, or
370   # of HEAD otherwise.
371   # @note Calls create which can forcibly destroy and re-clone the repo if
372   #       force => true
373   # @see get_revision
374   #
375   # @!visibility private
376   # @return [String] Returns the output of get_revision
377   def latest_revision
378     #TODO Why is create called here anyway?
379     create if @resource.value(:force) && working_copy_exists?
380     create if !working_copy_exists?
381
382     if branch = on_branch?
383       return get_revision("#{@resource.value(:remote)}/#{branch}")
384     else
385       return get_revision
386     end
387   end
388
389   # Returns the current revision given if the revision is a tag or branch and
390   # matches the current sha. If the current sha does not match the sha of a tag
391   # or branch, then it will just return the sha (ie, is not in sync)
392   #
393   # @!visibility private
394   #
395   # @param [String] rev The revision of which to check if it is current
396   # @return [String] Returns the tag/branch of the current repo if it's up to
397   #                  date; otherwise returns the sha of the requested revision.
398   def get_revision(rev = 'HEAD')
399     if @resource.value(:source)
400       update_references
401     else
402       status = at_path { git_with_identity('status')}
403       is_it_new = status =~ /Initial commit/
404       if is_it_new
405         status =~ /On branch (.*)/
406         branch = $1
407         return branch
408       end
409     end
410     current = at_path { git_with_identity('rev-parse', rev).strip }
411     if @resource.value(:revision)
412       if tag_revision?
413         # git-rev-parse will give you the hash of the tag object itself rather
414         # than the commit it points to by default. Using tag^0 will return the
415         # actual commit.
416         canonical = at_path { git_with_identity('rev-parse', "#{@resource.value(:revision)}^0").strip }
417       elsif local_branch_revision?
418         canonical = at_path { git_with_identity('rev-parse', @resource.value(:revision)).strip }
419       elsif remote_branch_revision?
420         canonical = at_path { git_with_identity('rev-parse', "#{@resource.value(:remote)}/#{@resource.value(:revision)}").strip }
421       else
422         #look for a sha (could match invalid shas)
423         canonical = at_path { git_with_identity('rev-parse', '--revs-only', @resource.value(:revision)).strip }
424       end
425       fail("#{@resource.value(:revision)} is not a local or remote ref") if canonical.nil? or canonical.empty?
426       current = @resource.value(:revision) if current == canonical
427     end
428     return current
429   end
430
431   # @!visibility private
432   def update_owner_and_excludes
433     if @resource.value(:owner) or @resource.value(:group)
434       set_ownership
435     end
436     if @resource.value(:excludes)
437       set_excludes
438     end
439   end
440
441   # @!visibility private
442   def git_with_identity(*args)
443     if @resource.value(:identity)
444       Tempfile.open('git-helper', Puppet[:statedir]) do |f|
445         f.puts '#!/bin/sh'
446         f.puts "exec ssh -oStrictHostKeyChecking=no -oPasswordAuthentication=no -oKbdInteractiveAuthentication=no -oChallengeResponseAuthentication=no -oConnectTimeout=120 -i #{@resource.value(:identity)} $*"
447         f.close
448
449         FileUtils.chmod(0755, f.path)
450         env_save = ENV['GIT_SSH']
451         ENV['GIT_SSH'] = f.path
452
453         ret = git(*args)
454
455         ENV['GIT_SSH'] = env_save
456
457         return ret
458       end
459     elsif @resource.value(:user) and @resource.value(:user) != Facter['id'].value
460       Puppet::Util::Execution.execute("git #{args.join(' ')}", :uid => @resource.value(:user), :failonfail => true)
461     else
462       git(*args)
463     end
464   end
465 end