// Copyright 2014 The Flutter Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. import 'package:file/file.dart'; import 'package:file/memory.dart'; import 'package:file_testing/file_testing.dart'; import 'package:flutter_tools/src/android/native_assets.dart'; import 'package:flutter_tools/src/artifacts.dart'; import 'package:flutter_tools/src/base/common.dart'; import 'package:flutter_tools/src/base/file_system.dart'; import 'package:flutter_tools/src/base/logger.dart'; import 'package:flutter_tools/src/base/platform.dart'; import 'package:flutter_tools/src/build_info.dart'; import 'package:flutter_tools/src/build_system/build_system.dart'; import 'package:flutter_tools/src/features.dart'; import 'package:flutter_tools/src/globals.dart' as globals; import 'package:native_assets_cli/native_assets_cli_internal.dart' as native_assets_cli; import 'package:native_assets_cli/native_assets_cli_internal.dart' hide BuildMode, Target; import 'package:package_config/package_config_types.dart'; import '../../src/common.dart'; import '../../src/context.dart'; import '../../src/fakes.dart'; import '../fake_native_assets_build_runner.dart'; void main() { late FakeProcessManager processManager; late Environment environment; late Artifacts artifacts; late FileSystem fileSystem; late BufferLogger logger; late Uri projectUri; setUp(() { processManager = FakeProcessManager.empty(); logger = BufferLogger.test(); artifacts = Artifacts.test(); fileSystem = MemoryFileSystem.test(); environment = Environment.test( fileSystem.currentDirectory, inputs: {}, artifacts: artifacts, processManager: processManager, fileSystem: fileSystem, logger: logger, ); environment.buildDir.createSync(recursive: true); projectUri = environment.projectDir.uri; }); testUsingContext('dry run with no package config', overrides: { ProcessManager: () => FakeProcessManager.empty(), }, () async { expect( await dryRunNativeAssetsAndroid( projectUri: projectUri, fileSystem: fileSystem, buildRunner: FakeNativeAssetsBuildRunner( hasPackageConfigResult: false, ), ), null, ); expect( (globals.logger as BufferLogger).traceText, contains('No package config found. Skipping native assets compilation.'), ); }); testUsingContext('build with no package config', overrides: { ProcessManager: () => FakeProcessManager.empty(), }, () async { await buildNativeAssetsAndroid( androidArchs: [AndroidArch.arm64_v8a], targetAndroidNdkApi: 21, projectUri: projectUri, buildMode: BuildMode.debug, fileSystem: fileSystem, yamlParentDirectory: environment.buildDir.uri, buildRunner: FakeNativeAssetsBuildRunner( hasPackageConfigResult: false, ), ); expect( (globals.logger as BufferLogger).traceText, contains('No package config found. Skipping native assets compilation.'), ); }); testUsingContext('dry run with assets but not enabled', overrides: { ProcessManager: () => FakeProcessManager.empty(), }, () async { final File packageConfig = environment.projectDir.childFile('.dart_tool/package_config.json'); await packageConfig.parent.create(); await packageConfig.create(); expect( () => dryRunNativeAssetsAndroid( projectUri: projectUri, fileSystem: fileSystem, buildRunner: FakeNativeAssetsBuildRunner( packagesWithNativeAssetsResult: [ Package('bar', projectUri), ], ), ), throwsToolExit( message: 'Package(s) bar require the native assets feature to be enabled. ' 'Enable using `flutter config --enable-native-assets`.', ), ); }); testUsingContext('dry run with assets', overrides: { FeatureFlags: () => TestFeatureFlags(isNativeAssetsEnabled: true), ProcessManager: () => FakeProcessManager.empty(), }, () async { final File packageConfig = environment.projectDir.childFile('.dart_tool/package_config.json'); await packageConfig.parent.create(); await packageConfig.create(); final Uri? nativeAssetsYaml = await dryRunNativeAssetsAndroid( projectUri: projectUri, fileSystem: fileSystem, buildRunner: FakeNativeAssetsBuildRunner( packagesWithNativeAssetsResult: [ Package('bar', projectUri), ], dryRunResult: FakeNativeAssetsBuilderResult( assets: [ Asset( id: 'package:bar/bar.dart', linkMode: LinkMode.dynamic, target: native_assets_cli.Target.macOSArm64, path: AssetAbsolutePath(Uri.file('libbar.so')), ), Asset( id: 'package:bar/bar.dart', linkMode: LinkMode.dynamic, target: native_assets_cli.Target.macOSX64, path: AssetAbsolutePath(Uri.file('libbar.so')), ), ], ), ), ); expect( (globals.logger as BufferLogger).traceText, stringContainsInOrder([ 'Dry running native assets for android.', 'Dry running native assets for android done.', ]), ); expect( nativeAssetsYaml, projectUri.resolve('build/native_assets/android/native_assets.yaml'), ); expect( await fileSystem.file(nativeAssetsYaml).readAsString(), contains('package:bar/bar.dart'), ); }); testUsingContext('build with assets but not enabled', () async { final File packageConfig = environment.projectDir.childFile('.dart_tool/package_config.json'); await packageConfig.parent.create(); await packageConfig.create(); expect( () => buildNativeAssetsAndroid( androidArchs: [AndroidArch.arm64_v8a], targetAndroidNdkApi: 21, projectUri: projectUri, buildMode: BuildMode.debug, fileSystem: fileSystem, yamlParentDirectory: environment.buildDir.uri, buildRunner: FakeNativeAssetsBuildRunner( packagesWithNativeAssetsResult: [ Package('bar', projectUri), ], ), ), throwsToolExit( message: 'Package(s) bar require the native assets feature to be enabled. ' 'Enable using `flutter config --enable-native-assets`.', ), ); }); testUsingContext('build no assets', overrides: { FeatureFlags: () => TestFeatureFlags(isNativeAssetsEnabled: true), ProcessManager: () => FakeProcessManager.empty(), }, () async { final File packageConfig = environment.projectDir.childFile('.dart_tool/package_config.json'); await packageConfig.parent.create(); await packageConfig.create(); await buildNativeAssetsAndroid( androidArchs: [AndroidArch.arm64_v8a], targetAndroidNdkApi: 21, projectUri: projectUri, buildMode: BuildMode.debug, fileSystem: fileSystem, yamlParentDirectory: environment.buildDir.uri, buildRunner: FakeNativeAssetsBuildRunner( packagesWithNativeAssetsResult: [ Package('bar', projectUri), ], ), ); expect( environment.buildDir.childFile('native_assets.yaml'), exists, ); }); testUsingContext('build with assets', skip: const LocalPlatform().isWindows, // [intended] Backslashes in commands, but we will never run these commands on Windows. overrides: { FeatureFlags: () => TestFeatureFlags(isNativeAssetsEnabled: true), ProcessManager: () => FakeProcessManager.empty(), }, () async { final File packageConfig = environment.projectDir.childFile('.dart_tool/package_config.json'); await packageConfig.parent.create(); await packageConfig.create(); final File dylibAfterCompiling = fileSystem.file('libbar.so'); // The mock doesn't create the file, so create it here. await dylibAfterCompiling.create(); await buildNativeAssetsAndroid( androidArchs: [AndroidArch.arm64_v8a], targetAndroidNdkApi: 21, projectUri: projectUri, buildMode: BuildMode.debug, fileSystem: fileSystem, yamlParentDirectory: environment.buildDir.uri, buildRunner: FakeNativeAssetsBuildRunner( packagesWithNativeAssetsResult: [ Package('bar', projectUri), ], buildResult: FakeNativeAssetsBuilderResult( assets: [ Asset( id: 'package:bar/bar.dart', linkMode: LinkMode.dynamic, target: native_assets_cli.Target.androidArm64, path: AssetAbsolutePath(Uri.file('libbar.so')), ), ], ), ), ); expect( (globals.logger as BufferLogger).traceText, stringContainsInOrder([ 'Building native assets for [android_arm64] debug.', 'Building native assets for [android_arm64] done.', ]), ); expect( environment.buildDir.childFile('native_assets.yaml'), exists, ); }); // Ensure no exceptions for a non installed NDK are thrown if no native // assets have to be build. testUsingContext( 'does not throw if NDK not present but no native assets present', overrides: { FeatureFlags: () => TestFeatureFlags(isNativeAssetsEnabled: true), ProcessManager: () => FakeProcessManager.empty(), }, () async { final File packageConfig = environment.projectDir.childFile('.dart_tool/package_config.json'); await packageConfig.create(recursive: true); await buildNativeAssetsAndroid( androidArchs: [AndroidArch.x86_64], targetAndroidNdkApi: 21, projectUri: projectUri, buildMode: BuildMode.debug, fileSystem: fileSystem, buildRunner: _BuildRunnerWithoutNdk(), ); expect( (globals.logger as BufferLogger).traceText, isNot(contains('Building native assets for ')), ); }); testUsingContext('throw if NDK not present and there are native assets', overrides: { FeatureFlags: () => TestFeatureFlags(isNativeAssetsEnabled: true), }, () async { final File packageConfig = environment.projectDir.childFile('.dart_tool/package_config.json'); await packageConfig.parent.create(); await packageConfig.create(); expect( () => buildNativeAssetsAndroid( androidArchs: [AndroidArch.arm64_v8a], targetAndroidNdkApi: 21, projectUri: projectUri, buildMode: BuildMode.debug, fileSystem: fileSystem, yamlParentDirectory: environment.buildDir.uri, buildRunner: _BuildRunnerWithoutNdk( packagesWithNativeAssetsResult: [ Package('bar', projectUri), ], ), ), throwsToolExit( message: 'Android NDK Clang could not be found.', ), ); }); testUsingContext('Native assets dry run error', overrides: { FeatureFlags: () => TestFeatureFlags(isNativeAssetsEnabled: true), ProcessManager: () => FakeProcessManager.empty(), }, () async { final File packageConfig = environment.projectDir.childFile('.dart_tool/package_config.json'); await packageConfig.parent.create(); await packageConfig.create(); expect( () => dryRunNativeAssetsAndroid( projectUri: projectUri, fileSystem: fileSystem, buildRunner: FakeNativeAssetsBuildRunner( packagesWithNativeAssetsResult: [ Package('bar', projectUri), ], dryRunResult: const FakeNativeAssetsBuilderResult( success: false, ), ), ), throwsToolExit( message: 'Building native assets failed. See the logs for more details.', ), ); }); testUsingContext('Native assets build error', overrides: { FeatureFlags: () => TestFeatureFlags(isNativeAssetsEnabled: true), ProcessManager: () => FakeProcessManager.empty(), }, () async { final File packageConfig = environment.projectDir.childFile('.dart_tool/package_config.json'); await packageConfig.parent.create(); await packageConfig.create(); expect( () => buildNativeAssetsAndroid( androidArchs: [AndroidArch.arm64_v8a], targetAndroidNdkApi: 21, projectUri: projectUri, buildMode: BuildMode.debug, fileSystem: fileSystem, yamlParentDirectory: environment.buildDir.uri, buildRunner: FakeNativeAssetsBuildRunner( packagesWithNativeAssetsResult: [ Package('bar', projectUri), ], buildResult: const FakeNativeAssetsBuilderResult( success: false, ), ), ), throwsToolExit( message: 'Building native assets failed. See the logs for more details.', ), ); }); } class _BuildRunnerWithoutNdk extends FakeNativeAssetsBuildRunner { _BuildRunnerWithoutNdk({ super.packagesWithNativeAssetsResult = const [], }); @override Future get ndkCCompilerConfig async => throwToolExit('Android NDK Clang could not be found.'); }