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