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