mirror of
https://github.com/flutter/flutter
synced 2024-10-13 19:52:53 +00:00
203 lines
11 KiB
Dart
203 lines
11 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 'package:flutter_tools/src/base/command_help.dart';
|
|
import 'package:flutter_tools/src/base/logger.dart';
|
|
import 'package:flutter_tools/src/base/terminal.dart' show AnsiTerminal, OutputPreferences;
|
|
import 'package:meta/meta.dart';
|
|
import 'package:platform/platform.dart';
|
|
|
|
import '../../src/common.dart';
|
|
import '../../src/mocks.dart' show MockStdio;
|
|
|
|
CommandHelp _createCommandHelp({
|
|
@required bool ansi,
|
|
@required int wrapColumn,
|
|
}) {
|
|
final Platform platform = FakePlatform(
|
|
stdoutSupportsAnsi: ansi,
|
|
);
|
|
return CommandHelp(
|
|
logger: BufferLogger.test(),
|
|
terminal: AnsiTerminal(
|
|
stdio: MockStdio(),
|
|
platform: platform,
|
|
),
|
|
platform: platform,
|
|
outputPreferences: OutputPreferences.test(
|
|
showColor: ansi,
|
|
wrapColumn: wrapColumn,
|
|
),
|
|
);
|
|
}
|
|
|
|
// Used to use the message length in different scenarios in a DRY way
|
|
void _testMessageLength({
|
|
@required bool stdoutSupportsAnsi,
|
|
@required int maxTestLineLength,
|
|
@required int wrapColumn,
|
|
}) {
|
|
final CommandHelp commandHelp = _createCommandHelp(
|
|
ansi: stdoutSupportsAnsi,
|
|
wrapColumn: wrapColumn,
|
|
);
|
|
|
|
int expectedWidth = maxTestLineLength;
|
|
|
|
if (stdoutSupportsAnsi) {
|
|
const int ansiMetaCharactersLength = 33;
|
|
expectedWidth += ansiMetaCharactersLength;
|
|
}
|
|
|
|
expect(commandHelp.L.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.P.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.R.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.S.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.U.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.a.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.d.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.h.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.i.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.o.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.p.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.q.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.r.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.s.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.t.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.w.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
expect(commandHelp.z.toString().length, lessThanOrEqualTo(expectedWidth));
|
|
}
|
|
|
|
void main() {
|
|
group('CommandHelp', () {
|
|
group('toString', () {
|
|
|
|
testWithoutContext('should have a bold command key', () {
|
|
final CommandHelp commandHelp = _createCommandHelp(
|
|
ansi: true,
|
|
wrapColumn: maxLineWidth,
|
|
);
|
|
|
|
expect(commandHelp.L.toString(), startsWith('\x1B[1mL\x1B[22m'));
|
|
expect(commandHelp.P.toString(), startsWith('\x1B[1mP\x1B[22m'));
|
|
expect(commandHelp.R.toString(), startsWith('\x1B[1mR\x1B[22m'));
|
|
expect(commandHelp.S.toString(), startsWith('\x1B[1mS\x1B[22m'));
|
|
expect(commandHelp.U.toString(), startsWith('\x1B[1mU\x1B[22m'));
|
|
expect(commandHelp.a.toString(), startsWith('\x1B[1ma\x1B[22m'));
|
|
expect(commandHelp.d.toString(), startsWith('\x1B[1md\x1B[22m'));
|
|
expect(commandHelp.h.toString(), startsWith('\x1B[1mh\x1B[22m'));
|
|
expect(commandHelp.i.toString(), startsWith('\x1B[1mi\x1B[22m'));
|
|
expect(commandHelp.o.toString(), startsWith('\x1B[1mo\x1B[22m'));
|
|
expect(commandHelp.p.toString(), startsWith('\x1B[1mp\x1B[22m'));
|
|
expect(commandHelp.q.toString(), startsWith('\x1B[1mq\x1B[22m'));
|
|
expect(commandHelp.r.toString(), startsWith('\x1B[1mr\x1B[22m'));
|
|
expect(commandHelp.s.toString(), startsWith('\x1B[1ms\x1B[22m'));
|
|
expect(commandHelp.t.toString(), startsWith('\x1B[1mt\x1B[22m'));
|
|
expect(commandHelp.w.toString(), startsWith('\x1B[1mw\x1B[22m'));
|
|
expect(commandHelp.z.toString(), startsWith('\x1B[1mz\x1B[22m'));
|
|
});
|
|
|
|
testWithoutContext('commands L,P,S,U,a,i,o,p,t,w should have a grey bolden parenthetical text', () {
|
|
final CommandHelp commandHelp = _createCommandHelp(
|
|
ansi: true,
|
|
wrapColumn: maxLineWidth,
|
|
);
|
|
|
|
expect(commandHelp.L.toString(), endsWith('\x1B[1;30m(debugDumpLayerTree)\x1B[39m'));
|
|
expect(commandHelp.P.toString(), endsWith('\x1B[1;30m(WidgetsApp.showPerformanceOverlay)\x1B[39m'));
|
|
expect(commandHelp.S.toString(), endsWith('\x1B[1;30m(debugDumpSemantics)\x1B[39m'));
|
|
expect(commandHelp.U.toString(), endsWith('\x1B[1;30m(debugDumpSemantics)\x1B[39m'));
|
|
expect(commandHelp.a.toString(), endsWith('\x1B[1;30m(debugProfileWidgetBuilds)\x1B[39m'));
|
|
expect(commandHelp.i.toString(), endsWith('\x1B[1;30m(WidgetsApp.showWidgetInspectorOverride)\x1B[39m'));
|
|
expect(commandHelp.o.toString(), endsWith('\x1B[1;30m(defaultTargetPlatform)\x1B[39m'));
|
|
expect(commandHelp.p.toString(), endsWith('\x1B[1;30m(debugPaintSizeEnabled)\x1B[39m'));
|
|
expect(commandHelp.t.toString(), endsWith('\x1B[1;30m(debugDumpRenderTree)\x1B[39m'));
|
|
expect(commandHelp.w.toString(), endsWith('\x1B[1;30m(debugDumpApp)\x1B[39m'));
|
|
});
|
|
|
|
testWithoutContext('should not create a help text longer than maxLineWidth without ansi support', () {
|
|
_testMessageLength(
|
|
stdoutSupportsAnsi: false,
|
|
wrapColumn: 0,
|
|
maxTestLineLength: maxLineWidth,
|
|
);
|
|
});
|
|
|
|
testWithoutContext('should not create a help text longer than maxLineWidth with ansi support', () {
|
|
_testMessageLength(
|
|
stdoutSupportsAnsi: true,
|
|
wrapColumn: 0,
|
|
maxTestLineLength: maxLineWidth,
|
|
);
|
|
});
|
|
|
|
testWithoutContext('should not create a help text longer than outputPreferences.wrapColumn without ansi support', () {
|
|
_testMessageLength(
|
|
stdoutSupportsAnsi: false,
|
|
wrapColumn: OutputPreferences.kDefaultTerminalColumns,
|
|
maxTestLineLength: OutputPreferences.kDefaultTerminalColumns,
|
|
);
|
|
});
|
|
|
|
testWithoutContext('should not create a help text longer than outputPreferences.wrapColumn with ansi support', () {
|
|
_testMessageLength(
|
|
stdoutSupportsAnsi: true,
|
|
wrapColumn: OutputPreferences.kDefaultTerminalColumns,
|
|
maxTestLineLength: OutputPreferences.kDefaultTerminalColumns,
|
|
);
|
|
});
|
|
|
|
testWithoutContext('should create the correct help text with ansi support', () {
|
|
final CommandHelp commandHelp = _createCommandHelp(
|
|
ansi: true,
|
|
wrapColumn: maxLineWidth,
|
|
);
|
|
|
|
expect(commandHelp.L.toString(), equals('\x1B[1mL\x1B[22m Dump layer tree to the console. \x1B[1;30m(debugDumpLayerTree)\x1B[39m'));
|
|
expect(commandHelp.P.toString(), equals('\x1B[1mP\x1B[22m Toggle performance overlay. \x1B[1;30m(WidgetsApp.showPerformanceOverlay)\x1B[39m'));
|
|
expect(commandHelp.R.toString(), equals('\x1B[1mR\x1B[22m Hot restart.'));
|
|
expect(commandHelp.S.toString(), equals('\x1B[1mS\x1B[22m Dump accessibility tree in traversal order. \x1B[1;30m(debugDumpSemantics)\x1B[39m'));
|
|
expect(commandHelp.U.toString(), equals('\x1B[1mU\x1B[22m Dump accessibility tree in inverse hit test order. \x1B[1;30m(debugDumpSemantics)\x1B[39m'));
|
|
expect(commandHelp.a.toString(), equals('\x1B[1ma\x1B[22m Toggle timeline events for all widget build methods. \x1B[1;30m(debugProfileWidgetBuilds)\x1B[39m'));
|
|
expect(commandHelp.d.toString(), equals('\x1B[1md\x1B[22m Detach (terminate "flutter run" but leave application running).'));
|
|
expect(commandHelp.h.toString(), equals('\x1B[1mh\x1B[22m Repeat this help message.'));
|
|
expect(commandHelp.i.toString(), equals('\x1B[1mi\x1B[22m Toggle widget inspector. \x1B[1;30m(WidgetsApp.showWidgetInspectorOverride)\x1B[39m'));
|
|
expect(commandHelp.o.toString(), equals('\x1B[1mo\x1B[22m Simulate different operating systems. \x1B[1;30m(defaultTargetPlatform)\x1B[39m'));
|
|
expect(commandHelp.p.toString(), equals('\x1B[1mp\x1B[22m Toggle the display of construction lines. \x1B[1;30m(debugPaintSizeEnabled)\x1B[39m'));
|
|
expect(commandHelp.q.toString(), equals('\x1B[1mq\x1B[22m Quit (terminate the application on the device).'));
|
|
expect(commandHelp.r.toString(), equals('\x1B[1mr\x1B[22m Hot reload. $fire$fire$fire'));
|
|
expect(commandHelp.s.toString(), equals('\x1B[1ms\x1B[22m Save a screenshot to flutter.png.'));
|
|
expect(commandHelp.t.toString(), equals('\x1B[1mt\x1B[22m Dump rendering tree to the console. \x1B[1;30m(debugDumpRenderTree)\x1B[39m'));
|
|
expect(commandHelp.w.toString(), equals('\x1B[1mw\x1B[22m Dump widget hierarchy to the console. \x1B[1;30m(debugDumpApp)\x1B[39m'));
|
|
expect(commandHelp.z.toString(), equals('\x1B[1mz\x1B[22m Toggle elevation checker.'));
|
|
});
|
|
|
|
testWithoutContext('should create the correct help text without ansi support', () {
|
|
final CommandHelp commandHelp = _createCommandHelp(
|
|
ansi: false,
|
|
wrapColumn: maxLineWidth,
|
|
);
|
|
|
|
expect(commandHelp.L.toString(), equals('L Dump layer tree to the console. (debugDumpLayerTree)'));
|
|
expect(commandHelp.P.toString(), equals('P Toggle performance overlay. (WidgetsApp.showPerformanceOverlay)'));
|
|
expect(commandHelp.R.toString(), equals('R Hot restart.'));
|
|
expect(commandHelp.S.toString(), equals('S Dump accessibility tree in traversal order. (debugDumpSemantics)'));
|
|
expect(commandHelp.U.toString(), equals('U Dump accessibility tree in inverse hit test order. (debugDumpSemantics)'));
|
|
expect(commandHelp.a.toString(), equals('a Toggle timeline events for all widget build methods. (debugProfileWidgetBuilds)'));
|
|
expect(commandHelp.d.toString(), equals('d Detach (terminate "flutter run" but leave application running).'));
|
|
expect(commandHelp.h.toString(), equals('h Repeat this help message.'));
|
|
expect(commandHelp.i.toString(), equals('i Toggle widget inspector. (WidgetsApp.showWidgetInspectorOverride)'));
|
|
expect(commandHelp.o.toString(), equals('o Simulate different operating systems. (defaultTargetPlatform)'));
|
|
expect(commandHelp.p.toString(), equals('p Toggle the display of construction lines. (debugPaintSizeEnabled)'));
|
|
expect(commandHelp.q.toString(), equals('q Quit (terminate the application on the device).'));
|
|
expect(commandHelp.r.toString(), equals('r Hot reload. $fire$fire$fire'));
|
|
expect(commandHelp.s.toString(), equals('s Save a screenshot to flutter.png.'));
|
|
expect(commandHelp.t.toString(), equals('t Dump rendering tree to the console. (debugDumpRenderTree)'));
|
|
expect(commandHelp.w.toString(), equals('w Dump widget hierarchy to the console. (debugDumpApp)'));
|
|
expect(commandHelp.z.toString(), equals('z Toggle elevation checker.'));
|
|
});
|
|
});
|
|
});
|
|
}
|