flutter/packages/flutter_tools
Jonah Williams 2e75f52ae4
[flutter_tools] refactor drive launch into separate service, split by mobile+desktop and web (#68451)
Overhaul of flutter drive in order to deliver a better experience, namely:

flutter run and flutter drive now share more flags, so code paths that were previously only testable on run are now testable on drive.
Removes web-initialize-platform as this is no longer used
flutter drive correctly sets up a logger that shows native exceptions, by connecting to the vm service.
VM service connection now provides access to memory info without launching devtools (only for debug/profile mode)
Web changes

Passes on the one test in the repo, otherwise the webdriver code has been isolated as much as possible

Additional NNBD related bug fixes:

No longer passes --enable-experiment to the test script. (FYI @blasten ). earlier we might have assumed that the flutter gallery benchmarks would be migrated along side the app and flutter driver, but only the app under test needs to be migrated. The test scripts should never be run with the experiment.
2020-10-22 15:07:02 -07:00
..
bin [flutter_tools] add some versions to tool sources, cleanup build.yaml (#68624) 2020-10-20 09:50:31 -07:00
doc [flutter_tools] delete code related to reload method (#67279) 2020-10-05 09:57:10 -07:00
gradle [flutter_tools] hot reload/restart update for asset manager change (#66742) 2020-10-09 12:25:15 -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] refactor drive launch into separate service, split by mobile+desktop and web (#68451) 2020-10-22 15:07:02 -07:00
schema [Material] Updated icons and fonts (#61778) 2020-07-24 15:41:13 -07:00
static Implement screenshot test for flutter web. (#45530) 2019-12-06 14:25:39 -08:00
templates App.framework must support iOS 8 for older Flutter projects (#68729) 2020-10-22 13:50:54 -07:00
test [flutter_tools] refactor drive launch into separate service, split by mobile+desktop and web (#68451) 2020-10-22 15:07:02 -07:00
tool [flutter_tools] remove iOS screenshot on failure functionality (#68650) 2020-10-22 13:34:07 -07:00
analysis_options.yaml Reland: [flutter_tool] Where possible, catch only subtypes of Exception (#52021) 2020-03-06 10:22:12 -08:00
dart_test.yaml Clean up test infrastructure (#43030) 2019-10-18 16:35:39 -07:00
pubspec.yaml Update package:stack_trace dependency to 1.10.0-nullsafety.4 (#68132) 2020-10-16 16:35:20 +02:00
README.md Update flutter_tools README.md to document need for FLUTTER_ROOT (#66854) 2020-09-28 14:36:09 -07: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:

$ ../../bin/flutter --version

Running the Tool

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

$ ../../bin/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:

$ ../../bin/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.

We measure test coverage post-submit. A change that deletes code might decrease test coverage, however, most changes that add new code should aim to increase coverage. In particular, the coverage of the diff should be close to the average coverage, and should ideally be better.

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
../../bin/dart test test/integration.shard/some_test_case

Running the tests

To run the tests in the test/ directory, first ensure that there are no connected devices. Then, in this directory run:

$ ../../bin/dart pub run 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:

$ ../../bin/dart pub run test test/general.shard

To run the tests in a specific file, run:

$ ../../bin/dart pub run 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