/
tc_zoneinfo_data_source.rb
1574 lines (1268 loc) · 59.8 KB
/
tc_zoneinfo_data_source.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
# encoding: UTF-8
# frozen_string_literal: true
require_relative '../test_utils'
require 'fileutils'
require 'pathname'
require 'tmpdir'
module DataSources
class TCZoneinfoDataSource < Minitest::Test
include TZInfo
include TZInfo::DataSources
ZONEINFO_DIR = File.expand_path(File.join(File.dirname(__FILE__), '..', 'zoneinfo'))
RubyCoreSupport.untaint(ZONEINFO_DIR)
def setup
@orig_search_path = ZoneinfoDataSource.search_path.clone
@orig_alternate_iso3166_tab_search_path = ZoneinfoDataSource.alternate_iso3166_tab_search_path.clone
@orig_pwd = FileUtils.pwd
# A zoneinfo directory containing files needed by the tests.
# The symlinks in this directory are set up in test_utils.rb.
@data_source = ZoneinfoDataSource.new(ZONEINFO_DIR)
end
def teardown
ZoneinfoDataSource.search_path = @orig_search_path
ZoneinfoDataSource.alternate_iso3166_tab_search_path = @orig_alternate_iso3166_tab_search_path
FileUtils.chdir(@orig_pwd)
end
def test_default_search_path
assert_equal(['/usr/share/zoneinfo', '/usr/share/lib/zoneinfo', '/etc/zoneinfo'], ZoneinfoDataSource.search_path)
assert_equal(false, ZoneinfoDataSource.search_path.frozen?)
end
def test_set_search_path_default
ZoneinfoDataSource.search_path = ['/tmp/zoneinfo1', '/tmp/zoneinfo2']
assert_equal(['/tmp/zoneinfo1', '/tmp/zoneinfo2'], ZoneinfoDataSource.search_path)
ZoneinfoDataSource.search_path = nil
assert_equal(['/usr/share/zoneinfo', '/usr/share/lib/zoneinfo', '/etc/zoneinfo'], ZoneinfoDataSource.search_path)
assert_equal(false, ZoneinfoDataSource.search_path.frozen?)
end
def test_set_search_path_array
path = ['/tmp/zoneinfo1', '/tmp/zoneinfo2']
ZoneinfoDataSource.search_path = path
assert_equal(['/tmp/zoneinfo1', '/tmp/zoneinfo2'], ZoneinfoDataSource.search_path)
refute_same(path, ZoneinfoDataSource.search_path)
end
def test_set_search_path_array_to_s
ZoneinfoDataSource.search_path = [Pathname.new('/tmp/zoneinfo3')]
assert_equal(['/tmp/zoneinfo3'], ZoneinfoDataSource.search_path)
end
def test_set_search_path_string
ZoneinfoDataSource.search_path = ['/tmp/zoneinfo4', '/tmp/zoneinfo5'].join(File::PATH_SEPARATOR)
assert_equal(['/tmp/zoneinfo4', '/tmp/zoneinfo5'], ZoneinfoDataSource.search_path)
end
def test_default_alternate_iso3166_tab_search_path
assert_equal(['/usr/share/misc/iso3166.tab', '/usr/share/misc/iso3166'], ZoneinfoDataSource.alternate_iso3166_tab_search_path)
assert_equal(false, ZoneinfoDataSource.alternate_iso3166_tab_search_path.frozen?)
end
def test_set_alternate_iso3166_tab_search_path_default
ZoneinfoDataSource.alternate_iso3166_tab_search_path = ['/tmp/iso3166.tab', '/tmp/iso3166']
assert_equal(['/tmp/iso3166.tab', '/tmp/iso3166'], ZoneinfoDataSource.alternate_iso3166_tab_search_path)
ZoneinfoDataSource.alternate_iso3166_tab_search_path = nil
assert_equal(['/usr/share/misc/iso3166.tab', '/usr/share/misc/iso3166'], ZoneinfoDataSource.alternate_iso3166_tab_search_path)
assert_equal(false, ZoneinfoDataSource.alternate_iso3166_tab_search_path.frozen?)
end
def test_set_alternate_iso3166_tab_search_path_array
path = ['/tmp/iso3166.tab', '/tmp/iso3166']
ZoneinfoDataSource.alternate_iso3166_tab_search_path = path
assert_equal(['/tmp/iso3166.tab', '/tmp/iso3166'], ZoneinfoDataSource.alternate_iso3166_tab_search_path)
refute_same(path, ZoneinfoDataSource.alternate_iso3166_tab_search_path)
end
def test_set_alternate_iso3166_tab_search_path_array_to_s
ZoneinfoDataSource.alternate_iso3166_tab_search_path = [Pathname.new('/tmp/iso3166.tab')]
assert_equal(['/tmp/iso3166.tab'], ZoneinfoDataSource.alternate_iso3166_tab_search_path)
end
def test_set_alternate_iso3166_tab_search_path_string
ZoneinfoDataSource.alternate_iso3166_tab_search_path = ['/tmp/iso3166.tab', '/tmp/iso3166'].join(File::PATH_SEPARATOR)
assert_equal(['/tmp/iso3166.tab', '/tmp/iso3166'], ZoneinfoDataSource.alternate_iso3166_tab_search_path)
end
def test_new_search
Dir.mktmpdir('tzinfo_test_dir1') do |dir1|
Dir.mktmpdir('tzinfo_test_dir2') do |dir2|
Dir.mktmpdir('tzinfo_test_dir3') do |dir3|
Dir.mktmpdir('tzinfo_test_dir4') do |dir4|
file = File.join(dir1, 'file')
FileUtils.touch(File.join(dir2, 'zone.tab'))
FileUtils.touch(File.join(dir3, 'iso3166.tab'))
FileUtils.touch(File.join(dir4, 'zone.tab'))
FileUtils.touch(File.join(dir4, 'iso3166.tab'))
ZoneinfoDataSource.search_path = [file, dir2, dir3, dir4]
ZoneinfoDataSource.alternate_iso3166_tab_search_path = []
data_source = ZoneinfoDataSource.new
assert_equal(dir4, data_source.zoneinfo_dir)
end
end
end
end
end
def test_new_search_zone1970
Dir.mktmpdir('tzinfo_test_dir1') do |dir1|
Dir.mktmpdir('tzinfo_test_dir2') do |dir2|
Dir.mktmpdir('tzinfo_test_dir3') do |dir3|
Dir.mktmpdir('tzinfo_test_dir4') do |dir4|
file = File.join(dir1, 'file')
FileUtils.touch(File.join(dir2, 'zone1970.tab'))
FileUtils.touch(File.join(dir3, 'iso3166.tab'))
FileUtils.touch(File.join(dir4, 'zone1970.tab'))
FileUtils.touch(File.join(dir4, 'iso3166.tab'))
ZoneinfoDataSource.search_path = [file, dir2, dir3, dir4]
ZoneinfoDataSource.alternate_iso3166_tab_search_path = []
data_source = ZoneinfoDataSource.new
assert_equal(dir4, data_source.zoneinfo_dir)
end
end
end
end
end
def test_new_search_solaris_tab_files
# Solaris names the tab files 'tab/country.tab' (iso3166.tab) and
# 'tab/zone_sun.tab' (zone.tab).
Dir.mktmpdir('tzinfo_test_dir') do |dir|
tab = File.join(dir, 'tab')
FileUtils.mkdir(tab)
FileUtils.touch(File.join(tab, 'country.tab'))
FileUtils.touch(File.join(tab, 'zone_sun.tab'))
ZoneinfoDataSource.search_path = [dir]
ZoneinfoDataSource.alternate_iso3166_tab_search_path = []
data_source = ZoneinfoDataSource.new
assert_equal(dir, data_source.zoneinfo_dir)
end
end
def test_new_search_alternate_iso3166_path
Dir.mktmpdir('tzinfo_test_dir_zoneinfo') do |zoneinfo_dir|
Dir.mktmpdir('tzinfo_test_dir_tab') do |tab_dir|
FileUtils.touch(File.join(zoneinfo_dir, 'zone.tab'))
tab_file = File.join(tab_dir, 'iso3166')
ZoneinfoDataSource.search_path = [zoneinfo_dir]
ZoneinfoDataSource.alternate_iso3166_tab_search_path = [tab_file]
assert_raises_directory_not_found { ZoneinfoDataSource.new }
FileUtils.touch(tab_file)
data_source = ZoneinfoDataSource.new
assert_equal(zoneinfo_dir, data_source.zoneinfo_dir)
end
end
end
def test_new_search_not_found
Dir.mktmpdir('tzinfo_test_dir1') do |dir1|
Dir.mktmpdir('tzinfo_test_dir2') do |dir2|
Dir.mktmpdir('tzinfo_test_dir3') do |dir3|
Dir.mktmpdir('tzinfo_test_dir4') do |dir4|
Dir.mktmpdir('tzinfo_test_dir5') do |dir5|
file = File.join(dir1, 'file')
FileUtils.touch(file)
FileUtils.touch(File.join(dir2, 'zone.tab'))
FileUtils.touch(File.join(dir3, 'zone1970.tab'))
FileUtils.touch(File.join(dir4, 'iso3166.tab'))
ZoneinfoDataSource.search_path = [file, dir2, dir3, dir4, dir5]
ZoneinfoDataSource.alternate_iso3166_tab_search_path = []
assert_raises_directory_not_found { ZoneinfoDataSource.new }
end
end
end
end
end
end
def test_new_search_relative
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
FileUtils.chdir(dir)
ZoneinfoDataSource.search_path = ['.']
ZoneinfoDataSource.alternate_iso3166_tab_search_path = []
data_source = ZoneinfoDataSource.new
assert_equal(Pathname.new(dir).realpath.to_s, data_source.zoneinfo_dir)
# Change out of the directory to allow it to be deleted on Windows.
FileUtils.chdir(@orig_pwd)
end
end
def test_new_dir
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
data_source = ZoneinfoDataSource.new(dir)
assert_equal(dir, data_source.zoneinfo_dir)
end
end
def test_new_dir_zone1970
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone1970.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
data_source = ZoneinfoDataSource.new(dir)
assert_equal(dir, data_source.zoneinfo_dir)
end
end
def test_new_dir_solaris_tab_files
# Solaris names the tab files 'tab/country.tab' (iso3166.tab) and
# 'tab/zone_sun.tab' (zone.tab).
Dir.mktmpdir('tzinfo_test') do |dir|
tab = File.join(dir, 'tab')
FileUtils.mkdir(tab)
FileUtils.touch(File.join(tab, 'country.tab'))
FileUtils.touch(File.join(tab, 'zone_sun.tab'))
data_source = ZoneinfoDataSource.new(dir)
assert_equal(dir, data_source.zoneinfo_dir)
end
end
def test_new_dir_alternate_iso3166_path
Dir.mktmpdir('tzinfo_test_dir_zoneinfo') do |zoneinfo_dir|
Dir.mktmpdir('tzinfo_test_dir_tab') do |tab_dir|
FileUtils.touch(File.join(zoneinfo_dir, 'zone.tab'))
tab_file = File.join(tab_dir, 'iso3166')
FileUtils.touch(tab_file)
ZoneinfoDataSource.alternate_iso3166_tab_search_path = [tab_file]
assert_raises_invalid_directory(zoneinfo_dir) do
# The alternate_iso3166_tab_search_path should not be used. This should raise
# an exception.
ZoneinfoDataSource.new(zoneinfo_dir)
end
data_source = ZoneinfoDataSource.new(zoneinfo_dir, tab_file)
assert_equal(zoneinfo_dir, data_source.zoneinfo_dir)
end
end
end
def test_new_dir_invalid
Dir.mktmpdir('tzinfo_test') do |dir|
assert_raises_invalid_directory(dir) { ZoneinfoDataSource.new(dir) }
end
end
def test_new_dir_invalid_alternate_iso3166_path
Dir.mktmpdir('tzinfo_test_dir_zoneinfo') do |zoneinfo_dir|
Dir.mktmpdir('tzinfo_test_dir_tab') do |tab_dir|
FileUtils.touch(File.join(zoneinfo_dir, 'zone.tab'))
assert_raises_invalid_directory(zoneinfo_dir) do
ZoneinfoDataSource.new(zoneinfo_dir, File.join(tab_dir, 'iso3166'))
end
end
end
end
def test_new_dir_invalid_alternate_iso3166_path_overrides_valid
Dir.mktmpdir('tzinfo_test_dir_zoneinfo') do |zoneinfo_dir|
Dir.mktmpdir('tzinfo_test_dir_tab') do |tab_dir|
FileUtils.touch(File.join(zoneinfo_dir, 'iso3166.tab'))
FileUtils.touch(File.join(zoneinfo_dir, 'zone.tab'))
assert_raises_invalid_directory(zoneinfo_dir) do
ZoneinfoDataSource.new(zoneinfo_dir, File.join(tab_dir, 'iso3166'))
end
end
end
end
def test_new_file
Dir.mktmpdir('tzinfo_test') do |dir|
file = File.join(dir, 'file')
FileUtils.touch(file)
assert_raises_invalid_directory(file) do
ZoneinfoDataSource.new(file)
end
end
end
def test_new_dir_relative
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
FileUtils.chdir(dir)
data_source = ZoneinfoDataSource.new('.')
assert_equal(Pathname.new(dir).realpath.to_s, data_source.zoneinfo_dir)
# Change out of the directory to allow it to be deleted on Windows.
FileUtils.chdir(@orig_pwd)
end
end
def test_zoneinfo_dir
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
data_source = ZoneinfoDataSource.new(dir)
assert_equal(dir, data_source.zoneinfo_dir)
assert_equal(true, data_source.zoneinfo_dir.frozen?)
end
end
def test_load_timezone_info_transitions
o1 = TimezoneOffset.new(-17900, 0, 'TESTLMT')
o2 = TimezoneOffset.new(-18000, 3600, 'TESTD')
o3 = TimezoneOffset.new(-18000, 0, 'TESTS')
t1 = TimezoneTransition.new(o2, o1, Time.utc(2000, 4,1,1,0,0).to_i)
t2 = TimezoneTransition.new(o3, o2, Time.utc(2000,10,1,1,0,0).to_i)
t3 = TimezoneTransition.new(o2, o3, Time.utc(2001, 3,1,1,0,0).to_i)
transitions = [t1, t2, t3]
reader_mock = Minitest::Mock.new
reader_mock.expect(:read, transitions, [File.join(ZONEINFO_DIR, 'Europe', 'London')])
@data_source.instance_variable_set(:@zoneinfo_reader, reader_mock)
info = @data_source.send(:load_timezone_info, 'Europe/London')
reader_mock.verify
assert_kind_of(TransitionsDataTimezoneInfo, info)
assert_equal('Europe/London', info.identifier)
assert_equal(transitions, info.transitions)
end
def test_load_timezone_info_constant_offset
offset = TimezoneOffset.new(-17900, 0, 'TESTLMT')
reader_mock = Minitest::Mock.new
reader_mock.expect(:read, offset, [File.join(ZONEINFO_DIR, 'Europe', 'London')])
@data_source.instance_variable_set(:@zoneinfo_reader, reader_mock)
info = @data_source.send(:load_timezone_info, 'Europe/London')
reader_mock.verify
assert_kind_of(ConstantOffsetDataTimezoneInfo, info)
assert_equal('Europe/London', info.identifier)
assert_same(offset, info.constant_offset)
end
def test_load_timezone_info_data
info = @data_source.send(:load_timezone_info, 'Europe/London')
assert_kind_of(TransitionsDataTimezoneInfo, info)
assert_equal('Europe/London', info.identifier)
end
def test_load_timezone_info_linked
info = @data_source.send(:load_timezone_info, 'UTC')
# On platforms that don't support symlinks, 'UTC' will be created as a copy.
# Either way, a ConstantOffsetDataTimezoneInfo should be returned.
assert_kind_of(ConstantOffsetDataTimezoneInfo, info)
assert_equal('UTC', info.identifier)
end
def test_load_timezone_info_does_not_exist
error = assert_raises(InvalidTimezoneIdentifier) do
@data_source.send(:load_timezone_info, 'Nowhere/Special')
end
assert_match(/\bNowhere\/Special\b/, error.message)
end
test_encodings('UTF-8', 'UTF-16').each do |encoding|
define_method("test_load_timezone_info_file_does_not_exist_with_#{encoding.to_method}_encoded_identifier") do
# Override the index so that an attempt is made to load the file.
def @data_source.validate_timezone_identifier(identifier)
identifier = identifier.encode(Encoding::UTF_8)
raise "Unexpected identifier passed to validate_timezone_identifier: #{identifier}" unless identifier == 'Nowhere/Special'
'Nowhere/Special'.freeze
end
error = assert_raises(InvalidTimezoneIdentifier) do
@data_source.send(:load_timezone_info, 'Nowhere/Special'.encode(encoding.name))
end
assert_match(/\bNowhere\/Special\b/, error.message)
assert_equal(Encoding::UTF_8, error.message.encoding)
assert_kind_of(Errno::ENOENT, error.cause) if error.respond_to?(:cause)
end
define_method("test_load_timezone_info_path_component_not_dir_with_#{encoding.to_method}_encoded_identifier") do
skip('JRuby 9.0.5.0 raises an unhandled Java IOException when encountering a path component that is not a directory') if RUBY_ENGINE == 'jruby' && JRUBY_VERSION.start_with?('9.0.')
# Override the index so that an attempt is made to load the file.
def @data_source.validate_timezone_identifier(identifier)
identifier = identifier.encode(Encoding::UTF_8)
raise "Unexpected identifier passed to validate_timezone_identifier: #{identifier}" unless identifier == 'UTC/File'
'UTC/File'.freeze
end
error = assert_raises(InvalidTimezoneIdentifier) do
@data_source.send(:load_timezone_info, 'UTC/File'.encode(encoding.name))
end
assert_match(/\bUTC\/File\b/, error.message)
assert_equal(Encoding::UTF_8, error.message.encoding)
# The cause is usually Errno::ENOTDIR. On Windows it is Errno::ENOENT
# instead.
if error.respond_to?(:cause)
expected_cause = get_expected_file_open_and_read_cause(File.join(ZONEINFO_DIR, 'UTC', 'File'))
assert_kind_of(expected_cause, error.cause)
end
end
define_method("test_load_timezone_info_name_to_long_with_#{encoding.to_method}_encoded_identifier") do
# Override the read method to raise Errno::ENAMETOOLONG and check that
# this is handled correctly.
zoneinfo_reader = @data_source.instance_variable_get(:@zoneinfo_reader)
def zoneinfo_reader.read(file_path)
raise Errno::ENAMETOOLONG, 'Test'
end
error = assert_raises(InvalidTimezoneIdentifier) do
@data_source.send(:load_timezone_info, 'Europe/London'.encode(encoding.name))
end
assert_match(/\bEurope\/London\b/, error.message)
assert_equal(Encoding::UTF_8, error.message.encoding)
assert_kind_of(Errno::ENAMETOOLONG, error.cause) if error.respond_to?(:cause)
end
end
def test_load_timezone_info_invalid
error = assert_raises(InvalidTimezoneIdentifier) do
@data_source.send(:load_timezone_info, '../zoneinfo/Europe/London')
end
assert_match(/\W\.\.\/zoneinfo\/Europe\/London\b/, error.message)
end
def test_load_timezone_info_nil
error = assert_raises(InvalidTimezoneIdentifier) do
@data_source.send(:load_timezone_info, nil)
end
assert_match(/\bnil\b/, error.message)
end
def test_load_timezone_info_false
error = assert_raises(InvalidTimezoneIdentifier) do
@data_source.send(:load_timezone_info, false)
end
assert_match(/\bfalse\b/, error.message)
end
def test_load_timezone_info_case
error = assert_raises(InvalidTimezoneIdentifier) do
@data_source.send(:load_timezone_info, 'europe/london')
end
assert_match(/\beurope\/london/, error.message)
end
test_encodings('UTF-8', 'UTF-16').each do |encoding|
define_method("test_load_timezone_info_permission_denied_with_#{encoding.to_method}_encoded_identifier") do
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
file = File.join(dir, 'UTC')
FileUtils.touch(file)
FileUtils.chmod(0200, file)
if File.stat(file).mode & 0400 == 0400
# chmod failed to remove read permissions. Assume this is Windows and
# try setting permissions with icacls instead.
`icacls "#{file}" /deny Everyone:R`
end
data_source = ZoneinfoDataSource.new(dir)
error = assert_raises(InvalidTimezoneIdentifier) do
data_source.send(:load_timezone_info, 'UTC'.encode(encoding.name))
end
assert_match(/\bUTC\b/, error.message)
assert_equal(Encoding::UTF_8, error.message.encoding)
assert_kind_of(Errno::EACCES, error.cause) if error.respond_to?(:cause)
end
end
end
def test_load_timezone_info_directory
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
subdir = File.join(dir, 'Subdir')
FileUtils.mkdir(subdir)
data_source = ZoneinfoDataSource.new(dir)
error = assert_raises(InvalidTimezoneIdentifier) do
data_source.send(:load_timezone_info, 'Subdir')
end
assert_match(/\bSubdir\b/, error.message)
end
end
test_encodings('UTF-8', 'UTF-16').each do |encoding|
define_method("test_load_timezone_info_file_is_directory_with_#{encoding.to_method}_encoded_identifier") do
skip('JRuby 9.0.5.0 hangs when attempting to read a directory') if RUBY_ENGINE == 'jruby' && JRUBY_VERSION.start_with?('9.0.')
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
subdir = File.join(dir, 'Subdir')
FileUtils.mkdir(subdir)
data_source = ZoneinfoDataSource.new(dir)
# Override the index so that an attempt is made to load the file.
def data_source.validate_timezone_identifier(identifier)
identifier = identifier.encode(Encoding::UTF_8)
raise "Unexpected identifier passed to validate_timezone_identifier: #{identifier}" unless identifier == 'Subdir'
'Subdir'.freeze
end
error = assert_raises(InvalidTimezoneIdentifier) do
data_source.send(:load_timezone_info, 'Subdir'.encode(encoding.name))
end
assert_match(/\bSubdir\b/, error.message)
assert_equal(Encoding::UTF_8, error.message.encoding)
if error.respond_to?(:cause)
# Errno::EISDIR is normally raised either when attempting to read or
# when opening the file (Windows). However, JRuby on Windows 9.1.14.0
# raises Errno::EACCES instead.
#
# Once https://github.com/jruby/jruby/pull/4818 has been fixed/merged,
# this can be changed to:
#
# assert_kind_of(Errno::EISDIR, error.cause)
expected_cause = get_expected_file_open_and_read_cause(File.join(dir, 'Subdir'))
assert_kind_of(expected_cause, error.cause)
end
end
end
end
def test_load_timezone_info_linked_absolute_outside
Dir.mktmpdir('tzinfo_test') do |dir|
Dir.mktmpdir('tzinfo_test') do |outside|
outside_file = File.join(outside, 'EST')
FileUtils.cp(File.join(@data_source.zoneinfo_dir, 'EST'), outside_file)
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
file = File.join(dir, 'EST')
begin
FileUtils.ln_s(outside_file, file)
rescue NotImplementedError, Errno::EACCES
# Symlinks not supported on this platform, or permission denied
# (administrative rights are required on some versions of Windows).
skip('Symlinks are not supported on this platform, or permission was denied creating a symlink')
end
data_source = ZoneinfoDataSource.new(dir)
info = data_source.send(:load_timezone_info, 'EST')
assert_kind_of(ConstantOffsetDataTimezoneInfo, info)
assert_equal('EST', info.identifier)
# JRuby 9.1.14.0 on Windows (running elevated) fails to clean up symlinks.
File.delete(file)
end
end
end
def test_load_timezone_info_linked_absolute_inside
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
FileUtils.cp(File.join(@data_source.zoneinfo_dir, 'EST'), File.join(dir, 'EST'))
link = File.join(dir, 'Link')
begin
FileUtils.ln_s(File.join(File.expand_path(dir), 'EST'), link)
rescue NotImplementedError, Errno::EACCES
# Symlinks not supported on this platform, or permission denied
# (administrative rights are required on some versions of Windows).
skip('Symlinks are not supported on this platform, or permission was denied creating a symlink')
end
data_source = ZoneinfoDataSource.new(dir)
info = data_source.send(:load_timezone_info, 'Link')
assert_kind_of(ConstantOffsetDataTimezoneInfo, info)
assert_equal('Link', info.identifier)
# JRuby 9.1.14.0 on Windows (running elevated) fails to clean up symlinks.
File.delete(link)
end
end
def test_load_timezone_info_linked_relative_outside
Dir.mktmpdir('tzinfo_test') do |root|
FileUtils.cp(File.join(@data_source.zoneinfo_dir, 'EST'), File.join(root, 'outside'))
dir = File.join(root, 'zoneinfo')
FileUtils.mkdir(dir)
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
link = File.join(dir, 'Link')
begin
FileUtils.ln_s('../outside', link)
rescue NotImplementedError, Errno::EACCES
# Symlinks not supported on this platform, or permission denied
# (administrative rights are required on some versions of Windows).
skip('Symlinks are not supported on this platform, or permission was denied creating a symlink')
end
subdir = File.join(dir, 'Subdir')
subdir_link = File.join(subdir, 'Link')
FileUtils.mkdir(subdir)
FileUtils.ln_s('../../outside', subdir_link)
data_source = ZoneinfoDataSource.new(dir)
info = data_source.send(:load_timezone_info, 'Link')
assert_kind_of(ConstantOffsetDataTimezoneInfo, info)
assert_equal('Link', info.identifier)
info = data_source.send(:load_timezone_info, 'Subdir/Link')
assert_kind_of(ConstantOffsetDataTimezoneInfo, info)
assert_equal('Subdir/Link', info.identifier)
# JRuby 9.1.14.0 on Windows (running elevated) fails to clean up symlinks.
File.delete(link)
File.delete(subdir_link)
end
end
def test_load_timezone_info_linked_relative_parent_inside
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
FileUtils.cp(File.join(@data_source.zoneinfo_dir, 'EST'), File.join(dir, 'EST'))
subdir = File.join(dir, 'Subdir')
FileUtils.mkdir(subdir)
FileUtils.cp(File.join(@data_source.zoneinfo_dir, 'EST'), File.join(subdir, 'EST'))
subdir_link = File.join(subdir, 'Link')
begin
FileUtils.ln_s('../Subdir/EST', subdir_link)
rescue NotImplementedError, Errno::EACCES
# Symlinks not supported on this platform, or permission denied
# (administrative rights are required on some versions of Windows).
skip('Symlinks are not supported on this platform, or permission was denied creating a symlink')
end
subdir_link2 = File.join(subdir, 'Link2')
FileUtils.ln_s('../EST', subdir_link2)
subdir2 = File.join(dir, 'Subdir2')
FileUtils.mkdir(subdir2)
subdir2_link = File.join(subdir2, 'Link')
FileUtils.ln_s('../Subdir/EST', subdir2_link)
data_source = ZoneinfoDataSource.new(dir)
info = data_source.send(:load_timezone_info, 'Subdir/Link')
assert_kind_of(ConstantOffsetDataTimezoneInfo, info)
assert_equal('Subdir/Link', info.identifier)
info = data_source.send(:load_timezone_info, 'Subdir/Link2')
assert_kind_of(ConstantOffsetDataTimezoneInfo, info)
assert_equal('Subdir/Link2', info.identifier)
info = data_source.send(:load_timezone_info, 'Subdir2/Link')
assert_kind_of(ConstantOffsetDataTimezoneInfo, info)
assert_equal('Subdir2/Link', info.identifier)
# JRuby 9.1.14.0 on Windows (running elevated) fails to clean up symlinks.
File.delete(subdir_link)
File.delete(subdir_link2)
File.delete(subdir2_link)
end
end
test_encodings('UTF-8', 'UTF-16').each do |encoding|
define_method("test_load_timezone_info_invalid_file_with_#{encoding.to_method}_encoded_identifier") do
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
File.open(File.join(dir, 'Zone'), 'wb') do |file|
file.write('NotAValidTZifFile')
end
data_source = ZoneinfoDataSource.new(dir)
error = assert_raises(InvalidTimezoneIdentifier) do
data_source.send(:load_timezone_info, 'Zone'.encode(encoding.name))
end
assert_match(/\bZone\b/, error.message)
assert_equal(Encoding::UTF_8, error.message.encoding)
end
end
define_method("test_load_timezone_info_invalid_file_2_with_#{encoding.to_method}_encoded_identifier") do
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
zone = File.join(dir, 'Zone')
File.open(File.join(@data_source.zoneinfo_dir, 'EST')) do |src|
# Change header to TZif1 (which is not a valid header).
File.open(zone, 'wb') do |dest|
dest.write('TZif1')
src.pos = 5
FileUtils.copy_stream(src, dest)
end
end
data_source = ZoneinfoDataSource.new(dir)
error = assert_raises(InvalidTimezoneIdentifier) do
data_source.send(:load_timezone_info, 'Zone'.encode(encoding.name))
end
assert_match(/\bZone\b/, error.message)
assert_equal(Encoding::UTF_8, error.message.encoding)
end
end
end
def test_load_timezone_info_tainted
skip_if_taint_is_undefined_or_no_op
safe_test(unavailable: :skip) do
identifier = 'Europe/Amsterdam'.dup.taint
assert(identifier.tainted?)
info = @data_source.send(:load_timezone_info, identifier)
assert_equal('Europe/Amsterdam', info.identifier)
assert(identifier.tainted?)
end
end
def test_load_timezone_info_tainted_and_frozen
skip_if_taint_is_undefined_or_no_op
safe_test do
info = @data_source.send(:load_timezone_info, 'Europe/Amsterdam'.dup.taint.freeze)
assert_equal('Europe/Amsterdam', info.identifier)
end
end
def test_load_timezone_info_tainted_zoneinfo_dir_safe_mode
skip_if_taint_is_undefined_or_no_op
safe_test(unavailable: :skip) do
assert_raises(SecurityError) do
ZoneinfoDataSource.new(@data_source.zoneinfo_dir.dup.taint)
end
end
end
def test_load_timezone_info_tainted_zoneinfo_dir
skip_if_taint_is_undefined_or_no_op
data_source = ZoneinfoDataSource.new(@data_source.zoneinfo_dir.dup.taint)
info = data_source.send(:load_timezone_info, 'Europe/London')
assert_kind_of(TransitionsDataTimezoneInfo, info)
assert_equal('Europe/London', info.identifier)
end
def test_load_timezone_info_returned_identifier_frozen
info = @data_source.send(:load_timezone_info, 'Europe/London')
assert(info.identifier.frozen?)
end
def test_load_timezone_info_parameter_remains_unfrozen
identifier = 'Europe/London'.dup
info = @data_source.send(:load_timezone_info, identifier)
assert_equal('Europe/London', info.identifier)
refute_same(identifier, info.identifier)
assert(!identifier.frozen?)
end
test_encodings('UTF-8', 'UTF-16', 'ISO-8859-1') do |encoding|
define_method("test_load_timezone_info_with_#{encoding.to_method}_encoded_identifier") do
identifier = 'Europe/London'.encode(encoding.name).freeze
info = @data_source.send(:load_timezone_info, identifier)
assert_equal('Europe/London', info.identifier)
end
end
def test_get_timezone_info
info = @data_source.get_timezone_info('Europe/London')
assert_equal('Europe/London', info.identifier)
end
def get_timezone_filenames(directory)
entries = Dir.glob(File.join(directory, '**', '*'))
entries = entries.select do |file|
RubyCoreSupport.untaint(file)
File.file?(file)
end
entries = entries.collect {|file| file[directory.length + File::SEPARATOR.length, file.length - directory.length - File::SEPARATOR.length]}
# Exclude right (with leapseconds) and posix (copy) directories; .tab files; leapseconds, localtime and posixrules files.
entries = entries.select do |file|
file !~ /\A(posix|right)\// &&
file !~ /\.tab\z/ &&
!%w(leapseconds localtime posixrules).include?(file)
end
entries.sort
end
def test_timezone_identifiers
expected = get_timezone_filenames(@data_source.zoneinfo_dir).sort!
all = @data_source.timezone_identifiers
assert_kind_of(Array, all)
assert_equal(expected, all)
assert(all.frozen?)
assert(all.all?(&:frozen?))
assert(all.all? {|s| s.encoding == Encoding::UTF_8})
assert_same(all, @data_source.timezone_identifiers)
end
def test_data_timezone_identifiers
expected = get_timezone_filenames(@data_source.zoneinfo_dir).sort!
all_data = @data_source.data_timezone_identifiers
assert_kind_of(Array, all_data)
assert_equal(expected, all_data)
assert(all_data.frozen?)
assert(all_data.all?(&:frozen?))
assert(all_data.all? {|s| s.encoding == Encoding::UTF_8})
assert_same(all_data, @data_source.data_timezone_identifiers)
end
def test_linked_timezone_identifiers
all_linked = @data_source.linked_timezone_identifiers
assert_kind_of(Array, all_linked)
assert_equal([], all_linked)
assert(all_linked.frozen?)
end
['UTF-8', 'ISO-8859-1', nil].each do |encoding|
define_method("test_timezone_identifiers_loaded_as_utf_8_when_internal_encoding_is_#{encoding ? encoding.downcase.gsub('-', '_') : 'nil'}") do
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
subdir = File.join(dir, 'Subdir')
FileUtils.mkdir(subdir)
FileUtils.touch(File.join(subdir, 'Zone'))
orig_verbose = $VERBOSE
orig_default_internal_encoding = Encoding.default_internal
begin
$VERBOSE = nil
Encoding.default_internal = encoding
data_source = ZoneinfoDataSource.new(dir)
all = data_source.timezone_identifiers
assert_equal(1, all.length)
assert_equal('Subdir/Zone', all[0])
assert_equal(Encoding::UTF_8, all[0].encoding)
ensure
Encoding.default_internal = orig_default_internal_encoding
$VERBOSE = orig_verbose
end
end
end
end
['UTF-8', 'ISO-8859-1'].each do |encoding|
define_method("test_timezone_identifiers_loaded_when_zoneinfo_dir_encoded_as_#{encoding.downcase.gsub('-', '_')}") do
Dir.mktmpdir('tzinfo_test') do |dir|
FileUtils.touch(File.join(dir, 'zone.tab'))
FileUtils.touch(File.join(dir, 'iso3166.tab'))
subdir = File.join(dir, 'Subdir')
FileUtils.mkdir(subdir)
FileUtils.touch(File.join(subdir, 'Zone'))
data_source = ZoneinfoDataSource.new(dir.encode(encoding))
all = data_source.timezone_identifiers
assert_equal(1, all.length)
assert_equal('Subdir/Zone', all[0])
assert_equal(Encoding::UTF_8, all[0].encoding)
end
end
end
def test_timezone_identifiers_excludes_those_that_cannot_be_utf8_encoded
file_expand_path = ->(path) do
raise "Unexpected path: #{path}" unless path == '/test'
path
end
file_directory = ->(path) do
path == '/test'
end
file_file = ->(path) do
path =~ /\A\/test\/((iso3166|zone).tab|Zone[123])\z/
end
file_read = ->(path, options = {}) do
raise "Unexpected path: #{path}" unless path == '/test/iso3166.tab' || path == '/test/zone.tab'
''
end
dir_foreach = ->(path, &block) do
raise "Unexpected path: #{path}" unless path == '/test'
block.call('Zone1'.dup.force_encoding(Encoding::UTF_16)) # Invalid, can't be converted.
block.call('Zone2'.dup)
block.call('Zone3'.dup.force_encoding(Encoding::UTF_16)) # Invalid, can't be converted.
end
File.stub(:expand_path, file_expand_path) do
File.stub(:directory?, file_directory) do
File.stub(:file?, file_file) do
File.stub(:read, file_read) do
Dir.stub(:foreach, dir_foreach) do
data_source = ZoneinfoDataSource.new('/test')
all = data_source.timezone_identifiers
assert_equal(1, all.length)
assert_equal('Zone2', all[0])
assert_equal(Encoding::UTF_8, all[0].encoding)
end
end
end
end
end
end
def test_timezone_identifiers_are_utf8_when_file_join_returns_non_utf8
file_join = ->(*paths) do
if paths.length == 2 && paths[0] == 'Test' && paths[1] == 'Zone'
'Test/Zone'.encode(Encoding::ISO_8859_1)
else
File.__minitest_stub__join(*paths)
end
end