Lib/std/perl-tests

   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), $Exp_stderr, "$Txt (stderr)");
 151         unlink($TMP_STDERR);
 152     } else {
 153         diag("Warning: stderr not defined for '$Txt'");
 154     }
 155     $retval &= is($ret_val >> 8, $Exp_retval, "$Txt (retval)");
 156
 157     return $retval;
 158 }
 159
 160 sub likecmd {
 161     my ($Cmd, $Exp_stdout, $Exp_stderr, $Exp_retval, $Desc) = @_;
 162     defined($descriptions{$Desc})
 163     && BAIL_OUT("likecmd(): '$Desc' description is used twice");
 164     $descriptions{$Desc} = 1;
 165     my $stderr_cmd = '';
 166     my $cmd_outp_str = $Opt{'verbose'} >= 1 ? "\"$Cmd\" - " : '';
 167     my $Txt = join('', $cmd_outp_str, defined($Desc) ? $Desc : '');
 168     my $TMP_STDERR = "$CMDB-stderr.tmp";
 169     my $retval = 1;
 170
 171     if (defined($Exp_stderr)) {
 172         $stderr_cmd = " 2>$TMP_STDERR";
 173     }
 174     $retval &= like(`$Cmd$stderr_cmd`, $Exp_stdout, "$Txt (stdout)");
 175     my $ret_val = $?;
 176     if (defined($Exp_stderr)) {
 177         $retval &= like(file_data($TMP_STDERR), $Exp_stderr, "$Txt (stderr)");
 178         unlink($TMP_STDERR);
 179     } else {
 180         diag("Warning: stderr not defined for '$Txt'");
 181     }
 182     $retval &= is($ret_val >> 8, $Exp_retval, "$Txt (retval)");
 183
 184     return $retval;
 185 }
 186
 187 sub file_data {
 188     # Return file content as a string
 189     my $File = shift;
 190     my $Txt;
 191
 192     open(my $fp, '<', $File) or return undef;
 193     local $/ = undef;
 194     $Txt = <$fp>;
 195     close($fp);
 196
 197     return $Txt;
 198 }
 199
 200 sub create_file {
 201     # Create new file and fill it with data
 202     my ($file, $text) = @_;
 203     my $retval = 0;
 204
 205     open(my $fp, ">", $file) or return 0;
 206     print($fp $text);
 207     close($fp);
 208     $retval = is(file_data($file), $text,
 209                  "$file was successfully created");
 210
 211     return $retval; # 0 if error, 1 if ok
 212 }
 213
 214 sub print_version {
 215     # Print program version
 216     print("$progname $VERSION\n");
 217
 218     return;
 219 }
 220
 221 sub usage {
 222     # Send the help message to stdout
 223     my $Retval = shift;
 224
 225     if ($Opt{'verbose'}) {
 226         print("\n");
 227         print_version();
 228     }
 229     print(<<"END");
 230
 231 Usage: $progname [options]
 232
 233 Contains tests for the $CMDB(1) program.
 234
 235 Options:
 236
 237   -a, --all
 238     Run all tests, also TODOs.
 239   -h, --help
 240     Show this help.
 241   -q, --quiet
 242     Be more quiet. Can be repeated to increase silence.
 243   -t, --todo
 244     Run only the TODO tests.
 245   -v, --verbose
 246     Increase level of verbosity. Can be repeated.
 247   --version
 248     Print version information.
 249
 250 END
 251     exit($Retval);
 252 }
 253
 254 sub msg {
 255     # Print a status message to stderr based on verbosity level
 256     my ($verbose_level, $Txt) = @_;
 257
 258     $verbose_level > $Opt{'verbose'} && return;
 259     print(STDERR "$progname: $Txt\n");
 260
 261     return;
 262 }
 263
 264 __END__
 265
 266 # This program is free software; you can redistribute it and/or modify it under
 267 # the terms of the GNU General Public License as published by the Free Software
 268 # Foundation; either version 2 of the License, or (at your option) any later
 269 # version.
 270 #
 271 # This program is distributed in the hope that it will be useful, but WITHOUT
 272 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 273 # FOR A PARTICULAR PURPOSE.
 274 # See the GNU General Public License for more details.
 275 #
 276 # You should have received a copy of the GNU General Public License along with
 277 # this program.
 278 # If not, see L<http://www.gnu.org/licenses/>.
 279
 280 # vim: set fenc=UTF-8 ft=perl fdm=marker ts=4 sw=4 sts=4 et fo+=w :