-
Notifications
You must be signed in to change notification settings - Fork 5.3k
/
test_case.rb
1537 lines (1198 loc) · 39.5 KB
/
test_case.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# frozen_string_literal: true
require 'rubygems'
# If bundler gemspec exists, add to stubs
bundler_gemspec = File.expand_path("../../../bundler/bundler.gemspec", __FILE__)
if File.exist?(bundler_gemspec)
Gem::Specification.dirs.unshift File.dirname(bundler_gemspec)
Gem::Specification.class_variable_set :@@stubs, nil
Gem::Specification.stubs
Gem::Specification.dirs.shift
end
begin
gem 'minitest', '~> 5.0'
rescue Gem::LoadError
end
begin
require 'simplecov'
SimpleCov.start do
add_filter "/test/"
add_filter "/bundler/"
add_filter "/lib/rubygems/resolver/molinillo"
end
rescue LoadError
end
require 'bundler'
require 'minitest/autorun'
require 'rubygems/deprecate'
require 'fileutils'
require 'pathname'
require 'pp'
require 'rubygems/package'
require 'shellwords'
require 'tmpdir'
require 'uri'
require 'zlib'
require 'benchmark' # stdlib
require 'rubygems/mock_gem_ui'
module Gem
##
# Allows setting the gem path searcher. This method is available when
# requiring 'rubygems/test_case'
def self.searcher=(searcher)
@searcher = searcher
end
##
# Allows toggling Windows behavior. This method is available when requiring
# 'rubygems/test_case'
def self.win_platform=(val)
@@win_platform = val
end
##
# Allows setting path to Ruby. This method is available when requiring
# 'rubygems/test_case'
def self.ruby=(ruby)
@ruby = ruby
end
##
# When rubygems/test_case is required the default user interaction is a
# MockGemUi.
module DefaultUserInteraction
@ui = Gem::MockGemUi.new
end
end
##
# RubyGemTestCase provides a variety of methods for testing rubygems and
# gem-related behavior in a sandbox. Through RubyGemTestCase you can install
# and uninstall gems, fetch remote gems through a stub fetcher and be assured
# your normal set of gems is not affected.
class Gem::TestCase < (defined?(Minitest::Test) ? Minitest::Test : MiniTest::Unit::TestCase)
extend Gem::Deprecate
attr_accessor :fetcher # :nodoc:
attr_accessor :gem_repo # :nodoc:
attr_accessor :uri # :nodoc:
TEST_PATH = ENV.fetch('RUBYGEMS_TEST_PATH', File.expand_path('../../../test/rubygems', __FILE__))
def assert_activate(expected, *specs)
specs.each do |spec|
case spec
when String then
Gem::Specification.find_by_name(spec).activate
when Gem::Specification then
spec.activate
else
flunk spec.inspect
end
end
loaded = Gem.loaded_specs.values.map(&:full_name)
assert_equal expected.sort, loaded.sort if expected
end
# TODO: move to minitest
def assert_path_exists(path, msg = nil)
msg = message(msg) { "Expected path '#{path}' to exist" }
assert File.exist?(path), msg
end
def assert_directory_exists(path, msg = nil)
msg = message(msg) { "Expected path '#{path}' to be a directory" }
assert_path_exists path
assert File.directory?(path), msg
end
##
# Sets the ENABLE_SHARED entry in RbConfig::CONFIG to +value+ and restores
# the original value when the block ends
def enable_shared(value)
enable_shared = RbConfig::CONFIG['ENABLE_SHARED']
RbConfig::CONFIG['ENABLE_SHARED'] = value
yield
ensure
if enable_shared
RbConfig::CONFIG['enable_shared'] = enable_shared
else
RbConfig::CONFIG.delete 'enable_shared'
end
end
##
# Sets the vendordir entry in RbConfig::CONFIG to +value+ and restores the
# original value when the block ends
#
def vendordir(value)
vendordir = RbConfig::CONFIG['vendordir']
if value
RbConfig::CONFIG['vendordir'] = value
else
RbConfig::CONFIG.delete 'vendordir'
end
yield
ensure
if vendordir
RbConfig::CONFIG['vendordir'] = vendordir
else
RbConfig::CONFIG.delete 'vendordir'
end
end
##
# Sets the bindir entry in RbConfig::CONFIG to +value+ and restores the
# original value when the block ends
#
def bindir(value)
bindir = RbConfig::CONFIG['bindir']
if value
RbConfig::CONFIG['bindir'] = value
else
RbConfig::CONFIG.delete 'bindir'
end
yield
ensure
if bindir
RbConfig::CONFIG['bindir'] = bindir
else
RbConfig::CONFIG.delete 'bindir'
end
end
##
# Sets the EXEEXT entry in RbConfig::CONFIG to +value+ and restores the
# original value when the block ends
#
def exeext(value)
exeext = RbConfig::CONFIG['EXEEXT']
if value
RbConfig::CONFIG['EXEEXT'] = value
else
RbConfig::CONFIG.delete 'EXEEXT'
end
yield
ensure
if exeext
RbConfig::CONFIG['EXEEXT'] = exeext
else
RbConfig::CONFIG.delete 'EXEEXT'
end
end
# TODO: move to minitest
def refute_path_exists(path, msg = nil)
msg = message(msg) { "Expected path '#{path}' to not exist" }
refute File.exist?(path), msg
end
def scan_make_command_lines(output)
output.scan(/^#{Regexp.escape make_command}(?:[[:blank:]].*)?$/)
end
def parse_make_command_line(line)
command, *args = line.shellsplit
targets = []
macros = {}
args.each do |arg|
case arg
when /\A(\w+)=/
macros[$1] = $'
else
targets << arg
end
end
targets << '' if targets.empty?
{
:command => command,
:targets => targets,
:macros => macros,
}
end
def assert_contains_make_command(target, output, msg = nil)
if output.match(/\n/)
msg = message(msg) do
'Expected output containing make command "%s": %s' % [
('%s %s' % [make_command, target]).rstrip,
output.inspect
]
end
else
msg = message(msg) do
'Expected make command "%s": %s' % [
('%s %s' % [make_command, target]).rstrip,
output.inspect
]
end
end
assert scan_make_command_lines(output).any? { |line|
make = parse_make_command_line(line)
if make[:targets].include?(target)
yield make, line if block_given?
true
else
false
end
}, msg
end
include Gem::DefaultUserInteraction
undef_method :default_test if instance_methods.include? 'default_test' or
instance_methods.include? :default_test
##
# #setup prepares a sandboxed location to install gems. All installs are
# directed to a temporary directory. All install plugins are removed.
#
# If the +RUBY+ environment variable is set the given path is used for
# Gem::ruby. The local platform is set to <tt>i386-mswin32</tt> for Windows
# or <tt>i686-darwin8.10.1</tt> otherwise.
def setup
super
@orig_env = ENV.to_hash
ENV['GEM_VENDOR'] = nil
ENV['GEMRC'] = nil
ENV['SOURCE_DATE_EPOCH'] = nil
@current_dir = Dir.pwd
@fetcher = nil
@back_ui = Gem::DefaultUserInteraction.ui
@ui = Gem::MockGemUi.new
# This needs to be a new instance since we call use_ui(@ui) when we want to
# capture output
Gem::DefaultUserInteraction.ui = Gem::MockGemUi.new
tmpdir = File.realpath Dir.tmpdir
tmpdir.tap(&Gem::UNTAINT)
@tempdir = File.join(tmpdir, "test_rubygems_#{$$}")
@tempdir.tap(&Gem::UNTAINT)
FileUtils.mkdir_p @tempdir
# This makes the tempdir consistent on Windows.
# Dir.tmpdir may return short path name, but Dir[Dir.tmpdir] returns long
# path name. https://bugs.ruby-lang.org/issues/10819
# File.expand_path or File.realpath doesn't convert path name to long path
# name. Only Dir[] (= Dir.glob) works.
# Short and long path name is specific to Windows filesystem.
if win_platform?
@tempdir = Dir[@tempdir][0]
@tempdir.tap(&Gem::UNTAINT)
end
@gemhome = File.join @tempdir, 'gemhome'
@userhome = File.join @tempdir, 'userhome'
ENV["GEM_SPEC_CACHE"] = File.join @tempdir, 'spec_cache'
@orig_ruby = if ENV['RUBY']
ruby = Gem.ruby
Gem.ruby = ENV['RUBY']
ruby
end
@git = ENV['GIT'] || 'git'
Gem.ensure_gem_subdirectories @gemhome
@orig_LOAD_PATH = $LOAD_PATH.dup
$LOAD_PATH.map! do |s|
expand_path = File.realpath(s) rescue File.expand_path(s)
if expand_path != s
expand_path.tap(&Gem::UNTAINT)
if s.instance_variable_defined?(:@gem_prelude_index)
expand_path.instance_variable_set(:@gem_prelude_index, expand_path)
end
expand_path.freeze if s.frozen?
s = expand_path
end
s
end
Dir.chdir @tempdir
ENV['HOME'] = @userhome
Gem.instance_variable_set :@user_home, nil
Gem.instance_variable_set :@gemdeps, nil
Gem.instance_variable_set :@env_requirements_by_name, nil
Gem.send :remove_instance_variable, :@ruby_version if
Gem.instance_variables.include? :@ruby_version
FileUtils.mkdir_p @gemhome
FileUtils.mkdir_p @userhome
ENV['GEM_PRIVATE_KEY_PASSPHRASE'] = PRIVATE_KEY_PASSPHRASE
@default_dir = File.join @tempdir, 'default'
@default_spec_dir = File.join @default_dir, "specifications", "default"
if Gem.java_platform?
@orig_default_gem_home = RbConfig::CONFIG['default_gem_home']
RbConfig::CONFIG['default_gem_home'] = @default_dir
else
Gem.instance_variable_set(:@default_dir, @default_dir)
end
FileUtils.mkdir_p @default_spec_dir
Gem::Specification.unresolved_deps.clear
Gem.use_paths(@gemhome)
Gem::Security.reset
Gem.loaded_specs.clear
Gem.clear_default_specs
Bundler.reset!
Gem.configuration.verbose = true
Gem.configuration.update_sources = true
Gem::RemoteFetcher.fetcher = Gem::FakeFetcher.new
@gem_repo = "http://gems.example.com/"
@uri = URI.parse @gem_repo
Gem.sources.replace [@gem_repo]
Gem.searcher = nil
Gem::SpecFetcher.fetcher = nil
@orig_arch = RbConfig::CONFIG['arch']
if win_platform?
util_set_arch 'i386-mswin32'
else
util_set_arch 'i686-darwin8.10.1'
end
@orig_hooks = {}
%w[post_install_hooks done_installing_hooks post_uninstall_hooks pre_uninstall_hooks pre_install_hooks pre_reset_hooks post_reset_hooks post_build_hooks].each do |name|
@orig_hooks[name] = Gem.send(name).dup
end
@marshal_version = "#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}"
@orig_LOADED_FEATURES = $LOADED_FEATURES.dup
end
##
# #teardown restores the process to its original state and removes the
# tempdir
def teardown
$LOAD_PATH.replace @orig_LOAD_PATH if @orig_LOAD_PATH
if @orig_LOADED_FEATURES
if @orig_LOAD_PATH
paths = @orig_LOAD_PATH.map {|path| File.join(File.expand_path(path), "/")}
($LOADED_FEATURES - @orig_LOADED_FEATURES).each do |feat|
unless paths.any? {|path| feat.start_with?(path)}
$LOADED_FEATURES.delete(feat)
end
end
else
$LOADED_FEATURES.replace @orig_LOADED_FEATURES
end
end
RbConfig::CONFIG['arch'] = @orig_arch
if defined? Gem::RemoteFetcher
Gem::RemoteFetcher.fetcher = nil
end
Dir.chdir @current_dir
FileUtils.rm_rf @tempdir
ENV.replace(@orig_env)
Gem.ruby = @orig_ruby if @orig_ruby
if Gem.java_platform?
RbConfig::CONFIG['default_gem_home'] = @orig_default_gem_home
else
Gem.instance_variable_set :@default_dir, nil
end
Gem::Specification._clear_load_cache
Gem::Specification.unresolved_deps.clear
Gem::refresh
@orig_hooks.each do |name, hooks|
Gem.send(name).replace hooks
end
@back_ui.close
end
def common_installer_setup
common_installer_teardown
Gem.post_build do |installer|
@post_build_hook_arg = installer
true
end
Gem.post_install do |installer|
@post_install_hook_arg = installer
end
Gem.post_uninstall do |uninstaller|
@post_uninstall_hook_arg = uninstaller
end
Gem.pre_install do |installer|
@pre_install_hook_arg = installer
true
end
Gem.pre_uninstall do |uninstaller|
@pre_uninstall_hook_arg = uninstaller
end
end
def common_installer_teardown
Gem.post_build_hooks.clear
Gem.post_install_hooks.clear
Gem.done_installing_hooks.clear
Gem.post_reset_hooks.clear
Gem.post_uninstall_hooks.clear
Gem.pre_install_hooks.clear
Gem.pre_reset_hooks.clear
Gem.pre_uninstall_hooks.clear
end
##
# A git_gem is used with a gem dependencies file. The gem created here
# has no files, just a gem specification for the given +name+ and +version+.
#
# Yields the +specification+ to the block, if given
def git_gem(name = 'a', version = 1)
have_git?
directory = File.join 'git', name
directory = File.expand_path directory
git_spec = Gem::Specification.new name, version do |specification|
yield specification if block_given?
end
FileUtils.mkdir_p directory
gemspec = "#{name}.gemspec"
File.open File.join(directory, gemspec), 'w' do |io|
io.write git_spec.to_ruby
end
head = nil
Dir.chdir directory do
unless File.exist? '.git'
system @git, 'init', '--quiet'
system @git, 'config', 'user.name', 'RubyGems Tests'
system @git, 'config', 'user.email', 'rubygems@example'
end
system @git, 'add', gemspec
system @git, 'commit', '-a', '-m', 'a non-empty commit message', '--quiet'
head = Gem::Util.popen(@git, 'rev-parse', 'master').strip
end
return name, git_spec.version, directory, head
end
##
# Skips this test unless you have a git executable
def have_git?
return if in_path? @git
skip 'cannot find git executable, use GIT environment variable to set'
end
def in_path?(executable) # :nodoc:
return true if %r%\A([A-Z]:|/)% =~ executable and File.exist? executable
ENV['PATH'].split(File::PATH_SEPARATOR).any? do |directory|
File.exist? File.join directory, executable
end
end
##
# Builds and installs the Gem::Specification +spec+
def install_gem(spec, options = {})
require 'rubygems/installer'
gem = File.join @tempdir, "gems", "#{spec.full_name}.gem"
unless File.exist? gem
use_ui Gem::MockGemUi.new do
Dir.chdir @tempdir do
Gem::Package.build spec
end
end
gem = File.join(@tempdir, File.basename(spec.cache_file)).tap(&Gem::UNTAINT)
end
Gem::Installer.at(gem, options.merge({:wrappers => true})).install
end
##
# Builds and installs the Gem::Specification +spec+ into the user dir
def install_gem_user(spec)
install_gem spec, :user_install => true
end
##
# Uninstalls the Gem::Specification +spec+
def uninstall_gem(spec)
require 'rubygems/uninstaller'
Class.new(Gem::Uninstaller) do
def ask_if_ok(spec)
true
end
end.new(spec.name, :executables => true, :user_install => true).uninstall
end
##
# Enables pretty-print for all tests
def mu_pp(obj)
s = String.new
s = PP.pp obj, s
s = s.force_encoding(Encoding.default_external)
s.chomp
end
##
# Reads a Marshal file at +path+
def read_cache(path)
File.open path.dup.tap(&Gem::UNTAINT), 'rb' do |io|
Marshal.load io.read
end
end
##
# Reads a binary file at +path+
def read_binary(path)
Gem.read_binary path
end
##
# Writes a binary file to +path+ which is relative to +@gemhome+
def write_file(path)
path = File.join @gemhome, path unless Pathname.new(path).absolute?
dir = File.dirname path
FileUtils.mkdir_p dir unless File.directory? dir
File.open path, 'wb' do |io|
yield io if block_given?
end
path
end
def all_spec_names
Gem::Specification.map(&:full_name)
end
##
# Creates a Gem::Specification with a minimum of extra work. +name+ and
# +version+ are the gem's name and version, platform, author, email,
# homepage, summary and description are defaulted. The specification is
# yielded for customization.
#
# The gem is added to the installed gems in +@gemhome+ and the runtime.
#
# Use this with #write_file to build an installed gem.
def quick_gem(name, version='2')
require 'rubygems/specification'
spec = Gem::Specification.new do |s|
s.platform = Gem::Platform::RUBY
s.name = name
s.version = version
s.author = 'A User'
s.email = 'example@example.com'
s.homepage = 'http://example.com'
s.summary = "this is a summary"
s.description = "This is a test description"
yield(s) if block_given?
end
Gem::Specification.map # HACK: force specs to (re-)load before we write
written_path = write_file spec.spec_file do |io|
io.write spec.to_ruby_for_cache
end
spec.loaded_from = written_path
Gem::Specification.reset
return spec
end
##
# Builds a gem from +spec+ and places it in <tt>File.join @gemhome,
# 'cache'</tt>. Automatically creates files based on +spec.files+
def util_build_gem(spec)
dir = spec.gem_dir
FileUtils.mkdir_p dir
Dir.chdir dir do
spec.files.each do |file|
next if File.exist? file
FileUtils.mkdir_p File.dirname(file)
File.open file, 'w' do |fp|
fp.puts "# #{file}"
end
end
use_ui Gem::MockGemUi.new do
Gem::Package.build spec
end
cache = spec.cache_file
FileUtils.mv File.basename(cache), cache
end
end
def util_remove_gem(spec)
FileUtils.rm_rf spec.cache_file
FileUtils.rm_rf spec.spec_file
end
##
# Removes all installed gems from +@gemhome+.
def util_clear_gems
FileUtils.rm_rf File.join(@gemhome, "gems")
FileUtils.mkdir File.join(@gemhome, "gems")
FileUtils.rm_rf File.join(@gemhome, "specifications")
FileUtils.mkdir File.join(@gemhome, "specifications")
Gem::Specification.reset
end
##
# Install the provided specs
def install_specs(*specs)
specs.each do |spec|
Gem::Installer.for_spec(spec).install
end
Gem.searcher = nil
end
##
# Installs the provided default specs including writing the spec file
def install_default_gems(*specs)
install_default_specs(*specs)
specs.each do |spec|
File.open spec.loaded_from, 'w' do |io|
io.write spec.to_ruby_for_cache
end
end
end
##
# Install the provided default specs
def install_default_specs(*specs)
specs.each do |spec|
installer = Gem::Installer.for_spec(spec, :install_as_default => true)
installer.install
Gem.register_default_spec(spec)
end
end
def loaded_spec_names
Gem.loaded_specs.values.map(&:full_name).sort
end
def unresolved_names
Gem::Specification.unresolved_deps.values.map(&:to_s).sort
end
def save_loaded_features
old_loaded_features = $LOADED_FEATURES.dup
yield
ensure
prefix = File.dirname(__FILE__) + "/"
new_features = ($LOADED_FEATURES - old_loaded_features)
old_loaded_features.concat(new_features.select {|f| f.rindex(prefix, 0)})
$LOADED_FEATURES.replace old_loaded_features
end
def new_default_spec(name, version, deps = nil, *files)
spec = util_spec name, version, deps
spec.loaded_from = File.join(@default_spec_dir, spec.spec_name)
spec.files = files
lib_dir = File.join(@tempdir, "default_gems", "lib")
lib_dir.instance_variable_set(:@gem_prelude_index, lib_dir)
$LOAD_PATH.unshift(lib_dir)
files.each do |file|
rb_path = File.join(lib_dir, file)
FileUtils.mkdir_p(File.dirname(rb_path))
File.open(rb_path, "w") do |rb|
rb << "# #{file}"
end
end
spec
end
##
# Creates a spec with +name+, +version+. +deps+ can specify the dependency
# or a +block+ can be given for full customization of the specification.
def util_spec(name, version = 2, deps = nil, *files) # :yields: specification
raise "deps or block, not both" if deps and block_given?
spec = Gem::Specification.new do |s|
s.platform = Gem::Platform::RUBY
s.name = name
s.version = version
s.author = 'A User'
s.email = 'example@example.com'
s.homepage = 'http://example.com'
s.summary = "this is a summary"
s.description = "This is a test description"
s.files.push(*files) unless files.empty?
yield s if block_given?
end
if deps
# Since Hash#each is unordered in 1.8, sort the keys and iterate that
# way so the tests are deterministic on all implementations.
deps.keys.sort.each do |n|
spec.add_dependency n, (deps[n] || '>= 0')
end
end
unless files.empty?
write_file spec.spec_file do |io|
io.write spec.to_ruby_for_cache
end
util_build_gem spec
cache_file = File.join @tempdir, 'gems', "#{spec.full_name}.gem"
FileUtils.mkdir_p File.dirname cache_file
FileUtils.mv spec.cache_file, cache_file
FileUtils.rm spec.spec_file
end
return spec
end
##
# Creates a gem with +name+, +version+ and +deps+. The specification will
# be yielded before gem creation for customization. The gem will be placed
# in <tt>File.join @tempdir, 'gems'</tt>. The specification and .gem file
# location are returned.
def util_gem(name, version, deps = nil, &block)
if deps
block = proc do |s|
# Since Hash#each is unordered in 1.8, sort
# the keys and iterate that way so the tests are
# deterministic on all implementations.
deps.keys.sort.each do |n|
s.add_dependency n, (deps[n] || '>= 0')
end
end
end
spec = quick_gem(name, version, &block)
util_build_gem spec
cache_file = File.join @tempdir, 'gems', "#{spec.original_name}.gem"
FileUtils.mkdir_p File.dirname cache_file
FileUtils.mv spec.cache_file, cache_file
FileUtils.rm spec.spec_file
spec.loaded_from = nil
[spec, cache_file]
end
##
# Gzips +data+.
def util_gzip(data)
out = StringIO.new
Zlib::GzipWriter.wrap out do |io|
io.write data
end
out.string
end
##
# Creates several default gems which all have a lib/code.rb file. The gems
# are not installed but are available in the cache dir.
#
# +@a1+:: gem a version 1, this is the best-described gem.
# +@a2+:: gem a version 2
# +@a3a:: gem a version 3.a
# +@a_evil9+:: gem a_evil version 9, use this to ensure similarly-named gems
# don't collide with a.
# +@b2+:: gem b version 2
# +@c1_2+:: gem c version 1.2
# +@pl1+:: gem pl version 1, this gem has a legacy platform of i386-linux.
#
# Additional +prerelease+ gems may also be created:
#
# +@a2_pre+:: gem a version 2.a
# TODO: nuke this and fix tests. this should speed up a lot
def util_make_gems(prerelease = false)
@a1 = quick_gem 'a', '1' do |s|
s.files = %w[lib/code.rb]
s.require_paths = %w[lib]
s.date = Gem::Specification::TODAY - 86400
s.homepage = 'http://a.example.com'
s.email = %w[example@example.com example2@example.com]
s.authors = %w[Example Example2]
s.description = <<-DESC
This line is really, really long. So long, in fact, that it is more than eighty characters long! The purpose of this line is for testing wrapping behavior because sometimes people don't wrap their text to eighty characters. Without the wrapping, the text might not look good in the RSS feed.
Also, a list:
* An entry that\'s actually kind of sort
* an entry that\'s really long, which will probably get wrapped funny. That's ok, somebody wasn't thinking straight when they made it more than eighty characters.
DESC
end
init = proc do |s|
s.files = %w[lib/code.rb]
s.require_paths = %w[lib]
end
@a2 = quick_gem('a', '2', &init)
@a3a = quick_gem('a', '3.a', &init)
@a_evil9 = quick_gem('a_evil', '9', &init)
@b2 = quick_gem('b', '2', &init)
@c1_2 = quick_gem('c', '1.2', &init)
@x = quick_gem('x', '1', &init)
@dep_x = quick_gem('dep_x', '1') do |s|
s.files = %w[lib/code.rb]
s.require_paths = %w[lib]
s.add_dependency 'x', '>= 1'
end
@pl1 = quick_gem 'pl', '1' do |s| # l for legacy
s.files = %w[lib/code.rb]
s.require_paths = %w[lib]
s.platform = Gem::Platform.new 'i386-linux'
s.instance_variable_set :@original_platform, 'i386-linux'
end
if prerelease
@a2_pre = quick_gem('a', '2.a', &init)
write_file File.join(*%W[gems #{@a2_pre.original_name} lib code.rb])
util_build_gem @a2_pre
end
write_file File.join(*%W[gems #{@a1.original_name} lib code.rb])
write_file File.join(*%W[gems #{@a2.original_name} lib code.rb])
write_file File.join(*%W[gems #{@a3a.original_name} lib code.rb])
write_file File.join(*%W[gems #{@a_evil9.original_name} lib code.rb])
write_file File.join(*%W[gems #{@b2.original_name} lib code.rb])
write_file File.join(*%W[gems #{@c1_2.original_name} lib code.rb])
write_file File.join(*%W[gems #{@pl1.original_name} lib code.rb])
write_file File.join(*%W[gems #{@x.original_name} lib code.rb])
write_file File.join(*%W[gems #{@dep_x.original_name} lib code.rb])
[@a1, @a2, @a3a, @a_evil9, @b2, @c1_2, @pl1, @x, @dep_x].each do |spec|
util_build_gem spec
end
FileUtils.rm_r File.join(@gemhome, "gems", @pl1.original_name)
end
##
# Set the platform to +arch+
def util_set_arch(arch)
RbConfig::CONFIG['arch'] = arch
platform = Gem::Platform.new arch
Gem.instance_variable_set :@platforms, nil
Gem::Platform.instance_variable_set :@local, nil
yield if block_given?
platform
end
##
# Add +spec+ to +@fetcher+ serving the data in the file +path+.
# +repo+ indicates which repo to make +spec+ appear to be in.
def add_to_fetcher(spec, path=nil, repo=@gem_repo)
path ||= spec.cache_file
@fetcher.data["#{@gem_repo}gems/#{spec.file_name}"] = read_binary(path)
end
##
# Sets up Gem::SpecFetcher to return information from the gems in +specs+.
def util_setup_spec_fetcher(*specs)
all_specs = Gem::Specification.to_a + specs