tests/sortxml.t

   1 #!/usr/bin/env perl
   2
   3 #=======================================================================
   4 # sortxml.t
   5 # File ID: 8c064bc0-1463-11de-b31f-000475e441b9
   6 #
   7 # Test suite for sortxml(1).
   8 #
   9 # Character set: UTF-8
  10 # ©opyleft 2009– Ø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 $CMD_BASENAME = "sortxml";
  28 our $CMD = "../$CMD_BASENAME";
  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("Test sorting...");
 122     testcmd("$CMD -s b sortxml-files/a.xml", # {{{
 123         <<END,
 124 <?xml version="1.0" encoding="UTF-8"?>
 125 <!DOCTYPE a [
 126 <!ELEMENT a (b)+>
 127 <!ELEMENT b (c , d?)>
 128 <!ELEMENT c (#PCDATA)>
 129 <!ELEMENT d (#PCDATA)>
 130 ]>
 131 <a>
 132   <b>
 133     <c>abc</c>
 134     <d>dsfv</d>
 135   </b>
 136   <b>
 137     <c>add</c>
 138   </b>
 139   <b>
 140     <c>ba</c>
 141   </b>
 142   <b>
 143     <c>bbb</c>
 144     <d>gurgle</d>
 145   </b>
 146   <b>
 147     <c>bbb</c>
 148     <d>gurgle</d>
 149   </b>
 150   <b>
 151     <c>ggg</c>
 152     <d>fgh</d>
 153   </b>
 154   <b>
 155     <c>ggg</c>
 156     <d>pdfg</d>
 157   </b>
 158   <b>
 159     <c>zsd</c>
 160   </b>
 161 </a>
 162 END
 163         "",
 164         0,
 165         "Sorting XML document",
 166     );
 167
 168     # }}}
 169     testcmd("$CMD -s b sortxml-files/oneliners.xml", # {{{
 170         <<END,
 171 <?xml version="1.0" encoding="UTF-8"?>
 172 <!DOCTYPE a [
 173 <!ELEMENT a (b)+>
 174 <!ELEMENT b (c , d?)>
 175 <!ELEMENT c (#PCDATA)>
 176 <!ELEMENT d (#PCDATA)>
 177 ]>
 178 <a>
 179   <b> <c>abc</c> <d>dsfv</d> </b>
 180   <b> <c>add</c> </b>
 181   <b> <c>ba</c> </b>
 182   <b> <c>bbb</c> <d>gurgle</d> </b>
 183   <b> <c>ggg</c> <d>fgh</d> </b>
 184   <b> <c>ggg</c> <d>pdfg</d> </b>
 185   <b> <c>zsd</c> </b>
 186 </a>
 187 END
 188         "",
 189         0,
 190         "XML uses oneliners",
 191     );
 192
 193     # }}}
 194     diag("Test reverse sorting...");
 195     testcmd("$CMD -s b -r sortxml-files/a.xml", # {{{
 196         <<END,
 197 <?xml version="1.0" encoding="UTF-8"?>
 198 <!DOCTYPE a [
 199 <!ELEMENT a (b)+>
 200 <!ELEMENT b (c , d?)>
 201 <!ELEMENT c (#PCDATA)>
 202 <!ELEMENT d (#PCDATA)>
 203 ]>
 204 <a>
 205   <b>
 206     <c>zsd</c>
 207   </b>
 208   <b>
 209     <c>ggg</c>
 210     <d>pdfg</d>
 211   </b>
 212   <b>
 213     <c>ggg</c>
 214     <d>fgh</d>
 215   </b>
 216   <b>
 217     <c>bbb</c>
 218     <d>gurgle</d>
 219   </b>
 220   <b>
 221     <c>bbb</c>
 222     <d>gurgle</d>
 223   </b>
 224   <b>
 225     <c>ba</c>
 226   </b>
 227   <b>
 228     <c>add</c>
 229   </b>
 230   <b>
 231     <c>abc</c>
 232     <d>dsfv</d>
 233   </b>
 234 </a>
 235 END
 236         "",
 237         0,
 238         "Reverse sort XML document",
 239     );
 240
 241     # }}}
 242     testcmd("$CMD -s b -r sortxml-files/oneliners.xml", # {{{
 243         <<END,
 244 <?xml version="1.0" encoding="UTF-8"?>
 245 <!DOCTYPE a [
 246 <!ELEMENT a (b)+>
 247 <!ELEMENT b (c , d?)>
 248 <!ELEMENT c (#PCDATA)>
 249 <!ELEMENT d (#PCDATA)>
 250 ]>
 251 <a>
 252   <b> <c>zsd</c> </b>
 253   <b> <c>ggg</c> <d>pdfg</d> </b>
 254   <b> <c>ggg</c> <d>fgh</d> </b>
 255   <b> <c>bbb</c> <d>gurgle</d> </b>
 256   <b> <c>ba</c> </b>
 257   <b> <c>add</c> </b>
 258   <b> <c>abc</c> <d>dsfv</d> </b>
 259 </a>
 260 END
 261         "",
 262         0,
 263         "Reverse sort onelined XML",
 264     );
 265
 266     # }}}
 267     diag('Testing -u (--unique) option...');
 268     testcmd("$CMD -s b -u sortxml-files/a.xml", # {{{
 269         <<END,
 270 <?xml version="1.0" encoding="UTF-8"?>
 271 <!DOCTYPE a [
 272 <!ELEMENT a (b)+>
 273 <!ELEMENT b (c , d?)>
 274 <!ELEMENT c (#PCDATA)>
 275 <!ELEMENT d (#PCDATA)>
 276 ]>
 277 <a>
 278   <b>
 279     <c>abc</c>
 280     <d>dsfv</d>
 281   </b>
 282   <b>
 283     <c>add</c>
 284   </b>
 285   <b>
 286     <c>ba</c>
 287   </b>
 288   <b>
 289     <c>bbb</c>
 290     <d>gurgle</d>
 291   </b>
 292   <b>
 293     <c>ggg</c>
 294     <d>fgh</d>
 295   </b>
 296   <b>
 297     <c>ggg</c>
 298     <d>pdfg</d>
 299   </b>
 300   <b>
 301     <c>zsd</c>
 302   </b>
 303 </a>
 304 END
 305         "",
 306         0,
 307         "Duplicated <b> removed",
 308     );
 309
 310     # }}}
 311
 312     todo_section:
 313     ;
 314
 315     if ($Opt{'all'} || $Opt{'todo'}) {
 316         diag('Running TODO tests...'); # {{{
 317
 318         TODO: {
 319
 320             local $TODO = '';
 321             # Insert TODO tests here.
 322
 323         }
 324         # TODO tests }}}
 325     }
 326
 327     diag('Testing finished.');
 328     return $Retval;
 329     # }}}
 330 } # main()
 331
 332 sub testcmd {
 333     # {{{
 334     my ($Cmd, $Exp_stdout, $Exp_stderr, $Exp_retval, $Desc) = @_;
 335     defined($descriptions{$Desc}) &&
 336         BAIL_OUT("testcmd(): '$Desc' description is used twice");
 337     $descriptions{$Desc} = 1;
 338     my $stderr_cmd = '';
 339     my $cmd_outp_str = $Opt{'verbose'} >= 1 ? "\"$Cmd\" - " : '';
 340     my $Txt = join('', $cmd_outp_str, defined($Desc) ? $Desc : '');
 341     my $TMP_STDERR = "$CMD_BASENAME-stderr.tmp";
 342     my $retval = 1;
 343
 344     if (defined($Exp_stderr)) {
 345         $stderr_cmd = " 2>$TMP_STDERR";
 346     }
 347     $retval &= is(`$Cmd$stderr_cmd`, $Exp_stdout, "$Txt (stdout)");
 348     my $ret_val = $?;
 349     if (defined($Exp_stderr)) {
 350         $retval &= is(file_data($TMP_STDERR), $Exp_stderr, "$Txt (stderr)");
 351         unlink($TMP_STDERR);
 352     } else {
 353         diag("Warning: stderr not defined for '$Txt'");
 354     }
 355     $retval &= is($ret_val >> 8, $Exp_retval, "$Txt (retval)");
 356
 357     return $retval;
 358     # }}}
 359 } # testcmd()
 360
 361 sub likecmd {
 362     # {{{
 363     my ($Cmd, $Exp_stdout, $Exp_stderr, $Exp_retval, $Desc) = @_;
 364     defined($descriptions{$Desc}) &&
 365         BAIL_OUT("likecmd(): '$Desc' description is used twice");
 366     $descriptions{$Desc} = 1;
 367     my $stderr_cmd = '';
 368     my $cmd_outp_str = $Opt{'verbose'} >= 1 ? "\"$Cmd\" - " : '';
 369     my $Txt = join('', $cmd_outp_str, defined($Desc) ? $Desc : '');
 370     my $TMP_STDERR = "$CMD_BASENAME-stderr.tmp";
 371     my $retval = 1;
 372
 373     if (defined($Exp_stderr)) {
 374         $stderr_cmd = " 2>$TMP_STDERR";
 375     }
 376     $retval &= like(`$Cmd$stderr_cmd`, $Exp_stdout, "$Txt (stdout)");
 377     my $ret_val = $?;
 378     if (defined($Exp_stderr)) {
 379         $retval &= like(file_data($TMP_STDERR), $Exp_stderr, "$Txt (stderr)");
 380         unlink($TMP_STDERR);
 381     } else {
 382         diag("Warning: stderr not defined for '$Txt'");
 383     }
 384     $retval &= is($ret_val >> 8, $Exp_retval, "$Txt (retval)");
 385
 386     return $retval;
 387     # }}}
 388 } # likecmd()
 389
 390 sub file_data {
 391     # Return file content as a string {{{
 392     my $File = shift;
 393     my $Txt;
 394
 395     open(my $fp, '<', $File) or return undef;
 396     local $/ = undef;
 397     $Txt = <$fp>;
 398     close($fp);
 399     return $Txt;
 400     # }}}
 401 } # file_data()
 402
 403 sub print_version {
 404     # Print program version {{{
 405     print("$progname $VERSION\n");
 406     return;
 407     # }}}
 408 } # print_version()
 409
 410 sub usage {
 411     # Send the help message to stdout {{{
 412     my $Retval = shift;
 413
 414     if ($Opt{'verbose'}) {
 415         print("\n");
 416         print_version();
 417     }
 418     print(<<"END");
 419
 420 Usage: $progname [options]
 421
 422 Contains tests for the $CMD_BASENAME(1) program.
 423
 424 Options:
 425
 426   -a, --all
 427     Run all tests, also TODOs.
 428   -h, --help
 429     Show this help.
 430   -q, --quiet
 431     Be more quiet. Can be repeated to increase silence.
 432   -t, --todo
 433     Run only the TODO tests.
 434   -v, --verbose
 435     Increase level of verbosity. Can be repeated.
 436   --version
 437     Print version information.
 438
 439 END
 440     exit($Retval);
 441     # }}}
 442 } # usage()
 443
 444 sub msg {
 445     # Print a status message to stderr based on verbosity level {{{
 446     my ($verbose_level, $Txt) = @_;
 447
 448     $verbose_level > $Opt{'verbose'} && return;
 449     print(STDERR "$progname: $Txt\n");
 450     return;
 451     # }}}
 452 } # msg()
 453
 454 __END__
 455
 456 # This program is free software; you can redistribute it and/or modify
 457 # it under the terms of the GNU General Public License as published by
 458 # the Free Software Foundation; either version 2 of the License, or (at
 459 # your option) any later version.
 460 #
 461 # This program is distributed in the hope that it will be useful, but
 462 # WITHOUT ANY WARRANTY; without even the implied warranty of
 463 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 464 # See the GNU General Public License for more details.
 465 #
 466 # You should have received a copy of the GNU General Public License
 467 # along with this program.
 468 # If not, see L<http://www.gnu.org/licenses/>.
 469
 470 # vim: set fenc=UTF-8 ft=perl fdm=marker ts=4 sw=4 sts=4 et fo+=w :