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