// 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/memory.dart'; import 'package:flutter_tools/src/base/file_system.dart'; import 'package:flutter_tools/src/platform_plugins.dart'; import 'package:flutter_tools/src/plugins.dart'; import 'package:yaml/yaml.dart'; import '../src/common.dart'; const String _kTestPluginName = 'test_plugin_name'; const String _kTestPluginPath = 'test_plugin_path'; void main() { testWithoutContext('Plugin creation from the legacy format', () { final MemoryFileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'androidPackage: com.flutter.dev\n' 'iosPrefix: FLT\n' 'pluginClass: SamplePlugin\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; final Plugin plugin = Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ); final AndroidPlugin androidPlugin = plugin.platforms[AndroidPlugin.kConfigKey]! as AndroidPlugin; final IOSPlugin iosPlugin = plugin.platforms[IOSPlugin.kConfigKey]! as IOSPlugin; expect(iosPlugin.pluginClass, 'SamplePlugin'); expect(iosPlugin.classPrefix, 'FLT'); expect(iosPlugin.sharedDarwinSource, isFalse); expect(androidPlugin.pluginClass, 'SamplePlugin'); expect(androidPlugin.package, 'com.flutter.dev'); }); testWithoutContext('Plugin creation from the multi-platform format', () { final MemoryFileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'platforms:\n' ' android:\n' ' package: com.flutter.dev\n' ' pluginClass: ASamplePlugin\n' ' ios:\n' ' pluginClass: ISamplePlugin\n' ' sharedDarwinSource: true\n' ' linux:\n' ' pluginClass: LSamplePlugin\n' ' macos:\n' ' pluginClass: MSamplePlugin\n' ' sharedDarwinSource: true\n' ' web:\n' ' pluginClass: WebSamplePlugin\n' ' fileName: web_plugin.dart\n' ' windows:\n' ' pluginClass: WinSamplePlugin\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; final Plugin plugin = Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ); final AndroidPlugin androidPlugin = plugin.platforms[AndroidPlugin.kConfigKey]! as AndroidPlugin; final IOSPlugin iosPlugin = plugin.platforms[IOSPlugin.kConfigKey]! as IOSPlugin; final LinuxPlugin linuxPlugin = plugin.platforms[LinuxPlugin.kConfigKey]! as LinuxPlugin; final MacOSPlugin macOSPlugin = plugin.platforms[MacOSPlugin.kConfigKey]! as MacOSPlugin; final WebPlugin webPlugin = plugin.platforms[WebPlugin.kConfigKey]! as WebPlugin; final WindowsPlugin windowsPlugin = plugin.platforms[WindowsPlugin.kConfigKey]! as WindowsPlugin; expect(iosPlugin.pluginClass, 'ISamplePlugin'); expect(iosPlugin.classPrefix, ''); expect(iosPlugin.sharedDarwinSource, isTrue); expect(androidPlugin.pluginClass, 'ASamplePlugin'); expect(androidPlugin.package, 'com.flutter.dev'); expect(linuxPlugin.pluginClass, 'LSamplePlugin'); expect(macOSPlugin.pluginClass, 'MSamplePlugin'); expect(macOSPlugin.sharedDarwinSource, isTrue); expect(webPlugin.pluginClass, 'WebSamplePlugin'); expect(webPlugin.fileName, 'web_plugin.dart'); expect(windowsPlugin.pluginClass, 'WinSamplePlugin'); }); testWithoutContext('Plugin parsing of unknown fields are allowed (allows some future compatibility)', () { final MemoryFileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'implements: same_plugin\n' // this should be ignored by the tool 'platforms:\n' ' android:\n' ' package: com.flutter.dev\n' ' pluginClass: ASamplePlugin\n' ' anUnknownField: ASamplePlugin\n' // this should be ignored by the tool ' ios:\n' ' pluginClass: ISamplePlugin\n' ' linux:\n' ' pluginClass: LSamplePlugin\n' ' macos:\n' ' pluginClass: MSamplePlugin\n' ' web:\n' ' pluginClass: WebSamplePlugin\n' ' fileName: web_plugin.dart\n' ' windows:\n' ' pluginClass: WinSamplePlugin\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; final Plugin plugin = Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ); final AndroidPlugin androidPlugin = plugin.platforms[AndroidPlugin.kConfigKey]! as AndroidPlugin; final IOSPlugin iosPlugin = plugin.platforms[IOSPlugin.kConfigKey]! as IOSPlugin; final LinuxPlugin linuxPlugin = plugin.platforms[LinuxPlugin.kConfigKey]! as LinuxPlugin; final MacOSPlugin macOSPlugin = plugin.platforms[MacOSPlugin.kConfigKey]! as MacOSPlugin; final WebPlugin webPlugin = plugin.platforms[WebPlugin.kConfigKey]! as WebPlugin; final WindowsPlugin windowsPlugin = plugin.platforms[WindowsPlugin.kConfigKey]! as WindowsPlugin; expect(iosPlugin.pluginClass, 'ISamplePlugin'); expect(iosPlugin.classPrefix, ''); expect(iosPlugin.sharedDarwinSource, isFalse); expect(androidPlugin.pluginClass, 'ASamplePlugin'); expect(androidPlugin.package, 'com.flutter.dev'); expect(linuxPlugin.pluginClass, 'LSamplePlugin'); expect(macOSPlugin.pluginClass, 'MSamplePlugin'); expect(macOSPlugin.sharedDarwinSource, isFalse); expect(webPlugin.pluginClass, 'WebSamplePlugin'); expect(webPlugin.fileName, 'web_plugin.dart'); expect(windowsPlugin.pluginClass, 'WinSamplePlugin'); }); testWithoutContext('Plugin parsing allows for Dart-only plugins without a pluginClass', () { final FileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'implements: same_plugin\n' // this should be ignored by the tool 'platforms:\n' ' android:\n' ' dartPluginClass: ASamplePlugin\n' ' ios:\n' ' dartPluginClass: ISamplePlugin\n' ' linux:\n' ' dartPluginClass: LSamplePlugin\n' ' macos:\n' ' dartPluginClass: MSamplePlugin\n' ' windows:\n' ' dartPluginClass: WinSamplePlugin\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; final Plugin plugin = Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ); final AndroidPlugin androidPlugin = plugin.platforms[AndroidPlugin.kConfigKey]! as AndroidPlugin; final IOSPlugin iOSPlugin = plugin.platforms[IOSPlugin.kConfigKey]! as IOSPlugin; final LinuxPlugin linuxPlugin = plugin.platforms[LinuxPlugin.kConfigKey]! as LinuxPlugin; final MacOSPlugin macOSPlugin = plugin.platforms[MacOSPlugin.kConfigKey]! as MacOSPlugin; final WindowsPlugin windowsPlugin = plugin.platforms[WindowsPlugin.kConfigKey]! as WindowsPlugin; expect(androidPlugin.pluginClass, isNull); expect(iOSPlugin.pluginClass, isNull); expect(linuxPlugin.pluginClass, isNull); expect(macOSPlugin.pluginClass, isNull); expect(windowsPlugin.pluginClass, isNull); expect(androidPlugin.dartPluginClass, 'ASamplePlugin'); expect(iOSPlugin.dartPluginClass, 'ISamplePlugin'); expect(linuxPlugin.dartPluginClass, 'LSamplePlugin'); expect(macOSPlugin.dartPluginClass, 'MSamplePlugin'); expect(windowsPlugin.dartPluginClass, 'WinSamplePlugin'); }); testWithoutContext('Plugin parsing of legacy format and multi-platform format together is not allowed ' 'and fatal error message contains plugin name', () { final FileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'androidPackage: com.flutter.dev\n' 'platforms:\n' ' android:\n' ' package: com.flutter.dev\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; expect( () => Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ), throwsToolExit(message: _kTestPluginName), ); }); testWithoutContext('Plugin parsing allows a default_package field', () { final FileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'platforms:\n' ' android:\n' ' default_package: sample_package_android\n' ' ios:\n' ' default_package: sample_package_ios\n' ' linux:\n' ' default_package: sample_package_linux\n' ' macos:\n' ' default_package: sample_package_macos\n' ' web:\n' ' default_package: sample_package_web\n' ' windows:\n' ' default_package: sample_package_windows\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; final Plugin plugin = Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ); expect(plugin.platforms, <String, PluginPlatform>{}); expect(plugin.defaultPackagePlatforms, <String, String>{ 'android': 'sample_package_android', 'ios': 'sample_package_ios', 'linux': 'sample_package_linux', 'macos': 'sample_package_macos', 'windows': 'sample_package_windows', }); expect(plugin.pluginDartClassPlatforms, <String, String>{}); }); testWithoutContext('Desktop plugin parsing allows a dartPluginClass field', () { final FileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'platforms:\n' ' linux:\n' ' dartPluginClass: LinuxClass\n' ' macos:\n' ' dartPluginClass: MacOSClass\n' ' windows:\n' ' dartPluginClass: WindowsClass\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; final Plugin plugin = Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ); expect(plugin.pluginDartClassPlatforms, <String, String>{ 'linux': 'LinuxClass', 'macos': 'MacOSClass', 'windows': 'WindowsClass', }); }); testWithoutContext('Windows allows supported mode lists', () { final FileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'platforms:\n' ' windows:\n' ' pluginClass: WinSamplePlugin\n' ' supportedVariants:\n' ' - win32\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; final Plugin plugin = Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ); final WindowsPlugin windowsPlugin = plugin.platforms[WindowsPlugin.kConfigKey]! as WindowsPlugin; expect(windowsPlugin.supportedVariants, <PluginPlatformVariant>[ PluginPlatformVariant.win32, ]); }); testWithoutContext('Web plugin tool exits if fileName field missing', () { final FileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'platforms:\n' ' web:\n' ' pluginClass: WebSamplePlugin\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; expect( () => Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ), throwsToolExit( message: 'The plugin `$_kTestPluginName` is missing the required field `fileName` in pubspec.yaml', ), ); }); testWithoutContext('Windows assumes win32 when no variants are given', () { final FileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'platforms:\n' ' windows:\n' ' pluginClass: WinSamplePlugin\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; final Plugin plugin = Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ); final WindowsPlugin windowsPlugin = plugin.platforms[WindowsPlugin.kConfigKey]! as WindowsPlugin; expect(windowsPlugin.supportedVariants, <PluginPlatformVariant>[ PluginPlatformVariant.win32, ]); }); testWithoutContext('Windows ignores unknown variants', () { final FileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'platforms:\n' ' windows:\n' ' pluginClass: WinSamplePlugin\n' ' supportedVariants:\n' ' - not_yet_invented_variant\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; final Plugin plugin = Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ); final WindowsPlugin windowsPlugin = plugin.platforms[WindowsPlugin.kConfigKey]! as WindowsPlugin; expect(windowsPlugin.supportedVariants, <PluginPlatformVariant>{}); }); testWithoutContext('Plugin parsing throws a fatal error on an empty plugin', () { final MemoryFileSystem fileSystem = MemoryFileSystem.test(); final YamlMap? pluginYaml = loadYaml('') as YamlMap?; expect( () => Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ), throwsToolExit(message: 'Invalid "plugin" specification.'), ); }); testWithoutContext('Plugin parsing throws a fatal error on empty platforms', () { final MemoryFileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'platforms:\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; expect( () => Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ), throwsToolExit(message: 'Invalid "platforms" specification.'), ); }); test('Plugin parsing throws a fatal error on an empty platform key', () { final MemoryFileSystem fileSystem = MemoryFileSystem.test(); const String pluginYamlRaw = 'platforms:\n' ' android:\n'; final YamlMap pluginYaml = loadYaml(pluginYamlRaw) as YamlMap; expect( () => Plugin.fromYaml( _kTestPluginName, _kTestPluginPath, pluginYaml, null, const <String>[], fileSystem: fileSystem, ), throwsToolExit(message: 'Invalid "android" plugin specification.'), ); }); }