Lib/std/perl-tests-tab

   1 #!/usr/bin/env perl
   2
   3 #==============================================================================
   4 # STDfilenameDTS
   5 # File ID: STDuuidDTS
   6 #
   7 # Test suite for STDprognameDTS(1).
   8 #
   9 # Character set: UTF-8
  10 # ©opyleft STDyearDTS– Øyvind A. Holm <sunny@sunbase.org>
  11 # License: GNU General Public License version 2 or later, see end of file for
  12 # 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 = "STDprognameDTS";
  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'; # Not used here, $CMD decides
  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 my $exec_version = `$CMD --version`;
  67
  68 exit(main());
  69
  70 sub main {
  71         my $Retval = 0;
  72
  73         diag('========== BEGIN version info ==========');
  74         diag($exec_version);
  75         diag('=========== END version info ===========');
  76
  77         if ($Opt{'todo'} && !$Opt{'all'}) {
  78                 goto todo_section;
  79         }
  80
  81         test_standard_options();
  82         test_executable();
  83
  84         diag('========== BEGIN version info ==========');
  85         diag($exec_version);
  86         diag('=========== END version info ===========');
  87
  88         todo_section:
  89         ;
  90
  91         if ($Opt{'all'} || $Opt{'todo'}) {
  92                 diag('Running TODO tests...');
  93                 TODO: {
  94                         local $TODO = '';
  95                         # Insert TODO tests here.
  96                 }
  97         }
  98
  99         diag('Testing finished.');
 100
 101         return $Retval;
 102 }
 103
 104 sub test_standard_options {
 105         diag('Testing -h (--help) option...');
 106         likecmd("$CMD -h",
 107                 '/  Show this help/i',
 108                 '/^$/',
 109                 0,
 110                 'Option -h prints help screen');
 111
 112         diag('Testing -v (--verbose) option...');
 113         likecmd("$CMD -hv",
 114                 '/^\n\S+ \d+\.\d+\.\d+/s',
 115                 '/^$/',
 116                 0,
 117                 'Option -v with -h returns version number and help screen');
 118
 119         diag('Testing --version option...');
 120         likecmd("$CMD --version",
 121                 '/^\S+ \d+\.\d+\.\d+/',
 122                 '/^$/',
 123                 0,
 124                 'Option --version returns version number');
 125
 126         return;
 127 }
 128
 129 sub test_executable {
 130         return;
 131 }
 132
 133 sub testcmd {
 134         my ($Cmd, $Exp_stdout, $Exp_stderr, $Exp_retval, $Desc) = @_;
 135         defined($descriptions{$Desc})
 136         && BAIL_OUT("testcmd(): '$Desc' description is used twice");
 137         $descriptions{$Desc} = 1;
 138         my $stderr_cmd = '';
 139         my $cmd_outp_str = $Opt{'verbose'} >= 1 ? "\"$Cmd\" - " : '';
 140         my $Txt = join('', $cmd_outp_str, defined($Desc) ? $Desc : '');
 141         my $TMP_STDERR = "$CMDB-stderr.tmp";
 142         my $retval = 1;
 143
 144         if (defined($Exp_stderr)) {
 145                 $stderr_cmd = " 2>$TMP_STDERR";
 146         }
 147         $retval &= is(`$Cmd$stderr_cmd`, $Exp_stdout, "$Txt (stdout)");
 148         my $ret_val = $?;
 149         if (defined($Exp_stderr)) {
 150                 $retval &= is(file_data($TMP_STDERR),
 151                               $Exp_stderr, "$Txt (stderr)");
 152                 unlink($TMP_STDERR);
 153         } else {
 154                 diag("Warning: stderr not defined for '$Txt'");
 155         }
 156         $retval &= is($ret_val >> 8, $Exp_retval, "$Txt (retval)");
 157
 158         return $retval;
 159 }
 160
 161 sub likecmd {
 162         my ($Cmd, $Exp_stdout, $Exp_stderr, $Exp_retval, $Desc) = @_;
 163         defined($descriptions{$Desc})
 164         && BAIL_OUT("likecmd(): '$Desc' description is used twice");
 165         $descriptions{$Desc} = 1;
 166         my $stderr_cmd = '';
 167         my $cmd_outp_str = $Opt{'verbose'} >= 1 ? "\"$Cmd\" - " : '';
 168         my $Txt = join('', $cmd_outp_str, defined($Desc) ? $Desc : '');
 169         my $TMP_STDERR = "$CMDB-stderr.tmp";
 170         my $retval = 1;
 171
 172         if (defined($Exp_stderr)) {
 173                 $stderr_cmd = " 2>$TMP_STDERR";
 174         }
 175         $retval &= like(`$Cmd$stderr_cmd`, $Exp_stdout, "$Txt (stdout)");
 176         my $ret_val = $?;
 177         if (defined($Exp_stderr)) {
 178                 $retval &= like(file_data($TMP_STDERR),
 179                                 $Exp_stderr, "$Txt (stderr)");
 180                 unlink($TMP_STDERR);
 181         } else {
 182                 diag("Warning: stderr not defined for '$Txt'");
 183         }
 184         $retval &= is($ret_val >> 8, $Exp_retval, "$Txt (retval)");
 185
 186         return $retval;
 187 }
 188
 189 sub file_data {
 190         # Return file content as a string
 191         my $File = shift;
 192         my $Txt;
 193
 194         open(my $fp, '<', $File) or return undef;
 195         local $/ = undef;
 196         $Txt = <$fp>;
 197         close($fp);
 198
 199         return $Txt;
 200 }
 201
 202 sub create_file {
 203         # Create new file and fill it with data
 204         my ($file, $text) = @_;
 205         my $retval = 0;
 206
 207         open(my $fp, ">", $file) or return 0;
 208         print($fp $text);
 209         close($fp);
 210         $retval = is(file_data($file), $text,
 211                      "$file was successfully created");
 212
 213         return $retval; # 0 if error, 1 if ok
 214 }
 215
 216 sub print_version {
 217         # Print program version
 218         print("$progname $VERSION\n");
 219
 220         return;
 221 }
 222
 223 sub usage {
 224         # Send the help message to stdout
 225         my $Retval = shift;
 226
 227         if ($Opt{'verbose'}) {
 228                 print("\n");
 229                 print_version();
 230         }
 231         print(<<"END");
 232
 233 Usage: $progname [options]
 234
 235 Contains tests for the $CMDB(1) program.
 236
 237 Options:
 238
 239   -a, --all
 240     Run all tests, also TODOs.
 241   -h, --help
 242     Show this help.
 243   -q, --quiet
 244     Be more quiet. Can be repeated to increase silence.
 245   -t, --todo
 246     Run only the TODO tests.
 247   -v, --verbose
 248     Increase level of verbosity. Can be repeated.
 249   --version
 250     Print version information.
 251
 252 END
 253         exit($Retval);
 254 }
 255
 256 sub msg {
 257         # Print a status message to stderr based on verbosity level
 258         my ($verbose_level, $Txt) = @_;
 259
 260         $verbose_level > $Opt{'verbose'} && return;
 261         print(STDERR "$progname: $Txt\n");
 262
 263         return;
 264 }
 265
 266 __END__
 267
 268 # This program is free software; you can redistribute it and/or modify it under
 269 # the terms of the GNU General Public License as published by the Free Software
 270 # Foundation; either version 2 of the License, or (at your option) any later
 271 # version.
 272 #
 273 # This program is distributed in the hope that it will be useful, but WITHOUT
 274 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 275 # FOR A PARTICULAR PURPOSE.
 276 # See the GNU General Public License for more details.
 277 #
 278 # You should have received a copy of the GNU General Public License along with
 279 # this program.
 280 # If not, see L<http://www.gnu.org/licenses/>.
 281
 282 # vim: set ts=8 sw=8 sts=8 noet fo+=w tw=79 fenc=UTF-8 :