Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Clean up contributing formatting, add a Skia gold callout #50828

Merged
merged 2 commits into from
Feb 22, 2024
Merged

Clean up contributing formatting, add a Skia gold callout #50828

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1202b
Clean up contributing formatting, add a skia gold callout.
matanlurey Feb 21, 2024
07a3309
++
matanlurey Feb 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 63 additions & 40 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,38 @@ with `gn format`.

## Testing

The testing policy for contributing to the flutter engine can be found at the [Tree Hygiene Wiki][tree_hygiene_wiki]. The summary is that all PR's to the engine should be tested or have an explicit test exemption.
The testing policy for contributing to the flutter engine can be found at the
[Tree Hygiene Wiki][tree_hygiene_wiki]. The summary is that all PR's to the
engine should be tested or have an explicit test exemption.

Because the engine targets multiple platforms the testing infrastructure is fairly complicated. Here are some more resources to help guide writing tests:
Because the engine targets multiple platforms the testing infrastructure is
fairly complicated. Here are some more resources to help guide writing tests:

- [Testing the engine wiki][testing_the_engine_wiki] - A guide on writing tests for the engine including an overview of the different tests and the different technologies the engine uses.
- [//testing](./testing) - This is where the `run_tests.py` script is located. All tests will have the ability to be executed with `run_tests.py`.
- [//ci/builders](./ci/builders) - The JSON files that determine how tests are executed on CI.
- [Testing the engine wiki][testing_the_engine_wiki] - A guide on writing tests
for the engine including an overview of the different tests and the different
technologies the engine uses.
- [`//testing`](./testing) - This is where the `run_tests.py` script is located.
All tests will have the ability to be executed with `run_tests.py`.
- [`//ci/builders`](./ci/builders) - The JSON files that determine how tests are
executed on CI.

Tests will be executed on CI, but some tests will be executed before PR's can be merged (presubmit) and others after they have been merged (postsubmit). Ideally everything would be presubmit but tests that take up more resources are executed in postsubmit.
Tests will be executed on CI, but some tests will be executed before PR's can be
merged (presubmit) and others after they have been merged (postsubmit). Ideally
everything would be presubmit but tests that take up more resources are executed
in postsubmit.

### Skia Gold

The Flutter engine uses [Skia Gold][skia_gold] for image comparison tests which fail if:

- The image is different from an accepted baseline.
- An image is not uploaded but is expected to be (see
[`dir_contents_diff`][dir_contents_diff]).

[skia_gold]: https://flutter-engine-gold.skia.org/
[dir_contents_diff]: ./tools/dir_contents_diff/

Any untriaged failures will block presubmit and postsubmit tests.

### Example run_tests.py invocation

Expand All @@ -64,40 +87,40 @@ $ ./run_tests.py --variant=host_debug_unopt_arm64 --type=engine`

### Directory

| Name | run_tests.py type | Description |
|-|-|-|
| accessibility_unittests |engine ||
| client_wrapper_glfw_unittests|engine ||
| client_wrapper_unittests|engine ||
| common_cpp_core_unittests|engine ||
| common_cpp_unittests|engine ||
| dart_plugin_registrant_unittests|engine ||
| display_list_rendertests|engine ||
| display_list_unittests|engine ||
| embedder_a11y_unittests|engine ||
| embedder_proctable_unittests|engine ||
| embedder_unittests|engine ||
| felt| n/a | The test runner for flutter web. See //lib/web_ui |
| flow_unittests| engine ||
| flutter_tester| dart | Launcher for engine dart tests. |
| fml_arc_unittests|engine ||
| fml_unittests|engine | Unit tests for //fml |
| framework_common_unittests| engine(mac) ||
| gpu_surface_metal_unittests| engine(mac)||
| impeller_dart_unittests| engine ||
| impeller_golden_tests| engine(mac)| Generates golden images for impeller (vulkan, metal, opengles).|
| impeller_unittests| engine | impeller unit tests and interactive tests |
| ios_test_flutter| objc | dynamic library of objc tests to be run with XCTest |
| jni_unittests| engine(not windows)||
| no_dart_plugin_registrant_unittests|engine ||
| platform_view_android_delegate_unittests| engine(not windows) ||
| runtime_unittests|engine ||
| shell_unittests|engine(not windows) ||
| scenario_app|android | Integration and golden tests for Android, iOS|
| testing_unittests| engine ||
| tonic_unittests|engine | Unit tests for //third_party/tonic |
| txt_unittests| engine(linux) ||
| ui_unittests|engine ||
| Name | run_tests.py type | Description |
| ---------------------------------------- | ------------------- | --------------------------------------------------------------- |
| accessibility_unittests | engine | |
| client_wrapper_glfw_unittests | engine | |
| client_wrapper_unittests | engine | |
| common_cpp_core_unittests | engine | |
| common_cpp_unittests | engine | |
| dart_plugin_registrant_unittests | engine | |
| display_list_rendertests | engine | |
| display_list_unittests | engine | |
| embedder_a11y_unittests | engine | |
| embedder_proctable_unittests | engine | |
| embedder_unittests | engine | |
| felt | n/a | The test runner for flutter web. See //lib/web_ui |
| flow_unittests | engine | |
| flutter_tester | dart | Launcher for engine dart tests. |
| fml_arc_unittests | engine | |
| fml_unittests | engine | Unit tests for //fml |
| framework_common_unittests | engine(mac) | |
| gpu_surface_metal_unittests | engine(mac) | |
| impeller_dart_unittests | engine | |
| impeller_golden_tests | engine(mac) | Generates golden images for impeller (vulkan, metal, opengles). |
| impeller_unittests | engine | impeller unit tests and interactive tests |
| ios_test_flutter | objc | dynamic library of objc tests to be run with XCTest |
| jni_unittests | engine(not windows) | |
| no_dart_plugin_registrant_unittests | engine | |
| platform_view_android_delegate_unittests | engine(not windows) | |
| runtime_unittests | engine | |
| shell_unittests | engine(not windows) | |
| scenario_app | android | Integration and golden tests for Android, iOS |
| testing_unittests | engine | |
| tonic_unittests | engine | Unit tests for //third_party/tonic |
| txt_unittests | engine(linux) | |
| ui_unittests | engine | |

[tree_hygiene_wiki]: https://github.com/flutter/flutter/wiki/Tree-hygiene#tests
[testing_the_engine_wiki]: https://github.com/flutter/flutter/wiki/Testing-the-engine
Expand Down