Split the args tests into a couple of smaller suites.

pkg/args/test/args_test.dart

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library args_test;
 
 import 'package:unittest/unittest.dart';
 import 'package:args/args.dart';
 
 main() {
@@ skipping 42 matching lines @@
       throwsIllegalArg(() => parser.addOption('flummox', abbr: 'f'));
     });
 
     test('throws ArgumentError if the abbreviation is longer '
          'than one character', () {
       var parser = new ArgParser();
       throwsIllegalArg(() => parser.addOption('flummox', abbr: 'flu'));
     });
   });
 
-  group('ArgParser.parse()', () {
-    group('flags', () {
-      test('are true if present', () {
-        var parser = new ArgParser();
-        parser.addFlag('verbose');
-
-        var args = parser.parse(['--verbose']);
-        expect(args['verbose'], isTrue);
-      });
-
-      test('default if missing', () {
-        var parser = new ArgParser();
-        parser.addFlag('a', defaultsTo: true);
-        parser.addFlag('b', defaultsTo: false);
-
-        var args = parser.parse([]);
-        expect(args['a'], isTrue);
-        expect(args['b'], isFalse);
-      });
-
-      test('are false if missing with no default', () {
-        var parser = new ArgParser();
-        parser.addFlag('verbose');
-
-        var args = parser.parse([]);
-        expect(args['verbose'], isFalse);
-      });
-
-      test('throws if given a value', () {
-        var parser = new ArgParser();
-        parser.addFlag('verbose');
-
-        throwsFormat(parser, ['--verbose=true']);
-      });
+  group('ArgParser.getDefault()', () {
+    test('returns the default value for an option', () {
+      var parser = new ArgParser();
+      parser.addOption('mode', defaultsTo: 'debug');
+      expect(parser.getDefault('mode'), 'debug');
     });
 
-    group('flags negated with "no-"', () {
-      test('set the flag to false', () {
-        var parser = new ArgParser();
-        parser.addFlag('verbose');
-
-        var args = parser.parse(['--no-verbose']);
-        expect(args['verbose'], isFalse);
-      });
-
-      test('set the flag to true if the flag actually starts with "no-"', () {
-        var parser = new ArgParser();
-        parser.addFlag('no-body');
-
-        var args = parser.parse(['--no-body']);
-        expect(args['no-body'], isTrue);
-      });
-
-      test('are not preferred over a colliding one without', () {
-        var parser = new ArgParser();
-        parser.addFlag('no-strum');
-        parser.addFlag('strum');
-
-        var args = parser.parse(['--no-strum']);
-        expect(args['no-strum'], isTrue);
-        expect(args['strum'], isFalse);
-      });
-
-      test('fail for non-negatable flags', () {
-        var parser = new ArgParser();
-        parser.addFlag('strum', negatable: false);
-
-        throwsFormat(parser, ['--no-strum']);
-      });
-    });
-
-    group('callbacks', () {
-      test('for present flags are invoked with the value', () {
-        var a;
-        var parser = new ArgParser();
-        parser.addFlag('a', callback: (value) => a = value);
-
-        var args = parser.parse(['--a']);
-        expect(a, isTrue);
-      });
-
-      test('for absent flags are invoked with the default value', () {
-        var a;
-        var parser = new ArgParser();
-        parser.addFlag('a', defaultsTo: false,
-            callback: (value) => a = value);
-
-        var args = parser.parse([]);
-        expect(a, isFalse);
-      });
-
-      test('are invoked even if the flag is not present', () {
-        var a = 'not called';
-        var parser = new ArgParser();
-        parser.addFlag('a', callback: (value) => a = value);
-
-        var args = parser.parse([]);
-        expect(a, isFalse);
-      });
-
-      test('for present options are invoked with the value', () {
-        var a;
-        var parser = new ArgParser();
-        parser.addOption('a', callback: (value) => a = value);
-
-        var args = parser.parse(['--a=v']);
-        expect(a, equals('v'));
-      });
-
-      test('for absent options are invoked with the default value', () {
-        var a;
-        var parser = new ArgParser();
-        parser.addOption('a', defaultsTo: 'v',
-            callback: (value) => a = value);
-
-        var args = parser.parse([]);
-        expect(a, equals('v'));
-      });
-
-      test('are invoked even if the option is not present', () {
-        var a = 'not called';
-        var parser = new ArgParser();
-        parser.addOption('a', callback: (value) => a = value);
-
-        var args = parser.parse([]);
-        expect(a, isNull);
-      });
-
-      test('for multiple present, allowMultiple, options are invoked with '
-           'value as a list', () {
-        var a;
-        var parser = new ArgParser();
-        parser.addOption('a', allowMultiple: true,
-            callback: (value) => a = value);
-
-        var args = parser.parse(['--a=v', '--a=x']);
-        expect(a, equals(['v', 'x']));
-      });
-
-      test('for single present, allowMultiple, options are invoked with '
-           ' value as a single element list', () {
-        var a;
-        var parser = new ArgParser();
-        parser.addOption('a', allowMultiple: true,
-            callback: (value) => a = value);
-
-        var args = parser.parse(['--a=v']);
-        expect(a, equals(['v']));
-      });
-
-      test('for absent, allowMultiple, options are invoked with default '
-           'value as a list.', () {
-        var a;
-        var parser = new ArgParser();
-        parser.addOption('a', allowMultiple: true, defaultsTo: 'v',
-            callback: (value) => a = value);
-
-        var args = parser.parse([]);
-        expect(a, equals(['v']));
-      });
-
-      test('for absent, allowMultiple, options are invoked with value '
-           'as an empty list.', () {
-        var a;
-        var parser = new ArgParser();
-        parser.addOption('a', allowMultiple: true,
-            callback: (value) => a = value);
-
-        var args = parser.parse([]);
-        expect(a, isEmpty);
-      });
-    });
-
-    group('abbreviations', () {
-      test('are parsed with a preceding "-"', () {
-        var parser = new ArgParser();
-        parser.addFlag('arg', abbr: 'a');
-
-        var args = parser.parse(['-a']);
-        expect(args['arg'], isTrue);
-      });
-
-      test('can use multiple after a single "-"', () {
-        var parser = new ArgParser();
-        parser.addFlag('first', abbr: 'f');
-        parser.addFlag('second', abbr: 's');
-        parser.addFlag('third', abbr: 't');
-
-        var args = parser.parse(['-tf']);
-        expect(args['first'], isTrue);
-        expect(args['second'], isFalse);
-        expect(args['third'], isTrue);
-      });
-
-      test('can have multiple "-" args', () {
-        var parser = new ArgParser();
-        parser.addFlag('first', abbr: 'f');
-        parser.addFlag('second', abbr: 's');
-        parser.addFlag('third', abbr: 't');
-
-        var args = parser.parse(['-s', '-tf']);
-        expect(args['first'], isTrue);
-        expect(args['second'], isTrue);
-        expect(args['third'], isTrue);
-      });
-
-      test('can take arguments without a space separating', () {
-        var parser = new ArgParser();
-        parser.addOption('file', abbr: 'f');
-
-        var args = parser.parse(['-flip']);
-        expect(args['file'], equals('lip'));
-      });
-
-      test('can take arguments with a space separating', () {
-        var parser = new ArgParser();
-        parser.addOption('file', abbr: 'f');
-
-        var args = parser.parse(['-f', 'name']);
-        expect(args['file'], equals('name'));
-      });
-
-      test('allow non-option characters in the value', () {
-        var parser = new ArgParser();
-        parser.addOption('apple', abbr: 'a');
-
-        var args = parser.parse(['-ab?!c']);
-        expect(args['apple'], equals('b?!c'));
-      });
-
-      test('throw if unknown', () {
-        var parser = new ArgParser();
-        throwsFormat(parser, ['-f']);
-      });
-
-      test('throw if the value is missing', () {
-        var parser = new ArgParser();
-        parser.addOption('file', abbr: 'f');
-
-        throwsFormat(parser, ['-f']);
-      });
-
-      test('throw if the value looks like an option', () {
-        var parser = new ArgParser();
-        parser.addOption('file', abbr: 'f');
-        parser.addOption('other');
-
-        throwsFormat(parser, ['-f', '--other']);
-        throwsFormat(parser, ['-f', '--unknown']);
-        throwsFormat(parser, ['-f', '-abbr']);
-      });
-
-      test('throw if the value is not allowed', () {
-        var parser = new ArgParser();
-        parser.addOption('mode', abbr: 'm', allowed: ['debug', 'release']);
-
-        throwsFormat(parser, ['-mprofile']);
-      });
-
-      test('throw if any but the first is not a flag', () {
-        var parser = new ArgParser();
-        parser.addFlag('apple', abbr: 'a');
-        parser.addOption('banana', abbr: 'b'); // Takes an argument.
-        parser.addFlag('cherry', abbr: 'c');
-
-        throwsFormat(parser, ['-abc']);
-      });
-
-      test('throw if it has a value but the option is a flag', () {
-        var parser = new ArgParser();
-        parser.addFlag('apple', abbr: 'a');
-        parser.addFlag('banana', abbr: 'b');
-
-        // The '?!' means this can only be understood as '--apple b?!c'.
-        throwsFormat(parser, ['-ab?!c']);
-      });
-    });
-
-    group('options', () {
-      test('are parsed if present', () {
-        var parser = new ArgParser();
-        parser.addOption('mode');
-        var args = parser.parse(['--mode=release']);
-        expect(args['mode'], equals('release'));
-      });
-
-      test('are null if not present', () {
-        var parser = new ArgParser();
-        parser.addOption('mode');
-        var args = parser.parse([]);
-        expect(args['mode'], isNull);
-      });
-
-      test('default if missing', () {
-        var parser = new ArgParser();
-        parser.addOption('mode', defaultsTo: 'debug');
-        var args = parser.parse([]);
-        expect(args['mode'], equals('debug'));
-      });
-
-      test('allow the value to be separated by whitespace', () {
-        var parser = new ArgParser();
-        parser.addOption('mode');
-        var args = parser.parse(['--mode', 'release']);
-        expect(args['mode'], equals('release'));
-      });
-
-      test('throw if unknown', () {
-        var parser = new ArgParser();
-        throwsFormat(parser, ['--unknown']);
-        throwsFormat(parser, ['--nobody']); // Starts with "no".
-      });
-
-      test('throw if the arg does not include a value', () {
-        var parser = new ArgParser();
-        parser.addOption('mode');
-        throwsFormat(parser, ['--mode']);
-      });
-
-      test('throw if the value looks like an option', () {
-        var parser = new ArgParser();
-        parser.addOption('mode');
-        parser.addOption('other');
-
-        throwsFormat(parser, ['--mode', '--other']);
-        throwsFormat(parser, ['--mode', '--unknown']);
-        throwsFormat(parser, ['--mode', '-abbr']);
-      });
-
-      test('do not throw if the value is in the allowed set', () {
-        var parser = new ArgParser();
-        parser.addOption('mode', allowed: ['debug', 'release']);
-        var args = parser.parse(['--mode=debug']);
-        expect(args['mode'], equals('debug'));
-      });
-
-      test('throw if the value is not in the allowed set', () {
-        var parser = new ArgParser();
-        parser.addOption('mode', allowed: ['debug', 'release']);
-        throwsFormat(parser, ['--mode=profile']);
-      });
-
-      test('returns last provided value', () {
-        var parser = new ArgParser();
-        parser.addOption('define');
-        var args = parser.parse(['--define=1', '--define=2']);
-        expect(args['define'], equals('2'));
-      });
-
-      test('returns a List if multi-valued', () {
-        var parser = new ArgParser();
-        parser.addOption('define', allowMultiple: true);
-        var args = parser.parse(['--define=1']);
-        expect(args['define'], equals(['1']));
-        args = parser.parse(['--define=1', '--define=2']);
-        expect(args['define'], equals(['1','2']));
-      });
-
-      test('returns the default value for multi-valued arguments '
-           'if not explicitly set', () {
-        var parser = new ArgParser();
-        parser.addOption('define', defaultsTo: '0', allowMultiple: true);
-        var args = parser.parse(['']);
-        expect(args['define'], equals(['0']));
-      });
-    });
-
-    group('query default values', () {
-      test('queries the default value', () {
-        var parser = new ArgParser();
-        parser.addOption('define', defaultsTo: '0');
-        expect(()=>parser.getDefault('undefine'),
-            throwsArgumentError);
-      });
-
-      test('queries the default value for an unknown option', () {
-        var parser = new ArgParser();
-        parser.addOption('define', defaultsTo: '0');
-        expect(()=>parser.getDefault('undefine'),
-            throwsArgumentError);
-      });
-    });
-
-    group('gets the option names from an ArgsResult', () {
-      test('queries the set options', () {
-        var parser = new ArgParser();
-        parser.addFlag('woof', defaultsTo: false);
-        parser.addOption('meow', defaultsTo: 'kitty');
-        var args = parser.parse([]);
-        expect(args.options, hasLength(2));
-        expect(args.options.any((o) => o == 'woof'), isTrue);
-        expect(args.options.any((o) => o == 'meow'), isTrue);
-      });
-    });
-
-    group('remaining args', () {
-      test('stops parsing args when a non-option-like arg is encountered', () {
-        var parser = new ArgParser();
-        parser.addFlag('woof');
-        parser.addOption('meow');
-        parser.addOption('tweet', defaultsTo: 'bird');
-
-        var results = parser.parse(['--woof', '--meow', 'v', 'not', 'option']);
-        expect(results['woof'], isTrue);
-        expect(results['meow'], equals('v'));
-        expect(results['tweet'], equals('bird'));
-        expect(results.rest, orderedEquals(['not', 'option']));
-      });
-
-      test('stops parsing at "--"', () {
-        var parser = new ArgParser();
-        parser.addFlag('woof', defaultsTo: false);
-        parser.addOption('meow', defaultsTo: 'kitty');
-
-        var results = parser.parse(['--woof', '--', '--meow']);
-        expect(results['woof'], isTrue);
-        expect(results['meow'], equals('kitty'));
-        expect(results.rest, orderedEquals(['--meow']));
-      });
-
-      test('handles options with case-sensitivity', () {
-        var parser = new ArgParser();
-        parser.addFlag('recurse', defaultsTo: false, abbr:'R');
-        var results = parser.parse(['-R']);
-        expect(results['recurse'], isTrue);
-        expect(results.rest, [ ]);
-        throwsFormat(parser, ['-r']);
-      });
+    test('throws if the option is unknown', () {
+      var parser = new ArgParser();
+      parser.addOption('mode', defaultsTo: 'debug');
+      expect(()=>parser.getDefault('undefined'),
+          throwsArgumentError);
     });
   });
 
-  group('ArgParser.getUsage()', () {
-    test('negatable flags show "no-" in title', () {
+  group('ArgResults.options', () {
+    test('returns the provided options', () {
       var parser = new ArgParser();
-      parser.addFlag('mode', help: 'The mode');
-
-      validateUsage(parser,
-          '''
-          --[no-]mode    The mode
-          ''');
+      parser.addFlag('woof');
+      parser.addOption('meow');
+      var args = parser.parse(['--woof', '--meow', 'kitty']);
+      expect(args.options, hasLength(2));
+      expect(args.options.any((o) => o == 'woof'), isTrue);
+      expect(args.options.any((o) => o == 'meow'), isTrue);
     });
 
-    test('non-negatable flags don\'t show "no-" in title', () {
+    test('includes defaulted options', () {
       var parser = new ArgParser();
-      parser.addFlag('mode', negatable: false, help: 'The mode');
-
-      validateUsage(parser,
-          '''
-          --mode    The mode
-          ''');
-    });
-
-    test('if there are no abbreviations, there is no column for them', () {
-      var parser = new ArgParser();
-      parser.addFlag('mode', help: 'The mode');
-
-      validateUsage(parser,
-          '''
-          --[no-]mode    The mode
-          ''');
-    });
-
-    test('options are lined up past abbreviations', () {
-      var parser = new ArgParser();
-      parser.addFlag('mode', abbr: 'm', help: 'The mode');
-      parser.addOption('long', help: 'Lacks an abbreviation');
-
-      validateUsage(parser,
-          '''
-          -m, --[no-]mode    The mode
-              --long         Lacks an abbreviation
-          ''');
-    });
-
-    test('help text is lined up past the longest option', () {
-      var parser = new ArgParser();
-      parser.addFlag('mode', abbr: 'm', help: 'Lined up with below');
-      parser.addOption('a-really-long-name', help: 'Its help text');
-
-      validateUsage(parser,
-          '''
-          -m, --[no-]mode             Lined up with below
-              --a-really-long-name    Its help text
-          ''');
-    });
-
-    test('leading empty lines are ignored in help text', () {
-      var parser = new ArgParser();
-      parser.addFlag('mode', help: '\n\n\n\nAfter newlines');
-
-      validateUsage(parser,
-          '''
-          --[no-]mode    After newlines
-          ''');
-    });
-
-    test('trailing empty lines are ignored in help text', () {
-      var parser = new ArgParser();
-      parser.addFlag('mode', help: 'Before newlines\n\n\n\n');
-
-      validateUsage(parser,
-          '''
-          --[no-]mode    Before newlines
-          ''');
-    });
-
-    test('options are documented in the order they were added', () {
-      var parser = new ArgParser();
-      parser.addFlag('zebra', help: 'First');
-      parser.addFlag('monkey', help: 'Second');
-      parser.addFlag('wombat', help: 'Third');
-
-      validateUsage(parser,
-          '''
-          --[no-]zebra     First
-          --[no-]monkey    Second
-          --[no-]wombat    Third
-          ''');
-    });
-
-    test('the default value for a flag is shown if on', () {
-      var parser = new ArgParser();
-      parser.addFlag('affirm', help: 'Should be on', defaultsTo: true);
-      parser.addFlag('negate', help: 'Should be off', defaultsTo: false);
-
-      validateUsage(parser,
-          '''
-          --[no-]affirm    Should be on
-                           (defaults to on)
-
-          --[no-]negate    Should be off
-          ''');
-    });
-
-    test('the default value for an option with no allowed list is shown', () {
-      var parser = new ArgParser();
-      parser.addOption('any', help: 'Can be anything', defaultsTo: 'whatevs');
-
-      validateUsage(parser,
-          '''
-          --any    Can be anything
-                   (defaults to "whatevs")
-          ''');
-    });
-
-    test('the allowed list is shown', () {
-      var parser = new ArgParser();
-      parser.addOption('suit', help: 'Like in cards',
-          allowed: ['spades', 'clubs', 'hearts', 'diamonds']);
-
-      validateUsage(parser,
-          '''
-          --suit    Like in cards
-                    [spades, clubs, hearts, diamonds]
-          ''');
-    });
-
-    test('the default is highlighted in the allowed list', () {
-      var parser = new ArgParser();
-      parser.addOption('suit', help: 'Like in cards', defaultsTo: 'clubs',
-          allowed: ['spades', 'clubs', 'hearts', 'diamonds']);
-
-      validateUsage(parser,
-          '''
-          --suit    Like in cards
-                    [spades, clubs (default), hearts, diamonds]
-          ''');
-    });
-
-    test('the allowed help is shown', () {
-      var parser = new ArgParser();
-      parser.addOption('suit', help: 'Like in cards', defaultsTo: 'clubs',
-          allowed: ['spades', 'clubs', 'diamonds', 'hearts'],
-          allowedHelp: {
-            'spades': 'Swords of a soldier',
-            'clubs': 'Weapons of war',
-            'diamonds': 'Money for this art',
-            'hearts': 'The shape of my heart'
-          });
-
-      validateUsage(parser,
-          '''
-          --suit              Like in cards
-
-                [clubs]       Weapons of war
-                [diamonds]    Money for this art
-                [hearts]      The shape of my heart
-                [spades]      Swords of a soldier
-          ''');
+      parser.addFlag('woof', defaultsTo: false);
+      parser.addOption('meow', defaultsTo: 'kitty');
+      var args = parser.parse([]);
+      expect(args.options, hasLength(2));
+      expect(args.options.any((o) => o == 'woof'), isTrue);
+      expect(args.options.any((o) => o == 'meow'), isTrue);
     });
   });
 
   group('ArgResults[]', () {
     test('throws if the name is not an option', () {
       var parser = new ArgParser();
       var results = parser.parse([]);
       throwsIllegalArg(() => results['unknown']);
     });
   });
 }
 
 throwsIllegalArg(function) {
   expect(function, throwsArgumentError);
 }
 
 throwsFormat(ArgParser parser, List<String> args) {
   expect(() => parser.parse(args), throwsFormatException);
 }
-
-validateUsage(ArgParser parser, String expected) {
-  expected = unindentString(expected);
-  expect(parser.getUsage(), equals(expected));
-}
-
-// TODO(rnystrom): Replace one in test_utils.
-String unindentString(String text) {
-  var lines = text.split('\n');
-
-  // Count the indentation of the last line.
-  var whitespace = new RegExp('^ *');
-  var indent = whitespace.firstMatch(lines[lines.length - 1])[0].length;
-
-  // Drop the last line. It only exists for specifying indentation.
-  lines.removeLast();
-
-  // Strip indentation from the remaining lines.
-  for (var i = 0; i < lines.length; i++) {
-    var line = lines[i];
-    if (line.length <= indent) {
-      // It's short, so it must be nothing but whitespace.
-      if (line.trim() != '') {
-        throw new ArgumentError(
-            'Line "$line" does not have enough indentation.');
-      }
-
-      lines[i] = '';
-    } else {
-      if (line.substring(0, indent).trim() != '') {
-        throw new ArgumentError(
-            'Line "$line" does not have enough indentation.');
-      }
-
-      lines[i] = line.substring(indent);
-    }
-  }
-
-  return Strings.join(lines, '\n');
-}