File DefaultVelocityEngineTest.java

Branches:

0

Statements:

73

Methods:

14

Classes:

1

LOC:

265

NCLOC:

173

Total complexity:

14

Complexity density:

0.19

Statements/Method:

5.21

Methods/Class:

14

Average method complexity:

1

Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
DefaultVelocityEngineTest	51	73	0%	14	0	1.0100%

Class DefaultVelocityEngineTest

Class DefaultVelocityEngineTest	Line # 51	Total Statements 73	% Filtered 0%	Complexity 14	Uncovered Elements 0	TOTAL Coverage 1.0100%
setUp() : void setUp() : void	5959	8.08	0.00%	1.01	0.00	1.0 1.0100%
assertEvaluate(String,String,String) : void assertEvaluate(String,String,String) : void	7575	1.01	0.00%	1.01	0.00	1.0 1.0100%
assertEvaluate(String,String,String,Context) : void assertEvaluate(String,String,String,Context) : void	8080	3.03	0.00%	1.01	0.00	1.0 1.0100%
testEvaluateReader() : void testEvaluateReader() : void	8888	4.04	0.00%	1.01	0.00	1.0 1.0100%
testEvaluateString() : void testEvaluateString() : void	9898	2.02	0.00%	1.01	0.00	1.0 1.0100%
testSecureUberspectorActiveByDefault() : void testSecureUberspectorActiveByDefault() : void	109109	4.04	0.00%	1.01	0.00	1.0 1.0100%
testSettingNullAllowedByDefault() : void testSettingNullAllowedByDefault() : void	127127	13.013	0.00%	1.01	0.00	1.0 1.0100%
testOverrideConfiguration() : void testOverrideConfiguration() : void	149149	6.06	0.00%	1.01	0.00	1.0 1.0100%
testMacroIsolation() : void testMacroIsolation() : void	164164	4.04	0.00%	1.01	0.00	1.0 1.0100%
testConfigureMacrosToBeGlobal() : void testConfigureMacrosToBeGlobal() : void	173173	6.06	0.00%	1.01	0.00	1.0 1.0100%
testMacroNamespaceCleanup() : void testMacroNamespaceCleanup() : void	188188	9.09	0.00%	1.01	0.00	1.0 1.0100%
call() : Void call() : Void	243243	2.02	0.00%	1.01	0.00	1.0 1.0100%
testThreadsafeNamespaces() : void testThreadsafeNamespaces() : void	226226	9.09	0.00%	1.01	0.00	1.0 1.0100%
testEvaluateWithStopCommand() : void testEvaluateWithStopCommand() : void	258258	2.02	0.00%	1.01	0.00	1.0 1.0100%

Contributing tests

This file is covered by 10 tests. .

Contributing tests

	Test contribution	Test	Result	Actions
	0.21839081	org.xwiki.velocity.internal.DefaultVelocityEngineTest.testThreadsafeNamespacesorg.xwiki.velocity.internal.DefaultVelocityEngineTest.testThreadsafeNamespaces	1PASS
	0.20689656	org.xwiki.velocity.internal.DefaultVelocityEngineTest.testSettingNullAllowedByDefaultorg.xwiki.velocity.internal.DefaultVelocityEngineTest.testSettingNullAllowedByDefault	1PASS
	0.18390805	org.xwiki.velocity.internal.DefaultVelocityEngineTest.testMacroNamespaceCleanuporg.xwiki.velocity.internal.DefaultVelocityEngineTest.testMacroNamespaceCleanup	1PASS
	0.14942528	org.xwiki.velocity.internal.DefaultVelocityEngineTest.testConfigureMacrosToBeGlobalorg.xwiki.velocity.internal.DefaultVelocityEngineTest.testConfigureMacrosToBeGlobal	1PASS
	0.12643678	org.xwiki.velocity.internal.DefaultVelocityEngineTest.testMacroIsolationorg.xwiki.velocity.internal.DefaultVelocityEngineTest.testMacroIsolation	1PASS
	0.12643678	org.xwiki.velocity.internal.DefaultVelocityEngineTest.testSecureUberspectorActiveByDefaultorg.xwiki.velocity.internal.DefaultVelocityEngineTest.testSecureUberspectorActiveByDefault	1PASS
	0.10344828	org.xwiki.velocity.internal.DefaultVelocityEngineTest.testEvaluateWithStopCommandorg.xwiki.velocity.internal.DefaultVelocityEngineTest.testEvaluateWithStopCommand	1PASS
	0.10344828	org.xwiki.velocity.internal.DefaultVelocityEngineTest.testEvaluateStringorg.xwiki.velocity.internal.DefaultVelocityEngineTest.testEvaluateString	1PASS
	0.08045977	org.xwiki.velocity.internal.DefaultVelocityEngineTest.testOverrideConfigurationorg.xwiki.velocity.internal.DefaultVelocityEngineTest.testOverrideConfiguration	1PASS
	0.057471264	org.xwiki.velocity.internal.DefaultVelocityEngineTest.testEvaluateReaderorg.xwiki.velocity.internal.DefaultVelocityEngineTest.testEvaluateReader	1PASS

Source view

/*

* See the NOTICE file distributed with this work for additional

* information regarding copyright ownership.

*

* This is free software; you can redistribute it and/or modify it

* under the terms of the GNU Lesser General Public License as

* published by the Free Software Foundation; either version 2.1 of

* the License, or (at your option) any later version.

*

* This software is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

* Lesser General Public License for more details.

*

* You should have received a copy of the GNU Lesser General Public

* License along with this software; if not, write to the Free

* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA

* 02110-1301 USA, or see the FSF site: http://www.fsf.org.

*/

package org.xwiki.velocity.internal;

import static org.mockito.Mockito.verify;

import static org.mockito.Mockito.when;

import java.io.StringReader;

import java.io.StringWriter;

import java.util.ArrayList;

import java.util.List;

import java.util.Properties;

import java.util.concurrent.Callable;

import java.util.concurrent.ExecutionException;

import java.util.concurrent.ExecutorService;

import java.util.concurrent.Executors;

import java.util.concurrent.Future;

import org.apache.velocity.context.Context;

import org.junit.Assert;

import org.junit.Before;

import org.junit.Rule;

import org.junit.Test;

import org.xwiki.test.mockito.MockitoComponentMockingRule;

import org.xwiki.velocity.VelocityConfiguration;

import org.xwiki.velocity.XWikiVelocityException;

import org.xwiki.velocity.introspection.ChainingUberspector;

import org.xwiki.velocity.introspection.DeprecatedCheckUberspector;

import org.xwiki.velocity.introspection.SecureUberspector;

/**

* Unit tests for {@link DefaultVelocityEngine}.

*/

public class DefaultVelocityEngineTest

{

@Rule

public MockitoComponentMockingRule<DefaultVelocityEngine> mocker =

new MockitoComponentMockingRule<DefaultVelocityEngine>(DefaultVelocityEngine.class);

private DefaultVelocityEngine engine;

10

@Before

public void setUp() throws Exception

{

10

Properties properties = new Properties();

10

properties.put("runtime.introspector.uberspect", ChainingUberspector.class.getName());

10

properties.put("runtime.introspector.uberspect.chainClasses", SecureUberspector.class.getName() + ","

+ DeprecatedCheckUberspector.class.getName());

10

properties.put("directive.set.null.allowed", Boolean.TRUE.toString());

10

properties.put("velocimacro.permissions.allow.inline.local.scope", Boolean.TRUE.toString());

10

VelocityConfiguration configuration = this.mocker.getInstance(VelocityConfiguration.class);

10

when(configuration.getProperties()).thenReturn(properties);

10

this.engine = this.mocker.getComponentUnderTest();

}

11

private void assertEvaluate(String expected, String content, String template) throws XWikiVelocityException

{

11

assertEvaluate(expected, content, template, new org.apache.velocity.VelocityContext());

}

12

private void assertEvaluate(String expected, String content, String template, Context context)

throws XWikiVelocityException

{

12

StringWriter writer = new StringWriter();

12

this.engine.evaluate(context, writer, template, content);

12

Assert.assertEquals(expected, writer.toString());

}

1

@Test

public void testEvaluateReader() throws Exception

{

1

this.engine.initialize(new Properties());

1

StringWriter writer = new StringWriter();

1

this.engine.evaluate(new org.apache.velocity.VelocityContext(), writer, "mytemplate", new StringReader(

"#set($foo='hello')$foo World"));

1

Assert.assertEquals("hello World", writer.toString());

}

1

@Test

public void testEvaluateString() throws Exception

{

1

this.engine.initialize(new Properties());

1

assertEvaluate("hello World", "#set($foo='hello')$foo World", "mytemplate");

}

/**

* Verify that the default configuration doesn't allow calling Class.forName.

*/

1

@Test

public void testSecureUberspectorActiveByDefault() throws Exception

{

1

this.engine.initialize(new Properties());

1

String content =

"#set($foo = 'test')#set($object = $foo.class.forName('java.util.ArrayList')"

+ ".newInstance())$object.size()";

1

assertEvaluate("$object.size()", content, "mytemplate");

// Verify that we log a warning and verify the message.

1

verify(this.mocker.getMockedLogger()).warn(

"Cannot retrieve method forName from object of class " + "java.lang.Class due to security restrictions.");

}

/**

* Verify that the default configuration allows #setting existing variables to null.

*/

1

@Test

public void testSettingNullAllowedByDefault() throws Exception

{

1

this.engine.initialize(new Properties());

1

StringWriter writer = new StringWriter();

1

Context context = new org.apache.velocity.VelocityContext();

1

context.put("null", null);

1

List<String> list = new ArrayList<String>();

1

list.add("1");

1

list.add(null);

1

list.add("3");

1

context.put("list", list);

1

this.engine.evaluate(context, writer, "mytemplate", "#set($foo = true)${foo}#set($foo = $null)${foo}\n"

+ "#foreach($i in $list)${velocityCount}=$!{i} #end");

1

Assert.assertEquals("true${foo}\n1=1 2= 3=3 ", writer.toString());

1

String content =

"#set($foo = true)${foo}#set($foo = $null)${foo}\n" + "#foreach($i in $list)${velocityCount}=$!{i} #end";

1

assertEvaluate("true${foo}\n1=1 2= 3=3 ", content, "mytemplate", context);

}

1

@Test

public void testOverrideConfiguration() throws Exception

{

// For example try setting a non secure Uberspector.

1

Properties properties = new Properties();

1

properties

.setProperty("runtime.introspector.uberspect", "org.apache.velocity.util.introspection.UberspectImpl");

1

this.engine.initialize(properties);

1

StringWriter writer = new StringWriter();

1

this.engine.evaluate(new org.apache.velocity.VelocityContext(), writer, "mytemplate",

"#set($foo = 'test')#set($object = $foo.class.forName('java.util.ArrayList')"

+ ".newInstance())$object.size()");

1

Assert.assertEquals("0", writer.toString());

}

1

@Test

public void testMacroIsolation() throws Exception

{

1

this.engine.initialize(new Properties());

1

Context context = new org.apache.velocity.VelocityContext();

1

this.engine.evaluate(context, new StringWriter(), "template1", "#macro(mymacro)test#end");

1

assertEvaluate("#mymacro", "#mymacro", "template2");

}

1

@Test

public void testConfigureMacrosToBeGlobal() throws Exception

{

1

Properties properties = new Properties();

// Force macros to be global

1

properties.put("velocimacro.permissions.allow.inline.local.scope", "false");

1

this.engine.initialize(properties);

1

Context context = new org.apache.velocity.VelocityContext();

1

this.engine.evaluate(context, new StringWriter(), "template1", "#macro(mymacro)test#end");

1

assertEvaluate("test", "#mymacro", "template2");

}

/**

* Verify namespace is properly cleared when not needed anymore.

*/

1

@Test

public void testMacroNamespaceCleanup() throws Exception

{

1

this.engine.initialize(new Properties());

// Unprotected namespace

1

assertEvaluate("#mymacro", "#mymacro", "namespace");

1

this.engine.evaluate(new org.apache.velocity.VelocityContext(), new StringWriter(), "namespace",

"#macro(mymacro)test#end");

1

assertEvaluate("#mymacro", "#mymacro", "namespace");

// Protected namespace

// Start using namespace "namespace"

1

this.engine.startedUsingMacroNamespace("namespace");

// Register macro

1

this.engine.evaluate(new org.apache.velocity.VelocityContext(), new StringWriter(), "namespace",

"#macro(mymacro)test#end");

1

assertEvaluate("test", "#mymacro", "namespace");

// Mark namespace "namespace" as not used anymore

1

this.engine.stoppedUsingMacroNamespace("namespace");

1

assertEvaluate("#mymacro", "#mymacro", "namespace");

}

/**

* Make sure several thread that supposedly use the same namespace string don't collide.

*

* @throws XWikiVelocityException

* @throws InterruptedException

* @throws ExecutionException

*/

1

@Test

public void testThreadsafeNamespaces() throws XWikiVelocityException, InterruptedException, ExecutionException

{

1

this.engine.initialize(new Properties());

// Start using namespace "namespace"

1

this.engine.startedUsingMacroNamespace("namespace");

// Register macro

1

Context context = new org.apache.velocity.VelocityContext();

1

this.engine.evaluate(context, new StringWriter(), "namespace", "#macro(mymacro)test#end");

1

assertEvaluate("test", "#mymacro", "namespace");

1

ExecutorService pool = Executors.newSingleThreadExecutor();

1

Future<Void> future = pool.submit(new Callable<Void>()

{

1

@Override

public Void call() throws Exception

{

// the macro should not be available in a different thread than the one which registered it

1

assertEvaluate("#mymacro", "#mymacro", "namespace");

1

return null;

}

});

1

future.get();

// Mark namespace "namespace" as not used anymore

1

this.engine.stoppedUsingMacroNamespace("namespace");

}

1

@Test

public void testEvaluateWithStopCommand() throws Exception

{

1

this.engine.initialize(new Properties());

1

assertEvaluate("hello world", "hello world#stop", "mytemplate");

}

}