Merge pull request #185 from cmurphy/master
[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       it "should warn about destroying it using force and noop attribute" do
179         resource[:force] = true
180         resource[:noop] = true
181         resource.delete(:revision)
182         provider.expects(:working_copy_exists?).returns(true)
183
184         provider.expects(:destroy).never
185         provider.expects(:create).never
186         Puppet::Type::Vcsrepo::Ensure.any_instance.expects(:send_log).with(:notice, "Noop Mode - Would have deleted repository and re-created from latest")
187         provider.resource.retrieve
188       end
189       it "should warn about destroying it using force and global noop" do
190         resource[:force] = true
191         Puppet[:noop] = true
192         resource.delete(:revision)
193         provider.expects(:working_copy_exists?).returns(true)
194
195         provider.expects(:destroy).never
196         provider.expects(:create).never
197         Puppet::Type::Vcsrepo::Ensure.any_instance.expects(:send_log).with(:notice, "Noop Mode - Would have deleted repository and re-created from latest")
198         provider.resource.retrieve
199       end
200     end
201
202     context "when the path is not empty and not a repository" do
203       it "should raise an exception" do
204         provider.expects(:path_exists?).returns(true)
205         provider.expects(:path_empty?).returns(false)
206         provider.expects(:working_copy_exists?).returns(false)
207         proc { provider.create }.should raise_error(Puppet::Error)
208       end
209     end
210   end
211
212
213   context 'destroying' do
214     it "it should remove the directory" do
215       #expects_rm_rf
216       provider.destroy
217     end
218   end
219
220   context "checking the revision property" do
221     before do
222       expects_chdir('/tmp/test')
223       resource[:revision] = 'currentsha'
224       resource.delete(:source)
225       provider.expects(:git).with('rev-parse', 'HEAD').returns('currentsha')
226     end
227
228     context "when its SHA is not different than the current SHA" do
229       it "should return the ref" 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('rev-parse', '--revs-only', resource.value(:revision)).returns('currentsha')
234         provider.expects(:git).with('tag', '-l').returns("Hello")
235         provider.revision.should == resource.value(:revision)
236       end
237     end
238
239     context "when its SHA is different than the current SHA" do
240       it "should return the current SHA" do
241         provider.expects(:git).with('config', 'remote.origin.url').returns('')
242         provider.expects(:git).with('fetch', 'origin') # FIXME
243         provider.expects(:git).with('fetch', '--tags', 'origin')
244         provider.expects(:git).with('rev-parse', '--revs-only', resource.value(:revision)).returns('othersha')
245         provider.expects(:git).with('tag', '-l').returns("Hello")
246         provider.revision.should == 'currentsha'
247       end
248     end
249
250     context "when its a ref to a remote head" do
251       it "should return the revision" do
252         provider.expects(:git).with('config', 'remote.origin.url').returns('')
253         provider.expects(:git).with('fetch', 'origin') # FIXME
254         provider.expects(:git).with('fetch', '--tags', 'origin')
255         provider.expects(:git).with('tag', '-l').returns("Hello")
256         provider.expects(:git).with('rev-parse', '--revs-only', resource.value(:revision)).returns('')
257         provider.expects(:git).with('ls-remote', '--heads', '--tags', 'origin', resource.value(:revision)).returns("newsha refs/heads/#{resource.value(:revision)}")
258         provider.revision.should == 'currentsha'
259       end
260     end
261
262     context "when its a ref to non existant remote head" do
263       it "should fail" do
264         provider.expects(:git).with('config', 'remote.origin.url').returns('')
265         provider.expects(:git).with('fetch', 'origin') # FIXME
266         provider.expects(:git).with('fetch', '--tags', 'origin')
267         provider.expects(:git).with('tag', '-l').returns("Hello")
268         provider.expects(:git).with('rev-parse', '--revs-only', resource.value(:revision)).returns('')
269         provider.expects(:git).with('ls-remote', '--heads', '--tags', 'origin', resource.value(:revision)).returns('')
270         expect { provider.revision }.to raise_error(Puppet::Error, /not a local or remote ref$/)
271       end
272     end
273
274     context "when the source is modified" do
275       it "should update the origin url" do
276         resource[:source] = 'git://git@foo.com/bar.git'
277         provider.expects(:git).with('config', 'remote.origin.url').returns('old')
278         provider.expects(:git).with('config', 'remote.origin.url', 'git://git@foo.com/bar.git')
279         provider.expects(:git).with('fetch', 'origin') # FIXME
280         provider.expects(:git).with('fetch', '--tags', 'origin')
281         provider.expects(:git).with('rev-parse', '--revs-only', resource.value(:revision)).returns('currentsha')
282         provider.expects(:git).with('tag', '-l').returns("Hello")
283         provider.revision.should == resource.value(:revision)
284       end
285     end
286   end
287
288   context "setting the revision property" do
289     before do
290       expects_chdir
291     end
292     context "when it's an existing local branch" do
293       it "should use 'git fetch' and 'git reset'" do
294         resource[:revision] = 'feature/foo'
295         provider.expects(:update_submodules)
296         provider.expects(:git).with('branch', '-a').at_least_once.returns(branch_a_list(resource.value(:revision)))
297         provider.expects(:git).with('checkout', '--force', resource.value(:revision))
298         provider.expects(:git).with('reset', '--hard', "origin/#{resource.value(:revision)}")
299         provider.revision = resource.value(:revision)
300       end
301     end
302     context "when it's a remote branch" do
303       it "should use 'git fetch' and 'git reset'" do
304         resource[:revision] = 'only/remote'
305         provider.expects(:update_submodules)
306         provider.expects(:git).with('branch', '-a').at_least_once.returns(resource.value(:revision))
307         provider.expects(:git).with('checkout', '--force', resource.value(:revision))
308         provider.expects(:git).with('reset', '--hard', "origin/#{resource.value(:revision)}")
309         provider.revision = resource.value(:revision)
310       end
311     end
312     context "when it's a commit or tag" do
313       it "should use 'git fetch' and 'git reset'" do
314         resource[:revision] = 'a-commit-or-tag'
315         provider.expects(:git).with('branch', '-a').at_least_once.returns(fixture(:git_branch_a))
316         provider.expects(:git).with('checkout', '--force', resource.value(:revision))
317         provider.expects(:git).with('branch', '-a').returns(fixture(:git_branch_a))
318         provider.expects(:git).with('branch', '-a').returns(fixture(:git_branch_a))
319         provider.expects(:git).with('submodule', 'update', '--init', '--recursive')
320         provider.revision = resource.value(:revision)
321       end
322     end
323   end
324
325   context "updating references" do
326     it "should use 'git fetch --tags'" do
327       resource.delete(:source)
328       expects_chdir
329       provider.expects(:git).with('config', 'remote.origin.url').returns('')
330       provider.expects(:git).with('fetch', 'origin')
331       provider.expects(:git).with('fetch', '--tags', 'origin')
332       provider.update_references
333     end
334   end
335
336   context "checking if revision" do
337     before do
338       expects_chdir
339       provider.expects(:git).with('branch', '-a').returns(fixture(:git_branch_a))
340     end
341     context "is a local branch" do
342       context "when it's listed in 'git branch -a'" do
343         it "should return true" do
344           resource[:revision] = 'feature/foo'
345           provider.should be_local_branch_revision
346         end
347       end
348       context "when it's not listed in 'git branch -a'" do
349         it "should return false" do
350           resource[:revision] = 'feature/notexist'
351           provider.should_not be_local_branch_revision
352         end
353       end
354     end
355     context "is a remote branch" do
356       context "when it's listed in 'git branch -a' with an 'origin/' prefix" do
357         it "should return true" do
358           resource[:revision] = 'only/remote'
359           provider.should be_remote_branch_revision
360         end
361       end
362       context "when it's not listed in 'git branch -a' with an 'origin/' prefix" do
363         it "should return false" do
364           resource[:revision] = 'only/local'
365           provider.should_not be_remote_branch_revision
366         end
367       end
368     end
369   end
370
371   context "retrieving the current revision" do
372     before do
373       expects_chdir
374       provider.expects(:git).with('branch','-a').returns("* foo")
375     end
376
377     it "will strip trailing newlines" do
378       provider.expects(:get_revision).with('origin/foo')
379       provider.latest
380     end
381   end
382
383   describe 'latest?' do
384     before do
385       expects_chdir('/tmp/test')
386     end
387     context 'when true' do
388       it do
389         provider.expects(:revision).returns('testrev')
390         provider.expects(:latest).returns('testrev')
391         provider.latest?.should be_true
392       end
393     end
394     context 'when false' do
395       it do
396         provider.expects(:revision).returns('master')
397         provider.expects(:latest).returns('testrev')
398         provider.latest?.should be_false
399       end
400     end
401   end
402
403   describe 'latest' do
404     before do
405       provider.expects(:get_revision).returns('master')
406       expects_chdir
407     end
408     context 'on master' do
409       it do
410         provider.expects(:git).with('branch','-a').returns("* master")
411         provider.latest.should == 'master'
412       end
413     end
414     context 'no branch' do
415       it do
416         provider.expects(:git).with('branch','-a').returns("* master")
417
418         provider.latest.should == 'master'
419       end
420     end
421     context 'feature/bar' do
422       it do
423         provider.expects(:git).with('branch','-a').returns("* master")
424         provider.latest.should == 'master'
425       end
426     end
427   end
428
429   describe 'convert_working_copy_to_bare' do
430     it do
431       FileUtils.expects(:mv).returns(true)
432       FileUtils.expects(:rm_rf).returns(true)
433       FileUtils.expects(:mv).returns(true)
434
435       provider.instance_eval { convert_working_copy_to_bare }
436     end
437   end
438
439     describe 'convert_bare_to_working_copy' do
440     it do
441       FileUtils.expects(:mv).returns(true)
442       FileUtils.expects(:mkdir).returns(true)
443       FileUtils.expects(:mv).returns(true)
444       provider.expects(:commits_in?).returns(true)
445       # If you forget to stub these out you lose 3 hours of rspec work.
446       provider.expects(:reset).with('HEAD').returns(true)
447       provider.expects(:git_with_identity).returns(true)
448       provider.expects(:update_owner_and_excludes).returns(true)
449
450       provider.instance_eval { convert_bare_to_working_copy }
451     end
452   end
453
454 end