mirror of
https://github.com/flutter/flutter
synced 2024-10-13 11:42:54 +00:00
53c2f7086b
Allow flutter run to work end-to-end with a UWP device. Uses win32/ffi for the actual launch of the application, injected via the native API class. This is structured to avoid a g3 dependency. Install and amuid require powershell scripts for now. Actually connecting to the observatory requires running a command in an elevated prompt. Instructions are presented to the user if a terminal is attached. This is a rebased version of https://github.com/flutter/flutter/pull/79684 by @jonahwilliams, updated to remove `NativeApi` and replace is with calls to `uwptool`. Part of https://github.com/flutter/flutter/issues/82085
323 lines
12 KiB
Dart
323 lines
12 KiB
Dart
// 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.
|
|
|
|
// @dart = 2.8
|
|
|
|
import 'package:file/memory.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/cache.dart';
|
|
import 'package:flutter_tools/src/device.dart';
|
|
import 'package:flutter_tools/src/features.dart';
|
|
import 'package:flutter_tools/src/project.dart';
|
|
import 'package:flutter_tools/src/windows/application_package.dart';
|
|
import 'package:flutter_tools/src/windows/uwptool.dart';
|
|
import 'package:flutter_tools/src/windows/windows_device.dart';
|
|
import 'package:flutter_tools/src/windows/windows_workflow.dart';
|
|
import 'package:test/fake.dart';
|
|
|
|
import '../../src/common.dart';
|
|
import '../../src/context.dart';
|
|
import '../../src/fakes.dart';
|
|
|
|
void main() {
|
|
testWithoutContext('WindowsDevice defaults', () async {
|
|
final WindowsDevice windowsDevice = setUpWindowsDevice();
|
|
final PrebuiltWindowsApp windowsApp = PrebuiltWindowsApp(executable: 'foo');
|
|
|
|
expect(await windowsDevice.targetPlatform, TargetPlatform.windows_x64);
|
|
expect(windowsDevice.name, 'Windows');
|
|
expect(await windowsDevice.installApp(windowsApp), true);
|
|
expect(await windowsDevice.uninstallApp(windowsApp), true);
|
|
expect(await windowsDevice.isLatestBuildInstalled(windowsApp), true);
|
|
expect(await windowsDevice.isAppInstalled(windowsApp), true);
|
|
expect(windowsDevice.category, Category.desktop);
|
|
|
|
expect(windowsDevice.supportsRuntimeMode(BuildMode.debug), true);
|
|
expect(windowsDevice.supportsRuntimeMode(BuildMode.profile), true);
|
|
expect(windowsDevice.supportsRuntimeMode(BuildMode.release), true);
|
|
expect(windowsDevice.supportsRuntimeMode(BuildMode.jitRelease), false);
|
|
});
|
|
|
|
testWithoutContext('WindowsUwpDevice defaults', () async {
|
|
final WindowsUWPDevice windowsDevice = setUpWindowsUwpDevice();
|
|
final FakeBuildableUwpApp package = FakeBuildableUwpApp();
|
|
|
|
expect(await windowsDevice.targetPlatform, TargetPlatform.windows_uwp_x64);
|
|
expect(windowsDevice.name, 'Windows (UWP)');
|
|
expect(await windowsDevice.installApp(package), true);
|
|
expect(await windowsDevice.uninstallApp(package), false);
|
|
expect(await windowsDevice.isLatestBuildInstalled(package), false);
|
|
expect(await windowsDevice.isAppInstalled(package), false);
|
|
expect(windowsDevice.category, Category.desktop);
|
|
|
|
expect(windowsDevice.supportsRuntimeMode(BuildMode.debug), true);
|
|
expect(windowsDevice.supportsRuntimeMode(BuildMode.profile), true);
|
|
expect(windowsDevice.supportsRuntimeMode(BuildMode.release), true);
|
|
expect(windowsDevice.supportsRuntimeMode(BuildMode.jitRelease), false);
|
|
});
|
|
|
|
testWithoutContext('WindowsDevices does not list devices if the workflow is unsupported', () async {
|
|
expect(await WindowsDevices(
|
|
windowsWorkflow: WindowsWorkflow(
|
|
featureFlags: TestFeatureFlags(isWindowsEnabled: false),
|
|
platform: FakePlatform(operatingSystem: 'windows'),
|
|
),
|
|
featureFlags: TestFeatureFlags(isWindowsEnabled: false),
|
|
operatingSystemUtils: FakeOperatingSystemUtils(),
|
|
logger: BufferLogger.test(),
|
|
processManager: FakeProcessManager.any(),
|
|
fileSystem: MemoryFileSystem.test(),
|
|
uwptool: FakeUwpTool(),
|
|
).devices, <Device>[]);
|
|
});
|
|
|
|
testWithoutContext('WindowsDevices lists a devices if the workflow is supported', () async {
|
|
expect(await WindowsDevices(
|
|
windowsWorkflow: WindowsWorkflow(
|
|
featureFlags: TestFeatureFlags(isWindowsEnabled: true),
|
|
platform: FakePlatform(operatingSystem: 'windows')
|
|
),
|
|
operatingSystemUtils: FakeOperatingSystemUtils(),
|
|
logger: BufferLogger.test(),
|
|
processManager: FakeProcessManager.any(),
|
|
fileSystem: MemoryFileSystem.test(),
|
|
featureFlags: TestFeatureFlags(isWindowsEnabled: true),
|
|
uwptool: FakeUwpTool(),
|
|
).devices, hasLength(1));
|
|
});
|
|
|
|
testWithoutContext('WindowsDevices lists a UWP Windows device if feature is enabled', () async {
|
|
final FeatureFlags featureFlags = TestFeatureFlags(isWindowsEnabled: true, isWindowsUwpEnabled: true);
|
|
expect(await WindowsDevices(
|
|
windowsWorkflow: WindowsWorkflow(
|
|
featureFlags: featureFlags,
|
|
platform: FakePlatform(operatingSystem: 'windows')
|
|
),
|
|
operatingSystemUtils: FakeOperatingSystemUtils(),
|
|
logger: BufferLogger.test(),
|
|
processManager: FakeProcessManager.any(),
|
|
fileSystem: MemoryFileSystem.test(),
|
|
featureFlags: featureFlags,
|
|
uwptool: FakeUwpTool(),
|
|
).devices, hasLength(2));
|
|
});
|
|
|
|
testWithoutContext('WindowsDevices ignores the timeout provided to discoverDevices', () async {
|
|
final WindowsDevices windowsDevices = WindowsDevices(
|
|
windowsWorkflow: WindowsWorkflow(
|
|
featureFlags: TestFeatureFlags(isWindowsEnabled: true),
|
|
platform: FakePlatform(operatingSystem: 'windows')
|
|
),
|
|
operatingSystemUtils: FakeOperatingSystemUtils(),
|
|
logger: BufferLogger.test(),
|
|
processManager: FakeProcessManager.any(),
|
|
fileSystem: MemoryFileSystem.test(),
|
|
featureFlags: TestFeatureFlags(isWindowsEnabled: true),
|
|
uwptool: FakeUwpTool(),
|
|
);
|
|
// Timeout ignored.
|
|
final List<Device> devices = await windowsDevices.discoverDevices(timeout: const Duration(seconds: 10));
|
|
expect(devices, hasLength(1));
|
|
});
|
|
|
|
testWithoutContext('isSupportedForProject is true with editable host app', () async {
|
|
final FileSystem fileSystem = MemoryFileSystem.test();
|
|
final WindowsDevice windowsDevice = setUpWindowsDevice(fileSystem: fileSystem);
|
|
fileSystem.file('pubspec.yaml').createSync();
|
|
fileSystem.file('.packages').createSync();
|
|
fileSystem.directory('windows').createSync();
|
|
fileSystem.file(fileSystem.path.join('windows', 'CMakeLists.txt')).createSync();
|
|
final FlutterProject flutterProject = setUpFlutterProject(fileSystem.currentDirectory);
|
|
|
|
expect(windowsDevice.isSupportedForProject(flutterProject), true);
|
|
});
|
|
|
|
testWithoutContext('isSupportedForProject is false with no host app', () async {
|
|
final FileSystem fileSystem = MemoryFileSystem.test();
|
|
final WindowsDevice windowsDevice = setUpWindowsDevice(fileSystem: fileSystem);
|
|
fileSystem.file('pubspec.yaml').createSync();
|
|
fileSystem.file('.packages').createSync();
|
|
final FlutterProject flutterProject = setUpFlutterProject(fileSystem.currentDirectory);
|
|
|
|
expect(windowsDevice.isSupportedForProject(flutterProject), false);
|
|
});
|
|
|
|
testWithoutContext('isSupportedForProject is false with no build file', () async {
|
|
final FileSystem fileSystem = MemoryFileSystem.test();
|
|
final WindowsDevice windowsDevice = setUpWindowsDevice(fileSystem: fileSystem);
|
|
fileSystem.file('pubspec.yaml').createSync();
|
|
fileSystem.file('.packages').createSync();
|
|
fileSystem.directory('windows').createSync();
|
|
final FlutterProject flutterProject = setUpFlutterProject(fileSystem.currentDirectory);
|
|
|
|
expect(windowsDevice.isSupportedForProject(flutterProject), false);
|
|
});
|
|
|
|
testWithoutContext('executablePathForDevice uses the correct package executable', () async {
|
|
final WindowsDevice windowsDevice = setUpWindowsDevice();
|
|
final FakeWindowsApp fakeApp = FakeWindowsApp();
|
|
|
|
expect(windowsDevice.executablePathForDevice(fakeApp, BuildMode.debug), 'debug/executable');
|
|
expect(windowsDevice.executablePathForDevice(fakeApp, BuildMode.profile), 'profile/executable');
|
|
expect(windowsDevice.executablePathForDevice(fakeApp, BuildMode.release), 'release/executable');
|
|
});
|
|
|
|
testWithoutContext('WinUWPDevice can launch application', () async {
|
|
Cache.flutterRoot = '';
|
|
final FakeUwpTool uwptool = FakeUwpTool();
|
|
final FileSystem fileSystem = MemoryFileSystem.test();
|
|
final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[
|
|
const FakeCommand(command: <String>[
|
|
'powershell.exe',
|
|
'build/winuwp/runner_uwp/AppPackages/testapp/testapp_1.2.3.4_Debug_Test/install.ps1',
|
|
]),
|
|
]);
|
|
final WindowsUWPDevice windowsDevice = setUpWindowsUwpDevice(
|
|
fileSystem: fileSystem,
|
|
processManager: processManager,
|
|
uwptool: uwptool,
|
|
);
|
|
final FakeBuildableUwpApp package = FakeBuildableUwpApp();
|
|
|
|
final LaunchResult result = await windowsDevice.startApp(
|
|
package,
|
|
debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug),
|
|
prebuiltApplication: true,
|
|
platformArgs: <String, Object>{},
|
|
);
|
|
|
|
expect(result.started, true);
|
|
expect(uwptool.launchRequests.single.appId, 'PACKAGE-ID_asdfghjkl');
|
|
expect(uwptool.launchRequests.single.args, <String>[
|
|
'--observatory-port=12345',
|
|
'--disable-service-auth-codes',
|
|
'--enable-dart-profiling',
|
|
'--enable-checked-mode',
|
|
'--verify-entry-points',
|
|
]);
|
|
});
|
|
|
|
testWithoutContext('WinUWPDevice can launch application in release mode', () async {
|
|
Cache.flutterRoot = '';
|
|
final FakeUwpTool uwptool = FakeUwpTool();
|
|
final FileSystem fileSystem = MemoryFileSystem.test();
|
|
final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[
|
|
const FakeCommand(command: <String>[
|
|
'powershell.exe',
|
|
'build/winuwp/runner_uwp/AppPackages/testapp/testapp_1.2.3.4_Release_Test/install.ps1',
|
|
]),
|
|
]);
|
|
final WindowsUWPDevice windowsDevice = setUpWindowsUwpDevice(
|
|
fileSystem: fileSystem,
|
|
processManager: processManager,
|
|
uwptool: uwptool,
|
|
);
|
|
final FakeBuildableUwpApp package = FakeBuildableUwpApp();
|
|
|
|
final LaunchResult result = await windowsDevice.startApp(
|
|
package,
|
|
debuggingOptions: DebuggingOptions.enabled(BuildInfo.release),
|
|
prebuiltApplication: true,
|
|
platformArgs: <String, Object>{},
|
|
);
|
|
|
|
expect(result.started, true);
|
|
expect(uwptool.launchRequests.single.appId, 'PACKAGE-ID_asdfghjkl');
|
|
expect(uwptool.launchRequests.single.args, <String>[]);
|
|
});
|
|
}
|
|
|
|
FlutterProject setUpFlutterProject(Directory directory) {
|
|
final FlutterProjectFactory flutterProjectFactory = FlutterProjectFactory(
|
|
fileSystem: directory.fileSystem,
|
|
logger: BufferLogger.test(),
|
|
);
|
|
return flutterProjectFactory.fromDirectory(directory);
|
|
}
|
|
|
|
WindowsDevice setUpWindowsDevice({
|
|
FileSystem fileSystem,
|
|
Logger logger,
|
|
ProcessManager processManager,
|
|
}) {
|
|
return WindowsDevice(
|
|
fileSystem: fileSystem ?? MemoryFileSystem.test(),
|
|
logger: logger ?? BufferLogger.test(),
|
|
processManager: processManager ?? FakeProcessManager.any(),
|
|
operatingSystemUtils: FakeOperatingSystemUtils(),
|
|
);
|
|
}
|
|
|
|
WindowsUWPDevice setUpWindowsUwpDevice({
|
|
FileSystem fileSystem,
|
|
Logger logger,
|
|
ProcessManager processManager,
|
|
UwpTool uwptool,
|
|
}) {
|
|
return WindowsUWPDevice(
|
|
fileSystem: fileSystem ?? MemoryFileSystem.test(),
|
|
logger: logger ?? BufferLogger.test(),
|
|
processManager: processManager ?? FakeProcessManager.any(),
|
|
operatingSystemUtils: FakeOperatingSystemUtils(),
|
|
uwptool: uwptool ?? FakeUwpTool(),
|
|
);
|
|
}
|
|
|
|
class FakeWindowsApp extends Fake implements WindowsApp {
|
|
@override
|
|
String executable(BuildMode buildMode) => '${buildMode.name}/executable';
|
|
}
|
|
|
|
class FakeBuildableUwpApp extends Fake implements BuildableUwpApp {
|
|
@override
|
|
String get id => 'PACKAGE-ID';
|
|
@override
|
|
String get name => 'testapp';
|
|
@override
|
|
String get projectVersion => '1.2.3.4';
|
|
}
|
|
|
|
class FakeUwpTool implements UwpTool {
|
|
final List<_LaunchRequest> launchRequests = <_LaunchRequest>[];
|
|
final List<_LookupAppIdRequest> lookupAppIdRequests = <_LookupAppIdRequest>[];
|
|
|
|
@override
|
|
Future<List<String>> listApps() async {
|
|
return <String>[
|
|
'fb89bf4f-55db-4bcd-8f0b-d8139953e08b',
|
|
'3e556a66-cb7f-4335-9569-35d5f5e37219',
|
|
'dfe5d409-a524-4635-b2f8-78a5e9551994',
|
|
'51e8a06b-02e8-4f76-9131-f20ce114fc34',
|
|
];
|
|
}
|
|
|
|
@override
|
|
Future<String> getAppIdFromPackageId(String packageId) async {
|
|
lookupAppIdRequests.add(_LookupAppIdRequest(packageId));
|
|
return '${packageId}_asdfghjkl';
|
|
}
|
|
|
|
@override
|
|
Future<int> launchApp(String appId, List<String> args) async {
|
|
launchRequests.add(_LaunchRequest(appId, args));
|
|
return 42;
|
|
}
|
|
}
|
|
|
|
class _LookupAppIdRequest {
|
|
const _LookupAppIdRequest(this.packageId);
|
|
|
|
final String packageId;
|
|
}
|
|
|
|
class _LaunchRequest {
|
|
const _LaunchRequest(this.appId, this.args);
|
|
|
|
final String appId;
|
|
final List<String> args;
|
|
}
|