Enable use of #import stmts containing relative paths in Dart multitests

tools/testing/dart/multitest.dart

 // Copyright (c) 2011, 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("multitest");
 
 #import("dart:io");
 
 // Multitests are Dart test scripts containing lines of the form
 // " [some dart code] /// [key]: [error type]"
@@ skipping 59 matching lines @@
   Set<String> validMultitestOutcomes = new Set<String>.from(
       ['compile-time error', 'runtime error',
        'static type error', 'dynamic type error', '']);
 
   List<String> testTemplate = new List<String>();
   testTemplate.add('// Test created from multitest named $filename.');
   // Create the set of multitests, which will have a new test added each
   // time we see a multitest line with a new key.
   Map<String, List<String>> testsAsLines = new Map<String, List<String>>();
 
-  // Matches #import( or #source( followed by " or ' followed by anything
-  // except dart: or /, at the beginning of a line.
-  RegExp relativeImportRegExp =
-      const RegExp('^#(import|source)[(]["\'](?!(dart:|/))');
   int lineCount = 0;
   for (String line in lines) {
     lineCount++;
     if (line.contains('///')) {
       var parts = line.split('///')[1].split(':');
       var key = parts[0].trim();
       var rest = parts[1].trim();
       if (testsAsLines.containsKey(key)) {
         Expect.equals('continued', rest);
         testsAsLines[key].add(line);
       } else {
         (testsAsLines[key] = new List<String>.from(testTemplate)).add(line);
         outcomes[key] = rest;
         if (!validMultitestOutcomes.contains(rest)) {
           Expect.fail("Invalid test directive on line ${lineCount}: $rest ");
         }
       }
     } else {
       testTemplate.add(line);
       for (var test in testsAsLines.getValues()) test.add(line);
     }
-    // Warn if any import or source tags have relative paths.
-    if (relativeImportRegExp.hasMatch(line)) {
-      print('Warning: Multitest cannot contain relative imports:');
-      print('    $filename: $line');
-    }
   }
   // Add the template, with no multitest lines, as a test with key 'none'.
   testsAsLines['none'] = testTemplate;
   outcomes['none'] = '';
 
   // Copy all the tests into the output map tests, as multiline strings.
   for (String key in testsAsLines.getKeys()) {
     tests[key] =
         Strings.join(testsAsLines[key], line_separator) + line_separator;
   }
 }
 
+void _copyFile(File source, File dest) {

[zundel, 2012/03/01 06:06:58]

is there already a canned way to do this somewhere else?  

[Bill Hesse, 2012/03/01 15:01:52]

Not that I know of, except by calling the shell.

[zundel, 2012/03/01 18:06:01]

Moved to TestUtils class.

+  List contents = source.readAsBytesSync();
+  RandomAccessFile handle = dest.openSync(FileMode.WRITE);

[Bill Hesse, 2012/03/01 15:01:52]

This will not work except for files in the same directory.  Subdirectories and
'../sibling_dir' will not work unless every directory on the path exists. 
Either check that the target directory exists, and print error if it doesn't, or
don't allow non-trivial paths, or create the necessary directories.  We have
client tests (samples) with relative paths, that work because the relative path
points to the same place from source and dest.  Also, make sure we are not
overwriting sensitive stuff, I suppose.

[zundel, 2012/03/01 18:06:01]

the generated test files don't go away between tests,I assume they are fair game
to be clobbered, so I'm not testing for file existence.  I did add a filter to
disallow any '..' in the relative paths. If someone really needs that they can
just take out the check.

Created the dirs TestUtils.mkdirRecursive()

+  handle.writeListSync(contents, 0, contents.length);
+  handle.closeSync();
+}
+
+// Find all relative imports and copy them into the dir that contains
+// the generated tests.
+Set<String> _findAllRelativeImports(String topLibrary) {
+  Set<String> toSearch = new Set<String>.from([topLibrary]);
+  Set<String> foundImports = new HashSet<String>();
+  String pathSep = new Platform().pathSeparator();

[Bill Hesse, 2012/03/01 15:01:52]

Rather than use pathSeparator, I would use "/" everywhere.  If there is a chance
that topLibrary comes in using "\", then replace all the "\" with "/" there. 
This makes things easier, I think.

[zundel, 2012/03/01 18:06:01]

Done.

+  int end = topLibrary.lastIndexOf(pathSep);
+  String libraryDir = topLibrary.substring(0, end);
+
+  // Matches #import( or #source( followed by " or ' followed by anything
+  // except dart: or /, at the beginning of a line.
+  RegExp relativeImportRegExp1 =
+      const RegExp('^#(import|source)[(]["\'](?!(dart:|/))');
+  // Like the above, but captures the path in the import
+  RegExp relativeImportRegExp2 =
+      const RegExp('^#(import|source)[(]["\']([^"\']*)["\']');
+  while (!toSearch.isEmpty()) {
+    var thisPass = toSearch;
+    toSearch = new HashSet<String>();
+    for (String filename in thisPass) {
+      File f = new File(filename);
+      for (String line in f.readAsLinesSync()) {
+        if (relativeImportRegExp1.hasMatch(line)) {

[Bill Hesse, 2012/03/01 15:01:52]

I think you can combine the two regexp to 
 '........[(]["\'](?!(dart:|/))([^"\']*)["\']',
since the (?!...) is non-capturing (?).  Then m = .firstMatch
if (m != null) ....

[zundel, 2012/03/01 18:06:01]

i've never used the non-capturing before, but it does seem to take up a group
position:

RegExp relativeImportRegExp =
      const RegExp('^#(import|source)[(]["\'](?!(dart:|/))([^"\']*)["\']');

 Match match = relativeImportRegExp.firstMatch(line); 
        if (match != null) {
          print ("group count is ${match.groupCount()}");
          print ("${match.group(1)}");
          print ("${match.group(2)}");
          print ("${match.group(3)}");

group count is 3
import

dummy/library11.dart

Is that what you would have expected (group 2 is empty string)?

+          // remember relative import so we can copy it later
+          Match match = relativeImportRegExp2.firstMatch(line);
+          String relativePath = match.group(2);
+          if (foundImports.contains(relativePath)) {
+            continue;
+          }
+          foundImports.add(relativePath);
+          toSearch.add('$libraryDir$pathSep$relativePath');
+        }
+      }
+    }
+  }
+  return foundImports;
+}
 
 void DoMultitest(String filename,
                  String outputDir,
                  String testDir,
                  Function doTest(String filename,
                                  bool isNegative,
                                  [bool isNegativeIfChecked,
                                   bool hasFatalTypeErrors,
                                   bool hasRuntimeErrors]),
                  Function multitestDone) {
   // Each new test is a single String value in the Map tests.
   Map<String, String> tests = new Map<String, String>();
   Map<String, String> outcomes = new Map<String, String>();
+  Set<String> importsToCopy = new Set<String>();

[Bill Hesse, 2012/03/01 15:01:52]

This initializer is overwritten - can be omitted.

[zundel, 2012/03/01 18:06:01]

Done.

   ExtractTestsFromMultitest(filename, tests, outcomes);
 
-  String directory = CreateMultitestDirectory(outputDir, testDir);
-  String pathSeparator = new Platform().pathSeparator();
-  int start = filename.lastIndexOf(pathSeparator) + 1;
+  String directory = CreateMultitestDirectory(outputDir,  testDir);

[Bill Hesse, 2012/03/01 15:01:52]

extra space before testDir?

[zundel, 2012/03/01 18:06:01]

Done.

+  Expect.isNotNull(directory);
+  String pathSep = new Platform().pathSeparator();
+  int start = filename.lastIndexOf(pathSep) + 1;
   int end = filename.indexOf('.dart', start);
   String baseFilename = filename.substring(start, end);
+  String sourceDirectory = filename.substring(0, start - 1);
+  importsToCopy = _findAllRelativeImports(filename);
+  for (String import in importsToCopy) {
+    File source = new File('$sourceDirectory$pathSep$import');

[Bill Hesse, 2012/03/01 15:01:52]

Again, no need for $pathSep.  "/" works on all platforms.

[zundel, 2012/03/01 18:06:01]

Done.

+    // assumes no subdirs
+    var dest = new File('$directory$pathSep$import');
+    _copyFile(source, dest);
+  }
   for (String key in tests.getKeys()) {
     final String filename = '$directory/${baseFilename}_$key.dart';
     final File file = new File(filename);
 
     file.createSync();
     RandomAccessFile openedFile = file.openSync(FileMode.WRITE);
     var bytes = tests[key].charCodes();
     openedFile.writeListSync(bytes, 0, bytes.length);
     openedFile.closeSync();
     var outcome = outcomes[key];
@@ skipping 24 matching lines @@
   var split = testDir.split('/');
   var lastComponent = split.removeLast();
   Expect.isTrue(lastComponent == 'src');
   String path = '${generatedTestDir.path}/${split.last()}';
   Directory dir = new Directory(path);
   if (!dir.existsSync()) {
     dir.createSync();
   }
   return path;
 }