tests/csv2gpx.t

   1 #!/usr/bin/perl -w
   2
   3 #=======================================================================
   4 # csv2gpx.t
   5 # File ID: d4031198-f987-11dd-9f3b-000475e441b9
   6 # Test suite for csv2gpx(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 = "../csv2gpx";
  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 ok(`$CMD -h` !~ /^\n\S+ v\d\.\d\d\n/s, "\"$CMD -h\" - No Id with only -h");
  93 diag("Testing -v (--verbose) option...");
  94 likecmd("$CMD -hv", # {{{
  95     '/^\n\S+ v\d\.\d\d\n/s',
  96     '/^$/',
  97     "Option --version with -h returns version number and help screen",
  98 );
  99
 100 # }}}
 101 diag("Testing --version option...");
 102 likecmd("$CMD --version", # {{{
 103     '/^\S+ v\d\.\d\d\n/',
 104     '/^$/',
 105     "Option --version returns version number",
 106 );
 107
 108 # }}}
 109
 110 todo_section:
 111 ;
 112
 113 if ($Opt{'all'} || $Opt{'todo'}) {
 114     diag("Running TODO tests..."); # {{{
 115
 116     TODO: {
 117
 118 local $TODO = "";
 119 # Insert TODO tests here.
 120
 121     }
 122     # TODO tests }}}
 123 }
 124
 125 diag("Testing finished.");
 126
 127 sub testcmd {
 128     # {{{
 129     my ($Cmd, $Exp_stdout, $Exp_stderr, $Desc) = @_;
 130     my $stderr_cmd = "";
 131     my $deb_str = $Opt{'debug'} ? " --debug" : "";
 132     my $Txt = join("",
 133         "\"$Cmd\"",
 134         defined($Desc)
 135             ? " - $Desc"
 136             : ""
 137     );
 138     my $TMP_STDERR = "csv2gpx-stderr.tmp";
 139
 140     if (defined($Exp_stderr) && !length($deb_str)) {
 141         $stderr_cmd = " 2>$TMP_STDERR";
 142     }
 143     is(`$Cmd$deb_str$stderr_cmd`, $Exp_stdout, $Txt);
 144     if (defined($Exp_stderr)) {
 145         if (!length($deb_str)) {
 146             is(file_data($TMP_STDERR), $Exp_stderr, "$Txt (stderr)");
 147             unlink($TMP_STDERR);
 148         }
 149     } else {
 150         diag("Warning: stderr not defined for '$Txt'");
 151     }
 152     # }}}
 153 } # testcmd()
 154
 155 sub likecmd {
 156     # {{{
 157     my ($Cmd, $Exp_stdout, $Exp_stderr, $Desc) = @_;
 158     my $stderr_cmd = "";
 159     my $deb_str = $Opt{'debug'} ? " --debug" : "";
 160     my $Txt = join("",
 161         "\"$Cmd\"",
 162         defined($Desc)
 163             ? " - $Desc"
 164             : ""
 165     );
 166     my $TMP_STDERR = "csv2gpx-stderr.tmp";
 167
 168     if (defined($Exp_stderr) && !length($deb_str)) {
 169         $stderr_cmd = " 2>$TMP_STDERR";
 170     }
 171     like(`$Cmd$deb_str$stderr_cmd`, "$Exp_stdout", $Txt);
 172     if (defined($Exp_stderr)) {
 173         if (!length($deb_str)) {
 174             like(file_data($TMP_STDERR), "$Exp_stderr", "$Txt (stderr)");
 175             unlink($TMP_STDERR);
 176         }
 177     } else {
 178         diag("Warning: stderr not defined for '$Txt'");
 179     }
 180     # }}}
 181 } # likecmd()
 182
 183 sub file_data {
 184     # Return file content as a string {{{
 185     my $File = shift;
 186     my $Txt;
 187     if (open(FP, "<", $File)) {
 188         $Txt = join("", <FP>);
 189         close(FP);
 190         return($Txt);
 191     } else {
 192         return undef;
 193     }
 194     # }}}
 195 } # file_data()
 196
 197 sub print_version {
 198     # Print program version {{{
 199     print("$progname v$VERSION\n");
 200     # }}}
 201 } # print_version()
 202
 203 sub usage {
 204     # Send the help message to stdout {{{
 205     my $Retval = shift;
 206
 207     if ($Opt{'verbose'}) {
 208         print("\n");
 209         print_version();
 210     }
 211     print(<<END);
 212
 213 Usage: $progname [options] [file [files [...]]]
 214
 215 Contains tests for the csv2gpx(1) program.
 216
 217 Options:
 218
 219   -a, --all
 220     Run all tests, also TODOs.
 221   -h, --help
 222     Show this help.
 223   -t, --todo
 224     Run only the TODO tests.
 225   -v, --verbose
 226     Increase level of verbosity. Can be repeated.
 227   --version
 228     Print version information.
 229   --debug
 230     Print debugging messages.
 231
 232 END
 233     exit($Retval);
 234     # }}}
 235 } # usage()
 236
 237 sub msg {
 238     # Print a status message to stderr based on verbosity level {{{
 239     my ($verbose_level, $Txt) = @_;
 240
 241     if ($Opt{'verbose'} >= $verbose_level) {
 242         print(STDERR "$progname: $Txt\n");
 243     }
 244     # }}}
 245 } # msg()
 246
 247 __END__
 248
 249 # Plain Old Documentation (POD) {{{
 250
 251 =pod
 252
 253 =head1 NAME
 254
 255 run-tests.pl
 256
 257 =head1 SYNOPSIS
 258
 259 csv2gpx.t [options] [file [files [...]]]
 260
 261 =head1 DESCRIPTION
 262
 263 Contains tests for the csv2gpx(1) program.
 264
 265 =head1 OPTIONS
 266
 267 =over 4
 268
 269 =item B<-a>, B<--all>
 270
 271 Run all tests, also TODOs.
 272
 273 =item B<-h>, B<--help>
 274
 275 Print a brief help summary.
 276
 277 =item B<-t>, B<--todo>
 278
 279 Run only the TODO tests.
 280
 281 =item B<-v>, B<--verbose>
 282
 283 Increase level of verbosity. Can be repeated.
 284
 285 =item B<--version>
 286
 287 Print version information.
 288
 289 =item B<--debug>
 290
 291 Print debugging messages.
 292
 293 =back
 294
 295 =head1 AUTHOR
 296
 297 Made by Øyvind A. Holm S<E<lt>sunny@sunbase.orgE<gt>>.
 298
 299 =head1 COPYRIGHT
 300
 301 Copyleft © Øyvind A. Holm E<lt>sunny@sunbase.orgE<gt>
 302 This is free software; see the file F<COPYING> for legalese stuff.
 303
 304 =head1 LICENCE
 305
 306 This program is free software: you can redistribute it and/or modify it
 307 under the terms of the GNU General Public License as published by the
 308 Free Software Foundation, either version 3 of the License, or (at your
 309 option) any later version.
 310
 311 This program is distributed in the hope that it will be useful, but
 312 WITHOUT ANY WARRANTY; without even the implied warranty of
 313 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 314 See the GNU General Public License for more details.
 315
 316 You should have received a copy of the GNU General Public License along
 317 with this program.
 318 If not, see L<http://www.gnu.org/licenses/>.
 319
 320 =head1 SEE ALSO
 321
 322 =cut
 323
 324 # }}}
 325
 326 # vim: set fenc=UTF-8 ft=perl fdm=marker ts=4 sw=4 sts=4 et fo+=w :