// Copyright 2013 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 'dart:io' as io; import 'package:args/command_runner.dart'; import 'package:file/file.dart'; import 'package:file/memory.dart'; import 'package:flutter_plugin_tools/src/build_examples_command.dart'; import 'package:flutter_plugin_tools/src/common/core.dart'; import 'package:flutter_plugin_tools/src/common/plugin_utils.dart'; import 'package:test/test.dart'; import 'mocks.dart'; import 'util.dart'; void main() { group('build-example', () { late FileSystem fileSystem; late MockPlatform mockPlatform; late Directory packagesDir; late CommandRunner runner; late RecordingProcessRunner processRunner; setUp(() { fileSystem = MemoryFileSystem(); mockPlatform = MockPlatform(); packagesDir = createPackagesDirectory(fileSystem: fileSystem); processRunner = RecordingProcessRunner(); final BuildExamplesCommand command = BuildExamplesCommand( packagesDir, processRunner: processRunner, platform: mockPlatform, ); runner = CommandRunner( 'build_examples_command', 'Test for build_example_command'); runner.addCommand(command); }); test('fails if no plaform flags are passed', () async { Error? commandError; final List output = await runCapturingPrint( runner, ['build-examples'], errorHandler: (Error e) { commandError = e; }); expect(commandError, isA()); expect( output, containsAllInOrder([ contains('At least one platform must be provided'), ])); }); test('fails if building fails', () async { createFakePlugin('plugin', packagesDir, platformSupport: { kPlatformIos: const PlatformDetails(PlatformSupport.inline), }); processRunner .mockProcessesForExecutable[getFlutterCommand(mockPlatform)] = [ MockProcess(exitCode: 1) // flutter packages get ]; Error? commandError; final List output = await runCapturingPrint( runner, ['build-examples', '--ios'], errorHandler: (Error e) { commandError = e; }); expect(commandError, isA()); expect( output, containsAllInOrder([ contains('The following packages had errors:'), contains(' plugin:\n' ' plugin/example (iOS)'), ])); }); test('building for iOS when plugin is not set up for iOS results in no-op', () async { mockPlatform.isMacOS = true; createFakePlugin('plugin', packagesDir); final List output = await runCapturingPrint(runner, ['build-examples', '--ios']); expect( output, containsAllInOrder([ contains('Running for plugin'), contains('iOS is not supported by this plugin'), ]), ); // Output should be empty since running build-examples --macos with no macos // implementation is a no-op. expect(processRunner.recordedCalls, orderedEquals([])); }); test('building for iOS', () async { mockPlatform.isMacOS = true; final Directory pluginDirectory = createFakePlugin('plugin', packagesDir, platformSupport: { kPlatformIos: const PlatformDetails(PlatformSupport.inline), }); final Directory pluginExampleDirectory = pluginDirectory.childDirectory('example'); final List output = await runCapturingPrint(runner, ['build-examples', '--ios', '--enable-experiment=exp1']); expect( output, containsAllInOrder([ '\nBUILDING plugin/example for iOS', ]), ); expect( processRunner.recordedCalls, orderedEquals([ ProcessCall( getFlutterCommand(mockPlatform), const [ 'build', 'ios', '--no-codesign', '--enable-experiment=exp1' ], pluginExampleDirectory.path), ])); }); test( 'building for Linux when plugin is not set up for Linux results in no-op', () async { mockPlatform.isLinux = true; createFakePlugin('plugin', packagesDir); final List output = await runCapturingPrint( runner, ['build-examples', '--linux']); expect( output, containsAllInOrder([ contains('Running for plugin'), contains('Linux is not supported by this plugin'), ]), ); // Output should be empty since running build-examples --linux with no // Linux implementation is a no-op. expect(processRunner.recordedCalls, orderedEquals([])); }); test('building for Linux', () async { mockPlatform.isLinux = true; final Directory pluginDirectory = createFakePlugin('plugin', packagesDir, platformSupport: { kPlatformLinux: const PlatformDetails(PlatformSupport.inline), }); final Directory pluginExampleDirectory = pluginDirectory.childDirectory('example'); final List output = await runCapturingPrint( runner, ['build-examples', '--linux']); expect( output, containsAllInOrder([ '\nBUILDING plugin/example for Linux', ]), ); expect( processRunner.recordedCalls, orderedEquals([ ProcessCall(getFlutterCommand(mockPlatform), const ['build', 'linux'], pluginExampleDirectory.path), ])); }); test('building for macOS with no implementation results in no-op', () async { mockPlatform.isMacOS = true; createFakePlugin('plugin', packagesDir); final List output = await runCapturingPrint( runner, ['build-examples', '--macos']); expect( output, containsAllInOrder([ contains('Running for plugin'), contains('macOS is not supported by this plugin'), ]), ); // Output should be empty since running build-examples --macos with no macos // implementation is a no-op. expect(processRunner.recordedCalls, orderedEquals([])); }); test('building for macOS', () async { mockPlatform.isMacOS = true; final Directory pluginDirectory = createFakePlugin('plugin', packagesDir, platformSupport: { kPlatformMacos: const PlatformDetails(PlatformSupport.inline), }); final Directory pluginExampleDirectory = pluginDirectory.childDirectory('example'); final List output = await runCapturingPrint( runner, ['build-examples', '--macos']); expect( output, containsAllInOrder([ '\nBUILDING plugin/example for macOS', ]), ); expect( processRunner.recordedCalls, orderedEquals([ ProcessCall(getFlutterCommand(mockPlatform), const ['build', 'macos'], pluginExampleDirectory.path), ])); }); test('building for web with no implementation results in no-op', () async { createFakePlugin('plugin', packagesDir); final List output = await runCapturingPrint(runner, ['build-examples', '--web']); expect( output, containsAllInOrder([ contains('Running for plugin'), contains('web is not supported by this plugin'), ]), ); // Output should be empty since running build-examples --macos with no macos // implementation is a no-op. expect(processRunner.recordedCalls, orderedEquals([])); }); test('building for web', () async { final Directory pluginDirectory = createFakePlugin('plugin', packagesDir, platformSupport: { kPlatformWeb: const PlatformDetails(PlatformSupport.inline), }); final Directory pluginExampleDirectory = pluginDirectory.childDirectory('example'); final List output = await runCapturingPrint(runner, ['build-examples', '--web']); expect( output, containsAllInOrder([ '\nBUILDING plugin/example for web', ]), ); expect( processRunner.recordedCalls, orderedEquals([ ProcessCall(getFlutterCommand(mockPlatform), const ['build', 'web'], pluginExampleDirectory.path), ])); }); test( 'building for win32 when plugin is not set up for Windows results in no-op', () async { mockPlatform.isWindows = true; createFakePlugin('plugin', packagesDir); final List output = await runCapturingPrint( runner, ['build-examples', '--windows']); expect( output, containsAllInOrder([ contains('Running for plugin'), contains('Win32 is not supported by this plugin'), ]), ); // Output should be empty since running build-examples --windows with no // Windows implementation is a no-op. expect(processRunner.recordedCalls, orderedEquals([])); }); test('building for win32', () async { mockPlatform.isWindows = true; final Directory pluginDirectory = createFakePlugin('plugin', packagesDir, platformSupport: { kPlatformWindows: const PlatformDetails(PlatformSupport.inline), }); final Directory pluginExampleDirectory = pluginDirectory.childDirectory('example'); final List output = await runCapturingPrint( runner, ['build-examples', '--windows']); expect( output, containsAllInOrder([ '\nBUILDING plugin/example for Win32 (windows)', ]), ); expect( processRunner.recordedCalls, orderedEquals([ ProcessCall( getFlutterCommand(mockPlatform), const ['build', 'windows'], pluginExampleDirectory.path), ])); }); test('building for UWP when plugin does not support UWP is a no-op', () async { createFakePlugin('plugin', packagesDir); final List output = await runCapturingPrint( runner, ['build-examples', '--winuwp']); expect( output, containsAllInOrder([ contains('Running for plugin'), contains('UWP is not supported by this plugin'), ]), ); print(processRunner.recordedCalls); // Output should be empty since running build-examples --macos with no macos // implementation is a no-op. expect(processRunner.recordedCalls, orderedEquals([])); }); test('building for UWP', () async { final Directory pluginDirectory = createFakePlugin('plugin', packagesDir, extraFiles: [ 'example/test', ], platformSupport: { kPlatformWindows: const PlatformDetails(PlatformSupport.federated, variants: [platformVariantWinUwp]), }); final Directory pluginExampleDirectory = pluginDirectory.childDirectory('example'); final List output = await runCapturingPrint( runner, ['build-examples', '--winuwp']); expect( output, containsAllInOrder([ contains('BUILDING plugin/example for UWP (winuwp)'), ]), ); print(processRunner.recordedCalls); expect( processRunner.recordedCalls, containsAll([ ProcessCall(getFlutterCommand(mockPlatform), const ['build', 'winuwp'], pluginExampleDirectory.path), ])); }); test('building for UWP creates a folder if necessary', () async { final Directory pluginDirectory = createFakePlugin('plugin', packagesDir, extraFiles: [ 'example/test', ], platformSupport: { kPlatformWindows: const PlatformDetails(PlatformSupport.federated, variants: [platformVariantWinUwp]), }); final Directory pluginExampleDirectory = pluginDirectory.childDirectory('example'); final List output = await runCapturingPrint( runner, ['build-examples', '--winuwp']); expect( output, contains('Creating temporary winuwp folder'), ); print(processRunner.recordedCalls); expect( processRunner.recordedCalls, orderedEquals([ ProcessCall( getFlutterCommand(mockPlatform), const ['create', '--platforms=winuwp', '.'], pluginExampleDirectory.path), ProcessCall(getFlutterCommand(mockPlatform), const ['build', 'winuwp'], pluginExampleDirectory.path), ])); }); test( 'building for Android when plugin is not set up for Android results in no-op', () async { createFakePlugin('plugin', packagesDir); final List output = await runCapturingPrint(runner, ['build-examples', '--apk']); expect( output, containsAllInOrder([ contains('Running for plugin'), contains('Android is not supported by this plugin'), ]), ); // Output should be empty since running build-examples --macos with no macos // implementation is a no-op. expect(processRunner.recordedCalls, orderedEquals([])); }); test('building for Android', () async { final Directory pluginDirectory = createFakePlugin('plugin', packagesDir, platformSupport: { kPlatformAndroid: const PlatformDetails(PlatformSupport.inline), }); final Directory pluginExampleDirectory = pluginDirectory.childDirectory('example'); final List output = await runCapturingPrint(runner, [ 'build-examples', '--apk', ]); expect( output, containsAllInOrder([ '\nBUILDING plugin/example for Android (apk)', ]), ); expect( processRunner.recordedCalls, orderedEquals([ ProcessCall(getFlutterCommand(mockPlatform), const ['build', 'apk'], pluginExampleDirectory.path), ])); }); test('enable-experiment flag for Android', () async { final Directory pluginDirectory = createFakePlugin('plugin', packagesDir, platformSupport: { kPlatformAndroid: const PlatformDetails(PlatformSupport.inline), }); final Directory pluginExampleDirectory = pluginDirectory.childDirectory('example'); await runCapturingPrint(runner, ['build-examples', '--apk', '--enable-experiment=exp1']); expect( processRunner.recordedCalls, orderedEquals([ ProcessCall( getFlutterCommand(mockPlatform), const ['build', 'apk', '--enable-experiment=exp1'], pluginExampleDirectory.path), ])); }); test('enable-experiment flag for ios', () async { final Directory pluginDirectory = createFakePlugin('plugin', packagesDir, platformSupport: { kPlatformIos: const PlatformDetails(PlatformSupport.inline), }); final Directory pluginExampleDirectory = pluginDirectory.childDirectory('example'); await runCapturingPrint(runner, ['build-examples', '--ios', '--enable-experiment=exp1']); expect( processRunner.recordedCalls, orderedEquals([ ProcessCall( getFlutterCommand(mockPlatform), const [ 'build', 'ios', '--no-codesign', '--enable-experiment=exp1' ], pluginExampleDirectory.path), ])); }); }); }