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