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