t/Root/IO.t

   1 # -*-Perl-*- Test Harness script for Bioperl
   2
   3 use strict;
   4 use warnings;
   5
   6 BEGIN {
   7     use lib '.';
   8     use Bio::Root::Test;
   9     test_begin(-tests => 154);
  10     use_ok 'Bio::Root::IO';
  11 }
  12
  13
  14 ok my $obj = Bio::Root::IO->new();
  15 isa_ok $obj, 'Bio::Root::IO';
  16
  17
  18 #############################################
  19 # tests for exceptions/debugging/verbosity
  20 #############################################
  21
  22 throws_ok { $obj->throw('Testing throw') } qr/Testing throw/, 'Throw';
  23
  24 $obj->verbose(-1);
  25 throws_ok { $obj->throw('Testing throw') } qr/Testing throw/;
  26
  27 eval { $obj->warn('Testing warn') };
  28 ok !$@, 'Warn';
  29
  30 $obj->verbose(1);
  31 throws_ok { $obj->throw('Testing throw') } qr/Testing throw/;
  32
  33 ok my @stack = $obj->stack_trace(), 'Stack trace';
  34 is scalar @stack, 2;
  35
  36 ok my $verbobj = Bio::Root::IO->new( -verbose => 1, -strict => 1 ), 'Verbosity';
  37 is $verbobj->verbose(), 1;
  38
  39 ok $obj->verbose(-1);
  40
  41
  42 #############################################
  43 # tests for finding executables
  44 #############################################
  45
  46 ok my $io = Bio::Root::IO->new();
  47
  48 # An executable file
  49 my $out_file = 'test_file.txt';
  50 my $out_fh;
  51 open  $out_fh, '>', $out_file or die "Could not write file '$out_file': $!\n";
  52 print $out_fh 'test';
  53 close $out_fh;
  54 # -X test file will fail in Windows regardless of chmod,
  55 # because it looks for the executable suffix (like ".exe")
  56 if ($^O =~ m/mswin/i) {
  57     # An executable file
  58     my $exec_file = 'test_exec.exe';
  59     open my $exe_fh, '>', $exec_file or die "Could not write file '$exec_file': $!\n";
  60     close $exe_fh;
  61     ok $obj->exists_exe($exec_file), 'executable file';
  62     unlink $exec_file or die "Could not delete file '$exec_file': $!\n";
  63
  64     # A not executable file
  65     ok (! $obj->exists_exe($out_file), 'non-executable file');
  66     unlink $out_file  or die "Could not delete file '$out_file': $!\n";
  67 }
  68 else {
  69     # An executable file
  70     chmod 0777, $out_file or die "Could not change permission of file '$out_file': $!\n";
  71     ok $obj->exists_exe($out_file), 'executable file';
  72
  73     # A not executable file
  74     chmod 0444, $out_file or die "Could not change permission of file '$out_file': $!\n";
  75     ok (! $obj->exists_exe($out_file), 'non-executable file');
  76     unlink $out_file or die "Could not delete file '$out_file': $!\n";
  77 }
  78
  79 # An executable dir
  80 my $out_dir = 'test_dir';
  81 mkdir $out_dir or die "Could not write dir '$out_dir': $!\n";
  82 chmod 0777, $out_dir or die "Could not change permission of dir '$out_dir': $!\n";
  83 ok (! $obj->exists_exe($out_dir), 'executable dir');
  84 rmdir $out_dir or die "Could not delete dir '$out_dir': $!\n";
  85
  86
  87 #############################################
  88 # tests for handle read and write abilities
  89 #############################################
  90
  91 # Test catfile
  92
  93 ok my $in_file = Bio::Root::IO->catfile(qw(t data test.waba));
  94 is $in_file, test_input_file('test.waba');
  95
  96 ok my $in_file_2 = Bio::Root::IO->catfile(qw(t data test.txt));
  97
  98 $out_file = test_output_file();
  99
 100
 101 # Test with files
 102
 103 ok my $rio = Bio::Root::IO->new( -input => $in_file ), 'Read from file';
 104 is $rio->file, $in_file;
 105 is_deeply [$rio->cleanfile], [undef, $in_file];
 106 is $rio->mode, 'r';
 107 ok $rio->close;
 108
 109 ok $rio = Bio::Root::IO->new( -file => '<'.$in_file );
 110 is $rio->file, '<'.$in_file;
 111 is_deeply [$rio->cleanfile], ['<', $in_file];
 112 1 while $rio->_readline; # read entire file content
 113 is $rio->mode, 'r';
 114 ok $rio->close;
 115
 116 ok my $wio = Bio::Root::IO->new( -file => ">$out_file" ), 'Write to file';
 117 is $wio->file, ">$out_file";
 118 is_deeply [$wio->cleanfile], ['>', $out_file];
 119 is $wio->mode, 'w';
 120 ok $wio->close;
 121
 122 ok $rio = Bio::Root::IO->new( -file => "+>$out_file" ), 'Read+write to file';
 123 is $rio->file, "+>$out_file";
 124 is_deeply [$rio->cleanfile], ['+>', $out_file];
 125 is $rio->mode, 'rw';
 126 ok $rio->close;
 127
 128
 129 # Test with handles
 130
 131 my $in_fh;
 132 open $in_fh , '<', $in_file  or die "Could not read file '$in_file': $!\n", 'Read from GLOB handle';
 133 ok $rio = Bio::Root::IO->new( -fh => $in_fh );
 134 is $rio->_fh, $in_fh;
 135 is $rio->mode, 'r';
 136 close $in_fh;
 137
 138 open $out_fh, '>', $out_file or die "Could not write file '$out_file': $!\n", 'Write to GLOB handle';
 139 ok $wio = Bio::Root::IO->new( -fh => $out_fh );
 140 is $wio->_fh, $out_fh;
 141 is $wio->mode, 'w';
 142 close $out_fh;
 143
 144 SKIP: {
 145     eval { require File::Temp; }
 146        or skip 'could not create File::Temp object, maybe your File::Temp is 10 years old', 4;
 147
 148     $out_fh = File::Temp->new;
 149     ok $wio = Bio::Root::IO->new( -fh => $out_fh ), 'Read from File::Temp handle';
 150     isa_ok $wio, 'Bio::Root::IO';
 151     is $wio->mode, 'rw', 'is a write handle';
 152     warnings_like sub { $wio->close }, '', 'no warnings in ->close()';
 153     ok $wio->close;
 154 }
 155
 156
 157 # Exclusive arguments
 158 open $in_fh , '<', $in_file  or die "Could not read file '$in_file': $!\n", 'Read from GLOB handle';
 159 throws_ok {$rio = Bio::Root::IO->new( -input => $in_file, -fh     => $in_fh     )} qr/Providing both a file and a filehandle for reading/, 'Exclusive arguments';
 160 throws_ok {$rio = Bio::Root::IO->new( -input => $in_file, -file   => $in_file_2 )} qr/Input file given twice/;
 161 throws_ok {$rio = Bio::Root::IO->new( -input => $in_file, -string => 'abcedf'   )} qr/File or filehandle provided with -string/;
 162 throws_ok {$rio = Bio::Root::IO->new( -fh    => $in_fh  , -file   => $in_file   )} qr/Providing both a file and a filehandle for reading/;
 163 throws_ok {$rio = Bio::Root::IO->new( -fh    => $in_fh  , -string => 'abcedf'   )} qr/File or filehandle provided with -string/;
 164 throws_ok {$rio = Bio::Root::IO->new( -file  => $in_file, -string => 'abcedf'   )} qr/File or filehandle provided with -string/;
 165 close $in_fh;
 166
 167 lives_ok  {$rio = Bio::Root::IO->new( -input => $in_file, -file   => $in_file   )} 'Same file';
 168
 169
 170 ##############################################
 171 # tests _pushback for multi-line buffering
 172 ##############################################
 173
 174 ok $rio = Bio::Root::IO->new( -file => $in_file ), 'Pushback';
 175
 176 ok my $line1 = $rio->_readline;
 177 ok my $line2 = $rio->_readline;
 178
 179 ok $rio->_pushback($line2);
 180 ok $rio->_pushback($line1);
 181
 182 ok my $line3 = $rio->_readline;
 183 ok my $line4 = $rio->_readline;
 184 ok my $line5 = $rio->_readline;
 185
 186 is $line1, $line3;
 187 is $line2, $line4;
 188 isnt $line5, $line4;
 189
 190 ok $rio->close;
 191
 192
 193 ##############################################
 194 # test _print and _insert
 195 ##############################################
 196
 197 ok my $fio = Bio::Root::IO->new( -file => ">$out_file" );
 198 ok $fio->_print("line 1\n"), '_print';
 199 ok $fio->_print("line 2\n");
 200 ok $fio->_insert("insertion at line 2\n",2), '_insert at middle of file';
 201 ok $fio->_print("line 3\n");
 202 ok $fio->_print("line 4\n");
 203 ok $fio->close;
 204
 205 open my $checkio, '<', $out_file or die "Could not read file '$out_file': $!\n";
 206 my @content = <$checkio>;
 207 close $checkio;
 208 is_deeply \@content, ["line 1\n","insertion at line 2\n","line 2\n","line 3\n","line 4\n"];
 209
 210 ok $fio = Bio::Root::IO->new(-file=>">$out_file");
 211 ok $fio->_insert("insertion at line 1\n",1), '_insert in empty file';
 212 ok $fio->close;
 213
 214 open $checkio, '<', $out_file or die "Could not read file '$out_file': $!\n";
 215 @content = <$checkio>;
 216 close $checkio;
 217 is_deeply \@content, ["insertion at line 1\n"];
 218
 219
 220 ##############################################
 221 # test Win vs UNIX line ending
 222 ##############################################
 223
 224 {
 225     ok my $unix_rio = Bio::Root::IO->new(-file => test_input_file('U71225.gb.unix'));
 226     ok my $win_rio  = Bio::Root::IO->new(-file => test_input_file('U71225.gb.win' ));
 227     ok my $mac_rio  = Bio::Root::IO->new(-file => test_input_file('U71225.gb.mac' ));
 228
 229     my $expected = "LOCUS       U71225                  1164 bp    DNA     linear   VRT 27-NOV-2001\n";
 230     is $unix_rio->_readline, $expected;
 231     is $win_rio->_readline , $expected;
 232     like $mac_rio->_readline, qr#^LOCUS.*//\n$#ms;
 233     # line spans entire file because lines end with "\r" but $/ is "\n"
 234
 235     $expected = "DEFINITION  Desmognathus quadramaculatus 12S ribosomal RNA gene, partial\n";
 236     is $unix_rio->_readline, $expected;
 237     is $win_rio->_readline , $expected;
 238     is $mac_rio->_readline , undef;
 239
 240     $expected = "            sequence; tRNA-Val gene, complete sequence; and 16S ribosomal RNA\n";
 241     is $unix_rio->_readline, $expected;
 242     is $win_rio->_readline , $expected;
 243     is $mac_rio->_readline , undef;
 244
 245     $expected = "            gene, partial sequence, mitochondrial genes for mitochondrial RNAs.\n";
 246     is $unix_rio->_readline, $expected;
 247     is $win_rio->_readline , $expected;
 248     is $mac_rio->_readline , undef;
 249
 250     $expected = "ACCESSION   U71225\n";
 251     is $unix_rio->_readline, $expected;
 252     is $win_rio->_readline , $expected;
 253     is $mac_rio->_readline , undef;
 254
 255     # In Windows the "-raw" parameter has no effect, because Perl already discards
 256     # the '\r' from the line when reading in text mode from the filehandle
 257     # ($line = <$fh>), and put it back automatically when printing
 258     if ($^O =~ m/mswin/i) {
 259         is $win_rio->_readline( -raw => 1) , "VERSION     U71225.1  GI:2804359\n";
 260     }
 261     else {
 262         is $win_rio->_readline( -raw => 1) , "VERSION     U71225.1  GI:2804359\r\n";
 263     }
 264     is $win_rio->_readline( -raw => 0) , "KEYWORDS    .\n";
 265 }
 266
 267
 268 ##############################################
 269 # test Win vs UNIX line ending using PerlIO::eol
 270 ##############################################
 271
 272 SKIP: {
 273     test_skip(-tests => 20, -requires_module => 'PerlIO::eol');
 274
 275     local $Bio::Root::IO::HAS_EOL = 1;
 276     ok my $unix_rio = Bio::Root::IO->new(-file => test_input_file('U71225.gb.unix'));
 277     ok my $win_rio  = Bio::Root::IO->new(-file => test_input_file('U71225.gb.win' ));
 278     ok my $mac_rio  = Bio::Root::IO->new(-file => test_input_file('U71225.gb.mac' ));
 279
 280     my $expected = "LOCUS       U71225                  1164 bp    DNA     linear   VRT 27-NOV-2001\n";
 281     is $unix_rio->_readline, $expected;
 282     is $win_rio->_readline , $expected;
 283     is $mac_rio->_readline , $expected;
 284
 285     $expected = "DEFINITION  Desmognathus quadramaculatus 12S ribosomal RNA gene, partial\n";
 286     is $unix_rio->_readline, $expected;
 287     TODO: {
 288         local $TODO = "Sporadic test failures when running using PerlIO::eol on Linux w/".
 289                       "Windows line endings: #";
 290         is $win_rio->_readline , $expected;
 291     };
 292     is $mac_rio->_readline , $expected;
 293
 294     $expected = "            sequence; tRNA-Val gene, complete sequence; and 16S ribosomal RNA\n";
 295     is $unix_rio->_readline, $expected;
 296     TODO: {
 297         local $TODO = "Sporadic test failures when running using PerlIO::eol on Linux w/".
 298                       "Windows line endings: #";
 299         is $win_rio->_readline , $expected;
 300     };
 301     is $mac_rio->_readline , $expected;
 302
 303     $expected = "            gene, partial sequence, mitochondrial genes for mitochondrial RNAs.\n";
 304     is $unix_rio->_readline, $expected;
 305     TODO: {
 306         local $TODO = "Sporadic test failures when running using PerlIO::eol on Linux w/".
 307                       "Windows line endings: #";
 308         is $win_rio->_readline , $expected;
 309     };
 310     is $mac_rio->_readline , $expected;
 311
 312     $expected = "ACCESSION   U71225\n";
 313     is $unix_rio->_readline, $expected;
 314     TODO: {
 315         local $TODO = "Sporadic test failures when running using PerlIO::eol on Linux w/".
 316                       "Windows line endings: #";
 317         is $win_rio->_readline , $expected;
 318     };
 319     is $mac_rio->_readline , $expected;
 320
 321     # $HAS_EOL ignores -raw
 322     is $win_rio->_readline( -raw => 1) , "VERSION     U71225.1  GI:2804359\n";
 323     is $win_rio->_readline( -raw => 0) , "KEYWORDS    .\n";
 324 }
 325
 326
 327 ##############################################
 328 # test Path::Class support
 329 ##############################################
 330
 331 SKIP: {
 332     test_skip(-tests => 2, -requires_module => 'Path::Class');
 333     my $f = sub { Bio::Root::IO->new( -file => Path::Class::file(test_input_file('U71225.gb.unix') ) ) };
 334     lives_ok(sub { $f->() } , 'Bio::Root::IO->new can handle a Path::Class object');
 335     isa_ok($f->(), 'Bio::Root::IO');
 336 }
 337
 338
 339 ##############################################
 340 # test -string
 341 ##############################################
 342
 343 my $teststring = "Foo\nBar\nBaz";
 344 ok $rio = Bio::Root::IO->new(-string => $teststring), 'Read string';
 345
 346 is $rio->mode, 'r';
 347
 348 ok $line1 = $rio->_readline;
 349 is $line1, "Foo\n";
 350
 351 ok $line2 = $rio->_readline;
 352 is $line2, "Bar\n";
 353 ok $rio->_pushback($line2);
 354
 355 ok $line3 = $rio->_readline;
 356 is $line3, "Bar\n";
 357 ok $line3 = $rio->_readline;
 358 is $line3, 'Baz';
 359
 360
 361 ##############################################
 362 # test tempfile()
 363 ##############################################
 364 {
 365 ok my $obj = Bio::Root::IO->new(-verbose => 0);
 366
 367 isa_ok $obj, 'Bio::Root::IO';
 368
 369 my $TEST_STRING = "Bioperl rocks!\n";
 370
 371 my ($tfh,$tfile);
 372
 373 eval {
 374     ($tfh, $tfile) = $obj->tempfile();
 375     isa_ok $tfh, 'GLOB';
 376     print $tfh $TEST_STRING;
 377     close $tfh;
 378     open my $IN, '<', $tfile or die "Could not read file '$tfile': $!\n";
 379     my $val = join '', <$IN>;
 380     is $val, $TEST_STRING;
 381     close $IN;
 382     ok -e $tfile;
 383     undef $obj;
 384 };
 385 undef $obj;
 386 if ( $@ ) {
 387     ok 0;
 388 } else {
 389     ok ! -e $tfile, 'auto UNLINK => 1';
 390 }
 391
 392 $obj = Bio::Root::IO->new();
 393
 394 eval {
 395     my $tdir = $obj->tempdir(CLEANUP=>1);
 396     ok -d $tdir;
 397     ($tfh, $tfile) = $obj->tempfile(dir => $tdir);
 398     close $tfh;
 399     ok -e $tfile;
 400     undef $obj; # see Bio::Root::IO::_io_cleanup
 401 };
 402
 403 if ( $@ ) {
 404     ok 0;
 405 } else {
 406     ok ! -e $tfile, 'tempfile deleted';
 407 }
 408
 409 eval {
 410     $obj = Bio::Root::IO->new(-verbose => 0);
 411     ($tfh, $tfile) = $obj->tempfile(UNLINK => 0);
 412     isa_ok $tfh, 'GLOB';
 413     close $tfh;
 414     ok -e $tfile;
 415     undef $obj; # see Bio::Root::IO::_io_cleanup
 416 };
 417
 418 if ( $@ ) {
 419    ok 0;
 420 } else {
 421    ok -e $tfile, 'UNLINK => 0';
 422 }
 423
 424 ok unlink( $tfile) == 1 ;
 425
 426
 427 ok $obj = Bio::Root::IO->new;
 428
 429 # check suffix is applied
 430 my ($fh1, $fn1) = $obj->tempfile(SUFFIX => '.bioperl');
 431 isa_ok $fh1, 'GLOB';
 432 like $fn1, qr/\.bioperl$/, 'tempfile suffix';
 433 ok close $fh1;
 434
 435 # check single return value mode of File::Temp
 436 my $fh2 = $obj->tempfile;
 437 isa_ok $fh2, 'GLOB';
 438 ok $fh2, 'tempfile() in scalar context';
 439 ok close $fh2;
 440 }
 441