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