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