Refactoring analyzer_cli for code hygiene.

pkg/analyzer_cli/lib/src/analyzer_driver.dart

 // Copyright (c) 2015, the Dart project authors.  Please see the AUTHORS file

[Brian Wilkerson, 2017/04/24 20:26:47]

I don't understand why the name of the file was changed. (1) We generally use
file names that match the name of the primary class, which in this case is
Driver. (2) We use the name 'driver.dart' in analysis_server, so it  would be
easier to find if we used the same name in both places. (3) I know the name of
this file, so making unmotivated changes (if this is one) only makes me have to
re-learn where to find the code I'm looking for.

[devoncarew, 2017/04/24 22:10:00]

I can change this name back to 'driver.dart'. It was odd to me to have the file
'analyzer_impl.dart' prefixed with analyzer, and not to have the entrypoint be
prefixed as well. Perhaps there's a better way to factor the impl file which
would lead to a more descriptive name.

 // 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.src.driver;
-
 import 'dart:async';
-import 'dart:convert';
 import 'dart:io' as io;
 
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/file_system/file_system.dart' as file_system;
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/physical_file_system.dart';
 import 'package:analyzer/plugin/resolver_provider.dart';
 import 'package:analyzer/source/package_map_provider.dart';
 import 'package:analyzer/source/package_map_resolver.dart';
 import 'package:analyzer/source/pub_package_map_provider.dart';
@@ skipping 10 matching lines @@
 import 'package:analyzer/src/generated/sdk.dart';
 import 'package:analyzer/src/generated/source.dart';
 import 'package:analyzer/src/generated/source_io.dart';
 import 'package:analyzer/src/generated/utilities_general.dart'
     show PerformanceTag;
 import 'package:analyzer/src/source/source_resource.dart';
 import 'package:analyzer/src/summary/idl.dart';
 import 'package:analyzer/src/summary/package_bundle_reader.dart';
 import 'package:analyzer/src/summary/summary_sdk.dart' show SummaryBasedDartSdk;
 import 'package:analyzer_cli/src/analyzer_impl.dart';
+import 'package:analyzer_cli/src/analyzer_options.dart';
+import 'package:analyzer_cli/src/batch_mode.dart';
 import 'package:analyzer_cli/src/build_mode.dart';
 import 'package:analyzer_cli/src/error_formatter.dart';
 import 'package:analyzer_cli/src/error_severity.dart';
-import 'package:analyzer_cli/src/options.dart';
 import 'package:analyzer_cli/src/perf_report.dart';
 import 'package:analyzer_cli/starter.dart' show CommandLineStarter;
 import 'package:linter/src/rules.dart' as linter;
 import 'package:package_config/discovery.dart' as pkg_discovery;
 import 'package:package_config/packages.dart' show Packages;
 import 'package:package_config/packages_file.dart' as pkgfile show parse;
 import 'package:package_config/src/packages_impl.dart' show MapPackages;
 import 'package:path/path.dart' as path;
 import 'package:plugin/manager.dart';
 import 'package:plugin/plugin.dart';
 import 'package:yaml/yaml.dart';
 
 /// Shared IO sink for standard error reporting.
 ///
 /// *Visible for testing.*
 StringSink errorSink = io.stderr;
 
 /// Shared IO sink for standard out reporting.
 ///
 /// *Visible for testing.*
 StringSink outSink = io.stdout;
 
 /// Test this option map to see if it specifies lint rules.
 bool containsLintRuleEntry(Map<String, YamlNode> options) {
   var linterNode = options['linter'];
   return linterNode is YamlMap && linterNode.containsKey('rules');
 }
 
-typedef Future<ErrorSeverity> _BatchRunnerHandler(List<String> args);
-
 class Driver implements CommandLineStarter {
   static final PerformanceTag _analyzeAllTag =
       new PerformanceTag("Driver._analyzeAll");
 
   static ByteStore analysisDriverMemoryByteStore = new MemoryByteStore();
 
   /// The plugins that are defined outside the `analyzer_cli` package.
   List<Plugin> _userDefinedPlugins = <Plugin>[];
 
   /// The context that was most recently created by a call to [_analyzeAll], or
@@ skipping 49 matching lines @@
     CommandLineOptions options = CommandLineOptions.parse(args);
 
     // Do analysis.
     if (options.buildMode) {
       ErrorSeverity severity = _buildModeAnalyze(options);
       // In case of error propagate exit code.
       if (severity == ErrorSeverity.ERROR) {
         io.exitCode = severity.ordinal;
       }
     } else if (options.shouldBatch) {
-      _BatchRunner.runAsBatch(args, (List<String> args) async {
+      BatchRunner batchRunner = new BatchRunner(outSink, errorSink);
+      batchRunner.runAsBatch(args, (List<String> args) async {
         CommandLineOptions options = CommandLineOptions.parse(args);
         return await _analyzeAll(options);
       });
     } else {
       ErrorSeverity severity = await _analyzeAll(options);
       // In case of error propagate exit code.
       if (severity == ErrorSeverity.ERROR) {
         io.exitCode = severity.ordinal;
       }
     }
@@ skipping 694 matching lines @@
       }
     }
     return true;
   }
 
   /// Convert [sourcePath] into an absolute path.
   static String _normalizeSourcePath(String sourcePath) =>
       path.normalize(new io.File(sourcePath).absolute.path);
 }
 
-/// Provides a framework to read command line options from stdin and feed them
-/// to a callback.
-class _BatchRunner {
-  /// Run the tool in 'batch' mode, receiving command lines through stdin and
-  /// returning pass/fail status through stdout. This feature is intended for
-  /// use in unit testing.
-  static void runAsBatch(List<String> sharedArgs, _BatchRunnerHandler handler) {
-    outSink.writeln('>>> BATCH START');
-    Stopwatch stopwatch = new Stopwatch();
-    stopwatch.start();
-    int testsFailed = 0;
-    int totalTests = 0;
-    ErrorSeverity batchResult = ErrorSeverity.NONE;
-    // Read line from stdin.
-    Stream cmdLine =
-        io.stdin.transform(UTF8.decoder).transform(new LineSplitter());
-    cmdLine.listen((String line) async {
-      // Maybe finish.
-      if (line.isEmpty) {
-        var time = stopwatch.elapsedMilliseconds;
-        outSink.writeln(
-            '>>> BATCH END (${totalTests - testsFailed}/$totalTests) ${time}ms');
-        io.exitCode = batchResult.ordinal;
-      }
-      // Prepare arguments.
-      var lineArgs = line.split(new RegExp('\\s+'));
-      var args = new List<String>();
-      args.addAll(sharedArgs);
-      args.addAll(lineArgs);
-      args.remove('-b');
-      args.remove('--batch');
-      // Analyze single set of arguments.
-      try {
-        totalTests++;
-        ErrorSeverity result = await handler(args);
-        bool resultPass = result != ErrorSeverity.ERROR;
-        if (!resultPass) {
-          testsFailed++;
-        }
-        batchResult = batchResult.max(result);
-        // Write stderr end token and flush.
-        errorSink.writeln('>>> EOF STDERR');
-        String resultPassString = resultPass ? 'PASS' : 'FAIL';
-        outSink.writeln(
-            '>>> TEST $resultPassString ${stopwatch.elapsedMilliseconds}ms');
-      } catch (e, stackTrace) {
-        errorSink.writeln(e);
-        errorSink.writeln(stackTrace);
-        errorSink.writeln('>>> EOF STDERR');
-        outSink.writeln('>>> TEST CRASH');
-      }
-    });
-  }
-}
-
 class _DriverError implements Exception {
   String msg;
   _DriverError(this.msg);
 }
 
 class _PackageInfo {
   Packages packages;
   Map<String, List<file_system.Folder>> packageMap;
   _PackageInfo(this.packages, this.packageMap);
 }
@@ skipping 16 matching lines @@
     for (var package in packages) {
       var packageName = path.basename(package.path);
       var realPath = package.resolveSymbolicLinksSync();
       result[packageName] = [
         PhysicalResourceProvider.INSTANCE.getFolder(realPath)
       ];
     }
     return result;
   }
 }