Add dart analyzer test suite 'analyze_library' that fails if we

tools/testing/dart/test_suite.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.
 
 /**
  * Classes and methods for enumerating and preparing tests.
  *
  * This library includes:
  *
  * - Creating tests by listing all the Dart files in certain directories,
@@ skipping 797 matching lines @@
   /**
    * _createUrlPathFromFile takes a [file], which is either located in the dart
    * or in the build directory, and will return a String representing
    * the relative path to either the dart or the build directory.
    * Thus, the returned [String] will be the path component of the URL
    * corresponding to [file] (the http server serves files relative to the
    * dart/build directories).
    */
   String _createUrlPathFromFile(Path file) {
     file = TestUtils.absolutePath(file);
-    
+
     var relativeBuildDir = new Path(TestUtils.buildDir(configuration));
     var buildDir = TestUtils.absolutePath(relativeBuildDir);
     var dartDir = TestUtils.absolutePath(TestUtils.dartDir());
 
     var fileString = file.toString();
     if (fileString.startsWith(buildDir.toString())) {
       var fileRelativeToBuildDir = file.relativeTo(buildDir);
       return "/$PREFIX_BUILDDIR/$fileRelativeToBuildDir";
     } else if (fileString.startsWith(dartDir.toString())) {
       var fileRelativeToDartDir = file.relativeTo(dartDir);
@@ skipping 488 matching lines @@
    *   an image, if the expectation ends in .png. 'test.dart' will compare the
    *   snapshot to the expectation file. When tests fail, 'test.dart' saves the
    *   new snapshot into a file so it can be visualized or copied over.
    *   Expectations can be recorded for the first time by creating an empty file
    *   with the right name (touch test_name_test.png), running the test, and
    *   executing the copy command printed by the test script.
    *
    * This method is static as the map is cached and shared amongst
    * configurations, so it may not use [configuration].
    */
-  static Map readOptionsFromFile(Path filePath) {
+  Map readOptionsFromFile(Path filePath) {
     if (filePath.segments().contains('co19')) {
       return readOptionsFromCo19File(filePath);
     }
     RegExp testOptionsRegExp = new RegExp(r"// VMOptions=(.*)");
     RegExp dartOptionsRegExp = new RegExp(r"// DartOptions=(.*)");
     RegExp otherScriptsRegExp = new RegExp(r"// OtherScripts=(.*)");
     RegExp packageRootRegExp = new RegExp(r"// PackageRoot=(.*)");
     RegExp multiHtmlTestRegExp =
         new RegExp(r"useHtmlIndividualConfiguration()");
     RegExp staticTypeRegExp =
         new RegExp(r"/// ([0-9][0-9]:){0,1}\s*static type warning");
     RegExp compileTimeRegExp =
         new RegExp(r"/// ([0-9][0-9]:){0,1}\s*compile-time error");
     RegExp staticCleanRegExp = new RegExp(r"// @static-clean");
-    RegExp leadingHashRegExp = new RegExp(r"^#", multiLine: true);
     RegExp isolateStubsRegExp = new RegExp(r"// IsolateStubs=(.*)");
     // TODO(gram) Clean these up once the old directives are not supported.
     RegExp domImportRegExp =
         new RegExp(r"^[#]?import.*dart:html", multiLine: true);
     RegExp libraryDefinitionRegExp =
         new RegExp(r"^[#]?library[\( ]", multiLine: true);
     RegExp sourceOrImportRegExp =
         new RegExp("^(#source|#import|part)[ \t]+[\('\"]", multiLine: true);
 
     var bytes = new File.fromPath(filePath).readAsBytesSync();
@@ skipping 44 matching lines @@
     }
 
     List<String> otherScripts = new List<String>();
     matches = otherScriptsRegExp.allMatches(contents);
     for (var match in matches) {
       otherScripts.addAll(match[1].split(' ').where((e) => e != '').toList());
     }
 
     bool isMultitest = multiTestRegExp.hasMatch(contents);
     bool isMultiHtmlTest = multiHtmlTestRegExp.hasMatch(contents);
-    bool containsLeadingHash = leadingHashRegExp.hasMatch(contents);
     Match isolateMatch = isolateStubsRegExp.firstMatch(contents);
     String isolateStubs = isolateMatch != null ? isolateMatch[1] : '';
     bool containsDomImport = domImportRegExp.hasMatch(contents);
     bool isLibraryDefinition = libraryDefinitionRegExp.hasMatch(contents);
     bool containsSourceOrImport = sourceOrImportRegExp.hasMatch(contents);
     int numStaticTypeAnnotations = 0;
     for (var i in staticTypeRegExp.allMatches(contents)) {
       numStaticTypeAnnotations++;
     }
     int numCompileTimeAnnotations = 0;
@@ skipping 18 matching lines @@
     return { "vmOptions": result,
              "dartOptions": dartOptions,
              "packageRoot": packageRoot,
              "hasCompileError": false,
              "hasRuntimeError": false,
              "isStaticClean" : isStaticClean,
              "otherScripts": otherScripts,
              "isMultitest": isMultitest,
              "isMultiHtmlTest": isMultiHtmlTest,
              "subtestNames": subtestNames,
-             "containsLeadingHash": containsLeadingHash,
              "isolateStubs": isolateStubs,
              "containsDomImport": containsDomImport,
              "isLibraryDefinition": isLibraryDefinition,
              "containsSourceOrImport": containsSourceOrImport,
              "numStaticTypeAnnotations": numStaticTypeAnnotations,
              "numCompileTimeAnnotations": numCompileTimeAnnotations };
   }
 
   List<List<String>> getVmOptions(Map optionsFromFile) {
     var COMPILERS = const ['none', 'dart2dart'];
@@ skipping 16 matching lines @@
    * co19 is developed based on a contract which defines certain test
    * tags. These tags may appear unused, but should not be removed
    * without consulting with the co19 team.
    *
    * Also, [readOptionsFromFile] recognizes a number of additional
    * tags that are not appropriate for use in general tests of
    * conformance to the Dart language. Any Dart implementation must
    * pass the co19 test suite as is, and not require extra flags,
    * environment variables, configuration files, etc.
    */
-  static Map readOptionsFromCo19File(Path filePath) {
+  Map readOptionsFromCo19File(Path filePath) {
     String contents = decodeUtf8(new File.fromPath(filePath).readAsBytesSync());
 
     bool hasCompileError = contents.contains("@compile-error");
     bool hasRuntimeError = contents.contains("@runtime-error");
     bool hasDynamicTypeError = contents.contains("@dynamic-type-error");
     bool hasStaticWarning = contents.contains("@static-warning");
     bool isMultitest = multiTestRegExp.hasMatch(contents);
 
     if (hasDynamicTypeError) {
       // TODO(ahe): Remove this warning when co19 no longer uses this tag.
@@ skipping 13 matching lines @@
       "vmOptions": <List>[[]],
       "dartOptions": null,
       "packageRoot": null,
       "hasCompileError": hasCompileError,
       "hasRuntimeError": hasRuntimeError,
       "isStaticClean" : !hasStaticWarning,
       "otherScripts": <String>[],
       "isMultitest": isMultitest,
       "isMultiHtmlTest": false,
       "subtestNames": <String>[],
-      "containsLeadingHash": false,
       "isolateStubs": '',
       "containsDomImport": false,
       "isLibraryDefinition": false,
       "containsSourceOrImport": false,
       "numStaticTypeAnnotations": 0,
       "numCompileTimeAnnotations": 0,
     };
   }
 }
 
 
+/// A DartcCompilationTestSuite will run dartc on all of the tests.
+///
+/// Usually, the result of a dartc run is determined by the output of
+/// dartc in connection with annotations in the test file.
+///
+/// If you want each file that you are running as a test to have no
+/// static warnings or errors you can create a DartcCompilationTestSuite
+/// with the optional allStaticClean constructor parameter set to true.
 class DartcCompilationTestSuite extends StandardTestSuite {
   List<String> _testDirs;
+  bool allStaticClean;
 
   DartcCompilationTestSuite(Map configuration,
                             String suiteName,
                             String directoryPath,
                             List<String> this._testDirs,
-                            List<String> expectations)
+                            List<String> expectations,
+                            {bool this.allStaticClean: false})

[ricow1, 2013/03/06 14:23:25]

we don't have to have this as a constructor parameter, we could just set it in
the constructor of the specialized AnalyzeLibraryTestSuite 

[Mads Ager (google), 2013/03/06 14:26:42]

That is true. I like having it as a constructor parameter so  it is set in the
class that uses it.

       : super(configuration,
               suiteName,
               new Path(directoryPath),
               expectations);
 
   List<String> additionalOptions(Path filePath) {
     return ['--fatal-warnings', '--fatal-type-errors'];
   }
 
   Future enqueueTests() {
     var group = new FutureGroup();
 
     for (String testDir in _testDirs) {
       Directory dir = new Directory.fromPath(suiteDir.append(testDir));
       if (dir.existsSync()) {
         enqueueDirectory(dir, group);
       }
     }
 
     return group.future;
   }
+
+  Map readOptionsFromFile(Path p) {
+    Map options = super.readOptionsFromFile(p);
+    if (allStaticClean) {
+      options['isStaticClean'] = true;
+    }
+    return options;
+  }
 }
 
 
 class JUnitTestSuite extends TestSuite {
   String directoryPath;
   String statusFilePath;
   final String dartDir;
   String classPath;
   List<String> testClasses;
   TestCaseEvent doTest;
@@ skipping 370 matching lines @@
  * $pass tests are expected to pass
  * $failOk tests are expected to fail that we won't fix
  * $fail tests are expected to fail that we should fix
  * $crash tests are expected to crash that we should fix
  * $timeout tests are allowed to timeout
  * $compileErrorSkip tests are skipped on browsers due to compile-time error
 """;
     print(report);
    }
 }