Refactor the pub tests.

utils/tests/pub/test_pub.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.
 
 /**
  * Test infrastructure for testing pub. Unlike typical unit tests, most pub
  * tests are integration tests that stage some stuff on the file system, run
  * pub, and then validate the results. This library provides an API to build
  * tests like that.
  */
@@ skipping 10 matching lines @@
  */
 FileDescriptor file(String name, String contents) =>
     new FileDescriptor(name, contents);
 
 /**
  * Creates a new [DirectoryDescriptor] with [name] and [contents].
  */
 DirectoryDescriptor dir(String name, [List<Descriptor> contents]) =>
     new DirectoryDescriptor(name, contents);
 
-void testPub(String description, [List<Descriptor> cache, Descriptor app,
-    List<String> args, List<Descriptor> expectedPackageDir,
-    List<Descriptor> sdk, String output, int exitCode = 0]) {
-  asyncTest(description, 1, () {
-    var createdSandboxDir;
-    var createdAppDir;
-    var createdSdkDir;
+/**
+ * The path of the package cache directory used for tests. Relative to the
+ * sandbox directory.
+ */
+final String cachePath = "cache";
 
-    deleteSandboxIfCreated() {
-      if (createdSandboxDir != null) {
-        deleteDir(createdSandboxDir).then((_) {
-          callbackDone();
-        });
-      } else {
-        callbackDone();
-      }
+/**
+ * The path of the mock SDK directory used for tests. Relative to the sandbox
+ * directory.
+ */
+final String sdkPath = "sdk";
+
+/**
+ * The path of the mock app directory used for tests. Relative to the sandbox
+ * directory.
+ */
+final String appPath = "myapp";
+
+/**
+ * The path of the packages directory in the mock app used for tests. Relative
+ * to the sandbox directory.
+ */
+final String packagesPath = "$appPath/packages";
+
+/**
+ * The type for callbacks that will be fired during [runPub]. Takes the sandbox
+ * directory as a parameter.
+ */
+typedef Future _ScheduledEvent(Directory parentDir);
+
+/**
+ * The list of events that are scheduled to run after the sandbox directory has
+ * been created but before Pub is run.
+ */
+List<_ScheduledEvent> _scheduledBeforePub;
+
+/**
+ * The list of events that are scheduled to run after Pub has been run.
+ */
+List<_ScheduledEvent> _scheduledAfterPub;
+
+void runPub([List<String> args, String output, int exitCode = 0]) {
+  var createdSandboxDir;
+
+  var asyncDone = expectAsync0(() {});
+
+  deleteSandboxIfCreated(onDeleted()) {
+    _scheduledBeforePub = [];
+    _scheduledAfterPub = [];

[Bob Nystrom, 2012/05/10 20:15:10]

I would set these to null instead of an empty list here since schedule() checks
for that case and that's what they'll be on the first test.

[nweiz, 2012/05/10 21:01:09]

Done.

+    if (createdSandboxDir != null) {
+      deleteDir(createdSandboxDir).then((_) => onDeleted());
+    } else {
+      onDeleted();
     }
+  }
 
-    final future = _setUpSandbox().chain((sandboxDir) {
-      createdSandboxDir = sandboxDir;
-      return _setUpApp(sandboxDir, app);
-    }).chain((appDir) {
-      createdAppDir = appDir;
-      return _setUpSdk(createdSandboxDir, sdk);
-    }).chain((sdkDir) {
-      createdSdkDir = sdkDir;
-      return _setUpCache(createdSandboxDir, cache);
-    }).chain((cacheDir) {
-      var workingDir;
-      if (createdAppDir != null) workingDir = createdAppDir.path;
+  String pathInSandbox(path) => join(getFullPath(createdSandboxDir), path);
 
-      if (cacheDir != null) {
-        // TODO(rnystrom): Hack in the cache directory path. Should pass this
-        // in using environment var once #752 is done.
-        args.add('--cachedir=${getFullPath(cacheDir)}');
-      }
+  Future runScheduled(List<_ScheduledEvent> scheduled) {

[Bob Nystrom, 2012/05/10 20:15:10]

I would break this out into a (private) top-level function and pass in the
sandboxDir. The containing function is pretty big as it is.

[nweiz, 2012/05/10 21:01:09]

Done.

+    if (scheduled == null) return new Future.immediate(null);
+    var future = Futures.wait(
+        scheduled.map((event) => event(createdSandboxDir)));
+    scheduled.clear();
+    return future;
+  }
 
-      if (createdSdkDir != null) {
-        // TODO(rnystrom): Hack in the SDK path. Should pass this in using
-        // environment var once #752 is done.
-        args.add('--sdkdir=${getFullPath(createdSdkDir)}');
-      }
+  final future = _setUpSandbox().chain((sandboxDir) {
+    createdSandboxDir = sandboxDir;
+    return runScheduled(_scheduledBeforePub);
+  }).chain((_) {
+    return ensureDir(pathInSandbox(appPath));
+  }).chain((_) {
+    // TODO(rnystrom): Hack in the cache directory path. Should pass this
+    // in using environment var once #752 is done.
+    args.add('--cachedir=${pathInSandbox(cachePath)}');
 
-      return _runPub(args, workingDir);
-    }).chain((result) {
-      _validateOutput(output, result.stdout);
+    // TODO(rnystrom): Hack in the SDK path. Should pass this in using
+    // environment var once #752 is done.
+    args.add('--sdkdir=${pathInSandbox(sdkPath)}');
 
-      Expect.equals(result.stderr.length, 0,
-          'Did not expect any output on stderr, and got:\n' +
-          Strings.join(result.stderr, '\n'));
+    return _runPub(args, pathInSandbox(appPath));
+  }).chain((result) {
+    _validateOutput(output, result.stdout);
 
-      Expect.equals(result.exitCode, exitCode,
-          'Pub returned exit code ${result.exitCode}, expected $exitCode.');
+    Expect.equals(result.stderr.length, 0,
+        'Did not expect any output on stderr, and got:\n' +
+        Strings.join(result.stderr, '\n'));
 
-      return _validateExpectedPackages(createdAppDir, expectedPackageDir);
+    Expect.equals(result.exitCode, exitCode,
+        'Pub returned exit code ${result.exitCode}, expected $exitCode.');
+
+    return runScheduled(_scheduledAfterPub);
+  });
+
+  future.then((_) {
+    deleteSandboxIfCreated(asyncDone);
+  });
+
+  future.handleException((error) {
+    // If an error occurs during testing, delete the sandbox, throw the error so
+    // that the test framework sees it, then finally call asyncDone so that the
+    // test framework knows we're done doing asynchronous stuff.
+    deleteSandboxIfCreated(() {
+      guard(() { throw error; }, asyncDone);
     });
-
-    future.then((error) {
-      // Null means there were no errors.
-      if (error != null) Expect.fail(error);
-
-      deleteSandboxIfCreated();
-    });
-
-    future.handleException((error) {
-      deleteSandboxIfCreated();
-      // If we encounter an error, we want to pass it to the test framework. In
-      // order to get the stack trace information, we need to re-throw and
-      // re-catch it.
-      try {
-        throw error;
-      } catch (var e, var stack) {
-        reportTestError('$e', '$stack');
-      }
-      return true;
-    });
+    return true;
   });
 }
 
 Future<Directory> _setUpSandbox() {
   return createTempDir('pub-test-sandbox-');
 }
 
 Future _setUpCache(Directory sandboxDir, List<Descriptor> cache) {
   // No cache.
   if (cache == null) return new Future.immediate(null);
@@ skipping 25 matching lines @@
   // Find the main pub entrypoint.
   final pubPath = fs.joinPaths(scriptDir, '../../pub/pub.dart');
 
   final args = ['--enable-type-checks', '--enable-asserts', pubPath];
   args.addAll(pubArgs);
 
   return runProcess(dartBin, args, workingDir);
 }
 
 /**
- * Validates the contents of the "packages" directory inside [appDir] against
- * [expectedPackageDir].
- */
-Future<String> _validateExpectedPackages(Directory appDir,
-    List<Descriptor> expectedPackageDir) {
-  // No expectation.
-  if (expectedPackageDir == null) return new Future.immediate(null);
-
-  return dir('packages', expectedPackageDir).validate(appDir.path);
-}
-
-/**
  * Compares the [actual] output from running pub with [expectedText]. Ignores
  * leading and trailing whitespace differences and tries to report the
  * offending difference in a nice way.
  */
 void _validateOutput(String expectedText, List<String> actual) {
   final expected = expectedText.split('\n');
 
   // Strip off the last line. This lets us have expected multiline strings
   // where the closing ''' is on its own line. It also fixes '' expected output
   // to expect zero lines of output, not a single empty line.
@@ skipping 45 matching lines @@
 
   /**
    * Creates the file or directory within [dir]. Returns a [Future] that is
    * completed after the creation is done.
    */
   abstract Future create(dir);
 
   /**
    * Validates that this descriptor correctly matches the corresponding file
    * system entry within [dir]. Returns a [Future] that completes to `null` if
-   * the entry is valid, or a message describing the error if it failed.
+   * the entry is valid, or throws an error if it failed.
    */
-  abstract Future<String> validate(String dir);
+  abstract Future validate(String dir);
+
+  /**
+   * Schedules the directory to be created before Pub is run with [runPub]. The
+   * directory will be created relative to the sandbox directory.
+   */
+  void scheduleCreate() => _scheduleBeforePub(create);
+
+  /**
+   * Schedules the directory to be validated after Pub is run with [runPub]. The
+   * directory will be validated relative to the sandbox directory.
+   */
+  void scheduleValidate() =>
+    _scheduleAfterPub((parentDir) => validate(parentDir));
 }
 
 /**
  * Describes a file. These are used both for setting up an expected directory
  * tree before running a test, and for validating that the file system matches
  * some expectations after running it.
  */
 class FileDescriptor extends Descriptor {
   /**
    * The text contents of the file.
    */
   final String contents;
 
   FileDescriptor(String name, this.contents) : super(name);
 
   /**
    * Creates the file within [dir]. Returns a [Future] that is completed after
    * the creation is done.
    */
   Future<File> create(dir) {
     return writeTextFile(join(dir, name), contents);
   }
 
   /**
    * Validates that this file correctly matches the actual file at [path].
    */
-  Future<String> validate(String path) {
+  Future validate(String path) {
     path = join(path, name);
     return fileExists(path).chain((exists) {
-      if (!exists) {
-        return new Future.immediate('Expected file $path does not exist.');
-      }
+      if (!exists) Expect.fail('Expected file $path does not exist.');
 
       return readTextFile(path).transform((text) {
         if (text == contents) return null;
 
-        return 'File $path should contain:\n\n$contents\n\n'
-               'but contained:\n\n$text';
+        Expect.fail('File $path should contain:\n\n$contents\n\n'
+                    'but contained:\n\n$text');
       });
     });
   }
 }
 
 /**
  * Describes a directory and its contents. These are used both for setting up
  * an expected directory tree before running a test, and for validating that
  * the file system matches some expectations after running it.
  */
@@ skipping 28 matching lines @@
 
     return completer.future;
   }
 
   /**
    * Validates that the directory at [path] contains all of the expected
    * contents in this descriptor. Note that this does *not* check that the
    * directory doesn't contain other unexpected stuff, just that it *does*
    * contain the stuff we do expect.
    */
-  Future<String> validate(String path) {
+  Future validate(String path) {
     // Validate each of the items in this directory.
     final entryFutures = contents.map(
         (entry) => entry.validate(join(path, name)));
 
     // If they are all valid, the directory is valid.
-    return Futures.wait(entryFutures).transform((entries) {
-      for (final entry in entries) {
-        if (entry != null) return entry;
-      }
-
-      // If we got here, all of the sub-entries were valid.
-      return null;
-    });
+    return Futures.wait(entryFutures).transform((entries) => null);
   }
 }
+
+/**
+ * Schedules a callback to be called before Pub is run with [runPub].
+ */
+void _scheduleBeforePub(_ScheduledEvent event) {
+  if (_scheduledBeforePub == null) _scheduledBeforePub = [];
+  _scheduledBeforePub.add(event);
+}
+
+/**
+ * Schedules a callback to be called after Pub is run with [runPub].
+ */
+void _scheduleAfterPub(_ScheduledEvent event) {
+  if (_scheduledAfterPub == null) _scheduledAfterPub = [];
+  _scheduledAfterPub.add(event);
+}