tests/age.t

   1 #!/usr/bin/env perl
   2
   3 #==============================================================================
   4 # age.t
   5 # File ID: 294ca6f6-7396-11eb-bf84-5582e081d110
   6 #
   7 # Test suite for age(1).
   8 #
   9 # Character set: UTF-8
  10 # ©opyleft 2021– Ø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 = "age";
  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 -h -v",
 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         my $h = 3600;
 131         my $d = 24 * $h;
 132         my $y = 365 * $d;
 133         my $ly = $y + $d;
 134
 135         test_range("1970-01-01", "1979-01-01", 9 * $y + 2 * $d, "");
 136         test_range("1995-02-02 12:00:00", "1995-07-12 12:00:00",
 137                    160 * $d, "");
 138         test_range("1995-07-12 12:00:00", "1995-02-02 12:00:00",
 139                    -160 * $d, "");
 140         test_range("1814-05-17", "1815-05-17", $y, "");
 141         test_range("0765-07-08", "0766-07-08", $y, "");
 142         test_range("0765-07-08 17:13:13", "0766-07-08 17:13:13", $y, "");
 143         test_range("0765-07-08 17:13:13", "0766-07-08 17:13:14", $y + 1, "");
 144         test_range("7777-07-08 17:13:13", "7778-07-08 17:13:13", $y, "");
 145         test_range("7777-07-08 17:13:13", "7778-07-08 17:13:14", $y + 1, "");
 146         test_range("1900-02-28", "1900-03-01", $d, "");
 147         test_range("1904-02-28", "1904-03-01", 2 * $d, "");
 148         test_range("1976-02-28", "1976-03-01", 2 * $d, "");
 149         test_range("2000-02-28", "2000-03-01", 2 * $d, "");
 150
 151         return;
 152 }
 153
 154 sub test_range {
 155         my ($begin, $end, $secs, $opts) = @_;
 156
 157         length($opts) && ($opts = " $opts");
 158         chomp (my $dfmt = `echo $secs | datefmt`);
 159
 160         testcmd("$CMD$opts \"$begin\" \"$end\"",
 161                 "$dfmt\n",
 162                 "",
 163                 0,
 164                 "$CMD$opts \"$begin\" \"$end\"");
 165
 166         for my $o ('-s', '--seconds') {
 167                 testcmd("$CMD $o$opts \"$begin\" \"$end\"",
 168                         "$secs\n",
 169                         "",
 170                         0,
 171                         "$CMD $o$opts \"$begin\" \"$end\"");
 172         }
 173
 174         return;
 175 }
 176
 177 sub testcmd {
 178         my ($Cmd, $Exp_stdout, $Exp_stderr, $Exp_retval, $Desc) = @_;
 179         defined($descriptions{$Desc})
 180         && BAIL_OUT("testcmd(): '$Desc' description is used twice");
 181         $descriptions{$Desc} = 1;
 182         my $stderr_cmd = '';
 183         my $cmd_outp_str = $Opt{'verbose'} >= 1 ? "\"$Cmd\" - " : '';
 184         my $Txt = join('', $cmd_outp_str, defined($Desc) ? $Desc : '');
 185         my $TMP_STDERR = "$CMDB-stderr.tmp";
 186         my $retval = 1;
 187
 188         if (defined($Exp_stderr)) {
 189                 $stderr_cmd = " 2>$TMP_STDERR";
 190         }
 191         $retval &= is(`$Cmd$stderr_cmd`, $Exp_stdout, "$Txt (stdout)");
 192         my $ret_val = $?;
 193         if (defined($Exp_stderr)) {
 194                 $retval &= is(file_data($TMP_STDERR),
 195                               $Exp_stderr, "$Txt (stderr)");
 196                 unlink($TMP_STDERR);
 197         } else {
 198                 diag("Warning: stderr not defined for '$Txt'");
 199         }
 200         $retval &= is($ret_val >> 8, $Exp_retval, "$Txt (retval)");
 201
 202         return $retval;
 203 }
 204
 205 sub likecmd {
 206         my ($Cmd, $Exp_stdout, $Exp_stderr, $Exp_retval, $Desc) = @_;
 207         defined($descriptions{$Desc})
 208         && BAIL_OUT("likecmd(): '$Desc' description is used twice");
 209         $descriptions{$Desc} = 1;
 210         my $stderr_cmd = '';
 211         my $cmd_outp_str = $Opt{'verbose'} >= 1 ? "\"$Cmd\" - " : '';
 212         my $Txt = join('', $cmd_outp_str, defined($Desc) ? $Desc : '');
 213         my $TMP_STDERR = "$CMDB-stderr.tmp";
 214         my $retval = 1;
 215
 216         if (defined($Exp_stderr)) {
 217                 $stderr_cmd = " 2>$TMP_STDERR";
 218         }
 219         $retval &= like(`$Cmd$stderr_cmd`, $Exp_stdout, "$Txt (stdout)");
 220         my $ret_val = $?;
 221         if (defined($Exp_stderr)) {
 222                 $retval &= like(file_data($TMP_STDERR),
 223                                 $Exp_stderr, "$Txt (stderr)");
 224                 unlink($TMP_STDERR);
 225         } else {
 226                 diag("Warning: stderr not defined for '$Txt'");
 227         }
 228         $retval &= is($ret_val >> 8, $Exp_retval, "$Txt (retval)");
 229
 230         return $retval;
 231 }
 232
 233 sub file_data {
 234         # Return file content as a string
 235         my $File = shift;
 236         my $Txt;
 237
 238         open(my $fp, '<', $File) or return undef;
 239         local $/ = undef;
 240         $Txt = <$fp>;
 241         close($fp);
 242
 243         return $Txt;
 244 }
 245
 246 sub create_file {
 247         # Create new file and fill it with data
 248         my ($file, $text) = @_;
 249         my $retval = 0;
 250
 251         open(my $fp, ">", $file) or return 0;
 252         print($fp $text);
 253         close($fp);
 254         $retval = is(file_data($file), $text,
 255                      "$file was successfully created");
 256
 257         return $retval; # 0 if error, 1 if ok
 258 }
 259
 260 sub print_version {
 261         # Print program version
 262         print("$progname $VERSION\n");
 263
 264         return;
 265 }
 266
 267 sub usage {
 268         # Send the help message to stdout
 269         my $Retval = shift;
 270
 271         if ($Opt{'verbose'}) {
 272                 print("\n");
 273                 print_version();
 274         }
 275         print(<<"END");
 276
 277 Usage: $progname [options]
 278
 279 Contains tests for the $CMDB(1) program.
 280
 281 Options:
 282
 283   -a, --all
 284     Run all tests, also TODOs.
 285   -h, --help
 286     Show this help.
 287   -q, --quiet
 288     Be more quiet. Can be repeated to increase silence.
 289   -t, --todo
 290     Run only the TODO tests.
 291   -v, --verbose
 292     Increase level of verbosity. Can be repeated.
 293   --version
 294     Print version information.
 295
 296 END
 297         exit($Retval);
 298 }
 299
 300 sub msg {
 301         # Print a status message to stderr based on verbosity level
 302         my ($verbose_level, $Txt) = @_;
 303
 304         $verbose_level > $Opt{'verbose'} && return;
 305         print(STDERR "$progname: $Txt\n");
 306
 307         return;
 308 }
 309
 310 __END__
 311
 312 # This program is free software; you can redistribute it and/or modify it under
 313 # the terms of the GNU General Public License as published by the Free Software
 314 # Foundation; either version 2 of the License, or (at your option) any later
 315 # version.
 316 #
 317 # This program is distributed in the hope that it will be useful, but WITHOUT
 318 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 319 # FOR A PARTICULAR PURPOSE.
 320 # See the GNU General Public License for more details.
 321 #
 322 # You should have received a copy of the GNU General Public License along with
 323 # this program.
 324 # If not, see L<http://www.gnu.org/licenses/>.
 325
 326 # vim: set ts=8 sw=8 sts=8 noet fo+=w tw=79 fenc=UTF-8 :