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