Refactor writing of package config in tests #163734

sigurdm · 2025-02-20T15:41:31Z

Seems like each test had its own way of doing this.

Extracted from #160443

flutter-dashboard · 2025-02-20T15:59:01Z

This pull request has been changed to a draft. The currently pending flutter-gold status will not be able to resolve until a new commit is pushed or the change is marked ready for review again.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

matanlurey

LGTM, Approval.

A few minor suggestions that are not blocking.

matanlurey · 2025-02-24T20:04:43Z

packages/flutter_tools/test/src/package_config.dart

+/// [otherLibs] maps other package names to their `rootUri` relative to `directory`.
+///
+/// Returns the `File` Object representing the package config.
+File writePackageConfigFile({


This is more of a clarification question than a block:

Why do this instead of just Iterable<Package> packages (from package:package_config)?

Is there something that is gained other than a bit of code tersity?

i.e. https://github.com/flutter/flutter/blob/8ad78cce13cf39e71398c9016d84f42b6bc091ae/packages/flutter_tools/test/src/package_config.dart.

I did not really consider using a list of Package but looking at the constructor, it requires repeating the root uri (the location of the package config)
I think that makes it kinda unergonomic.

Also the Package.packageUri getter is always absolute, meaning no easy way to test relative paths.

I think I'll keep this for now, though I can see how a list of packages could make sense

matanlurey · 2025-02-24T20:06:39Z

packages/flutter_tools/test/src/package_config.dart

+///
+/// Returns the `File` Object representing the package config.
+File writePackageConfigFile({
+  Directory? directory,


I would prefer to make this explicit (required non-null) instead of falling back to globals.fs.currentDirectory; the tests that want this behavior can write it themselves IMO.

matanlurey · 2025-02-24T20:07:42Z

packages/flutter_tools/test/src/package_config.dart

+/// Returns the `File` Object representing the package config.
+File writePackageConfigFile({
+  Directory? directory,
+  String mainLibName = 'my_app',


Ditto, I would make this required instead of assuming a default.

…163734)

Roll Flutter from 2e570ca to 842db35 (59 revisions) flutter/flutter@2e570ca...842db35 2025-03-02 [email protected] Roll Skia from ad64415050aa to 101eee8fce59 (1 revision) (flutter/flutter#164449) 2025-03-02 [email protected] Roll Fuchsia Linux SDK from ln3joxJfRN2XGhvCv... to AO1KirSDI7-MVYNPN... (flutter/flutter#164440) 2025-03-02 [email protected] android: Clean up gen_snapshot artifact build (flutter/flutter#164418) 2025-03-02 [email protected] Start using `bin/cache/engine.{stamp|realm}` instead of `bin/internal/engine.{realm|version}`. (flutter/flutter#164352) 2025-03-01 [email protected] Add macos/android_debug_unopt to local_engine.json (flutter/flutter#164410) 2025-03-01 [email protected] Delete unused build archive targets (flutter/flutter#164414) 2025-03-01 [email protected] Roll Fuchsia Linux SDK from QMun2itYrV_zUYrvW... to ln3joxJfRN2XGhvCv... (flutter/flutter#164423) 2025-03-01 [email protected] Roll Skia from ac14158663ea to ad64415050aa (1 revision) (flutter/flutter#164413) 2025-03-01 [email protected] Update linux_host_engine.json ci/host_release description (flutter/flutter#164402) 2025-03-01 [email protected] In update_engine_version_test.dart, do not populate the test environment with the host platform environment (flutter/flutter#164395) 2025-03-01 [email protected] Roll-forward #164317: Use `bin/cache/engine.stamp` (flutter/flutter#164401) 2025-02-28 [email protected] Make pressing and moving on CupertinoButton closer to native behavior. (flutter/flutter#161731) 2025-02-28 [email protected] Roll Skia from 4005ba3ca7b6 to ac14158663ea (7 revisions) (flutter/flutter#164404) 2025-02-28 [email protected] [macOS] Prepare FlutterKeyboardManager for multi-view (flutter/flutter#163962) 2025-02-28 [email protected] Add PlatformDispatcher.engineId (flutter/flutter#163476) 2025-02-28 [email protected] Move `integration_test.FlutterDeviceScreenshotTest` to the framework slow shard (flutter/flutter#164398) 2025-02-28 [email protected] Fix: Update DelegatedTransition animation parameter correctly (flutter/flutter#163853) 2025-02-28 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Write an identical value to `bin/cache/engine.stamp` to prepare for migration (#164317)" (flutter/flutter#164396) 2025-02-28 [email protected] Add action for configuring default action of EditableText.onTapUpOutside (flutter/flutter#162575) 2025-02-28 [email protected] Align jvmTarget usages across codebase, while editing build.gradle files align them with android version documentation (flutter/flutter#164200) 2025-02-28 [email protected] Roll Packages from 01d3d5c to 70b41e1 (5 revisions) (flutter/flutter#164380) 2025-02-28 [email protected] [tool] Allow using archiveName in android bundle build (flutter/flutter#162390) 2025-02-28 [email protected] Fix incorrectly checking for invalid environment variables in the tool (flutter/flutter#164101) 2025-02-28 [email protected] Support forward and back buttons (flutter/flutter#164356) 2025-02-28 [email protected] Fix window creation callback for multi-window (flutter/flutter#164353) 2025-02-28 [email protected] Fix flutter doctor usage of eglinfo in failure cases. (flutter/flutter#164334) 2025-02-28 [email protected] Refactor writing of package config in tests (flutter/flutter#163734) 2025-02-28 [email protected] Fixed the issue that Slider's secondaryTrackValue is not updated. (flutter/flutter#163996) 2025-02-28 [email protected] Roll pub packages (flutter/flutter#164357) 2025-02-28 [email protected] Remove `Mac mac_unopt` presubmit retry count (flutter/flutter#164350) 2025-02-28 [email protected] Roll Fuchsia Linux SDK from 1elkOxihZuTEiTXzY... to QMun2itYrV_zUYrvW... (flutter/flutter#164351) 2025-02-28 [email protected] Drag handles only need to be tested on mobile platforms. (flutter/flutter#163723) 2025-02-28 [email protected] [Android] Use java for looking up Android API level. (flutter/flutter#163558) 2025-02-28 [email protected] Write an identical value to `bin/cache/engine.stamp` to prepare for migration (flutter/flutter#164317) 2025-02-27 [email protected] Wires up expanded state in web engine (flutter/flutter#164048) 2025-02-27 [email protected] Remove Cheserton's File (flutter/flutter#164340) 2025-02-27 [email protected] Replace update semantics handler with signal. (flutter/flutter#163583) 2025-02-27 [email protected] Split up the conical gradient fragment shader (flutter/flutter#164058) 2025-02-27 [email protected] Roll Skia from c16b145749d4 to 4005ba3ca7b6 (3 revisions) (flutter/flutter#164339) 2025-02-27 [email protected] Delete and update stale documentation regarding engine/engine hash. (flutter/flutter#164324) 2025-02-27 [email protected] Document how `engine.version` (is/will be) computed (flutter/flutter#164335) 2025-02-27 [email protected] Update conductor to write engine.version file (flutter/flutter#163350) 2025-02-27 [email protected] remove last usages of min/compile/target SdkVersion, align sourceCompatibility across repo and update android version documentation (flutter/flutter#164198) 2025-02-27 [email protected] Update links to the `flutter/engine` repository for the monorepo. (flutter/flutter#164328) 2025-02-27 [email protected] Add empty `io.flutter.app.FlutterApplication` to give deprecation notice, and un-break projects that have not migrated (flutter/flutter#164233) 2025-02-27 [email protected] Revert dart sdks that were causing dartaotruntime issues in g3 (flutter/flutter#164307) ...

…163734)

Roll Flutter from 2e570ca to 842db35 (59 revisions) flutter/flutter@2e570ca...842db35 2025-03-02 [email protected] Roll Skia from ad64415050aa to 101eee8fce59 (1 revision) (flutter/flutter#164449) 2025-03-02 [email protected] Roll Fuchsia Linux SDK from ln3joxJfRN2XGhvCv... to AO1KirSDI7-MVYNPN... (flutter/flutter#164440) 2025-03-02 [email protected] android: Clean up gen_snapshot artifact build (flutter/flutter#164418) 2025-03-02 [email protected] Start using `bin/cache/engine.{stamp|realm}` instead of `bin/internal/engine.{realm|version}`. (flutter/flutter#164352) 2025-03-01 [email protected] Add macos/android_debug_unopt to local_engine.json (flutter/flutter#164410) 2025-03-01 [email protected] Delete unused build archive targets (flutter/flutter#164414) 2025-03-01 [email protected] Roll Fuchsia Linux SDK from QMun2itYrV_zUYrvW... to ln3joxJfRN2XGhvCv... (flutter/flutter#164423) 2025-03-01 [email protected] Roll Skia from ac14158663ea to ad64415050aa (1 revision) (flutter/flutter#164413) 2025-03-01 [email protected] Update linux_host_engine.json ci/host_release description (flutter/flutter#164402) 2025-03-01 [email protected] In update_engine_version_test.dart, do not populate the test environment with the host platform environment (flutter/flutter#164395) 2025-03-01 [email protected] Roll-forward #164317: Use `bin/cache/engine.stamp` (flutter/flutter#164401) 2025-02-28 [email protected] Make pressing and moving on CupertinoButton closer to native behavior. (flutter/flutter#161731) 2025-02-28 [email protected] Roll Skia from 4005ba3ca7b6 to ac14158663ea (7 revisions) (flutter/flutter#164404) 2025-02-28 [email protected] [macOS] Prepare FlutterKeyboardManager for multi-view (flutter/flutter#163962) 2025-02-28 [email protected] Add PlatformDispatcher.engineId (flutter/flutter#163476) 2025-02-28 [email protected] Move `integration_test.FlutterDeviceScreenshotTest` to the framework slow shard (flutter/flutter#164398) 2025-02-28 [email protected] Fix: Update DelegatedTransition animation parameter correctly (flutter/flutter#163853) 2025-02-28 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Write an identical value to `bin/cache/engine.stamp` to prepare for migration (#164317)" (flutter/flutter#164396) 2025-02-28 [email protected] Add action for configuring default action of EditableText.onTapUpOutside (flutter/flutter#162575) 2025-02-28 [email protected] Align jvmTarget usages across codebase, while editing build.gradle files align them with android version documentation (flutter/flutter#164200) 2025-02-28 [email protected] Roll Packages from 01d3d5c to 70b41e1 (5 revisions) (flutter/flutter#164380) 2025-02-28 [email protected] [tool] Allow using archiveName in android bundle build (flutter/flutter#162390) 2025-02-28 [email protected] Fix incorrectly checking for invalid environment variables in the tool (flutter/flutter#164101) 2025-02-28 [email protected] Support forward and back buttons (flutter/flutter#164356) 2025-02-28 [email protected] Fix window creation callback for multi-window (flutter/flutter#164353) 2025-02-28 [email protected] Fix flutter doctor usage of eglinfo in failure cases. (flutter/flutter#164334) 2025-02-28 [email protected] Refactor writing of package config in tests (flutter/flutter#163734) 2025-02-28 [email protected] Fixed the issue that Slider's secondaryTrackValue is not updated. (flutter/flutter#163996) 2025-02-28 [email protected] Roll pub packages (flutter/flutter#164357) 2025-02-28 [email protected] Remove `Mac mac_unopt` presubmit retry count (flutter/flutter#164350) 2025-02-28 [email protected] Roll Fuchsia Linux SDK from 1elkOxihZuTEiTXzY... to QMun2itYrV_zUYrvW... (flutter/flutter#164351) 2025-02-28 [email protected] Drag handles only need to be tested on mobile platforms. (flutter/flutter#163723) 2025-02-28 [email protected] [Android] Use java for looking up Android API level. (flutter/flutter#163558) 2025-02-28 [email protected] Write an identical value to `bin/cache/engine.stamp` to prepare for migration (flutter/flutter#164317) 2025-02-27 [email protected] Wires up expanded state in web engine (flutter/flutter#164048) 2025-02-27 [email protected] Remove Cheserton's File (flutter/flutter#164340) 2025-02-27 [email protected] Replace update semantics handler with signal. (flutter/flutter#163583) 2025-02-27 [email protected] Split up the conical gradient fragment shader (flutter/flutter#164058) 2025-02-27 [email protected] Roll Skia from c16b145749d4 to 4005ba3ca7b6 (3 revisions) (flutter/flutter#164339) 2025-02-27 [email protected] Delete and update stale documentation regarding engine/engine hash. (flutter/flutter#164324) 2025-02-27 [email protected] Document how `engine.version` (is/will be) computed (flutter/flutter#164335) 2025-02-27 [email protected] Update conductor to write engine.version file (flutter/flutter#163350) 2025-02-27 [email protected] remove last usages of min/compile/target SdkVersion, align sourceCompatibility across repo and update android version documentation (flutter/flutter#164198) 2025-02-27 [email protected] Update links to the `flutter/engine` repository for the monorepo. (flutter/flutter#164328) 2025-02-27 [email protected] Add empty `io.flutter.app.FlutterApplication` to give deprecation notice, and un-break projects that have not migrated (flutter/flutter#164233) 2025-02-27 [email protected] Revert dart sdks that were causing dartaotruntime issues in g3 (flutter/flutter#164307) ...

github-actions bot added tool Affects the "flutter" command-line tool. See also t: labels. a: desktop Running on desktop team-ios Owned by iOS platform team labels Feb 20, 2025

sigurdm force-pushed the package_conf_tests branch from 8683870 to bd75100 Compare February 20, 2025 15:48

sigurdm marked this pull request as draft February 20, 2025 15:55

Refactor writing of package config in tests

e6f7027

sigurdm force-pushed the package_conf_tests branch from bd75100 to e6f7027 Compare February 20, 2025 16:02

sigurdm added 9 commits February 21, 2025 09:25

Blank line after license header

020aa3a

Fix directory in asset_bundle_test

b35f300

Fix dart_plugin_test

45651fa

Allow specifying language versions

954ce2c

Lints

d9e41fd

fix copyright year

05b00fd

Fix test expectation

98b9dc8

provide language version for dart_plugin_registrant_test

f8341da

Merge remote-tracking branch 'origin/master' into package_conf_tests

14247fc

sigurdm mentioned this pull request Feb 24, 2025

Convert manual writes of package_config.json to more structured output. #163892

Closed

sigurdm marked this pull request as ready for review February 24, 2025 09:54

sigurdm requested a review from matanlurey February 24, 2025 09:54

matanlurey approved these changes Feb 24, 2025

View reviewed changes

Make mainLibName and directory required

e4afac9

sigurdm requested a review from jmagman as a code owner February 27, 2025 12:38

sigurdm added this pull request to the merge queue Feb 28, 2025

Merged via the queue into flutter:master with commit 45b21ec Feb 28, 2025
176 checks passed

sigurdm deleted the package_conf_tests branch February 28, 2025 09:19

engine-flutter-autoroll mentioned this pull request Feb 28, 2025

Roll Flutter from 2e570ca393c8 to 25b3a4743a84 (35 revisions) flutter/packages#8755

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 28, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

fd39c8a

…163734)

engine-flutter-autoroll mentioned this pull request Feb 28, 2025

Roll Flutter from 2e570ca393c8 to 933cb5da82c4 (36 revisions) flutter/packages#8756

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 28, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

e52f2c6

…163734)

engine-flutter-autoroll mentioned this pull request Feb 28, 2025

Roll Flutter from 2e570ca393c8 to b8902e6a1746 (38 revisions) flutter/packages#8759

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 28, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

c898e62

…163734)

engine-flutter-autoroll mentioned this pull request Feb 28, 2025

Roll Flutter from 2e570ca393c8 to 787adc75ed35 (39 revisions) flutter/packages#8762

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 28, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

47e0d23

…163734)

engine-flutter-autoroll mentioned this pull request Feb 28, 2025

Roll Flutter from 2e570ca393c8 to 845c7779b802 (40 revisions) flutter/packages#8763

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 28, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

715853e

…163734)

engine-flutter-autoroll mentioned this pull request Mar 1, 2025

Roll Flutter from 2e570ca393c8 to 0c055f2c508a (55 revisions) flutter/packages#8767

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 1, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

3486d89

…163734)

engine-flutter-autoroll mentioned this pull request Mar 1, 2025

Roll Flutter from 2e570ca393c8 to 0c055f2c508a (55 revisions) flutter/packages#8768

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 1, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

87d16e4

…163734)

engine-flutter-autoroll mentioned this pull request Mar 2, 2025

Roll Flutter from 2e570ca393c8 to 619d4248114d (58 revisions) flutter/packages#8769

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 2, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

a7697d6

…163734)

engine-flutter-autoroll mentioned this pull request Mar 2, 2025

Roll Flutter from 2e570ca393c8 to 842db35d27b8 (59 revisions) flutter/packages#8770

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 2, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

96db701

…163734)

engine-flutter-autoroll mentioned this pull request Mar 2, 2025

Roll Flutter from 2e570ca393c8 to 842db35d27b8 (59 revisions) flutter/packages#8771

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 2, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

381571e

…163734)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

1ad3c7a

…163734)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

75076e7

…163734)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025

45b21ec Refactor writing of package config in tests (flutter/flutter#…

6acd3b6

…163734)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refactor writing of package config in tests #163734

Refactor writing of package config in tests #163734

Uh oh!

sigurdm commented Feb 20, 2025

Uh oh!

flutter-dashboard bot commented Feb 20, 2025

Uh oh!

matanlurey left a comment

Uh oh!

matanlurey Feb 24, 2025

Uh oh!

sigurdm Feb 25, 2025

Uh oh!

matanlurey Feb 24, 2025

Uh oh!

sigurdm Feb 25, 2025

Uh oh!

matanlurey Feb 24, 2025

Uh oh!

sigurdm Feb 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Refactor writing of package config in tests #163734

Refactor writing of package config in tests #163734

Uh oh!

Conversation

sigurdm commented Feb 20, 2025

Uh oh!

flutter-dashboard bot commented Feb 20, 2025

Uh oh!

matanlurey left a comment

Choose a reason for hiding this comment

Uh oh!

matanlurey Feb 24, 2025

Choose a reason for hiding this comment

Uh oh!

sigurdm Feb 25, 2025

Choose a reason for hiding this comment

Uh oh!

matanlurey Feb 24, 2025

Choose a reason for hiding this comment

Uh oh!

sigurdm Feb 25, 2025

Choose a reason for hiding this comment

Uh oh!

matanlurey Feb 24, 2025

Choose a reason for hiding this comment

Uh oh!

sigurdm Feb 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants