Chaining of setup/teardown.

pkg/unittest/lib/unittest.dart

 // Copyright (c) 2013, 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.
 
 /**
  * A library for writing dart unit tests.
  *
  * ## Installing ##
  *
  * Use [pub][] to install this package. Add the following to your `pubspec.yaml`
@@ skipping 187 matching lines @@
   }
 }
 
 /**
  * Can be called by tests to log status. Tests should use this
  * instead of [print].
  */
 void logMessage(String message) =>
     _config.onLogMessage(currentTestCase, message);
 
-/**
- * Description text of the current test group. If multiple groups are nested,
- * this will contain all of their text concatenated.
- */
-String _currentGroup = '';
-
 /** Separator used between group names and test names. */
 String groupSep = ' ';
 
 final List<TestCase> _testCases = new List<TestCase>();
 
 /** Tests executed in this suite. */
 final List<TestCase> testCases = new UnmodifiableListView<TestCase>(_testCases);
 
-/** Setup function called before each test in a group */
-Function _testSetup;
+/**
+ * Setup and teardown functions for a group and its parents, the latter
+ * for chaining.
+ */
+class GroupContext {
+  /** Setup function called before each test in a group. */
+  Function testSetup = null;
 
-/** Teardown function called after each test in a group */
-Function _testTeardown;
+  /** Teardown function called after each test in a group. */
+  Function testTeardown = null;
+
+  /** Setup and teardown functions of parent group, for chaining. */
+  Function parentSetup = null;
+  Function parentTeardown = null;
+
+  /**
+   * Description text of the current test group. If multiple groups are nested,
+   * this will contain all of their text concatenated.
+   */
+  String groupName = '';
+}
+
+GroupContext _currentContext = new GroupContext();
 
 int _currentTestCaseIndex = 0;
 
 /** [TestCase] currently being executed. */
 TestCase get currentTestCase =>
     (_currentTestCaseIndex >= 0 && _currentTestCaseIndex < testCases.length)
         ? testCases[_currentTestCaseIndex]
         : null;
 
 /** Whether the framework is in an initialized state. */
@@ skipping 352 matching lines @@
 Function protectAsync2(Function callback, {String id}) {
   return new _SpreadArgsHelper(callback, 0, -1, null, id).invoke2;
 }
 
 /**
  * Creates a new named group of tests. Calls to group() or test() within the
  * body of the function passed to this will inherit this group's description.
  */
 void group(String description, void body()) {
   ensureInitialized();
+  // Groups can be nested, so we need to preserve the current
+  // settings for test setup/teardown. We use a local copy here so we
+  // can nest multiple levels; we also have the global parent variables
+  // which are used for chaining.
+  var oldContext = _currentContext;
+  _currentContext = new GroupContext();
+  _currentContext.testSetup = _currentContext.parentSetup =
+      oldContext.testSetup;
+  _currentContext.testTeardown = _currentContext.parentTeardown =
+      oldContext.testTeardown;
+
   // Concatenate the new group.
-  final parentGroup = _currentGroup;
-  if (_currentGroup != '') {
+  if (oldContext.groupName != '') {
     // Add a space.
-    _currentGroup = '$_currentGroup$groupSep$description';
+    _currentContext.groupName = '${oldContext.groupName}$groupSep$description';
   } else {
     // The first group.
-    _currentGroup = description;
+    _currentContext.groupName = description;
   }
 
-  // Groups can be nested, so we need to preserve the current
-  // settings for test setup/teardown.
-  Function parentSetup = _testSetup;
-  Function parentTeardown = _testTeardown;
 
   try {
-    _testSetup = null;
-    _testTeardown = null;
     body();
   } catch (e, trace) {
     var stack = (trace == null) ? '' : ': ${trace.toString()}';
     _uncaughtErrorMessage = "${e.toString()}$stack";
   } finally {
     // Now that the group is over, restore the previous one.
-    _currentGroup = parentGroup;
-    _testSetup = parentSetup;
-    _testTeardown = parentTeardown;
+    _currentContext = oldContext;
   }
 }
 
 /**
  * Register a [setUp] function for a test [group]. This function will
- * be called before each test in the group is run. Note that if groups
- * are nested only the most locally scoped [setUpTest] function will be run.
+ * be called before each test in the group is run.
  * [setUp] and [tearDown] should be called within the [group] before any
  * calls to [test]. The [setupTest] function can be asynchronous; in this
  * case it must return a [Future].
  */
 void setUp(Function setupTest) {
-  _testSetup = setupTest;
+  var parent = _currentContext.parentSetup;
+  _currentContext.testSetup = () {
+    var f = parent == null ? null : parent();
+    if (f is Future) {
+      return f.then((_) => setupTest());
+    } else {
+      return setupTest();
+    }
+  };
 }
 
 /**
  * Register a [tearDown] function for a test [group]. This function will
  * be called after each test in the group is run. Note that if groups
  * are nested only the most locally scoped [teardownTest] function will be run.
  * [setUp] and [tearDown] should be called within the [group] before any
  * calls to [test]. The [teardownTest] function can be asynchronous; in this
  * case it must return a [Future].
  */
 void tearDown(Function teardownTest) {
-  _testTeardown = teardownTest;
+  var parent = _currentContext.parentTeardown;
+  _currentContext.testTeardown = () {
+    var f = teardownTest();
+    if (parent == null) return f;
+    if (f is Future) {
+      // TODO(gram): as _parentTeardown is a global, do we need
+      // to first take a local copy so the value is fixed at the
+      // point that tearDown is called?
+      return f.then((_) => parent());
+    } else {
+      return parent();
+    }
+  };
 }
 
 /** Advance to the next test case. */
 void _nextTestCase() {
   _defer(() {
     _currentTestCaseIndex++;
     _nextBatch();
   });
 }
 
@@ skipping 44 matching lines @@
   } else if (testFilter is Function) {
     filterFunction = testFilter;
   }
   _testCases.retainWhere(filterFunction);
 }
 
 /** Runs all queued tests, one at a time. */
 void runTests() {
   _ensureInitialized(false);
   _currentTestCaseIndex = 0;
-  _currentGroup = '';
+  _currentContext = new GroupContext();
 
   // If we are soloing a test, remove all the others.
   if (_soloTest != null) {
     filterTests((t) => t == _soloTest);
   }
 
   _config.onStart();
 
   _defer(() {
     _nextBatch();
@@ skipping 78 matching lines @@
       case ERROR: errors++; break;
     }
   }
   _config.onSummary(passed, failed, errors, testCases, _uncaughtErrorMessage);
   _config.onDone(passed > 0 && failed == 0 && errors == 0 &&
       _uncaughtErrorMessage == null);
   _initialized = false;
 }
 
 String _fullSpec(String spec) {
-  if (spec == null) return '$_currentGroup';
-  return _currentGroup != '' ? '$_currentGroup$groupSep$spec' : spec;
+  var group = '${_currentContext.groupName}';
+  if (spec == null) return group;
+  return group != '' ? '$group$groupSep$spec' : spec;
 }
 
 /**
  * Lazily initializes the test library if not already initialized.
  */
 void ensureInitialized() {
   _ensureInitialized(true);
 }
 
 void _ensureInitialized(bool configAutoStart) {
@@ skipping 44 matching lines @@
 }
 
 /** Enable a test by ID. */
 void enableTest(int testId) => _setTestEnabledState(testId, true);
 
 /** Disable a test by ID. */
 void disableTest(int testId) => _setTestEnabledState(testId, false);
 
 /** Signature for a test function. */
 typedef dynamic TestFunction();