Support running tests by absolute file: uri (#1893)

Fixes #1891
Fixes #1899

For any path which looks like it has a scheme (contains "://"), parse it as a uri and grab the path from that. On windows, we also remove any leading `/` from the path because it will be followed by a drive letter, which we want to be the first part of the path (and not preceded by a `/`).

Author: jakemac53

pkgs/test/CHANGELOG.md

@@ -4,6 +4,7 @@
   reporter.
 * Add support for CHROME_EXECUTABLE environment variable. This overrides any
   config file settings.
+* Support running tests by absolute file uri.
 
 ## 1.22.2
 

pkgs/test/test/runner/configuration/platform_test.dart

@@ -4,7 +4,6 @@
 
 @TestOn('vm')
 import 'dart:convert';
-import 'dart:io';
 
 import 'package:test/test.dart';
 import 'package:test_core/src/util/exit_codes.dart' as exit_codes;
@@ -205,10 +204,8 @@ void main() {
       var test = await runTest(['.']);
       expect(
           test.stdout,
-          containsInOrder([
-            '+0: .${Platform.pathSeparator}test_foo.dart: test_foo',
-            '+1: All tests passed!'
-          ]));
+          containsInOrder(
+              ['+0: ./test_foo.dart: test_foo', '+1: All tests passed!']));
       await test.shouldExit(0);
     });
 
@@ -243,10 +240,8 @@ void main() {
       var test = await runTest(['.']);
       expect(
           test.stdout,
-          containsInOrder([
-            '+0: .${Platform.pathSeparator}foo_test.dart: foo_test',
-            '+1: All tests passed!'
-          ]));
+          containsInOrder(
+              ['+0: ./foo_test.dart: foo_test', '+1: All tests passed!']));
       await test.shouldExit(0);
     });
 

pkgs/test/test/runner/configuration/randomize_order_test.dart

@@ -4,7 +4,6 @@
 
 @TestOn('vm')
 import 'dart:convert';
-import 'dart:io';
 
 import 'package:test/test.dart';
 import 'package:test_descriptor/test_descriptor.dart' as d;
@@ -148,14 +147,14 @@ void main() {
         test.stdout,
         emitsInAnyOrder([
           containsInOrder([
-            '.${Platform.pathSeparator}1_test.dart: test 1.2',
-            '.${Platform.pathSeparator}1_test.dart: test 1.3',
-            '.${Platform.pathSeparator}1_test.dart: test 1.1'
+            './1_test.dart: test 1.2',
+            './1_test.dart: test 1.3',
+            './1_test.dart: test 1.1'
           ]),
           containsInOrder([
-            '.${Platform.pathSeparator}2_test.dart: test 2.2',
-            '.${Platform.pathSeparator}2_test.dart: test 2.3',
-            '.${Platform.pathSeparator}2_test.dart: test 2.1'
+            './2_test.dart: test 2.2',
+            './2_test.dart: test 2.3',
+            './2_test.dart: test 2.1'
           ]),
           contains('+6: All tests passed!')
         ]));

pkgs/test/test/runner/runner_test.dart

@@ -7,6 +7,7 @@
 import 'dart:io';
 import 'dart:math' as math;
 
+import 'package:path/path.dart' as p;
 import 'package:test/test.dart';
 import 'package:test_core/src/util/exit_codes.dart' as exit_codes;
 import 'package:test_descriptor/test_descriptor.dart' as d;
@@ -362,6 +363,30 @@ $_usage''');
       expect(test.stdout, emitsThrough(contains('+1: All tests passed!')));
       await test.shouldExit(0);
     });
+
+    test('given a file: uri', () async {
+      await d.file('test.dart', _success).create();
+      var fileUri = p.toUri(d.path('test.dart')).toString();
+      expect(fileUri, startsWith('file:///'));
+      var test = await runTest([fileUri]);
+      expect(test.stdout, emitsThrough(contains('+1: All tests passed!')));
+      await test.shouldExit(0);
+    });
+
+    test('with platform specific relative paths', () async {
+      await d.dir('foo', [d.file('test.dart', _success)]).create();
+      var test = await runTest([p.join('foo', 'test.dart')]);
+      expect(test.stdout, emitsThrough(contains('+1: All tests passed!')));
+      await test.shouldExit(0);
+    });
+
+    test('with platform specific relative paths containing query params',
+        () async {
+      await d.dir('foo', [d.file('test.dart', _success)]).create();
+      var test = await runTest(['${p.join('foo', 'test.dart')}?line=6']);
+      expect(test.stdout, emitsThrough(contains('+1: All tests passed!')));
+      await test.shouldExit(0);
+    });
   });
 
   group('runs successful tests with async setup', () {

pkgs/test/test/runner/shard_test.dart

@@ -3,9 +3,6 @@
 // BSD-style license that can be found in the LICENSE file.
 
 @TestOn('vm')
-
-import 'dart:io';
-
 import 'package:test/test.dart';
 import 'package:test_core/src/util/exit_codes.dart' as exit_codes;
 import 'package:test_descriptor/test_descriptor.dart' as d;
@@ -95,14 +92,10 @@ void main() {
         test.stdout,
         emitsInOrder([
           emitsAnyOf([
-            containsInOrder([
-              '+0: .${Platform.pathSeparator}1_test.dart: test 1.1',
-              '+1: .${Platform.pathSeparator}2_test.dart: test 2.1'
-            ]),
-            containsInOrder([
-              '+0: .${Platform.pathSeparator}2_test.dart: test 2.1',
-              '+1: .${Platform.pathSeparator}1_test.dart: test 1.1'
-            ])
+            containsInOrder(
+                ['+0: ./1_test.dart: test 1.1', '+1: ./2_test.dart: test 2.1']),
+            containsInOrder(
+                ['+0: ./2_test.dart: test 2.1', '+1: ./1_test.dart: test 1.1'])
           ]),
           contains('+2: All tests passed!')
         ]));
@@ -113,14 +106,10 @@ void main() {
         test.stdout,
         emitsInOrder([
           emitsAnyOf([
-            containsInOrder([
-              '+0: .${Platform.pathSeparator}1_test.dart: test 1.2',
-              '+1: .${Platform.pathSeparator}2_test.dart: test 2.2'
-            ]),
-            containsInOrder([
-              '+0: .${Platform.pathSeparator}2_test.dart: test 2.2',
-              '+1: .${Platform.pathSeparator}1_test.dart: test 1.2'
-            ])
+            containsInOrder(
+                ['+0: ./1_test.dart: test 1.2', '+1: ./2_test.dart: test 2.2']),
+            containsInOrder(
+                ['+0: ./2_test.dart: test 2.2', '+1: ./1_test.dart: test 1.2'])
           ]),
           contains('+2: All tests passed!')
         ]));
@@ -131,14 +120,10 @@ void main() {
         test.stdout,
         emitsInOrder([
           emitsAnyOf([
-            containsInOrder([
-              '+0: .${Platform.pathSeparator}1_test.dart: test 1.3',
-              '+1: .${Platform.pathSeparator}2_test.dart: test 2.3'
-            ]),
-            containsInOrder([
-              '+0: .${Platform.pathSeparator}2_test.dart: test 2.3',
-              '+1: .${Platform.pathSeparator}1_test.dart: test 1.3'
-            ])
+            containsInOrder(
+                ['+0: ./1_test.dart: test 1.3', '+1: ./2_test.dart: test 2.3']),
+            containsInOrder(
+                ['+0: ./2_test.dart: test 2.3', '+1: ./1_test.dart: test 1.3'])
           ]),
           contains('+2: All tests passed!')
         ]));

pkgs/test_core/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 * Avoid empty expandable groups for tests without extra output in Github
   reporter.
+* Support running tests by absolute file uri.
 * Update `vm_service` constraint to `>=6.0.0 <12.0.0`.
 
 # 0.4.22

pkgs/test_core/lib/src/runner.dart

@@ -7,7 +7,6 @@ import 'dart:io';
 
 import 'package:async/async.dart';
 import 'package:boolean_selector/boolean_selector.dart';
-import 'package:path/path.dart' as p;
 import 'package:stack_trace/stack_trace.dart';
 // ignore: deprecated_member_use
 import 'package:test_api/backend.dart'
@@ -317,7 +316,8 @@ class Runner {
                   'Cannot filter by line/column for this test suite, no suite'
                   'path available.');
             }
-            var absoluteSuitePath = p.absolute(path);
+            // The absolute path as it will appear in stack traces.
+            var absoluteSuitePath = File(path).absolute.uri.toFilePath();
 
             bool matchLineAndCol(Frame frame) {
               if (frame.uri.scheme != 'file' ||

pkgs/test_core/lib/src/runner/configuration/args.dart

@@ -177,41 +177,35 @@ Configuration parse(List<String> args) => _Parser(args).parse();
 
 void _parseTestSelection(
     String option, Map<String, Set<TestSelection>> selections) {
-  var firstQuestion = option.indexOf('?');
-  TestSelection selection;
-  String path;
-  if (firstQuestion == -1) {
-    path = option;
-    selection = TestSelection();
-  } else if (option.substring(0, firstQuestion).contains('\\')) {
-    throw FormatException(
-        'When passing test path queries, you must pass the path in URI '
-        'format (use `/` for directory separators instead of `\\`).');
-  } else {
-    final uri = Uri.parse(option);
+  final uri = Uri.parse(option);
+  // Restore the path to how it was given (namely, we want to report paths
+  // with their original separators).
+  var path = Uri.decodeComponent(uri.path);
+  // Strip out the leading slash before the drive letter on windows.
+  if (Platform.isWindows && path.startsWith('/')) {
+    path = path.substring(1);
+  }
 
-    final names = uri.queryParametersAll['name'];
-    final fullName = uri.queryParameters['full-name'];
-    final line = uri.queryParameters['line'];
-    final col = uri.queryParameters['col'];
+  final names = uri.queryParametersAll['name'];
+  final fullName = uri.queryParameters['full-name'];
+  final line = uri.queryParameters['line'];
+  final col = uri.queryParameters['col'];
 
-    if (names != null && names.isNotEmpty && fullName != null) {
-      throw FormatException(
-        'Cannot specify both "name=<...>" and "full-name=<...>".',
-      );
-    }
-    path = uri.path;
-    selection = TestSelection(
-      testPatterns: fullName != null
-          ? {RegExp('^${RegExp.escape(fullName)}\$')}
-          : {
-              if (names != null)
-                for (var name in names) RegExp(name)
-            },
-      line: line == null ? null : int.parse(line),
-      col: col == null ? null : int.parse(col),
+  if (names != null && names.isNotEmpty && fullName != null) {
+    throw FormatException(
+      'Cannot specify both "name=<...>" and "full-name=<...>".',
     );
   }
+  final selection = TestSelection(
+    testPatterns: fullName != null
+        ? {RegExp('^${RegExp.escape(fullName)}\$')}
+        : {
+            if (names != null)
+              for (var name in names) RegExp(name)
+          },
+    line: line == null ? null : int.parse(line),
+    col: col == null ? null : int.parse(col),
+  );
 
   selections.update(path, (selections) => selections..add(selection),
       ifAbsent: () => {selection});