Allow tests to specify a package root.

dart/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 87 matching lines @@
  */
 abstract class TestSuite {
   final Map configuration;
   final String suiteName;
 
   TestSuite(this.configuration, this.suiteName);
 
   /**
    * The output directory for this suite's configuration.
    */
-  String get buildDir {
-    var mode = (configuration['mode'] == 'debug') ? 'Debug' : 'Release';
-    var arch = configuration['arch'].toUpperCase();
-    return "${TestUtils.outputDir(configuration)}$mode$arch";
-  }
+  String get buildDir => TestUtils.buildDir(configuration);
 
   /**
    * The path to the compiler for this suite's configuration. Returns `null` if
    * no compiler should be used.
    */
   String get compilerPath {
     if (configuration['compiler'] == 'none') {
       return null;  // No separate compiler for dartium tests.
     }
     var name = '$buildDir/${compilerName}';
@@ skipping 803 matching lines @@
             args.add('--executable=$dartiumFilename');
           }
         } else {
           args = [
               dartDir.append('tools/testing/drt-trampoline.py').toNativePath(),
               dumpRenderTreeFilename,
               '--no-timeout'
           ];
           if (runtime == 'drt' &&
               (compiler == 'none' || compiler == 'dart2dart')) {
-            var dartFlags = ['--ignore-unrecognized-flags'];
+            // TODO(ahe): DO NOT SUBMIT, DumpRenderTree hangs on package: imports.

[ahe, 2012/11/16 07:29:09]

I have since learned that I should use an environment variable instead
DART_PACKAGE_ROOT.  It is a little bit tricky as the environment variable
depends on the configuration, so we have to pass it through to
drt-trampoline.py, rather than just setting it globally.

+            var dartFlags = ['--ignore-unrecognized-flags', '--package-root=$buildDir/packages/'];
             if (configuration["checked"]) {
               dartFlags.add('--enable_asserts');
               dartFlags.add("--enable_type_checks");
             }
             dartFlags.addAll(vmOptions);
             args.add('--dart-flags=${Strings.join(dartFlags, " ")}');
           }
           args.add(fullHtmlPath);
           if (expectedOutput != null) {
             args.add('--out-expectation=${expectedOutput.toNativePath()}');
@@ skipping 142 matching lines @@
                             'MacOS/Chromium').toNativePath();
     }
     return dartDir.append('client/tests/dartium/chrome').toNativePath();
   }
 
   void completeHandler(TestCase testCase) {
   }
 
   List<String> commonArgumentsFromFile(Path filePath, Map optionsFromFile) {
     List args = TestUtils.standardOptions(configuration);
+
+    String packageRoot = optionsFromFile['packageRoot'];
+    if (packageRoot == null) {
+      packageRoot = "$buildDir/packages/";
+    } else if (packageRoot == "none") {
+      // Do not pass --packageRoot option.
+      packageRoot = null;
+    }
+    if (packageRoot != null) {
+      args.add("--package-root=$packageRoot");
+    }
+
     args.addAll(additionalOptions(filePath));
     if (configuration['compiler'] == 'dartc') {
       args.add('--error_format');
       args.add('machine');
     }
 
     bool isMultitest = optionsFromFile["isMultitest"];
     List<String> dartOptions = optionsFromFile["dartOptions"];
     List<List<String>> vmOptionsList = getVmOptions(optionsFromFile);
     Expect.isTrue(!isMultitest || dartOptions == null);
@@ skipping 67 matching lines @@
    *   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) {
     RegExp testOptionsRegExp = const RegExp(r"// VMOptions=(.*)");
     RegExp dartOptionsRegExp = const RegExp(r"// DartOptions=(.*)");
     RegExp otherScriptsRegExp = const RegExp(r"// OtherScripts=(.*)");
+    RegExp packageRootRegExp = const RegExp(r"// PackageRoot=(.*)");
     RegExp multiTestRegExp = const RegExp(r"/// [0-9][0-9]:(.*)");
     RegExp multiHtmlTestRegExp =
         const RegExp(r"useHtmlIndividualConfiguration()");
     RegExp staticTypeRegExp =
         const RegExp(r"/// ([0-9][0-9]:){0,1}\s*static type warning");
     RegExp compileTimeRegExp =
         const RegExp(r"/// ([0-9][0-9]:){0,1}\s*compile-time error");
     RegExp staticCleanRegExp = const RegExp(r"// @static-clean");
     RegExp leadingHashRegExp = const RegExp(r"^#", multiLine: true);
     RegExp isolateStubsRegExp = const RegExp(r"// IsolateStubs=(.*)");
@@ skipping 14 matching lines @@
     while (offset != chars.length) {
       offset += file.readListSync(chars, offset, chars.length - offset);
     }
     file.closeSync();
     String contents = new String.fromCharCodes(chars);
     chars = null;
 
     // Find the options in the file.
     List<List> result = new List<List>();
     List<String> dartOptions;
+    String packageRoot;
     bool hasCompileError = contents.contains("@compile-error");
     bool hasRuntimeError = contents.contains("@runtime-error");
     bool isStaticClean = false;
 
     Iterable<Match> matches = testOptionsRegExp.allMatches(contents);
     for (var match in matches) {
       result.add(match[1].split(' ').filter((e) => e != ''));
     }
     if (result.isEmpty) result.add([]);
 
     matches = dartOptionsRegExp.allMatches(contents);
     for (var match in matches) {
       if (dartOptions != null) {
         throw new Exception(
             'More than one "// DartOptions=" line in test $filePath');
       }
       dartOptions = match[1].split(' ').filter((e) => e != '');
     }
 
+    matches = packageRootRegExp.allMatches(contents);
+    for (var match in matches) {
+      if (packageRoot != null) {
+        throw new Exception(
+            'More than one "// PackageRoot=" line in test $filePath');
+      }
+      packageRoot = match[1];
+    }
+
     matches = staticCleanRegExp.allMatches(contents);
     for (var match in matches) {
       if (isStaticClean) {
         throw new Exception(
             'More than one "// @static-clean=" line in test $filePath');
       }
       isStaticClean = true;
     }
 
     List<String> otherScripts = new List<String>();
@@ skipping 28 matching lines @@
     RegExp numTests = new RegExp(r"\s*[^/]\s*group\('[^,']*");
     List<String> subtestNames = [];
     Iterator matchesIter = numTests.allMatches(contents).iterator();
     while(matchesIter.hasNext && isMultiHtmlTest) {
       String fullMatch = matchesIter.next().group(0);
       subtestNames.add(fullMatch.substring(fullMatch.indexOf("'") + 1));
     }
 
     return { "vmOptions": result,
              "dartOptions": dartOptions,
+             "packageRoot": packageRoot,
              "hasCompileError": hasCompileError,
              "hasRuntimeError": hasRuntimeError,
              "isStaticClean" : isStaticClean,
              "otherScripts": otherScripts,
              "isMultitest": isMultitest,
              "isMultiHtmlTest": isMultiHtmlTest,
              "subtestNames": subtestNames,
              "containsLeadingHash": containsLeadingHash,
              "isolateStubs": isolateStubs,
              "containsDomImport": containsDomImport,
@@ skipping 274 matching lines @@
     ];
     return BROWSERS.contains(runtime);
   }
 
   static bool isBrowserRuntime(String runtime) =>
       runtime == 'drt' || TestUtils.usesWebDriver(runtime);
 
   static bool isJsCommandLineRuntime(String runtime) =>
       const ['d8', 'jsshell'].contains(runtime);
 
+  static String buildDir(Map configuration) {
+    var mode = (configuration['mode'] == 'debug') ? 'Debug' : 'Release';
+    var arch = configuration['arch'].toUpperCase();
+    return "${TestUtils.outputDir(configuration)}$mode$arch";
+  }
 }
 
 class SummaryReport {
   static int total = 0;
   static int skipped = 0;
   static int noCrash = 0;
   static int pass = 0;
   static int failOk = 0;
   static int fail = 0;
   static int crash = 0;
@@ skipping 40 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);
    }
 }