Update specs and fix FM-1361
[puppet_vcsrepo.git] / spec / unit / puppet / provider / vcsrepo / git_spec.rb
1 require 'spec_helper'
2
3 describe Puppet::Type.type(:vcsrepo).provider(:git_provider) do
4   def branch_a_list(include_branch)
5     <<branches
6 end
7 #{"*  master" unless  include_branch.nil?}
8 #{"*  " + include_branch unless !include_branch}
9    remote/origin/master
10    remote/origin/foo
11
12 branches
13     end
14   let(:resource) { Puppet::Type.type(:vcsrepo).new({
15     :name     => 'test',
16     :ensure   => :present,
17     :provider => :git,
18     :revision => '2634',
19     :source   => 'git@repo',
20     :path     => '/tmp/test',
21     :force    => false
22   })}
23
24   let(:provider) { resource.provider }
25
26   before :each do
27     Puppet::Util.stubs(:which).with('git').returns('/usr/bin/git')
28   end
29
30   context 'creating' do
31     context "with a revision that is a remote branch" do
32       it "should execute 'git clone' and 'git checkout -b'" do
33         resource[:revision] = 'only/remote'
34         Dir.expects(:chdir).with('/').at_least_once.yields
35         Dir.expects(:chdir).with('/tmp/test').at_least_once.yields
36         provider.expects(:git).with('clone', resource.value(:source), resource.value(:path))
37         provider.expects(:update_submodules)
38         provider.expects(:git).with('branch', '-a').returns(branch_a_list(resource.value(:revision)))
39         provider.expects(:git).with('checkout', '--force', resource.value(:revision))
40         provider.create
41       end
42     end
43
44     context "with a remote not named 'origin'" do
45       it "should execute 'git clone --origin not_origin" do
46         resource[:remote] = 'not_origin'
47         Dir.expects(:chdir).with('/').at_least_once.yields
48         Dir.expects(:chdir).with('/tmp/test').at_least_once.yields
49         provider.expects(:git).with('clone', '--origin', 'not_origin', resource.value(:source), resource.value(:path))
50         provider.expects(:update_submodules)
51         provider.expects(:git).with('branch', '-a').returns(branch_a_list(resource.value(:revision)))
52         provider.expects(:git).with('checkout', '--force', resource.value(:revision))
53         provider.create
54       end
55     end
56
57     context "with shallow clone enable" do
58       it "should execute 'git clone --depth 1'" do
59         resource[:revision] = 'only/remote'
60         resource[:depth] = 1
61         Dir.expects(:chdir).with('/').at_least_once.yields
62         Dir.expects(:chdir).with('/tmp/test').at_least_once.yields
63         provider.expects(:git).with('clone', '--depth', '1', resource.value(:source), resource.value(:path))
64         provider.expects(:update_submodules)
65         provider.expects(:git).with('branch', '-a').returns(branch_a_list(resource.value(:revision)))
66         provider.expects(:git).with('checkout', '--force', resource.value(:revision))
67         provider.create
68       end
69     end
70
71     context "with a revision that is not a remote branch" do
72       it "should execute 'git clone' and 'git reset --hard'" do
73         resource[:revision] = 'a-commit-or-tag'
74         Dir.expects(:chdir).with('/').at_least_once.yields
75         Dir.expects(:chdir).with('/tmp/test').at_least_once.yields
76         provider.expects(:git).with('clone', resource.value(:source), resource.value(:path))
77         provider.expects(:update_submodules)
78         provider.expects(:git).with('branch', '-a').returns(branch_a_list(resource.value(:revision)))
79         provider.expects(:git).with('checkout', '--force', resource.value(:revision))
80         provider.create
81       end
82
83       it "should execute 'git clone' and submodule commands" do
84         resource.delete(:revision)
85         provider.expects(:git).with('clone', resource.value(:source), resource.value(:path))
86         provider.expects(:update_submodules)
87         provider.create
88       end
89     end
90
91     context "with an ensure of bare" do
92       context "with revision" do
93         it "should raise an error" do
94           resource[:ensure] = :bare
95           expect { provider.create }.to raise_error Puppet::Error, /cannot set a revision.+bare/i
96         end
97       end
98       context "without revision" do
99         it "should just execute 'git clone --bare'" do
100           resource[:ensure] = :bare
101           resource.delete(:revision)
102           provider.expects(:git).with('clone', '--bare', resource.value(:source), resource.value(:path))
103           provider.create
104         end
105       end
106     end
107
108     context "when a source is not given" do
109       context "when the path does not exist" do
110         it "should execute 'git init'" do
111           resource[:ensure] = :present
112           resource.delete(:source)
113           expects_mkdir
114           expects_chdir
115           expects_directory?(false)
116
117           provider.expects(:bare_exists?).returns(false)
118           provider.expects(:git).with('init')
119           provider.create
120         end
121       end
122
123       context "when the path is a bare repository" do
124         it "should convert it to a working copy" do
125           resource[:ensure] = :present
126           resource.delete(:source)
127           provider.expects(:bare_exists?).returns(true)
128           provider.expects(:convert_bare_to_working_copy)
129           provider.create
130         end
131       end
132
133       context "when the path is not empty and not a repository" do
134         it "should raise an exception" do
135           provider.expects(:path_exists?).returns(true)
136           provider.expects(:path_empty?).returns(false)
137           proc { provider.create }.should raise_error(Puppet::Error)
138         end
139       end
140     end
141
142     context "when the path does not exist" do
143       it "should execute 'git init --bare'" do
144         resource[:ensure] = :bare
145         resource.delete(:source)
146         resource.delete(:revision)
147         expects_chdir
148         expects_mkdir
149         expects_directory?(false)
150         provider.expects(:working_copy_exists?).returns(false)
151         provider.expects(:git).with('init', '--bare')
152         provider.create
153       end
154     end
155
156     context "when the path is a working copy repository" do
157       it "should convert it to a bare repository" do
158         resource[:ensure] = :bare
159         resource.delete(:source)
160         resource.delete(:revision)
161         provider.expects(:working_copy_exists?).returns(true)
162         provider.expects(:convert_working_copy_to_bare)
163         provider.create
164       end
165       it "should clone overtop it using force" do
166         resource[:force] = true
167         Dir.expects(:chdir).with('/').at_least_once.yields
168         Dir.expects(:chdir).with('/tmp/test').at_least_once.yields
169         provider.expects(:path_exists?).returns(true)
170         provider.expects(:path_empty?).returns(false)
171         provider.destroy
172         provider.expects(:git).with('clone',resource.value(:source), resource.value(:path))
173         provider.expects(:update_submodules)
174         provider.expects(:git).with('branch', '-a').returns(branch_a_list(resource.value(:revision)))
175         provider.expects(:git).with('checkout', '--force', resource.value(:revision))
176         provider.create
177       end
178     end
179
180     context "when the path is not empty and not a repository" do
181       it "should raise an exception" do
182         provider.expects(:path_exists?).returns(true)
183         provider.expects(:path_empty?).returns(false)
184         provider.expects(:working_copy_exists?).returns(false)
185         proc { provider.create }.should raise_error(Puppet::Error)
186       end
187     end
188   end
189
190
191   context 'destroying' do
192     it "it should remove the directory" do
193       #expects_rm_rf
194       provider.destroy
195     end
196   end
197
198   context "checking the revision property" do
199     before do
200       expects_chdir('/tmp/test')
201       resource[:revision] = 'currentsha'
202       resource.delete(:source)
203       provider.expects(:git).with('rev-parse', 'HEAD').returns('currentsha')
204     end
205
206     context "when its SHA is not different than the current SHA" do
207       it "should return the ref" do
208         provider.expects(:git).with('config', 'remote.origin.url').returns('')
209         provider.expects(:git).with('fetch', 'origin') # FIXME
210         provider.expects(:git).with('fetch', '--tags', 'origin')
211         provider.expects(:git).with('rev-parse', '--revs-only', resource.value(:revision)).returns('currentsha')
212         provider.expects(:git).with('tag', '-l').returns("Hello")
213         provider.revision.should == resource.value(:revision)
214       end
215     end
216
217     context "when its SHA is different than the current SHA" do
218       it "should return the current SHA" do
219         provider.expects(:git).with('config', 'remote.origin.url').returns('')
220         provider.expects(:git).with('fetch', 'origin') # FIXME
221         provider.expects(:git).with('fetch', '--tags', 'origin')
222         provider.expects(:git).with('rev-parse', '--revs-only', resource.value(:revision)).returns('othersha')
223         provider.expects(:git).with('tag', '-l').returns("Hello")
224         provider.revision.should == 'currentsha'
225       end
226     end
227
228     context "when its a ref to a remote head" do
229       it "should return the revision" do
230         provider.expects(:git).with('config', 'remote.origin.url').returns('')
231         provider.expects(:git).with('fetch', 'origin') # FIXME
232         provider.expects(:git).with('fetch', '--tags', 'origin')
233         provider.expects(:git).with('tag', '-l').returns("Hello")
234         provider.expects(:git).with('rev-parse', '--revs-only', resource.value(:revision)).returns('')
235         provider.expects(:git).with('ls-remote', '--heads', '--tags', 'origin', resource.value(:revision)).returns("newsha refs/heads/#{resource.value(:revision)}")
236         provider.revision.should == 'currentsha'
237       end
238     end
239
240     context "when its a ref to non existant remote head" do
241       it "should fail" do
242         provider.expects(:git).with('config', 'remote.origin.url').returns('')
243         provider.expects(:git).with('fetch', 'origin') # FIXME
244         provider.expects(:git).with('fetch', '--tags', 'origin')
245         provider.expects(:git).with('tag', '-l').returns("Hello")
246         provider.expects(:git).with('rev-parse', '--revs-only', resource.value(:revision)).returns('')
247         provider.expects(:git).with('ls-remote', '--heads', '--tags', 'origin', resource.value(:revision)).returns('')
248         expect { provider.revision }.to raise_error(Puppet::Error, /not a local or remote ref$/)
249       end
250     end
251
252     context "when the source is modified" do
253       it "should update the origin url" do
254         resource[:source] = 'git://git@foo.com/bar.git'
255         provider.expects(:git).with('config', 'remote.origin.url').returns('old')
256         provider.expects(:git).with('config', 'remote.origin.url', 'git://git@foo.com/bar.git')
257         provider.expects(:git).with('fetch', 'origin') # FIXME
258         provider.expects(:git).with('fetch', '--tags', 'origin')
259         provider.expects(:git).with('rev-parse', '--revs-only', resource.value(:revision)).returns('currentsha')
260         provider.expects(:git).with('tag', '-l').returns("Hello")
261         provider.revision.should == resource.value(:revision)
262       end
263     end
264   end
265
266   context "setting the revision property" do
267     before do
268       expects_chdir
269     end
270     context "when it's an existing local branch" do
271       it "should use 'git fetch' and 'git reset'" do
272         resource[:revision] = 'feature/foo'
273         provider.expects(:update_submodules)
274         provider.expects(:git).with('branch', '-a').at_least_once.returns(branch_a_list(resource.value(:revision)))
275         provider.expects(:git).with('checkout', '--force', resource.value(:revision))
276         provider.expects(:git).with('reset', '--hard', "origin/#{resource.value(:revision)}")
277         provider.revision = resource.value(:revision)
278       end
279     end
280     context "when it's a remote branch" do
281       it "should use 'git fetch' and 'git reset'" do
282         resource[:revision] = 'only/remote'
283         provider.expects(:update_submodules)
284         provider.expects(:git).with('branch', '-a').at_least_once.returns(resource.value(:revision))
285         provider.expects(:git).with('checkout', '--force', resource.value(:revision))
286         provider.expects(:git).with('reset', '--hard', "origin/#{resource.value(:revision)}")
287         provider.revision = resource.value(:revision)
288       end
289     end
290     context "when it's a commit or tag" do
291       it "should use 'git fetch' and 'git reset'" do
292         resource[:revision] = 'a-commit-or-tag'
293         provider.expects(:git).with('branch', '-a').at_least_once.returns(fixture(:git_branch_a))
294         provider.expects(:git).with('checkout', '--force', resource.value(:revision))
295         provider.expects(:git).with('branch', '-a').returns(fixture(:git_branch_a))
296         provider.expects(:git).with('branch', '-a').returns(fixture(:git_branch_a))
297         provider.expects(:git).with('submodule', 'update', '--init', '--recursive')
298         provider.revision = resource.value(:revision)
299       end
300     end
301   end
302
303   context "updating references" do
304     it "should use 'git fetch --tags'" do
305       resource.delete(:source)
306       expects_chdir
307       provider.expects(:git).with('config', 'remote.origin.url').returns('')
308       provider.expects(:git).with('fetch', 'origin')
309       provider.expects(:git).with('fetch', '--tags', 'origin')
310       provider.update_references
311     end
312   end
313
314   context "checking if revision" do
315     before do
316       expects_chdir
317       provider.expects(:git).with('branch', '-a').returns(fixture(:git_branch_a))
318     end
319     context "is a local branch" do
320       context "when it's listed in 'git branch -a'" do
321         it "should return true" do
322           resource[:revision] = 'feature/foo'
323           provider.should be_local_branch_revision
324         end
325       end
326       context "when it's not listed in 'git branch -a'" do
327         it "should return false" do
328           resource[:revision] = 'feature/notexist'
329           provider.should_not be_local_branch_revision
330         end
331       end
332     end
333     context "is a remote branch" do
334       context "when it's listed in 'git branch -a' with an 'origin/' prefix" do
335         it "should return true" do
336           resource[:revision] = 'only/remote'
337           provider.should be_remote_branch_revision
338         end
339       end
340       context "when it's not listed in 'git branch -a' with an 'origin/' prefix" do
341         it "should return false" do
342           resource[:revision] = 'only/local'
343           provider.should_not be_remote_branch_revision
344         end
345       end
346     end
347   end
348
349   context "retrieving the current revision" do
350     before do
351       expects_chdir
352       provider.expects(:git).with('branch','-a').returns("* foo")
353     end
354
355     it "will strip trailing newlines" do
356       provider.expects(:get_revision).with('origin/foo')
357       provider.latest
358     end
359   end
360
361   describe 'latest?' do
362     before do
363       expects_chdir('/tmp/test')
364     end
365     context 'when true' do
366       it do
367         provider.expects(:revision).returns('testrev')
368         provider.expects(:latest).returns('testrev')
369         provider.latest?.should be_true
370       end
371     end
372     context 'when false' do
373       it do
374         provider.expects(:revision).returns('master')
375         provider.expects(:latest).returns('testrev')
376         provider.latest?.should be_false
377       end
378     end
379   end
380
381   describe 'latest' do
382     before do
383       provider.expects(:get_revision).returns('master')
384       expects_chdir
385     end
386     context 'on master' do
387       it do
388         provider.expects(:git).with('branch','-a').returns("* master")
389         provider.latest.should == 'master'
390       end
391     end
392     context 'no branch' do
393       it do
394         provider.expects(:git).with('branch','-a').returns("* master")
395
396         provider.latest.should == 'master'
397       end
398     end
399     context 'feature/bar' do
400       it do
401         provider.expects(:git).with('branch','-a').returns("* master")
402         provider.latest.should == 'master'
403       end
404     end
405   end
406
407   describe 'convert_working_copy_to_bare' do
408     it do
409       FileUtils.expects(:mv).returns(true)
410       FileUtils.expects(:rm_rf).returns(true)
411       FileUtils.expects(:mv).returns(true)
412
413       provider.instance_eval { convert_working_copy_to_bare }
414     end
415   end
416
417     describe 'convert_bare_to_working_copy' do
418     it do
419       FileUtils.expects(:mv).returns(true)
420       FileUtils.expects(:mkdir).returns(true)
421       FileUtils.expects(:mv).returns(true)
422       provider.expects(:commits_in?).returns(true)
423       # If you forget to stub these out you lose 3 hours of rspec work.
424       provider.expects(:reset).with('HEAD').returns(true)
425       provider.expects(:git_with_identity).returns(true)
426       provider.expects(:update_owner_and_excludes).returns(true)
427
428       provider.instance_eval { convert_bare_to_working_copy }
429     end
430   end
431
432 end