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.

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

Warn about abort statements in script blocks #87

Merged
merged 3 commits into from
Oct 11, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 29 additions & 0 deletions src/main/java/com/cflint/plugins/core/AbortChecker.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package com.cflint.plugins.core;

import ro.fortsoft.pf4j.Extension;
import cfml.parsing.cfscript.CFFunctionExpression;
import cfml.parsing.cfscript.script.CFAbortStatement;
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 AbortChecker extends CFLintScannerAdapter {
final String severity = "WARNING";

public void expression(final CFScriptStatement expression, final Context context, final BugList bugs) {
System.out.println(expression.getClass().getName());

if (expression instanceof CFAbortStatement) {
int lineNo = ((CFAbortStatement) expression).getLine();
bugs.add(new BugInfo.BugInfoBuilder().setLine(lineNo).setMessageCode("AVOID_USING_ABORT")
.setSeverity(severity).setFilename(context.getFilename())
.setMessage("Abort statement at " + lineNo + ". Avoid using abort in production code.")
.build());
}
}
}
5 changes: 5 additions & 0 deletions src/main/resources/cflint.definition.xml
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,11 @@
</message>
<parameter name="tagName" value="cfabort"/>
</ruleImpl>
<ruleImpl name="AbortChecker" className="AbortChecker">
<message code="AVOID_USING_ABORT">
<severity>INFO</severity>
</message>
</ruleImpl>
<ruleImpl name="CFInsertChecker" className="CFXTagChecker">
<message code="AVOID_USING_CFINSERT_TAG">
<messageText>Avoid using &lt;${tagName}&gt; tags. Use cfquery and cfstoredproc instead.</messageText>
Expand Down
56 changes: 56 additions & 0 deletions src/test/java/com/cflint/TestAbortChecker.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
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.AbortChecker;

public class TestAbortChecker {

private CFLint cfBugs;

@Before
public void setUp() {
final ConfigRuntime conf = new ConfigRuntime();
final PluginInfoRule pluginRule = new PluginInfoRule();
pluginRule.setName("AbortChecker");
pluginRule.addParameter("tagName", "cfabort");
conf.getRules().add(pluginRule);
final PluginMessage pluginMessage = new PluginMessage("AVOID_USING_ABORT");
pluginMessage.setSeverity("WARNING");
pluginRule.getMessages().add(pluginMessage);
cfBugs = new CFLint(conf, new AbortChecker());
}

@Test
public void test_no_abort() throws ParseException, IOException {
final String cfcSrc = "<cfscript>\r\n"
+ "a = 23;\r\n"
+ "</cfscript>";
cfBugs.process(cfcSrc, "test");
assertEquals(0, cfBugs.getBugs().getBugList().size());
}

@Test
public void test_abort() throws ParseException, IOException {
final String cfcSrc = "<cfscript>\r\n"
+ "abort;\r\n"
+ "</cfscript>";
cfBugs.process(cfcSrc, "test");
final List<BugInfo> result = cfBugs.getBugs().getBugList().values().iterator().next();
assertEquals(1, result.size());
assertEquals("AVOID_USING_ABORT", result.get(0).getMessageCode());
assertEquals(2, result.get(0).getLine());
}

}