/**
* This file Copyright (c) 2010-2012 Magnolia International
* Ltd. (http://www.magnolia-cms.com). All rights reserved.
*
*
* This file is dual-licensed under both the Magnolia
* Network Agreement and the GNU General Public License.
* You may elect to use one or the other of these licenses.
*
* This file is distributed in the hope that it will be
* useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
* implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
* Redistribution, except as permitted by whichever of the GPL
* or MNA you select, is prohibited.
*
* 1. For the GPL license (GPL), you can redistribute and/or
* modify this file under the terms of the GNU General
* Public License, Version 3, as published by the Free Software
* Foundation. You should have received a copy of the GNU
* General Public License, Version 3 along with this program;
* if not, write to the Free Software Foundation, Inc., 51
* Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* 2. For the Magnolia Network Agreement (MNA), this file
* and the accompanying materials are made available under the
* terms of the MNA which accompanies this distribution, and
* is available at http://www.magnolia-cms.com/mna.html
*
* Any modifications to this file must keep this entire header
* intact.
*
*/
package info.magnolia.templating.freemarker;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import freemarker.cache.StringTemplateLoader;
import info.magnolia.cms.beans.config.ServerConfiguration;
import info.magnolia.cms.core.AggregationState;
import info.magnolia.cms.core.SystemProperty;
import info.magnolia.cms.gui.i18n.DefaultI18nAuthoringSupport;
import info.magnolia.cms.gui.i18n.I18nAuthoringSupport;
import info.magnolia.cms.gui.misc.Sources;
import info.magnolia.cms.i18n.DefaultI18nContentSupport;
import info.magnolia.cms.i18n.DefaultMessagesManager;
import info.magnolia.cms.i18n.I18nContentSupport;
import info.magnolia.cms.i18n.MessagesManager;
import info.magnolia.cms.security.MgnlUser;
import info.magnolia.context.ContextFactory;
import info.magnolia.context.MgnlContext;
import info.magnolia.context.SystemContext;
import info.magnolia.context.WebContext;
import info.magnolia.freemarker.FreemarkerConfig;
import info.magnolia.freemarker.FreemarkerHelper;
import info.magnolia.jcr.node2bean.Node2BeanProcessor;
import info.magnolia.jcr.node2bean.Node2BeanTransformer;
import info.magnolia.jcr.node2bean.TypeMapping;
import info.magnolia.jcr.node2bean.impl.Node2BeanProcessorImpl;
import info.magnolia.jcr.node2bean.impl.Node2BeanTransformerImpl;
import info.magnolia.jcr.node2bean.impl.TypeMappingImpl;
import info.magnolia.objectfactory.configuration.ComponentProviderConfiguration;
import info.magnolia.objectfactory.guice.GuiceComponentProviderBuilder;
import info.magnolia.rendering.context.AggregationStateBasedRenderingContext;
import info.magnolia.rendering.context.RenderingContext;
import info.magnolia.rendering.engine.OutputProvider;
import info.magnolia.rendering.engine.RenderingEngine;
import info.magnolia.rendering.template.assignment.MetaDataBasedTemplateDefinitionAssignment;
import info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment;
import info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition;
import info.magnolia.rendering.template.registry.TemplateDefinitionProvider;
import info.magnolia.rendering.template.registry.TemplateDefinitionRegistry;
import info.magnolia.test.ComponentsTestUtil;
import info.magnolia.test.mock.MockContext;
import info.magnolia.test.mock.MockHierarchyManager;
import info.magnolia.test.mock.MockUtil;
import info.magnolia.test.mock.jcr.MockSession;
import java.io.IOException;
import java.io.OutputStream;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.lang.StringUtils;
import org.junit.After;
import org.junit.Before;
/**
* TODO review setUp() and renderForTest() methods: here we provide two ways to get the template definition, one is via TemplateDefintionRegistry and the other,
* which is needed i.e. by EditDirective, by pushing into into the current RenderingContext. Is that correct? Should two separate AbstractDirectiveTestCase classes be
* provided instead of setting up everything here?
* In contrast to related tests, this one can't use ComponentsTestUtils & MockComponentProvider (doesn't support
* determining appropriate constructor to be called) but a proper Pico environment.
*
* @version $Id$
*/
public abstract class AbstractDirectiveTestCase {
private WebContext ctx;
private MockHierarchyManager session;
private HttpServletRequest req;
private HttpServletResponse res;
private StringTemplateLoader tplLoader;
private FreemarkerHelper fmHelper;
private RenderingContext renderingContext;
private AggregationState aggState;
@Before
public void setUp() throws Exception {
// shunt loggers
freemarker.log.Logger.selectLoggerLibrary(freemarker.log.Logger.LIBRARY_NONE);
org.apache.log4j.Logger.getRootLogger().setLevel(org.apache.log4j.Level.OFF);
tplLoader = new StringTemplateLoader();
FreemarkerConfig fmConfig = new FreemarkerConfig();
fmConfig.getTemplateLoaders().clear();
fmConfig.addTemplateLoader(tplLoader);
fmHelper = new FreemarkerHelper(fmConfig);
session = MockUtil.createAndSetHierarchyManager("testWorkspace", StringUtils.join(new String[] {
"/foo/bar.@type=mgnl:page",
"/foo/bar.mgnl\\:template=testPageTemplate",
"/foo/bar/paragraphs.@type=mgnl:areae",
"/foo/bar/paragraphs/0.@type=mgnl:component",
"/foo/bar/paragraphs/0.@uuid=100",
"/foo/bar/paragraphs/1.@type=mgnl:component",
"/foo/bar/paragraphs/1.@uuid=101",
"/foo/bar/paragraphs/1.text=hello 1",
"/foo/bar/paragraphs/1.mgnl\\:template=testParagraph1" }, "\n"));
aggState = new AggregationState();
// let's make sure we render stuff on an author instance
aggState.setPreviewMode(false);
final ServerConfiguration serverCfg = new ServerConfiguration();
serverCfg.setAdmin(true);
ConfiguredTemplateDefinition testParagraph0 = new ConfiguredTemplateDefinition();
testParagraph0.setName("testParagraph0");
testParagraph0.setTitle("Test Paragraph 0");
ConfiguredTemplateDefinition testParagraph1 = new ConfiguredTemplateDefinition();
testParagraph1.setName("testParagraph1");
testParagraph1.setTitle("Test Paragraph 1");
testParagraph1.setDialog("testDialog");
ConfiguredTemplateDefinition testParagraph2 = new ConfiguredTemplateDefinition();
testParagraph2.setName("testParagraph2");
testParagraph2.setTitle("Test Paragraph 2");
final TemplateDefinitionProvider p0provider = mock(TemplateDefinitionProvider.class);
final TemplateDefinitionProvider p1provider = mock(TemplateDefinitionProvider.class);
final TemplateDefinitionProvider p2provider = mock(TemplateDefinitionProvider.class);
when(p0provider.getTemplateDefinition()).thenReturn(testParagraph0);
when(p0provider.getId()).thenReturn(testParagraph0.getName());
when(p1provider.getTemplateDefinition()).thenReturn(testParagraph1);
when(p1provider.getId()).thenReturn(testParagraph1.getName());
when(p2provider.getTemplateDefinition()).thenReturn(testParagraph2);
when(p2provider.getId()).thenReturn(testParagraph2.getName());
// TODO dlipp: next lines should be switched back to ComponentTestUtils as soon as SCRUM-201 is solved.
ComponentProviderConfiguration configuration = new ComponentProviderConfiguration();
configuration.registerInstance(ServerConfiguration.class, serverCfg);
// register some default components used internally
configuration.registerImplementation(MessagesManager.class, DefaultMessagesManager.class);
configuration.registerImplementation(I18nContentSupport.class, DefaultI18nContentSupport.class);
configuration.registerImplementation(I18nAuthoringSupport.class, DefaultI18nAuthoringSupport.class);
configuration.registerImplementation(TemplateDefinitionAssignment.class, MetaDataBasedTemplateDefinitionAssignment.class);
configuration.registerImplementation(ContextFactory.class);
// configure node2bean because its processor is injected into DefaultMessagesManager constructor
configuration.registerImplementation(Node2BeanProcessor.class, Node2BeanProcessorImpl.class);
configuration.registerImplementation(TypeMapping.class, TypeMappingImpl.class);
configuration.registerImplementation(Node2BeanTransformer.class, Node2BeanTransformerImpl.class);
MockContext systemContext = new MockContext();
systemContext.addSession("testWorkspace", session.getJcrSession());
configuration.registerInstance(SystemContext.class, systemContext);
aggState.setCurrentContent(session.getContent("/foo/bar/paragraphs/1"));
renderingContext = new AggregationStateBasedRenderingContext(aggState, null);
final RenderingEngine renderingEngine = mock(RenderingEngine.class);
when(renderingEngine.getRenderingContext()).thenReturn(renderingContext);
configuration.registerInstance(RenderingEngine.class, renderingEngine);
final TemplateDefinitionRegistry tdr = new TemplateDefinitionRegistry();
tdr.register(p0provider);
tdr.register(p1provider);
tdr.register(p2provider);
configuration.registerInstance(TemplateDefinitionRegistry.class, tdr);
req = mock(HttpServletRequest.class);
req.setAttribute(Sources.REQUEST_LINKS_DRAWN, Boolean.TRUE);
res = mock(HttpServletResponse.class);
when(res.getWriter()).thenReturn(null);
ctx = mock(WebContext.class);
when(ctx.getAggregationState()).thenReturn(aggState);
when(ctx.getLocale()).thenReturn(Locale.US);
when(ctx.getResponse()).thenReturn(res);
when(ctx.getRequest()).thenReturn(req);
MgnlUser mockUser = mock(MgnlUser.class);
when(mockUser.getLanguage()).thenReturn("en");
when(ctx.getUser()).thenReturn(mockUser);
when(ctx.getContextPath()).thenReturn("test");
when(ctx.getHierarchyManager("testWorkspace")).thenReturn(session);
when(ctx.getJCRSession("testWorkspace")).thenReturn(session.getJcrSession());
setupExpectations(ctx, req);
MgnlContext.setInstance(ctx);
// finally create the GuiceComponentProvider!
new GuiceComponentProviderBuilder().withConfiguration(configuration).exposeGlobally().build();
}
/**
* Hook method - overwrite if you want to set up special expectations.
*/
protected void setupExpectations(WebContext ctx, HttpServletRequest req) {
// no specific expectations here
}
@After
public void tearDown() throws Exception {
MgnlContext.setInstance(null);
SystemProperty.clear();
ComponentsTestUtil.clear();
}
public String renderForTest(final String templateSource, ConfiguredTemplateDefinition renderableDefinition) throws Exception {
if(renderableDefinition != null ) {
renderingContext.push(aggState.getCurrentContent().getJCRNode(), renderableDefinition, new OutputProvider() {
@Override
public OutputStream getOutputStream() throws IOException {
return null;
}
@Override
public Appendable getAppendable() throws IOException {
return new StringWriter();
}
});
}
tplLoader.putTemplate("test.ftl", templateSource);
final Map<String, Object> map = contextWithDirectives();
map.put("content", session.getContent("/foo/bar/"));
final StringWriter out = new StringWriter();
fmHelper.render("test.ftl", map, out);
return out.toString();
}
protected Map<String, Object> contextWithDirectives() {
// this is the only thing we expect rendering engines to do: added the directives to the rendering context so
// they can be refered to via "@cms"
return createSingleValueMap("cms", new Directives());
}
protected Map<String, Object> createSingleValueMap(String key, Object value) {
final HashMap<String, Object> map = new HashMap<String, Object>();
map.put(key, value);
return map;
}
protected MockSession getSession() {
return (MockSession) session.getJcrSession();
}
}