test.dart: add support for compiling multiple scripts for a single test.

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 117 matching lines @@
       }
 
       if (expectations.contains(SKIP)) return;
 
       // The cc test runner takes options after the name of the test
       // to run.
       var args = [testName];
       args.addAll(TestUtils.standardOptions(configuration));
 
       doTest(new TestCase('$suiteName/$testName',
-                          runnerPath,
-                          args,
+                          [new Command(runnerPath, args)],
                           configuration,
                           completeHandler,
                           expectations));
     }
   }
 
   void forEachTest(Function onTest, Map testCache, String globalTempDir(),
                    [Function onDone]) {
     doTest = onTest;
     doDone = (ignore) => (onDone != null) ? onDone() : null;
@@ skipping 206 matching lines @@
             isNegative = false;
           }
         }
 
         var argumentLists = argumentListsFromFile(filename,
                                                   optionsFromFile,
                                                   enableFatalTypeErrors);
 
         for (var args in argumentLists) {
           doTest(new TestCase('$suiteName/$testName',
-                              shellPath(),
-                              args,
+                              [new Command(shellPath(), args)],
                               configuration,
                               completeHandler,
                               expectations,
                               isNegative));
         }
     }
   }
 
   Function makeTestCaseCreator(Map optionsFromFile) {
     return (String filename,
@@ skipping 129 matching lines @@
         // with 'C:' adding 'file:///' solves the problem.
         filePrefix = 'file:///';
       }
       htmlTest.writeStringSync(GetHtmlContents(
           filename,
           '$filePrefix$dartDir/client/testing/unittest/test_controller.js',
           scriptType,
           filePrefix + scriptPath));
       htmlTest.closeSync();
 
-      List<String> compilerArgs = TestUtils.standardOptions(configuration);
-      String compilerExecutable = TestUtils.compilerPath(configuration);
-      switch (component) {
-        case 'chromium':
-          compilerArgs.addAll(['--work', tempDir.path]);
-          compilerArgs.addAll(vmOptions);
-          compilerArgs.add('--ignore-unrecognized-flags');
-          // TODO(zundel): remove assumption of generated code from dartc
-          compilerArgs.add('--out');
-          compilerArgs.add(compiledDartWrapperFilename);
-          compilerArgs.add(dartWrapperFilename);
-          // TODO(whesse): Add --fatal-type-errors if needed.
-          break;
-        case 'frogium':
-        case 'webdriver':
-          String libdir = configuration['froglib'];
-          if (libdir == '') {
-            libdir = '$dartDir/frog/lib';
-          }
-          compilerArgs.addAll(['--libdir=$libdir',
-                               '--compile-only',
-                               '--out=$compiledDartWrapperFilename']);
-          compilerArgs.addAll(vmOptions);
-          compilerArgs.add(dartWrapperFilename);
-          break;
-        case 'dartium':
-          // No compilation phase.
-          compilerExecutable = null;
-          compilerArgs = null;
-          break;
-        default:
-          Expect.fail('unimplemented component $component');
+      // Construct the command(s) that compile all the inputs needed by the
+      // browser test. For dartium, this will be noop commands.
+      List<Command> commands = [_compileCommand(
+          dartWrapperFilename, compiledDartWrapperFilename,
+          component, tempDir.path, vmOptions)];
+
+      // some tests require compiling multiple input scripts.
+      List<String> otherScripts = optionsFromFile['otherScripts'];
+      for (String name in otherScripts) {
+        int end = filename.lastIndexOf('/');
+        Expect.isTrue(end > 0);

[Bill Hesse, 2012/02/28 16:41:56]

Could we print a warning, and just return without adding a testCase, in this
case, rather than terminating the test script?

[Siggi Cherem (dart-lang), 2012/02/28 17:42:37]

Good point. Fixed.

+        String dir = filename.substring(0, end);
+        end = name.lastIndexOf('.dart');
+        Expect.isTrue(end > 0);
+        String compiledName = '${name.substring(0, end)}.js';
+        commands.add(_compileCommand(
+            '$dir/$name', '${tempDir.path}/$compiledName',
+            component, tempDir.path, vmOptions));
       }
 
+      // Construct the command that executes the browser test
       List<String> args;
       if (component == 'webdriver') {
         args = ['$dartDir/tools/testing/run_selenium.py',
             '--browser=${configuration["browser"]}',
             '--timeout=${configuration["timeout"] - 2}',
             '--out=$htmlPath'];
       } else {
         args = [
             '$dartDir/tools/testing/drt-trampoline.py',
             dumpRenderTreeFilename,
             '--no-timeout'
         ];
         if (component == 'dartium') {
           var dartFlags = ['--ignore-unrecognized-flags'];
           if (configuration["checked"]) {
             dartFlags.add('--enable_asserts');
             dartFlags.add("--enable_type_checks");
           }
           dartFlags.addAll(vmOptions);
           args.add('--dart-flags=${Strings.join(dartFlags, " ")}');
         }
         args.add(htmlPath);
       }
+      commands.add(new Command('python', args));
+
       // Create BrowserTestCase and queue it.
-      var testCase = new BrowserTestCase(
-          testName,
-          compilerExecutable,
-          compilerArgs,
-          'python',
-          args,
-          configuration,
-          completeHandler,
-          expectations,
-          optionsFromFile['isNegative']);
+      var testCase = new BrowserTestCase(testName, commands, configuration,
+          completeHandler, expectations, optionsFromFile['isNegative']);
       doTest(testCase);
     }
   }
 
+  /** Helper to create a compilation command for a single input file. */
+  Command _compileCommand(String inputFile, String outputFile,
+      String component, String dir, var vmOptions) {
+    String executable = TestUtils.compilerPath(configuration);
+    List<String> args = TestUtils.standardOptions(configuration);
+    switch (component) {
+      case 'chromium':
+        args.addAll(['--work', dir]);
+        args.addAll(vmOptions);
+        args.add('--ignore-unrecognized-flags');
+        // TODO(zundel): remove assumption of generated code from dartc
+        args.add('--out');
+        args.add(outputFile);
+        args.add(inputFile);
+        // TODO(whesse): Add --fatal-type-errors if needed.
+        break;
+      case 'frogium':
+      case 'webdriver':
+        String libdir = configuration['froglib'];
+        if (libdir == '') {
+          libdir = '$dartDir/frog/lib';
+        }
+        args.addAll(['--libdir=$libdir',
+                             '--compile-only',
+                             '--out=$outputFile']);
+        args.addAll(vmOptions);
+        args.add(inputFile);
+        break;
+      case 'dartium':
+        // No compilation phase.
+        args = null;
+        break;
+      default:
+        Expect.fail('unimplemented component $component');
+    }
+    return new Command(executable, args);
+  }
+
   bool get requiresCleanTemporaryDirectory() =>
       configuration['component'] == 'dartc' ||
       configuration['component'] == 'chromium';
 
   /**
    * Create a directory for the generated test.  If a Dart language test
    * needs to be run in a browser, the Dart test needs to be embedded in
    * an HTML page, with a testing framework based on scripting and DOM events.
    * These scripts and pages are written to a generated_test directory,
    * usually inside the build directory of the checkout.
@@ skipping 145 matching lines @@
       options.addAll(args);
       result.add(options);
     }
 
     return result;
   }
 
   Map optionsFromFile(String filename) {
     RegExp testOptionsRegExp = const RegExp(@"// VMOptions=(.*)");
     RegExp dartOptionsRegExp = const RegExp(@"// DartOptions=(.*)");
+    RegExp otherScriptsRegExp = const RegExp(@"// OtherScripts=(.*)");
     RegExp multiTestRegExp = const RegExp(@"/// [0-9][0-9]:(.*)");
     RegExp leadingHashRegExp = const RegExp(@"^#", multiLine: true);
     RegExp isolateStubsRegExp = const RegExp(@"// IsolateStubs=(.*)");
     RegExp domImportRegExp =
         const RegExp(@"^#import.*(dart:(dom|html)|html\.dart).*\)",
                      multiLine: true);
     RegExp libraryDefinitionRegExp =
         const RegExp(@"^#library\(", multiLine: true);
     RegExp sourceOrImportRegExp =
         const RegExp(@"^#(source|import)\(", multiLine: true);
@@ skipping 24 matching lines @@
 
     matches = dartOptionsRegExp.allMatches(contents);
     for (var match in matches) {
       if (dartOptions != null) {
         throw new Exception(
             'More than one "// DartOptions=" line in test $filename');
       }
       dartOptions = match[1].split(' ').filter((e) => e != '');
     }
 
+    List<String> otherScripts = new List<String>();
+    matches = otherScriptsRegExp.allMatches(contents);
+    for (var match in matches) {
+      otherScripts.addAll(match[1].split(' ').filter((e) => e != ''));
+    }
+
     if (contents.contains("@compile-error") ||
         contents.contains("@runtime-error")) {
       isNegative = true;
     }
 
     bool isMultitest = multiTestRegExp.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);
 
 
     return { "vmOptions": result,
              "dartOptions": dartOptions,
              "isNegative": isNegative,
+             "otherScripts": otherScripts,
              "isMultitest": isMultitest,
              "containsLeadingHash" : containsLeadingHash,
              "isolateStubs" : isolateStubs,
              "containsDomImport": containsDomImport,
              "isLibraryDefinition": isLibraryDefinition,
              "containsSourceOrImport": containsSourceOrImport };
   }
 }
 
 
@@ skipping 131 matching lines @@
     List<String> args = <String>[
         '-ea',
         '-classpath', classPath,
         '-Dcom.google.dart.runner.d8=$d8',
         '-Dcom.google.dart.corelib.SharedTests.test_py=' +
             dartDir + '/tools/test.py',
         'org.junit.runner.JUnitCore'];
     args.addAll(testClasses);
 
     doTest(new TestCase(suiteName,
-                        'java',
-                        args,
+                        [new Command('java', args)],
                         configuration,
                         completeHandler,
                         new Set<String>.from([PASS])));
     doDone();
   }
 
   void completeHandler(TestCase testCase) {
   }
 
   void computeClassPath() {
@@ skipping 164 matching lines @@
  * $noCrash tests are expected to be flaky but not crash
  * $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
 """;
     print(report);
    }
 }