Add location information to the JSON reporter.

test/runner/json_reporter_test.dart

 // Copyright (c) 2015, 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.
 
 @TestOn("vm")
 
 import 'dart:convert';
 
+import 'package:path/path.dart' as p;
 import 'package:scheduled_test/descriptor.dart' as d;
 import 'package:scheduled_test/scheduled_stream.dart';
 import 'package:scheduled_test/scheduled_test.dart';
 
 import 'package:test/src/runner/version.dart';
 
 import '../io.dart';
 
 /// The first event emitted by the JSON reporter.
 final _start = {
@@ skipping 10 matching lines @@
       test('success 1', () {});
       test('success 2', () {});
       test('success 3', () {});
     """, [
       _start,
       _allSuites(),
       _suite(0),
       _testStart(1, "loading test.dart", groupIDs: []),
       _testDone(1, hidden: true),
       _group(2, testCount: 3),
-      _testStart(3, "success 1"),
+      _testStart(3, "success 1", line: 6, column: 7),
       _testDone(3),
-      _testStart(4, "success 2"),
+      _testStart(4, "success 2", line: 7, column: 7),
       _testDone(4),
-      _testStart(5, "success 3"),
+      _testStart(5, "success 3", line: 8, column: 7),
       _testDone(5),
       _done()
     ]);
   });
 
   test("runs several failing tests and reports when each fails", () {
     _expectReport("""
       test('failure 1', () => throw new TestFailure('oh no'));
       test('failure 2', () => throw new TestFailure('oh no'));
       test('failure 3', () => throw new TestFailure('oh no'));
     """, [
       _start,
       _allSuites(),
       _suite(0),
       _testStart(1, "loading test.dart", groupIDs: []),
       _testDone(1, hidden: true),
       _group(2, testCount: 3),
-      _testStart(3, "failure 1"),
+      _testStart(3, "failure 1", line: 6, column: 7),
       _error(3, "oh no", isFailure: true),
       _testDone(3, result: "failure"),
-      _testStart(4, "failure 2"),
+      _testStart(4, "failure 2", line: 7, column: 7),
       _error(4, "oh no", isFailure: true),
       _testDone(4, result: "failure"),
-      _testStart(5, "failure 3"),
+      _testStart(5, "failure 3", line: 8, column: 7),
       _error(5, "oh no", isFailure: true),
       _testDone(5, result: "failure"),
       _done(success: false)
     ]);
   });
 
   test("includes the full stack trace with --verbose-trace", () {
     d.file("test.dart", """
       import 'dart:async';
 
@@ skipping 15 matching lines @@
       test('success 1', () {});
       test('failure 2', () => throw new TestFailure('oh no'));
       test('success 2', () {});
     """, [
       _start,
       _allSuites(),
       _suite(0),
       _testStart(1, "loading test.dart", groupIDs: []),
       _testDone(1, hidden: true),
       _group(2, testCount: 4),
-      _testStart(3, "failure 1"),
+      _testStart(3, "failure 1", line: 6, column: 7),
       _error(3, "oh no", isFailure: true),
       _testDone(3, result: "failure"),
-      _testStart(4, "success 1"),
+      _testStart(4, "success 1", line: 7, column: 7),
       _testDone(4),
-      _testStart(5, "failure 2"),
+      _testStart(5, "failure 2", line: 8, column: 7),
       _error(5, "oh no", isFailure: true),
       _testDone(5, result: "failure"),
-      _testStart(6, "success 2"),
+      _testStart(6, "success 2", line: 9, column: 7),
       _testDone(6),
       _done(success: false)
     ]);
   });
 
   test("gracefully handles multiple test failures in a row", () {
     _expectReport("""
       // This completer ensures that the test isolate isn't killed until all
       // errors have been thrown.
       var completer = new Completer();
       test('failures', () {
         new Future.microtask(() => throw 'first error');
         new Future.microtask(() => throw 'second error');
         new Future.microtask(() => throw 'third error');
         new Future.microtask(completer.complete);
       });
       test('wait', () => completer.future);
     """, [
       _start,
       _allSuites(),
       _suite(0),
       _testStart(1, "loading test.dart", groupIDs: []),
       _testDone(1, hidden: true),
       _group(2, testCount: 2),
-      _testStart(3, "failures"),
+      _testStart(3, "failures", line: 9, column: 7),
       _error(3, "first error"),
       _error(3, "second error"),
       _error(3, "third error"),
       _testDone(3, result: "error"),
-      _testStart(4, "wait"),
+      _testStart(4, "wait", line: 15, column: 7),
       _testDone(4),
       _done(success: false)
     ]);
   });
 
   test("gracefully handles a test failing after completion", () {
     _expectReport("""
       // These completers ensure that the first test won't fail until the second
       // one is running, and that the test isolate isn't killed until all errors
       // have been thrown.
       var waitStarted = new Completer();
       var testDone = new Completer();
       test('failure', () {
         waitStarted.future.then((_) {
           new Future.microtask(testDone.complete);
           throw 'oh no';
         });
       });
       test('wait', () {
         waitStarted.complete();
         return testDone.future;
       });
     """, [
       _start,
       _allSuites(),
       _suite(0),
       _testStart(1, "loading test.dart", groupIDs: []),
       _testDone(1, hidden: true),
       _group(2, testCount: 2),
-      _testStart(3, "failure"),
+      _testStart(3, "failure", line: 11, column: 7),
       _testDone(3),
-      _testStart(4, "wait"),
+      _testStart(4, "wait", line: 17, column: 7),
       _error(3, "oh no"),
       _error(3,
           "This test failed after it had already completed. Make sure to "
             "use [expectAsync]\n"
           "or the [completes] matcher when testing async code."),
       _testDone(4),
       _done(success: false)
     ]);
   });
 
   test("reports each test in its proper groups", () {
     _expectReport("""
       group('group 1', () {
         group('.2', () {
           group('.3', () {
             test('success', () {});
           });
         });
 
         test('success', () {});
         test('success', () {});
       });
     """, [
       _start,
       _allSuites(),
       _suite(0),
       _testStart(1, "loading test.dart", groupIDs: []),
       _testDone(1, hidden: true),
       _group(2, testCount: 3),
-      _group(3, name: "group 1", parentID: 2, testCount: 3),
-      _group(4, name: "group 1 .2", parentID: 3),
-      _group(5, name: "group 1 .2 .3", parentID: 4),
-      _testStart(6, 'group 1 .2 .3 success', groupIDs: [2, 3, 4, 5]),
+      _group(3,
+          name: "group 1", parentID: 2, testCount: 3, line: 6, column: 7),
+      _group(4, name: "group 1 .2", parentID: 3, line: 7, column: 9),
+      _group(5, name: "group 1 .2 .3", parentID: 4, line: 8, column: 11),
+      _testStart(6, 'group 1 .2 .3 success',
+          groupIDs: [2, 3, 4, 5], line: 9, column: 13),
       _testDone(6),
-      _testStart(7, 'group 1 success', groupIDs: [2, 3]),
+      _testStart(7, 'group 1 success', groupIDs: [2, 3], line: 13, column: 9),
       _testDone(7),
-      _testStart(8, 'group 1 success', groupIDs: [2, 3]),
+      _testStart(8, 'group 1 success', groupIDs: [2, 3], line: 14, column: 9),
       _testDone(8),
       _done()
     ]);
   });
 
   group("print:", () {
     test("handles multiple prints", () {
       _expectReport("""
         test('test', () {
           print("one");
           print("two");
           print("three");
           print("four");
         });
       """, [
         _start,
         _allSuites(),
         _suite(0),
         _testStart(1, "loading test.dart", groupIDs: []),
         _testDone(1, hidden: true),
         _group(2),
-        _testStart(3, 'test'),
+        _testStart(3, 'test', line: 6, column: 9),
         _print(3, "one"),
         _print(3, "two"),
         _print(3, "three"),
         _print(3, "four"),
         _testDone(3),
         _done()
       ]);
     });
 
     test("handles a print after the test completes", () {
@@ skipping 16 matching lines @@
           waitStarted.complete();
           return testDone.future;
         });
       """, [
         _start,
         _allSuites(),
         _suite(0),
         _testStart(1, "loading test.dart", groupIDs: []),
         _testDone(1, hidden: true),
         _group(2, testCount: 2),
-        _testStart(3, 'test'),
+        _testStart(3, 'test', line: 10, column: 9),
         _testDone(3),
-        _testStart(4, 'wait'),
+        _testStart(4, 'wait', line: 20, column: 9),
         _print(3, "one"),
         _print(3, "two"),
         _print(3, "three"),
         _print(3, "four"),
         _testDone(4),
         _done()
       ]);
     });
 
     test("interleaves prints and errors", () {
@@ skipping 20 matching lines @@
         });
 
         test('wait', () => completer.future);
       """, [
         _start,
         _allSuites(),
         _suite(0),
         _testStart(1, "loading test.dart", groupIDs: []),
         _testDone(1, hidden: true),
         _group(2, testCount: 2),
-        _testStart(3, 'test'),
+        _testStart(3, 'test', line: 9, column: 9),
         _print(3, "one"),
         _print(3, "two"),
         _error(3, "first error"),
         _print(3, "three"),
         _print(3, "four"),
         _error(3, "second error"),
         _print(3, "five"),
         _print(3, "six"),
         _testDone(3, result: "error"),
-        _testStart(4, 'wait'),
+        _testStart(4, 'wait', line: 27, column: 9),
         _testDone(4),
         _done(success: false)
       ]);
     });
   });
 
   group("skip:", () {
     test("reports skipped tests", () {
       _expectReport("""
         test('skip 1', () {}, skip: true);
         test('skip 2', () {}, skip: true);
         test('skip 3', () {}, skip: true);
       """, [
         _start,
         _allSuites(),
         _suite(0),
         _testStart(1, "loading test.dart", groupIDs: []),
         _testDone(1, hidden: true),
         _group(2, testCount: 3),
-        _testStart(3, "skip 1", skip: true),
+        _testStart(3, "skip 1", skip: true, line: 6, column: 9),
         _testDone(3),
-        _testStart(4, "skip 2", skip: true),
+        _testStart(4, "skip 2", skip: true, line: 7, column: 9),
         _testDone(4),
-        _testStart(5, "skip 3", skip: true),
+        _testStart(5, "skip 3", skip: true, line: 8, column: 9),
         _testDone(5),
         _done()
       ]);
     });
 
     test("reports skipped groups", () {
       _expectReport("""
         group('skip', () {
           test('success 1', () {});
           test('success 2', () {});
           test('success 3', () {});
         }, skip: true);
       """, [
         _start,
         _allSuites(),
         _suite(0),
         _testStart(1, "loading test.dart", groupIDs: []),
         _testDone(1, hidden: true),
         _group(2, testCount: 0),
-        _group(3, name: "skip", parentID: 2, skip: true, testCount: 0),
-        _testStart(4, "skip", groupIDs: [2, 3], skip: true),
+        _group(3, name: "skip", parentID: 2, skip: true, testCount: 0,
+            line: 6, column: 9),
+        _testStart(4, "skip", groupIDs: [2, 3], skip: true,
+            line: 6, column: 9),
         _testDone(4),
         _done()
       ]);
     });
 
     test("reports the skip reason if available", () {
       _expectReport("""
         test('skip 1', () {}, skip: 'some reason');
         test('skip 2', () {}, skip: 'or another');
       """, [
         _start,
          _allSuites(),
         _suite(0),
         _testStart(1, "loading test.dart", groupIDs: []),
         _testDone(1, hidden: true),
         _group(2, testCount: 2),
-        _testStart(3, "skip 1", skip: "some reason"),
+        _testStart(3, "skip 1", skip: "some reason", line: 6, column: 9),
         _testDone(3),
-        _testStart(4, "skip 2", skip: "or another"),
+        _testStart(4, "skip 2", skip: "or another", line: 7, column: 9),
         _testDone(4),
         _done()
       ]);
     });
   });
+
+  group("reports line and column numbers for", () {
+    test("the first call to setUpAll()", () {
+      _expectReport("""
+        setUpAll(() {});
+        setUpAll(() {});
+        setUpAll(() {});
+        test('success', () {});
+      """, [
+        _start,
+        _allSuites(),
+        _suite(0),
+        _testStart(1, "loading test.dart", groupIDs: []),
+        _testDone(1, hidden: true),
+        _group(2, testCount: 1),
+        _testStart(3, "(setUpAll)", line: 6, column: 9),
+        _testDone(3, hidden: true),
+        _testStart(4, "success", line: 9, column: 9),
+        _testDone(4),
+        _done()
+      ]);
+    });
+
+    test("the first call to tearDownAll()", () {
+      _expectReport("""
+        tearDownAll(() {});
+        tearDownAll(() {});
+        tearDownAll(() {});
+        test('success', () {});
+      """, [
+        _start,
+        _allSuites(),
+        _suite(0),
+        _testStart(1, "loading test.dart", groupIDs: []),
+        _testDone(1, hidden: true),
+        _group(2, testCount: 1),
+        _testStart(3, "success", line: 9, column: 9),
+        _testDone(3),
+        _testStart(4, "(tearDownAll)", line: 6, column: 9),
+        _testDone(4, hidden: true),
+        _done()
+      ]);
+    });
+
+    test("a test compiled to JS", () {
+      _expectReport("""
+        test('success', () {});
+      """, [
+        _start,
+        _allSuites(),
+        _suite(0, platform: "chrome"),
+        _testStart(1, "compiling test.dart", groupIDs: []),
+        _testDone(1, hidden: true),
+        _group(2, testCount: 1),
+        _testStart(3, "success", line: 6, column: 9),
+        _testDone(3),
+        _done()
+      ], args: ["-p", "chrome"]);
+    }, tags: ["chrome"]);
+  });
+
+  
+  test("doesn't report line and column information for a test compiled to JS "
+      "with --js-trace", () {
+    _expectReport("""
+      test('success', () {});
+    """, [
+      _start,
+      _allSuites(),
+      _suite(0, platform: "chrome"),
+      _testStart(1, "compiling test.dart", groupIDs: []),
+      _testDone(1, hidden: true),
+      _group(2, testCount: 1),
+      _testStart(3, "success"),
+      _testDone(3),
+      _done()
+    ], args: ["-p", "chrome", "--js-trace"]);
+  }, tags: ["chrome"]);
 }
 
 /// Asserts that the tests defined by [tests] produce the JSON events in
 /// [expected].
-void _expectReport(String tests, List<Map> expected) {
+void _expectReport(String tests, List<Map> expected, {List<String> args}) {
   var dart = """
     import 'dart:async';
 
     import 'package:test/test.dart';
 
     void main() {
-    $tests
+$tests
     }
   """;
 
   d.file("test.dart", dart).create();
 
-  var test = runTest(["test.dart"], reporter: "json");
+  var test = runTest(["test.dart"]..addAll(args ?? []), reporter: "json");
   test.shouldExit();
 
   schedule(() async {
     var stdoutLines = await test.stdoutStream().toList();
 
     expect(stdoutLines.length, equals(expected.length),
         reason: "Expected $stdoutLines to match ${JSON.encode(expected)}.");
 
     // TODO(nweiz): validate each event against the JSON schema when
     // patefacio/json_schema#4 is merged.
@@ skipping 37 matching lines @@
 /// Returns the event emitted by the JSON reporter indicating that a group has
 /// begun running.
 ///
 /// If [skip] is `true`, the group is expected to be marked as skipped without a
 /// reason. If it's a [String], the group is expected to be marked as skipped
 /// with that reason.
 ///
 /// The [testCount] parameter indicates the number of tests in the group. It
 /// defaults to 1.
 Map _group(int id, {String name, int suiteID, int parentID, skip,
-    int testCount}) {
+    int testCount, int line, int column}) {
+  if ((line == null) != (column == null)) {
+    throw new ArgumentError(
+        "line and column must either both be null or both be passed");
+  }
+
   return {
     "type": "group",
     "group": {
       "id": id,
       "name": name,
       "suiteID": suiteID ?? 0,
       "parentID": parentID,
       "metadata": _metadata(skip: skip),
-      "testCount": testCount ?? 1
+      "testCount": testCount ?? 1,
+      "line": line,
+      "column": column,
+      "url": 
+          line == null ? null : p.toUri(p.join(sandbox, "test.dart")).toString()
     }
   };
 }
 
 /// Returns the event emitted by the JSON reporter indicating that a test has
 /// begun running.
 ///
 /// If [parentIDs] is passed, it's the IDs of groups containing this test. If
 /// [skip] is `true`, the test is expected to be marked as skipped without a
 /// reason. If it's a [String], the test is expected to be marked as skipped
 /// with that reason.
 Map _testStart(int id, String name, {int suiteID, Iterable<int> groupIDs,
-    skip}) {
+    int line, int column, skip}) {
+  if ((line == null) != (column == null)) {
+    throw new ArgumentError(
+        "line and column must either both be null or both be passed");
+  }
+
   return {
     "type": "testStart",
     "test": {
       "id": id,
       "name": name,
       "suiteID": suiteID ?? 0,
       "groupIDs": groupIDs ?? [2],
-      "metadata": _metadata(skip: skip)
+      "metadata": _metadata(skip: skip),
+      "line": line,
+      "column": column,
+      "url":
+          line == null ? null : p.toUri(p.join(sandbox, "test.dart")).toString()
     }
   };
 }
 
 /// Returns the event emitted by the JSON reporter indicating that a test
 /// printed [message].
 Map _print(int id, String message) {
   return {
     "type": "print",
     "testID": id,
@@ skipping 35 matching lines @@
 /// Returns the serialized metadata corresponding to [skip].
 Map _metadata({skip}) {
   if (skip == true) {
     return {"skip": true, "skipReason": null};
   } else if (skip is String) {
     return {"skip": true, "skipReason": skip};
   } else {
     return {"skip": false, "skipReason": null};
   }
 }