pkg/analysis_server/test/src/services/correction/fix/remove_type_annotation_test.dart

// Copyright (c) 2018, 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/src/services/correction/fix.dart';
import 'package:analysis_server/src/services/linter/lint_names.dart';
import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
import 'package:test_reflective_loader/test_reflective_loader.dart';

import 'fix_processor.dart';

void main() {
  defineReflectiveSuite(() {
    defineReflectiveTests(AvoidAnnotatingWithDynamicBulkTest);
    defineReflectiveTests(AvoidAnnotatingWithDynamicTest);
    defineReflectiveTests(AvoidReturnTypesOnSettersBulkTest);
    defineReflectiveTests(AvoidReturnTypesOnSettersTest);
    defineReflectiveTests(AvoidTypesOnClosureParametersBulkTest);
    defineReflectiveTests(AvoidTypesOnClosureParametersTest);
    defineReflectiveTests(
        SuperFormalParameterTypeIsNotSubtypeOfAssociatedBulkTest);
    defineReflectiveTests(SuperFormalParameterTypeIsNotSubtypeOfAssociatedTest);
    defineReflectiveTests(TypeInitFormalsBulkTest);
    defineReflectiveTests(TypeInitFormalsTest);
    defineReflectiveTests(VarAndTypeTest);
  });
}

@reflectiveTest
class AvoidAnnotatingWithDynamicBulkTest extends BulkFixProcessorTest {
  @override
  String get lintCode => LintNames.avoid_annotating_with_dynamic;

  Future<void> test_singleFile() async {
    await resolveTestCode('''
f(void foo(dynamic x)) {
  return null;
}

f2({dynamic defaultValue}) {
  return null;
}
''');
    await assertHasFix('''
f(void foo(x)) {
  return null;
}

f2({defaultValue}) {
  return null;
}
''');
  }
}

@reflectiveTest
class AvoidAnnotatingWithDynamicTest extends RemoveTypeAnnotationTest {
  @override
  String get lintCode => LintNames.avoid_annotating_with_dynamic;

  Future<void> test_insideFunctionTypedFormalParameter() async {
    await resolveTestCode('''
bad(void foo(dynamic x)) {
  return null;
}
''');
    await assertHasFix('''
bad(void foo(x)) {
  return null;
}
''');
  }

  Future<void> test_namedParameter() async {
    await resolveTestCode('''
bad({dynamic defaultValue}) {
  return null;
}
''');
    await assertHasFix('''
bad({defaultValue}) {
  return null;
}
''');
  }

  Future<void> test_normalParameter() async {
    await resolveTestCode('''
bad(dynamic defaultValue) {
  return null;
}
''');
    await assertHasFix('''
bad(defaultValue) {
  return null;
}
''');
  }

  Future<void> test_optionalParameter() async {
    await resolveTestCode('''
bad([dynamic defaultValue]) {
  return null;
}
''');
    await assertHasFix('''
bad([defaultValue]) {
  return null;
}
''');
  }
}

@reflectiveTest
class AvoidReturnTypesOnSettersBulkTest extends BulkFixProcessorTest {
  @override
  String get lintCode => LintNames.avoid_return_types_on_setters;

  Future<void> test_singleFile() async {
    await resolveTestCode('''
void set s(int s) {}
void set s2(int s2) {}
''');
    await assertHasFix('''
set s(int s) {}
set s2(int s2) {}
''');
  }
}

@reflectiveTest
class AvoidReturnTypesOnSettersTest extends RemoveTypeAnnotationTest {
  @override
  String get lintCode => LintNames.avoid_return_types_on_setters;

  Future<void> test_void() async {
    await resolveTestCode('''
void set speed2(int ms) {}
''');
    await assertHasFix('''
set speed2(int ms) {}
''');
  }
}

@reflectiveTest
class AvoidTypesOnClosureParametersBulkTest extends BulkFixProcessorTest {
  @override
  String get lintCode => LintNames.avoid_types_on_closure_parameters;

  Future<void> test_singleFile() async {
    await resolveTestCode('''
void f(List<Future<int>> list) {
  list.forEach((Future<int> defaultValue) {});
  list.forEach((Future<int> defaultValue) { defaultValue; });
}
''');
    await assertHasFix('''
void f(List<Future<int>> list) {
  list.forEach((defaultValue) {});
  list.forEach((defaultValue) { defaultValue; });
}
''');
  }
}

@reflectiveTest
class AvoidTypesOnClosureParametersTest extends RemoveTypeAnnotationTest {
  @override
  String get lintCode => LintNames.avoid_types_on_closure_parameters;

  Future<void> test_namedParameter() async {
    await resolveTestCode('''
void f(C c) {
  c.forEach(({Future<int>? p}) {});
}
class C {
  void forEach(void Function({Future<int>? p})) {}
}
''');
    await assertHasFix('''
void f(C c) {
  c.forEach(({p}) {});
}
class C {
  void forEach(void Function({Future<int>? p})) {}
}
''');
  }

  Future<void> test_normalParameter() async {
    await resolveTestCode('''
void f(C c) {
  c.forEach((Future<int>? p) {});
}
class C {
  void forEach(void Function(Future<int>? p)) {}
}
''');
    await assertHasFix('''
void f(C c) {
  c.forEach((p) {});
}
class C {
  void forEach(void Function(Future<int>? p)) {}
}
''');
  }

  Future<void> test_optionalParameter() async {
    await resolveTestCode('''
void f(C c) {
  c.forEach(([Future<int>? p]) {});
}
class C {
  void forEach(void Function([Future<int>? p])) {}
}
''');
    await assertHasFix('''
void f(C c) {
  c.forEach(([p]) {});
}
class C {
  void forEach(void Function([Future<int>? p])) {}
}
''');
  }
}

@reflectiveTest
abstract class RemoveTypeAnnotationTest extends FixProcessorLintTest {
  @override
  FixKind get kind => DartFixKind.REMOVE_TYPE_ANNOTATION;
}

@reflectiveTest
class SuperFormalParameterTypeIsNotSubtypeOfAssociatedBulkTest
    extends BulkFixProcessorTest {
  Future<void> test_requiredPositional() async {
    await resolveTestCode('''
class C {
  C(String f);
}
class D extends C {
  D(int super.f);
  D.named(int super.f);
}
''');
    await assertHasFix('''
class C {
  C(String f);
}
class D extends C {
  D(super.f);
  D.named(super.f);
}
''');
  }
}

@reflectiveTest
class SuperFormalParameterTypeIsNotSubtypeOfAssociatedTest
    extends FixProcessorTest {
  @override
  FixKind get kind => DartFixKind.REMOVE_TYPE_ANNOTATION;

  Future<void> test_functionTyped_parameterTypeIsNotSupertype() async {
    await resolveTestCode('''
class C {
  C(void f(num p));
}
class D extends C {
  D(void super.f(int p));
}
''');
    await assertHasFix('''
class C {
  C(void f(num p));
}
class D extends C {
  D(super.f);
}
''');
  }

  Future<void> test_functionTyped_returnTypeIsNotSubtype() async {
    await resolveTestCode('''
class C {
  C(int f());
}
class D extends C {
  D(num super.f());
}
''');
    await assertHasFix('''
class C {
  C(int f());
}
class D extends C {
  D(super.f);
}
''');
  }

  Future<void> test_optionalPositional() async {
    await resolveTestCode('''
class C {
  C([int f = 0]);
}
class D extends C {
  D([num super.f = 1]);
}
''');
    await assertHasFix('''
class C {
  C([int f = 0]);
}
class D extends C {
  D([super.f = 1]);
}
''');
  }

  Future<void> test_requiredPositional() async {
    await resolveTestCode('''
class C {
  C(String f);
}
class D extends C {
  D(int super.f);
}
''');
    await assertHasFix('''
class C {
  C(String f);
}
class D extends C {
  D(super.f);
}
''');
  }
}

@reflectiveTest
class TypeInitFormalsBulkTest extends BulkFixProcessorTest {
  @override
  String get lintCode => LintNames.type_init_formals;

  Future<void> test_singleFile() async {
    await resolveTestCode('''
class C {
  int f;
  C(int this.f);
}

class Point {
  int x, y;
  Point(int this.x, int this.y);
}
''');
    await assertHasFix('''
class C {
  int f;
  C(this.f);
}

class Point {
  int x, y;
  Point(this.x, this.y);
}
''');
  }
}

@reflectiveTest
class TypeInitFormalsTest extends RemoveTypeAnnotationTest {
  @override
  String get lintCode => LintNames.type_init_formals;

  Future<void> test_formalFieldParameter() async {
    await resolveTestCode('''
class C {
  int f;
  C(int this.f);
}
''');
    await assertHasFix('''
class C {
  int f;
  C(this.f);
}
''');
  }

  @FailingTest(issue: 'https://github.com/dart-lang/linter/issues/3858')
  Future<void> test_functionTyped_parameterTypeIsNotSupertype() async {
    await resolveTestCode('''
class C {
  void Function(int) f;
  C(void this.f(int p));
}
''');
    await assertHasFix('''
class C {
  void Function(int) f;
  C(void this.f(int p));
}
''');
  }

  @FailingTest(issue: 'https://github.com/dart-lang/linter/issues/3858')
  Future<void> test_functionTyped_returnTypeIsNotSubtype() async {
    await resolveTestCode('''
class C {
  int Function() f;
  C(int this.f());
}
''');
    await assertHasFix('''
class C {
  int Function() f;
  C(this.f());
}
''');
  }

  @FailingTest(issue: 'https://github.com/dart-lang/linter/issues/3210')
  Future<void> test_superParameter() async {
    // If this issue gets closed as "won't fix," remove this test.
    await resolveTestCode('''
class C {
  C(int f);
}
class D extends C {
  D(int super.f);
}
''');
    await assertHasFix('''
class C {
  int f;
  C(super.f);
}
''');
  }
}

@reflectiveTest
class VarAndTypeTest extends FixProcessorTest {
  @override
  FixKind get kind => DartFixKind.REMOVE_TYPE_ANNOTATION;

  Future<void> test_declaredVariablePattern() async {
    await resolveTestCode('''
void f(Object? x) {
  switch (x) {
    case var int y:
      y;
  }
}
''');
    await assertHasFix('''
void f(Object? x) {
  switch (x) {
    case var y:
      y;
  }
}
''');
  }

  Future<void> test_variableDeclarationList() async {
    await resolveTestCode('''
void f() {
  var int v = 0;
  v;
}
''');
    await assertHasFix('''
void f() {
  var v = 0;
  v;
}
''');
  }
}