Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rule to check for structNew and suggest using {} instead #91

Merged
merged 4 commits into from
Oct 12, 2015
Merged

Rule to check for structNew and suggest using {} instead #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift click to select a range
a55c45a
added rule for struct new
justinmclean Oct 11, 2015
4acd96d
Rule to test if structnew is used and suggest using {} instead
justinmclean Oct 11, 2015
3a4b229
tests for structNew rule
justinmclean Oct 11, 2015
f191567
implemented generic function check
ryaneberly Oct 12, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions src/main/java/com/cflint/plugins/core/FunctionXChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 1,35 @@
package com.cflint.plugins.core;

import ro.fortsoft.pf4j.Extension;
import net.htmlparser.jericho.Element;
import cfml.parsing.cfscript.CFExpression;
import cfml.parsing.cfscript.CFFunctionExpression;
import cfml.parsing.cfscript.script.CFExpressionStatement;
import cfml.parsing.cfscript.script.CFScriptStatement;

import com.cflint.BugInfo;
import com.cflint.BugList;
import com.cflint.plugins.CFLintScannerAdapter;
import com.cflint.plugins.Context;

@Extension
public class FunctionXChecker extends CFLintScannerAdapter {
final String severity = "INFO";

@Override
public void expression(CFExpression expression, Context context,
BugList bugs) {
if (expression instanceof CFFunctionExpression) {
final String cfmlFunctionCheck = getParameter("functionName");

CFFunctionExpression functionExpression = (CFFunctionExpression)expression;
if(functionExpression.getName().equalsIgnoreCase(cfmlFunctionCheck)){
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

may want to use cfmlFunctionCheck "(" so less chance of matching things that are not function calls?

int lineNo = expression.getLine() context.startLine() - 1;
//structNew(lineNo, context, bugs);
context.addMessage("AVOID_USING_" cfmlFunctionCheck.toUpperCase(), cfmlFunctionCheck);

}
}
}

}
11 changes: 10 additions & 1 deletion src/main/resources/cflint.definition.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,9 174,18 @@
</message>
<parameter name="maximum" value="10" />
</ruleImpl>
<ruleImpl name="WriteDumpChecker" className="WriteDumpChecker">
<ruleImpl name="WriteDumpChecker" className="FunctionXChecker">
<message code="AVOID_USING_WRITEDUMP">
<messageText>Avoid using the ${functionName} function in production code.</messageText>
<severity>INFO</severity>
</message>
<parameter name="functionName" value="writeDump"/>
</ruleImpl>
<ruleImpl name="StructNewChecker" className="FunctionXChecker">
<message code="AVOID_USING_STRUCTNEW">
<messageText>Avoid using the ${functionName} function. Use implicit structure construction instead (= {}).</messageText>
<severity>INFO</severity>
</message>
<parameter name="functionName" value="structNew"/>
</ruleImpl>
</CFLint-Plugin>
66 changes: 66 additions & 0 deletions src/test/java/com/cflint/TestStructNewChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 1,66 @@
package com.cflint;

import static org.junit.Assert.assertEquals;

import java.io.IOException;
import java.util.List;

import org.junit.Before;
import org.junit.Test;

import cfml.parsing.reporting.ParseException;

import com.cflint.config.CFLintPluginInfo.PluginInfoRule;
import com.cflint.config.CFLintPluginInfo.PluginInfoRule.PluginMessage;
import com.cflint.config.ConfigRuntime;
import com.cflint.plugins.core.FunctionXChecker;

public class TestStructNewChecker {

private CFLint cfBugs;

@Before
public void setUp() {
final ConfigRuntime conf = new ConfigRuntime();
final PluginInfoRule pluginRule = new PluginInfoRule();
pluginRule.setName("StructNewChecker");
pluginRule.setClassName("FunctionXChecker");
pluginRule.addParameter("functionName", "structnew");
conf.getRules().add(pluginRule);
final PluginMessage pluginMessage = new PluginMessage("AVOID_USING_STRUCTNEW");
pluginMessage.setSeverity("INFO");
pluginMessage
.setMessageText("Avoid using the ${functionName} function. Use implict structure construction instead (= {}).");
pluginRule.getMessages().add(pluginMessage);
FunctionXChecker checker = new FunctionXChecker();
checker.setParameter("functionName", "structnew");
cfBugs = new CFLint(conf, checker);
}

@Test
public void testStructNewInScript() throws ParseException, IOException {
final String scriptSrc = "<cfscript>\r\n"
"var a = 23;\r\n"
"var b = structNew();\r\n"
"</cfscript>";

cfBugs.process(scriptSrc, "test");
final List<BugInfo> result = cfBugs.getBugs().getBugList().values().iterator().next();
assertEquals(1, result.size());
assertEquals("AVOID_USING_STRUCTNEW", result.get(0).getMessageCode());
assertEquals(3, result.get(0).getLine());
}

@Test
public void testStructNewInTag() throws ParseException, IOException {
final String tagSrc = "<cfset a = 23>\r\n"
"<cfset b = structNew()>";

cfBugs.process(tagSrc, "test");
final List<BugInfo> result = cfBugs.getBugs().getBugList().values().iterator().next();
assertEquals(1, result.size());
assertEquals("AVOID_USING_STRUCTNEW", result.get(0).getMessageCode());
assertEquals(2, result.get(0).getLine());
}

}
11 changes: 10 additions & 1 deletion src/test/java/com/cflint/TestWriteDumpChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 13,7 @@
import com.cflint.config.CFLintPluginInfo.PluginInfoRule;
import com.cflint.config.CFLintPluginInfo.PluginInfoRule.PluginMessage;
import com.cflint.config.ConfigRuntime;
import com.cflint.plugins.core.FunctionXChecker;
import com.cflint.plugins.core.WriteDumpChecker;

public class TestWriteDumpChecker {
Expand All @@ -24,10 25,18 @@ public void setUp() {
final ConfigRuntime conf = new ConfigRuntime();
final PluginInfoRule pluginRule = new PluginInfoRule();
pluginRule.setName("WriteDumpChecker");
pluginRule.setClassName("FunctionXChecker");
pluginRule.addParameter("functionName", "writedump");
conf.getRules().add(pluginRule);
final PluginMessage pluginMessage = new PluginMessage("AVOID_USING_WRITEDUMP");
pluginMessage.setSeverity("INFO");
cfBugs = new CFLint(conf, new WriteDumpChecker());
pluginMessage.setMessageText("Avoid using the ${functionName} function in production code.");
pluginRule.getMessages().add(pluginMessage);

FunctionXChecker checker = new FunctionXChecker();
checker.setParameter("functionName", "writedump");
cfBugs = new CFLint(conf, checker);

}

@Test
Expand Down