Add submodules feature to git provider
[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   commands :git => 'git'
7
8   has_features :bare_repositories, :reference_tracking, :ssh_identity, :multiple_remotes, :user, :depth, :submodules
9
10   def create
11     if @resource.value(:revision) and @resource.value(:ensure) == :bare
12       fail("Cannot set a revision (#{@resource.value(:revision)}) on a bare repository")
13     end
14     if !@resource.value(:source)
15       init_repository(@resource.value(:path))
16     else
17       clone_repository(@resource.value(:source), @resource.value(:path))
18       if @resource.value(:revision)
19         checkout
20       end
21       if @resource.value(:ensure) != :bare && @resource.value(:submodules) == :true
22         update_submodules
23       end
24     end
25     update_owner_and_excludes
26   end
27
28   def destroy
29     FileUtils.rm_rf(@resource.value(:path))
30   end
31
32   # Checks to see if the current revision is equal to the revision on the
33   # remote (whether on a branch, tag, or reference)
34   #
35   # @return [Boolean] Returns true if the repo is on the latest revision
36   def latest?
37     return revision == latest_revision
38   end
39
40   # Just gives the `should` value that we should be setting the repo to if
41   # latest? returns false
42   #
43   # @return [String] Returns the target sha/tag/branch
44   def latest
45     @resource.value(:revision)
46   end
47
48   # Get the current revision of the repo (tag/branch/sha)
49   #
50   # @return [String] Returns the branch/tag if the current sha matches the
51   #                  remote; otherwise returns the current sha.
52   def revision
53     #HEAD is the default, but lets just be explicit here.
54     get_revision('HEAD')
55   end
56
57   # Is passed the desired reference, whether a tag, rev, or branch. Should
58   # handle transitions from a rev/branch/tag to a rev/branch/tag. Detached
59   # heads should be treated like bare revisions.
60   #
61   # @param [String] desired The desired revision to which the repo should be
62   #                         set.
63   def revision=(desired)
64     #just checkout tags and shas; fetch has already happened so they should be updated.
65     checkout(desired)
66     #branches require more work.
67     if local_branch_revision?(desired)
68       #reset instead of pull to avoid merge conflicts. assuming remote is
69       #updated and authoritative.
70       #TODO might be worthwhile to have an allow_local_changes param to decide
71       #whether to reset or pull when we're ensuring latest.
72       at_path { git_with_identity('reset', '--hard', "#{@resource.value(:remote)}/#{desired}") }
73     end
74     #TODO Would this ever reach here if it is bare?
75     if @resource.value(:ensure) != :bare
76       update_submodules
77     end
78     update_owner_and_excludes
79   end
80
81   def bare_exists?
82     bare_git_config_exists? && !working_copy_exists?
83   end
84
85   def working_copy_exists?
86     File.directory?(File.join(@resource.value(:path), '.git'))
87   end
88
89   def exists?
90     working_copy_exists? || bare_exists?
91   end
92
93   def update_remote_origin_url
94     current = git_with_identity('config', "remote.#{@resource.value(:remote)}.url")
95     unless @resource.value(:source).nil?
96       if current.nil? or current.strip != @resource.value(:source)
97         git_with_identity('config', "remote.#{@resource.value(:remote)}.url", @resource.value(:source))
98       end
99     end
100   end
101
102   def update_references
103     at_path do
104       update_remote_origin_url
105       git_with_identity('fetch', @resource.value(:remote))
106       git_with_identity('fetch', '--tags', @resource.value(:remote))
107       update_owner_and_excludes
108     end
109   end
110
111   private
112
113   # @!visibility private
114   def bare_git_config_exists?
115     File.exist?(File.join(@resource.value(:path), 'config'))
116   end
117
118   # @!visibility private
119   def clone_repository(source, path)
120     check_force
121     args = ['clone']
122     if @resource.value(:depth) and @resource.value(:depth).to_i > 0
123       args.push('--depth', @resource.value(:depth).to_s)
124     end
125     if @resource.value(:ensure) == :bare
126       args << '--bare'
127     end
128     if @resource.value(:remote) != 'origin'
129       args.push('--origin', @resource.value(:remote))
130     end
131     if !working_copy_exists?
132       args.push(source, path)
133       Dir.chdir("/") do
134         git_with_identity(*args)
135       end
136     else
137       notice "Repo has already been cloned"
138     end
139   end
140
141   # @!visibility private
142   def check_force
143     if path_exists? and not path_empty?
144       if @resource.value(:force)
145         notice "Removing %s to replace with vcsrepo." % @resource.value(:path)
146         destroy
147       else
148         raise Puppet::Error, "Could not create repository (non-repository at path)"
149       end
150     end
151   end
152
153   # @!visibility private
154   def init_repository(path)
155     check_force
156     if @resource.value(:ensure) == :bare && working_copy_exists?
157       convert_working_copy_to_bare
158     elsif @resource.value(:ensure) == :present && bare_exists?
159       convert_bare_to_working_copy
160     else
161       # normal init
162       FileUtils.mkdir(@resource.value(:path))
163       FileUtils.chown(@resource.value(:user), nil, @resource.value(:path)) if @resource.value(:user)
164       args = ['init']
165       if @resource.value(:ensure) == :bare
166         args << '--bare'
167       end
168       at_path do
169         git_with_identity(*args)
170       end
171     end
172   end
173
174   # Convert working copy to bare
175   #
176   # Moves:
177   #   <path>/.git
178   # to:
179   #   <path>/
180   # @!visibility private
181   def convert_working_copy_to_bare
182     notice "Converting working copy repository to bare repository"
183     FileUtils.mv(File.join(@resource.value(:path), '.git'), tempdir)
184     FileUtils.rm_rf(@resource.value(:path))
185     FileUtils.mv(tempdir, @resource.value(:path))
186   end
187
188   # Convert bare to working copy
189   #
190   # Moves:
191   #   <path>/
192   # to:
193   #   <path>/.git
194   # @!visibility private
195   def convert_bare_to_working_copy
196     notice "Converting bare repository to working copy repository"
197     FileUtils.mv(@resource.value(:path), tempdir)
198     FileUtils.mkdir(@resource.value(:path))
199     FileUtils.mv(tempdir, File.join(@resource.value(:path), '.git'))
200     if commits_in?(File.join(@resource.value(:path), '.git'))
201       reset('HEAD')
202       git_with_identity('checkout', '--force')
203       update_owner_and_excludes
204     end
205   end
206
207   # @!visibility private
208   def commits_in?(dot_git)
209     Dir.glob(File.join(dot_git, 'objects/info/*'), File::FNM_DOTMATCH) do |e|
210       return true unless %w(. ..).include?(File::basename(e))
211     end
212     false
213   end
214
215   # Will checkout a rev/branch/tag using the locally cached versions. Does not
216   # handle upstream branch changes
217   # @!visibility private
218   def checkout(revision = @resource.value(:revision))
219     if !local_branch_revision? && remote_branch_revision?
220       #non-locally existant branches (perhaps switching to a branch that has never been checked out)
221       at_path { git_with_identity('checkout', '--force', '-b', revision, '--track', "#{@resource.value(:remote)}/#{revision}") }
222     else
223       #tags, locally existant branches (perhaps outdated), and shas
224       at_path { git_with_identity('checkout', '--force', revision) }
225     end
226   end
227
228   # @!visibility private
229   def reset(desired)
230     at_path do
231       git_with_identity('reset', '--hard', desired)
232     end
233   end
234
235   # @!visibility private
236   def update_submodules
237     at_path do
238       git_with_identity('submodule', 'update', '--init', '--recursive')
239     end
240   end
241
242   # Determins if the branch exists at the upstream but has not yet been locally committed
243   # @!visibility private
244   def remote_branch_revision?(revision = @resource.value(:revision))
245     # git < 1.6 returns '#{@resource.value(:remote)}/#{revision}'
246     # git 1.6+ returns 'remotes/#{@resource.value(:remote)}/#{revision}'
247     branch = at_path { branches.grep /(remotes\/)?#{@resource.value(:remote)}\/#{revision}/ }
248     branch unless branch.empty?
249   end
250
251   # Determins if the branch is already cached locally
252   # @!visibility private
253   def local_branch_revision?(revision = @resource.value(:revision))
254     at_path { branches.include?(revision) }
255   end
256
257   # @!visibility private
258   def tag_revision?(revision = @resource.value(:revision))
259     at_path { tags.include?(revision) }
260   end
261
262   # @!visibility private
263   def branches
264     at_path { git_with_identity('branch', '-a') }.gsub('*', ' ').split(/\n/).map { |line| line.strip }
265   end
266
267   # @!visibility private
268   def on_branch?
269     at_path {
270       matches = git_with_identity('branch', '-a').match /\*\s+(.*)/
271       matches[1] unless matches[1].match /(\(detached from|\(no branch)/
272     }
273   end
274
275   # @!visibility private
276   def tags
277     at_path { git_with_identity('tag', '-l') }.split(/\n/).map { |line| line.strip }
278   end
279
280   # @!visibility private
281   def set_excludes
282     # Excludes may be an Array or a String.
283     at_path do
284       open('.git/info/exclude', 'w') do |f|
285         if @resource.value(:excludes).respond_to?(:each)
286           @resource.value(:excludes).each { |ex| f.puts ex }
287         else
288           f.puts @resource.value(:excludes)
289         end
290       end
291     end
292   end
293
294   # Finds the latest revision or sha of the current branch if on a branch, or
295   # of HEAD otherwise.
296   # @note Calls create which can forcibly destroy and re-clone the repo if
297   #       force => true
298   # @see get_revision
299   #
300   # @!visibility private
301   # @return [String] Returns the output of get_revision
302   def latest_revision
303     #TODO Why is create called here anyway?
304     create if @resource.value(:force) && working_copy_exists?
305     create if !working_copy_exists?
306
307     if branch = on_branch?
308       return get_revision("#{@resource.value(:remote)}/#{branch}")
309     else
310       return get_revision
311     end
312   end
313
314   # Returns the current revision given if the revision is a tag or branch and
315   # matches the current sha. If the current sha does not match the sha of a tag
316   # or branch, then it will just return the sha (ie, is not in sync)
317   #
318   # @!visibility private
319   #
320   # @param [String] rev The revision of which to check if it is current
321   # @return [String] Returns the tag/branch of the current repo if it's up to
322   #                  date; otherwise returns the sha of the requested revision.
323   def get_revision(rev = 'HEAD')
324     update_references
325     current = at_path { git_with_identity('rev-parse', rev).strip }
326     if @resource.value(:revision)
327       if tag_revision?
328         # git-rev-parse will give you the hash of the tag object itself rather
329         # than the commit it points to by default. Using tag^0 will return the
330         # actual commit.
331         canonical = at_path { git_with_identity('rev-parse', "#{@resource.value(:revision)}^0").strip }
332       elsif local_branch_revision?
333         canonical = at_path { git_with_identity('rev-parse', @resource.value(:revision)).strip }
334       elsif remote_branch_revision?
335         canonical = at_path { git_with_identity('rev-parse', "#{@resource.value(:remote)}/#{@resource.value(:revision)}").strip }
336       else
337         #look for a sha (could match invalid shas)
338         canonical = at_path { git_with_identity('rev-parse', '--revs-only', @resource.value(:revision)).strip }
339       end
340       fail("#{@resource.value(:revision)} is not a local or remote ref") if canonical.nil? or canonical.empty?
341       current = @resource.value(:revision) if current == canonical
342     end
343     return current
344   end
345
346   # @!visibility private
347   def update_owner_and_excludes
348     if @resource.value(:owner) or @resource.value(:group)
349       set_ownership
350     end
351     if @resource.value(:excludes)
352       set_excludes
353     end
354   end
355
356   # @!visibility private
357   def git_with_identity(*args)
358     if @resource.value(:identity)
359       Tempfile.open('git-helper') do |f|
360         f.puts '#!/bin/sh'
361         f.puts "exec ssh -oStrictHostKeyChecking=no -oPasswordAuthentication=no -oKbdInteractiveAuthentication=no -oChallengeResponseAuthentication=no -oConnectTimeout=120 -i #{@resource.value(:identity)} $*"
362         f.close
363
364         FileUtils.chmod(0755, f.path)
365         env_save = ENV['GIT_SSH']
366         ENV['GIT_SSH'] = f.path
367
368         ret = git(*args)
369
370         ENV['GIT_SSH'] = env_save
371
372         return ret
373       end
374     elsif @resource.value(:user) and @resource.value(:user) != Facter['id'].value
375       Puppet::Util::Execution.execute("git #{args.join(' ')}", :uid => @resource.value(:user), :failonfail => true)
376     else
377       git(*args)
378     end
379   end
380 end