tests/sident.t

   1 #!/usr/bin/env perl
   2
   3 #=======================================================================
   4 # sident.t
   5 # File ID: 9e63b5fe-f989-11dd-9357-000475e441b9
   6 #
   7 # Test suite for sident(1).
   8 #
   9 # Character set: UTF-8
  10 # ©opyleft 2008– Øyvind A. Holm <sunny@sunbase.org>
  11 # License: GNU General Public License version 2 or later, see end of
  12 # file for legal stuff.
  13 #=======================================================================
  14
  15 use strict;
  16 use warnings;
  17
  18 BEGIN {
  19     use Test::More qw{no_plan};
  20     # use_ok() goes here
  21 }
  22
  23 use Getopt::Long;
  24
  25 local $| = 1;
  26
  27 our $CMDB = "sident";
  28 our $CMD = "../$CMDB";
  29
  30 our %Opt = (
  31
  32     'all' => 0,
  33     'help' => 0,
  34     'quiet' => 0,
  35     'todo' => 0,
  36     'verbose' => 0,
  37     'version' => 0,
  38
  39 );
  40
  41 our $progname = $0;
  42 $progname =~ s/^.*\/(.*?)$/$1/;
  43 our $VERSION = '0.0.0';
  44
  45 my %descriptions = ();
  46
  47 Getopt::Long::Configure('bundling');
  48 GetOptions(
  49
  50     'all|a' => \$Opt{'all'},
  51     'help|h' => \$Opt{'help'},
  52     'quiet|q+' => \$Opt{'quiet'},
  53     'todo|t' => \$Opt{'todo'},
  54     'verbose|v+' => \$Opt{'verbose'},
  55     'version' => \$Opt{'version'},
  56
  57 ) || die("$progname: Option error. Use -h for help.\n");
  58
  59 $Opt{'verbose'} -= $Opt{'quiet'};
  60 $Opt{'help'} && usage(0);
  61 if ($Opt{'version'}) {
  62     print_version();
  63     exit(0);
  64 }
  65
  66 exit(main());
  67
  68 sub main {
  69     # {{{
  70     my $Retval = 0;
  71
  72     diag(sprintf('========== Executing %s v%s ==========',
  73                  $progname, $VERSION));
  74
  75     if ($Opt{'todo'} && !$Opt{'all'}) {
  76         goto todo_section;
  77     }
  78
  79 =pod
  80
  81     testcmd("$CMD command", # {{{
  82         <<'END',
  83 [expected stdout]
  84 END
  85         '',
  86         0,
  87         'description',
  88     );
  89
  90     # }}}
  91
  92 =cut
  93
  94     diag('Testing -h (--help) option...');
  95     likecmd("$CMD -h", # {{{
  96         '/  Show this help/i',
  97         '/^$/',
  98         0,
  99         'Option -h prints help screen',
 100     );
 101
 102     # }}}
 103     diag('Testing -v (--verbose) option...');
 104     likecmd("$CMD -hv", # {{{
 105         '/^\n\S+ \d+\.\d+\.\d+/s',
 106         '/^$/',
 107         0,
 108         'Option -v with -h returns version number and help screen',
 109     );
 110
 111     # }}}
 112     diag('Testing --version option...');
 113     likecmd("$CMD --version", # {{{
 114         '/^\S+ \d+\.\d+\.\d+/',
 115         '/^$/',
 116         0,
 117         'Option --version returns version number',
 118     );
 119
 120     # }}}
 121     diag("Testing without options...");
 122     testcmd("$CMD sident-files/textfile", # {{{
 123         <<'END',
 124
 125 sident-files/textfile:
 126      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 127      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 128      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 129      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 130      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 131      $Date: 1999/12/23 21:59:22 $
 132      $Header: /cvsweb/cvs-guide/keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 133      $Id: keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 134      $Weirdo: blah blah $
 135 END
 136         "",
 137         0,
 138         "Read textfile, no arguments",
 139     );
 140
 141     # }}}
 142     testcmd("$CMD sident-files/random", # {{{
 143         <<'END',
 144
 145 sident-files/random:
 146      $Id: randomstuff 314159 1969-01-21 17:12:16Z sunny $
 147 END
 148         "",
 149         0,
 150         "Read random binary data, no arguments",
 151     );
 152
 153     # }}}
 154     diag("Testing stdin...");
 155     testcmd("$CMD - <sident-files/random", # {{{
 156         <<'END',
 157
 158 -:
 159      $Id: randomstuff 314159 1969-01-21 17:12:16Z sunny $
 160 END
 161         "",
 162         0,
 163         "Read random binary data from stdin with hyphen as filename",
 164     );
 165
 166     # }}}
 167     testcmd("cat sident-files/random | $CMD -", # {{{
 168         <<'END',
 169
 170 -:
 171      $Id: randomstuff 314159 1969-01-21 17:12:16Z sunny $
 172 END
 173         "",
 174         0,
 175         "Read random binary through pipe, hyphen filename",
 176     );
 177
 178     # }}}
 179     diag("Testing -e (--expanded-only) option...");
 180     testcmd("$CMD -e sident-files/unexpanded sident-files/textfile", # {{{
 181         <<'END',
 182
 183 sident-files/textfile:
 184      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 185      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 186      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 187      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 188      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 189      $Date: 1999/12/23 21:59:22 $
 190      $Header: /cvsweb/cvs-guide/keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 191      $Id: keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 192      $Weirdo: blah blah $
 193 END
 194         "",
 195         0,
 196         "List only expanded keywords",
 197     );
 198
 199     # }}}
 200     testcmd("$CMD -ev sident-files/unexpanded sident-files/textfile", # {{{
 201         <<'END',
 202
 203 sident-files/unexpanded:
 204
 205 sident-files/textfile:
 206      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 207      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 208      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 209      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 210      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 211      $Date: 1999/12/23 21:59:22 $
 212      $Header: /cvsweb/cvs-guide/keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 213      $Id: keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 214      $Weirdo: blah blah $
 215 END
 216         "",
 217         0,
 218         "List only expanded keywords, plus list filename without expanded kw",
 219     );
 220
 221     # }}}
 222     diag("Testing -f (--filenames-from) option...");
 223     testcmd("$CMD -f sident-files/filenames", # {{{
 224         <<'END',
 225
 226 sident-files/random:
 227      $Id: randomstuff 314159 1969-01-21 17:12:16Z sunny $
 228
 229 sident-files/textfile:
 230      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 231      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 232      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 233      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 234      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 235      $Date: 1999/12/23 21:59:22 $
 236      $Header: /cvsweb/cvs-guide/keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 237      $Id: keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 238      $Weirdo: blah blah $
 239
 240 sident-files/unexpanded:
 241      $URL$
 242      $HeadURL$
 243      $LastChangedBy$
 244      $Date$
 245      $LastChangedDate$
 246      $Rev$
 247      $Revision$
 248      $LastChangedRevision$
 249      $Id$
 250      $RealLyuNKoWN$
 251 END
 252         "",
 253         0,
 254         "Read filenames from file",
 255     );
 256
 257     # }}}
 258     diag("Testing -k (--known-keywords-only) option...");
 259     testcmd("$CMD -k sident-files/textfile", # {{{
 260         <<'END',
 261
 262 sident-files/textfile:
 263      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 264      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 265      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 266      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 267      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 268      $Date: 1999/12/23 21:59:22 $
 269      $Header: /cvsweb/cvs-guide/keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 270      $Id: keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 271 END
 272         "",
 273         0,
 274         "List only known keywords",
 275     );
 276
 277     # }}}
 278     diag("Testing -l (--filenames-only) option...");
 279     testcmd("$CMD -le sident-files/*", # {{{
 280         <<'END',
 281 sident-files/random
 282 sident-files/textfile
 283 END
 284         "",
 285         0,
 286         "Only list names of files with expanded keywords",
 287     );
 288
 289     # }}}
 290     diag("Testing -u (--unique-keywords) option...");
 291     testcmd("$CMD -u sident-files/textfile", # {{{
 292         <<'END',
 293
 294 sident-files/textfile:
 295      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 296      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 297      $Date: 1999/12/23 21:59:22 $
 298      $Header: /cvsweb/cvs-guide/keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 299      $Id: keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 300      $Weirdo: blah blah $
 301 END
 302         "",
 303         0,
 304         "Remove duplicates from textfile",
 305     );
 306
 307     # }}}
 308     testcmd("$CMD -v sident-files/*", # {{{
 309         <<'END',
 310
 311 sident-files/filenames:
 312
 313 sident-files/nothing_here:
 314
 315 sident-files/random:
 316      $Id: randomstuff 314159 1969-01-21 17:12:16Z sunny $
 317
 318 sident-files/textfile:
 319      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 320      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 321      $Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $
 322      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 323      $Id: yeh 1234 2008-09-22 12:25:05Z sunny $
 324      $Date: 1999/12/23 21:59:22 $
 325      $Header: /cvsweb/cvs-guide/keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 326      $Id: keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $
 327      $Weirdo: blah blah $
 328
 329 sident-files/unexpanded:
 330      $URL$
 331      $HeadURL$
 332      $LastChangedBy$
 333      $Date$
 334      $LastChangedDate$
 335      $Rev$
 336      $Revision$
 337      $LastChangedRevision$
 338      $Id$
 339      $RealLyuNKoWN$
 340 END
 341         "",
 342         0,
 343         "Also list files without keywords",
 344     );
 345
 346     # }}}
 347     testcmd("$CMD -vx sident-files/*", # {{{
 348         <<'END',
 349 <?xml version="1.0"?>
 350 <sident>
 351   <file>
 352     <filename>sident-files/filenames</filename>
 353   </file>
 354   <file>
 355     <filename>sident-files/nothing_here</filename>
 356   </file>
 357   <file>
 358     <filename>sident-files/random</filename>
 359     <keywords>
 360       <keyword>$Id: randomstuff 314159 1969-01-21 17:12:16Z sunny $</keyword>
 361     </keywords>
 362   </file>
 363   <file>
 364     <filename>sident-files/textfile</filename>
 365     <keywords>
 366       <keyword>$Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $</keyword>
 367       <keyword>$Id: yeh 1234 2008-09-22 12:25:05Z sunny $</keyword>
 368       <keyword>$Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $</keyword>
 369       <keyword>$Id: yeh 1234 2008-09-22 12:25:05Z sunny $</keyword>
 370       <keyword>$Id: yeh 1234 2008-09-22 12:25:05Z sunny $</keyword>
 371       <keyword>$Date: 1999/12/23 21:59:22 $</keyword>
 372       <keyword>$Header: /cvsweb/cvs-guide/keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $</keyword>
 373       <keyword>$Id: keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $</keyword>
 374       <keyword>$Weirdo: blah blah $</keyword>
 375     </keywords>
 376   </file>
 377   <file>
 378     <filename>sident-files/unexpanded</filename>
 379     <keywords>
 380       <keyword>$URL$</keyword>
 381       <keyword>$HeadURL$</keyword>
 382       <keyword>$LastChangedBy$</keyword>
 383       <keyword>$Date$</keyword>
 384       <keyword>$LastChangedDate$</keyword>
 385       <keyword>$Rev$</keyword>
 386       <keyword>$Revision$</keyword>
 387       <keyword>$LastChangedRevision$</keyword>
 388       <keyword>$Id$</keyword>
 389       <keyword>$RealLyuNKoWN$</keyword>
 390     </keywords>
 391   </file>
 392 </sident>
 393 END
 394         "",
 395         0,
 396         "Output XML, including files without keywords",
 397     );
 398
 399     # }}}
 400     diag("Testing -x (--xml) option...");
 401     testcmd("$CMD -x sident-files/textfile", # {{{
 402         <<'END',
 403 <?xml version="1.0"?>
 404 <sident>
 405   <file>
 406     <filename>sident-files/textfile</filename>
 407     <keywords>
 408       <keyword>$Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $</keyword>
 409       <keyword>$Id: yeh 1234 2008-09-22 12:25:05Z sunny $</keyword>
 410       <keyword>$Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $</keyword>
 411       <keyword>$Id: yeh 1234 2008-09-22 12:25:05Z sunny $</keyword>
 412       <keyword>$Id: yeh 1234 2008-09-22 12:25:05Z sunny $</keyword>
 413       <keyword>$Date: 1999/12/23 21:59:22 $</keyword>
 414       <keyword>$Header: /cvsweb/cvs-guide/keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $</keyword>
 415       <keyword>$Id: keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $</keyword>
 416       <keyword>$Weirdo: blah blah $</keyword>
 417     </keywords>
 418   </file>
 419 </sident>
 420 END
 421         "",
 422         0,
 423         "Output XML from textfile",
 424     );
 425
 426     # }}}
 427     testcmd("$CMD -ux sident-files/textfile", # {{{
 428         <<'END',
 429 <?xml version="1.0"?>
 430 <sident>
 431   <file>
 432     <filename>sident-files/textfile</filename>
 433     <keywords>
 434       <keyword>$Id: plain_old_textfile 93653 2008-09-22 14:15:10Z sunny $</keyword>
 435       <keyword>$Id: yeh 1234 2008-09-22 12:25:05Z sunny $</keyword>
 436       <keyword>$Date: 1999/12/23 21:59:22 $</keyword>
 437       <keyword>$Header: /cvsweb/cvs-guide/keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $</keyword>
 438       <keyword>$Id: keyword.html,v 1.3 1999/12/23 21:59:22 markd Exp $</keyword>
 439       <keyword>$Weirdo: blah blah $</keyword>
 440     </keywords>
 441   </file>
 442 </sident>
 443 END
 444         "",
 445         0,
 446         "Output XML, remove duplicates",
 447     );
 448
 449     # }}}
 450     diag("Error conditions...");
 451     testcmd("$CMD sident-files", # {{{
 452         "",
 453         "",
 454         0,
 455         "Ignore directories",
 456     );
 457
 458     # }}}
 459     testcmd("$CMD -v sident-files", # {{{
 460         "",
 461         "",
 462         0,
 463         "Ignore directories, even with --verbose",
 464     );
 465
 466     # }}}
 467     likecmd("$CMD sident-files/shbvkdsvsdfv", # {{{
 468         '/^$/',
 469         '/^sident: sident-files/shbvkdsvsdfv: .*$/',
 470         1,
 471         "File not found",
 472     );
 473
 474     # }}}
 475     likecmd("$CMD -x sident-files/shbvkdsvsdfv", # {{{
 476         '/^<\?xml version="1\.0"\?>\n<sident>\n<\/sident>$/',
 477         '/^sident: sident-files/shbvkdsvsdfv: .*$/',
 478         1,
 479         "File not found, don’t break the XML",
 480     );
 481
 482     # }}}
 483     diag("Validate POD (Plain Old Documentation)");
 484     testcmd("podchecker $CMD", # {{{
 485         "",
 486         "$CMD pod syntax OK.\n",
 487         0,
 488         "$CMD contains valid POD",
 489     );
 490
 491     # }}}
 492
 493     todo_section:
 494     ;
 495
 496     if ($Opt{'all'} || $Opt{'todo'}) {
 497         diag('Running TODO tests...'); # {{{
 498
 499         TODO: {
 500
 501             local $TODO = '';
 502             # Insert TODO tests here.
 503
 504         }
 505         # TODO tests }}}
 506     }
 507
 508     diag('Testing finished.');
 509     return $Retval;
 510     # }}}
 511 } # main()
 512
 513 sub testcmd {
 514     # {{{
 515     my ($Cmd, $Exp_stdout, $Exp_stderr, $Exp_retval, $Desc) = @_;
 516     defined($descriptions{$Desc}) &&
 517         BAIL_OUT("testcmd(): '$Desc' description is used twice");
 518     $descriptions{$Desc} = 1;
 519     my $stderr_cmd = '';
 520     my $cmd_outp_str = $Opt{'verbose'} >= 1 ? "\"$Cmd\" - " : '';
 521     my $Txt = join('', $cmd_outp_str, defined($Desc) ? $Desc : '');
 522     my $TMP_STDERR = "$CMDB-stderr.tmp";
 523     my $retval = 1;
 524
 525     if (defined($Exp_stderr)) {
 526         $stderr_cmd = " 2>$TMP_STDERR";
 527     }
 528     $retval &= is(`$Cmd$stderr_cmd`, $Exp_stdout, "$Txt (stdout)");
 529     my $ret_val = $?;
 530     if (defined($Exp_stderr)) {
 531         $retval &= is(file_data($TMP_STDERR), $Exp_stderr, "$Txt (stderr)");
 532         unlink($TMP_STDERR);
 533     } else {
 534         diag("Warning: stderr not defined for '$Txt'");
 535     }
 536     $retval &= is($ret_val >> 8, $Exp_retval, "$Txt (retval)");
 537
 538     return $retval;
 539     # }}}
 540 } # testcmd()
 541
 542 sub likecmd {
 543     # {{{
 544     my ($Cmd, $Exp_stdout, $Exp_stderr, $Exp_retval, $Desc) = @_;
 545     defined($descriptions{$Desc}) &&
 546         BAIL_OUT("likecmd(): '$Desc' description is used twice");
 547     $descriptions{$Desc} = 1;
 548     my $stderr_cmd = '';
 549     my $cmd_outp_str = $Opt{'verbose'} >= 1 ? "\"$Cmd\" - " : '';
 550     my $Txt = join('', $cmd_outp_str, defined($Desc) ? $Desc : '');
 551     my $TMP_STDERR = "$CMDB-stderr.tmp";
 552     my $retval = 1;
 553
 554     if (defined($Exp_stderr)) {
 555         $stderr_cmd = " 2>$TMP_STDERR";
 556     }
 557     $retval &= like(`$Cmd$stderr_cmd`, $Exp_stdout, "$Txt (stdout)");
 558     my $ret_val = $?;
 559     if (defined($Exp_stderr)) {
 560         $retval &= like(file_data($TMP_STDERR), $Exp_stderr, "$Txt (stderr)");
 561         unlink($TMP_STDERR);
 562     } else {
 563         diag("Warning: stderr not defined for '$Txt'");
 564     }
 565     $retval &= is($ret_val >> 8, $Exp_retval, "$Txt (retval)");
 566
 567     return $retval;
 568     # }}}
 569 } # likecmd()
 570
 571 sub file_data {
 572     # Return file content as a string {{{
 573     my $File = shift;
 574     my $Txt;
 575
 576     open(my $fp, '<', $File) or return undef;
 577     local $/ = undef;
 578     $Txt = <$fp>;
 579     close($fp);
 580     return $Txt;
 581     # }}}
 582 } # file_data()
 583
 584 sub print_version {
 585     # Print program version {{{
 586     print("$progname $VERSION\n");
 587     return;
 588     # }}}
 589 } # print_version()
 590
 591 sub usage {
 592     # Send the help message to stdout {{{
 593     my $Retval = shift;
 594
 595     if ($Opt{'verbose'}) {
 596         print("\n");
 597         print_version();
 598     }
 599     print(<<"END");
 600
 601 Usage: $progname [options]
 602
 603 Contains tests for the $CMDB(1) program.
 604
 605 Options:
 606
 607   -a, --all
 608     Run all tests, also TODOs.
 609   -h, --help
 610     Show this help.
 611   -q, --quiet
 612     Be more quiet. Can be repeated to increase silence.
 613   -t, --todo
 614     Run only the TODO tests.
 615   -v, --verbose
 616     Increase level of verbosity. Can be repeated.
 617   --version
 618     Print version information.
 619
 620 END
 621     exit($Retval);
 622     # }}}
 623 } # usage()
 624
 625 sub msg {
 626     # Print a status message to stderr based on verbosity level {{{
 627     my ($verbose_level, $Txt) = @_;
 628
 629     $verbose_level > $Opt{'verbose'} && return;
 630     print(STDERR "$progname: $Txt\n");
 631     return;
 632     # }}}
 633 } # msg()
 634
 635 __END__
 636
 637 # This program is free software; you can redistribute it and/or modify
 638 # it under the terms of the GNU General Public License as published by
 639 # the Free Software Foundation; either version 2 of the License, or (at
 640 # your option) any later version.
 641 #
 642 # This program is distributed in the hope that it will be useful, but
 643 # WITHOUT ANY WARRANTY; without even the implied warranty of
 644 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 645 # See the GNU General Public License for more details.
 646 #
 647 # You should have received a copy of the GNU General Public License
 648 # along with this program.
 649 # If not, see L<http://www.gnu.org/licenses/>.
 650
 651 # vim: set fenc=UTF-8 ft=perl fdm=marker ts=4 sw=4 sts=4 et fo+=w :