Paul Berry
321dfea36a
Change the following code paths so that they format Dart code by running `tools/sdks/dart-sdk/bin/dart format` as a subprocess: - `generate_messages.dart` (this is the CFE tool that generates `pkg/_fe_analyzer_shared/lib/src/messages/codes_generated.dart` and `pkg/front_end/lib/src/codes/cfe_codes_generated.dart`). - `generated_files_up_to_date_git_test.dart` (this is a CFE test that verifies that `pkg/_fe_analyzer_shared/lib/src/messages/codes_generated.dart` and `pkg/front_end/lib/src/codes/cfe_codes_generated.dart` are up to date). - `GeneratedFile.generate` (this is the common method used by most analyzer code generators). - `GeneratedContentExtension.check` (this is used by analyzer tests to verify that generated files are up to date). - `relevance_table_generator.dart` (this is an `analysis_server` tool that generates `relevance_tables*.g.dart` files). Previously, these tools were inconsistent; some of them invoked the formatter through its Dart API, and some of them ran `dart format` as a subprocess via whatever `dart` executable was currently being used for the parent process. This led to a risk that a generated file might be immediately rejected by its own "up to date" test, or by the presubmit script. Standardizing on the use of `tools/sdks/dart-sdk/bin/dart format` (which is what the presubmit script uses) should address this risk. Addresses code review comments: https://dart-review.googlesource.com/c/sdk/+/447920/comment/e9e1aa39_6fffc7e5/. Change-Id: I6a6a69643a69505dc6e30547e0e784358458c357 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/448161 Commit-Queue: Paul Berry <paulberry@google.com> Reviewed-by: Jens Johansen <jensj@google.com>
Package validation
The packages in pkg/ are automatically validated on the LUCI CI bots. The
validation is largely done by the tools/package_deps package; it can be tested
locally via:
dart tools/package_deps/bin/package_deps.dart
Packages which are published
There are several packages developed in pkg/ which are published to pub.
Validation of these packages is particularly important because the pub tools are
not used for these packages during development; we get our dependency versions
from the DEPS file. It's very easy for the dependencies specified in a package's
pubspec file to get out of date wrt the packages and versions actually used.
In order to better ensure we're publishing correct packages, we validate some properties of the pubspec files on our CI system. These validations include:
- that the dependencies listed in the pubspec are used in the package
- that all the packages used by the source are listed in the pubspec
- that we don't use relative path deps to pkg/ or third_party/ packages
Packages which are not published
For packages in pkg/ which we do not intend to be published, we put the following comment in the pubspec.yaml file:
# This package is not intended for consumption on pub.dev. DO NOT publish.
publish_to: none
These pubspecs are still validated by the package validation tool. The contents are more informational as the pubspecs for these packages are not consumed by the pub tool or ecosystem.
We validate:
- that the dependencies listed in the pubspec are used in the package
- that all the packages used by the source are listed in the pubspec
- that a reference to a pkg/ package is done via a relative path dependency
Adding new packages
Run gclient sync to re-generate .dart_tool/package_config.json after adding
a new package.
Testing packages
Currently dart test can't be used to run the tests, use test.py as usual.
E.g. the command ./tools/test.py -n...<path> runs all tests with prefix
<path>.