tests/gpst-file/gpst-file.t

   1 #!/usr/bin/perl -w
   2
   3 #=======================================================================
   4 # tests/gpst-file/gpst-file.t
   5 # File ID: bbcbed10-009f-11de-824e-000475e441b9
   6 # Test suite for gpst-file(1).
   7 #
   8 # Character set: UTF-8
   9 # ©opyleft 2009– Øyvind A. Holm <sunny@sunbase.org>
  10 # License: GNU General Public License version 3 or later, see end of
  11 # file for legal stuff.
  12 #=======================================================================
  13
  14 use strict;
  15
  16 BEGIN {
  17     # push(@INC, "$ENV{'HOME'}/bin/STDlibdirDTS");
  18     use Test::More qw{no_plan};
  19     # use_ok() goes here
  20 }
  21
  22 use Getopt::Long;
  23
  24 $| = 1;
  25
  26 our $Debug = 0;
  27 our $CMD = "../../gpst-file";
  28
  29 our %Opt = (
  30
  31     'all' => 0,
  32     'debug' => 0,
  33     'help' => 0,
  34     'todo' => 0,
  35     'verbose' => 0,
  36     'version' => 0,
  37
  38 );
  39
  40 our $progname = $0;
  41 $progname =~ s/^.*\/(.*?)$/$1/;
  42 our $VERSION = "0.00";
  43
  44 Getopt::Long::Configure("bundling");
  45 GetOptions(
  46
  47     "all|a" => \$Opt{'all'},
  48     "debug" => \$Opt{'debug'},
  49     "help|h" => \$Opt{'help'},
  50     "todo|t" => \$Opt{'todo'},
  51     "verbose|v+" => \$Opt{'verbose'},
  52     "version" => \$Opt{'version'},
  53
  54 ) || die("$progname: Option error. Use -h for help.\n");
  55
  56 $Opt{'debug'} && ($Debug = 1);
  57 $Opt{'help'} && usage(0);
  58 if ($Opt{'version'}) {
  59     print_version();
  60     exit(0);
  61 }
  62
  63 diag(sprintf("========== Executing %s v%s ==========",
  64     $progname,
  65     $VERSION));
  66
  67 chdir("files") || die("$progname: files/: Cannot chdir: $!\n");
  68 system("tar xzf testfile.tar.gz");
  69 chdir("..");
  70
  71 if ($Opt{'todo'} && !$Opt{'all'}) {
  72     goto todo_section;
  73 }
  74
  75 =pod
  76
  77 testcmd("$CMD command", # {{{
  78     <<END,
  79 [expected stdin]
  80 END
  81     "",
  82     "description",
  83 );
  84
  85 # }}}
  86
  87 =cut
  88
  89 diag("Testing --author option...");
  90 testcmd("$CMD -a sunny files/testfile/file.txt", # {{{
  91     <<END,
  92 1\t2009-02-23T21:58:01\t\\N\t\\N\tfile.txt\tsunny
  93 END
  94     "",
  95     "--author option works",
  96 );
  97
  98 # }}}
  99 testcmd("$CMD -a sunny -o xml files/testfile/file.txt", # {{{
 100     <<END,
 101 <?xml version="1.0" encoding="UTF-8"?>
 102 <gpstfile>
 103   <file>
 104     <filename>file.txt</filename>
 105     <date>2009-02-23T21:58:01</date>
 106     <author>sunny</author>
 107   </file>
 108 </gpstfile>
 109 END
 110     "",
 111     "Author info is included with -o xml",
 112 );
 113
 114 # }}}
 115 # diag("Testing --debug option...");
 116 diag("Testing --description option...");
 117 testcmd("$CMD -d 'Description stuff \\&<>' files/testfile/file.txt", # {{{
 118     <<END,
 119 1\t2009-02-23T21:58:01\t\\N\tDescription stuff \\\\&<>\tfile.txt\t\\N
 120 END
 121     "",
 122     "--description with backslash and stuff",
 123 );
 124
 125 # }}}
 126 testcmd("$CMD -o xml -d 'Description stuff \\&<>' files/testfile/file.txt", # {{{
 127     <<END,
 128 <?xml version="1.0" encoding="UTF-8"?>
 129 <gpstfile>
 130   <file>
 131     <filename>file.txt</filename>
 132     <date>2009-02-23T21:58:01</date>
 133     <desc>Description stuff \\&amp;&lt;&gt;</desc>
 134   </file>
 135 </gpstfile>
 136 END
 137     "",
 138     "--description with backslash and stuff",
 139 );
 140
 141 # }}}
 142 diag("Testing -h (--help) option...");
 143 likecmd("$CMD -h", # {{{
 144     '/  Show this help\./',
 145     '/^$/',
 146     "Option -h prints help screen",
 147 );
 148
 149 # }}}
 150 diag("Testing --output-format option..."); # {{{
 151 # pgtab
 152 testcmd("$CMD -o pgtab files/testfile/file.txt", # {{{
 153     <<END,
 154 1\t2009-02-23T21:58:01\t\\N\t\\N\tfile.txt\t\\N
 155 END
 156     "",
 157     "Output pgtab format from DSC_4426.JPG",
 158 );
 159
 160 # }}}
 161 # xml
 162 testcmd("$CMD -o xml files/testfile/file.txt", # {{{
 163     <<END,
 164 <?xml version="1.0" encoding="UTF-8"?>
 165 <gpstfile>
 166   <file>
 167     <filename>file.txt</filename>
 168     <date>2009-02-23T21:58:01</date>
 169   </file>
 170 </gpstfile>
 171 END
 172     "",
 173     "Output XML information for DSC_4426.JPG",
 174 );
 175
 176 # }}}
 177 # Unknown format
 178 testcmd("$CMD -o blurfl files/testfile/file.txt", # {{{
 179     "",
 180     "gpst-file: blurfl: Unknown output format\n",
 181     "Unknown output format specified",
 182 );
 183
 184 # }}}
 185 # }}} --output-format
 186 diag("Testing -w (--strip-whitespace) option...");
 187 testcmd("$CMD -w -o xml files/testfile/file.txt", # {{{
 188     <<END,
 189 <?xml version="1.0" encoding="UTF-8"?>
 190 <gpstfile>
 191 <file>
 192 <filename>file.txt</filename>
 193 <date>2009-02-23T21:58:01</date>
 194 </file>
 195 </gpstfile>
 196 END
 197     "",
 198     "Strip whitespace from XML",
 199 );
 200
 201 # }}}
 202 diag("Testing -T (--timezone) option...");
 203 testcmd("$CMD --timezone +1234 files/testfile/file.txt", # {{{
 204     <<END,
 205 1\t2009-02-23T21:58:01+1234\t\\N\t\\N\tfile.txt\t\\N
 206 END
 207     "",
 208     "--timezone works",
 209 );
 210
 211 # }}}
 212 testcmd("$CMD -T +0200 files/testfile/file.txt", # {{{
 213     <<END,
 214 1\t2009-02-23T21:58:01+0200\t\\N\t\\N\tfile.txt\t\\N
 215 END
 216     "",
 217     "Positive time zone",
 218 );
 219
 220 # }}}
 221 testcmd("$CMD -T-0600 files/testfile/file.txt", # {{{
 222     <<END,
 223 1\t2009-02-23T21:58:01-0600\t\\N\t\\N\tfile.txt\t\\N
 224 END
 225     "",
 226     "Negative time zone",
 227 );
 228
 229 # }}}
 230 testcmd("$CMD -T CET files/testfile/file.txt", # {{{
 231     <<END,
 232 1\t2009-02-23T21:58:01 CET\t\\N\t\\N\tfile.txt\t\\N
 233 END
 234     "",
 235     "Time zone abbreviation",
 236 );
 237
 238 # }}}
 239 testcmd("$CMD -T cet files/testfile/file.txt", # {{{
 240     <<END,
 241 1\t2009-02-23T21:58:01 CET\t\\N\t\\N\tfile.txt\t\\N
 242 END
 243     "",
 244     "Time zone is converted to upper case",
 245 );
 246
 247 # }}}
 248 testcmd("$CMD -T Z files/testfile/file.txt", # {{{
 249     <<END,
 250 1\t2009-02-23T21:58:01Z\t\\N\t\\N\tfile.txt\t\\N
 251 END
 252     "",
 253     "Zulu abbreviation",
 254 );
 255
 256 # }}}
 257 testcmd("$CMD -T erf324 files/testfile/file.txt", # {{{
 258     "",
 259     "gpst-file: erf324: Invalid time zone\n",
 260     "Invalid time zone abbr, contains digits",
 261 );
 262
 263 # }}}
 264 testcmd("$CMD -T CET -o xml files/testfile/file.txt", # {{{
 265     <<END,
 266 <?xml version="1.0" encoding="UTF-8"?>
 267 <gpstfile>
 268   <file>
 269     <filename>file.txt</filename>
 270     <date>2009-02-23T21:58:01 CET</date>
 271   </file>
 272 </gpstfile>
 273 END
 274     "",
 275     "Time zone abbr. works with -o xml",
 276 );
 277
 278 # }}}
 279 testcmd("$CMD -T Z -o xml files/testfile/file.txt", # {{{
 280     <<END,
 281 <?xml version="1.0" encoding="UTF-8"?>
 282 <gpstfile>
 283   <file>
 284     <filename>file.txt</filename>
 285     <date>2009-02-23T21:58:01Z</date>
 286   </file>
 287 </gpstfile>
 288 END
 289     "",
 290     "Zulu time zone works with -o xml",
 291 );
 292
 293 # }}}
 294 diag("Testing -v (--verbose) option...");
 295 likecmd("$CMD -hv", # {{{
 296     '/^\n\S+ v\d\.\d\d\n/s',
 297     '/^$/',
 298     "Option --version with -h returns version number and help screen",
 299 );
 300
 301 # }}}
 302 diag("Testing --version option...");
 303 likecmd("$CMD --version", # {{{
 304     '/^\S+ v\d\.\d\d\n/',
 305     '/^$/',
 306     "Option --version returns version number",
 307 );
 308
 309 # }}}
 310 diag("Various...");
 311 testcmd("$CMD files/testfile/file.txt", # {{{
 312     <<END,
 313 1\t2009-02-23T21:58:01\t\\N\t\\N\tfile.txt\t\\N
 314 END
 315     "",
 316     "No options",
 317 );
 318
 319 # }}}
 320 testcmd("echo files/testfile/file.txt | $CMD", # {{{
 321     <<END,
 322 1\t2009-02-23T21:58:01\t\\N\t\\N\tfile.txt\t\\N
 323 END
 324     "",
 325     "Read filename from stdin",
 326 );
 327
 328 # }}}
 329
 330 todo_section:
 331 ;
 332
 333 if ($Opt{'all'} || $Opt{'todo'}) {
 334     diag("Running TODO tests..."); # {{{
 335
 336     TODO: {
 337
 338 local $TODO = "";
 339 # Insert TODO tests here.
 340
 341     }
 342     # TODO tests }}}
 343 }
 344
 345 unlink("files/testfile/file.txt") || warn("$progname: files/testfile/file.txt: Cannot remove file: $!\n");
 346 rmdir("files/testfile") || warn("$progname: files/testfile: Cannot remove directory: $!\n");
 347
 348 diag("Testing finished.");
 349
 350 sub testcmd {
 351     # {{{
 352     my ($Cmd, $Exp_stdout, $Exp_stderr, $Desc) = @_;
 353     my $stderr_cmd = "";
 354     my $deb_str = $Opt{'debug'} ? " --debug" : "";
 355     my $Txt = join("",
 356         "\"$Cmd\"",
 357         defined($Desc)
 358             ? " - $Desc"
 359             : ""
 360     );
 361     my $TMP_STDERR = "gpst-file-stderr.tmp";
 362
 363     if (defined($Exp_stderr) && !length($deb_str)) {
 364         $stderr_cmd = " 2>$TMP_STDERR";
 365     }
 366     is(`$Cmd$deb_str$stderr_cmd`, $Exp_stdout, $Txt);
 367     if (defined($Exp_stderr)) {
 368         if (!length($deb_str)) {
 369             is(file_data($TMP_STDERR), $Exp_stderr, "$Txt (stderr)");
 370             unlink($TMP_STDERR);
 371         }
 372     } else {
 373         diag("Warning: stderr not defined for '$Txt'");
 374     }
 375     # }}}
 376 } # testcmd()
 377
 378 sub likecmd {
 379     # {{{
 380     my ($Cmd, $Exp_stdout, $Exp_stderr, $Desc) = @_;
 381     my $stderr_cmd = "";
 382     my $deb_str = $Opt{'debug'} ? " --debug" : "";
 383     my $Txt = join("",
 384         "\"$Cmd\"",
 385         defined($Desc)
 386             ? " - $Desc"
 387             : ""
 388     );
 389     my $TMP_STDERR = "gpst-file-stderr.tmp";
 390
 391     if (defined($Exp_stderr) && !length($deb_str)) {
 392         $stderr_cmd = " 2>$TMP_STDERR";
 393     }
 394     like(`$Cmd$deb_str$stderr_cmd`, "$Exp_stdout", $Txt);
 395     if (defined($Exp_stderr)) {
 396         if (!length($deb_str)) {
 397             like(file_data($TMP_STDERR), "$Exp_stderr", "$Txt (stderr)");
 398             unlink($TMP_STDERR);
 399         }
 400     } else {
 401         diag("Warning: stderr not defined for '$Txt'");
 402     }
 403     # }}}
 404 } # likecmd()
 405
 406 sub file_data {
 407     # Return file content as a string {{{
 408     my $File = shift;
 409     my $Txt;
 410     if (open(my $fp, "<", $File)) {
 411         $Txt = join("", <$fp>);
 412         close($fp);
 413         return($Txt);
 414     } else {
 415         return;
 416     }
 417     # }}}
 418 } # file_data()
 419
 420 sub print_version {
 421     # Print program version {{{
 422     print("$progname v$VERSION\n");
 423     # }}}
 424 } # print_version()
 425
 426 sub usage {
 427     # Send the help message to stdout {{{
 428     my $Retval = shift;
 429
 430     if ($Opt{'verbose'}) {
 431         print("\n");
 432         print_version();
 433     }
 434     print(<<END);
 435
 436 Usage: $progname [options] [file [files [...]]]
 437
 438 Contains tests for the gpst-file(1) program.
 439
 440 Options:
 441
 442   -a, --all
 443     Run all tests, also TODOs.
 444   -h, --help
 445     Show this help.
 446   -t, --todo
 447     Run only the TODO tests.
 448   -v, --verbose
 449     Increase level of verbosity. Can be repeated.
 450   --version
 451     Print version information.
 452   --debug
 453     Print debugging messages.
 454
 455 END
 456     exit($Retval);
 457     # }}}
 458 } # usage()
 459
 460 sub msg {
 461     # Print a status message to stderr based on verbosity level {{{
 462     my ($verbose_level, $Txt) = @_;
 463
 464     if ($Opt{'verbose'} >= $verbose_level) {
 465         print(STDERR "$progname: $Txt\n");
 466     }
 467     # }}}
 468 } # msg()
 469
 470 __END__
 471
 472 # Plain Old Documentation (POD) {{{
 473
 474 =pod
 475
 476 =head1 NAME
 477
 478 run-tests.pl
 479
 480 =head1 SYNOPSIS
 481
 482 ./gpst-file.t [options] [file [files [...]]]
 483
 484 =head1 DESCRIPTION
 485
 486 Contains tests for the gpst-file(1) program.
 487
 488 =head1 OPTIONS
 489
 490 =over 4
 491
 492 =item B<-a>, B<--all>
 493
 494 Run all tests, also TODOs.
 495
 496 =item B<-h>, B<--help>
 497
 498 Print a brief help summary.
 499
 500 =item B<-t>, B<--todo>
 501
 502 Run only the TODO tests.
 503
 504 =item B<-v>, B<--verbose>
 505
 506 Increase level of verbosity. Can be repeated.
 507
 508 =item B<--version>
 509
 510 Print version information.
 511
 512 =item B<--debug>
 513
 514 Print debugging messages.
 515
 516 =back
 517
 518 =head1 AUTHOR
 519
 520 Made by Øyvind A. Holm S<E<lt>sunny@sunbase.orgE<gt>>.
 521
 522 =head1 COPYRIGHT
 523
 524 Copyleft © Øyvind A. Holm E<lt>sunny@sunbase.orgE<gt>
 525 This is free software; see the file F<COPYING> for legalese stuff.
 526
 527 =head1 LICENCE
 528
 529 This program is free software: you can redistribute it and/or modify it
 530 under the terms of the GNU General Public License as published by the
 531 Free Software Foundation, either version 3 of the License, or (at your
 532 option) any later version.
 533
 534 This program is distributed in the hope that it will be useful, but
 535 WITHOUT ANY WARRANTY; without even the implied warranty of
 536 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 537 See the GNU General Public License for more details.
 538
 539 You should have received a copy of the GNU General Public License along
 540 with this program.
 541 If not, see L<http://www.gnu.org/licenses/>.
 542
 543 =head1 SEE ALSO
 544
 545 =cut
 546
 547 # }}}
 548
 549 # vim: set fenc=UTF-8 ft=perl fdm=marker ts=4 sw=4 sts=4 et fo+=w :