refactor(cherrypick_generator): migrate inject codegen to code_builder

This commit is contained in:
Sergey Penkovsky
2026-03-02 12:47:02 +03:00
parent 3c550db8cd
commit b7979d653e
9 changed files with 300 additions and 180 deletions

View File

@@ -1,32 +0,0 @@
//
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// https://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import 'package:test/test.dart';
// Import working test suites
import 'simple_test.dart' as simple_tests;
import 'bind_spec_test.dart' as bind_spec_tests;
import 'metadata_utils_test.dart' as metadata_utils_tests;
// Import integration test suites (now working!)
import 'module_generator_test.dart' as module_generator_tests;
import 'inject_generator_test.dart' as inject_generator_tests;
void main() {
group('CherryPick Generator Tests', () {
group('Simple Tests', simple_tests.main);
group('BindSpec Tests', bind_spec_tests.main);
group('MetadataUtils Tests', metadata_utils_tests.main);
group('ModuleGenerator Tests', module_generator_tests.main);
group('InjectGenerator Tests', inject_generator_tests.main);
});
}

View File

@@ -11,9 +11,13 @@
// limitations under the License.
//
import 'dart:isolate';
import 'package:build/build.dart';
import 'package:build_test/build_test.dart';
import 'package:build_runner_core/build_runner_core.dart';
import 'package:cherrypick_generator/inject_generator.dart';
import 'package:package_config/package_config.dart';
import 'package:source_gen/source_gen.dart';
import 'package:test/test.dart';
@@ -40,8 +44,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -75,8 +79,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -113,8 +117,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -124,9 +128,8 @@ part of 'test_widget.dart';
mixin _\$TestWidget {
void _inject(TestWidget instance) {
instance.service = CherryPick.openRootScope().resolve<MyService>(
named: 'myService',
);
instance.service =
CherryPick.openRootScope().resolve<MyService>(named: 'myService');
}
}
''';
@@ -151,8 +154,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -162,9 +165,8 @@ part of 'test_widget.dart';
mixin _\$TestWidget {
void _inject(TestWidget instance) {
instance.service = CherryPick.openRootScope().tryResolve<MyService>(
named: 'myService',
);
instance.service =
CherryPick.openRootScope().tryResolve<MyService>(named: 'myService');
}
}
''';
@@ -191,8 +193,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -229,8 +231,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -240,9 +242,9 @@ part of 'test_widget.dart';
mixin _\$TestWidget {
void _inject(TestWidget instance) {
instance.service = CherryPick.openScope(
scopeName: 'userScope',
).resolve<MyService>(named: 'myService');
instance.service =
CherryPick.openScope(scopeName: 'userScope')
.resolve<MyService>(named: 'myService');
}
}
''';
@@ -268,8 +270,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -303,8 +305,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -339,8 +341,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -350,9 +352,8 @@ part of 'test_widget.dart';
mixin _\$TestWidget {
void _inject(TestWidget instance) {
instance.service = CherryPick.openRootScope().resolveAsync<MyService>(
named: 'myService',
);
instance.service =
CherryPick.openRootScope().resolveAsync<MyService>(named: 'myService');
}
}
''';
@@ -391,8 +392,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -403,13 +404,11 @@ part of 'test_widget.dart';
mixin _\$TestWidget {
void _inject(TestWidget instance) {
instance.apiService = CherryPick.openRootScope().resolve<ApiService>();
instance.cacheService = CherryPick.openRootScope().tryResolve<CacheService>(
named: 'cache',
);
instance.cacheService =
CherryPick.openRootScope().tryResolve<CacheService>(named: 'cache');
instance.dbService =
CherryPick.openScope(
scopeName: 'dbScope',
).resolveAsync<DatabaseService>();
CherryPick.openScope(scopeName: 'dbScope')
.resolveAsync<DatabaseService>();
}
}
''';
@@ -439,8 +438,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -496,8 +495,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -533,8 +532,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -569,8 +568,8 @@ class TestWidget {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_widget.dart';
@@ -593,10 +592,41 @@ mixin _\$TestWidget {
/// Helper function to test code generation
Future<void> _testGeneration(String input, String expectedOutput) async {
await testBuilder(
final readerWriter = TestReaderWriter(rootPackage: 'a');
await readerWriter.testing.loadIsolateSources();
final packageConfig = await loadPackageConfigUri(
(await Isolate.packageConfig)!,
);
final outputs = expectedOutput.isEmpty
? null
: {
'a|lib/test_widget.inject.cherrypick.g.dart':
decodedMatches(_normalizedEquals(expectedOutput)),
};
final result = await testBuilder(
injectBuilder(BuilderOptions.empty),
{'a|lib/test_widget.dart': input},
outputs: {'a|lib/test_widget.inject.cherrypick.g.dart': expectedOutput},
readerWriter: TestReaderWriter(),
outputs: outputs,
readerWriter: readerWriter,
rootPackage: 'a',
packageConfig: packageConfig,
);
if (expectedOutput.isEmpty && result.buildResult.status == BuildStatus.failure) {
throw InvalidGenerationSourceError('Build failed');
}
}
Matcher _normalizedEquals(String expected) {
return predicate<String>(
(actual) => _normalize(actual) == _normalize(expected),
'matches after normalization',
);
}
String _normalize(String input) {
return input
.replaceAll(RegExp(r'\s+'), '')
.replaceAll(RegExp(r',\)'), ')')
.replaceAll(RegExp(r',\]'), ']')
.replaceAll(RegExp(r',\}'), '}');
}

View File

@@ -11,12 +11,16 @@
// limitations under the License.
//
import 'package:test/test.dart';
import 'package:build_test/build_test.dart';
import 'package:build/build.dart';
import 'dart:isolate';
import 'package:build/build.dart';
import 'package:build_test/build_test.dart';
import 'package:build_runner_core/build_runner_core.dart';
import 'package:package_config/package_config.dart';
import 'package:test/test.dart';
import 'package:cherrypick_generator/module_generator.dart';
import 'package:source_gen/source_gen.dart';
import 'package:cherrypick_generator/module_generator.dart';
void main() {
group('ModuleGenerator Tests', () {
@@ -40,8 +44,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -75,8 +79,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -113,8 +117,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -149,8 +153,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -187,8 +191,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -224,8 +228,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -264,8 +268,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -299,8 +303,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -334,8 +338,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -374,8 +378,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -414,8 +418,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -453,8 +457,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -488,8 +492,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -541,8 +545,8 @@ abstract class TestModule extends Module {
''';
const expectedOutput = '''
// dart format width=80
// GENERATED CODE - DO NOT MODIFY BY HAND
// dart format width=80
part of 'test_module.dart';
@@ -637,10 +641,41 @@ abstract class TestModule extends Module {
/// Helper function to test code generation
Future<void> _testGeneration(String input, String expectedOutput) async {
await testBuilder(
final readerWriter = TestReaderWriter(rootPackage: 'a');
await readerWriter.testing.loadIsolateSources();
final packageConfig = await loadPackageConfigUri(
(await Isolate.packageConfig)!,
);
final outputs = expectedOutput.isEmpty
? null
: {
'a|lib/test_module.module.cherrypick.g.dart':
decodedMatches(_normalizedEquals(expectedOutput)),
};
final result = await testBuilder(
moduleBuilder(BuilderOptions.empty),
{'a|lib/test_module.dart': input},
outputs: {'a|lib/test_module.module.cherrypick.g.dart': expectedOutput},
readerWriter: TestReaderWriter(),
outputs: outputs,
readerWriter: readerWriter,
rootPackage: 'a',
packageConfig: packageConfig,
);
if (expectedOutput.isEmpty && result.buildResult.status == BuildStatus.failure) {
throw InvalidGenerationSourceError('Build failed');
}
}
Matcher _normalizedEquals(String expected) {
return predicate<String>(
(actual) => _normalize(actual) == _normalize(expected),
'matches after normalization',
);
}
String _normalize(String input) {
return input
.replaceAll(RegExp(r'\s+'), '')
.replaceAll(RegExp(r',\)'), ')')
.replaceAll(RegExp(r',\]'), ']')
.replaceAll(RegExp(r',\}'), '}');
}