[native assets] Fix pub workspaces in dart test

Bug: #60489

We can land a fix in `package:test` as well. However, projects
referring to an older version of test will not see such fixes.
So, land a workaround here that is picked up by older versions of test.

Change-Id: Ib26be2c0edc1bccf58b7231e05896cd55ac0cf19
Cq-Include-Trybots: luci.dart.try:pkg-linux-debug-try,pkg-linux-release-arm64-try,pkg-linux-release-try,pkg-mac-release-arm64-try,pkg-win-release-arm64-try,pkg-mac-release-try,pkg-win-release-try
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/421741
Reviewed-by: Hossein Yousefi <[email protected]>

Author: dcharkes

pkg/dartdev/lib/src/commands/test.dart

@@ -90,7 +90,16 @@ Run "${runner!.executableName} help" to see global options.''');
             log.stderr('Error: Compiling native assets failed.');
             return DartdevCommand.errorExitCode;
           }
-          nativeAssets = assetsYamlFileUri.toFilePath();
+          // TODO(https://github.com/dart-lang/sdk/issues/60489): Add a way to
+          // package:test to explicitly provide the native_assets.yaml path
+          // instead of copying to the workspace .dart_tool.
+          final expectedPackageTestLocation =
+              packageConfig.resolve('native_assets.yaml');
+          if (expectedPackageTestLocation != assetsYamlFileUri) {
+            await File.fromUri(assetsYamlFileUri)
+                .copy(expectedPackageTestLocation.toFilePath());
+          }
+          nativeAssets = expectedPackageTestLocation.toFilePath();
         }
       }
     }

pkg/dartdev/test/native_assets/helpers.dart

@@ -67,8 +67,8 @@ Future<run_process.RunProcessResult> runProcess({
       filesystem: const LocalFileSystem(),
     );
 
-Future<void> copyTestProjects(
-    Uri copyTargetUri, Logger logger, Uri packageLocation, Uri sdkRoot) async {
+Future<void> copyTestProjects(Uri copyTargetUri, Logger logger,
+    Uri packageLocation, Uri sdkRoot, bool usePubWorkspace) async {
   // Reuse the test projects from `pkg:native`.
   final testProjectsUri = packageLocation.resolve('test_data/');
   final manifestUri = testProjectsUri.resolve('manifest.yaml');
@@ -82,7 +82,7 @@ Future<void> copyTestProjects(
       .where((e) => !(e.pathSegments.last.startsWith('pubspec') &&
           e.pathSegments.last.endsWith('.yaml')))
       .toList();
-  final filesToModify = manifest
+  final pubspecPaths = manifest
       .where((e) =>
           e.pathSegments.last.startsWith('pubspec') &&
           e.pathSegments.last.endsWith('.yaml'))
@@ -98,17 +98,7 @@ Future<void> copyTestProjects(
     }
     await sourceFile.copy(targetUri.toFilePath());
   }
-  for (final pathToModify in filesToModify) {
-    final sourceFile = File.fromUri(testProjectsUri.resolveUri(pathToModify));
-    final targetUri = copyTargetUri.resolveUri(pathToModify);
-    final sourceString = await sourceFile.readAsString();
-    final pubspec = YamlEditor(sourceString);
-    if ((loadYamlNode(sourceString) as Map)['resolution'] != null) {
-      pubspec.remove(['resolution']);
-    }
-    pubspec.update([
-      'dependency_overrides'
-    ], {
+  final dependencyOverrides = {
       'native_assets_cli': {
         'path': sdkRoot
             .resolve('third_party/pkg/native/pkgs/native_assets_cli/')
@@ -125,10 +115,36 @@ Future<void> copyTestProjects(
       'record_use': {
         'path': sdkRoot.resolve('pkg/record_use/').toFilePath(),
       },
-    });
+  };
+  for (final pubspecPath in pubspecPaths) {
+    final sourceFile = File.fromUri(testProjectsUri.resolveUri(pubspecPath));
+    final targetUri = copyTargetUri.resolveUri(pubspecPath);
+    final sourceString = await sourceFile.readAsString();
+    final pubspec = YamlEditor(sourceString);
+    if (!usePubWorkspace) {
+      if ((loadYamlNode(sourceString) as Map)['resolution'] != null) {
+        pubspec.remove(['resolution']);
+      }
+      pubspec.update(['dependency_overrides'], dependencyOverrides);
+    }
     final modifiedString = pubspec.toString();
     await File.fromUri(targetUri).writeAsString(modifiedString);
   }
+  if (usePubWorkspace) {
+    final workspacePubspec = YamlEditor('');
+    workspacePubspec.update([], {
+      'name': 'my_pub_workspace',
+      'environment': {'sdk': '>=3.7.0 <4.0.0'},
+      'workspace': [
+        for (final pubspec in pubspecPaths)
+          if (!pubspec.toFilePath().contains('version_skew'))
+            pubspec.toFilePath().replaceAll('pubspec.yaml', ''),
+      ],
+      'dependency_overrides': dependencyOverrides,
+    });
+    final pubspecUri = copyTargetUri.resolve('pubspec.yaml');
+    await File.fromUri(pubspecUri).writeAsString(workspacePubspec.toString());
+  }
 
   // If we're copying `my_native_library/` we need to simulate that its
   // native assets are pre-built
@@ -198,6 +214,7 @@ Future<void> nativeAssetsTest(
   String packageUnderTest,
   Future<void> Function(Uri) fun, {
   bool skipPubGet = false,
+  bool usePubWorkspace = false,
 }) async =>
     await runPackageTest(
       packageUnderTest,
@@ -218,6 +235,7 @@ Future<void> nativeAssetsTest(
       Platform.script.resolve(
           '../../../../third_party/pkg/native/pkgs/native_assets_builder/'),
       Platform.script.resolve('../../../../'),
+      usePubWorkspace,
     );
 
 Future<void> recordUseTest(
@@ -232,19 +250,22 @@ Future<void> recordUseTest(
       const ['drop_dylib_recording'],
       Platform.script.resolve('../../../record_use/'),
       Platform.script.resolve('../../../../'),
+      false,
     );
 
 Future<void> runPackageTest(
   String packageUnderTest,
   bool skipPubGet,
   Future<void> Function(Uri) fun,
   List<String> validPackages,
-    Uri packageLocation,
-    Uri sdkRoot
+  Uri packageLocation,
+  Uri sdkRoot,
+  bool usePubWorkspace,
 ) async {
   assert(validPackages.contains(packageUnderTest));
   return await inTempDir((tempUri) async {
-    await copyTestProjects(tempUri, logger, packageLocation, sdkRoot);
+    await copyTestProjects(
+        tempUri, logger, packageLocation, sdkRoot, usePubWorkspace);
     final packageUri = tempUri.resolve('$packageUnderTest/');
     if (!skipPubGet) {
       await runPubGet(workingDirectory: packageUri, logger: logger);

pkg/dartdev/test/native_assets/test_test.dart

@@ -24,7 +24,8 @@ void main(List<String> args) async {
     'system_library',
   ]) {
     test('package:$package dart test', timeout: longTimeout, () async {
-      await nativeAssetsTest(package, (packageUri) async {
+      await nativeAssetsTest(package, usePubWorkspace: true,
+          (packageUri) async {
         final result = await runDart(
           arguments: [
             '--enable-experiment=native-assets',
@@ -123,6 +124,7 @@ void main(List<String> args) async {
       );
     });
   });
+
   test(
     'dart test with user defines',
     timeout: longTimeout,