387 lines
13 KiB
Dart
387 lines
13 KiB
Dart
// Copyright 2014 The Flutter Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
// found in the LICENSE file.
|
|
|
|
import 'dart:ui' as ui show AppLifecycleState;
|
|
|
|
import 'package:flutter/foundation.dart';
|
|
import 'package:flutter/services.dart';
|
|
import 'package:flutter_test/flutter_test.dart';
|
|
|
|
void main() {
|
|
TestWidgetsFlutterBinding.ensureInitialized();
|
|
|
|
testWidgets('SystemChrome overlay style test', (WidgetTester tester) async {
|
|
final log = <MethodCall>[];
|
|
|
|
TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler(
|
|
SystemChannels.platform,
|
|
(MethodCall methodCall) async {
|
|
log.add(methodCall);
|
|
return null;
|
|
},
|
|
);
|
|
|
|
// The first call is a cache miss and will queue a microtask
|
|
SystemChrome.setSystemUIOverlayStyle(SystemUiOverlayStyle.light);
|
|
expect(tester.binding.microtaskCount, equals(1));
|
|
|
|
// Flush all microtasks
|
|
await tester.idle();
|
|
expect(log, hasLength(1));
|
|
expect(
|
|
log.single,
|
|
isMethodCall(
|
|
'SystemChrome.setSystemUIOverlayStyle',
|
|
arguments: <String, dynamic>{
|
|
'systemNavigationBarColor': 4278190080,
|
|
'systemNavigationBarDividerColor': null,
|
|
'systemStatusBarContrastEnforced': null,
|
|
'statusBarColor': null,
|
|
'statusBarBrightness': 'Brightness.dark',
|
|
'statusBarIconBrightness': 'Brightness.light',
|
|
'systemNavigationBarIconBrightness': 'Brightness.light',
|
|
'systemNavigationBarContrastEnforced': null,
|
|
},
|
|
),
|
|
);
|
|
log.clear();
|
|
expect(tester.binding.microtaskCount, equals(0));
|
|
expect(log.isEmpty, isTrue);
|
|
|
|
// The second call with the same value should be a no-op
|
|
SystemChrome.setSystemUIOverlayStyle(SystemUiOverlayStyle.light);
|
|
expect(tester.binding.microtaskCount, equals(0));
|
|
|
|
SystemChrome.setSystemUIOverlayStyle(
|
|
const SystemUiOverlayStyle(
|
|
systemStatusBarContrastEnforced: false,
|
|
systemNavigationBarContrastEnforced: true,
|
|
),
|
|
);
|
|
expect(tester.binding.microtaskCount, equals(1));
|
|
await tester.idle();
|
|
expect(log, hasLength(1));
|
|
expect(
|
|
log.single,
|
|
isMethodCall(
|
|
'SystemChrome.setSystemUIOverlayStyle',
|
|
arguments: <String, dynamic>{
|
|
'systemNavigationBarColor': null,
|
|
'systemNavigationBarDividerColor': null,
|
|
'systemStatusBarContrastEnforced': false,
|
|
'statusBarColor': null,
|
|
'statusBarBrightness': null,
|
|
'statusBarIconBrightness': null,
|
|
'systemNavigationBarIconBrightness': null,
|
|
'systemNavigationBarContrastEnforced': true,
|
|
},
|
|
),
|
|
);
|
|
});
|
|
|
|
test('setPreferredOrientations control test', () async {
|
|
final log = <MethodCall>[];
|
|
|
|
TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler(
|
|
SystemChannels.platform,
|
|
(MethodCall methodCall) async {
|
|
log.add(methodCall);
|
|
return null;
|
|
},
|
|
);
|
|
|
|
await SystemChrome.setPreferredOrientations(<DeviceOrientation>[DeviceOrientation.portraitUp]);
|
|
|
|
expect(log, hasLength(1));
|
|
expect(
|
|
log.single,
|
|
isMethodCall(
|
|
'SystemChrome.setPreferredOrientations',
|
|
arguments: <String>['DeviceOrientation.portraitUp'],
|
|
),
|
|
);
|
|
});
|
|
|
|
test('setApplicationSwitcherDescription control test', () async {
|
|
final log = <MethodCall>[];
|
|
|
|
TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler(
|
|
SystemChannels.platform,
|
|
(MethodCall methodCall) async {
|
|
log.add(methodCall);
|
|
return null;
|
|
},
|
|
);
|
|
|
|
await SystemChrome.setApplicationSwitcherDescription(
|
|
const ApplicationSwitcherDescription(label: 'Example label', primaryColor: 0xFF00FF00),
|
|
);
|
|
|
|
expect(log, hasLength(1));
|
|
expect(
|
|
log.single,
|
|
isMethodCall(
|
|
'SystemChrome.setApplicationSwitcherDescription',
|
|
arguments: <String, dynamic>{'label': 'Example label', 'primaryColor': 4278255360},
|
|
),
|
|
);
|
|
});
|
|
|
|
test('setApplicationSwitcherDescription missing plugin', () async {
|
|
final List<ByteData?> log = <ByteData>[];
|
|
|
|
TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMessageHandler(
|
|
'flutter/platform',
|
|
(ByteData? message) async {
|
|
log.add(message);
|
|
return null;
|
|
},
|
|
);
|
|
|
|
await SystemChrome.setApplicationSwitcherDescription(
|
|
const ApplicationSwitcherDescription(label: 'Example label', primaryColor: 0xFF00FF00),
|
|
);
|
|
|
|
expect(log, isNotEmpty);
|
|
});
|
|
|
|
test('setEnabledSystemUIMode control test', () async {
|
|
final log = <MethodCall>[];
|
|
|
|
TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler(
|
|
SystemChannels.platform,
|
|
(MethodCall methodCall) async {
|
|
log.add(methodCall);
|
|
return null;
|
|
},
|
|
);
|
|
|
|
await SystemChrome.setEnabledSystemUIMode(SystemUiMode.leanBack);
|
|
|
|
expect(log, hasLength(1));
|
|
expect(
|
|
log.single,
|
|
isMethodCall('SystemChrome.setEnabledSystemUIMode', arguments: 'SystemUiMode.leanBack'),
|
|
);
|
|
});
|
|
|
|
test('setEnabledSystemUIMode asserts for overlays in manual configuration', () async {
|
|
expect(
|
|
() async {
|
|
await SystemChrome.setEnabledSystemUIMode(SystemUiMode.manual);
|
|
},
|
|
throwsA(
|
|
isA<AssertionError>().having(
|
|
(AssertionError error) => error.toString(),
|
|
'description',
|
|
contains('mode == SystemUiMode.manual && overlays != null'),
|
|
),
|
|
),
|
|
);
|
|
});
|
|
|
|
test('setEnabledSystemUIMode passes correct overlays for manual configuration', () async {
|
|
final log = <MethodCall>[];
|
|
|
|
TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler(
|
|
SystemChannels.platform,
|
|
(MethodCall methodCall) async {
|
|
log.add(methodCall);
|
|
return null;
|
|
},
|
|
);
|
|
|
|
await SystemChrome.setEnabledSystemUIMode(
|
|
SystemUiMode.manual,
|
|
overlays: <SystemUiOverlay>[SystemUiOverlay.top],
|
|
);
|
|
|
|
expect(log, hasLength(1));
|
|
expect(
|
|
log.single,
|
|
isMethodCall(
|
|
'SystemChrome.setEnabledSystemUIOverlays',
|
|
arguments: <String>['SystemUiOverlay.top'],
|
|
),
|
|
);
|
|
});
|
|
|
|
test('setSystemUIChangeCallback control test', () async {
|
|
final log = <MethodCall>[];
|
|
|
|
TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler(
|
|
SystemChannels.platform,
|
|
(MethodCall methodCall) async {
|
|
log.add(methodCall);
|
|
return null;
|
|
},
|
|
);
|
|
|
|
await SystemChrome.setSystemUIChangeCallback(null);
|
|
expect(log, hasLength(0));
|
|
|
|
await SystemChrome.setSystemUIChangeCallback((bool overlaysAreVisible) async {});
|
|
expect(log, hasLength(1));
|
|
expect(log.single, isMethodCall('SystemChrome.setSystemUIChangeListener', arguments: null));
|
|
});
|
|
|
|
group('SystemUiOverlayStyle', () {
|
|
test('toString default values should be null', () async {
|
|
const systemUiOverlayStyle = SystemUiOverlayStyle();
|
|
|
|
final result = systemUiOverlayStyle.toString();
|
|
expect(result, startsWith('SystemUiOverlayStyle#'));
|
|
expect(result, contains('systemNavigationBarColor: null'));
|
|
expect(result, contains('systemNavigationBarDividerColor: null'));
|
|
expect(result, contains('systemStatusBarContrastEnforced: null'));
|
|
expect(result, contains('statusBarColor: null'));
|
|
expect(result, contains('statusBarBrightness: null'));
|
|
expect(result, contains('statusBarIconBrightness: null'));
|
|
expect(result, contains('systemNavigationBarIconBrightness: null'));
|
|
expect(result, contains('systemNavigationBarContrastEnforced: null'));
|
|
});
|
|
|
|
test('toString works as intended with actual values', () {
|
|
const style = SystemUiOverlayStyle(
|
|
systemNavigationBarColor: Color(0xFF123456),
|
|
systemNavigationBarDividerColor: Color(0xFF654321),
|
|
systemStatusBarContrastEnforced: true,
|
|
statusBarColor: Color(0xFFABCDEF),
|
|
statusBarBrightness: Brightness.dark,
|
|
statusBarIconBrightness: Brightness.light,
|
|
systemNavigationBarIconBrightness: Brightness.dark,
|
|
systemNavigationBarContrastEnforced: false,
|
|
);
|
|
|
|
final result = style.toString();
|
|
expect(result, startsWith('SystemUiOverlayStyle#'));
|
|
expect(
|
|
result,
|
|
contains(
|
|
'systemNavigationBarColor: Color(alpha: 1.0000, red: 0.0706, green: 0.2039, blue: 0.3373, colorSpace: ColorSpace.sRGB)',
|
|
),
|
|
);
|
|
expect(
|
|
result,
|
|
contains(
|
|
'systemNavigationBarDividerColor: Color(alpha: 1.0000, red: 0.3961, green: 0.2627, blue: 0.1294, colorSpace: ColorSpace.sRGB)',
|
|
),
|
|
);
|
|
expect(result, contains('systemStatusBarContrastEnforced: true'));
|
|
expect(
|
|
result,
|
|
contains(
|
|
'statusBarColor: Color(alpha: 1.0000, red: 0.6706, green: 0.8039, blue: 0.9373, colorSpace: ColorSpace.sRGB)',
|
|
),
|
|
);
|
|
expect(result, contains('statusBarBrightness: Brightness.dark'));
|
|
expect(result, contains('statusBarIconBrightness: Brightness.light'));
|
|
expect(result, contains('systemNavigationBarIconBrightness: Brightness.dark'));
|
|
expect(result, contains('systemNavigationBarContrastEnforced: false'));
|
|
});
|
|
|
|
test('==, hashCode basics', () {
|
|
const style1 = SystemUiOverlayStyle(
|
|
systemNavigationBarColor: Color(0xFF123456),
|
|
statusBarBrightness: Brightness.dark,
|
|
);
|
|
const style2 = SystemUiOverlayStyle(
|
|
systemNavigationBarColor: Color(0xFF123456),
|
|
statusBarBrightness: Brightness.dark,
|
|
);
|
|
const style3 = SystemUiOverlayStyle(
|
|
systemNavigationBarColor: Color(0xFF654321),
|
|
statusBarBrightness: Brightness.dark,
|
|
);
|
|
|
|
expect(style1, equals(style2));
|
|
expect(style1, isNot(equals(style3)));
|
|
expect(style1 == style2, isTrue);
|
|
expect(style1 == style3, isFalse);
|
|
|
|
expect(style1.hashCode, equals(style2.hashCode));
|
|
expect(style1.hashCode, isNot(equals(style3.hashCode)));
|
|
});
|
|
|
|
test('copyWith can override properties', () {
|
|
const style1 = SystemUiOverlayStyle(
|
|
systemNavigationBarColor: Color(0xFF123456),
|
|
statusBarBrightness: Brightness.dark,
|
|
systemStatusBarContrastEnforced: true,
|
|
);
|
|
|
|
final SystemUiOverlayStyle style2 = style1.copyWith(
|
|
systemNavigationBarColor: const Color(0xFF654321),
|
|
statusBarIconBrightness: Brightness.light,
|
|
);
|
|
|
|
expect(style2.systemNavigationBarColor, equals(const Color(0xFF654321)));
|
|
expect(style2.statusBarBrightness, equals(Brightness.dark));
|
|
expect(style2.systemStatusBarContrastEnforced, equals(true));
|
|
expect(style2.statusBarIconBrightness, equals(Brightness.light));
|
|
expect(style2.systemNavigationBarDividerColor, isNull);
|
|
});
|
|
|
|
test('SystemUiOverlayStyle implements debugFillProperties', () {
|
|
final builder = DiagnosticPropertiesBuilder();
|
|
|
|
const SystemUiOverlayStyle(
|
|
systemNavigationBarColor: Color(0xFF123456),
|
|
systemNavigationBarDividerColor: Color(0xFF654321),
|
|
systemNavigationBarIconBrightness: Brightness.light,
|
|
systemNavigationBarContrastEnforced: true,
|
|
statusBarColor: Color(0xFFABCDEF),
|
|
statusBarBrightness: Brightness.dark,
|
|
statusBarIconBrightness: Brightness.light,
|
|
systemStatusBarContrastEnforced: false,
|
|
).debugFillProperties(builder);
|
|
|
|
final List<String> description = builder.properties
|
|
.where((DiagnosticsNode node) => !node.isFiltered(DiagnosticLevel.info))
|
|
.map((DiagnosticsNode node) => node.toString())
|
|
.toList();
|
|
|
|
expect(description, <String>[
|
|
'systemNavigationBarColor: Color(alpha: 1.0000, red: 0.0706, green: 0.2039, blue: 0.3373, colorSpace: ColorSpace.sRGB)',
|
|
'systemNavigationBarDividerColor: Color(alpha: 1.0000, red: 0.3961, green: 0.2627, blue: 0.1294, colorSpace: ColorSpace.sRGB)',
|
|
'systemNavigationBarIconBrightness: Brightness.light',
|
|
'systemNavigationBarContrastEnforced: true',
|
|
'statusBarColor: Color(alpha: 1.0000, red: 0.6706, green: 0.8039, blue: 0.9373, colorSpace: ColorSpace.sRGB)',
|
|
'statusBarBrightness: Brightness.dark',
|
|
'statusBarIconBrightness: Brightness.light',
|
|
'systemStatusBarContrastEnforced: false',
|
|
]);
|
|
});
|
|
});
|
|
|
|
testWidgets('SystemChrome handles detached lifecycle state', (WidgetTester tester) async {
|
|
final log = <MethodCall>[];
|
|
|
|
TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler(
|
|
SystemChannels.platform,
|
|
(MethodCall methodCall) async {
|
|
log.add(methodCall);
|
|
return null;
|
|
},
|
|
);
|
|
|
|
const systemUiOverlayStyle = SystemUiOverlayStyle();
|
|
SystemChrome.setSystemUIOverlayStyle(systemUiOverlayStyle);
|
|
await tester.idle();
|
|
expect(log.length, equals(1));
|
|
|
|
// Setting the same state should not send another message to the host.
|
|
SystemChrome.setSystemUIOverlayStyle(systemUiOverlayStyle);
|
|
await tester.idle();
|
|
expect(log.length, equals(1));
|
|
|
|
// The state should be sent again if the app was detached.
|
|
SystemChrome.handleAppLifecycleStateChanged(ui.AppLifecycleState.detached);
|
|
await tester.idle();
|
|
SystemChrome.handleAppLifecycleStateChanged(ui.AppLifecycleState.resumed);
|
|
SystemChrome.setSystemUIOverlayStyle(systemUiOverlayStyle);
|
|
await tester.idle();
|
|
expect(log.length, equals(2));
|
|
});
|
|
}
|