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