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