flutter/packages/flutter_tools
Chris Bracken 53c2f7086b
[flutter_tools] support flutter run -d winuwp (#82373)
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
2021-05-12 20:45:30 -07:00
..
bin [flutter_tools] support flutter run -d winuwp (#82373) 2021-05-12 20:45:30 -07:00
doc [flutter_tools] delete code related to reload method (#67279) 2020-10-05 09:57:10 -07:00
gradle [flutter_tools] make bundle-sksl-path a define (#81576) 2021-04-30 17:39:07 -07:00
ide_templates/intellij Move Android doctor SDK check to 29 and Cirrus images to 30 (#63517) 2020-08-20 11:06:32 -07:00
lib [flutter_tools] support flutter run -d winuwp (#82373) 2021-05-12 20:45:30 -07:00
static [custom-devices] add screenshotting support (#80675) 2021-04-29 22:39:03 -07:00
templates Upgrade to stable flutter_lints 1.0.0 (#82365) 2021-05-12 17:14:03 -07:00
test [flutter_tools] support flutter run -d winuwp (#82373) 2021-05-12 20:45:30 -07:00
tool Split globals.dart into null sound and unsound libraries (#79016) 2021-03-31 16:55:20 -07:00
analysis_options.yaml Enable library_private_types_in_public_api lint (#81578) 2021-05-10 16:26:16 -07:00
dart_test.yaml Clean up test infrastructure (#43030) 2019-10-18 16:35:39 -07:00
pubspec.yaml [versions] roll versions and add ffi dep (#81403) 2021-04-28 11:19:03 -07:00
README.md [flutter_tools] allow using flutter test for testing the tool too (#69911) 2020-11-12 13:52:09 -08:00

Flutter Tools

This section of the Flutter repository contains the command line developer tools for building Flutter applications.

Working on Flutter Tools

Be sure to follow the instructions on CONTRIBUTING.md to set up your development environment. Further, familiarize yourself with the style guide, which we follow.

Setting up

First, ensure that the Dart SDK and other necessary artifacts are available by invoking the Flutter Tools wrapper script. In this directory run:

$ flutter --version

Running the Tool

To run Flutter Tools from source, in this directory run:

$ dart bin/flutter_tools.dart

followed by command-line arguments, as usual.

Running the analyzer

To run the analyzer on Flutter Tools, in this directory run:

$ flutter analyze

Writing tests

As with other parts of the Flutter repository, all changes in behavior must be tested. Tests live under the test/ subdirectory.

  • Hermetic unit tests of tool internals go under test/general.shard.
  • Tests of tool commands go under test/commands.shard. Hermetic tests go under its hermetic/ subdirectory. Non-hermetic tests go under its permeable sub-directory.
  • Integration tests (e.g. tests that run the tool in a subprocess) go under test/integration.shard.

In general, the tests for the code in a file called file.dart should go in a file called file_test.dart in the subdirectory that matches the behavior of the test.

Using local engine builds in integration tests

The integration tests can be configured to use a specific local engine variant by setting the FLUTTER_LOCAL_ENGINE environment variable to the name of the local engine (e.g. "android_debug_unopt"). If the local engine build requires a source path, this can be provided by setting the FLUTTER_LOCAL_ENGINE_SRC_PATH environment variable. This second variable is not necessary if the flutter and engine checkouts are in adjacent directories.

export FLUTTER_LOCAL_ENGINE=android_debug_unopt
flutter test test/integration.shard/some_test_case

Running the tests

To run the tests in the test/ directory:

$ flutter test

The tests in test/integration.shard are slower to run than the tests in test/general.shard. They also require the FLUTTER_ROOT environment variable to be set and pointing to the root of the Flutter SDK. To run only the tests in test/general.shard, in this directory run:

$ flutter test test/general.shard

To run the tests in a specific file, run:

$ flutter test test/general.shard/utils_test.dart

Forcing snapshot regeneration

To force the Flutter Tools snapshot to be regenerated, delete the following files:

$ rm ../../bin/cache/flutter_tools.stamp ../../bin/cache/flutter_tools.snapshot