/*
* Copyright 2000-2016 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.codeInspection.visibility;
import com.intellij.ToolExtensionPoints;
import com.intellij.codeInspection.LocalInspectionTool;
import com.intellij.codeInspection.reference.RefElement;
import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.openapi.extensions.Extensions;
import com.intellij.openapi.util.InvalidDataException;
import com.intellij.openapi.util.WriteExternalException;
import com.intellij.psi.PsiClass;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiMember;
import com.intellij.psi.PsiMethod;
import com.intellij.psi.util.PsiUtil;
import com.intellij.testFramework.PlatformTestUtil;
import com.siyeh.ig.LightInspectionTestCase;
import org.jdom.Element;
import org.jetbrains.annotations.NotNull;
@SuppressWarnings("WeakerAccess")
public class AccessCanBeTightenedInspectionTest extends LightInspectionTestCase {
private VisibilityInspection myVisibilityInspection = createTool();
@Override
protected LocalInspectionTool getInspection() {
return myVisibilityInspection.getSharedLocalInspectionTool();
}
@Override
protected void tearDown() throws Exception {
myVisibilityInspection = null;
super.tearDown();
}
private static VisibilityInspection createTool() {
VisibilityInspection inspection = new VisibilityInspection();
inspection.SUGGEST_PRIVATE_FOR_INNERS = true;
inspection.SUGGEST_PACKAGE_LOCAL_FOR_TOP_CLASSES = true;
inspection.SUGGEST_PACKAGE_LOCAL_FOR_MEMBERS = true;
return inspection;
}
public void testSimple() {
doTest("import java.util.*;\n" +
"class C {\n" +
" final int /*Access can be private*/fd/**/ = 0;\n" +
" /*Access can be private*/public/**/ int fd2;\n" +
" /*Access can be package-private*/public/**/ int forSubClass;\n" +
" @Override\n" +
" public int hashCode() {\n" +
" return fd + fd2;\n" + // use field
" }\n" +
"" +
" public void fff() {\n" +
" class Local {\n" +
" int /*Access can be private*/fd/**/;\n" +
" void f(){}\n" + // unused, ignore
" void /*Access can be private*/fd/**/(){}\n" +
" @Override\n" +
" public int hashCode() {\n" +
" fd();\n" +
" return fd;\n" +
" }\n" +
" class CantbePrivate {}\n" +
" }\n" +
" }\n" +
"}\n" +
"class Over extends C {" +
" int r = forSubClass;" +
" @Override " +
" public void fff() {}" +
"}");
}
public void testUseInAnnotation() {
doTest("import java.util.*;\n" +
"@interface Ann{ String value(); }\n" +
"@Ann(value = C.VAL\n)" +
"class C {\n" +
" /*Access can be package-private*/public/**/ static final String VAL = \"xx\";\n" +
"}");
}
public void testUseOfPackagePrivateInAnnotation() {
doTest("import java.util.*;\n" +
"@interface Ann{ String value(); }\n" +
"@Ann(value = C.VAL\n)" +
"class C {\n" +
" static final String VAL = \"xx\";\n" +
"}");
}
public void testSameFile() {
doTest("class C {\n" +
" private static class Err {\n" +
" /*Access can be private*/public/**/ boolean isVisible() { return true; }\n" +
" }\n"+
" boolean f = new Err().isVisible();\n" +
"}");
}
public void testAccessFromSubclass() {
myFixture.allowTreeAccessForAllFiles();
myFixture.addFileToProject("x/Sub.java",
"package x; " +
"import y.C; " +
"class Sub extends C {\n" +
" boolean f = new Err().isTVisible();\n" +
"}\n" +
"");
myFixture.addFileToProject("y/C.java",
"package y; public class C {\n" +
" public static class Err {\n" +
" public boolean isTVisible() { return true; }\n" +
" }\n"+
"}");
myFixture.configureByFiles("y/C.java","x/Sub.java");
myFixture.checkHighlighting();
}
public void testQualifiedAccessFromSubclass() {
myFixture.allowTreeAccessForAllFiles();
myFixture.addFileToProject("x/Sub.java",
"package x; " +
"import y.C; " +
"class Sub extends C {\n" +
" void bazz(C c) {\n" +
" int a = c.foo; c.bar();" +
" }\n" +
"}\n" +
"");
myFixture.addFileToProject("y/C.java",
"package y; public class C {\n" +
" public int foo = 0;\n" +
" public void bar() {}\n"+
"}");
myFixture.configureByFiles("y/C.java","x/Sub.java");
myFixture.checkHighlighting();
}
public void testDoNotSuggestPrivateInAnonymousClassIfPrivatesForInnersIsOff() {
myVisibilityInspection.SUGGEST_PACKAGE_LOCAL_FOR_MEMBERS = false;
myVisibilityInspection.SUGGEST_PRIVATE_FOR_INNERS = false;
doTest("class C {\n" +
" {\n" +
" new Runnable() {\n" +
" @Override\n" +
" public void run() { isDisposed = true; }\n"+
" boolean isVisible() { return true; }\n" +
" boolean isDisposed;\n" +
" }.run();\n" +
" }\n"+
"}");
}
public void testDoNotSuggestPrivateIfInExtendsOrImplements() {
doTest("abstract class C implements Comparable<C.Inner> {\n" +
" static class Inner {\n" +
" }\n"+
"}");
}
public void testDoNotSuggestPrivateForAbstractIDEA151875() {
doTest("class C {\n" +
" abstract static class Inner {\n" +
" abstract void foo();\n"+
" }\n" +
" void f(Inner i) {\n" +
" i.foo();\n" +
" }\n"+
"}");
}
public void testDoNotSuggestPrivateForInnerStaticSubclass() {
doTest("class A {\n" +
" <warning descr=\"Access can be package-private\">protected</warning> String myElement;\n" +
" static class B extends A {\n" +
" @Override\n" +
" public String toString() {\n" +
" return myElement;\n" +
" }\n" +
" }\n" +
"}");
}
public void testStupidTwoPublicClassesInTheSamePackage() {
myFixture.allowTreeAccessForAllFiles();
myFixture.addFileToProject("x/Sub.java",
"package x; " +
"public class Sub {\n" +
" Object o = new C();\n" +
"}\n" +
"");
myFixture.addFileToProject("x/C.java",
"package x; \n" +
"<warning descr=\"Access can be package-private\">public</warning> class C {\n" +
"}");
myFixture.configureByFiles("x/C.java", "x/Sub.java");
myFixture.checkHighlighting();
}
public void testInterfaceIsImplementedByLambda() {
myFixture.allowTreeAccessForAllFiles();
myFixture.addFileToProject("x/MyInterface.java",
"package x;\n" +
"public interface MyInterface {\n" +
" void doStuff();\n" +
"}\n" +
"");
myFixture.addFileToProject("x/MyConsumer.java",
"package x;\n" +
"public class MyConsumer {\n" +
" public void doIt(MyInterface i) {\n" +
" i.doStuff();\n" +
" }\n" +
"}" +
"");
myFixture.addFileToProject("y/Test.java",
"package y;\n" +
"\n" +
"import x.MyConsumer;\n" +
"\n" +
"public class Test {\n" +
" void ddd(MyConsumer consumer) {\n" +
" consumer.doIt(() -> {});\n" +
" }\n" +
"}" +
"");
myFixture.configureByFiles("x/MyInterface.java", "y/Test.java", "x/MyConsumer.java");
myFixture.checkHighlighting();
}
public void testInnerClassIsUnusedButItsMethodsAre() {
myFixture.allowTreeAccessForAllFiles();
myFixture.addFileToProject("x/Outer.java",
"package x;\n" +
"class Outer {\n" +
" static Inner makeInner() {\n" +
" return new Inner();\n" +
" }\n" +
"\n" +
" static class Inner {\n" +
" void frob() {}\n" +
" }\n" +
"}\n" +
"");
myFixture.addFileToProject("x/Consumer.java",
"package x;\n" +
"public class Consumer {\n" +
" public void doIt() {\n" +
" Outer.makeInner().frob();\n" +
" }\n" +
"}" +
"");
myFixture.configureByFiles("x/Outer.java", "x/Consumer.java");
myFixture.checkHighlighting();
}
public void testSuggestPackagePrivateForTopLevelClassSetting() {
myFixture.allowTreeAccessForAllFiles();
myVisibilityInspection.SUGGEST_PACKAGE_LOCAL_FOR_TOP_CLASSES = false;
myFixture.addFileToProject("x/Outer.java",
"package x;\n" +
"public class Outer {\n" +
"\n" +
"}\n" +
"");
myFixture.addFileToProject("x/Consumer.java",
"package x;\n" +
"public class Consumer {\n" +
" public void doIt() {\n" +
" System.out.println(Outer.class.hashCode());\n" +
" }\n" +
"}" +
"");
myFixture.configureByFiles("x/Outer.java", "x/Consumer.java");
myFixture.checkHighlighting();
}
public void testSuggestPackagePrivateForEntryPoint() {
myFixture.addFileToProject("x/MyTest.java",
"package x;\n" +
"public class MyTest {\n" +
" <warning descr=\"Access can be protected\">public</warning> void foo() {}\n" +
"}");
PlatformTestUtil.registerExtension(Extensions.getRootArea(), ExtensionPointName.create(ToolExtensionPoints.DEAD_CODE_TOOL), new EntryPointWithVisibilityLevel() {
@Override
public void readExternal(Element element) throws InvalidDataException {}
@Override
public void writeExternal(Element element) throws WriteExternalException {}
@NotNull
@Override
public String getDisplayName() {
return "accepted visibility";
}
@Override
public boolean isEntryPoint(@NotNull RefElement refElement, @NotNull PsiElement psiElement) {
return isEntryPoint(psiElement);
}
@Override
public boolean isEntryPoint(@NotNull PsiElement psiElement) {
return psiElement instanceof PsiMethod && "foo".equals(((PsiMethod)psiElement).getName()) || psiElement instanceof PsiClass;
}
@Override
public int getMinVisibilityLevel(PsiMember member) {
return member instanceof PsiMethod && isEntryPoint(member) ? PsiUtil.ACCESS_LEVEL_PROTECTED : -1;
}
@Override
public boolean isSelected() {
return true;
}
@Override
public void setSelected(boolean selected) {}
@Override
public String getTitle() {
return getDisplayName();
}
@Override
public String getId() {
return getDisplayName();
}
}, getTestRootDisposable());
myFixture.configureByFiles("x/MyTest.java");
myFixture.checkHighlighting();
}
}