flutter/packages/flutter_tools
stuartmorgan 7bdd4757ec
Create plugin symlinks for Windows and Linux (#50599)
This makes ephemeral symlinks to each plugin, for use by build systems.
This is similar to the logic implemented in the Podfile on iOS and
macOS, but managed internally to the Flutter tool.

Exploration for addressing #32719 and #32720
Related to #41146
2020-02-12 16:23:27 -08:00
..
bin Made xcode_backend stop on error. (#50664) 2020-02-12 16:23:01 -08:00
doc Support URL tunnelling (pass dwds UrlEncoder through to editors via daemon) (#44271) 2019-12-12 18:43:58 +00:00
gradle [flutter_tools] support --split-debug-info option in android builds (#49650) 2020-02-05 17:45:24 -08:00
ide_templates/intellij Move stocks example app into dev/benchmarks/test_apps (#49559) 2020-01-30 09:31:07 -08:00
lib Create plugin symlinks for Windows and Linux (#50599) 2020-02-12 16:23:27 -08:00
schema Add the beginnings of plugin support for Windows and Linux (#41015) 2019-09-26 14:01:57 -07:00
static Implement screenshot test for flutter web. (#45530) 2019-12-06 14:25:39 -08:00
templates Update cupertino_icons dependency version in pubspec.yaml template (#50479) 2020-02-12 13:28:03 -08:00
test Create plugin symlinks for Windows and Linux (#50599) 2020-02-12 16:23:27 -08:00
tool Pipe through test-randomize-ordering-seed (#47243) 2019-12-18 13:58:01 -08:00
analysis_options.yaml Reland implicit-casts: false (#47431) 2019-12-19 02:23:01 -08:00
BUILD.gn Add "flutter symbolize" command (#49465) 2020-02-10 14:18:03 -08:00
build.yaml Reland support flutter test on platform chrome (#33859) 2019-06-05 15:27:49 -07:00
dart_test.yaml Clean up test infrastructure (#43030) 2019-10-18 16:35:39 -07:00
pubspec.yaml update packages (#50666) 2020-02-12 14:51:38 -08:00
README.md [flutter_tools] Small addition to the readme about testing (#50051) 2020-02-04 08:19:59 -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:

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

Running the Tool

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

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

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/cache/dart-sdk/bin/pub run test

The tests in test/integration.shard are slower to run than the tests in test/general.shard. To run only the tests in test/general.shard, in this directory run:

$ ../../bin/cache/dart-sdk/bin/pub run test test/general.shard

To run the tests in a specific file, run:

$ ../../bin/cache/dart-sdk/bin/pub run test test/general.shard/utils_test.dart

When running all of the tests, it is a bit faster to use build_runner. First, set FLUTTER_ROOT to the root of your Flutter checkout. Then, in this directory run:

$ ../../bin/cache/dart-sdk/bin/pub run build_runner test

This is what we do in the continuous integration bots.

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