Allow non-root users to clone a repo
[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
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 == 'master'
43       return get_revision("#{@resource.value(:remote)}/HEAD")
44     elsif branch == '(no branch)'
45       return get_revision('HEAD')
46     else
47       return get_revision("#{@resource.value(:remote)}/%s" % branch)
48     end
49   end
50
51   def revision
52     update_references
53     current = at_path { git_with_identity('rev-parse', 'HEAD').chomp }
54     return current unless @resource.value(:revision)
55
56     if tag_revision?(@resource.value(:revision))
57       canonical = at_path { git_with_identity('show', @resource.value(:revision)).scan(/commit (.*)/).to_s }
58     else
59       canonical = at_path { git_with_identity('rev-parse', @resource.value(:revision)).chomp }
60     end
61
62     if current == canonical
63       @resource.value(:revision)
64     else
65       current
66     end
67   end
68
69   def revision=(desired)
70     checkout(desired)
71     if local_branch_revision?(desired)
72       # reset instead of pull to avoid merge conflicts. assuming remote is
73       # authoritative.
74       # might be worthwhile to have an allow_local_changes param to decide
75       # whether to reset or pull when we're ensuring latest.
76       at_path { git_with_identity('reset', '--hard', "#{@resource.value(:remote)}/#{desired}") }
77     end
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   def working_copy_exists?
89     File.directory?(File.join(@resource.value(:path), '.git'))
90   end
91
92   def exists?
93     working_copy_exists? || bare_exists?
94   end
95
96   def update_references
97     at_path do
98       git_with_identity('fetch', @resource.value(:remote))
99       git_with_identity('fetch', '--tags', @resource.value(:remote))
100       update_owner_and_excludes
101     end
102   end
103
104   private
105
106   def bare_git_config_exists?
107     File.exist?(File.join(@resource.value(:path), 'config'))
108   end
109
110   def clone_repository(source, path)
111     check_force
112     args = ['clone']
113     if @resource.value(:ensure) == :bare
114       args << '--bare'
115     end
116     if !File.exist?(File.join(@resource.value(:path), '.git'))
117       args.push(source, path)
118       Dir.chdir("/") do
119         git_with_identity(*args)
120       end
121     else
122       notice "Repo has already been cloned"
123     end
124   end
125
126   def check_force
127     if path_exists?
128       if @resource.value(:force)
129         notice "Removing %s to replace with vcsrepo." % @resource.value(:path)
130         destroy
131       else
132         raise Puppet::Error, "Could not create repository (non-repository at path)"
133       end
134     end
135   end
136
137   def init_repository(path)
138     check_force
139     if @resource.value(:ensure) == :bare && working_copy_exists?
140       convert_working_copy_to_bare
141     elsif @resource.value(:ensure) == :present && bare_exists?
142       convert_bare_to_working_copy
143     else
144       # normal init
145       FileUtils.mkdir(@resource.value(:path))
146       FileUtils.chown(@resource.value(:user), nil, @resource.value(:path)) if @resource.value(:user)
147       args = ['init']
148       if @resource.value(:ensure) == :bare
149         args << '--bare'
150       end
151       at_path do
152         git_with_identity(*args)
153       end
154     end
155   end
156
157   # Convert working copy to bare
158   #
159   # Moves:
160   #   <path>/.git
161   # to:
162   #   <path>/
163   def convert_working_copy_to_bare
164     notice "Converting working copy repository to bare repository"
165     FileUtils.mv(File.join(@resource.value(:path), '.git'), tempdir)
166     FileUtils.rm_rf(@resource.value(:path))
167     FileUtils.mv(tempdir, @resource.value(:path))
168   end
169
170   # Convert bare to working copy
171   #
172   # Moves:
173   #   <path>/
174   # to:
175   #   <path>/.git
176   def convert_bare_to_working_copy
177     notice "Converting bare repository to working copy repository"
178     FileUtils.mv(@resource.value(:path), tempdir)
179     FileUtils.mkdir(@resource.value(:path))
180     FileUtils.mv(tempdir, File.join(@resource.value(:path), '.git'))
181     if commits_in?(File.join(@resource.value(:path), '.git'))
182       reset('HEAD')
183       git_with_identity('checkout', '-f')
184       update_owner_and_excludes
185     end
186   end
187
188   def commits_in?(dot_git)
189     Dir.glob(File.join(dot_git, 'objects/info/*'), File::FNM_DOTMATCH) do |e|
190       return true unless %w(. ..).include?(File::basename(e))
191     end
192     false
193   end
194
195   def checkout(revision = @resource.value(:revision))
196     if !local_branch_revision? && remote_branch_revision?
197       at_path { git_with_identity('checkout', '-b', revision, '--track', "#{@resource.value(:remote)}/#{revision}") }
198     else
199       at_path { git_with_identity('checkout', '--force', revision) }
200     end
201   end
202
203   def reset(desired)
204     at_path do
205       git_with_identity('reset', '--hard', desired)
206     end
207   end
208
209   def update_submodules
210     at_path do
211       git_with_identity('submodule', 'init')
212       git_with_identity('submodule', 'update')
213       git_with_identity('submodule', 'foreach', 'git', 'submodule', 'init')
214       git_with_identity('submodule', 'foreach', 'git', 'submodule', 'update')
215     end
216   end
217
218   def remote_branch_revision?(revision = @resource.value(:revision))
219     # git < 1.6 returns '#{@resource.value(:remote)}/#{revision}'
220     # git 1.6+ returns 'remotes/#{@resource.value(:remote)}/#{revision}'
221     branch = at_path { branches.grep /(remotes\/)?#{@resource.value(:remote)}\/#{revision}/ }
222     if branch.length > 0
223       return branch
224     end
225   end
226
227   def local_branch_revision?(revision = @resource.value(:revision))
228     at_path { branches.include?(revision) }
229   end
230
231   def tag_revision?(revision = @resource.value(:revision))
232     at_path { tags.include?(revision) }
233   end
234
235   def branches
236     at_path { git_with_identity('branch', '-a') }.gsub('*', ' ').split(/\n/).map { |line| line.strip }
237   end
238
239   def on_branch?
240     at_path { git_with_identity('branch', '-a') }.split(/\n/).grep(/\*/).first.to_s.gsub('*', '').strip
241   end
242
243   def tags
244     at_path { git_with_identity('tag', '-l') }.split(/\n/).map { |line| line.strip }
245   end
246
247   def set_excludes
248     at_path { open('.git/info/exclude', 'w') { |f| @resource.value(:excludes).each { |ex| f.write(ex + "\n") }}}
249   end
250
251   def get_revision(rev)
252     if !working_copy_exists?
253       create
254     end
255     at_path do
256       git_with_identity('fetch', @resource.value(:remote))
257       git_with_identity('fetch', '--tags', @resource.value(:remote))
258     end
259     current = at_path { git_with_identity('rev-parse', rev).strip }
260     if @resource.value(:revision)
261       if local_branch_revision?
262         canonical = at_path { git_with_identity('rev-parse', @resource.value(:revision)).strip }
263       elsif remote_branch_revision?
264         canonical = at_path { git_with_identity('rev-parse', "#{@resource.value(:remote)}/" + @resource.value(:revision)).strip }
265       end
266       current = @resource.value(:revision) if current == canonical
267     end
268     update_owner_and_excludes
269     return current
270   end
271
272   def update_owner_and_excludes
273     if @resource.value(:owner) or @resource.value(:group)
274       set_ownership
275     end
276     if @resource.value(:excludes)
277       set_excludes
278     end
279   end
280
281   def git_with_identity(*args)
282     if @resource.value(:identity)
283       Tempfile.open('git-helper') do |f|
284         f.puts '#!/bin/sh'
285         f.puts "exec ssh -oStrictHostKeyChecking=no -oPasswordAuthentication=no -oKbdInteractiveAuthentication=no -oChallengeResponseAuthentication=no -i #{@resource.value(:identity)} $*"
286         f.close
287
288         FileUtils.chmod(0755, f.path)
289         env_save = ENV['GIT_SSH']
290         ENV['GIT_SSH'] = f.path
291
292         ret = git(*args)
293
294         ENV['GIT_SSH'] = env_save
295
296         return ret
297       end
298     elsif @resource.value(:user)
299       su(@resource.value(:user), '-c', "git #{args.join(' ')}" )
300     else
301       git(*args)
302     end
303   end
304 end