add suitePath getter for retrieving the package relative path of the …

…current suite

pkgs/test/CHANGELOG.md

@@ -3,6 +3,8 @@
 * Fix dart2wasm tests on windows.
 * Increase SDK constraint to ^3.5.0-311.0.dev.
 * Support running Node.js tests compiled with dart2wasm.
+* Add `suitePath` getter, which can return the package root relative path to
+  the current test suite being ran, if available
 
 ## 1.25.8
 

pkgs/test_api/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 * Increase SDK constraint to ^3.5.0-311.0.dev.
 * Support running Node.js tests compiled with dart2wasm.
+* Add `suitePath` getter, which can return the package root relative path to
+  the current test suite being ran, if available.
 
 ## 0.7.3
 

pkgs/test_api/dart_test.yaml

@@ -18,11 +18,6 @@ tags:
   browser:
     timeout: 2x
 
-    # Browsers can sometimes randomly time out while starting, especially on
-    # Travis which is pretty slow. Don't retry locally because it makes
-    # debugging more annoying.
-    presets: {travis: {retry: 3}}
-
   dart2js:
     add_tags: [browser]
     timeout: 2x

pkgs/test_api/lib/scaffolding.dart

@@ -20,4 +20,9 @@ export 'src/scaffolding/spawn_hybrid.dart' show spawnHybridCode, spawnHybridUri;
 export 'src/scaffolding/test_structure.dart'
     show addTearDown, group, setUp, setUpAll, tearDown, tearDownAll, test;
 export 'src/scaffolding/utils.dart'
-    show markTestSkipped, printOnFailure, pumpEventQueue, registerException;
+    show
+        markTestSkipped,
+        printOnFailure,
+        pumpEventQueue,
+        registerException,
+        suitePath;

pkgs/test_api/lib/src/backend/remote_listener.dart

@@ -119,21 +119,26 @@ final class RemoteListener {
 
         await declarer.declare(main);
 
+        final path = message['path'] as String;
         var suite = Suite(
           declarer.build(),
           SuitePlatform.deserialize(message['platform'] as Object),
-          path: message['path'] as String,
+          path: path,
           ignoreTimeouts: message['ignoreTimeouts'] as bool? ?? false,
         );
 
         runZoned(() {
           Invoker.guard(
               () => RemoteListener._(suite, printZone)._listen(channel));
-        },
-            // Make the declarer visible to running tests so that they'll throw
-            // useful errors when calling `test()` and `group()` within a test,
-            // and so they can add to the declarer's `tearDownAll()` list.
-            zoneValues: {#test.declarer: declarer});
+        }, zoneValues: {
+          // Make the declarer visible to running tests so that they'll throw
+          // useful errors when calling `test()` and `group()` within a test,
+          // and so they can add to the declarer's `tearDownAll()` list.
+          #test.declarer: declarer,
+          // Make the test suite path visible to running tests so that they can
+          // ask for it, if available.
+          #test.suitePath: path,
+        });
       }, (error, stackTrace) {
         _sendError(channel, error, stackTrace, verboseChain);
       }, zoneSpecification: spec);

pkgs/test_api/lib/src/scaffolding/utils.dart

@@ -44,6 +44,9 @@ void printOnFailure(String message) {
 /// test body after marking it as skipped.
 void markTestSkipped(String message) => _currentInvoker..skip(message);
 
+/// The relative path from the package root to the current test suite, if known.
+String? get suitePath => Zone.current[#test.suitePath] as String?;
+
 Invoker get _currentInvoker =>
     Invoker.current ??
     (throw StateError(

pkgs/test_api/mono_pkg.yaml

@@ -13,7 +13,7 @@ stages:
     - dev
 - unit_test:
   - group:
-    - command: dart test --preset travis -x browser
+    - command: dart test -p vm,chrome -c dart2js,dart2wasm,exe,kernel,source
       os:
       - linux
       - windows

pkgs/test_api/pubspec.yaml

@@ -12,6 +12,7 @@ dependencies:
   async: ^2.5.0
   boolean_selector: ^2.1.0
   collection: ^1.15.0
+  http: ^1.2.2
   meta: ^1.14.0
   source_span: ^1.8.0
   stack_trace: ^1.10.0

pkgs/test_api/test/import_restrictions_test.dart

@@ -2,6 +2,9 @@
 // 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 && !exe')
+library;
+
 import 'dart:async';
 import 'dart:io';
 import 'dart:isolate';

pkgs/test_api/test/scaffolding/test_data.txt

@@ -0,0 +1 @@
+hello

pkgs/test_api/test/scaffolding/utils_test.dart

@@ -0,0 +1,16 @@
+// Copyright (c) 2024, 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.
+
+import 'package:test/test.dart';
+
+import 'utils_test_browser.dart' if (dart.library.io) 'utils_test_io.dart';
+
+void main() {
+  test('suitePath is available', () {
+    expect(suitePath, 'test/scaffolding/utils_test.dart');
+  });
+
+  /// Tests specific to the platform we are running on.
+  platformTests();
+}

pkgs/test_api/test/scaffolding/utils_test_browser.dart

@@ -0,0 +1,23 @@
+// Copyright (c) 2024, 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.
+
+import 'package:http/http.dart';
+import 'package:test/test.dart';
+
+void platformTests() {
+  test(
+      'Suite relative paths should be resolved by using Uri.base in the browser',
+      () async {
+    // On the web, suite
+    final resolved = Uri.base.resolve('test_data.txt');
+    expect(resolved.scheme, startsWith('http'));
+    expect(resolved.isAbsolute, true);
+    expect(resolved.path, endsWith('test/scaffolding/test_data.txt'));
+    expect(
+        await get(resolved),
+        isA<Response>()
+            .having((r) => r.statusCode, 'statusCode', 200)
+            .having((r) => r.body, 'body', 'hello\n'));
+  });
+}

pkgs/test_api/test/scaffolding/utils_test_io.dart

@@ -0,0 +1,22 @@
+// Copyright (c) 2024, 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.
+
+import 'dart:io';
+
+import 'package:test/test.dart';
+
+void platformTests() {
+  test(
+      'Suite relative paths should be resolved by using Uri.base + suitePath '
+      'on the VM', () {
+    final resolved = Uri.base.resolve(suitePath!).resolve('test_data.txt');
+    expect(resolved.scheme, 'file');
+    expect(resolved.isAbsolute, true);
+    expect(resolved.path,
+        endsWith('pkgs/test_api/test/scaffolding/test_data.txt'));
+    final file = File.fromUri(resolved);
+    expect(file.existsSync(), true);
+    expect(file.readAsStringSync(), 'hello\n');
+  });
+}

pkgs/test_core/CHANGELOG.md

@@ -3,6 +3,8 @@
 * Fix dart2wasm tests on windows.
 * Increase SDK constraint to ^3.5.0-311.0.dev.
 * Allow passing additional arguments to `dart compile wasm`.
+* Add `suitePath` getter, which can return the package root relative path to
+  the current test suite being ran, if available
 
 ## 0.6.5