Merge pull request #137 from johnduarte/git_ensure_latest
[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   ##TODO modify the commands below so that the su - is included
7   optional_commands :git => 'git',
8                     :su  => 'su'
9   has_features :bare_repositories, :reference_tracking, :ssh_identity, :multiple_remotes, :user, :depth
10
11   def create
12     if !@resource.value(:source)
13       init_repository(@resource.value(:path))
14     else
15       clone_repository(@resource.value(:source), @resource.value(:path))
16       if @resource.value(:revision)
17         if @resource.value(:ensure) == :bare
18           notice "Ignoring revision for bare repository"
19         else
20           checkout
21         end
22       end
23       if @resource.value(:ensure) != :bare
24         update_submodules
25       end
26     end
27     update_owner_and_excludes
28   end
29
30   def destroy
31     FileUtils.rm_rf(@resource.value(:path))
32   end
33
34   def latest?
35     at_path do
36       return self.revision == self.latest
37     end
38   end
39
40   def latest
41     branch = on_branch?
42     if !branch
43       return get_revision('HEAD')
44     else
45       return get_revision("#{@resource.value(:remote)}/#{branch}")
46     end
47   end
48
49   def revision
50     update_references
51     current = at_path { git_with_identity('rev-parse', 'HEAD').chomp }
52     return current unless @resource.value(:revision)
53
54     if tag_revision?(@resource.value(:revision))
55       canonical = at_path { git_with_identity('rev-parse', @resource.value(:revision)).chomp }
56     else
57       # if it's not a tag, look for it as a local ref
58       canonical = at_path { git_with_identity('rev-parse', '--revs-only', @resource.value(:revision)).chomp }
59       if canonical.empty?
60         # git rev-parse executed properly but didn't find the ref;
61         # look for it in the remote
62         remote_ref = at_path { git_with_identity('ls-remote', '--heads', '--tags', @resource.value(:remote), @resource.value(:revision)).chomp }
63         if remote_ref.empty?
64           fail("#{@resource.value(:revision)} is not a local or remote ref")
65         end
66
67         # $ git ls-remote --heads --tags origin feature/cvs
68         # 7d4244b35e72904e30130cad6d2258f901c16f1a      refs/heads/feature/cvs
69         canonical = remote_ref.split.first
70       end
71     end
72
73     if current == canonical
74       @resource.value(:revision)
75     else
76       current
77     end
78   end
79
80   def revision=(desired)
81     checkout(desired)
82     if local_branch_revision?
83       # reset instead of pull to avoid merge conflicts. assuming remote is
84       # authoritative.
85       # might be worthwhile to have an allow_local_changes param to decide
86       # whether to reset or pull when we're ensuring latest.
87       at_path {
88         git_with_identity('reset', '--hard', "#{@resource.value(:remote)}/#{desired}")
89         if detached?
90           git_with_identity('checkout', "#{@resource.value(:revision)}")
91           git_with_identity('pull')
92         end
93       }
94     end
95     if @resource.value(:ensure) != :bare
96       update_submodules
97     end
98     update_owner_and_excludes
99   end
100
101   def bare_exists?
102     bare_git_config_exists? && !working_copy_exists?
103   end
104
105   def working_copy_exists?
106     File.directory?(File.join(@resource.value(:path), '.git'))
107   end
108
109   def exists?
110     working_copy_exists? || bare_exists?
111   end
112
113   def update_remote_origin_url
114     current = git_with_identity('config', "remote.#{@resource.value(:remote)}.url")
115     unless @resource.value(:source).nil?
116       if current.nil? or current.strip != @resource.value(:source)
117         git_with_identity('config', "remote.#{@resource.value(:remote)}.url", @resource.value(:source))
118       end
119     end
120   end
121
122   def update_references
123     at_path do
124       update_remote_origin_url
125       git_with_identity('fetch', @resource.value(:remote))
126       git_with_identity('fetch', '--tags', @resource.value(:remote))
127       update_owner_and_excludes
128     end
129   end
130
131   private
132
133   def bare_git_config_exists?
134     File.exist?(File.join(@resource.value(:path), 'config'))
135   end
136
137   def clone_repository(source, path)
138     check_force
139     args = ['clone']
140     if @resource.value(:depth) and @resource.value(:depth).to_i > 0
141       args.push('--depth', @resource.value(:depth).to_s)
142     end
143     if @resource.value(:ensure) == :bare
144       args << '--bare'
145     end
146     if @resource.value(:remote) != 'origin'
147       args.push('--origin', @resource.value(:remote))
148     end
149     if !working_copy_exists?
150       args.push(source, path)
151       Dir.chdir("/") do
152         git_with_identity(*args)
153       end
154     else
155       notice "Repo has already been cloned"
156     end
157   end
158
159   def check_force
160     if path_exists? and not path_empty?
161       if @resource.value(:force)
162         notice "Removing %s to replace with vcsrepo." % @resource.value(:path)
163         destroy
164       else
165         raise Puppet::Error, "Could not create repository (non-repository at path)"
166       end
167     end
168   end
169
170   def init_repository(path)
171     check_force
172     if @resource.value(:ensure) == :bare && working_copy_exists?
173       convert_working_copy_to_bare
174     elsif @resource.value(:ensure) == :present && bare_exists?
175       convert_bare_to_working_copy
176     else
177       # normal init
178       FileUtils.mkdir(@resource.value(:path))
179       FileUtils.chown(@resource.value(:user), nil, @resource.value(:path)) if @resource.value(:user)
180       args = ['init']
181       if @resource.value(:ensure) == :bare
182         args << '--bare'
183       end
184       at_path do
185         git_with_identity(*args)
186       end
187     end
188   end
189
190   # Convert working copy to bare
191   #
192   # Moves:
193   #   <path>/.git
194   # to:
195   #   <path>/
196   def convert_working_copy_to_bare
197     notice "Converting working copy repository to bare repository"
198     FileUtils.mv(File.join(@resource.value(:path), '.git'), tempdir)
199     FileUtils.rm_rf(@resource.value(:path))
200     FileUtils.mv(tempdir, @resource.value(:path))
201   end
202
203   # Convert bare to working copy
204   #
205   # Moves:
206   #   <path>/
207   # to:
208   #   <path>/.git
209   def convert_bare_to_working_copy
210     notice "Converting bare repository to working copy repository"
211     FileUtils.mv(@resource.value(:path), tempdir)
212     FileUtils.mkdir(@resource.value(:path))
213     FileUtils.mv(tempdir, File.join(@resource.value(:path), '.git'))
214     if commits_in?(File.join(@resource.value(:path), '.git'))
215       reset('HEAD')
216       git_with_identity('checkout', '--force')
217       update_owner_and_excludes
218     end
219   end
220
221   def commits_in?(dot_git)
222     Dir.glob(File.join(dot_git, 'objects/info/*'), File::FNM_DOTMATCH) do |e|
223       return true unless %w(. ..).include?(File::basename(e))
224     end
225     false
226   end
227
228   def checkout(revision = @resource.value(:revision))
229     if !local_branch_revision? && remote_branch_revision?
230       at_path { git_with_identity('checkout', '-b', revision, '--track', "#{@resource.value(:remote)}/#{revision}") }
231     else
232       at_path { git_with_identity('checkout', '--force', revision) }
233     end
234   end
235
236   def reset(desired)
237     at_path do
238       git_with_identity('reset', '--hard', desired)
239     end
240   end
241
242   def update_submodules
243     at_path do
244       git_with_identity('submodule', 'update', '--init', '--recursive')
245     end
246   end
247
248   def remote_branch_revision?(revision = @resource.value(:revision))
249     # git < 1.6 returns '#{@resource.value(:remote)}/#{revision}'
250     # git 1.6+ returns 'remotes/#{@resource.value(:remote)}/#{revision}'
251     branch = at_path { branches.grep /(remotes\/)?#{@resource.value(:remote)}\/#{revision}/ }
252     branch unless branch.empty?
253   end
254
255   def local_branch_revision?(revision = @resource.value(:revision))
256     at_path { branches.include?(revision) }
257   end
258
259   def tag_revision?(revision = @resource.value(:revision))
260     at_path { tags.include?(revision) }
261   end
262
263   def branches
264     at_path { git_with_identity('branch', '-a') }.gsub('*', ' ').split(/\n/).map { |line| line.strip }
265   end
266
267   def on_branch?
268     at_path {
269       matches = git_with_identity('branch', '-a').match /\*\s+(.*)/
270       matches[1] unless matches[1].match /detached/
271     }
272   end
273
274   def detached?
275     at_path {
276       git_with_identity('branch', '-a').match /\*\s+\(detached from.*\)/
277     }
278   end
279
280   def tags
281     at_path { git_with_identity('tag', '-l') }.split(/\n/).map { |line| line.strip }
282   end
283
284   def set_excludes
285     at_path { open('.git/info/exclude', 'w') { |f| @resource.value(:excludes).each { |ex| f.write(ex + "\n") }}}
286   end
287
288   def get_revision(rev)
289     if @resource.value(:force) && working_copy_exists?
290       create
291     end
292     if !working_copy_exists?
293       create
294     end
295     at_path do
296       update_remote_origin_url
297       git_with_identity('fetch', @resource.value(:remote))
298       git_with_identity('fetch', '--tags', @resource.value(:remote))
299     end
300     current = at_path { git_with_identity('rev-parse', rev).strip }
301     if @resource.value(:revision)
302       if local_branch_revision?
303         canonical = at_path { git_with_identity('rev-parse', @resource.value(:revision)).strip }
304       elsif remote_branch_revision?
305         canonical = at_path { git_with_identity('rev-parse', "#{@resource.value(:remote)}/" + @resource.value(:revision)).strip }
306       end
307       current = @resource.value(:revision) if current == canonical
308     end
309     update_owner_and_excludes
310     return current
311   end
312
313   def update_owner_and_excludes
314     if @resource.value(:owner) or @resource.value(:group)
315       set_ownership
316     end
317     if @resource.value(:excludes)
318       set_excludes
319     end
320   end
321
322   def git_with_identity(*args)
323     if @resource.value(:identity)
324       Tempfile.open('git-helper') do |f|
325         f.puts '#!/bin/sh'
326         f.puts "exec ssh -oStrictHostKeyChecking=no -oPasswordAuthentication=no -oKbdInteractiveAuthentication=no -oChallengeResponseAuthentication=no -oConnectTimeout=120 -i #{@resource.value(:identity)} $*"
327         f.close
328
329         FileUtils.chmod(0755, f.path)
330         env_save = ENV['GIT_SSH']
331         ENV['GIT_SSH'] = f.path
332
333         ret = git(*args)
334
335         ENV['GIT_SSH'] = env_save
336
337         return ret
338       end
339     elsif @resource.value(:user) and @resource.value(:user) != Facter['id'].value
340       su(@resource.value(:user), '-c', "git #{args.join(' ')}" )
341     else
342       git(*args)
343     end
344   end
345 end