pkg/linter/tool/checks/rules/no_solo_tests.dart

// Copyright (c) 2022, 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/dart/element/element.dart';
import 'package:linter/src/analyzer.dart';

const _desc = r"Don't commit soloed tests.";

const _details = r'''
**DON'T** commit a soloed test.

**BAD:**
```dart
@soloTest
test_myTest() async {
  ...
}
```

**GOOD:**
```dart
test_myTest() async {
  ...
}
```
''';

class NoSoloTests extends LintRule {
  NoSoloTests()
      : super(
            name: 'no_solo_tests',
            description: _desc,
            details: _details,
            group: Group.errors);

  @override
  void registerNodeProcessors(
      NodeLintRegistry registry, LinterContext context) {
    if (context.definingUnit.unit.inTestDir) {
      var visitor = _Visitor(this);
      registry.addMethodDeclaration(this, visitor);
    }
  }
}

class _Visitor extends SimpleAstVisitor<void> {
  final LintRule rule;

  _Visitor(this.rule);

  @override
  void visitMethodDeclaration(MethodDeclaration node) {
    // TODO(pq): we *could* ensure we're in a reflective test too.
    // Handle both 'solo_test_' and 'solo_fail_'.
    if (node.name.lexeme.startsWith('solo_')) {
      rule.reportLintForToken(node.name);
      return;
    }

    for (var annotation in node.metadata) {
      if (annotation.isSoloTest) {
        rule.reportLint(annotation);
      }
    }
  }
}

extension on Annotation {
  bool get isSoloTest {
    var element = this.element;
    return element is PropertyAccessorElement &&
        element.name == 'soloTest' &&
        element.library.name == 'test_reflective_loader';
  }
}