Skip to content

Commit ad78cf3

Browse files
authored
Remove deprecated *TestValues from TestWindow (flutter#131098)
Part of flutter#133171. Removes from `TestWindow`: * `localeTestValue` * `clearLocaleTestValue` * `localesTestValue` * `clearLocalesTestValue` * `initialLifecycleStateTestValue` * `alwaysUse24HourFormatTestValue` * `clearAlwaysUse24HourTestValue` * `brieflyShowPasswordTestValue` * `defaultRouteNameTestValue` * `clearDefaultRouteNameTestValue` * `semanticsEnabledTestValue` * `clearSemanticsEnabledTestValue` * `accessibilityFeaturesTestValue` * `clearAccessibilityFeaturesTestValue` These properties have reached the end of their deprecation period.
1 parent 3cfaa34 commit ad78cf3

File tree

3 files changed

+4
-229
lines changed

3 files changed

+4
-229
lines changed

packages/flutter_test/lib/src/binding.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ abstract class TestWidgetsFlutterBinding extends BindingBase
492492
}
493493

494494
/// Re-attempts the initialization of the lifecycle state after providing
495-
/// test values in [TestWindow.initialLifecycleStateTestValue].
495+
/// test values in [TestPlatformDispatcher.initialLifecycleStateTestValue].
496496
void readTestInitialLifecycleStateFromNativeWindow() {
497497
readInitialLifecycleStateFromNativeWindow();
498498
}

packages/flutter_test/lib/src/window.dart

Lines changed: 2 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -1186,7 +1186,7 @@ class _UnsupportedDisplay implements TestDisplay {
11861186
/// If a test needs to override a real [SingletonFlutterWindow] property and
11871187
/// then later return to using the real [SingletonFlutterWindow] property,
11881188
/// [TestWindow] provides methods to clear each individual test value, e.g.,
1189-
/// [clearLocaleTestValue].
1189+
/// [clearDevicePixelRatioTestValue].
11901190
///
11911191
/// To clear all fake test values in a [TestWindow], consider using
11921192
/// [clearAllTestValues].
@@ -1507,22 +1507,6 @@ class TestWindow implements SingletonFlutterWindow {
15071507
)
15081508
@override
15091509
Locale get locale => platformDispatcher.locale;
1510-
/// Hides the real locale and reports the given [localeTestValue] instead.
1511-
@Deprecated(
1512-
'Use WidgetTester.platformDispatcher.localeTestValue instead. '
1513-
'This feature was deprecated after v2.11.0-0.0.pre.'
1514-
)
1515-
set localeTestValue(Locale localeTestValue) { // ignore: avoid_setters_without_getters
1516-
platformDispatcher.localeTestValue = localeTestValue;
1517-
}
1518-
@Deprecated(
1519-
'Use WidgetTester.platformDispatcher.clearLocaleTestValue() instead. '
1520-
'This feature was deprecated after v2.11.0-0.0.pre.'
1521-
)
1522-
/// Deletes any existing test locale and returns to using the real locale.
1523-
void clearLocaleTestValue() {
1524-
platformDispatcher.clearLocaleTestValue();
1525-
}
15261510

15271511
@Deprecated(
15281512
'Use WidgetTester.platformDispatcher.locales instead. '
@@ -1531,22 +1515,6 @@ class TestWindow implements SingletonFlutterWindow {
15311515
)
15321516
@override
15331517
List<Locale> get locales => platformDispatcher.locales;
1534-
/// Hides the real locales and reports the given [localesTestValue] instead.
1535-
@Deprecated(
1536-
'Use WidgetTester.platformDispatcher.localesTestValue instead. '
1537-
'This feature was deprecated after v2.11.0-0.0.pre.'
1538-
)
1539-
set localesTestValue(List<Locale> localesTestValue) { // ignore: avoid_setters_without_getters
1540-
platformDispatcher.localesTestValue = localesTestValue;
1541-
}
1542-
/// Deletes any existing test locales and returns to using the real locales.
1543-
@Deprecated(
1544-
'Use WidgetTester.platformDispatcher.clearLocalesTestValue() instead. '
1545-
'This feature was deprecated after v2.11.0-0.0.pre.'
1546-
)
1547-
void clearLocalesTestValue() {
1548-
platformDispatcher.clearLocalesTestValue();
1549-
}
15501518

15511519
@Deprecated(
15521520
'Use WidgetTester.platformDispatcher.onLocaleChanged instead. '
@@ -1572,14 +1540,6 @@ class TestWindow implements SingletonFlutterWindow {
15721540
)
15731541
@override
15741542
String get initialLifecycleState => platformDispatcher.initialLifecycleState;
1575-
/// Sets a faked initialLifecycleState for testing.
1576-
@Deprecated(
1577-
'Use WidgetTester.platformDispatcher.initialLifecycleStateTestValue instead. '
1578-
'This feature was deprecated after v2.11.0-0.0.pre.'
1579-
)
1580-
set initialLifecycleStateTestValue(String state) { // ignore: avoid_setters_without_getters
1581-
platformDispatcher.initialLifecycleStateTestValue = state;
1582-
}
15831543

15841544
@Deprecated(
15851545
'Use WidgetTester.platformDispatcher.textScaleFactor instead. '
@@ -1656,24 +1616,6 @@ class TestWindow implements SingletonFlutterWindow {
16561616
)
16571617
@override
16581618
bool get alwaysUse24HourFormat => platformDispatcher.alwaysUse24HourFormat;
1659-
/// Hides the real clock format and reports the given
1660-
/// [alwaysUse24HourFormatTestValue] instead.
1661-
@Deprecated(
1662-
'Use WidgetTester.platformDispatcher.alwaysUse24HourFormatTestValue instead. '
1663-
'This feature was deprecated after v2.11.0-0.0.pre.'
1664-
)
1665-
set alwaysUse24HourFormatTestValue(bool alwaysUse24HourFormatTestValue) { // ignore: avoid_setters_without_getters
1666-
platformDispatcher.alwaysUse24HourFormatTestValue = alwaysUse24HourFormatTestValue;
1667-
}
1668-
/// Deletes any existing test clock format and returns to using the real clock
1669-
/// format.
1670-
@Deprecated(
1671-
'Use WidgetTester.platformDispatcher.clearAlwaysUse24HourTestValue() instead. '
1672-
'This feature was deprecated after v2.11.0-0.0.pre.'
1673-
)
1674-
void clearAlwaysUse24HourTestValue() {
1675-
platformDispatcher.clearAlwaysUse24HourTestValue();
1676-
}
16771619

16781620
@Deprecated(
16791621
'Use WidgetTester.platformDispatcher.onTextScaleFactorChanged instead. '
@@ -1715,15 +1657,6 @@ class TestWindow implements SingletonFlutterWindow {
17151657
)
17161658
@override
17171659
bool get brieflyShowPassword => platformDispatcher.brieflyShowPassword;
1718-
/// Hides the real [brieflyShowPassword] and reports the given
1719-
/// `brieflyShowPasswordTestValue` instead.
1720-
@Deprecated(
1721-
'Use WidgetTester.platformDispatcher.brieflyShowPasswordTestValue instead. '
1722-
'This feature was deprecated after v2.11.0-0.0.pre.'
1723-
)
1724-
set brieflyShowPasswordTestValue(bool brieflyShowPasswordTestValue) { // ignore: avoid_setters_without_getters
1725-
platformDispatcher.brieflyShowPasswordTestValue = brieflyShowPasswordTestValue;
1726-
}
17271660

17281661
@Deprecated(
17291662
'Use WidgetTester.platformDispatcher.onBeginFrame instead. '
@@ -1800,24 +1733,6 @@ class TestWindow implements SingletonFlutterWindow {
18001733
)
18011734
@override
18021735
String get defaultRouteName => platformDispatcher.defaultRouteName;
1803-
/// Hides the real default route name and reports the given
1804-
/// [defaultRouteNameTestValue] instead.
1805-
@Deprecated(
1806-
'Use WidgetTester.platformDispatcher.defaultRouteNameTestValue instead. '
1807-
'This feature was deprecated after v2.11.0-0.0.pre.'
1808-
)
1809-
set defaultRouteNameTestValue(String defaultRouteNameTestValue) { // ignore: avoid_setters_without_getters
1810-
platformDispatcher.defaultRouteNameTestValue = defaultRouteNameTestValue;
1811-
}
1812-
/// Deletes any existing test default route name and returns to using the real
1813-
/// default route name.
1814-
@Deprecated(
1815-
'Use WidgetTester.platformDispatcher.clearDefaultRouteNameTestValue() instead. '
1816-
'This feature was deprecated after v2.11.0-0.0.pre.'
1817-
)
1818-
void clearDefaultRouteNameTestValue() {
1819-
platformDispatcher.clearDefaultRouteNameTestValue();
1820-
}
18211736

18221737
@Deprecated(
18231738
'Use WidgetTester.platformDispatcher.scheduleFrame() instead. '
@@ -1846,24 +1761,6 @@ class TestWindow implements SingletonFlutterWindow {
18461761
)
18471762
@override
18481763
bool get semanticsEnabled => platformDispatcher.semanticsEnabled;
1849-
/// Hides the real semantics enabled and reports the given
1850-
/// [semanticsEnabledTestValue] instead.
1851-
@Deprecated(
1852-
'Use WidgetTester.platformDispatcher.semanticsEnabledTestValue instead. '
1853-
'This feature was deprecated after v2.11.0-0.0.pre.'
1854-
)
1855-
set semanticsEnabledTestValue(bool semanticsEnabledTestValue) { // ignore: avoid_setters_without_getters
1856-
platformDispatcher.semanticsEnabledTestValue = semanticsEnabledTestValue;
1857-
}
1858-
/// Deletes any existing test semantics enabled and returns to using the real
1859-
/// semantics enabled.
1860-
@Deprecated(
1861-
'Use WidgetTester.platformDispatcher.clearSemanticsEnabledTestValue() instead. '
1862-
'This feature was deprecated after v2.11.0-0.0.pre.'
1863-
)
1864-
void clearSemanticsEnabledTestValue() {
1865-
platformDispatcher.clearSemanticsEnabledTestValue();
1866-
}
18671764

18681765
@Deprecated(
18691766
'Use WidgetTester.platformDispatcher.onSemanticsEnabledChanged instead. '
@@ -1889,27 +1786,6 @@ class TestWindow implements SingletonFlutterWindow {
18891786
)
18901787
@override
18911788
AccessibilityFeatures get accessibilityFeatures => platformDispatcher.accessibilityFeatures;
1892-
/// Hides the real accessibility features and reports the given
1893-
/// [accessibilityFeaturesTestValue] instead.
1894-
///
1895-
/// Consider using [FakeAccessibilityFeatures] to provide specific
1896-
/// values for the various accessibility features under test.
1897-
@Deprecated(
1898-
'Use WidgetTester.platformDispatcher.accessibilityFeaturesTestValue instead. '
1899-
'This feature was deprecated after v2.11.0-0.0.pre.'
1900-
)
1901-
set accessibilityFeaturesTestValue(AccessibilityFeatures accessibilityFeaturesTestValue) { // ignore: avoid_setters_without_getters
1902-
platformDispatcher.accessibilityFeaturesTestValue = accessibilityFeaturesTestValue;
1903-
}
1904-
/// Deletes any existing test accessibility features and returns to using the
1905-
/// real accessibility features.
1906-
@Deprecated(
1907-
'Use WidgetTester.platformDispatcher.clearAccessibilityFeaturesTestValue() instead. '
1908-
'This feature was deprecated after v2.11.0-0.0.pre.'
1909-
)
1910-
void clearAccessibilityFeaturesTestValue() {
1911-
platformDispatcher.clearAccessibilityFeaturesTestValue();
1912-
}
19131789

19141790
@Deprecated(
19151791
'Use WidgetTester.platformDispatcher.onAccessibilityFeaturesChanged instead. '
@@ -1984,7 +1860,7 @@ class TestWindow implements SingletonFlutterWindow {
19841860
/// [PlatformDispatcher] values are reported again.
19851861
///
19861862
/// If desired, clearing of properties can be done on an individual basis,
1987-
/// e.g., [clearLocaleTestValue].
1863+
/// e.g., [clearDevicePixelRatioTestValue].
19881864
@Deprecated(
19891865
'Use WidgetTester.platformDispatcher.clearAllTestValues() and WidgetTester.view.reset() instead. '
19901866
'Deprecated to prepare for the upcoming multi-window support. '

packages/flutter_test/test/window_test.dart

Lines changed: 1 addition & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import 'dart:ui' as ui show window;
99
import 'dart:ui';
1010

11-
import 'package:flutter/widgets.dart' show WidgetsBinding, WidgetsBindingObserver;
11+
import 'package:flutter/widgets.dart' show WidgetsBinding;
1212
import 'package:flutter_test/flutter_test.dart';
1313

1414
import 'utils/fake_and_mock_utils.dart';
@@ -83,34 +83,6 @@ void main() {
8383
);
8484
});
8585

86-
testWidgets('TestWindow can fake locale', (WidgetTester tester) async {
87-
verifyPropertyFaked<Locale>(
88-
tester: tester,
89-
realValue: ui.window.locale,
90-
fakeValue: const Locale('fake_language_code'),
91-
propertyRetriever: () {
92-
return WidgetsBinding.instance.window.locale;
93-
},
94-
propertyFaker: (TestWidgetsFlutterBinding binding, Locale fakeValue) {
95-
binding.window.localeTestValue = fakeValue;
96-
},
97-
);
98-
});
99-
100-
testWidgets('TestWindow can fake locales', (WidgetTester tester) async {
101-
verifyPropertyFaked<List<Locale>>(
102-
tester: tester,
103-
realValue: ui.window.locales,
104-
fakeValue: <Locale>[const Locale('fake_language_code')],
105-
propertyRetriever: () {
106-
return WidgetsBinding.instance.window.locales;
107-
},
108-
propertyFaker: (TestWidgetsFlutterBinding binding, List<Locale> fakeValue) {
109-
binding.window.localesTestValue = fakeValue;
110-
},
111-
);
112-
});
113-
11486
testWidgets('TestWindow can fake text scale factor', (WidgetTester tester) async {
11587
verifyPropertyFaked<double>(
11688
tester: tester,
@@ -125,60 +97,6 @@ void main() {
12597
);
12698
});
12799

128-
testWidgets('TestWindow can fake clock format', (WidgetTester tester) async {
129-
verifyPropertyFaked<bool>(
130-
tester: tester,
131-
realValue: ui.window.alwaysUse24HourFormat,
132-
fakeValue: !ui.window.alwaysUse24HourFormat,
133-
propertyRetriever: () {
134-
return WidgetsBinding.instance.window.alwaysUse24HourFormat;
135-
},
136-
propertyFaker: (TestWidgetsFlutterBinding binding, bool fakeValue) {
137-
binding.window.alwaysUse24HourFormatTestValue = fakeValue;
138-
},
139-
);
140-
});
141-
142-
testWidgets('TestWindow can fake brieflyShowPassword', (WidgetTester tester) async {
143-
verifyPropertyFaked<bool>(
144-
tester: tester,
145-
realValue: ui.window.brieflyShowPassword,
146-
fakeValue: !ui.window.brieflyShowPassword,
147-
propertyRetriever: () => WidgetsBinding.instance.window.brieflyShowPassword,
148-
propertyFaker: (TestWidgetsFlutterBinding binding, bool fakeValue) {
149-
binding.window.brieflyShowPasswordTestValue = fakeValue;
150-
},
151-
);
152-
});
153-
154-
testWidgets('TestWindow can fake default route name', (WidgetTester tester) async {
155-
verifyPropertyFaked<String>(
156-
tester: tester,
157-
realValue: ui.window.defaultRouteName,
158-
fakeValue: 'fake_route',
159-
propertyRetriever: () {
160-
return WidgetsBinding.instance.window.defaultRouteName;
161-
},
162-
propertyFaker: (TestWidgetsFlutterBinding binding, String fakeValue) {
163-
binding.window.defaultRouteNameTestValue = fakeValue;
164-
},
165-
);
166-
});
167-
168-
testWidgets('TestWindow can fake accessibility features', (WidgetTester tester) async {
169-
verifyPropertyFaked<AccessibilityFeatures>(
170-
tester: tester,
171-
realValue: ui.window.accessibilityFeatures,
172-
fakeValue: const FakeAccessibilityFeatures(),
173-
propertyRetriever: () {
174-
return WidgetsBinding.instance.window.accessibilityFeatures;
175-
},
176-
propertyFaker: (TestWidgetsFlutterBinding binding, AccessibilityFeatures fakeValue) {
177-
binding.window.accessibilityFeaturesTestValue = fakeValue;
178-
},
179-
);
180-
});
181-
182100
testWidgets('TestWindow can fake platform brightness', (WidgetTester tester) async {
183101
verifyPropertyFaked<Brightness>(
184102
tester: tester,
@@ -210,16 +128,6 @@ void main() {
210128
expect(WidgetsBinding.instance.window.textScaleFactor, originalTextScaleFactor);
211129
});
212130

213-
testWidgets('TestWindow sends fake locales when WidgetsBindingObserver notifiers are called', (WidgetTester tester) async {
214-
final List<Locale> defaultLocales = WidgetsBinding.instance.window.locales;
215-
final TestObserver observer = TestObserver();
216-
retrieveTestBinding(tester).addObserver(observer);
217-
final List<Locale> expectedValue = <Locale>[const Locale('fake_language_code')];
218-
retrieveTestBinding(tester).window.localesTestValue = expectedValue;
219-
expect(observer.locales, equals(expectedValue));
220-
retrieveTestBinding(tester).window.localesTestValue = defaultLocales;
221-
});
222-
223131
testWidgets('Updates to window also update tester.view', (WidgetTester tester) async {
224132
tester.binding.window.devicePixelRatioTestValue = 7;
225133
tester.binding.window.displayFeaturesTestValue = <DisplayFeature>[const DisplayFeature(bounds: Rect.fromLTWH(0, 0, 20, 300), type: DisplayFeatureType.unknown, state: DisplayFeatureState.unknown)];
@@ -240,12 +148,3 @@ void main() {
240148
expect(tester.binding.window.gestureSettings, tester.view.gestureSettings);
241149
});
242150
}
243-
244-
class TestObserver with WidgetsBindingObserver {
245-
List<Locale>? locales;
246-
247-
@override
248-
void didChangeLocales(List<Locale>? locales) {
249-
this.locales = locales;
250-
}
251-
}

0 commit comments

Comments
 (0)