lib/Tie/File/t/04_splice.t

   1 #!/usr/bin/perl
   2
   3 #
   4 # Check SPLICE function's effect on the file
   5 # (07_rv_splice.t checks its return value)
   6 #
   7 # Each call to 'check_contents' actually performs two tests.
   8 # First, it calls the tied object's own 'check_integrity' method,
   9 # which makes sure that the contents of the read cache and offset tables
  10 # accurately reflect the contents of the file.
  11 # Then, it checks the actual contents of the file against the expected
  12 # contents.
  13
  14
  15 my $file = "tf$$.txt";
  16 $: = Tie::File::_default_recsep();
  17 my $data = "rec0$:rec1$:rec2$:";
  18 print "1..118\n";
  19
  20 init_file($data);
  21
  22 my $N = 1;
  23 use Tie::File;
  24 print "ok $N\n"; $N++;  # partial credit just for showing up
  25
  26 my $o = tie @a, 'Tie::File', $file;
  27 print $o ? "ok $N\n" : "not ok $N\n";
  28 $N++;
  29
  30 $: = $o->{recsep};
  31 my $n;
  32
  33 # (3-22) splicing at the beginning
  34 splice(@a, 0, 0, "rec4");
  35 check_contents("rec4$:$data");
  36 splice(@a, 0, 1, "rec5");       # same length
  37 check_contents("rec5$:$data");
  38 splice(@a, 0, 1, "record5");    # longer
  39 check_contents("record5$:$data");
  40
  41 splice(@a, 0, 1, "r5");         # shorter
  42 check_contents("r5$:$data");
  43 splice(@a, 0, 1);               # removal
  44 check_contents("$data");
  45 splice(@a, 0, 0);               # no-op
  46 check_contents("$data");
  47 splice(@a, 0, 0, 'r7', 'rec8'); # insert more than one
  48 check_contents("r7$:rec8$:$data");
  49 splice(@a, 0, 2, 'rec7', 'record8', 'rec9'); # insert more than delete
  50 check_contents("rec7$:record8$:rec9$:$data");
  51
  52 splice(@a, 0, 3, 'record9', 'rec10'); # delete more than insert
  53 check_contents("record9$:rec10$:$data");
  54 splice(@a, 0, 2);               # delete more than one
  55 check_contents("$data");
  56
  57
  58 # (23-42) splicing in the middle
  59 splice(@a, 1, 0, "rec4");
  60 check_contents("rec0$:rec4$:rec1$:rec2$:");
  61 splice(@a, 1, 1, "rec5");       # same length
  62 check_contents("rec0$:rec5$:rec1$:rec2$:");
  63 splice(@a, 1, 1, "record5");    # longer
  64 check_contents("rec0$:record5$:rec1$:rec2$:");
  65
  66 splice(@a, 1, 1, "r5");         # shorter
  67 check_contents("rec0$:r5$:rec1$:rec2$:");
  68 splice(@a, 1, 1);               # removal
  69 check_contents("$data");
  70 splice(@a, 1, 0);               # no-op
  71 check_contents("$data");
  72 splice(@a, 1, 0, 'r7', 'rec8'); # insert more than one
  73 check_contents("rec0$:r7$:rec8$:rec1$:rec2$:");
  74 splice(@a, 1, 2, 'rec7', 'record8', 'rec9'); # insert more than delete
  75 check_contents("rec0$:rec7$:record8$:rec9$:rec1$:rec2$:");
  76
  77 splice(@a, 1, 3, 'record9', 'rec10'); # delete more than insert
  78 check_contents("rec0$:record9$:rec10$:rec1$:rec2$:");
  79 splice(@a, 1, 2);               # delete more than one
  80 check_contents("$data");
  81
  82 # (43-62) splicing at the end
  83 splice(@a, 3, 0, "rec4");
  84 check_contents("$ {data}rec4$:");
  85 splice(@a, 3, 1, "rec5");       # same length
  86 check_contents("$ {data}rec5$:");
  87 splice(@a, 3, 1, "record5");    # longer
  88 check_contents("$ {data}record5$:");
  89
  90 splice(@a, 3, 1, "r5");         # shorter
  91 check_contents("$ {data}r5$:");
  92 splice(@a, 3, 1);               # removal
  93 check_contents("$data");
  94 splice(@a, 3, 0);               # no-op
  95 check_contents("$data");
  96 splice(@a, 3, 0, 'r7', 'rec8'); # insert more than one
  97 check_contents("$ {data}r7$:rec8$:");
  98 splice(@a, 3, 2, 'rec7', 'record8', 'rec9'); # insert more than delete
  99 check_contents("$ {data}rec7$:record8$:rec9$:");
 100
 101 splice(@a, 3, 3, 'record9', 'rec10'); # delete more than insert
 102 check_contents("$ {data}record9$:rec10$:");
 103 splice(@a, 3, 2);               # delete more than one
 104 check_contents("$data");
 105
 106 # (63-82) splicing with negative subscript
 107 splice(@a, -1, 0, "rec4");
 108 check_contents("rec0$:rec1$:rec4$:rec2$:");
 109 splice(@a, -1, 1, "rec5");       # same length
 110 check_contents("rec0$:rec1$:rec4$:rec5$:");
 111 splice(@a, -1, 1, "record5");    # longer
 112 check_contents("rec0$:rec1$:rec4$:record5$:");
 113
 114 splice(@a, -1, 1, "r5");         # shorter
 115 check_contents("rec0$:rec1$:rec4$:r5$:");
 116 splice(@a, -1, 1);               # removal
 117 check_contents("rec0$:rec1$:rec4$:");
 118 splice(@a, -1, 0);               # no-op
 119 check_contents("rec0$:rec1$:rec4$:");
 120 splice(@a, -1, 0, 'r7', 'rec8'); # insert more than one
 121 check_contents("rec0$:rec1$:r7$:rec8$:rec4$:");
 122 splice(@a, -1, 2, 'rec7', 'record8', 'rec9'); # insert more than delete
 123 check_contents("rec0$:rec1$:r7$:rec8$:rec7$:record8$:rec9$:");
 124
 125 splice(@a, -3, 3, 'record9', 'rec10'); # delete more than insert
 126 check_contents("rec0$:rec1$:r7$:rec8$:record9$:rec10$:");
 127 splice(@a, -4, 3);               # delete more than one
 128 check_contents("rec0$:rec1$:rec10$:");
 129
 130 # (83-84) scrub it all out
 131 splice(@a, 0, 3);
 132 check_contents("");
 133
 134 # (85-86) put some back in
 135 splice(@a, 0, 0, "rec0", "rec1");
 136 check_contents("rec0$:rec1$:");
 137
 138 # (87-88) what if we remove too many records?
 139 splice(@a, 0, 17);
 140 check_contents("");
 141
 142 # (89-92) In the past, splicing past the end was not correctly detected
 143 # (1.14)
 144 splice(@a, 89, 3);
 145 check_contents("");
 146 splice(@a, @a, 3);
 147 check_contents("");
 148
 149 # (93-96) Also we did not emulate splice's freaky behavior when inserting
 150 # past the end of the array (1.14)
 151 splice(@a, 89, 0, "I", "like", "pie");
 152 check_contents("I$:like$:pie$:");
 153 splice(@a, 89, 0, "pie pie pie");
 154 check_contents("I$:like$:pie$:pie pie pie$:");
 155
 156 # (97) Splicing with too large a negative number should be fatal
 157 # This test ignored because it causes 5.6.1 and 5.7.3 to dump core
 158 # It also garbles the stack under 5.005_03 (20020401)
 159 # NOT MY FAULT
 160 if ($] > 5.008) {
 161   eval { splice(@a, -7, 0) };
 162   print $@ =~ /^Modification of non-creatable array value attempted, subscript -7/
 163       ? "ok $N\n" : "not ok $N \# \$\@ was '$@'\n";
 164 } else {
 165   print "ok $N \# skipped (5.6.0 through 5.8 dump core here.)\n";
 166 }
 167 $N++;
 168
 169 # (98-101) Test default arguments
 170 splice @a, 0, 0, (0..11);
 171 splice @a, 4;
 172 check_contents("0$:1$:2$:3$:");
 173 splice @a;
 174 check_contents("");
 175
 176 # (102-103) I think there's a bug here---it will fail to clear the EOF flag
 177 @a = (0..11);
 178 splice @a, -1, 1000;
 179 check_contents("0$:1$:2$:3$:4$:5$:6$:7$:8$:9$:10$:");
 180
 181 # (104-106) make sure that undefs are treated correctly---they should
 182 # be converted to empty records, and should not raise any warnings.
 183 # (Some of these failed in 0.90.  The change to _fixrec fixed them.)
 184 # 20020331
 185 {
 186   my $good = 1; my $warn;
 187   # If any of these raise warnings, we have a problem.
 188   local $SIG{__WARN__} = sub { $good = 0; $warn = shift(); ctrlfix($warn)};
 189   local $^W = 1;
 190   @a = (1);
 191   splice @a, 1, 0, undef, undef, undef;
 192   print $good ? "ok $N\n" : "not ok $N # $warn\n";
 193   $N++; $good = 1;
 194   print defined($a[2]) ? "ok $N\n" : "not ok $N\n";
 195   $N++; $good = 1;
 196   my @r = splice @a, 2;
 197   print defined($r[0]) ? "ok $N\n" : "not ok $N\n";
 198   $N++; $good = 1;
 199 }
 200
 201 # (107-118) splice with negative length was treated wrong
 202 # 20020402 Reported by Juerd Waalboer
 203 @a = (0..8) ;
 204 splice @a, 0, -3;
 205 check_contents("6$:7$:8$:");
 206 @a = (0..8) ;
 207 splice @a, 1, -3;
 208 check_contents("0$:6$:7$:8$:");
 209 @a = (0..8) ;
 210 splice @a, 7, -3;
 211 check_contents("0$:1$:2$:3$:4$:5$:6$:7$:8$:");
 212 @a = (0..2) ;
 213 splice @a, 0, -3;
 214 check_contents("0$:1$:2$:");
 215 @a = (0..2) ;
 216 splice @a, 1, -3;
 217 check_contents("0$:1$:2$:");
 218 @a = (0..2) ;
 219 splice @a, 7, -3;
 220 check_contents("0$:1$:2$:");
 221
 222 sub init_file {
 223   my $data = shift;
 224   open F, "> $file" or die $!;
 225   binmode F;
 226   print F $data;
 227   close F;
 228 }
 229
 230 use POSIX 'SEEK_SET';
 231 sub check_contents {
 232   my $x = shift;
 233   my $integrity = $o->_check_integrity($file, $ENV{INTEGRITY});
 234   local *FH = $o->{fh};
 235   seek FH, 0, SEEK_SET;
 236   print $integrity ? "ok $N\n" : "not ok $N\n";
 237   $N++;
 238   my $a;
 239   { local $/; $a = <FH> }
 240   $a = "" unless defined $a;
 241   if ($a eq $x) {
 242     print "ok $N\n";
 243   } else {
 244     ctrlfix($a, $x);
 245     print "not ok $N\n# expected <$x>, got <$a>\n";
 246   }
 247   $N++;
 248 }
 249
 250
 251 sub ctrlfix {
 252   for (@_) {
 253     s/\n/\\n/g;
 254     s/\r/\\r/g;
 255   }
 256 }
 257
 258 END {
 259   undef $o;
 260   untie @a;
 261   1 while unlink $file;
 262 }
 263