From 1a479c4a988b469655ed72cf59d002bd11458fd7 Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Sat, 18 Aug 2012 12:20:12 +0200 Subject: [PATCH] added unit test for freemarker template engine --- .../FreemarkerTemplateEngineTest.java | 72 ++++++++ .../template/MustacheTemplateEngineTest.java | 63 ++----- .../scm/template/TemplateEngineTestBase.java | 155 ++++++++++++++++++ .../test/resources/sonia/scm/template/002.ftl | 1 + 4 files changed, 241 insertions(+), 50 deletions(-) create mode 100644 scm-webapp/src/test/java/sonia/scm/template/FreemarkerTemplateEngineTest.java create mode 100644 scm-webapp/src/test/java/sonia/scm/template/TemplateEngineTestBase.java create mode 100644 scm-webapp/src/test/resources/sonia/scm/template/002.ftl diff --git a/scm-webapp/src/test/java/sonia/scm/template/FreemarkerTemplateEngineTest.java b/scm-webapp/src/test/java/sonia/scm/template/FreemarkerTemplateEngineTest.java new file mode 100644 index 0000000000..b4655eeff6 --- /dev/null +++ b/scm-webapp/src/test/java/sonia/scm/template/FreemarkerTemplateEngineTest.java @@ -0,0 +1,72 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. 2. Redistributions in + * binary form must reproduce the above copyright notice, this list of + * conditions and the following disclaimer in the documentation and/or other + * materials provided with the distribution. 3. Neither the name of SCM-Manager; + * nor the names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.template; + +//~--- JDK imports ------------------------------------------------------------ + +import javax.servlet.ServletContext; + +/** + * + * @author Sebastian Sdorra + */ +public class FreemarkerTemplateEngineTest extends TemplateEngineTestBase +{ + + /** + * Method description + * + * + * @param context + * + * @return + */ + @Override + public TemplateEngine createEngine(ServletContext context) + { + return new FreemarkerTemplateEngine(context); + } + + //~--- get methods ---------------------------------------------------------- + + /** + * Method description + * + * + * @return + */ + @Override + public String getTemplateResource() + { + return "sonia/scm/template/002.ftl"; + } +} diff --git a/scm-webapp/src/test/java/sonia/scm/template/MustacheTemplateEngineTest.java b/scm-webapp/src/test/java/sonia/scm/template/MustacheTemplateEngineTest.java index f5678a4378..bb07e8b827 100644 --- a/scm-webapp/src/test/java/sonia/scm/template/MustacheTemplateEngineTest.java +++ b/scm-webapp/src/test/java/sonia/scm/template/MustacheTemplateEngineTest.java @@ -31,79 +31,42 @@ package sonia.scm.template; -//~--- non-JDK imports -------------------------------------------------------- - -import org.junit.Test; - -import static org.junit.Assert.*; - -import static org.mockito.Mockito.*; - //~--- JDK imports ------------------------------------------------------------ -import java.io.IOException; -import java.io.InputStream; - import javax.servlet.ServletContext; /** * * @author Sebastian Sdorra */ -public class MustacheTemplateEngineTest +public class MustacheTemplateEngineTest extends TemplateEngineTestBase { /** * Method description * * - * @throws IOException + * @param context + * + * @return */ - @Test - public void testGetTemlateNotFound() throws IOException + @Override + public TemplateEngine createEngine(ServletContext context) { - ServletContext context = mock(ServletContext.class); - MustacheTemplateEngine engine = new MustacheTemplateEngine(context); - Template template = engine.getTemplate("002"); - - assertNull(template); + return new MustacheTemplateEngine(context); } + //~--- get methods ---------------------------------------------------------- + /** * Method description * * - * @throws IOException + * @return */ - @Test - public void testGetTemplateFromClasspath() throws IOException + @Override + public String getTemplateResource() { - ServletContext context = mock(ServletContext.class); - - MustacheTemplateEngine engine = new MustacheTemplateEngine(context); - - assertNotNull(engine.getTemplate("sonia/scm/template/001.mustache")); - } - - /** - * Method description - * - * - * @throws IOException - */ - @Test - public void testGetTemplateFromServletContext() throws IOException - { - - InputStream source = MustacheTemplateEngineTest.class.getResourceAsStream( - "/sonia/scm/template/001.mustache"); - - ServletContext context = mock(ServletContext.class); - - when(context.getResourceAsStream("001")).thenReturn(source); - - MustacheTemplateEngine engine = new MustacheTemplateEngine(context); - - assertNotNull(engine.getTemplate("001")); + return "sonia/scm/template/001.mustache"; } } diff --git a/scm-webapp/src/test/java/sonia/scm/template/TemplateEngineTestBase.java b/scm-webapp/src/test/java/sonia/scm/template/TemplateEngineTestBase.java new file mode 100644 index 0000000000..12ddfa4653 --- /dev/null +++ b/scm-webapp/src/test/java/sonia/scm/template/TemplateEngineTestBase.java @@ -0,0 +1,155 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. 2. Redistributions in + * binary form must reproduce the above copyright notice, this list of + * conditions and the following disclaimer in the documentation and/or other + * materials provided with the distribution. 3. Neither the name of SCM-Manager; + * nor the names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.template; + +//~--- non-JDK imports -------------------------------------------------------- + +import com.google.common.io.Closeables; + +import org.junit.Test; + +import static org.junit.Assert.*; + +import static org.mockito.Mockito.*; + +//~--- JDK imports ------------------------------------------------------------ + +import java.io.IOException; +import java.io.InputStream; + +import java.net.URL; + +import javax.servlet.ServletContext; + +/** + * + * @author Sebastian Sdorra + */ +public abstract class TemplateEngineTestBase +{ + + /** + * Method description + * + * + * @param context + * + * @return + */ + public abstract TemplateEngine createEngine(ServletContext context); + + //~--- get methods ---------------------------------------------------------- + + /** + * Method description + * + * + * @return + */ + public abstract String getTemplateResource(); + + //~--- methods -------------------------------------------------------------- + + /** + * Method description + * + * + * @throws IOException + */ + @Test + public void testGetTemlateNotFound() throws IOException + { + ServletContext context = mock(ServletContext.class); + TemplateEngine engine = createEngine(context); + Template template = engine.getTemplate("002"); + + assertNull(template); + } + + /** + * Method description + * + * + * @throws IOException + */ + @Test + public void testGetTemplateFromClasspath() throws IOException + { + ServletContext context = mock(ServletContext.class); + + TemplateEngine engine = createEngine(context); + + assertNotNull(engine.getTemplate(getTemplateResource())); + } + + /** + * Method description + * + * + * @throws IOException + */ + @Test + public void testGetTemplateFromServletContext() throws IOException + { + + String resource = getTemplateResource(); + + if (!resource.startsWith("/")) + { + resource = "/".concat(resource); + } + + URL url = MustacheTemplateEngineTest.class.getResource(resource); + + ServletContext context = mock(ServletContext.class); + + InputStream input = null; + + try + { + input = url.openStream(); + + when(context.getResourceAsStream("001")).thenReturn(input); + when(context.getResource("001")).thenReturn(url); + when(context.getResourceAsStream("/001")).thenReturn(input); + when(context.getResource("/001")).thenReturn(url); + + TemplateEngine engine = createEngine(context); + + assertNotNull(engine.getTemplate("001")); + } + finally + { + Closeables.closeQuietly(input); + } + } +} diff --git a/scm-webapp/src/test/resources/sonia/scm/template/002.ftl b/scm-webapp/src/test/resources/sonia/scm/template/002.ftl new file mode 100644 index 0000000000..4551c970e8 --- /dev/null +++ b/scm-webapp/src/test/resources/sonia/scm/template/002.ftl @@ -0,0 +1 @@ +Hello ${name}! \ No newline at end of file