/** 測試當使用者自訂的type1是否能抓到Outer class 未測試完成 */
@Test
public void testAddDummyHandlerSmellInfoForUserPatternType1() {
String testClassPattern = UserDefineDummyHandlerFish.class.getName() + ".*";
// 確認初始值
setEmptySetting();
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
compilationUnit.accept(dummyHandlerVisitor);
assertEquals(0, dummyHandlerVisitor.getDummyList().size());
// 確認全部的Example中恰有偵測到兩次呼叫
smellSettings.addDummyHandlerPattern(testClassPattern, true);
smellSettings.writeXMLFile(UserDefinedMethodAnalyzer.SETTINGFILEPATH);
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
compilationUnit.accept(dummyHandlerVisitor);
assertEquals(2, dummyHandlerVisitor.getDummyList().size());
// 確認當使用者未勾選時不會偵測到
setEmptySetting();
smellSettings.addDummyHandlerPattern(testClassPattern, false);
smellSettings.writeXMLFile(UserDefinedMethodAnalyzer.SETTINGFILEPATH);
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
compilationUnit.accept(dummyHandlerVisitor);
assertEquals(0, dummyHandlerVisitor.getDummyList().size());
}
@Test
public void testAddDummyHandlerSmellInfoWithUserDefinedPatternAndDetecting() {
// 使用者自定義 *.toString 的Pattern，並且要求要偵測
setEmptySetting();
smellSettings.addDummyHandlerPattern("*.toString", true);
smellSettings.writeXMLFile(UserDefinedMethodAnalyzer.SETTINGFILEPATH);
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
compilationUnit.accept(dummyHandlerVisitor);
assertEquals(2, dummyHandlerVisitor.getDummyList().size());
MethodInvocation mi = null;
// 符合 *.toString 的程式碼 -> e.toString()
mi =
ASTNodeFinder.getMethodInvocationByMethodNameAndCode(
compilationUnit, "true_systemOutPrintlnWithoutE", "e.toString()")
.get(0);
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
dummyHandlerVisitor.detectDummyHandler(mi);
assertEquals(1, dummyHandlerVisitor.getDummyList().size());
// 不符合 *.toString 的程式碼 -> e.toString.toCharArray()
mi =
ASTNodeFinder.getMethodInvocationByMethodNameAndCode(
compilationUnit, "true_systemOutPrintlnWithoutE", "e.toString().toCharArray()")
.get(0);
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
dummyHandlerVisitor.detectDummyHandler(mi);
assertEquals(0, dummyHandlerVisitor.getDummyList().size());
}
@Test
public void testAddDummyHandlerSmellInfoForExtraRule_OrgApacheLog4j() throws Exception {
Method method =
DummyHandlerVisitor.class.getDeclaredMethod(
"addDummyHandlerSmellInfo", MethodInvocation.class);
method.setAccessible(true);
// 確認初始值
setEmptySetting();
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
compilationUnit.accept(dummyHandlerVisitor);
assertEquals(0, dummyHandlerVisitor.getDummyList().size());
// OrgApacheLog4j case
dummyHandlerPatternsInXML = new String[] {SmellSettings.EXTRARULE_OrgApacheLog4j};
setNewSettingsWithExtraRules(dummyHandlerPatternsInXML);
// 分別測試：全部例子、符合例子、不符合例子 是否有抓出
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
compilationUnit.accept(dummyHandlerVisitor);
assertEquals(1, dummyHandlerVisitor.getDummyList().size());
MethodInvocation mi = null;
mi =
ASTNodeFinder.getMethodInvocationByMethodNameAndCode(
compilationUnit, "true_Log4J", "log4j.info(\"message\")")
.get(0);
method.invoke(dummyHandlerVisitor, mi);
assertEquals(2, dummyHandlerVisitor.getDummyList().size());
mi =
ASTNodeFinder.getMethodInvocationByMethodNameAndCode(
compilationUnit, "true_javaLogInfo", "javaLog.info(\"\")")
.get(0);
method.invoke(dummyHandlerVisitor, mi);
assertEquals(2, dummyHandlerVisitor.getDummyList().size());
}
@Test
public void testAddDummyHandlerSmellInfoForExtraRule_PrintStackTrace() throws Exception {
Method method =
DummyHandlerVisitor.class.getDeclaredMethod(
"addDummyHandlerSmellInfo", MethodInvocation.class);
method.setAccessible(true);
// 確認初始值
setEmptySetting();
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
compilationUnit.accept(dummyHandlerVisitor);
assertEquals(0, dummyHandlerVisitor.getDummyList().size());
// ePrintStackTrace case
dummyHandlerPatternsInXML = new String[] {SmellSettings.EXTRARULE_ePrintStackTrace};
setNewSettingsWithExtraRules(dummyHandlerPatternsInXML);
// 分別測試：全部例子、符合例子、不符合例子 是否有抓出
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
compilationUnit.accept(dummyHandlerVisitor);
assertEquals(10, dummyHandlerVisitor.getDummyList().size());
MethodInvocation mi = null;
mi =
ASTNodeFinder.getMethodInvocationByMethodNameAndCode(
compilationUnit, "true_printStackTrace_protected", "e.printStackTrace()")
.get(0);
method.invoke(dummyHandlerVisitor, mi);
assertEquals(11, dummyHandlerVisitor.getDummyList().size());
}
@Test
public void testVisitMethodInvocation() {
MethodInvocation methodInvocation =
ASTNodeFinder.getMethodInvocationByMethodNameAndCode(
compilationUnit, "true_printStackTrace_public", "e.printStackTrace()")
.get(0);
assertFalse(dummyHandlerVisitor.visit(methodInvocation));
assertEquals(1, dummyHandlerVisitor.getDummyList().size());
}
@Test
public void testDetectDummyHandler() {
// 確認初始值
assertEquals(0, dummyHandlerVisitor.getDummyList().size());
// #1 正常的DummyHandler
MethodInvocation methodInvocation =
ASTNodeFinder.getMethodInvocationByMethodNameAndCode(
compilationUnit, "true_printStackTrace_public", "e.printStackTrace()")
.get(0);
dummyHandlerVisitor.detectDummyHandler(methodInvocation);
assertEquals(1, dummyHandlerVisitor.getDummyList().size());
// #2 有throw
methodInvocation =
ASTNodeFinder.getMethodInvocationByMethodNameAndCode(
compilationUnit, "false_throwAndPrint", "e.printStackTrace()")
.get(0);
dummyHandlerVisitor.detectDummyHandler(methodInvocation);
assertEquals(1, dummyHandlerVisitor.getDummyList().size());
// #3 測 Catch 外面
methodInvocation =
ASTNodeFinder.getMethodInvocationByMethodNameAndCode(
compilationUnit, "true_printStackTrace_protected", "fis.read()")
.get(0);
dummyHandlerVisitor.detectDummyHandler(methodInvocation);
assertEquals(1, dummyHandlerVisitor.getDummyList().size());
}
@Test
public void testAddDummyHandlerSmellInfoWithUserDefinedPatternButNotDetecting() {
// 使用者有自定義 *.toString 的Pattern，但是不要偵測
setEmptySetting();
smellSettings.addDummyHandlerPattern("*.toString", false);
smellSettings.writeXMLFile(UserDefinedMethodAnalyzer.SETTINGFILEPATH);
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
compilationUnit.accept(dummyHandlerVisitor);
assertEquals(0, dummyHandlerVisitor.getDummyList().size());
// 使用者輸入改為 *.toString(), 不會被視同是 *.toString
setEmptySetting();
smellSettings.addDummyHandlerPattern("*.toString()", true);
smellSettings.writeXMLFile(UserDefinedMethodAnalyzer.SETTINGFILEPATH);
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
compilationUnit.accept(dummyHandlerVisitor);
assertEquals(0, dummyHandlerVisitor.getDummyList().size());
}
/** 測試當使用者自訂的type3是否能抓到 同時測試addDummyHandlerSmellInfo()中，遇到含有"<>"library會自動轉成"<"之前的子字串 */
@Test
public void testAddDummyHandlerSmellInfoForUserPatternType3WithBracket() {
String testClassPattern = "java.util.ArrayList.add";
setEmptySetting();
smellSettings.addDummyHandlerPattern(testClassPattern, true);
smellSettings.writeXMLFile(UserDefinedMethodAnalyzer.SETTINGFILEPATH);
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnit);
compilationUnit.accept(dummyHandlerVisitor);
assertEquals(1, dummyHandlerVisitor.getDummyList().size());
}
/**
* 另外測試若 try statement 位於非 try statement 之中時，是否會正確偵測
*
* @throws Exception
*/
@Test
public void testDetectDummyHandlerWithTryStatementInNonTryStatement() throws Exception {
CompilationUnit compilationUnitWithTSINTS;
// 新建立測試用的 DummyHandlerExampleWithTryStatementInNonTryStatement
javaFile2String.clear();
javaFile2String.read(
DummyHandlerExampleWithTryStatementInNonTryStatement.class,
JavaProjectMaker.FOLDERNAME_TEST);
javaProjectMaker.createJavaFile(
DummyHandlerExampleWithTryStatementInNonTryStatement.class.getPackage().getName(),
DummyHandlerExampleWithTryStatementInNonTryStatement.class.getSimpleName()
+ JavaProjectMaker.JAVA_FILE_EXTENSION,
"package "
+ DummyHandlerExampleWithTryStatementInNonTryStatement.class.getPackage().getName()
+ ";\n"
+ javaFile2String.getFileContent());
Path path =
new Path(
PathUtils.getPathOfClassUnderSrcFolder(
DummyHandlerExampleWithTryStatementInNonTryStatement.class, testProjectName));
// Create AST to parse
ASTParser parser = ASTParser.newParser(AST.JLS3);
parser.setKind(ASTParser.K_COMPILATION_UNIT);
// 設定要被建立AST的檔案
parser.setSource(
JavaCore.createCompilationUnitFrom(ResourcesPlugin.getWorkspace().getRoot().getFile(path)));
parser.setResolveBindings(true);
// 取得AST
compilationUnitWithTSINTS = (CompilationUnit) parser.createAST(null);
compilationUnitWithTSINTS.recordModifications();
dummyHandlerVisitor = new DummyHandlerVisitor(compilationUnitWithTSINTS);
// 確認初始值
assertEquals(0, dummyHandlerVisitor.getDummyList().size());
// do this test
compilationUnitWithTSINTS.accept(dummyHandlerVisitor);
// 驗證總共抓到幾個bad smell
assertEquals(2, dummyHandlerVisitor.getDummyList().size());
}
@Test
public void testIsThrowStatementInCatchClause() {
TryStatement tryStatement;
CatchClause catchStatement;
// 測試 符合的例子 是否會抓出
MethodDeclaration md = null;
md = ASTNodeFinder.getMethodDeclarationNodeByName(compilationUnit, "false_throwAndPrint");
tryStatement = (TryStatement) md.getBody().statements().get(0);
catchStatement = (CatchClause) tryStatement.catchClauses().get(0);
assertTrue(dummyHandlerVisitor.isThrowStatementInCatchClause(catchStatement));
// 測試 不符合例子 是否會抓出
md =
ASTNodeFinder.getMethodDeclarationNodeByName(
compilationUnit, "true_DummyHandlerTryNestedTry");
tryStatement = (TryStatement) md.getBody().statements().get(1);
catchStatement = (CatchClause) tryStatement.catchClauses().get(0);
assertFalse(dummyHandlerVisitor.isThrowStatementInCatchClause(catchStatement));
}