blob: 1db7113107e4ea2d7f5583e2242a0f805db455b4 [file] [log] [blame]
// Copyright (c) 2014, 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/status.dart';
import 'package:analyzer_plugin/protocol/protocol_common.dart';
import 'package:test/test.dart';
import 'package:test_reflective_loader/test_reflective_loader.dart';
import 'abstract_rename.dart';
main() {
defineReflectiveSuite(() {
defineReflectiveTests(RenameUnitMemberTest);
});
}
@reflectiveTest
class RenameUnitMemberTest extends RenameRefactoringTest {
test_checkFinalConditions_hasTopLevel_ClassElement() async {
await indexTestUnit('''
class Test {}
class NewName {} // existing
''');
createRenameRefactoringAtString('Test {}');
// check status
refactoring.newName = 'NewName';
RefactoringStatus status = await refactoring.checkFinalConditions();
assertRefactoringStatus(status, RefactoringProblemSeverity.ERROR,
expectedMessage: "Library already declares class with name 'NewName'.",
expectedContextSearch: 'NewName {} // existing');
}
test_checkFinalConditions_hasTopLevel_FunctionTypeAliasElement() async {
await indexTestUnit('''
class Test {}
typedef NewName(); // existing
''');
createRenameRefactoringAtString('Test {}');
// check status
refactoring.newName = 'NewName';
RefactoringStatus status = await refactoring.checkFinalConditions();
assertRefactoringStatus(status, RefactoringProblemSeverity.ERROR,
expectedMessage:
"Library already declares function type alias with name 'NewName'.",
expectedContextSearch: 'NewName(); // existing');
}
test_checkFinalConditions_OK_qualifiedSuper_MethodElement() async {
await indexTestUnit('''
class Test {}
class A {
NewName() {}
}
class B extends A {
main() {
super.NewName(); // super-ref
}
}
''');
createRenameRefactoringAtString('Test {}');
// check status
refactoring.newName = 'NewName';
RefactoringStatus status = await refactoring.checkFinalConditions();
assertRefactoringStatusOK(status);
}
test_checkFinalConditions_publicToPrivate_usedInOtherLibrary() async {
await indexTestUnit('''
class Test {}
''');
await indexUnit(convertPath('/project/lib.dart'), '''
library my.lib;
import 'test.dart';
main() {
new Test();
}
''');
createRenameRefactoringAtString('Test {}');
// check status
refactoring.newName = '_NewName';
RefactoringStatus status = await refactoring.checkFinalConditions();
assertRefactoringStatus(status, RefactoringProblemSeverity.ERROR,
expectedMessage: "Renamed class will be invisible in 'my.lib'.");
}
test_checkFinalConditions_shadowedBy_MethodElement() async {
await indexTestUnit('''
class Test {}
class A {
void NewName() {}
main() {
new Test();
}
}
''');
createRenameRefactoringAtString('Test {}');
// check status
refactoring.newName = 'NewName';
RefactoringStatus status = await refactoring.checkFinalConditions();
assertRefactoringStatus(status, RefactoringProblemSeverity.ERROR,
expectedMessage:
"Reference to renamed class will be shadowed by method 'A.NewName'.",
expectedContextSearch: 'NewName() {}');
}
test_checkFinalConditions_shadowsInSubClass_importedLib() async {
await indexTestUnit('''
class Test {}
''');
await indexUnit(convertPath('/project/lib.dart'), '''
library my.lib;
import 'test.dart';
class A {
NewName() {}
}
class B extends A {
main() {
NewName(); // super-ref
}",
}
''');
createRenameRefactoringAtString('Test {}');
// check status
refactoring.newName = 'NewName';
RefactoringStatus status = await refactoring.checkFinalConditions();
assertRefactoringStatus(status, RefactoringProblemSeverity.ERROR,
expectedMessage: "Renamed class will shadow method 'A.NewName'.");
}
test_checkFinalConditions_shadowsInSubClass_importedLib_hideCombinator() async {
await indexTestUnit('''
class Test {}
''');
await indexUnit('/lib.dart', '''
library my.lib;
import 'test.dart' hide Test;
class A {
NewName() {}
}
class B extends A {
main() {
NewName(); // super-ref
}",
}
''');
createRenameRefactoringAtString('Test {}');
// check status
refactoring.newName = 'NewName';
RefactoringStatus status = await refactoring.checkFinalConditions();
assertRefactoringStatusOK(status);
}
test_checkFinalConditions_shadowsInSubClass_MethodElement() async {
await indexTestUnit('''
class Test {}
class A {
NewName() {}
}
class B extends A {
main() {
NewName(); // super-ref
}
}
''');
createRenameRefactoringAtString('Test {}');
// check status
refactoring.newName = 'NewName';
RefactoringStatus status = await refactoring.checkFinalConditions();
assertRefactoringStatus(status, RefactoringProblemSeverity.ERROR,
expectedMessage: "Renamed class will shadow method 'A.NewName'.",
expectedContextSearch: 'NewName(); // super-ref');
}
test_checkFinalConditions_shadowsInSubClass_notImportedLib() async {
await indexUnit('/lib.dart', '''
library my.lib;
class A {
NewName() {}
}
class B extends A {
main() {
NewName(); // super-ref
}",
}
''');
await indexTestUnit('''
class Test {}
''');
createRenameRefactoringAtString('Test {}');
// check status
refactoring.newName = 'NewName';
RefactoringStatus status = await refactoring.checkFinalConditions();
assertRefactoringStatusOK(status);
}
test_checkFinalConditions_shadowsInSubClass_notSubClass() async {
await indexTestUnit('''
class Test {}
class A {
NewName() {}
}
class B {
main(A a) {
a.NewName();
}
}
''');
createRenameRefactoringAtString('Test {}');
// check status
refactoring.newName = 'NewName';
RefactoringStatus status = await refactoring.checkFinalConditions();
assertRefactoringStatusOK(status);
}
test_checkInitialConditions_inSDK() async {
await indexTestUnit('''
main() {
String s;
}
''');
createRenameRefactoringAtString('String s');
// check status
refactoring.newName = 'NewName';
RefactoringStatus status = await refactoring.checkInitialConditions();
assertRefactoringStatus(status, RefactoringProblemSeverity.FATAL,
expectedMessage:
"The class 'String' is defined in the SDK, so cannot be renamed.");
}
test_checkInitialConditions_outsideOfProject() async {
addSource('/other/lib.dart', r'''
class A {}
''');
await indexTestUnit('''
import "${convertPathForImport('/other/lib.dart')}";
main() {
A a;
}
''');
createRenameRefactoringAtString('A a');
// check status
refactoring.newName = 'NewName';
RefactoringStatus status = await refactoring.checkInitialConditions();
assertRefactoringStatus(status, RefactoringProblemSeverity.FATAL,
expectedMessage:
"The class 'A' is defined outside of the project, so cannot be renamed.");
}
test_checkNewName_ClassElement() async {
await indexTestUnit('''
class Test {}
''');
createRenameRefactoringAtString('Test {}');
// null
refactoring.newName = null;
assertRefactoringStatus(
refactoring.checkNewName(), RefactoringProblemSeverity.FATAL,
expectedMessage: "Class name must not be null.");
// empty
refactoring.newName = '';
assertRefactoringStatus(
refactoring.checkNewName(), RefactoringProblemSeverity.FATAL,
expectedMessage: "Class name must not be empty.");
// same
refactoring.newName = 'Test';
assertRefactoringStatus(
refactoring.checkNewName(), RefactoringProblemSeverity.FATAL,
expectedMessage:
"The new name must be different than the current name.");
// OK
refactoring.newName = 'NewName';
assertRefactoringStatusOK(refactoring.checkNewName());
}
test_checkNewName_FunctionElement() async {
await indexTestUnit('''
test() {}
''');
createRenameRefactoringAtString('test() {}');
// null
refactoring.newName = null;
assertRefactoringStatus(
refactoring.checkNewName(), RefactoringProblemSeverity.FATAL,
expectedMessage: "Function name must not be null.");
// empty
refactoring.newName = '';
assertRefactoringStatus(
refactoring.checkNewName(), RefactoringProblemSeverity.FATAL,
expectedMessage: "Function name must not be empty.");
// OK
refactoring.newName = 'newName';
assertRefactoringStatusOK(refactoring.checkNewName());
}
test_checkNewName_FunctionTypeAliasElement() async {
await indexTestUnit('''
typedef Test();
''');
createRenameRefactoringAtString('Test();');
// null
refactoring.newName = null;
assertRefactoringStatus(
refactoring.checkNewName(), RefactoringProblemSeverity.FATAL,
expectedMessage: "Function type alias name must not be null.");
// OK
refactoring.newName = 'NewName';
assertRefactoringStatusOK(refactoring.checkNewName());
}
test_checkNewName_TopLevelVariableElement() async {
await indexTestUnit('''
var test;
''');
createRenameRefactoringAtString('test;');
// null
refactoring.newName = null;
assertRefactoringStatus(
refactoring.checkNewName(), RefactoringProblemSeverity.FATAL,
expectedMessage: "Variable name must not be null.");
// empty
refactoring.newName = '';
assertRefactoringStatus(
refactoring.checkNewName(), RefactoringProblemSeverity.FATAL,
expectedMessage: "Variable name must not be empty.");
// OK
refactoring.newName = 'newName';
assertRefactoringStatusOK(refactoring.checkNewName());
}
test_createChange_ClassElement() async {
await indexTestUnit('''
class Test implements Other {
Test() {}
Test.named() {}
}
class Other {
factory Other.a() = Test;
factory Other.b() = Test.named;
}
main() {
Test t1 = new Test();
Test t2 = new Test.named();
}
''');
// configure refactoring
createRenameRefactoringAtString('Test implements');
expect(refactoring.refactoringName, 'Rename Class');
expect(refactoring.elementKindName, 'class');
expect(refactoring.oldName, 'Test');
refactoring.newName = 'NewName';
// validate change
return assertSuccessfulRefactoring('''
class NewName implements Other {
NewName() {}
NewName.named() {}
}
class Other {
factory Other.a() = NewName;
factory Other.b() = NewName.named;
}
main() {
NewName t1 = new NewName();
NewName t2 = new NewName.named();
}
''');
}
test_createChange_ClassElement_flutterWidget() async {
addFlutterPackage();
await indexTestUnit('''
import 'package:flutter/material.dart';
class TestPage extends StatefulWidget {
const TestPage();
@override
TestPageState createState() => new TestPageState();
}
class TestPageState extends State<TestPage> {
@override
Widget build(BuildContext context) => null;
}
''');
createRenameRefactoringAtString('TestPage extends');
expect(refactoring.refactoringName, 'Rename Class');
expect(refactoring.elementKindName, 'class');
expect(refactoring.oldName, 'TestPage');
refactoring.newName = 'NewPage';
return assertSuccessfulRefactoring('''
import 'package:flutter/material.dart';
class NewPage extends StatefulWidget {
const NewPage();
@override
NewPageState createState() => new NewPageState();
}
class NewPageState extends State<NewPage> {
@override
Widget build(BuildContext context) => null;
}
''');
}
test_createChange_ClassElement_flutterWidget_privateBoth() async {
addFlutterPackage();
await indexTestUnit('''
import 'package:flutter/material.dart';
class _TestPage extends StatefulWidget {
const _TestPage();
@override
_TestPageState createState() => new _TestPageState();
}
class _TestPageState extends State<_TestPage> {
@override
Widget build(BuildContext context) => null;
}
''');
createRenameRefactoringAtString('_TestPage extends');
expect(refactoring.refactoringName, 'Rename Class');
expect(refactoring.elementKindName, 'class');
expect(refactoring.oldName, '_TestPage');
refactoring.newName = '_NewPage';
return assertSuccessfulRefactoring('''
import 'package:flutter/material.dart';
class _NewPage extends StatefulWidget {
const _NewPage();
@override
_NewPageState createState() => new _NewPageState();
}
class _NewPageState extends State<_NewPage> {
@override
Widget build(BuildContext context) => null;
}
''');
}
test_createChange_ClassElement_flutterWidget_privateState() async {
addFlutterPackage();
await indexTestUnit('''
import 'package:flutter/material.dart';
class TestPage extends StatefulWidget {
const TestPage();
@override
_TestPageState createState() => new _TestPageState();
}
class _TestPageState extends State<TestPage> {
@override
Widget build(BuildContext context) => null;
}
''');
createRenameRefactoringAtString('TestPage extends');
expect(refactoring.refactoringName, 'Rename Class');
expect(refactoring.elementKindName, 'class');
expect(refactoring.oldName, 'TestPage');
refactoring.newName = 'NewPage';
return assertSuccessfulRefactoring('''
import 'package:flutter/material.dart';
class NewPage extends StatefulWidget {
const NewPage();
@override
_NewPageState createState() => new _NewPageState();
}
class _NewPageState extends State<NewPage> {
@override
Widget build(BuildContext context) => null;
}
''');
}
test_createChange_ClassElement_invocation() async {
verifyNoTestUnitErrors = false;
await indexTestUnit('''
class Test {
}
main() {
Test(); // invalid code, but still a reference
}
''');
// configure refactoring
createRenameRefactoringAtString('Test();');
expect(refactoring.refactoringName, 'Rename Class');
expect(refactoring.elementKindName, 'class');
expect(refactoring.oldName, 'Test');
refactoring.newName = 'NewName';
// validate change
return assertSuccessfulRefactoring('''
class NewName {
}
main() {
NewName(); // invalid code, but still a reference
}
''');
}
test_createChange_ClassElement_parameterTypeNested() async {
await indexTestUnit('''
class Test {
}
main(f(Test p)) {
}
''');
// configure refactoring
createRenameRefactoringAtString('Test {');
expect(refactoring.refactoringName, 'Rename Class');
expect(refactoring.oldName, 'Test');
refactoring.newName = 'NewName';
// validate change
return assertSuccessfulRefactoring('''
class NewName {
}
main(f(NewName p)) {
}
''');
}
test_createChange_ClassElement_typeAlias() async {
await indexTestUnit('''
class A {}
class Test = Object with A;
main(Test t) {
}
''');
// configure refactoring
createRenameRefactoringAtString('Test =');
expect(refactoring.refactoringName, 'Rename Class');
expect(refactoring.elementKindName, 'class');
expect(refactoring.oldName, 'Test');
refactoring.newName = 'NewName';
// validate change
return assertSuccessfulRefactoring('''
class A {}
class NewName = Object with A;
main(NewName t) {
}
''');
}
test_createChange_FunctionElement() async {
await indexTestUnit('''
test() {}
foo() {}
main() {
print(test);
print(test());
foo();
}
''');
// configure refactoring
createRenameRefactoringAtString('test() {}');
expect(refactoring.refactoringName, 'Rename Top-Level Function');
expect(refactoring.elementKindName, 'function');
expect(refactoring.oldName, 'test');
refactoring.newName = 'newName';
// validate change
return assertSuccessfulRefactoring('''
newName() {}
foo() {}
main() {
print(newName);
print(newName());
foo();
}
''');
}
test_createChange_FunctionElement_imported() async {
await indexUnit('/project/foo.dart', r'''
test() {}
foo() {}
''');
await indexTestUnit('''
import 'foo.dart';
main() {
print(test);
print(test());
foo();
}
''');
// configure refactoring
createRenameRefactoringAtString('test);');
expect(refactoring.refactoringName, 'Rename Top-Level Function');
expect(refactoring.elementKindName, 'function');
expect(refactoring.oldName, 'test');
refactoring.newName = 'newName';
// validate change
await assertSuccessfulRefactoring('''
import 'foo.dart';
main() {
print(newName);
print(newName());
foo();
}
''');
assertFileChangeResult('/project/foo.dart', '''
newName() {}
foo() {}
''');
}
test_createChange_FunctionTypeAliasElement() async {
await indexTestUnit('''
typedef void F();
void foo<T>() {}
void main() {
foo<F>();
}
''');
// configure refactoring
createRenameRefactoringAtString('F()');
expect(refactoring.refactoringName, 'Rename Function Type Alias');
expect(refactoring.elementKindName, 'function type alias');
expect(refactoring.oldName, 'F');
refactoring.newName = 'G';
// validate change
return assertSuccessfulRefactoring('''
typedef void G();
void foo<T>() {}
void main() {
foo<G>();
}
''');
}
test_createChange_PropertyAccessorElement_getter_declaration() async {
await _test_createChange_PropertyAccessorElement("test {}");
}
test_createChange_PropertyAccessorElement_getter_usage() async {
await _test_createChange_PropertyAccessorElement("test);");
}
test_createChange_PropertyAccessorElement_mix() async {
await _test_createChange_PropertyAccessorElement("test += 2");
}
test_createChange_PropertyAccessorElement_setter_declaration() async {
await _test_createChange_PropertyAccessorElement("test(x) {}");
}
test_createChange_PropertyAccessorElement_setter_usage() async {
await _test_createChange_PropertyAccessorElement("test = 1");
}
test_createChange_TopLevelVariableElement_field() async {
await _test_createChange_TopLevelVariableElement("test = 0");
}
test_createChange_TopLevelVariableElement_getter() async {
await _test_createChange_TopLevelVariableElement("test);");
}
test_createChange_TopLevelVariableElement_mix() async {
await _test_createChange_TopLevelVariableElement("test += 2");
}
test_createChange_TopLevelVariableElement_setter() async {
await _test_createChange_TopLevelVariableElement("test = 1");
}
_test_createChange_PropertyAccessorElement(String search) async {
await indexTestUnit('''
get test {}
set test(x) {}
main() {
print(test);
test = 1;
test += 2;
}
''');
// configure refactoring
createRenameRefactoringAtString(search);
expect(refactoring.refactoringName, 'Rename Top-Level Variable');
expect(refactoring.oldName, 'test');
refactoring.newName = 'newName';
// validate change
return assertSuccessfulRefactoring('''
get newName {}
set newName(x) {}
main() {
print(newName);
newName = 1;
newName += 2;
}
''');
}
_test_createChange_TopLevelVariableElement(String search) async {
await indexTestUnit('''
int test = 0;
main() {
print(test);
test = 1;
test += 2;
}
''');
// configure refactoring
createRenameRefactoringAtString(search);
expect(refactoring.refactoringName, 'Rename Top-Level Variable');
expect(refactoring.elementKindName, 'top level variable');
expect(refactoring.oldName, 'test');
refactoring.newName = 'newName';
// validate change
return assertSuccessfulRefactoring('''
int newName = 0;
main() {
print(newName);
newName = 1;
newName += 2;
}
''');
}
}