tests/addpoints/addpoints.t

   1 #!/usr/bin/perl -w
   2
   3 #=======================================================================
   4 # tests/addpoints/addpoints.t
   5 # File ID: ccab1138-f924-11dd-9694-0001805bf4b1
   6 # Test suite for addpoints(1).
   7 #
   8 # Character set: UTF-8
   9 # ©opyleft 2008– Ø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 BEGIN {
  15     # push(@INC, "$ENV{'HOME'}/bin/STDlibdirDTS");
  16     use Test::More qw{no_plan};
  17     # use_ok() goes here
  18 }
  19
  20 use strict;
  21 use Getopt::Long;
  22
  23 $| = 1;
  24
  25 our $Debug = 0;
  26 our $CMD = "../../addpoints";
  27
  28 our %Opt = (
  29
  30     'all' => 0,
  31     'debug' => 0,
  32     'help' => 0,
  33     'todo' => 0,
  34     'verbose' => 0,
  35     'version' => 0,
  36
  37 );
  38
  39 our $progname = $0;
  40 $progname =~ s/^.*\/(.*?)$/$1/;
  41 our $VERSION = "0.00";
  42
  43 Getopt::Long::Configure("bundling");
  44 GetOptions(
  45
  46     "all|a" => \$Opt{'all'},
  47     "debug" => \$Opt{'debug'},
  48     "help|h" => \$Opt{'help'},
  49     "todo|t" => \$Opt{'todo'},
  50     "verbose|v+" => \$Opt{'verbose'},
  51     "version" => \$Opt{'version'},
  52
  53 ) || die("$progname: Option error. Use -h for help.\n");
  54
  55 $Opt{'debug'} && ($Debug = 1);
  56 $Opt{'help'} && usage(0);
  57 if ($Opt{'version'}) {
  58     print_version();
  59     exit(0);
  60 }
  61
  62 diag(sprintf("========== Executing %s v%s ==========",
  63     $progname,
  64     $VERSION));
  65
  66 if ($Opt{'todo'} && !$Opt{'all'}) {
  67     goto todo_section;
  68 }
  69
  70 =pod
  71
  72 testcmd("$CMD command", # {{{
  73     <<END,
  74 [expected stdin]
  75 END
  76     "",
  77     "description",
  78 );
  79
  80 # }}}
  81
  82 =cut
  83
  84 diag("Testing -h (--help) option...");
  85 likecmd("$CMD -h", # {{{
  86     '/  Show this help\./',
  87     '/^$/',
  88     "Option -h prints help screen",
  89 );
  90
  91 # }}}
  92 diag("Testing -v (--verbose) option...");
  93 likecmd("$CMD -hv", # {{{
  94     '/^\n\S+ v\d\.\d\d\n/s',
  95     '/^$/',
  96     "Option --version with -h returns version number and help screen",
  97 );
  98
  99 # }}}
 100 diag("Testing --version option...");
 101 likecmd("$CMD --version", # {{{
 102     '/^\S+ v\d\.\d\d\n/',
 103     '/^$/',
 104     "Option --version returns version number",
 105 );
 106
 107 # }}}
 108
 109 todo_section:
 110 ;
 111
 112 if ($Opt{'all'} || $Opt{'todo'}) {
 113     diag("Running TODO tests..."); # {{{
 114
 115     TODO: {
 116
 117 local $TODO = "";
 118 # Insert TODO tests here.
 119
 120     }
 121     # TODO tests }}}
 122 }
 123
 124 diag("Testing finished.");
 125
 126 sub testcmd {
 127     # {{{
 128     my ($Cmd, $Exp_stdout, $Exp_stderr, $Desc) = @_;
 129     my $stderr_cmd = "";
 130     my $deb_str = $Opt{'debug'} ? " --debug" : "";
 131     my $Txt = join("",
 132         "\"$Cmd\"",
 133         defined($Desc)
 134             ? " - $Desc"
 135             : ""
 136     );
 137     my $TMP_STDERR = "addpoints-stderr.tmp";
 138
 139     if (defined($Exp_stderr) && !length($deb_str)) {
 140         $stderr_cmd = " 2>$TMP_STDERR";
 141     }
 142     is(`$Cmd$deb_str$stderr_cmd`, $Exp_stdout, $Txt);
 143     if (defined($Exp_stderr)) {
 144         if (!length($deb_str)) {
 145             is(file_data($TMP_STDERR), $Exp_stderr, "$Txt (stderr)");
 146             unlink($TMP_STDERR);
 147         }
 148     } else {
 149         diag("Warning: stderr not defined for '$Txt'");
 150     }
 151     # }}}
 152 } # testcmd()
 153
 154 sub likecmd {
 155     # {{{
 156     my ($Cmd, $Exp_stdout, $Exp_stderr, $Desc) = @_;
 157     my $stderr_cmd = "";
 158     my $deb_str = $Opt{'debug'} ? " --debug" : "";
 159     my $Txt = join("",
 160         "\"$Cmd\"",
 161         defined($Desc)
 162             ? " - $Desc"
 163             : ""
 164     );
 165     my $TMP_STDERR = "addpoints-stderr.tmp";
 166
 167     if (defined($Exp_stderr) && !length($deb_str)) {
 168         $stderr_cmd = " 2>$TMP_STDERR";
 169     }
 170     like(`$Cmd$deb_str$stderr_cmd`, "$Exp_stdout", $Txt);
 171     if (defined($Exp_stderr)) {
 172         if (!length($deb_str)) {
 173             like(file_data($TMP_STDERR), "$Exp_stderr", "$Txt (stderr)");
 174             unlink($TMP_STDERR);
 175         }
 176     } else {
 177         diag("Warning: stderr not defined for '$Txt'");
 178     }
 179     # }}}
 180 } # likecmd()
 181
 182 sub file_data {
 183     # Return file content as a string {{{
 184     my $File = shift;
 185     my $Txt;
 186     if (open(my $fp, "<", $File)) {
 187         $Txt = join("", <$fp>);
 188         close($fp);
 189         return($Txt);
 190     } else {
 191         return undef;
 192     }
 193     # }}}
 194 } # file_data()
 195
 196 sub print_version {
 197     # Print program version {{{
 198     print("$progname v$VERSION\n");
 199     # }}}
 200 } # print_version()
 201
 202 sub usage {
 203     # Send the help message to stdout {{{
 204     my $Retval = shift;
 205
 206     if ($Opt{'verbose'}) {
 207         print("\n");
 208         print_version();
 209     }
 210     print(<<END);
 211
 212 Usage: $progname [options] [file [files [...]]]
 213
 214 Contains tests for the addpoints(1) program.
 215
 216 Options:
 217
 218   -a, --all
 219     Run all tests, also TODOs.
 220   -h, --help
 221     Show this help.
 222   -t, --todo
 223     Run only the TODO tests.
 224   -v, --verbose
 225     Increase level of verbosity. Can be repeated.
 226   --version
 227     Print version information.
 228   --debug
 229     Print debugging messages.
 230
 231 END
 232     exit($Retval);
 233     # }}}
 234 } # usage()
 235
 236 sub msg {
 237     # Print a status message to stderr based on verbosity level {{{
 238     my ($verbose_level, $Txt) = @_;
 239
 240     if ($Opt{'verbose'} >= $verbose_level) {
 241         print(STDERR "$progname: $Txt\n");
 242     }
 243     # }}}
 244 } # msg()
 245
 246 __END__
 247
 248 # Plain Old Documentation (POD) {{{
 249
 250 =pod
 251
 252 =head1 NAME
 253
 254 run-tests.pl
 255
 256 =head1 SYNOPSIS
 257
 258 addpoints.t [options] [file [files [...]]]
 259
 260 =head1 DESCRIPTION
 261
 262 Contains tests for the addpoints(1) program.
 263
 264 =head1 OPTIONS
 265
 266 =over 4
 267
 268 =item B<-a>, B<--all>
 269
 270 Run all tests, also TODOs.
 271
 272 =item B<-h>, B<--help>
 273
 274 Print a brief help summary.
 275
 276 =item B<-t>, B<--todo>
 277
 278 Run only the TODO tests.
 279
 280 =item B<-v>, B<--verbose>
 281
 282 Increase level of verbosity. Can be repeated.
 283
 284 =item B<--version>
 285
 286 Print version information.
 287
 288 =item B<--debug>
 289
 290 Print debugging messages.
 291
 292 =back
 293
 294 =head1 AUTHOR
 295
 296 Made by Øyvind A. Holm S<E<lt>sunny@sunbase.orgE<gt>>.
 297
 298 =head1 COPYRIGHT
 299
 300 Copyleft © Øyvind A. Holm E<lt>sunny@sunbase.orgE<gt>
 301 This is free software; see the file F<COPYING> for legalese stuff.
 302
 303 =head1 LICENCE
 304
 305 This program is free software: you can redistribute it and/or modify it
 306 under the terms of the GNU General Public License as published by the
 307 Free Software Foundation, either version 3 of the License, or (at your
 308 option) any later version.
 309
 310 This program is distributed in the hope that it will be useful, but
 311 WITHOUT ANY WARRANTY; without even the implied warranty of
 312 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 313 See the GNU General Public License for more details.
 314
 315 You should have received a copy of the GNU General Public License along
 316 with this program.
 317 If not, see L<http://www.gnu.org/licenses/>.
 318
 319 =head1 SEE ALSO
 320
 321 =cut
 322
 323 # }}}
 324
 325 # vim: set fenc=UTF-8 ft=perl fdm=marker ts=4 sw=4 sts=4 et fo+=w :