[infra] Prepare to add ffigen, objective_c, swift2objc, and swiftgen to the workspace

.github/workflows/ffigen.yml

@@ -89,8 +89,10 @@ jobs:
           brew: clang-format
       - name: Build test dylib and bindings
         run: dart test/setup.dart
+      - name: Install coverage
+        run: dart pub global activate coverage
       - name: Run VM tests and collect coverage
-        run: dart run coverage:test_with_coverage --scope-output=ffigen --scope-output=objective_c
+        run: dart pub global run coverage:test_with_coverage --scope-output=ffigen --scope-output=objective_c
       - name: Generate package:jni bindings
         run: dart run tool/generate_ffi_bindings.dart
         working-directory: pkgs/jni/

.github/workflows/objective_c.yaml

@@ -60,8 +60,10 @@ jobs:
       - name: Build test dylib
         # TODO(https://github.com/dart-lang/native/issues/1068): Remove this.
         run: dart test/setup.dart
+      - name: Install coverage
+        run: dart pub global activate coverage
       - name: Run VM tests and collect coverage
-        run: dart run coverage:test_with_coverage --scope-output=ffigen --scope-output=objective_c
+        run: dart pub global run coverage:test_with_coverage --scope-output=ffigen --scope-output=objective_c
       - name: Verify generated code is up to date
         # test/generate_code_test.dart runs the code generator, so if there are
         # any git-diffs at this point, it means the generated code is outdated.

.github/workflows/swift2objc.yaml

@@ -55,8 +55,10 @@ jobs:
           sdk: stable
       - name: Install dependencies
         run: dart pub get
+      - name: Install coverage
+        run: dart pub global activate coverage
       - name: Run VM tests and collect coverage
-        run: dart run coverage:test_with_coverage --scope-output=swift2objc
+        run: dart pub global run coverage:test_with_coverage --scope-output=swift2objc
       - name: Upload coverage
         uses: coverallsapp/github-action@648a8eb78e6d50909eff900e4ec85cab4524a45b
         with:

pkgs/ffigen/lib/src/config_provider/config_spec.dart

@@ -141,9 +141,9 @@ class ConfigValue<TE> {
   ) {
     ConfigValue<RE> returnValue;
     if (transform != null) {
-      returnValue = this.withValue(transform.call(this), rawValue);
+      returnValue = withValue(transform.call(this), rawValue);
     } else {
-      returnValue = this.withValue(this.value as RE, rawValue);
+      returnValue = withValue(value as RE, rawValue);
     }
     resultCallback?.call(returnValue);
     return returnValue;

pkgs/ffigen/lib/src/config_provider/overrideable_utils.dart

@@ -41,8 +41,58 @@ final libclangOverridePaths = const <String>[];
 /// Returns the root path of the package, for use during tests.
 ///
 /// Note that `dart test` sets the current directory to the package root.
-final packagePathForTests = p.current;
+final packagePathForTests = _findPackageRoot('ffigen').toFilePath();
 
 /// Returns a path to a config yaml in a unit test.
 String configPathForTest(String directory, String file) =>
     p.join(directory, file);
+
+/// Test files are run in a variety of ways, find this package root in all.
+///
+/// Test files can be run from source from any working directory. The Dart SDK
+/// `tools/test.py` runs them from the root of the SDK for example.
+///
+/// Test files can be run from dill from the root of package. `package:test`
+/// does this.
+///
+/// https://github.com/dart-lang/test/issues/110
+Uri _findPackageRoot(String packageName) {
+  final script = Platform.script;
+  final fileName = script.name;
+  if (fileName.endsWith('.dart')) {
+    // We're likely running from source in the package somewhere.
+    var directory = script.resolve('.');
+    while (true) {
+      final dirName = directory.name;
+      if (dirName == packageName) {
+        return directory;
+      }
+      final parent = directory.resolve('..');
+      if (parent == directory) break;
+      directory = parent;
+    }
+  } else if (fileName.endsWith('.dill')) {
+    // Probably from the package root.
+    final cwd = Directory.current.uri;
+    final dirName = cwd.name;
+    if (dirName == packageName) {
+      return cwd;
+    }
+  }
+  // Or the workspace root.
+  final cwd = Directory.current.uri;
+  final candidate = cwd.resolve('pkgs/$packageName/');
+  if (Directory.fromUri(candidate).existsSync()) {
+    return candidate;
+  }
+  throw StateError(
+    "Could not find package root for package '$packageName'. "
+    'Tried finding the package root via Platform.script '
+    "'${Platform.script.toFilePath()}' and Directory.current "
+    "'${Directory.current.uri.toFilePath()}'.",
+  );
+}
+
+extension on Uri {
+  String get name => pathSegments.where((e) => e != '').last;
+}

pkgs/ffigen/pubspec.yaml

@@ -37,11 +37,10 @@ dependencies:
 
 dev_dependencies:
   async: ^2.11.0
-  coverage: ^1.11.0
   dart_flutter_team_lints: ^2.0.0
   json_schema: ^5.1.1
   leak_tracker: ^10.0.7
-  objective_c: ^7.2.0
+  objective_c: ^8.0.0
   test: ^1.16.2
 
 dependency_overrides:

pkgs/ffigen/test/collision_tests/reserved_keyword_collision_test.dart

@@ -5,6 +5,7 @@
 import 'package:ffigen/src/config_provider.dart';
 import 'package:ffigen/src/header_parser.dart' as parser;
 import 'package:logging/logging.dart';
+import 'package:path/path.dart' as path;
 import 'package:test/test.dart';
 
 import '../test_utils.dart';
@@ -18,7 +19,12 @@ void main() {
       final library = parser.parse(Config(
         output: Uri.file('unused'),
         entryPoints: [
-          Uri.file('test/collision_tests/reserved_keyword_collision.h')
+          Uri.file(path.join(
+            packagePathForTests,
+            'test',
+            'collision_tests',
+            'reserved_keyword_collision.h',
+          ))
         ],
         structDecl: DeclarationFilters.includeAll,
         unionDecl: DeclarationFilters.includeAll,

pkgs/ffigen/test/config_tests/json_schema_test.dart

@@ -10,9 +10,12 @@ import 'package:ffigen/src/strings.dart' as strings;
 import 'package:file/local.dart';
 import 'package:glob/glob.dart';
 import 'package:json_schema/json_schema.dart';
+import 'package:path/path.dart' as path;
 import 'package:test/test.dart';
 import 'package:yaml/yaml.dart';
 
+import '../test_utils.dart';
+
 void main() {
   group('json_schema_test', () {
     final schema = YamlConfig.getsRootConfigSpec()
@@ -24,9 +27,10 @@ void main() {
         YamlConfig.getsRootConfigSpec()
             .generateJsonSchema(strings.ffigenJsonSchemaId),
       );
-      final expectedJsonSchema = File(strings.ffigenJsonSchemaFileName)
-          .readAsStringSync()
-          .replaceAll('\r\n', '\n');
+      final expectedJsonSchema = File(path.join(
+        packagePathForTests,
+        strings.ffigenJsonSchemaFileName,
+      )).readAsStringSync().replaceAll('\r\n', '\n');
       expect(actualJsonSchema, expectedJsonSchema);
     });
 
@@ -37,16 +41,16 @@ void main() {
 
     // Find all ffigen config files in the repo.
     final configYamlGlob = Glob('**config.yaml');
-    final configYamlFiles =
-        configYamlGlob.listFileSystemSync(const LocalFileSystem());
+    final configYamlFiles = configYamlGlob
+        .listFileSystemSync(const LocalFileSystem(), root: packagePathForTests);
     test('$configYamlGlob files not empty', () {
       expect(configYamlFiles.isNotEmpty, true);
     });
 
     final sharedBindingsConfigYamlGlob =
         Glob('example/shared_bindings/ffigen_configs/**.yaml');
     final sharedBindingsConfigYamlFiles = sharedBindingsConfigYamlGlob
-        .listFileSystemSync(const LocalFileSystem());
+        .listFileSystemSync(const LocalFileSystem(), root: packagePathForTests);
     test('$sharedBindingsConfigYamlGlob files not emty', () {
       expect(sharedBindingsConfigYamlFiles.isNotEmpty, true);
     });

pkgs/ffigen/test/example_tests/cjson_example_test.dart

@@ -15,8 +15,12 @@ void main() {
       logWarnings(Level.SEVERE);
     });
     test('c_json', () {
-      final config =
-          testConfigFromPath(path.join('example', 'c_json', 'config.yaml'));
+      final config = testConfigFromPath(path.join(
+        packagePathForTests,
+        'example',
+        'c_json',
+        'config.yaml',
+      ));
       final library = parse(config);
 
       matchLibraryWithExpected(

pkgs/ffigen/test/example_tests/ffinative_example_test.dart

@@ -16,8 +16,12 @@ void main() {
     });
 
     test('ffinative', () {
-      final config =
-          testConfigFromPath(path.join('example', 'ffinative', 'config.yaml'));
+      final config = testConfigFromPath(path.join(
+        packagePathForTests,
+        'example',
+        'ffinative',
+        'config.yaml',
+      ));
       final library = parse(config);
 
       matchLibraryWithExpected(

pkgs/ffigen/test/example_tests/libclang_example_test.dart

@@ -19,9 +19,12 @@ void main() {
       logWarnings(Level.SEVERE);
     });
     test('libclang-example', () {
-      final configYaml =
-          File(path.join('example', 'libclang-example', 'config.yaml'))
-              .absolute;
+      final configYaml = File(path.join(
+        packagePathForTests,
+        'example',
+        'libclang-example',
+        'config.yaml',
+      )).absolute;
       late Config config;
       late Library library;
       withChDir(configYaml.path, () {

pkgs/ffigen/test/example_tests/objective_c_example_test.dart

@@ -20,8 +20,12 @@ void main() {
     });
 
     test('objective_c', () {
-      final config = testConfigFromPath(
-          path.join('example', 'objective_c', 'config.yaml'));
+      final config = testConfigFromPath(path.join(
+        packagePathForTests,
+        'example',
+        'objective_c',
+        'config.yaml',
+      ));
       final output = parse(config).generate();
 
       // Verify that the output contains all the methods and classes that the

pkgs/ffigen/test/example_tests/shared_bindings_example_test.dart

@@ -17,6 +17,7 @@ void main() {
 
     test('a_shared_base bindings', () {
       final config = testConfigFromPath(path.join(
+        packagePathForTests,
         'example',
         'shared_bindings',
         'ffigen_configs',
@@ -33,6 +34,7 @@ void main() {
 
     test('base symbol file output', () {
       final config = testConfigFromPath(path.join(
+        packagePathForTests,
         'example',
         'shared_bindings',
         'ffigen_configs',

pkgs/ffigen/test/example_tests/simple_example_test.dart

@@ -17,6 +17,7 @@ void main() {
 
     test('simple', () {
       final config = testConfigFromPath(path.join(
+        packagePathForTests,
         'example',
         'simple',
         'config.yaml',

pkgs/ffigen/test/example_tests/swift_example_test.dart

@@ -37,13 +37,14 @@ void main() {
             '-o',
             'libswiftapi.dylib',
           ],
-          workingDirectory: path.join(Directory.current.path, 'example/swift'));
+          workingDirectory: path.join(packagePathForTests, 'example/swift'));
       unawaited(stdout.addStream(process.stdout));
       unawaited(stderr.addStream(process.stderr));
       final result = await process.exitCode;
       expect(result, 0);
 
       final config = testConfigFromPath(path.join(
+        packagePathForTests,
         'example',
         'swift',
         'config.yaml',

pkgs/ffigen/test/header_parser_tests/globals_test.dart

@@ -18,7 +18,12 @@ void main() {
       expected = expectedLibrary();
       actual = parser.parse(
         testConfigFromPath(configPath(
-            path.join('test', 'header_parser_tests'), 'globals_config.yaml')),
+            path.join(
+              packagePathForTests,
+              'test',
+              'header_parser_tests',
+            ),
+            'globals_config.yaml')),
       );
     });
 

pkgs/ffigen/test/header_parser_tests/macros_test.dart

@@ -20,7 +20,12 @@ void main() {
       expected = expectedLibrary();
       actual = parser.parse(
         testConfigFromPath(configPath(
-            path.join('test', 'header_parser_tests'), 'macros_config.yaml')),
+            path.join(
+              packagePathForTests,
+              'test',
+              'header_parser_tests',
+            ),
+            'macros_config.yaml')),
       );
     });
     test('Total bindings count', () {

pkgs/ffigen/test/header_parser_tests/sort_test.dart

@@ -5,6 +5,7 @@
 import 'package:ffigen/src/code_generator.dart';
 import 'package:ffigen/src/config_provider.dart';
 import 'package:ffigen/src/header_parser.dart' as parser;
+import 'package:path/path.dart' as path;
 import 'package:test/test.dart';
 
 import '../test_utils.dart';
@@ -17,7 +18,14 @@ void main() {
       logWarnings();
       actual = parser.parse(Config(
         output: Uri.file('unused'),
-        entryPoints: [Uri.file('test/header_parser_tests/sort.h')],
+        entryPoints: [
+          Uri.file(path.join(
+            packagePathForTests,
+            'test',
+            'header_parser_tests',
+            'sort.h',
+          ))
+        ],
         structDecl: DeclarationFilters.includeAll,
         unionDecl: DeclarationFilters.includeAll,
         typedefs: DeclarationFilters.includeAll,

pkgs/ffigen/test/large_integration_tests/large_objc_test.dart

@@ -16,9 +16,12 @@ import 'package:ffigen/ffigen.dart';
 import 'package:ffigen/src/code_generator/utils.dart';
 import 'package:ffigen/src/config_provider/config_types.dart';
 import 'package:logging/logging.dart';
+import 'package:path/path.dart' as path;
 import 'package:pub_semver/pub_semver.dart';
 import 'package:test/test.dart';
 
+import '../test_utils.dart';
+
 Future<int> run(String exe, List<String> args) async {
   final process =
       await Process.start(exe, args, mode: ProcessStartMode.inheritStdio);
@@ -41,14 +44,31 @@ void main() {
               randInclude('$kind.memb', clazz, method),
         );
 
-    const outFile = 'test/large_integration_tests/large_objc_bindings.dart';
-    const outObjCFile = 'test/large_integration_tests/large_objc_bindings.m';
+    final outFile = path.join(
+      packagePathForTests,
+      'test',
+      'large_integration_tests',
+      'large_objc_bindings.dart',
+    );
+    final outObjCFile = path.join(
+      packagePathForTests,
+      'test',
+      'large_integration_tests',
+      'large_objc_bindings.m',
+    );
     final config = Config(
       wrapperName: 'LargeObjCLibrary',
       language: Language.objc,
       output: Uri.file(outFile),
       outputObjC: Uri.file(outObjCFile),
-      entryPoints: [Uri.file('test/large_integration_tests/large_objc_test.h')],
+      entryPoints: [
+        Uri.file(path.join(
+          packagePathForTests,
+          'test',
+          'large_integration_tests',
+          'large_objc_test.h',
+        ))
+      ],
       formatOutput: false,
       includeTransitiveObjCInterfaces: false,
       includeTransitiveObjCProtocols: false,