CLI driver test re-enablement (#25001).

pkg/analyzer_cli/test/driver_test.dart

 // Copyright (c) 2015, 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 analyzer_cli.test.driver;
 
 import 'dart:io';
 
 import 'package:analyzer/plugin/options.dart';
 import 'package:analyzer/source/analysis_options_provider.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/error.dart';
 import 'package:analyzer/src/generated/source.dart';
 import 'package:analyzer/src/plugin/plugin_configuration.dart';
 import 'package:analyzer/src/services/lint.dart';
 import 'package:analyzer_cli/src/bootloader.dart';
 import 'package:analyzer_cli/src/driver.dart';
 import 'package:analyzer_cli/src/options.dart';
 import 'package:path/path.dart' as path;
 import 'package:plugin/plugin.dart';
 import 'package:unittest/unittest.dart';
 import 'package:yaml/src/yaml_node.dart';
 
-// TODO(pq): fix tests to run safely on the bots
-// https://github.com/dart-lang/sdk/issues/25001
-main() {}
-const emptyOptionsFile = 'test/data/empty_options.yaml';
+import 'utils.dart';
 
-/// Start a driver for the given [source], optionally providing additional
-/// [args] and an [options] file path.  The value of [options] defaults to
-/// an empty options file to avoid unwanted configuration from an otherwise
-/// discovered options file.
-void drive(String source,
-        {String options: emptyOptionsFile,
-        List<String> args: const <String>[]}) =>
-    new Driver().start(['--options', options, source]..addAll(args));
+main() {
+  StringSink savedOutSink, savedErrorSink;
+  int savedExitCode;
+  ExitHandler savedExitHandler;
 
-not_main() {
+  /// Base setup.
+  _setUp() {
+    savedOutSink = outSink;
+    savedErrorSink = errorSink;
+    savedExitHandler = exitHandler;
+    savedExitCode = exitCode;
+    exitHandler = (code) => exitCode = code;
+    outSink = new StringBuffer();
+    errorSink = new StringBuffer();
+  }
+
+  /// Base teardown.
+  _tearDown() {
+    outSink = savedOutSink;
+    errorSink = savedErrorSink;
+    exitCode = savedExitCode;
+    exitHandler = savedExitHandler;
+  }
+
+  setUp(() => _setUp());
+
+  tearDown(() => _tearDown());
+
   group('Driver', () {
-    StringSink savedOutSink, savedErrorSink;
-    int savedExitCode;
-    setUp(() {
-      savedOutSink = outSink;
-      savedErrorSink = errorSink;
-      savedExitCode = exitCode;
-      outSink = new StringBuffer();
-      errorSink = new StringBuffer();
-    });
-    tearDown(() {
-      outSink = savedOutSink;
-      errorSink = savedErrorSink;
-      exitCode = savedExitCode;
-    });
-
     group('options', () {
       test('custom processor', () {
         Driver driver = new Driver();
         TestProcessor processor = new TestProcessor();
         driver.userDefinedPlugins = [new TestPlugin(processor)];
         driver.start([
           '--options',
-          'test/data/test_options.yaml',
-          'test/data/test_file.dart'
+          path.join(testDirectory, 'data/test_options.yaml'),
+          path.join(testDirectory, 'data/test_file.dart')
         ]);
         expect(processor.options['test_plugin'], isNotNull);
         expect(processor.exception, isNull);
       });
     });
 
+    //TODO(pq): refactor to NOT set actual error codes to play nice with bots
     group('exit codes', () {
-      StringSink savedOutSink, savedErrorSink;
-      int savedExitCode;
-      ExitHandler savedExitHandler;
-      setUp(() {
-        savedOutSink = outSink;
-        savedErrorSink = errorSink;
-        savedExitCode = exitCode;
-        savedExitHandler = exitHandler;
-        exitHandler = (code) => exitCode = code;
-        outSink = new StringBuffer();
-        errorSink = new StringBuffer();
-      });
-      tearDown(() {
-        outSink = savedOutSink;
-        errorSink = savedErrorSink;
-        exitCode = savedExitCode;
-        exitHandler = savedExitHandler;
-      });
-
       test('fatal hints', () {
-        drive('test/data/file_with_hint.dart', args: ['--fatal-hints']);
+        drive('data/file_with_hint.dart', args: ['--fatal-hints']);
         expect(exitCode, 3);
       });
 
       test('not fatal hints', () {
-        drive('test/data/file_with_hint.dart');
+        drive('data/file_with_hint.dart');
         expect(exitCode, 0);
       });
 
       test('fatal errors', () {
-        drive('test/data/file_with_error.dart');
+        drive('data/file_with_error.dart');
         expect(exitCode, 3);
       });
 
       test('not fatal warnings', () {
-        drive('test/data/file_with_warning.dart');
+        drive('data/file_with_warning.dart');
         expect(exitCode, 0);
       });
 
       test('fatal warnings', () {
-        drive('test/data/file_with_warning.dart', args: ['--fatal-warnings']);
+        drive('data/file_with_warning.dart', args: ['--fatal-warnings']);
         expect(exitCode, 3);
       });
 
       test('missing options file', () {
-        drive('test/data/test_file.dart', options: 'test/data/NO_OPTIONS_HERE');
+        drive('data/test_file.dart', options: 'data/NO_OPTIONS_HERE');
         expect(exitCode, 3);
       });
 
       test('missing dart file', () {
-        drive('test/data/NO_DART_FILE_HERE.dart');
+        drive('data/NO_DART_FILE_HERE.dart');
         expect(exitCode, 3);
       });
 
       test('part file', () {
-        drive('test/data/library_and_parts/part2.dart');
+        drive('data/library_and_parts/part2.dart');
         expect(exitCode, 3);
       });
 
       test('non-dangling part file', () {
         Driver driver = new Driver();
         driver.start([
-          'test/data/library_and_parts/lib.dart',
-          'test/data/library_and_parts/part1.dart',
+          path.join(testDirectory, 'data/library_and_parts/lib.dart'),
+          path.join(testDirectory, 'data/library_and_parts/part1.dart')
         ]);
         expect(exitCode, 0);
       });
 
       test('extra part file', () {
         Driver driver = new Driver();
         driver.start([
-          'test/data/library_and_parts/lib.dart',
-          'test/data/library_and_parts/part1.dart',
-          'test/data/library_and_parts/part2.dart',
+          path.join(testDirectory, 'data/library_and_parts/lib.dart'),
+          path.join(testDirectory, 'data/library_and_parts/part1.dart'),
+          path.join(testDirectory, 'data/library_and_parts/part2.dart')
         ]);
         expect(exitCode, 3);
       });
     });
 
     group('linter', () {
       group('lints in options', () {
-        StringSink savedOutSink;
-        Driver driver;
-
-        setUp(() {
-          savedOutSink = outSink;
-          outSink = new StringBuffer();
-
-          driver = new Driver();
-          driver.start([
-            '--options',
-            'test/data/linter_project/.analysis_options',
-            '--lints',
-            'test/data/linter_project/test_file.dart'
-          ]);
-        });
-        tearDown(() {
-          outSink = savedOutSink;
-        });
+        // Shared lint command.
+        var runLinter = () => drive('data/linter_project/test_file.dart',
+            options: 'data/linter_project/.analysis_options',
+            args: ['--lints']);
 
         test('gets analysis options', () {
+          runLinter();
+
           /// Lints should be enabled.
           expect(driver.context.analysisOptions.lint, isTrue);
 
           /// The .analysis_options file only specifies 'camel_case_types'.
           var lintNames = getLints(driver.context).map((r) => r.name);
           expect(lintNames, orderedEquals(['camel_case_types']));
         });
 
         test('generates lints', () {
+          runLinter();
           expect(outSink.toString(),
               contains('[lint] Name types using UpperCamelCase.'));
         });
       });
 
       group('default lints', () {
-        StringSink savedOutSink;
-        Driver driver;
-
-        setUp(() {
-          savedOutSink = outSink;
-          outSink = new StringBuffer();
-
-          driver = new Driver();
-          driver.start([
-            '--lints',
-            'test/data/linter_project/test_file.dart',
-            '--options',
-            'test/data/linter_project/.analysis_options'
-          ]);
-        });
-        tearDown(() {
-          outSink = savedOutSink;
-        });
+        // Shared lint command.
+        var runLinter = () => drive('data/linter_project/test_file.dart',
+            options: 'data/linter_project/.analysis_options',
+            args: ['--lints']);
 
         test('gets default lints', () {
+          runLinter();
+
           /// Lints should be enabled.
           expect(driver.context.analysisOptions.lint, isTrue);
 
           /// Default list should include camel_case_types.
           var lintNames = getLints(driver.context).map((r) => r.name);
           expect(lintNames, contains('camel_case_types'));
         });
 
         test('generates lints', () {
+          runLinter();
           expect(outSink.toString(),
               contains('[lint] Name types using UpperCamelCase.'));
         });
       });
 
       group('no `--lints` flag (none in options)', () {
-        StringSink savedOutSink;
-        Driver driver;
-
-        setUp(() {
-          savedOutSink = outSink;
-          outSink = new StringBuffer();
-
-          driver = new Driver();
-          driver.start([
-            'test/data/no_lints_project/test_file.dart',
-            '--options',
-            'test/data/no_lints_project/.analysis_options'
-          ]);
-        });
-        tearDown(() {
-          outSink = savedOutSink;
-        });
+        // Shared lint command.
+        var runLinter = () => drive('data/no_lints_project/test_file.dart',
+            options: 'data/no_lints_project/.analysis_options');
 
         test('lints disabled', () {
+          runLinter();
           expect(driver.context.analysisOptions.lint, isFalse);
         });
 
         test('no registered lints', () {
+          runLinter();
           expect(getLints(driver.context), isEmpty);
         });
 
         test('no generated warnings', () {
+          runLinter();
           expect(outSink.toString(), contains('No issues found'));
         });
       });
     });
 
     test('containsLintRuleEntry', () {
       Map<String, YamlNode> options;
       options = parseOptions('''
 linter:
   rules:
@@ skipping 11 matching lines @@
       expect(containsLintRuleEntry(options), true);
       options = parseOptions('''
 linter:
  # rules:
     # - foo
         ''');
       expect(containsLintRuleEntry(options), false);
     });
 
     group('options processing', () {
+      // Shared driver command.
+      var doDrive = () => drive('data/options_tests_project/test_file.dart',
+          options: 'data/options_tests_project/.analysis_options');
+
       group('error filters', () {
-        StringSink savedOutSink;
-        Driver driver;
-
-        setUp(() {
-          savedOutSink = outSink;
-          outSink = new StringBuffer();
-
-          driver = new Driver();
-          driver.start([
-            'test/data/options_tests_project/test_file.dart',
-            '--options',
-            'test/data/options_tests_project/.analysis_options'
-          ]);
-        });
-        tearDown(() {
-          outSink = savedOutSink;
-        });
-
         test('filters', () {
+          doDrive();
           var processors =
               driver.context.getConfigurationData(CONFIGURED_ERROR_PROCESSORS);
           expect(processors, hasLength(1));
 
           var unused_local_variable = new AnalysisError(
               new TestSource(), 0, 1, HintCode.UNUSED_LOCAL_VARIABLE, [
             ['x']
           ]);
 
           var unusedLocalVariable =
               processors.firstWhere((p) => p.appliesTo(unused_local_variable));
           expect(unusedLocalVariable.severity, isNull);
         });
 
         test('language config', () {
+          doDrive();
           expect(driver.context.analysisOptions.enableSuperMixins, isTrue);
         });
       });
     });
 
     group('in temp directory', () {
-      StringSink savedOutSink, savedErrorSink;
-      int savedExitCode;
       Directory savedCurrentDirectory;
       Directory tempDir;
       setUp(() {
-        savedOutSink = outSink;
-        savedErrorSink = errorSink;
-        savedExitCode = exitCode;
-        outSink = new StringBuffer();
-        errorSink = new StringBuffer();
+        // Call base setUp.
+        _setUp();
         savedCurrentDirectory = Directory.current;
         tempDir = Directory.systemTemp.createTempSync('analyzer_');
       });
       tearDown(() {
-        outSink = savedOutSink;
-        errorSink = savedErrorSink;
-        exitCode = savedExitCode;
         Directory.current = savedCurrentDirectory;
         tempDir.deleteSync(recursive: true);
+        // Call base tearDown.
+        _tearDown();
       });
 
       test('packages folder', () {
         Directory.current = tempDir;
         new File(path.join(tempDir.path, 'test.dart')).writeAsStringSync('''
 import 'package:foo/bar.dart';
 main() {
   baz();
 }
         ''');
@@ skipping 29 matching lines @@
         expect(exitCode, 3);
         expect(
             stdout,
             contains(
                 'Package root directory (does/not/exist) does not exist.'));
       });
     });
   });
   group('Bootloader', () {
     group('plugin processing', () {
-      StringSink savedErrorSink;
-      setUp(() {
-        savedErrorSink = errorSink;
-        errorSink = new StringBuffer();
-      });
-      tearDown(() {
-        errorSink = savedErrorSink;
-      });
       test('bad format', () {
         BootLoader loader = new BootLoader();
         loader.createImage([
           '--options',
-          'test/data/bad_plugin_options.yaml',
-          'test/data/test_file.dart'
+          path.join(testDirectory, 'data/bad_plugin_options.yaml'),
+          path.join(testDirectory, 'data/test_file.dart')
         ]);
         expect(
             errorSink.toString(),
             equals('Plugin configuration skipped: Unrecognized plugin config '
                 'format, expected `YamlMap`, got `YamlList` '
                 '(line 2, column 4)\n'));
       });
       test('plugin config', () {
         BootLoader loader = new BootLoader();
         Image image = loader.createImage([
           '--options',
-          'test/data/plugin_options.yaml',
-          'test/data/test_file.dart'
+          path.join(testDirectory, 'data/plugin_options.yaml'),
+          path.join(testDirectory, 'data/test_file.dart')
         ]);
         var plugins = image.config.plugins;
         expect(plugins, hasLength(1));
         expect(plugins.first.name, equals('my_plugin1'));
       });
       group('plugin validation', () {
         test('requires class name', () {
           expect(
               validate(new PluginInfo(
                   name: 'test_plugin', libraryUri: 'my_package/foo.dart')),
@@ skipping 11 matching lines @@
                   name: 'test_plugin',
                   className: 'MyPlugin',
                   libraryUri: 'my_package/foo.dart')),
               isNull);
         });
       });
     });
   });
 }
 
+const emptyOptionsFile = 'data/empty_options.yaml';
+
+/// Shared driver.
+Driver driver;
+
+/// Start a driver for the given [source], optionally providing additional
+/// [args] and an [options] file path.  The value of [options] defaults to
+/// an empty options file to avoid unwanted configuration from an otherwise
+/// discovered options file.
+void drive(String source,
+    {String options: emptyOptionsFile, List<String> args: const <String>[]}) {
+  driver = new Driver();
+  var cmd = [
+    '--options',
+    path.join(testDirectory, options),
+    path.join(testDirectory, source)
+  ]..addAll(args);
+  driver.start(cmd);
+}
+
 Map<String, YamlNode> parseOptions(String src) =>
     new AnalysisOptionsProvider().getOptionsFromString(src);
 
 class TestPlugin extends Plugin {
   TestProcessor processor;
   TestPlugin(this.processor);
 
   @override
   String get uniqueIdentifier => 'test_plugin.core';
 
@@ skipping 23 matching lines @@
     this.options = options;
   }
 }
 
 class TestSource implements Source {
   TestSource();
 
   @override
   noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
 }