From 5c9e8529a858211c65714b3fdc8c1f7f43761a72 Mon Sep 17 00:00:00 2001 From: Sam Rawlins Date: Tue, 25 Feb 2025 11:19:20 -0800 Subject: [PATCH 1/2] Introduce an analyzer plugin for the test package. --- pkgs/test_analyzer_plugin/README.md | 13 +++++ pkgs/test_analyzer_plugin/lib/main.dart | 20 +++++++ pkgs/test_analyzer_plugin/lib/src/fixes.dart | 58 +++++++++++++++++++ pkgs/test_analyzer_plugin/lib/src/rules.dart | 53 +++++++++++++++++ .../lib/src/utilities.dart | 37 ++++++++++++ pkgs/test_analyzer_plugin/pubspec.yaml | 12 ++++ 6 files changed, 193 insertions(+) create mode 100644 pkgs/test_analyzer_plugin/README.md create mode 100644 pkgs/test_analyzer_plugin/lib/main.dart create mode 100644 pkgs/test_analyzer_plugin/lib/src/fixes.dart create mode 100644 pkgs/test_analyzer_plugin/lib/src/rules.dart create mode 100644 pkgs/test_analyzer_plugin/lib/src/utilities.dart create mode 100644 pkgs/test_analyzer_plugin/pubspec.yaml diff --git a/pkgs/test_analyzer_plugin/README.md b/pkgs/test_analyzer_plugin/README.md new file mode 100644 index 000000000..1f157181a --- /dev/null +++ b/pkgs/test_analyzer_plugin/README.md @@ -0,0 +1,13 @@ +# test_analyzer_plugin + +This package is an analyzer plugin that provides additional static analysis for +usage of the test package. + +This analyzer plugin provides the following additional analysis: + +* Report a warning when a `test` or a `group` is declared inside a `test` + declaration. This can _sometimes_ be detected at runtime. This warning is + reported statically. + +* Offer a quick fix in the IDE for the above warning, which moves the violating + `test` or `group` declaration below the containing `test` declaration. \ No newline at end of file diff --git a/pkgs/test_analyzer_plugin/lib/main.dart b/pkgs/test_analyzer_plugin/lib/main.dart new file mode 100644 index 000000000..a7445cf0b --- /dev/null +++ b/pkgs/test_analyzer_plugin/lib/main.dart @@ -0,0 +1,20 @@ +// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file +// for details. 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:analysis_server_plugin/plugin.dart'; +import 'package:analysis_server_plugin/registry.dart'; + +import 'src/fixes.dart'; +import 'src/rules.dart'; + +final plugin = TestPackagePlugin(); + +class TestPackagePlugin extends Plugin { + @override + void register(PluginRegistry registry) { + registry.registerWarningRule(TestInTestRule()); + registry.registerFixForRule( + TestInTestRule.code, MoveBelowEnclosingTestCall.new); + } +} diff --git a/pkgs/test_analyzer_plugin/lib/src/fixes.dart b/pkgs/test_analyzer_plugin/lib/src/fixes.dart new file mode 100644 index 000000000..98af4aa3e --- /dev/null +++ b/pkgs/test_analyzer_plugin/lib/src/fixes.dart @@ -0,0 +1,58 @@ +// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file +// for details. 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:analysis_server_plugin/edit/dart/correction_producer.dart'; +import 'package:analysis_server_plugin/edit/dart/dart_fix_kind_priority.dart'; +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart'; +import 'package:analyzer_plugin/utilities/fixes/fixes.dart'; +import 'package:analyzer_plugin/utilities/range_factory.dart'; + +import 'utilities.dart'; + +class MoveBelowEnclosingTestCall extends ResolvedCorrectionProducer { + static const _wrapInQuotesKind = FixKind( + 'dart.fix.moveBelowEnclosingTestCall', + DartFixKindPriority.standard, + "Move below the enclosing 'test' call"); + + MoveBelowEnclosingTestCall({required super.context}); + + @override + CorrectionApplicability get applicability => + // This fix may break code by moving references to variables away from the + // scope in which they are declared. + CorrectionApplicability.singleLocation; + + @override + FixKind get fixKind => _wrapInQuotesKind; + + @override + Future compute(ChangeBuilder builder) async { + var methodCall = node; + if (methodCall is! MethodInvocation) return; + AstNode? enclosingTestCall = findEnclosingTestCall(methodCall); + if (enclosingTestCall == null) return; + + if (enclosingTestCall.parent is ExpressionStatement) { + // Move the 'test' call to below the outer 'test' call _statement_. + enclosingTestCall = enclosingTestCall.parent!; + } + + if (methodCall.parent is ExpressionStatement) { + // Move the whole statement (don't leave the semicolon dangling). + methodCall = methodCall.parent!; + } + + await builder.addDartFileEdit(file, (builder) { + var indent = utils.getLinePrefix(enclosingTestCall!.offset); + var source = utils.getRangeText(range.node(methodCall)); + + // Move the source for `methodCall` wholsale to be just after `enclosingTestCall`. + builder.addDeletion(range.deletionRange(methodCall)); + builder.addSimpleInsertion( + enclosingTestCall.end, '$eol$eol$indent$source'); + }); + } +} diff --git a/pkgs/test_analyzer_plugin/lib/src/rules.dart b/pkgs/test_analyzer_plugin/lib/src/rules.dart new file mode 100644 index 000000000..bf4634ec0 --- /dev/null +++ b/pkgs/test_analyzer_plugin/lib/src/rules.dart @@ -0,0 +1,53 @@ +// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file +// for details. 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:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/ast/visitor.dart'; +import 'package:analyzer/src/dart/error/lint_codes.dart'; +import 'package:analyzer/src/lint/linter.dart'; + +import 'utilities.dart'; + +class TestInTestRule extends AnalysisRule { + static const LintCode code = LintCode( + 'test_in_test', + "Do not declare a 'test' or a 'group' inside a 'test'", + correctionMessage: "Try moving 'test' or 'group' outside of 'test'", + ); + + TestInTestRule() + : super( + name: 'test_in_test', + description: + 'Tests and groups declared inside of a test are not properly ' + 'registered in the test framework.', + ); + + @override + LintCode get lintCode => code; + + @override + void registerNodeProcessors( + NodeLintRegistry registry, LinterContext context) { + var visitor = _Visitor(this); + registry.addMethodInvocation(this, visitor); + } +} + +class _Visitor extends SimpleAstVisitor { + final AnalysisRule rule; + + _Visitor(this.rule); + + @override + void visitMethodInvocation(MethodInvocation node) { + if (!node.methodName.isTest && !node.methodName.isGroup) { + return; + } + var enclosingTestCall = findEnclosingTestCall(node); + if (enclosingTestCall != null) { + rule.reportLint(node); + } + } +} diff --git a/pkgs/test_analyzer_plugin/lib/src/utilities.dart b/pkgs/test_analyzer_plugin/lib/src/utilities.dart new file mode 100644 index 000000000..0de22044c --- /dev/null +++ b/pkgs/test_analyzer_plugin/lib/src/utilities.dart @@ -0,0 +1,37 @@ +// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file +// for details. 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:analyzer/dart/ast/ast.dart'; + +/// Finds an enclosing call to the 'test' function, if there is one. +MethodInvocation? findEnclosingTestCall(MethodInvocation node) { + var ancestor = node.parent?.thisOrAncestorOfType(); + while (ancestor != null) { + if (ancestor.methodName.isTest) { + return ancestor; + } + ancestor = ancestor.parent?.thisOrAncestorOfType(); + } + return null; +} + +extension SimpleIdentifierExtension on SimpleIdentifier { + /// Whether this identifier represents the 'test' function from the + /// 'test_core' package. + bool get isTest { + final element = this.element; + if (element == null) return false; + if (element.name3 != 'test') return false; + return element.library2?.uri.path.startsWith('test_core/') ?? false; + } + + /// Whether this identifier represents the 'group' function from the + /// 'test_core' package. + bool get isGroup { + final element = this.element; + if (element == null) return false; + if (element.name3 != 'group') return false; + return element.library2?.uri.path.startsWith('test_core/') ?? false; + } +} diff --git a/pkgs/test_analyzer_plugin/pubspec.yaml b/pkgs/test_analyzer_plugin/pubspec.yaml new file mode 100644 index 000000000..9a434a305 --- /dev/null +++ b/pkgs/test_analyzer_plugin/pubspec.yaml @@ -0,0 +1,12 @@ +name: test_analyzer_plugin +description: An analyzer plugin to report improper usage of the test package. +version: 1.0.0 +publish_to: none + +environment: + sdk: '>=3.6.0 <4.0.0' + +dependencies: + analysis_server_plugin: any + analyzer: ^7.2.0 + From 1b527ed3663d39fd1b06df8f32182ec4feda6619 Mon Sep 17 00:00:00 2001 From: Sam Rawlins Date: Tue, 4 Mar 2025 10:56:59 -0800 Subject: [PATCH 2/2] feedback --- pkgs/test_analyzer_plugin/lib/src/fixes.dart | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkgs/test_analyzer_plugin/lib/src/fixes.dart b/pkgs/test_analyzer_plugin/lib/src/fixes.dart index 98af4aa3e..87d35f55b 100644 --- a/pkgs/test_analyzer_plugin/lib/src/fixes.dart +++ b/pkgs/test_analyzer_plugin/lib/src/fixes.dart @@ -12,7 +12,7 @@ import 'package:analyzer_plugin/utilities/range_factory.dart'; import 'utilities.dart'; class MoveBelowEnclosingTestCall extends ResolvedCorrectionProducer { - static const _wrapInQuotesKind = FixKind( + static const _moveBelowEnclosingTestCallKind = FixKind( 'dart.fix.moveBelowEnclosingTestCall', DartFixKindPriority.standard, "Move below the enclosing 'test' call"); @@ -26,7 +26,7 @@ class MoveBelowEnclosingTestCall extends ResolvedCorrectionProducer { CorrectionApplicability.singleLocation; @override - FixKind get fixKind => _wrapInQuotesKind; + FixKind get fixKind => _moveBelowEnclosingTestCallKind; @override Future compute(ChangeBuilder builder) async {