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