This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
make testsuite somewhat location independent
[perl5.git] / t / lib / db-btree.t
1 #!./perl -w
2
3 BEGIN {
4     unshift @INC, '../lib' if -d '../lib' ;
5     require Config; import Config;
6     if ($Config{'extensions'} !~ /\bDB_File\b/) {
7         print "1..0\n";
8         exit 0;
9     }
10 }
11
12 use DB_File; 
13 use Fcntl;
14
15 print "1..102\n";
16
17 sub ok
18 {
19     my $no = shift ;
20     my $result = shift ;
21  
22     print "not " unless $result ;
23     print "ok $no\n" ;
24 }
25
26 sub lexical
27 {
28     my(@a) = unpack ("C*", $a) ;
29     my(@b) = unpack ("C*", $b) ;
30
31     my $len = (@a > @b ? @b : @a) ;
32     my $i = 0 ;
33
34     foreach $i ( 0 .. $len -1) {
35         return $a[$i] - $b[$i] if $a[$i] != $b[$i] ;
36     }
37
38     return @a - @b ;
39 }
40
41 $Dfile = "dbbtree.tmp";
42 unlink $Dfile;
43
44 umask(0);
45
46 # Check the interface to BTREEINFO
47
48 my $dbh = new DB_File::BTREEINFO ;
49 ok(1, ! defined $dbh->{flags}) ;
50 ok(2, ! defined $dbh->{cachesize}) ;
51 ok(3, ! defined $dbh->{psize}) ;
52 ok(4, ! defined $dbh->{lorder}) ;
53 ok(5, ! defined $dbh->{minkeypage}) ;
54 ok(6, ! defined $dbh->{maxkeypage}) ;
55 ok(7, ! defined $dbh->{compare}) ;
56 ok(8, ! defined $dbh->{prefix}) ;
57
58 $dbh->{flags} = 3000 ;
59 ok(9, $dbh->{flags} == 3000) ;
60
61 $dbh->{cachesize} = 9000 ;
62 ok(10, $dbh->{cachesize} == 9000);
63
64 $dbh->{psize} = 400 ;
65 ok(11, $dbh->{psize} == 400) ;
66
67 $dbh->{lorder} = 65 ;
68 ok(12, $dbh->{lorder} == 65) ;
69
70 $dbh->{minkeypage} = 123 ;
71 ok(13, $dbh->{minkeypage} == 123) ;
72
73 $dbh->{maxkeypage} = 1234 ;
74 ok(14, $dbh->{maxkeypage} == 1234 );
75
76 $dbh->{compare} = 1234 ;
77 ok(15, $dbh->{compare} == 1234) ;
78
79 $dbh->{prefix} = 1234 ;
80 ok(16, $dbh->{prefix} == 1234 );
81
82 # Check that an invalid entry is caught both for store & fetch
83 eval '$dbh->{fred} = 1234' ;
84 ok(17, $@ =~ /^DB_File::BTREEINFO::STORE - Unknown element 'fred' at/ ) ;
85 eval '$q = $dbh->{fred}' ;
86 ok(18, $@ =~ /^DB_File::BTREEINFO::FETCH - Unknown element 'fred' at/ ) ;
87
88 # Now check the interface to BTREE
89
90 ok(19, $X = tie(%h, 'DB_File',$Dfile, O_RDWR|O_CREAT, 0640, $DB_BTREE )) ;
91
92 ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,$atime,$mtime,$ctime,
93    $blksize,$blocks) = stat($Dfile);
94 ok(20, ($mode & 0777) == ($^O eq 'os2' ? 0666 : 0640) || $^O eq 'amigaos' || $^O eq 'MSWin32');
95
96 while (($key,$value) = each(%h)) {
97     $i++;
98 }
99 ok(21, !$i ) ;
100
101 $h{'goner1'} = 'snork';
102
103 $h{'abc'} = 'ABC';
104 ok(22, $h{'abc'} eq 'ABC' );
105 ok(23, ! defined $h{'jimmy'} ) ;
106 ok(24, ! exists $h{'jimmy'} ) ;
107 ok(25,  defined $h{'abc'} ) ;
108
109 $h{'def'} = 'DEF';
110 $h{'jkl','mno'} = "JKL\034MNO";
111 $h{'a',2,3,4,5} = join("\034",'A',2,3,4,5);
112 $h{'a'} = 'A';
113
114 #$h{'b'} = 'B';
115 $X->STORE('b', 'B') ;
116
117 $h{'c'} = 'C';
118
119 #$h{'d'} = 'D';
120 $X->put('d', 'D') ;
121
122 $h{'e'} = 'E';
123 $h{'f'} = 'F';
124 $h{'g'} = 'X';
125 $h{'h'} = 'H';
126 $h{'i'} = 'I';
127
128 $h{'goner2'} = 'snork';
129 delete $h{'goner2'};
130
131
132 # IMPORTANT - $X must be undefined before the untie otherwise the
133 #             underlying DB close routine will not get called.
134 undef $X ;
135 untie(%h);
136
137
138 # tie to the same file again
139 ok(26, $X = tie(%h,'DB_File',$Dfile, O_RDWR, 0640, $DB_BTREE)) ;
140
141 # Modify an entry from the previous tie
142 $h{'g'} = 'G';
143
144 $h{'j'} = 'J';
145 $h{'k'} = 'K';
146 $h{'l'} = 'L';
147 $h{'m'} = 'M';
148 $h{'n'} = 'N';
149 $h{'o'} = 'O';
150 $h{'p'} = 'P';
151 $h{'q'} = 'Q';
152 $h{'r'} = 'R';
153 $h{'s'} = 'S';
154 $h{'t'} = 'T';
155 $h{'u'} = 'U';
156 $h{'v'} = 'V';
157 $h{'w'} = 'W';
158 $h{'x'} = 'X';
159 $h{'y'} = 'Y';
160 $h{'z'} = 'Z';
161
162 $h{'goner3'} = 'snork';
163
164 delete $h{'goner1'};
165 $X->DELETE('goner3');
166
167 @keys = keys(%h);
168 @values = values(%h);
169
170 ok(27, $#keys == 29 && $#values == 29) ;
171
172 $i = 0 ;
173 while (($key,$value) = each(%h)) {
174     if ($key eq $keys[$i] && $value eq $values[$i] && $key eq lc($value)) {
175         $key =~ y/a-z/A-Z/;
176         $i++ if $key eq $value;
177     }
178 }
179
180 ok(28, $i == 30) ;
181
182 @keys = ('blurfl', keys(%h), 'dyick');
183 ok(29, $#keys == 31) ;
184
185 #Check that the keys can be retrieved in order
186 my @b = keys %h ;
187 my @c = sort lexical @b ;
188 ok(30, ArrayCompare(\@b, \@c)) ;
189
190 $h{'foo'} = '';
191 ok(31, $h{'foo'} eq '' ) ;
192
193 #$h{''} = 'bar';
194 #ok(32, $h{''} eq 'bar' );
195 ok(32,1) ;
196
197 # check cache overflow and numeric keys and contents
198 $ok = 1;
199 for ($i = 1; $i < 200; $i++) { $h{$i + 0} = $i + 0; }
200 for ($i = 1; $i < 200; $i++) { $ok = 0 unless $h{$i} == $i; }
201 ok(33, $ok);
202
203 ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,$atime,$mtime,$ctime,
204    $blksize,$blocks) = stat($Dfile);
205 ok(34, $size > 0 );
206
207 @h{0..200} = 200..400;
208 @foo = @h{0..200};
209 ok(35, join(':',200..400) eq join(':',@foo) );
210
211 # Now check all the non-tie specific stuff
212
213
214 # Check R_NOOVERWRITE flag will make put fail when attempting to overwrite
215 # an existing record.
216  
217 $status = $X->put( 'x', 'newvalue', R_NOOVERWRITE) ;
218 ok(36, $status == 1 );
219  
220 # check that the value of the key 'x' has not been changed by the 
221 # previous test
222 ok(37, $h{'x'} eq 'X' );
223
224 # standard put
225 $status = $X->put('key', 'value') ;
226 ok(38, $status == 0 );
227
228 #check that previous put can be retrieved
229 $value = 0 ;
230 $status = $X->get('key', $value) ;
231 ok(39, $status == 0 );
232 ok(40, $value eq 'value' );
233
234 # Attempting to delete an existing key should work
235
236 $status = $X->del('q') ;
237 ok(41, $status == 0 );
238 #$status = $X->del('') ;
239 #ok(42, $status == 0 );
240 ok(42,1) ;
241
242 # Make sure that the key deleted, cannot be retrieved
243 ok(43, ! defined $h{'q'}) ;
244 ok(44, ! defined $h{''}) ;
245
246 undef $X ;
247 untie %h ;
248
249 ok(45, $X = tie(%h, 'DB_File',$Dfile, O_RDWR, 0640, $DB_BTREE ));
250
251 # Attempting to delete a non-existant key should fail
252
253 $status = $X->del('joe') ;
254 ok(46, $status == 1 );
255
256 # Check the get interface
257
258 # First a non-existing key
259 $status = $X->get('aaaa', $value) ;
260 ok(47, $status == 1 );
261
262 # Next an existing key
263 $status = $X->get('a', $value) ;
264 ok(48, $status == 0 );
265 ok(49, $value eq 'A' );
266
267 # seq
268 # ###
269
270 # use seq to find an approximate match
271 $key = 'ke' ;
272 $value = '' ;
273 $status = $X->seq($key, $value, R_CURSOR) ;
274 ok(50, $status == 0 );
275 ok(51, $key eq 'key' );
276 ok(52, $value eq 'value' );
277
278 # seq when the key does not match
279 $key = 'zzz' ;
280 $value = '' ;
281 $status = $X->seq($key, $value, R_CURSOR) ;
282 ok(53, $status == 1 );
283
284
285 # use seq to set the cursor, then delete the record @ the cursor.
286
287 $key = 'x' ;
288 $value = '' ;
289 $status = $X->seq($key, $value, R_CURSOR) ;
290 ok(54, $status == 0 );
291 ok(55, $key eq 'x' );
292 ok(56, $value eq 'X' );
293 $status = $X->del(0, R_CURSOR) ;
294 ok(57, $status == 0 );
295 $status = $X->get('x', $value) ;
296 ok(58, $status == 1 );
297
298 # ditto, but use put to replace the key/value pair.
299 $key = 'y' ;
300 $value = '' ;
301 $status = $X->seq($key, $value, R_CURSOR) ;
302 ok(59, $status == 0 );
303 ok(60, $key eq 'y' );
304 ok(61, $value eq 'Y' );
305
306 $key = "replace key" ;
307 $value = "replace value" ;
308 $status = $X->put($key, $value, R_CURSOR) ;
309 ok(62, $status == 0 );
310 ok(63, $key eq 'replace key' );
311 ok(64, $value eq 'replace value' );
312 $status = $X->get('y', $value) ;
313 ok(65, 1) ; # hard-wire to always pass. the previous test ($status == 1)
314             # only worked because of a bug in 1.85/6
315
316 # use seq to walk forwards through a file 
317
318 $status = $X->seq($key, $value, R_FIRST) ;
319 ok(66, $status == 0 );
320 $previous = $key ;
321
322 $ok = 1 ;
323 while (($status = $X->seq($key, $value, R_NEXT)) == 0)
324 {
325     ($ok = 0), last if ($previous cmp $key) == 1 ;
326 }
327
328 ok(67, $status == 1 );
329 ok(68, $ok == 1 );
330
331 # use seq to walk backwards through a file 
332 $status = $X->seq($key, $value, R_LAST) ;
333 ok(69, $status == 0 );
334 $previous = $key ;
335
336 $ok = 1 ;
337 while (($status = $X->seq($key, $value, R_PREV)) == 0)
338 {
339     ($ok = 0), last if ($previous cmp $key) == -1 ;
340     #print "key = [$key] value = [$value]\n" ;
341 }
342
343 ok(70, $status == 1 );
344 ok(71, $ok == 1 );
345
346
347 # check seq FIRST/LAST
348
349 # sync
350 # ####
351
352 $status = $X->sync ;
353 ok(72, $status == 0 );
354
355
356 # fd
357 # ##
358
359 $status = $X->fd ;
360 ok(73, $status != 0 );
361
362
363 undef $X ;
364 untie %h ;
365
366 unlink $Dfile;
367
368 # Now try an in memory file
369 ok(74, $Y = tie(%h, 'DB_File',undef, O_RDWR|O_CREAT, 0640, $DB_BTREE ));
370
371 # fd with an in memory file should return failure
372 $status = $Y->fd ;
373 ok(75, $status == -1 );
374
375
376 undef $Y ;
377 untie %h ;
378
379 # Duplicate keys
380 my $bt = new DB_File::BTREEINFO ;
381 $bt->{flags} = R_DUP ;
382 ok(76, $YY = tie(%hh, 'DB_File', $Dfile, O_RDWR|O_CREAT, 0640, $bt )) ;
383
384 $hh{'Wall'} = 'Larry' ;
385 $hh{'Wall'} = 'Stone' ; # Note the duplicate key
386 $hh{'Wall'} = 'Brick' ; # Note the duplicate key
387 $hh{'Wall'} = 'Brick' ; # Note the duplicate key and value
388 $hh{'Smith'} = 'John' ;
389 $hh{'mouse'} = 'mickey' ;
390
391 # first work in scalar context
392 ok(77, scalar $YY->get_dup('Unknown') == 0 );
393 ok(78, scalar $YY->get_dup('Smith') == 1 );
394 ok(79, scalar $YY->get_dup('Wall') == 4 );
395
396 # now in list context
397 my @unknown = $YY->get_dup('Unknown') ;
398 ok(80, "@unknown" eq "" );
399
400 my @smith = $YY->get_dup('Smith') ;
401 ok(81, "@smith" eq "John" );
402
403 {
404 my @wall = $YY->get_dup('Wall') ;
405 my %wall ;
406 @wall{@wall} = @wall ;
407 ok(82, (@wall == 4 && $wall{'Larry'} && $wall{'Stone'} && $wall{'Brick'}) );
408 }
409
410 # hash
411 my %unknown = $YY->get_dup('Unknown', 1) ;
412 ok(83, keys %unknown == 0 );
413
414 my %smith = $YY->get_dup('Smith', 1) ;
415 ok(84, keys %smith == 1 && $smith{'John'}) ;
416
417 my %wall = $YY->get_dup('Wall', 1) ;
418 ok(85, keys %wall == 3 && $wall{'Larry'} == 1 && $wall{'Stone'} == 1 
419                 && $wall{'Brick'} == 2);
420
421 undef $YY ;
422 untie %hh ;
423 unlink $Dfile;
424
425
426 # test multiple callbacks
427 $Dfile1 = "btree1" ;
428 $Dfile2 = "btree2" ;
429 $Dfile3 = "btree3" ;
430  
431 $dbh1 = new DB_File::BTREEINFO ;
432 { local $^W = 0 ;
433   $dbh1->{compare} = sub { $_[0] <=> $_[1] } ; }
434  
435 $dbh2 = new DB_File::BTREEINFO ;
436 $dbh2->{compare} = sub { $_[0] cmp $_[1] } ;
437  
438 $dbh3 = new DB_File::BTREEINFO ;
439 $dbh3->{compare} = sub { length $_[0] <=> length $_[1] } ;
440  
441  
442 tie(%h, 'DB_File',$Dfile1, O_RDWR|O_CREAT, 0640, $dbh1 ) ;
443 tie(%g, 'DB_File',$Dfile2, O_RDWR|O_CREAT, 0640, $dbh2 ) ;
444 tie(%k, 'DB_File',$Dfile3, O_RDWR|O_CREAT, 0640, $dbh3 ) ;
445  
446 @Keys = qw( 0123 12 -1234 9 987654321 def  ) ;
447 { local $^W = 0 ;
448   @srt_1 = sort { $a <=> $b } @Keys ; }
449 @srt_2 = sort { $a cmp $b } @Keys ;
450 @srt_3 = sort { length $a <=> length $b } @Keys ;
451  
452 foreach (@Keys) {
453     { local $^W = 0 ; 
454       $h{$_} = 1 ; }
455     $g{$_} = 1 ;
456     $k{$_} = 1 ;
457 }
458  
459 sub ArrayCompare
460 {
461     my($a, $b) = @_ ;
462  
463     return 0 if @$a != @$b ;
464  
465     foreach (1 .. length @$a)
466     {
467         return 0 unless $$a[$_] eq $$b[$_] ;
468     }
469  
470     1 ;
471 }
472  
473 ok(86, ArrayCompare (\@srt_1, [keys %h]) );
474 ok(87, ArrayCompare (\@srt_2, [keys %g]) );
475 ok(88, ArrayCompare (\@srt_3, [keys %k]) );
476
477 untie %h ;
478 untie %g ;
479 untie %k ;
480 unlink $Dfile1, $Dfile2, $Dfile3 ;
481
482 # clear
483 # #####
484
485 ok(89, tie(%h, 'DB_File', $Dfile1, O_RDWR|O_CREAT, 0640, $DB_BTREE ) );
486 foreach (1 .. 10)
487   { $h{$_} = $_ * 100 }
488
489 # check that there are 10 elements in the hash
490 $i = 0 ;
491 while (($key,$value) = each(%h)) {
492     $i++;
493 }
494 ok(90, $i == 10);
495
496 # now clear the hash
497 %h = () ;
498
499 # check it is empty
500 $i = 0 ;
501 while (($key,$value) = each(%h)) {
502     $i++;
503 }
504 ok(91, $i == 0);
505
506 untie %h ;
507 unlink $Dfile1 ;
508
509 {
510     # check that attempting to tie an array to a DB_BTREE will fail
511
512     my $filename = "xyz" ;
513     my @x ;
514     eval { tie @x, 'DB_File', $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE ; } ;
515     ok(92, $@ =~ /^DB_File can only tie an associative array to a DB_BTREE database/) ;
516     unlink $filename ;
517 }
518
519 {
520    # sub-class test
521
522    package Another ;
523
524    use strict ;
525
526    open(FILE, ">SubDB.pm") or die "Cannot open SubDB.pm: $!\n" ;
527    print FILE <<'EOM' ;
528
529    package SubDB ;
530
531    use strict ;
532    use vars qw( @ISA @EXPORT) ;
533
534    require Exporter ;
535    use DB_File;
536    @ISA=qw(DB_File);
537    @EXPORT = @DB_File::EXPORT ;
538
539    sub STORE { 
540         my $self = shift ;
541         my $key = shift ;
542         my $value = shift ;
543         $self->SUPER::STORE($key, $value * 2) ;
544    }
545
546    sub FETCH { 
547         my $self = shift ;
548         my $key = shift ;
549         $self->SUPER::FETCH($key) - 1 ;
550    }
551
552    sub put { 
553         my $self = shift ;
554         my $key = shift ;
555         my $value = shift ;
556         $self->SUPER::put($key, $value * 3) ;
557    }
558
559    sub get { 
560         my $self = shift ;
561         $self->SUPER::get($_[0], $_[1]) ;
562         $_[1] -= 2 ;
563    }
564
565    sub A_new_method
566    {
567         my $self = shift ;
568         my $key = shift ;
569         my $value = $self->FETCH($key) ;
570         return "[[$value]]" ;
571    }
572
573    1 ;
574 EOM
575
576     close FILE ;
577
578     BEGIN { push @INC, '.'; }    
579     eval 'use SubDB ; ';
580     main::ok(93, $@ eq "") ;
581     my %h ;
582     my $X ;
583     eval '
584         $X = tie(%h, "SubDB","dbbtree.tmp", O_RDWR|O_CREAT, 0640, $DB_BTREE );
585         ' ;
586
587     main::ok(94, $@ eq "") ;
588
589     my $ret = eval '$h{"fred"} = 3 ; return $h{"fred"} ' ;
590     main::ok(95, $@ eq "") ;
591     main::ok(96, $ret == 5) ;
592
593     my $value = 0;
594     $ret = eval '$X->put("joe", 4) ; $X->get("joe", $value) ; return $value' ;
595     main::ok(97, $@ eq "") ;
596     main::ok(98, $ret == 10) ;
597
598     $ret = eval ' R_NEXT eq main::R_NEXT ' ;
599     main::ok(99, $@ eq "" ) ;
600     main::ok(100, $ret == 1) ;
601
602     $ret = eval '$X->A_new_method("joe") ' ;
603     main::ok(101, $@ eq "") ;
604     main::ok(102, $ret eq "[[11]]") ;
605
606     undef $X;
607     untie(%h);
608     unlink "SubDB.pm", "dbbtree.tmp" ;
609
610 }
611
612 exit ;