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