Improve handling of disable-dartdev-analytics

Some other refactorings are piggy-backed along.

TestProject.runSync no longer takes a 'command' argument. It was anyway
often not an argument.

Also stop the messy handling of pub arguments. It is no longer needed.

BUG: https://github.com/dart-lang/sdk/issues/44135
TEST=The VM change is tested via all the pkg/dartdev/test/command/* tests that invoke dart with the --no-analytics flag.

Change-Id: Ib5a1a29841a5fdb28663b7f60c5d6fc31ba252d0
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/171284
Commit-Queue: Sigurd Meldgaard <sigurdm@google.com>
Reviewed-by: Martin Kustermann <kustermann@google.com>
Reviewed-by: Jonas Jensen <jonasfj@google.com>
This commit is contained in:
Sigurd Meldgaard
2020-11-13 08:40:06 +00:00
committed by commit-bot@chromium.org
parent f3ffe6dac6
commit cda994ffc8
18 changed files with 237 additions and 295 deletions
+99 -127
View File
@@ -33,128 +33,34 @@ import 'src/vm_interop_handler.dart';
Future<void> runDartdev(List<String> args, SendPort port) async {
VmInteropHandler.initialize(port);
int result;
// The exit code for the dartdev process; null indicates that it has not been
// set yet. The value is set in the catch and finally blocks below.
int exitCode;
// Any caught non-UsageExceptions when running the sub command.
Object exception;
StackTrace stackTrace;
// The Analytics instance used to report information back to Google Analytics;
// see lib/src/analytics.dart.
final analytics = createAnalyticsInstance(
args.contains('--disable-dartdev-analytics'),
);
// If we have not printed the analyticsNoticeOnFirstRunMessage to stdout,
// the user is on a terminal, and the machine is not a bot, then print the
// disclosure and set analytics.disclosureShownOnTerminal to true.
if (analytics is DartdevAnalytics &&
!analytics.disclosureShownOnTerminal &&
io.stdout.hasTerminal &&
!isBot()) {
print(analyticsNoticeOnFirstRunMessage);
analytics.disclosureShownOnTerminal = true;
if (args.contains('run')) {
// These flags have a format that can't be handled by package:args, so while
// they are valid flags we'll assume the VM has verified them by this point.
args = args
.where(
(element) => !(element.contains('--observe') ||
element.contains('--enable-vm-service')),
)
.toList();
}
// When `--disable-analytics` or `--enable-analytics` are called we perform
// the respective intention and print any notices to standard out and exit.
if (args.contains('--disable-analytics')) {
// This block also potentially catches the case of (disableAnalytics &&
// enableAnalytics), in which we favor the disabling of analytics.
analytics.enabled = false;
// Alert the user that analytics has been disabled.
print(analyticsDisabledNoticeMessage);
VmInteropHandler.exit(0);
return;
} else if (args.contains('--enable-analytics')) {
analytics.enabled = true;
// Alert the user again that anonymous data will be collected.
print(analyticsNoticeOnFirstRunMessage);
VmInteropHandler.exit(0);
return;
}
// Finally, call the runner to execute the command; see DartdevRunner.
final runner = DartdevRunner(args);
var exitCode = 1;
try {
final runner = DartdevRunner(args, analytics);
// Run can't be called with the '--disable-dartdev-analytics' flag; remove
// it if it is contained in args.
if (args.contains('--disable-dartdev-analytics')) {
args = List.from(args)..remove('--disable-dartdev-analytics');
}
if (args.contains('run')) {
// These flags have a format that can't be handled by package:args, so while
// they are valid flags we'll assume the VM has verified them by this point.
args = args
.where(
(element) => !(element.contains('--observe') ||
element.contains('--enable-vm-service')),
)
.toList();
}
// If ... help pub ... is in the args list, remove 'help', and add '--help'
// to the end of the list. This will make it possible to use the help
// command to access subcommands of pub such as `dart help pub publish`; see
// https://github.com/dart-lang/sdk/issues/42965.
if (PubUtils.shouldModifyArgs(args, runner.commands.keys.toList())) {
args = PubUtils.modifyArgs(args);
}
// Finally, call the runner to execute the command; see DartdevRunner.
result = await runner.run(args);
} catch (e, st) {
if (e is UsageException) {
io.stderr.writeln('$e');
exitCode = 64;
} else {
// Set the exception and stack trace only for non-UsageException cases:
exception = e;
stackTrace = st;
io.stderr.writeln('$e');
io.stderr.writeln('$st');
exitCode = 1;
}
exitCode = await runner.run(args);
} on UsageException catch (e) {
// TODO(sigurdm): It is unclear when a UsageException gets to here, and
// when it is in DartdevRunner.runCommand.
io.stderr.writeln('$e');
exitCode = 64;
} finally {
// Set the exitCode, if it wasn't set in the catch block above.
exitCode ??= result ?? 0;
// Send analytics before exiting
if (analytics.enabled) {
// And now send the exceptions and events to Google Analytics:
if (exception != null) {
unawaited(
analytics.sendException(
'${exception.runtimeType}\n${sanitizeStacktrace(stackTrace)}',
fatal: true),
);
}
await analytics.waitForLastPing(
timeout: const Duration(milliseconds: 200));
}
// Set the enabled flag in the analytics object to true. Note: this will not
// enable the analytics unless the disclosure was shown (terminal detected),
// and the machine is not detected to be a bot.
if (analytics.firstRun) {
analytics.enabled = true;
}
analytics.close();
VmInteropHandler.exit(exitCode);
}
}
class DartdevRunner extends CommandRunner<int> {
final Analytics analytics;
@override
final ArgParser argParser =
ArgParser(usageLineLength: dartdevUsageLineLength);
@@ -162,8 +68,7 @@ class DartdevRunner extends CommandRunner<int> {
static const String dartdevDescription =
'A command-line utility for Dart development';
DartdevRunner(List<String> args, this.analytics)
: super('dart', '$dartdevDescription.') {
DartdevRunner(List<String> args) : super('dart', '$dartdevDescription.') {
final bool verbose = args.contains('-v') || args.contains('--verbose');
argParser.addFlag('verbose',
@@ -178,12 +83,9 @@ class DartdevRunner extends CommandRunner<int> {
argParser.addFlag('diagnostics',
negatable: false, help: 'Show tool diagnostic output.', hide: !verbose);
// A hidden flag to disable analytics on this run, this constructor can be
// called with this flag, but should be removed before run() is called as
// the flag has not been added to all sub-commands.
argParser.addFlag(
'disable-dartdev-analytics',
negatable: false,
'analytics',
negatable: true,
help: 'Disable anonymous analytics for this `dart *` run',
hide: true,
);
@@ -210,7 +112,38 @@ class DartdevRunner extends CommandRunner<int> {
@override
Future<int> runCommand(ArgResults topLevelResults) async {
final stopwatch = Stopwatch()..start();
assert(!topLevelResults.arguments.contains('--disable-dartdev-analytics'));
// The Analytics instance used to report information back to Google Analytics;
// see lib/src/analytics.dart.
final analytics = createAnalyticsInstance(!topLevelResults['analytics']);
// If we have not printed the analyticsNoticeOnFirstRunMessage to stdout,
// the user is on a terminal, and the machine is not a bot, then print the
// disclosure and set analytics.disclosureShownOnTerminal to true.
if (analytics is DartdevAnalytics &&
!analytics.disclosureShownOnTerminal &&
io.stdout.hasTerminal &&
!isBot()) {
print(analyticsNoticeOnFirstRunMessage);
analytics.disclosureShownOnTerminal = true;
}
// When `--disable-analytics` or `--enable-analytics` are called we perform
// the respective intention and print any notices to standard out and exit.
if (topLevelResults['disable-analytics']) {
// This block also potentially catches the case of (disableAnalytics &&
// enableAnalytics), in which we favor the disabling of analytics.
analytics.enabled = false;
// Alert the user that analytics has been disabled.
print(analyticsDisabledNoticeMessage);
return 0;
} else if (topLevelResults['enable-analytics']) {
analytics.enabled = true;
// Alert the user again that anonymous data will be collected.
print(analyticsNoticeOnFirstRunMessage);
return 0;
}
if (topLevelResults.command == null &&
topLevelResults.arguments.isNotEmpty) {
@@ -220,14 +153,12 @@ class DartdevRunner extends CommandRunner<int> {
io.stderr.writeln(
"Error when reading '$firstArg': No such file or directory.");
// This is the exit code used by the frontend.
VmInteropHandler.exit(254);
return 254;
}
}
isDiagnostics = topLevelResults['diagnostics'];
final Ansi ansi = Ansi(Ansi.terminalSupportsAnsi);
log = isDiagnostics
log = topLevelResults['diagnostics']
? Logger.verbose(ansi: ansi)
: Logger.standard(ansi: ansi);
@@ -245,8 +176,15 @@ class DartdevRunner extends CommandRunner<int> {
analytics.sendScreenView(path),
);
// The exit code for the dartdev process; null indicates that it has not been
// set yet. The value is set in the catch and finally blocks below.
int exitCode;
// Any caught non-UsageExceptions when running the sub command.
Object exception;
StackTrace stackTrace;
try {
final exitCode = await super.runCommand(topLevelResults);
exitCode = await super.runCommand(topLevelResults);
if (path != null && analytics.enabled) {
// Send the event to analytics
@@ -266,8 +204,16 @@ class DartdevRunner extends CommandRunner<int> {
),
);
}
return exitCode;
} on UsageException catch (e) {
io.stderr.writeln('$e');
exitCode = 64;
} catch (e, st) {
// Set the exception and stack trace only for non-UsageException cases:
exception = e;
stackTrace = st;
io.stderr.writeln('$e');
io.stderr.writeln('$st');
exitCode = 1;
} finally {
stopwatch.stop();
if (analytics.enabled) {
@@ -279,6 +225,32 @@ class DartdevRunner extends CommandRunner<int> {
),
);
}
// Set the exitCode, if it wasn't set in the catch block above.
exitCode ??= 0;
// Send analytics before exiting
if (analytics.enabled) {
// And now send the exceptions and events to Google Analytics:
if (exception != null) {
unawaited(
analytics.sendException(
'${exception.runtimeType}\n${sanitizeStacktrace(stackTrace)}',
fatal: true),
);
}
await analytics.waitForLastPing(
timeout: const Duration(milliseconds: 200));
}
// Set the enabled flag in the analytics object to true. Note: this will not
// enable the analytics unless the disclosure was shown (terminal detected),
// and the machine is not detected to be a bot.
if (analytics.firstRun) {
analytics.enabled = true;
}
analytics.close();
return exitCode;
}
}
}
+1 -1
View File
@@ -53,7 +53,7 @@ Analytics createAnalyticsInstance(bool disableAnalytics) {
}
if (disableAnalytics) {
// Dartdev tests pass a hidden 'disable-dartdev-analytics' flag which is
// Dartdev tests pass a hidden 'no-analytics' flag which is
// handled here.
// Also, stdout.hasTerminal is checked, if there is no terminal we infer that
// a machine is running dartdev so we return analytics shouldn't be set.
-25
View File
@@ -38,31 +38,6 @@ String trimEnd(String s, String suffix) {
return s;
}
/// Static util methods used in dartdev to potentially modify the order of the
/// arguments passed into dartdev.
class PubUtils {
/// If [doModifyArgs] returns true, then this method returns a modified copy
/// of the argument list, 'help' is removed from the interior of the list, and
/// '--help' is added to the end of the list of arguments. This method returns
/// a modified copy of the list, the list itself is not modified.
static List<String> modifyArgs(List<String> args) => List.from(args)
..remove('help')
..add('--help');
/// If ... help pub ..., and no other verb (such as 'analyze') appears before
/// the ... help pub ... in the argument list, then return true.
static bool shouldModifyArgs(List<String> args, List<String> allCmds) =>
args != null &&
allCmds != null &&
args.isNotEmpty &&
allCmds.isNotEmpty &&
args.firstWhere((arg) => allCmds.contains(arg), orElse: () => '') ==
'help' &&
args.contains('help') &&
args.contains('pub') &&
args.indexOf('help') + 1 == args.indexOf('pub');
}
extension FileSystemEntityExtension on FileSystemEntity {
String get name => p.basename(path);
+9 -7
View File
@@ -23,7 +23,7 @@ void main() {
group('Sending analytics', () {
test('help', () {
final p = project(logAnalytics: true);
final result = p.runSync('help', []);
final result = p.runSync(['help']);
expect(extractAnalytics(result), [
{
'hitType': 'screenView',
@@ -51,7 +51,7 @@ void main() {
});
test('create', () {
final p = project(logAnalytics: true);
final result = p.runSync('create', ['-tpackage-simple', 'name']);
final result = p.runSync(['create', '-tpackage-simple', 'name']);
expect(extractAnalytics(result), [
{
'hitType': 'screenView',
@@ -82,7 +82,7 @@ void main() {
test('pub get', () {
final p = project(logAnalytics: true);
final result = p.runSync('pub', ['get', '--dry-run']);
final result = p.runSync(['pub', 'get', '--dry-run']);
expect(extractAnalytics(result), [
{
'hitType': 'screenView',
@@ -113,7 +113,7 @@ void main() {
test('format', () {
final p = project(logAnalytics: true);
final result = p.runSync('format', ['-l80']);
final result = p.runSync(['format', '-l80']);
expect(extractAnalytics(result), [
{
'hitType': 'screenView',
@@ -146,7 +146,8 @@ void main() {
final p = project(
mainSrc: 'void main(List<String> args) => print(args)',
logAnalytics: true);
final result = p.runSync('run', [
final result = p.runSync([
'run',
'--no-pause-isolates-on-exit',
'--enable-asserts',
'lib/main.dart',
@@ -184,7 +185,8 @@ void main() {
final p = project(
mainSrc: 'void main(List<String> args) => print(args);',
logAnalytics: true);
final result = p.runSync('run', [
final result = p.runSync([
'run',
'--enable-experiment=non-nullable',
'lib/main.dart',
]);
@@ -221,7 +223,7 @@ void main() {
mainSrc: 'void main(List<String> args) => print(args);',
logAnalytics: true);
final result = p
.runSync('compile', ['kernel', 'lib/main.dart', '-o', 'main.kernel']);
.runSync(['compile', 'kernel', 'lib/main.dart', '-o', 'main.kernel']);
expect(extractAnalytics(result), [
{
'hitType': 'screenView',
+13 -13
View File
@@ -62,7 +62,7 @@ void defineAnalyze() {
test('--help', () {
p = project();
var result = p.runSync('analyze', ['--help']);
var result = p.runSync(['analyze', '--help']);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
@@ -72,7 +72,7 @@ void defineAnalyze() {
test('multiple directories', () {
p = project();
var result = p.runSync('analyze', ['/no/such/dir1/', '/no/such/dir2/']);
var result = p.runSync(['analyze', '/no/such/dir1/', '/no/such/dir2/']);
expect(result.exitCode, 64);
expect(result.stdout, isEmpty);
@@ -82,7 +82,7 @@ void defineAnalyze() {
test('no such directory', () {
p = project();
var result = p.runSync('analyze', ['/no/such/dir1/']);
var result = p.runSync(['analyze', '/no/such/dir1/']);
expect(result.exitCode, 64);
expect(result.stdout, isEmpty);
@@ -93,7 +93,7 @@ void defineAnalyze() {
test('current working directory', () {
p = project(mainSrc: 'int get foo => 1;\n');
var result = p.runSync('analyze', [], workingDir: p.dirPath);
var result = p.runSync(['analyze'], workingDir: p.dirPath);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
@@ -102,7 +102,7 @@ void defineAnalyze() {
test('no errors', () {
p = project(mainSrc: 'int get foo => 1;\n');
var result = p.runSync('analyze', [p.dirPath]);
var result = p.runSync(['analyze', p.dirPath]);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
@@ -111,7 +111,7 @@ void defineAnalyze() {
test('one error', () {
p = project(mainSrc: "int get foo => 'str';\n");
var result = p.runSync('analyze', [p.dirPath]);
var result = p.runSync(['analyze', p.dirPath]);
expect(result.exitCode, 3);
expect(result.stderr, isEmpty);
@@ -123,7 +123,7 @@ void defineAnalyze() {
test('two errors', () {
p = project(mainSrc: "int get foo => 'str';\nint get bar => 'str';\n");
var result = p.runSync('analyze', [p.dirPath]);
var result = p.runSync(['analyze', p.dirPath]);
expect(result.exitCode, 3);
expect(result.stderr, isEmpty);
@@ -134,7 +134,7 @@ void defineAnalyze() {
p = project(
mainSrc: _unusedImportCodeSnippet,
analysisOptions: _unusedImportAnalysisOptions);
var result = p.runSync('analyze', ['--fatal-warnings', p.dirPath]);
var result = p.runSync(['analyze', '--fatal-warnings', p.dirPath]);
expect(result.exitCode, equals(2));
expect(result.stderr, isEmpty);
@@ -145,7 +145,7 @@ void defineAnalyze() {
p = project(
mainSrc: _unusedImportCodeSnippet,
analysisOptions: _unusedImportAnalysisOptions);
var result = p.runSync('analyze', [p.dirPath]);
var result = p.runSync(['analyze', p.dirPath]);
expect(result.exitCode, equals(2));
expect(result.stderr, isEmpty);
@@ -156,7 +156,7 @@ void defineAnalyze() {
p = project(
mainSrc: _unusedImportCodeSnippet,
analysisOptions: _unusedImportAnalysisOptions);
var result = p.runSync('analyze', ['--no-fatal-warnings', p.dirPath]);
var result = p.runSync(['analyze', '--no-fatal-warnings', p.dirPath]);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
@@ -165,7 +165,7 @@ void defineAnalyze() {
test('info implicit no --fatal-infos', () {
p = project(mainSrc: dartVersionFilePrefix2_9 + 'String foo() {}');
var result = p.runSync('analyze', [p.dirPath]);
var result = p.runSync(['analyze', p.dirPath]);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
@@ -174,7 +174,7 @@ void defineAnalyze() {
test('info --fatal-infos', () {
p = project(mainSrc: dartVersionFilePrefix2_9 + 'String foo() {}');
var result = p.runSync('analyze', ['--fatal-infos', p.dirPath]);
var result = p.runSync(['analyze', '--fatal-infos', p.dirPath]);
expect(result.exitCode, 1);
expect(result.stderr, isEmpty);
@@ -188,7 +188,7 @@ int f() {
var one = 1;
return result;
}''');
var result = p.runSync('analyze', ['--verbose', p.dirPath]);
var result = p.runSync(['analyze', '--verbose', p.dirPath]);
expect(result.exitCode, 3);
expect(result.stderr, isEmpty);
+13 -12
View File
@@ -27,8 +27,9 @@ void defineCompileTests() {
test('Implicit --help', () {
final p = project();
var result = p.runSync(
'compile',
[],
[
'compile',
],
);
expect(result.stderr, contains('Compile Dart'));
expect(result.exitCode, compileErrorExitCode);
@@ -37,8 +38,7 @@ void defineCompileTests() {
test('--help', () {
final p = project();
final result = p.runSync(
'compile',
['--help'],
['compile', '--help'],
);
expect(result.stdout, contains('Compile Dart'));
expect(result.exitCode, 0);
@@ -48,8 +48,8 @@ void defineCompileTests() {
final p = project(mainSrc: 'void main() { print("I love jit"); }');
final outFile = path.join(p.dirPath, 'main.jit');
var result = p.runSync(
'compile',
[
'compile',
'jit-snapshot',
'-o',
outFile,
@@ -61,7 +61,7 @@ void defineCompileTests() {
expect(File(outFile).existsSync(), true,
reason: 'File not found: $outFile');
result = p.runSync('run', ['main.jit']);
result = p.runSync(['run', 'main.jit']);
expect(result.stdout, contains('I love jit'));
expect(result.stderr, isEmpty);
expect(result.exitCode, 0);
@@ -73,8 +73,8 @@ void defineCompileTests() {
final outFile = path.canonicalize(path.join(p.dirPath, 'lib', 'main.exe'));
var result = p.runSync(
'compile',
[
'compile',
'exe',
inFile,
],
@@ -102,8 +102,8 @@ void defineCompileTests() {
final outFile = path.canonicalize(path.join(p.dirPath, 'myexe'));
var result = p.runSync(
'compile',
[
'compile',
'exe',
'--define',
'life=42',
@@ -134,8 +134,8 @@ void defineCompileTests() {
final outFile = path.canonicalize(path.join(p.dirPath, 'main.aot'));
var result = p.runSync(
'compile',
[
'compile',
'aot-snapshot',
'-o',
'main.aot',
@@ -163,8 +163,8 @@ void defineCompileTests() {
final p = project(mainSrc: 'void main() { print("I love kernel"); }');
final outFile = path.join(p.dirPath, 'main.dill');
var result = p.runSync(
'compile',
[
'compile',
'kernel',
'-o',
outFile,
@@ -176,7 +176,7 @@ void defineCompileTests() {
expect(result.stderr, isEmpty);
expect(result.exitCode, 0);
result = p.runSync('run', ['main.dill']);
result = p.runSync(['run', 'main.dill']);
expect(result.stdout, contains('I love kernel'));
expect(result.stderr, isEmpty);
expect(result.exitCode, 0);
@@ -187,7 +187,8 @@ void defineCompileTests() {
final inFile = path.canonicalize(path.join(p.dirPath, p.relativeFilePath));
final outFile = path.canonicalize(path.join(p.dirPath, 'main.js'));
final result = p.runSync('compile', [
final result = p.runSync([
'compile',
'js',
'-m',
'-o',
+7 -5
View File
@@ -36,7 +36,7 @@ void defineCreateTests() {
test('list templates', () {
p = project();
ProcessResult result = p.runSync('create', ['--list-templates']);
ProcessResult result = p.runSync(['create', '--list-templates']);
expect(result.exitCode, 0);
String output = result.stdout.toString();
@@ -50,7 +50,9 @@ void defineCreateTests() {
test('no directory given', () {
p = project();
ProcessResult result = p.runSync('create', []);
ProcessResult result = p.runSync([
'create',
]);
expect(result.exitCode, 1);
});
@@ -58,7 +60,7 @@ void defineCreateTests() {
p = project();
ProcessResult result = p.runSync(
'create', ['--template', CreateCommand.defaultTemplateId, p.dir.path]);
['create', '--template', CreateCommand.defaultTemplateId, p.dir.path]);
expect(result.exitCode, 73);
});
@@ -66,7 +68,7 @@ void defineCreateTests() {
p = project();
ProcessResult result =
p.runSync('create', ['--no-pub', '--template', 'foo-bar', p.dir.path]);
p.runSync(['create', '--no-pub', '--template', 'foo-bar', p.dir.path]);
expect(result.exitCode, isNot(0));
});
@@ -76,7 +78,7 @@ void defineCreateTests() {
p = project();
ProcessResult result = p
.runSync('create', ['--force', '--template', templateId, p.dir.path]);
.runSync(['create', '--force', '--template', templateId, p.dir.path]);
expect(result.exitCode, 0);
String projectName = path.basename(p.dir.path);
+6 -6
View File
@@ -21,7 +21,7 @@ void defineFix() {
test('none', () {
p = project(mainSrc: 'int get foo => 1;\n');
var result = p.runSync('fix', [p.dirPath]);
var result = p.runSync(['fix', p.dirPath]);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
expect(result.stdout, contains('Nothing to fix!'));
@@ -38,7 +38,7 @@ linter:
- prefer_single_quotes
''',
);
var result = p.runSync('fix', [], workingDir: p.dirPath);
var result = p.runSync(['fix'], workingDir: p.dirPath);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
expect(result.stdout, contains('Fixed 1 file.'));
@@ -55,7 +55,7 @@ linter:
- prefer_single_quotes
''',
);
var result = p.runSync('fix', ['--dry-run', '.'], workingDir: p.dirPath);
var result = p.runSync(['fix', '--dry-run', '.'], workingDir: p.dirPath);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
expect(
@@ -76,7 +76,7 @@ linter:
- prefer_single_quotes
''',
);
var result = p.runSync('fix', ['.'], workingDir: p.dirPath);
var result = p.runSync(['fix', '.'], workingDir: p.dirPath);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
expect(result.stdout, contains('Fixed 1 file.'));
@@ -96,7 +96,7 @@ linter:
- prefer_single_quotes
''',
);
var result = p.runSync('fix', ['.'], workingDir: p.dirPath);
var result = p.runSync(['fix', '.'], workingDir: p.dirPath);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
expect(result.stdout, contains('Nothing to fix!'));
@@ -114,7 +114,7 @@ linter:
- prefer_single_quotes
''',
);
var result = p.runSync('fix', ['.'], workingDir: p.dirPath);
var result = p.runSync(['fix', '.'], workingDir: p.dirPath);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
expect(result.stdout, contains('Nothing to fix!'));
+8 -9
View File
@@ -6,7 +6,6 @@ import 'dart:io';
import 'package:args/command_runner.dart';
import 'package:dartdev/dartdev.dart';
import 'package:dartdev/src/analytics.dart' show disabledAnalytics;
import 'package:test/test.dart';
import '../utils.dart';
@@ -20,7 +19,7 @@ void command() {
// For each command description, assert that the values are not empty, don't
// have trailing white space and end with a period.
test('description formatting', () {
DartdevRunner(['--disable-dartdev-analytics'], disabledAnalytics)
DartdevRunner(['--no-analytics'])
.commands
.forEach((String commandKey, Command command) {
expect(commandKey, isNotEmpty);
@@ -32,7 +31,7 @@ void command() {
// Assert that all found usageLineLengths are the same and null
test('argParser usageLineLength', () {
DartdevRunner(['--disable-dartdev-analytics'], disabledAnalytics)
DartdevRunner(['--no-analytics'])
.commands
.forEach((String commandKey, Command command) {
if (command.argParser != null) {
@@ -62,7 +61,7 @@ void help() {
test('--help', () {
p = project();
var result = p.runSync('--help', []);
var result = p.runSync(['--help']);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
@@ -80,7 +79,7 @@ void help() {
test('--help --verbose', () {
p = project();
var result = p.runSync('--help', ['--verbose']);
var result = p.runSync(['--help', '--verbose']);
expect(result.exitCode, 0);
expect(result.stdout, isEmpty);
@@ -90,7 +89,7 @@ void help() {
test('--help -v', () {
p = project();
var result = p.runSync('--help', ['-v']);
var result = p.runSync(['--help', '-v']);
expect(result.exitCode, 0);
expect(result.stdout, isEmpty);
@@ -100,7 +99,7 @@ void help() {
test('help', () {
p = project();
var result = p.runSync('help', []);
var result = p.runSync(['help']);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
@@ -118,7 +117,7 @@ void help() {
test('help --verbose', () {
p = project();
var result = p.runSync('help', ['--verbose']);
var result = p.runSync(['help', '--verbose']);
expect(result.exitCode, 0);
expect(result.stdout, contains('migrate '));
@@ -126,7 +125,7 @@ void help() {
test('help -v', () {
p = project();
var result = p.runSync('help', ['-v']);
var result = p.runSync(['help', '-v']);
expect(result.exitCode, 0);
expect(result.stdout, contains('migrate '));
+5 -5
View File
@@ -19,7 +19,7 @@ void format() {
test('--help', () {
p = project();
var result = p.runSync('format', ['--help']);
var result = p.runSync(['format', '--help']);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
expect(result.stdout, contains('Idiomatically format Dart source code.'));
@@ -32,7 +32,7 @@ void format() {
test('--help --verbose', () {
p = project();
var result = p.runSync('format', ['--help', '--verbose']);
var result = p.runSync(['format', '--help', '--verbose']);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
expect(result.stdout, contains('Idiomatically format Dart source code.'));
@@ -45,7 +45,7 @@ void format() {
test('unchanged', () {
p = project(mainSrc: 'int get foo => 1;\n');
ProcessResult result = p.runSync('format', [p.relativeFilePath]);
ProcessResult result = p.runSync(['format', p.relativeFilePath]);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
expect(result.stdout, startsWith('Formatted 1 file (0 changed) in '));
@@ -53,7 +53,7 @@ void format() {
test('formatted', () {
p = project(mainSrc: 'int get foo => 1;\n');
ProcessResult result = p.runSync('format', [p.relativeFilePath]);
ProcessResult result = p.runSync(['format', p.relativeFilePath]);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
expect(
@@ -65,7 +65,7 @@ void format() {
test('unknown file', () {
p = project(mainSrc: 'int get foo => 1;\n');
var unknownFilePath = '${p.relativeFilePath}-unknown-file.dart';
ProcessResult result = p.runSync('format', [unknownFilePath]);
ProcessResult result = p.runSync(['format', unknownFilePath]);
expect(result.exitCode, 0);
expect(result.stderr,
startsWith('No file or directory found at "$unknownFilePath".'));
+6 -7
View File
@@ -4,7 +4,6 @@
import 'package:args/command_runner.dart';
import 'package:dartdev/dartdev.dart';
import 'package:dartdev/src/analytics.dart' show disabledAnalytics;
import 'package:test/test.dart';
import '../utils.dart';
@@ -22,14 +21,14 @@ void help() {
List<String> _commandsNotTested = <String>[
'help', // `dart help help` is redundant
];
DartdevRunner(['--disable-dartdev-analytics'], disabledAnalytics)
DartdevRunner(['--no-analytics'])
.commands
.forEach((String commandKey, Command command) {
if (!_commandsNotTested.contains(commandKey)) {
test('(help $commandKey == $commandKey --help)', () {
p = project();
var result = p.runSync('help', [commandKey]);
var verbHelpResult = p.runSync(commandKey, ['--help']);
var result = p.runSync(['help', commandKey]);
var verbHelpResult = p.runSync([commandKey, '--help']);
expect(result.stdout, contains(verbHelpResult.stdout));
expect(result.stderr, contains(verbHelpResult.stderr));
@@ -39,15 +38,15 @@ void help() {
test('(help pub == pub --help)', () {
p = project();
var result = p.runSync('help', ['pub']);
var pubHelpResult = p.runSync('pub', ['--help']);
var result = p.runSync(['help', 'pub']);
var pubHelpResult = p.runSync(['pub', '--help']);
expect(result.stdout, contains(pubHelpResult.stdout));
expect(result.stderr, contains(pubHelpResult.stderr));
});
test('(--help flags also have -h abbr)', () {
DartdevRunner(['--disable-dartdev-analytics'], disabledAnalytics)
DartdevRunner(['--no-analytics'])
.commands
.forEach((String commandKey, Command command) {
var helpOption = command.argParser.options['help'];
+6 -6
View File
@@ -21,7 +21,7 @@ void defineMigrateTests() {
test('--help', () {
p = project();
var result = p.runSync('migrate', ['--help']);
var result = p.runSync(['migrate', '--help']);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
@@ -34,7 +34,7 @@ void defineMigrateTests() {
test('directory implicit', () {
p = project(mainSrc: dartVersionFilePrefix2_9 + 'int get foo => 1;\n');
var result =
p.runSync('migrate', ['--no-web-preview'], workingDir: p.dirPath);
p.runSync(['migrate', '--no-web-preview'], workingDir: p.dirPath);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
expect(result.stdout, contains('Generating migration suggestions'));
@@ -42,7 +42,7 @@ void defineMigrateTests() {
test('directory explicit', () {
p = project(mainSrc: dartVersionFilePrefix2_9 + 'int get foo => 1;\n');
var result = p.runSync('migrate', ['--no-web-preview', p.dirPath]);
var result = p.runSync(['migrate', '--no-web-preview', p.dirPath]);
expect(result.exitCode, 0);
expect(result.stderr, isEmpty);
expect(result.stdout, contains('Generating migration suggestions'));
@@ -50,7 +50,7 @@ void defineMigrateTests() {
test('bad directory', () {
p = project(mainSrc: 'int get foo => 1;\n');
var result = p.runSync('migrate', ['foo_bar_dir']);
var result = p.runSync(['migrate', 'foo_bar_dir']);
expect(result.exitCode, 1);
expect(result.stderr, contains('foo_bar_dir does not exist'));
expect(result.stdout, isEmpty);
@@ -58,7 +58,7 @@ void defineMigrateTests() {
test('pub get needs running', () {
p = project(mainSrc: 'import "package:foo/foo.dart";\n');
var result = p.runSync('migrate', [p.dirPath]);
var result = p.runSync(['migrate', p.dirPath]);
expect(result.exitCode, 1);
expect(result.stderr, isEmpty);
expect(result.stdout, runPubGet);
@@ -67,7 +67,7 @@ void defineMigrateTests() {
test('non-pub-related error', () {
p = project(mainSrc: 'var missing = "semicolon"\n');
var result = p.runSync('migrate', [p.dirPath]);
var result = p.runSync(['migrate', p.dirPath]);
expect(result.exitCode, 1);
expect(result.stderr, isEmpty);
expect(result.stdout, runPubGet);
+11 -11
View File
@@ -26,7 +26,7 @@ void pub() {
}
test('implicit --help', () {
final result = project().runSync('pub', []);
final result = project().runSync(['pub']);
expect(result, isNotNull);
expect(result.exitCode, 64);
expect(result.stderr, contains('Missing subcommand for "dart pub".'));
@@ -35,17 +35,17 @@ void pub() {
});
test('--help', () {
_assertPubHelpInvoked(project().runSync('pub', ['--help']));
_assertPubHelpInvoked(project().runSync(['pub', '--help']));
});
test('-h', () {
_assertPubHelpInvoked(project().runSync('pub', ['-h']));
_assertPubHelpInvoked(project().runSync(['pub', '-h']));
});
test('help cache', () {
p = project();
var result = p.runSync('help', ['pub', 'cache']);
var result2 = p.runSync('pub', ['cache', '--help']);
var result = p.runSync(['help', 'pub', 'cache']);
var result2 = p.runSync(['pub', 'cache', '--help']);
expect(result.exitCode, 0);
@@ -58,8 +58,8 @@ void pub() {
test('help publish', () {
p = project();
var result = p.runSync('help', ['pub', 'publish']);
var result2 = p.runSync('pub', ['publish', '--help']);
var result = p.runSync(['help', 'pub', 'publish']);
var result2 = p.runSync(['pub', 'publish', '--help']);
expect(result.exitCode, 0);
@@ -77,10 +77,10 @@ void pub() {
"void main() { int? a; a = null; print('a is \$a.'); }");
// run 'pub get'
p.runSync('pub', ['get']);
p.runSync(['pub', 'get']);
var result = p.runSync(
'pub', ['run', '--enable-experiment=no-non-nullable', 'main.dart']);
['pub', 'run', '--enable-experiment=no-non-nullable', 'main.dart']);
expect(result.exitCode, 254);
expect(result.stdout, isEmpty);
@@ -93,7 +93,7 @@ void pub() {
test('failure', () {
p = project(mainSrc: 'int get foo => 1;\n');
var result = p.runSync('pub', ['deps']);
var result = p.runSync(['pub', 'deps']);
expect(result.exitCode, 65);
expect(result.stdout, isEmpty);
expect(result.stderr, contains('No pubspec.lock file found'));
@@ -101,7 +101,7 @@ void pub() {
test('failure unknown option', () {
p = project(mainSrc: 'int get foo => 1;\n');
var result = p.runSync('pub', ['deps', '--foo']);
var result = p.runSync(['pub', 'deps', '--foo']);
expect(result.exitCode, 64);
expect(result.stdout, isEmpty);
expect(result.stderr, startsWith('Could not find an option named "foo".'));
+23 -14
View File
@@ -20,7 +20,7 @@ void run() {
test('--help', () {
p = project();
var result = p.runSync('run', ['--help']);
var result = p.runSync(['run', '--help']);
expect(result.stdout, contains('Run a Dart program.'));
expect(result.stdout, contains('Debugging options:'));
@@ -30,7 +30,7 @@ void run() {
test("'Hello World'", () {
p = project(mainSrc: "void main() { print('Hello World'); }");
ProcessResult result = p.runSync('run', [p.relativeFilePath]);
ProcessResult result = p.runSync(['run', p.relativeFilePath]);
expect(result.stdout, contains('Hello World'));
expect(result.stderr, isEmpty);
@@ -40,7 +40,7 @@ void run() {
test('no such file', () {
p = project(mainSrc: "void main() { print('Hello World'); }");
ProcessResult result =
p.runSync('run', ['no/such/file/${p.relativeFilePath}']);
p.runSync(['run', 'no/such/file/${p.relativeFilePath}']);
expect(result.stderr, isNotEmpty);
expect(result.exitCode, isNot(0));
@@ -51,7 +51,7 @@ void run() {
// name (package name) will be the name of the temporary directory on disk
p = project(mainSrc: "void main() { print('Hello World'); }");
p.file('bin/main.dart', "void main() { print('Hello main.dart'); }");
ProcessResult result = p.runSync('run', []);
ProcessResult result = p.runSync(['run']);
expect(result.stdout, contains('Hello main.dart'));
expect(result.stderr, isEmpty);
@@ -62,7 +62,7 @@ void run() {
test('missing implicit packageName.dart', () {
p = project(mainSrc: "void main() { print('Hello World'); }");
p.file('bin/foo.dart', "void main() { print('Hello main.dart'); }");
ProcessResult result = p.runSync('run', []);
ProcessResult result = p.runSync(['run']);
expect(result.stdout, isEmpty);
expect(
@@ -75,7 +75,8 @@ void run() {
test('arguments are properly passed', () {
p = project();
p.file('main.dart', 'void main(args) { print(args); }');
ProcessResult result = p.runSync('run', [
ProcessResult result = p.runSync([
'run',
'--enable-experiment=triple-shift',
'main.dart',
'argument1',
@@ -93,7 +94,8 @@ void run() {
p.file('main.dart', 'void main(args) { print(args); }');
// Test with absolute path
final name = path.join(p.dirPath, 'main.dart');
final result = p.runSync('run', [
final result = p.runSync([
'run',
'--enable-experiment=triple-shift',
name,
'--argument1',
@@ -111,7 +113,8 @@ void run() {
p.file('main.dart', 'void main(args) { print(args); }');
// Test with File uri
final name = path.join(p.dirPath, 'main.dart');
final result = p.runSync('run', [
final result = p.runSync([
'run',
Uri.file(name).toString(),
'--argument1',
'argument2',
@@ -134,7 +137,8 @@ void run() {
//
// This test ensures that allowed arguments for dart run which are valid VM
// arguments are properly handled by the VM.
ProcessResult result = p.runSync('run', [
ProcessResult result = p.runSync([
'run',
'--observe',
'--pause-isolates-on-start',
// This should negate the above flag.
@@ -153,7 +157,8 @@ void run() {
expect(result.exitCode, 0);
// Again, with --disable-service-auth-codes.
result = p.runSync('run', [
result = p.runSync([
'run',
'--observe',
'--pause-isolates-on-start',
// This should negate the above flag.
@@ -178,7 +183,8 @@ void run() {
// Any VM flags not listed under 'dart run help --verbose' should be passed
// before a dartdev command.
ProcessResult result = p.runSync('run', [
ProcessResult result = p.runSync([
'run',
'--vm-name=foo',
p.relativeFilePath,
]);
@@ -196,7 +202,8 @@ void run() {
// Any VM flags not listed under 'dart run help --verbose' should be passed
// before a dartdev command.
ProcessResult result = p.runSync('run', [
ProcessResult result = p.runSync([
'run',
'--verbose_gc',
p.relativeFilePath,
]);
@@ -214,7 +221,8 @@ void run() {
// Ensure --enable-asserts doesn't cause the dartdev isolate to fail to
// load. Regression test for: https://github.com/dart-lang/sdk/issues/42831
ProcessResult result = p.runSync('run', [
ProcessResult result = p.runSync([
'run',
'--enable-asserts',
p.relativeFilePath,
]);
@@ -228,7 +236,8 @@ void run() {
p = project(mainSrc: 'void main() { assert(false); }');
// Any VM flags passed after the script shouldn't be interpreted by the VM.
ProcessResult result = p.runSync('run', [
ProcessResult result = p.runSync([
'run',
p.relativeFilePath,
'--enable-asserts',
]);
+16 -10
View File
@@ -21,7 +21,7 @@ void defineTest() {
test('--help', () {
p = project();
final result = p.runSync('test', ['--help']);
final result = p.runSync(['test', '--help']);
expect(result.exitCode, 0);
expect(result.stdout, contains(' tests in this package'));
@@ -31,7 +31,7 @@ void defineTest() {
test('dart help test', () {
p = project();
final result = p.runSync('help', ['test']);
final result = p.runSync(['help', 'test']);
expect(result.exitCode, 0);
expect(result.stdout, contains(' tests in this package'));
@@ -43,7 +43,7 @@ void defineTest() {
var pubspec = File(path.join(p.dirPath, 'pubspec.yaml'));
pubspec.deleteSync();
var result = p.runSync('test', []);
var result = p.runSync(['test']);
expect(result.stderr, isEmpty);
expect(result.stdout, contains('No pubspec.yaml file found'));
@@ -63,7 +63,7 @@ void main() {
''');
// An implicit `pub get` will happen.
final result = p.runSync('test', ['--no-color', '--reporter', 'expanded']);
final result = p.runSync(['test', '--no-color', '--reporter', 'expanded']);
expect(result.stderr, isEmpty);
expect(result.stdout, contains('All tests passed!'));
expect(result.exitCode, 0);
@@ -86,7 +86,8 @@ void main() {
}
''');
final result = p.runSync('test', []);
final result = p.runSync(['test']);
expect(result.exitCode, 65);
expect(
result.stdout,
contains('You need to add a dependency on package:test'),
@@ -94,10 +95,10 @@ void main() {
expect(result.stderr, isEmpty);
expect(result.exitCode, 65);
final resultPubAdd = p.runSync('pub', ['add', 'test']);
final resultPubAdd = p.runSync(['pub', 'add', 'test']);
expect(resultPubAdd.exitCode, 0);
final result2 = p.runSync('test', ['--no-color', '--reporter', 'expanded']);
final result2 = p.runSync(['test', '--no-color', '--reporter', 'expanded']);
expect(result2.stderr, isEmpty);
expect(result2.stdout, contains('All tests passed!'));
expect(result2.exitCode, 0);
@@ -117,7 +118,7 @@ void main() {
}
''');
final result = p.runSync('test', ['--no-color', '--reporter', 'expanded']);
final result = p.runSync(['test', '--no-color', '--reporter', 'expanded']);
expect(result.exitCode, 0);
expect(result.stdout, contains('All tests passed!'));
expect(result.stderr, isEmpty);
@@ -138,8 +139,13 @@ void main() {
''');
final result = p.runSync(
'--enable-experiment=non-nullable',
['test', '--no-color', '--reporter', 'expanded'],
[
'--enable-experiment=non-nullable',
'test',
'--no-color',
'--reporter',
'expanded',
],
);
expect(result.exitCode, 1);
});
+1 -3
View File
@@ -71,16 +71,14 @@ dev_dependencies:
}
ProcessResult runSync(
String command,
List<String> args, {
String workingDir,
}) {
var arguments = [
command,
'--no-analytics',
...?args,
];
arguments.add('--disable-dartdev-analytics');
return Process.runSync(Platform.resolvedExecutable, arguments,
workingDirectory: workingDir ?? dir.path,
environment: {if (logAnalytics) '_DARTDEV_LOG_ANALYTICS': 'true'});
-33
View File
@@ -100,39 +100,6 @@ void main() {
expect(File('bar.bart').name, 'bar.bart');
});
});
group('PubUtils', () {
test('doModifyArgs', () {
const allCmds = ['analyze', 'help', 'pub', 'migrate'];
expect(PubUtils.shouldModifyArgs(null, null), isFalse);
expect(PubUtils.shouldModifyArgs([], null), isFalse);
expect(PubUtils.shouldModifyArgs(null, []), isFalse);
expect(PubUtils.shouldModifyArgs([], []), isFalse);
expect(PubUtils.shouldModifyArgs(['-h'], allCmds), isFalse);
expect(PubUtils.shouldModifyArgs(['--help'], allCmds), isFalse);
expect(PubUtils.shouldModifyArgs(['help'], allCmds), isFalse);
expect(PubUtils.shouldModifyArgs(['pub'], allCmds), isFalse);
expect(PubUtils.shouldModifyArgs(['analyze', 'help', 'pub'], allCmds),
isFalse);
expect(PubUtils.shouldModifyArgs(['--some-flag', 'help', 'pub'], allCmds),
isTrue);
expect(PubUtils.shouldModifyArgs(['help', 'pub'], allCmds), isTrue);
expect(PubUtils.shouldModifyArgs(['help', 'pub', 'publish'], allCmds),
isTrue);
expect(PubUtils.shouldModifyArgs(['help', 'pub', 'analyze'], allCmds),
isTrue);
});
test('modifyArgs', () {
expect(PubUtils.modifyArgs(['--some-flag', 'help', 'pub']),
orderedEquals(['--some-flag', 'pub', '--help']));
expect(PubUtils.modifyArgs(['help', 'pub']),
orderedEquals(['pub', '--help']));
expect(PubUtils.modifyArgs(['help', 'pub', 'publish']),
orderedEquals(['pub', 'publish', '--help']));
});
});
}
const String _packageData = '''{
+13 -1
View File
@@ -387,6 +387,7 @@ int Options::ParseArguments(int argc,
bool enable_dartdev_analytics = false;
bool disable_dartdev_analytics = false;
bool no_dartdev_analytics = false;
// Parse out the vm options.
while (i < argc) {
@@ -405,12 +406,14 @@ int Options::ParseArguments(int argc,
const char* kVerboseDebug1 = "--verbose_debug";
const char* kVerboseDebug2 = "--verbose-debug";
// The following two flags are processed as DartDev flags and are not to
// The following flags are processed as DartDev flags and are not to
// be treated as if they are VM flags.
const char* kEnableDartDevAnalytics1 = "--enable-analytics";
const char* kEnableDartDevAnalytics2 = "--enable_analytics";
const char* kDisableDartDevAnalytics1 = "--disable-analytics";
const char* kDisableDartDevAnalytics2 = "--disable_analytics";
const char* kNoDartDevAnalytics1 = "--no-analytics";
const char* kNoDartDevAnalytics2 = "--no_analytics";
if ((strncmp(argv[i], kPrintFlags1, strlen(kPrintFlags1)) == 0) ||
(strncmp(argv[i], kPrintFlags2, strlen(kPrintFlags2)) == 0)) {
@@ -426,6 +429,12 @@ int Options::ParseArguments(int argc,
strlen(kEnableDartDevAnalytics2)) == 0)) {
enable_dartdev_analytics = true;
skipVmOption = true;
} else if ((strncmp(argv[i], kNoDartDevAnalytics1,
strlen(kNoDartDevAnalytics1)) == 0) ||
(strncmp(argv[i], kNoDartDevAnalytics2,
strlen(kNoDartDevAnalytics2)) == 0)) {
no_dartdev_analytics = true;
skipVmOption = true;
} else if ((strncmp(argv[i], kDisableDartDevAnalytics1,
strlen(kDisableDartDevAnalytics1)) == 0) ||
(strncmp(argv[i], kDisableDartDevAnalytics2,
@@ -518,6 +527,9 @@ int Options::ParseArguments(int argc,
if (disable_dartdev_analytics) {
dart_options->AddArgument("--disable-analytics");
}
if (no_dartdev_analytics) {
dart_options->AddArgument("--no-analytics");
}
return 0;
}