t/109_help_flag.t

   1 # The documentation claims:
   2 #   If Getopt::Long::Descriptive is installed and any of the following command
   3 #   line params are passed (--help, --usage, --?), the program will exit with
   4 #   usage information...
   5
   6 # This is not actually true (as of 0.29), as:
   7 # 1. the consuming class must set up a attributes named 'help', 'usage' and
   8 #     '?' to contain these command line options, which is not clearly
   9 #     documented as a requirement
  10 # 2.  the code is checking whether an option was parsed into an attribute
  11 #     *called* 'help', 'usage' or '?', not whether the option --help, --usage
  12 #     or --? was passed on the command-line (the mapping could be different,
  13 #     if cmd_flag or cmd_aliases is used),
  14
  15 # This inconsistency is the underlying cause of RT#52474, RT#57683, RT#47865.
  16
  17 # Update: since 0.41, usage info is printed to stdout, not stderr.
  18
  19 use strict; use warnings;
  20 use Test::More tests => 22;
  21 use Test::Trap;
  22
  23 {
  24     package MyClass;
  25     use strict; use warnings;
  26     use Moose;
  27     with 'MooseX::Getopt';
  28 }
  29
  30 # before fix, prints this on stderr:
  31 #Unknown option: ?
  32 #usage: test1.t
  33
  34 # after fix, prints this on stdout (formerly stderr):
  35 #usage: test1.t [-?] [long options...]
  36 #       -? --usage --help  Prints this usage information.
  37
  38 my $obj = MyClass->new_with_options;
  39 ok($obj->meta->has_attribute('usage'), 'class has usage attribute');
  40 isa_ok($obj->usage, 'Getopt::Long::Descriptive::Usage');
  41 my $usage_text = $obj->usage->text;
  42
  43 foreach my $args ( ['--help'], ['--usage'], ['--?'], ['-?'], ['-h'] )
  44 {
  45     local @ARGV = @$args;
  46     note "Setting \@ARGV to @$args";
  47
  48     trap { MyClass->new_with_options() };
  49
  50     is($trap->leaveby, 'exit', 'bailed with an exit code');
  51     is($trap->exit, 0, '...of 0');
  52     is(
  53         $trap->stdout,
  54         $usage_text,
  55         'Usage information printed to STDOUT',
  56     );
  57     is($trap->stderr, '', 'there was no STDERR output');
  58 }
  59