Generator: switch to new build_test 3 APIs #152

greenrobot-team · greenrobot-team · commit 327e866036b1 · 2025-09-02T11:48:36.000+02:00
diff --git a/generator/build.yaml b/generator/build.yaml
@@ -29,9 +29,10 @@ builders:
     builder_factories: ["codeGeneratorFactory"]
     # build_extensions: Required. A map from input extension to the list of output extensions that may be created
     # for that input. This must match the merged buildExtensions maps from each Builder in builder_factories.
+    # See notes on CodeBuilder.buildExtensions.
     build_extensions:
       "$lib$": ["objectbox.g.dart"]
-      "$test": ["objectbox.g.dart"]
+      "$test$": ["objectbox.g.dart"]
     required_inputs: ['.objectbox.info']
     auto_apply: dependents
     build_to: source
diff --git a/generator/lib/src/builder_dirs.dart b/generator/lib/src/builder_dirs.dart
@@ -1,4 +1,3 @@
-import 'package:build/build.dart';
 import 'package:path/path.dart' as path;
 
 import 'config.dart';
@@ -12,11 +11,15 @@ class BuilderDirs {
 
   BuilderDirs._(this.root, this.out);
 
-  factory BuilderDirs(BuildStep buildStep, Config config) {
+  /// For [pathInSourceRoot] expects the path to a file in the source root
+  /// directory (currently only lib or test are supported). It's used to
+  /// determine the [root] source path and [out] path for generated code.
+  /// A [config] may customize the [out] path relative to [root].
+  factory BuilderDirs(String pathInSourceRoot, Config config) {
     // Paths from Config are supplied by the user and may contain duplicate
     // slashes or be empty: normalize all paths to not return duplicate or
     // trailing slashes to ensure they can be compared via strings.
-    final root = path.normalize(path.dirname(buildStep.inputId.path));
+    final root = path.normalize(path.dirname(pathInSourceRoot));
     final String out;
     if (root.endsWith('test')) {
       out = path.normalize('$root/${config.outDirTest}');
diff --git a/generator/lib/src/code_builder.dart b/generator/lib/src/code_builder.dart
@@ -29,13 +29,17 @@ class CodeBuilder extends Builder {
 
   @override
   late final buildExtensions = {
+    // lib/$lib$ and test/$test$ are placeholder files of build_runner which are
+    // used as there is no clear primary input file for this builder.
     r'$lib$': [path.join(_config.outDirLib, _config.codeFile)],
     r'$test$': [path.join(_config.outDirTest, _config.codeFile)]
   };
 
   @override
   FutureOr<void> build(BuildStep buildStep) async {
-    final builderDirs = BuilderDirs(buildStep, _config);
+    // This is only called twice, once with path lib/$lib$ and once with test/$test$
+    final inputFilePath = buildStep.inputId.path;
+    final builderDirs = BuilderDirs(inputFilePath, _config);
 
     // build() will be called only twice, once for the `lib` directory and once for the `test` directory
     // map from file name to a 'json' representation of entities
diff --git a/generator/pubspec.yaml b/generator/pubspec.yaml
@@ -11,7 +11,7 @@ environment:
 dependencies:
   objectbox: 4.3.0
   analyzer: '>=6.5.0 <8.0.0' # dart_style 2.3.7 requires 6.5.0
-  build: '>=2.4.1 <2.5.0' # 2.5.0 has breaking changes for code_builder_test.dart, adapt before allowing
+  build: ^2.5.0 # TODO Tighten further as Dart 3.7.0 is required by build_test anyhow?
   collection: ^1.18.0 # Would require 1.19.1, but Flutter 3.24.0 has 1.18.0 pinned
   dart_style: '>=2.3.7 <4.0.0' # require 2.3.7 for languageVersion in DartFormatter constructor
   glob: ^2.1.3
@@ -27,4 +27,6 @@ dev_dependencies:
   lints: ^3.0.0
   pub_semver: ^2.2.0
   package_config: ^2.2.0
-  build_test: ^2.2.2
+  build_test: ^3.0.0
+  build_runner_core: ^9.0.0
+  logging: ^1.3.0
diff --git a/generator/test/code_builder_test.dart b/generator/test/code_builder_test.dart
@@ -1,120 +1,100 @@
-import 'dart:async';
+import 'dart:io';
 
-import 'package:build/build.dart';
-import 'package:build/src/builder/build_step_impl.dart';
-import 'package:build_test/build_test.dart';
+import 'package:build_runner_core/build_runner_core.dart';
+import 'package:logging/logging.dart';
 import 'package:objectbox/internal.dart';
 import 'package:objectbox_generator/src/builder_dirs.dart';
 import 'package:objectbox_generator/src/code_builder.dart';
 import 'package:objectbox_generator/src/config.dart';
-import 'package:package_config/package_config.dart';
 import 'package:path/path.dart' as path;
 import 'package:source_gen/source_gen.dart';
 import 'package:test/test.dart';
 
 import 'generator_test_env.dart';
 
 void main() {
-  var reader = StubAssetReader();
-  var writer = StubAssetWriter();
-  final resourceManager = ResourceManager();
-  // Default directory structure: sources inside lib folder.
-  final testBuildStep = BuildStepImpl(
-      AssetId("objectbox_generator_test", "lib/\$lib\$"),
-      [],
-      reader,
-      writer,
-      null,
-      resourceManager,
-      _unsupported);
+  // lib/$lib$ is a placeholder file of build_runner, it's one of the two
+  // input files used by CodeBuilder.
+  final inputPathLib = 'lib/\$lib\$';
 
   group('getRootDir and getOutDir', () {
-    test('lib', () {
-      final builderDirs = BuilderDirs(testBuildStep, Config());
+    test('lib', () async {
+      final builderDirs = BuilderDirs(inputPathLib, Config());
       expect(builderDirs.root, equals('lib'));
       expect(builderDirs.out, equals('lib'));
     });
 
-    test('test', () {
-      final testBuildStepTest = BuildStepImpl(
-          AssetId("objectbox_generator_test", "test/\$test\$"),
-          [],
-          reader,
-          writer,
-          null,
-          resourceManager,
-          _unsupported);
-      final builderDirs = BuilderDirs(testBuildStepTest, Config());
+    test('test', () async {
+      // test/$test$ is a placeholder file of build_runner, it's the other one
+      // of the two input files used by CodeBuilder.
+      final inputPathTest = 'test/\$test\$';
+      final builderDirs = BuilderDirs(inputPathTest, Config());
       expect(builderDirs.root, equals('test'));
       expect(builderDirs.out, equals('test'));
     });
 
     test('not supported', () {
-      final testBuildStepNotSupported = BuildStepImpl(
-          AssetId("objectbox_generator_test", "custom/\$custom\$"),
-          [],
-          reader,
-          writer,
-          null,
-          resourceManager,
-          _unsupported);
+      // For completeness, test an unsupported input file path.
+      // Currently, CodeBuilder (and therefore BuilderDirs) never gets called
+      // with one as its buildExtensions restricts it to the special placeholder
+      // files $lib$ and $test$ (see tests above).
+      final customPath = 'lib/custom/custom.dart';
       expect(
-          () => BuilderDirs(testBuildStepNotSupported, Config()),
-          throwsA(predicate((e) =>
-              e is ArgumentError &&
-              e.message == 'Is not lib or test directory: "custom"')));
+          () => BuilderDirs(customPath, Config()),
+          throwsA(isA<ArgumentError>().having((e) => e.message, 'message',
+              'Is not lib or test directory: "lib${Platform.pathSeparator}custom"')));
     });
 
     test('out dir with redundant slash', () {
-      final builderDirs = BuilderDirs(testBuildStep, Config(outDirLib: '/'));
+      final builderDirs = BuilderDirs(inputPathLib, Config(outDirLib: '/'));
       expect(builderDirs.root, equals('lib'));
       expect(builderDirs.out, equals(path.normalize('lib')));
     });
 
     test('out dir not in root dir', () {
       final builderDirs =
-          BuilderDirs(testBuildStep, Config(outDirLib: '../sibling'));
+          BuilderDirs(inputPathLib, Config(outDirLib: '../sibling'));
       expect(builderDirs.root, equals('lib'));
       expect(builderDirs.out, equals(path.normalize('sibling')));
     });
 
     test('out dir below root dir', () {
       final builderDirs =
-          BuilderDirs(testBuildStep, Config(outDirLib: 'below/root'));
+          BuilderDirs(inputPathLib, Config(outDirLib: 'below/root'));
       expect(builderDirs.root, equals('lib'));
       expect(builderDirs.out, equals(path.normalize('lib/below/root')));
     });
   });
 
   group('getPrefixFor', () {
     test('out dir is root dir', () {
-      expect(CodeBuilder.getPrefixFor(BuilderDirs(testBuildStep, Config())),
+      expect(CodeBuilder.getPrefixFor(BuilderDirs(inputPathLib, Config())),
           equals(''));
     });
 
     test('out dir redundant slash', () {
       expect(
           CodeBuilder.getPrefixFor(
-              BuilderDirs(testBuildStep, Config(outDirLib: '/'))),
+              BuilderDirs(inputPathLib, Config(outDirLib: '/'))),
           equals(''));
       expect(
           CodeBuilder.getPrefixFor(
-              BuilderDirs(testBuildStep, Config(outDirLib: '//below/'))),
+              BuilderDirs(inputPathLib, Config(outDirLib: '//below/'))),
           equals('../'));
     });
 
     test('out dir not in root dir', () {
       expect(
           () => CodeBuilder.getPrefixFor(
-              BuilderDirs(testBuildStep, Config(outDirLib: '../sibling'))),
+              BuilderDirs(inputPathLib, Config(outDirLib: '../sibling'))),
           throwsA(predicate((e) =>
               e is InvalidGenerationSourceError &&
               e.message
                   .contains("is not a subdirectory of the source directory"))));
 
       expect(
           () => CodeBuilder.getPrefixFor(
-              BuilderDirs(testBuildStep, Config(outDirLib: '../../above'))),
+              BuilderDirs(inputPathLib, Config(outDirLib: '../../above'))),
           throwsA(predicate((e) =>
               e is InvalidGenerationSourceError &&
               e.message
@@ -124,11 +104,11 @@ void main() {
     test('out dir below root dir', () {
       expect(
           CodeBuilder.getPrefixFor(
-              BuilderDirs(testBuildStep, Config(outDirLib: 'below'))),
+              BuilderDirs(inputPathLib, Config(outDirLib: 'below'))),
           equals('../'));
       expect(
           CodeBuilder.getPrefixFor(
-              BuilderDirs(testBuildStep, Config(outDirLib: 'below/lower'))),
+              BuilderDirs(inputPathLib, Config(outDirLib: 'below/lower'))),
           equals('../../'));
     });
   });
@@ -186,10 +166,15 @@ void main() {
         }
         ''';
 
-        await expectLater(
-            () async => await testEnv.run(source),
-            throwsA(isA<InvalidGenerationSourceError>().having((e) => e.message,
-                'message', contains("@Index/@Unique is not supported"))));
+        final result = await testEnv.run(source, expectNoOutput: true);
+
+        expect(result.builderResult.buildResult.status, BuildStatus.failure);
+        expect(
+            result.logs,
+            contains(isA<LogRecord>()
+                .having((r) => r.level, 'level', Level.SEVERE)
+                .having((r) => r.message, 'message',
+                    contains('@Index/@Unique is not supported'))));
       }
 
       // floating point types
@@ -259,13 +244,20 @@ void main() {
       ''';
 
       final testEnv = GeneratorTestEnv();
-      await expectLater(
-          () async => await testEnv.run(source),
-          throwsA(isA<InvalidGenerationSourceError>().having(
-              (e) => e.message,
-              'message',
-              contains(
-                  "@HnswIndex is only supported for float vector properties."))));
+      final result = await testEnv.run(source, expectNoOutput: true);
+
+      expect(result.builderResult.buildResult.status, BuildStatus.failure);
+      expect(
+        result.logs,
+        contains(isA<LogRecord>()
+            .having((r) => r.level, 'level', Level.SEVERE)
+            .having(
+                (r) => r.message,
+                'message',
+                contains(
+                  '@HnswIndex is only supported for float vector properties.',
+                ))),
+      );
     });
 
     test('HNSW annotation default', () async {
@@ -465,7 +457,3 @@ void main() {
     });
   });
 }
-
-Future<PackageConfig> _unsupported() {
-  return Future.error(UnsupportedError('stub'));
-}
diff --git a/generator/test/generator_test_env.dart b/generator/test/generator_test_env.dart
