[native_assets_cli] Refactor testCodeBuildHook (#2242)

Author: dcharkes

pkgs/native_assets_builder/lib/src/build_runner/build_runner.dart

@@ -150,7 +150,7 @@ class NativeAssetsBuildRunner {
         userDefines: loadedUserDefines?[package.name],
       );
 
-      final input = BuildInput(inputBuilder.json);
+      final input = inputBuilder.build();
       final errors = [
         ...await validateBuildInput(input),
         for (final e in extensions) ...await e.validateBuildInput(input),
@@ -256,7 +256,7 @@ class NativeAssetsBuildRunner {
         recordedUsesFile: resourcesFile?.uri,
       );
 
-      final input = LinkInput(inputBuilder.json);
+      final input = inputBuilder.build();
       final errors = [
         ...await validateLinkInput(input),
         for (final e in extensions) ...await e.validateLinkInput(input),

pkgs/native_assets_builder/test/test_data/native_dynamic_linking_test.dart

@@ -10,7 +10,6 @@ import 'dart:io';
 
 import 'package:native_assets_cli/code_assets.dart';
 import 'package:native_assets_cli/code_assets_builder.dart';
-import 'package:native_assets_cli/native_assets_cli.dart';
 import 'package:native_assets_cli/native_assets_cli_builder.dart';
 import 'package:test/test.dart';
 
@@ -60,7 +59,7 @@ void main() async {
       File.fromUri(
         buildInputUri,
       ).writeAsStringSync(jsonEncode(inputBuilder.json));
-      outputDirectory = BuildInput(inputBuilder.json).outputDirectory;
+      outputDirectory = inputBuilder.build().outputDirectory;
 
       await runPubGet(workingDirectory: testPackageUri, logger: logger);
 

pkgs/native_assets_builder/test_data/native_add_duplicate/hook/build.dart

@@ -6,7 +6,6 @@ import 'package:logging/logging.dart';
 import 'package:native_assets_cli/code_assets.dart';
 import 'package:native_assets_cli/code_assets_builder.dart';
 import 'package:native_assets_cli/native_assets_cli.dart';
-import 'package:native_assets_cli/native_assets_cli_builder.dart';
 import 'package:native_toolchain_c/native_toolchain_c.dart';
 
 void main(List<String> arguments) async {
@@ -30,7 +29,7 @@ void main(List<String> arguments) async {
               print('${record.level.name}: ${record.time}: ${record.message}');
             }),
     );
-    final tempBuildOutput = BuildOutput(outputBuilder.json);
+    final tempBuildOutput = outputBuilder.build();
     output.assets.code.add(
       tempBuildOutput.assets.code.single,
       // Send dylib to linking if linking is enabled.

pkgs/native_assets_cli/example/build/download_asset/tool/build.dart

@@ -100,5 +100,5 @@ BuildInput createBuildInput(
             macOS: MacOSCodeConfig(targetVersion: macOSTargetVersion),
           ),
         );
-  return BuildInput(inputBuilder.json);
+  return inputBuilder.build();
 }

pkgs/native_assets_cli/example/build/local_asset/pubspec.yaml

@@ -16,5 +16,6 @@ dependencies:
 
 dev_dependencies:
   ffigen: ^18.0.0
+  file_testing: ^3.0.2
   lints: ^5.1.1
   test: ^1.25.15

pkgs/native_assets_cli/example/build/local_asset/test/build_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.
 
+import 'dart:io';
+
+import 'package:file_testing/file_testing.dart';
 import 'package:native_assets_cli/code_assets_builder.dart';
 import 'package:native_assets_cli/code_assets_testing.dart';
 import 'package:test/test.dart';
@@ -12,9 +15,15 @@ void main() async {
   test('test my build hook', () async {
     await testCodeBuildHook(
       mainMethod: build.main,
-      check: (_, output) {
+      check: (input, output) {
+        expect(output.assets.encodedAssets.length, equals(1));
         expect(output.assets.code, isNotEmpty);
         expect(output.assets.code.first.id, 'package:local_asset/asset.txt');
+        expect(File.fromUri(output.assets.code.first.file!), exists);
+        expect(
+          output.dependencies,
+          equals([input.packageRoot.resolve('assets/asset.txt')]),
+        );
       },
     );
   });

pkgs/native_assets_cli/lib/code_assets_builder.dart

@@ -6,5 +6,5 @@
 library;
 
 export 'src/code_assets/config.dart'
-    show CodeAssetBuildInputBuilder, CodeAssetBuildOutput, CodeAssetLinkOutput;
+    show CodeAssetBuildOutput, CodeAssetLinkOutput;
 export 'src/code_assets/extension.dart';

pkgs/native_assets_cli/lib/test.dart renamed to pkgs/native_assets_cli/lib/native_assets_cli_testing.dart

@@ -182,7 +182,6 @@ extension type CodeAssetLinkOutputBuilderAdd._(
 
 /// Extension to initialize code specific configuration on link/build inputs.
 extension CodeAssetBuildInputBuilder on HookConfigBuilder {
-  @Deprecated('Prefer using input.addExtension(CodeExtension(...)).')
   void setupCode({
     required Architecture targetArchitecture,
     required OS targetOS,

pkgs/native_assets_cli/lib/src/code_assets/config.dart

@@ -46,7 +46,6 @@ final class CodeAssetExtension implements ProtocolExtension {
 
   void _setupConfig(HookInputBuilder input) {
     input.config.addBuildAssetTypes([CodeAssetType.type]);
-    // ignore: deprecated_member_use_from_same_package
     input.config.setupCode(
       targetArchitecture: targetArchitecture,
       targetOS: targetOS,

pkgs/native_assets_cli/lib/src/code_assets/extension.dart

@@ -5,8 +5,9 @@
 import 'dart:async';
 
 import '../config.dart';
+import '../encoded_asset.dart';
 import '../test.dart';
-import '../validation.dart';
+import '../user_defines.dart';
 import 'architecture.dart';
 import 'c_compiler_config.dart';
 import 'config.dart';
@@ -15,8 +16,9 @@ import 'ios_sdk.dart';
 import 'link_mode_preference.dart';
 import 'os.dart';
 
-/// Validate a code build hook; this will throw an exception on validation
-/// errors.
+/// Validates a code build hook.
+///
+/// This method will throw an exception on validation errors.
 ///
 /// This is intended to be used from tests, e.g.:
 ///
@@ -27,25 +29,33 @@ import 'os.dart';
 ///   );
 /// });
 /// ```
+///
+/// The hook is run in isolation. No user-defines are read from the pubspec,
+/// they must be provided via [userDefines]. No other hooks are run, if the hook
+/// requires assets from other build hooks, the must be provided in [assets].
 Future<void> testCodeBuildHook({
-  // ignore: inference_failure_on_function_return_type
-  required Function(List<String> arguments) mainMethod,
+  required FutureOr<void> Function(List<String> arguments) mainMethod,
   required FutureOr<void> Function(BuildInput, BuildOutput) check,
+  bool? linkingEnabled,
   Architecture? targetArchitecture,
   OS? targetOS,
-  IOSSdk? targetIOSSdk,
-  int? targetIOSVersion,
-  int? targetMacOSVersion,
-  int? targetAndroidNdkApi,
+  IOSSdk? targetIOSSdk = IOSSdk.iPhoneOS,
+  int? targetIOSVersion = 17,
+  int? targetMacOSVersion = 13,
+  int? targetAndroidNdkApi = 30,
   CCompilerConfig? cCompiler,
-  LinkModePreference? linkModePreference,
-  bool? linkingEnabled,
+  LinkModePreference? linkModePreference = LinkModePreference.dynamic,
+  // TODO(https://github.com/dart-lang/native/issues/2241): Cleanup how the
+  // following parameters are passed in.
+  PackageUserDefines? userDefines,
+  Map<String, List<EncodedAsset>>? assets,
 }) async {
+  targetOS ??= OS.current;
   final extension = CodeAssetExtension(
-    linkModePreference: linkModePreference ?? LinkModePreference.dynamic,
+    linkModePreference: linkModePreference!,
     cCompiler: cCompiler,
     targetArchitecture: targetArchitecture ?? Architecture.current,
-    targetOS: targetOS ?? OS.current,
+    targetOS: targetOS,
     iOS: targetOS == OS.iOS
         ? IOSCodeConfig(
             targetSdk: targetIOSSdk!,
@@ -61,22 +71,10 @@ Future<void> testCodeBuildHook({
   );
   await testBuildHook(
     mainMethod: mainMethod,
-    extraInputSetup: (input) {
-      input.addExtension(extension);
-    },
-    check: (input, output) async {
-      final validationErrors = await extension.validateBuildOutput(
-        input,
-        output,
-      );
-      if (validationErrors.isNotEmpty) {
-        throw ValidationFailure(
-          'encountered build output validation issues: $validationErrors',
-        );
-      }
-
-      await check(input, output);
-    },
+    check: check,
     linkingEnabled: linkingEnabled,
+    userDefines: userDefines,
+    assets: assets,
+    extensions: [extension],
   );
 }

pkgs/native_assets_cli/lib/src/code_assets/testing.dart

@@ -152,11 +152,6 @@ sealed class HookInputBuilder {
   void setupShared({
     required Uri packageRoot,
     required String packageName,
-    @Deprecated(
-      'This parameter is not read in `HookInput`. '
-      'It must still be provided to accommodate `HookInput`s in hooks using an '
-      'older version of this package.',
-    )
     required Uri outputDirectoryShared,
     required Uri outputFile,
     PackageUserDefines? userDefines,
@@ -264,6 +259,8 @@ final class BuildInputBuilder extends HookInputBuilder {
   @override
   void addExtension(ProtocolExtension extension) =>
       extension.setupBuildInput(this);
+
+  BuildInput build() => BuildInput(json);
 }
 
 final class HookConfigBuilder {
@@ -337,6 +334,8 @@ final class LinkInputBuilder extends HookInputBuilder {
   @override
   void addExtension(ProtocolExtension extension) =>
       extension.setupLinkInput(this);
+
+  LinkInput build() => LinkInput(json);
 }
 
 List<EncodedAsset> _parseAssets(List<AssetSyntax>? assets) => assets == null
@@ -476,6 +475,8 @@ class BuildOutputBuilder extends HookOutputBuilder {
   @override
   BuildOutputSyntax get _syntax =>
       BuildOutputSyntax.fromJson(super._syntax.json);
+
+  BuildOutput build() => BuildOutput(json);
 }
 
 extension type MetadataOutputBuilder._(BuildOutputBuilder _output) {
@@ -655,6 +656,8 @@ extension type LinkOutputAssets._(LinkOutput _output) {
 class LinkOutputBuilder extends HookOutputBuilder {
   EncodedAssetLinkOutputBuilder get assets =>
       EncodedAssetLinkOutputBuilder._(this);
+
+  LinkOutput build() => LinkOutput(json);
 }
 
 /// Extension for the lower-level API to add [EncodedAsset]s to

pkgs/native_assets_cli/lib/src/config.dart

@@ -9,25 +9,39 @@ import 'dart:io';
 import 'package:yaml/yaml.dart';
 
 import 'config.dart';
+import 'encoded_asset.dart';
+import 'extension.dart';
+import 'user_defines.dart';
 import 'validation.dart';
 
-/// Validate a build hook; this will throw an exception on validation errors.
+/// Validates a build hook.
+///
+/// This method will throw an exception on validation errors.
 ///
 /// This is intended to be used from tests, e.g.:
 ///
 /// ```
 /// test('test my build hook', () async {
-///   await testCodeBuildHook(
+///   await testBuildHook(
 ///     ...
 ///   );
 /// });
 /// ```
+///
+/// The hook is run in isolation. No user-defines are read from the pubspec,
+/// they must be provided via [userDefines]. No other hooks are run, if the hook
+/// requires assets from other build hooks, the must be provided in [assets].
 Future<void> testBuildHook({
-  required void Function(BuildInputBuilder) extraInputSetup,
   required FutureOr<void> Function(List<String> arguments) mainMethod,
   required FutureOr<void> Function(BuildInput input, BuildOutput output) check,
   bool? linkingEnabled,
+  required List<ProtocolExtension> extensions,
+  // TODO(https://github.com/dart-lang/native/issues/2241): Cleanup how the
+  // following parameters are passed in.
+  PackageUserDefines? userDefines,
+  Map<String, List<EncodedAsset>>? assets,
 }) async {
+  linkingEnabled ??= false;
   const keepTempKey = 'KEEP_TEMPORARY_DIRECTORIES';
 
   final tempDir = await Directory.systemTemp.createTemp();
@@ -37,11 +51,9 @@ Future<void> testBuildHook({
     final tempUri = Directory(
       await tempDir.resolveSymbolicLinks(),
     ).uri.normalizePath();
-    final outputDirectory = tempUri.resolve('output/');
     final outputDirectoryShared = tempUri.resolve('output_shared/');
     final outputFile = tempUri.resolve('output.json');
 
-    await Directory.fromUri(outputDirectory).create();
     await Directory.fromUri(outputDirectoryShared).create();
 
     final inputBuilder = BuildInputBuilder();
@@ -51,26 +63,45 @@ Future<void> testBuildHook({
         packageName: _readPackageNameFromPubspec(),
         outputFile: outputFile,
         outputDirectoryShared: outputDirectoryShared,
+        userDefines: userDefines,
       )
-      ..config.setupBuild(linkingEnabled: true);
-    extraInputSetup(inputBuilder);
+      ..setupBuildInput(assets: assets)
+      ..config.setupBuild(linkingEnabled: linkingEnabled);
+    for (final extension in extensions) {
+      extension.setupBuildInput(inputBuilder);
+    }
+    final input = inputBuilder.build();
 
-    final input = BuildInput(inputBuilder.json);
+    final inputErrors = [
+      for (final extension in extensions)
+        ...await extension.validateBuildInput(input),
+    ];
+    if (inputErrors.isNotEmpty) {
+      throw ValidationFailure(
+        'Encountered build input validation issues: $inputErrors',
+      );
+    }
 
     final inputUri = tempUri.resolve('input.json');
     _writeJsonTo(inputUri, input.json);
     await mainMethod(['--config=${inputUri.toFilePath()}']);
     final output = BuildOutput(_readJsonFrom(input.outputFile));
 
-    // Test conformance of protocol invariants.
-    final validationErrors = await validateBuildOutput(input, output);
-    if (validationErrors.isNotEmpty) {
+    final outputErrors = [
+      ...await validateBuildOutput(input, output),
+      for (final extension in extensions) ...[
+        ...await extension.validateBuildOutput(input, output),
+        ...await extension.validateApplicationAssets(
+          output.assets.encodedAssets,
+        ),
+      ],
+    ];
+    if (outputErrors.isNotEmpty) {
       throw ValidationFailure(
-        'encountered build output validation issues: $validationErrors',
+        'Encountered build output validation issues: $inputErrors',
       );
     }
 
-    // Run user-defined tests.
     await check(input, output);
   } finally {
     final keepTempDir = (Platform.environment[keepTempKey] ?? '').isNotEmpty;

pkgs/native_assets_cli/lib/src/test.dart

@@ -39,7 +39,7 @@ void main() async {
         outputDirectoryShared: outputDirectoryShared,
       )
       ..config.setupBuild(linkingEnabled: false);
-    input = BuildInput(inputBuilder.json);
+    input = inputBuilder.build();
 
     final inputJson = json.encode(input.json);
     buildInputUri = tempUri.resolve('input.json');

pkgs/native_assets_cli/test/api/build_test.dart

@@ -73,7 +73,7 @@ void main() async {
       ..config.addBuildAssetTypes(['my-asset-type'])
       ..config.setupBuild(linkingEnabled: false)
       ..setupBuildInput(assets: assets);
-    final input = BuildInput(inputBuilder.json);
+    final input = inputBuilder.build();
 
     expect(input.json, inputJson);
     expect(json.decode(input.toString()), inputJson);