litvinovg/vitro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

NIHVIVO-1562 Add unit tests for TemplateDirectiveModel and TemplateMethodModel help() methods that return something other than the expected type. Delete HelpDirectiveTest since it just replicated method and help directive tests in DumpDirectiveTest, and was a nuisance to maintain.

Browse source
This commit is contained in:
ryounes 2011-04-25 14:13:33 +00:00
parent 1b9f4bbdce
commit 1ef114ff45
3 changed files with 78 additions and 297 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
webapp/src/freemarker/ext/dump/BaseDumpDirective.java
View file

@ -453,7 +453,11 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
Method help = cls.getMethod("help", String.class); Method help = cls.getMethod("help", String.class);
try { try {
return (Map<String, Object>) help.invoke(model, varName); return (Map<String, Object>) help.invoke(model, varName);
} catch (Exception e) { } catch (ClassCastException e) {
log.error("Method help() of " + modelClass + " of class " + cls.getName() + " has incorrect return type.");
return null;
} catch (Exception e) {
//
log.error("Error invoking method help() on " + modelClass + " of class " + cls.getName()); log.error("Error invoking method help() on " + modelClass + " of class " + cls.getName());
return null; return null;
} }

81
webapp/test/freemarker/ext/dump/DumpDirectiveTest.java
View file

@ -286,12 +286,12 @@ public class DumpDirectiveTest {
} }
@Test @Test
public void dumpMethodWithBadHelp() { public void dumpMethodWithStringHelp() {
String varName = "square"; String varName = "square";
Map<String, Object> dataModel = new HashMap<String, Object>(); Map<String, Object> dataModel = new HashMap<String, Object>();
TemplateMethodModel methodModel = new MethodWithBadHelp(); TemplateMethodModel methodModel = new MethodWithStringHelp();
dataModel.put(varName, methodModel); dataModel.put(varName, methodModel);
Map<String, Object> expectedDumpValue = new HashMap<String, Object>(); Map<String, Object> expectedDumpValue = new HashMap<String, Object>();
@ -304,6 +304,26 @@ public class DumpDirectiveTest {
test(varName, dataModel, expectedDump); test(varName, dataModel, expectedDump);
} }
@Test
public void dumpMethodWithStringStringMapHelp() {
String varName = "square";
Map<String, Object> dataModel = new HashMap<String, Object>();
TemplateMethodModel methodModel = new MethodWithStringStringMapHelp();
dataModel.put(varName, methodModel);
Map<String, Object> expectedDumpValue = new HashMap<String, Object>();
expectedDumpValue.put(Key.TYPE.toString(), Type.METHOD);
expectedDumpValue.put(Key.CLASS.toString(), methodModel.getClass().getName());
expectedDumpValue.put(Key.HELP.toString(), new HashMap<String, Object>());
Map<String, Object> expectedDump = new HashMap<String, Object>();
expectedDump.put(varName, expectedDumpValue);
test(varName, dataModel, expectedDump);
}
@Test @Test
public void dumpHelplessDirective() { public void dumpHelplessDirective() {
@ -346,12 +366,12 @@ public class DumpDirectiveTest {
} }
@Test @Test
public void dumpDirectiveWithBadHelp() { public void dumpDirectiveWithStringHelp() {
String varName = "dump"; String varName = "dump";
Map<String, Object> dataModel = new HashMap<String, Object>(); Map<String, Object> dataModel = new HashMap<String, Object>();
TemplateDirectiveModel directiveModel = new DirectiveWithBadHelp(); TemplateDirectiveModel directiveModel = new DirectiveWithStringHelp();
dataModel.put(varName, directiveModel); dataModel.put(varName, directiveModel);
Map<String, Object> expectedDumpValue = new HashMap<String, Object>(); Map<String, Object> expectedDumpValue = new HashMap<String, Object>();
@ -364,6 +384,26 @@ public class DumpDirectiveTest {
test(varName, dataModel, expectedDump); test(varName, dataModel, expectedDump);
} }
@Test
public void dumpDirectiveWithStringStringMapHelp() {
String varName = "dump";
Map<String, Object> dataModel = new HashMap<String, Object>();
TemplateDirectiveModel directiveModel = new DirectiveWithStringStringMapHelp();
dataModel.put(varName, directiveModel);
Map<String, Object> expectedDumpValue = new HashMap<String, Object>();
expectedDumpValue.put(Key.TYPE.toString(), Type.DIRECTIVE);
expectedDumpValue.put(Key.CLASS.toString(), directiveModel.getClass().getName());
expectedDumpValue.put(Key.HELP.toString(), new HashMap<String, Object>());
Map<String, Object> expectedDump = new HashMap<String, Object>();
expectedDump.put(varName, expectedDumpValue);
test(varName, dataModel, expectedDump);
}
@Test @Test
public void dumpStringList() { public void dumpStringList() {
@ -814,15 +854,27 @@ public class DumpDirectiveTest {
} }
} }
private class MethodWithBadHelp implements TemplateMethodModel { private class MethodWithStringHelp implements TemplateMethodModel {
@Override @Override
public Object exec(List arg0) throws TemplateModelException { public Object exec(List arg0) throws TemplateModelException {
return null; return null;
} }
public Map<String, Object> help() { public String help(String name) {
return new HashMap<String, Object>(); return "help";
}
}
private class MethodWithStringStringMapHelp implements TemplateMethodModel {
@Override
public Object exec(List arg0) throws TemplateModelException {
return null;
}
public Map<String, String> help(String name) {
return new HashMap<String, String>();
} }
} }
@ -848,7 +900,7 @@ public class DumpDirectiveTest {
} }
} }
private class DirectiveWithBadHelp implements TemplateDirectiveModel { private class DirectiveWithStringHelp implements TemplateDirectiveModel {
@Override @Override
public void execute(Environment arg0, Map arg1, TemplateModel[] arg2, public void execute(Environment arg0, Map arg1, TemplateModel[] arg2,
@ -860,6 +912,19 @@ public class DumpDirectiveTest {
return "help"; return "help";
} }
} }
private class DirectiveWithStringStringMapHelp implements TemplateDirectiveModel {
@Override
public void execute(Environment arg0, Map arg1, TemplateModel[] arg2,
TemplateDirectiveBody arg3) throws TemplateException,
IOException {
}
public Map<String, String> help(String name) {
return new HashMap<String, String>();
}
}
private Map<String, Object> getDirectiveHelp(String name) { private Map<String, Object> getDirectiveHelp(String name) {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();

288
webapp/test/freemarker/ext/dump/HelpDirectiveTest.java
View file

@ -1,288 +0,0 @@
/* $This file is distributed under the terms of the license in /doc/license.txt$ */
package freemarker.ext.dump;
import static junit.framework.Assert.assertEquals;
import static junit.framework.Assert.fail;
import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.junit.Before;
import org.junit.Test;
import freemarker.core.Environment;
import freemarker.ext.dump.BaseDumpDirective.Key;
import freemarker.ext.dump.BaseDumpDirective.Type;
import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateDirectiveBody;
import freemarker.template.TemplateDirectiveModel;
import freemarker.template.TemplateException;
import freemarker.template.TemplateMethodModel;
import freemarker.template.TemplateModel;
import freemarker.template.TemplateModelException;
public class HelpDirectiveTest {
private Template template;
@Before
public void setUp() {
Configuration config = new Configuration();
String templateStr = "";
try {
template = new Template("template", new StringReader(templateStr), config);
} catch (Exception e) {
fail(e.getMessage());
}
// Turn off log messages to console
Logger.getLogger(BaseDumpDirective.class).setLevel(Level.OFF);
}
@Test
public void dumpHelplessMethod() {
String varName = "square";
Map<String, Object> dataModel = new HashMap<String, Object>();
TemplateMethodModel methodModel = new HelplessMethod();
dataModel.put(varName, methodModel);
Map<String, Object> expectedDumpValue = new HashMap<String, Object>();
expectedDumpValue.put(Key.TYPE.toString(), Type.METHOD);
expectedDumpValue.put(Key.CLASS.toString(), methodModel.getClass().getName());
expectedDumpValue.put(Key.HELP.toString(), null);
Map<String, Object> expectedDump = new HashMap<String, Object>();
expectedDump.put(varName, expectedDumpValue);
test(varName, dataModel, expectedDump);
}
@Test
public void dumpHelpfulMethod() {
String varName = "square";
Map<String, Object> dataModel = new HashMap<String, Object>();
TemplateMethodModel methodModel = new HelpfulMethod();
dataModel.put(varName, methodModel);
Map<String, Object> expectedDumpValue = new HashMap<String, Object>();
expectedDumpValue.put(Key.TYPE.toString(), Type.METHOD);
expectedDumpValue.put(Key.CLASS.toString(), methodModel.getClass().getName());
expectedDumpValue.put(Key.HELP.toString(), getMethodHelp(varName));
Map<String, Object> expectedDump = new HashMap<String, Object>();
expectedDump.put(varName, expectedDumpValue);
test(varName, dataModel, expectedDump);
}
@Test
public void dumpMethodWithBadHelp() {
String varName = "square";
Map<String, Object> dataModel = new HashMap<String, Object>();
TemplateMethodModel methodModel = new MethodWithBadHelp();
dataModel.put(varName, methodModel);
Map<String, Object> expectedDumpValue = new HashMap<String, Object>();
expectedDumpValue.put(Key.TYPE.toString(), Type.METHOD);
expectedDumpValue.put(Key.CLASS.toString(), methodModel.getClass().getName());
expectedDumpValue.put(Key.HELP.toString(), null);
Map<String, Object> expectedDump = new HashMap<String, Object>();
expectedDump.put(varName, expectedDumpValue);
test(varName, dataModel, expectedDump);
}
@Test
public void dumpHelplessDirective() {
String varName = "dump";
Map<String, Object> dataModel = new HashMap<String, Object>();
TemplateDirectiveModel directiveModel = new HelplessDirective();
dataModel.put(varName, directiveModel);
Map<String, Object> expectedDumpValue = new HashMap<String, Object>();
expectedDumpValue.put(Key.TYPE.toString(), Type.DIRECTIVE);
expectedDumpValue.put(Key.CLASS.toString(), directiveModel.getClass().getName());
expectedDumpValue.put(Key.HELP.toString(), null);
Map<String, Object> expectedDump = new HashMap<String, Object>();
expectedDump.put(varName, expectedDumpValue);
test(varName, dataModel, expectedDump);
}
@Test
public void dumpHelpfulDirective() {
String varName = "dump";
Map<String, Object> dataModel = new HashMap<String, Object>();
TemplateDirectiveModel directiveModel = new HelpfulDirective();
dataModel.put(varName, directiveModel);
Map<String, Object> expectedDumpValue = new HashMap<String, Object>();
expectedDumpValue.put(Key.TYPE.toString(), Type.DIRECTIVE);
expectedDumpValue.put(Key.CLASS.toString(), directiveModel.getClass().getName());
expectedDumpValue.put(Key.HELP.toString(), getDirectiveHelp(varName));
Map<String, Object> expectedDump = new HashMap<String, Object>();
expectedDump.put(varName, expectedDumpValue);
test(varName, dataModel, expectedDump);
}
@Test
public void dumpDirectiveWithBadHelp() {
String varName = "dump";
Map<String, Object> dataModel = new HashMap<String, Object>();
TemplateDirectiveModel directiveModel = new DirectiveWithBadHelp();
dataModel.put(varName, directiveModel);
Map<String, Object> expectedDumpValue = new HashMap<String, Object>();
expectedDumpValue.put(Key.TYPE.toString(), Type.DIRECTIVE);
expectedDumpValue.put(Key.CLASS.toString(), directiveModel.getClass().getName());
expectedDumpValue.put(Key.HELP.toString(), null);
Map<String, Object> expectedDump = new HashMap<String, Object>();
expectedDump.put(varName, expectedDumpValue);
test(varName, dataModel, expectedDump);
}
/////////////////////////// Private test classes and helper methods ///////////////////////////
private class HelplessMethod implements TemplateMethodModel {
@Override
public Object exec(List arg0) throws TemplateModelException {
return null;
}
}
private class HelpfulMethod implements TemplateMethodModel {
@Override
public Object exec(List arg0) throws TemplateModelException {
return null;
}
public Map<String, Object> help(String name) {
return getMethodHelp(name);
}
}
private class MethodWithBadHelp implements TemplateMethodModel {
@Override
public Object exec(List arg0) throws TemplateModelException {
return null;
}
public Map<String, Object> help() {
return new HashMap<String, Object>();
}
}
private class HelplessDirective implements TemplateDirectiveModel {
@Override
public void execute(Environment arg0, Map arg1, TemplateModel[] arg2,
TemplateDirectiveBody arg3) throws TemplateException,
IOException {
}
}
private class HelpfulDirective implements TemplateDirectiveModel {
@Override
public void execute(Environment arg0, Map arg1, TemplateModel[] arg2,
TemplateDirectiveBody arg3) throws TemplateException,
IOException {
}
public Map<String, Object> help(String name) {
return getDirectiveHelp(name);
}
}
private class DirectiveWithBadHelp implements TemplateDirectiveModel {
@Override
public void execute(Environment arg0, Map arg1, TemplateModel[] arg2,
TemplateDirectiveBody arg3) throws TemplateException,
IOException {
}
public String help(String name) {
return "help";
}
}
private Map<String, Object> getDirectiveHelp(String name) {
Map<String, Object> map = new HashMap<String, Object>();
map.put("effect", "Dump the contents of a template variable.");
map.put("comments", "Sequences (lists and arrays) are enclosed in square brackets. Hashes are enclosed in curly braces.");
Map<String, String> parameters = new HashMap<String, String>();
parameters.put("var", "name of variable to dump");
map.put("parameters", parameters);
List<String> examples = new ArrayList<String>();
examples.add("<@" + name + " var=\"urls\" />");
map.put("examples", examples);
return map;
}
private Map<String, Object> getMethodHelp(String name) {
Map<String, Object> map = new HashMap<String, Object>();
map.put("returns", "The square of the argument");
List<String> params = new ArrayList<String>();
params.add("Integer to square");
map.put("parameters", params);
List<String> examples = new ArrayList<String>();
examples.add(name + "(4)");
map.put("examples", examples);
return map;
}
private Map<String, Object> getDump(String varName, Map<String, Object> dataModel) {
try {
Environment env = template.createProcessingEnvironment(dataModel, new StringWriter());
return new DumpDirective().getTemplateVariableDump(varName, env);
} catch (Exception e) {
fail(e.getMessage());
return null;
}
}
private void test(String varName, Map<String, Object> dataModel, Map<String, Object> expectedDump) {
Map<String, Object> dump = getDump(varName, dataModel);
assertEquals(expectedDump, dump);
}
}