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