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

// Copyright (c) 2019, 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/expect.dart';
import 'package:test_reflective_loader/test_reflective_loader.dart';

import 'fix_processor.dart';

void main() {
  defineReflectiveSuite(() {
    defineReflectiveTests(AddKeyToConstructorsBulkTest);
    defineReflectiveTests(AddKeyToConstructorsInFileTest);
    defineReflectiveTests(AddKeyToConstructorsTest);
    defineReflectiveTests(
        AddKeyToConstructorsWithoutNamedArgumentsAnywhereTest);
    defineReflectiveTests(AddKeyToConstructorsWithoutSuperParametersTest);
  });
}

@reflectiveTest
class AddKeyToConstructorsBulkTest extends BulkFixProcessorTest {
  @override
  String get lintCode => LintNames.use_key_in_widget_constructors;

  @override
  void setUp() {
    super.setUp();
    writeTestPackageConfig(
      flutter: true,
    );
  }

  Future<void> test_singleFile() async {
    await resolveTestCode(r'''
import 'package:flutter/material.dart';

class MyWidget1 extends StatelessWidget {
}

class MyWidget2 extends StatelessWidget {
}
''');
    await assertHasFix(r'''
import 'package:flutter/material.dart';

class MyWidget1 extends StatelessWidget {
  const MyWidget1({super.key});
}

class MyWidget2 extends StatelessWidget {
  const MyWidget2({super.key});
}
''');
  }
}

@reflectiveTest
class AddKeyToConstructorsInFileTest extends FixInFileProcessorTest {
  @override
  void setUp() {
    super.setUp();
    writeTestPackageConfig(
      flutter: true,
    );
  }

  Future<void> test_file() async {
    createAnalysisOptionsFile(
        lints: [LintNames.use_key_in_widget_constructors]);
    await resolveTestCode(r'''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  const MyWidget();
  const MyWidget.named();
}
''');
    var fixes = await getFixesForFirstError();
    expect(fixes, hasLength(1));
    assertProduces(fixes.first, r'''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  const MyWidget({super.key});
  const MyWidget.named({super.key});
}
''');
  }
}

@reflectiveTest
class AddKeyToConstructorsTest extends FixProcessorLintTest {
  @override
  FixKind get kind => DartFixKind.ADD_KEY_TO_CONSTRUCTORS;

  @override
  String get lintCode => LintNames.use_key_in_widget_constructors;

  @override
  void setUp() {
    super.setUp();
    writeTestPackageConfig(
      flutter: true,
    );
  }

  Future<void> test_class_newline() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  const MyWidget({super.key});
}
''');
  }

  Future<void> test_class_noNewline() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  const MyWidget({super.key});
}
''');
  }

  Future<void> test_class_withSuper_first() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  final int field;
  MyWidget() : super(), field = 0;
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  final int field;
  MyWidget({super.key}) : field = 0;
}
''', errorFilter: lintNameFilter(LintNames.use_key_in_widget_constructors));
  }

  Future<void> test_class_withSuper_middle() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  final int field1;
  final int field2;
  MyWidget() : field1 = 1, super(), field2 = 2;
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  final int field1;
  final int field2;
  MyWidget({super.key}) : field1 = 1, field2 = 2;
}
''', errorFilter: lintNameFilter(LintNames.use_key_in_widget_constructors));
  }

  Future<void> test_constructor_namedParameters_withoutSuper() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({required String s});
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({super.key, required String s});
}
''');
  }

  Future<void> test_constructor_namedParameters_withSuper() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({required String s}) : super();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({super.key, required String s});
}
''');
  }

  Future<void> test_constructor_namedParameters_withSuper_assert() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({required String s}) : assert(s.isNotEmpty), super();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({super.key, required String s}) : assert(s.isNotEmpty);
}
''');
  }

  Future<void> test_constructor_noNamedParameters_withoutSuper() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget(String s);
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget(String s, {super.key});
}
''');
  }

  Future<void> test_constructor_noNamedParameters_withSuper() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget(String s) : super();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget(String s, {super.key});
}
''');
  }

  Future<void> test_constructor_noParameters_withoutSuper() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({super.key});
}
''');
  }

  Future<void> test_constructor_noParameters_withSuper_empty() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget() : super();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({super.key});
}
''');
  }

  Future<void> test_constructor_noParameters_withSuper_nonEmpty() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A({required this.text, Key? key}) : super(key: key);

  final String text;
}

class MyWidget extends A {
  MyWidget() : super(text: '');
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A({required this.text, Key? key}) : super(key: key);

  final String text;
}

class MyWidget extends A {
  MyWidget({super.key}) : super(text: '');
}
''');
  }

  Future<void>
      test_constructor_noParameters_withSuper_nonEmpty_tailingComma() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A({required this.text, Key? key}) : super(key: key);

  final String text;
}

class MyWidget extends A {
  MyWidget() : super(text: '',);
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A({required this.text, Key? key}) : super(key: key);

  final String text;
}

class MyWidget extends A {
  MyWidget({super.key}) : super(text: '',);
}
''');
  }

  Future<void>
      test_constructor_noParameters_withSuper_nonNamed_trailingComma() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A(this.widget, {Key? key}) : super(key: key);

  final Widget widget;
}

class B extends A {
  B() : super(const Text(''),);
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A(this.widget, {Key? key}) : super(key: key);

  final Widget widget;
}

class B extends A {
  B({super.key}) : super(const Text(''),);
}
''');
  }

  Future<void> test_initializer_final_constant() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  final t = const Text('');
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  final t = const Text('');

  const MyWidget({super.key});
}
''');
  }

  Future<void> test_initializer_final_not_constant() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  final c = Container();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  final c = Container();

  MyWidget({super.key});
}
''');
  }

  Future<void> test_initializer_not_final_constant() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  var t = const Text('');
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  var t = const Text('');

  MyWidget({super.key});
}
''');
  }

  Future<void> test_initializer_not_final_not_constant() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  var c = Container();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  var c = Container();

  MyWidget({super.key});
}
''');
  }

  Future<void> test_initializer_static() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  static Text t = const Text('');
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  static Text t = const Text('');

  const MyWidget({super.key});
}
''');
  }

  Future<void> test_namedConstructor_namedParameters_withSuper_assert() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget.named({required String s}) : assert(s.isNotEmpty), super();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget.named({super.key, required String s}) : assert(s.isNotEmpty);
}
''');
  }

  Future<void> test_namedConstructor_noParameters_withoutSuper() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget.named();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget.named({super.key});
}
''');
  }

  Future<void> test_super_not_constant() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class ParentWidget extends StatelessWidget {
  final c = Container();

  ParentWidget({Key? key}) : super(key: key);
}

class MyWidget extends ParentWidget {
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class ParentWidget extends StatelessWidget {
  final c = Container();

  ParentWidget({Key? key}) : super(key: key);
}

class MyWidget extends ParentWidget {
  MyWidget({super.key});
}
''');
  }
}

@reflectiveTest
class AddKeyToConstructorsWithoutNamedArgumentsAnywhereTest
    extends FixProcessorLintTest {
  @override
  FixKind get kind => DartFixKind.ADD_KEY_TO_CONSTRUCTORS;

  @override
  String get lintCode => LintNames.use_key_in_widget_constructors;

  @override
  String get testPackageLanguageVersion => '2.16';

  @override
  void setUp() {
    super.setUp();
    writeTestPackageConfig(
      flutter: true,
    );
  }

  Future<void> test_constructor_noParameters_withSuper_nonEmpty() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A(this.widget, {Key? key}) : super(key: key);

  final Widget widget;
}

class B extends A {
  B() : super(const Text(''));
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A(this.widget, {Key? key}) : super(key: key);

  final Widget widget;
}

class B extends A {
  B({Key? key}) : super(const Text(''), key: key);
}
''');
  }
}

@reflectiveTest
class AddKeyToConstructorsWithoutSuperParametersTest
    extends FixProcessorLintTest {
  @override
  FixKind get kind => DartFixKind.ADD_KEY_TO_CONSTRUCTORS;

  @override
  String get lintCode => LintNames.use_key_in_widget_constructors;

  @override
  String get testPackageLanguageVersion => '2.16';

  @override
  void setUp() {
    super.setUp();
    writeTestPackageConfig(
      flutter: true,
    );
  }

  Future<void> test_class_newline() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  const MyWidget({Key? key}) : super(key: key);
}
''');
  }

  Future<void> test_class_noNewline() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  const MyWidget({Key? key}) : super(key: key);
}
''');
  }

  Future<void> test_constructor_namedParameters_withoutSuper() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({required String s});
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({Key? key, required String s}) : super(key: key);
}
''');
  }

  Future<void> test_constructor_namedParameters_withSuper() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({required String s}) : super();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({Key? key, required String s}) : super(key: key);
}
''');
  }

  Future<void> test_constructor_noNamedParameters_withoutSuper() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget(String s);
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget(String s, {Key? key}) : super(key: key);
}
''');
  }

  Future<void> test_constructor_noNamedParameters_withSuper() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget(String s) : super();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget(String s, {Key? key}) : super(key: key);
}
''');
  }

  Future<void> test_constructor_noParameters_withoutSuper() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({Key? key}) : super(key: key);
}
''');
  }

  Future<void> test_constructor_noParameters_withSuper_empty() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget() : super();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  MyWidget({Key? key}) : super(key: key);
}
''');
  }

  Future<void> test_constructor_noParameters_withSuper_nonEmpty() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A({required this.text, Key? key}) : super(key: key);

  final String text;
}

class MyWidget extends A {
  MyWidget() : super(text: '');
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A({required this.text, Key? key}) : super(key: key);

  final String text;
}

class MyWidget extends A {
  MyWidget({Key? key}) : super(key: key, text: '');
}
''');
  }

  Future<void>
      test_constructor_noParameters_withSuper_nonEmpty_tailingComma() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A({required this.text, Key? key}) : super(key: key);

  final String text;
}

class MyWidget extends A {
  MyWidget() : super(text: '',);
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A({required this.text, Key? key}) : super(key: key);

  final String text;
}

class MyWidget extends A {
  MyWidget({Key? key}) : super(key: key, text: '',);
}
''');
  }

  Future<void>
      test_constructor_noParameters_withSuper_nonNamed_trailingComma() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A(this.widget, {Key? key}) : super(key: key);

  final Widget widget;
}

class B extends A {
  B() : super(const Text(''),);
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class A extends StatelessWidget {
  const A(this.widget, {Key? key}) : super(key: key);

  final Widget widget;
}

class B extends A {
  B({Key? key}) : super(const Text(''), key: key,);
}
''');
  }

  Future<void> test_initializer_final_constant() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  final t = const Text('');
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  final t = const Text('');

  const MyWidget({Key? key}) : super(key: key);
}
''');
  }

  Future<void> test_initializer_final_not_constant() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  final c = Container();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  final c = Container();

  MyWidget({Key? key}) : super(key: key);
}
''');
  }

  Future<void> test_initializer_not_final_constant() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  var t = const Text('');
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  var t = const Text('');

  MyWidget({Key? key}) : super(key: key);
}
''');
  }

  Future<void> test_initializer_not_final_not_constant() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  var c = Container();
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  var c = Container();

  MyWidget({Key? key}) : super(key: key);
}
''');
  }

  Future<void> test_initializer_static() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  static Text t = const Text('');
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class MyWidget extends StatelessWidget {
  static Text t = const Text('');

  const MyWidget({Key? key}) : super(key: key);
}
''');
  }

  Future<void> test_super_not_constant() async {
    await resolveTestCode('''
import 'package:flutter/material.dart';

class ParentWidget extends StatelessWidget {
  final c = Container();

  ParentWidget({Key? key}) : super(key: key);
}

class MyWidget extends ParentWidget {
}
''');
    await assertHasFix('''
import 'package:flutter/material.dart';

class ParentWidget extends StatelessWidget {
  final c = Container();

  ParentWidget({Key? key}) : super(key: key);
}

class MyWidget extends ParentWidget {
  MyWidget({Key? key}) : super(key: key);
}
''');
  }
}