package org.apache.maven.doxia.siterenderer;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.FileOutputStream;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.io.StringWriter;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.jar.JarOutputStream;
import java.util.zip.ZipEntry;
import org.apache.commons.io.IOUtils;
import org.apache.maven.doxia.sink.render.RenderingContext;
import org.apache.maven.doxia.site.decoration.DecorationModel;
import org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader;
import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
import org.apache.maven.doxia.xsd.AbstractXmlValidator;
import org.codehaus.plexus.PlexusTestCase;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.StringUtils;
import org.xml.sax.EntityResolver;
/**
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @author <a href="mailto:evenisse@codehaus.org>Emmanuel Venisse</a>
* @version $Id: DefaultSiteRendererTest.java 1451951 2013-03-02 22:21:20Z olamy $
*/
public class DefaultSiteRendererTest
extends PlexusTestCase
{
/**
* All output produced by this test will go here.
*/
private static final String OUTPUT = "target/output";
/**
* The renderer used to produce output.
*/
private Renderer renderer;
/**
* The locale before executing tests.
*/
private Locale oldLocale;
private File skinJar = new File( getBasedir(), "target/test-classes/skin.jar" );
/**
* @throws java.lang.Exception if something goes wrong.
* @see org.codehaus.plexus.PlexusTestCase#setUp()
*/
@Override
protected void setUp()
throws Exception
{
super.setUp();
renderer = (Renderer) lookup( Renderer.ROLE );
// copy the default-site.vm
InputStream is =
this.getResourceAsStream( "/org/apache/maven/doxia/siterenderer/resources/default-site.vm" );
assertNotNull( is );
OutputStream os = new FileOutputStream( new File( getBasedir(), "target/test-classes/default-site.vm" ) );
try
{
IOUtil.copy( is, os );
}
finally
{
IOUtil.close( is );
IOUtil.close( os );
}
InputStream skinIS = this.getResourceAsStream( "velocity-toolmanager.vm" );
JarOutputStream jarOS = new JarOutputStream( new FileOutputStream( skinJar ) );
try
{
jarOS.putNextEntry( new ZipEntry( "META-INF/maven/site.vm" ) );
IOUtil.copy( skinIS, jarOS );
jarOS.closeEntry();
}
finally
{
IOUtil.close( skinIS );
IOUtil.close( jarOS );
}
oldLocale = Locale.getDefault();
Locale.setDefault( Locale.ENGLISH );
}
/**
* @throws java.lang.Exception if something goes wrong.
* @see org.codehaus.plexus.PlexusTestCase#tearDown()
*/
@Override
protected void tearDown()
throws Exception
{
release( renderer );
super.tearDown();
Locale.setDefault( oldLocale );
}
/**
* @throws Exception if something goes wrong.
*/
public void testRender()
throws Exception
{
// Safety
FileUtils.deleteDirectory( getTestFile( OUTPUT ) );
// ----------------------------------------------------------------------
// Render the site from src/test/resources/site to OUTPUT
// ----------------------------------------------------------------------
DecorationModel decoration = new DecorationXpp3Reader()
.read( new FileReader( getTestFile( "src/test/resources/site/site.xml" ) ) );
SiteRenderingContext ctxt = getSiteRenderingContext( decoration, "src/test/resources/site", false );
renderer.render( renderer.locateDocumentFiles( ctxt ).values(), ctxt, getTestFile( OUTPUT ) );
ctxt = getSiteRenderingContext( decoration, "src/test/resources/site-validate", true );
renderer.render( renderer.locateDocumentFiles( ctxt ).values(), ctxt, getTestFile( OUTPUT ) );
// ----------------------------------------------------------------------
// Verify specific pages
// ----------------------------------------------------------------------
verifyHeadPage();
verifyCdcPage();
verifyNestedItemsPage();
verifyMultipleBlock();
verifyMacro();
verifyEntitiesPage();
verifyJavascriptPage();
verifyFaqPage();
verifyAttributes();
verifyMisc();
verifyDocbookPageExists();
verifyApt();
// ----------------------------------------------------------------------
// Validate the rendering pages
// ----------------------------------------------------------------------
validatePages();
}
public void testVelocityToolManager()
throws Exception
{
StringWriter writer = new StringWriter();
SiteRenderingContext siteRenderingContext = new SiteRenderingContext();
siteRenderingContext.setDecoration(new DecorationModel());
siteRenderingContext.setTemplateName( "org/apache/maven/doxia/siterenderer/velocity-toolmanager.vm" );
RenderingContext context = new RenderingContext( new File( "" ), "document.html" );
SiteRendererSink sink = new SiteRendererSink( context );
renderer.generateDocument( writer, sink, siteRenderingContext );
String renderResult = writer.toString();
String expectedResult = IOUtils.toString( getClass().getResourceAsStream( "velocity-toolmanager.expected.txt" ) );
assertEquals( expectedResult, renderResult );
}
public void testVelocityToolManagerForTemplate() throws Exception
{
StringWriter writer = new StringWriter();
File templateFile = new File( getBasedir(), "target/test-classes/org/apache/maven/doxia/siterenderer/velocity-toolmanager.vm" );
Map<String, ?> attributes = Collections.emptyMap();
SiteRenderingContext siteRenderingContext = renderer.createContextForTemplate( templateFile, null, attributes, new DecorationModel(), "defaultWindowTitle", Locale.ENGLISH );
RenderingContext context = new RenderingContext( new File( "" ), "document.html" );
SiteRendererSink sink = new SiteRendererSink( context );
renderer.generateDocument( writer, sink, siteRenderingContext );
String renderResult = writer.toString();
String expectedResult = IOUtils.toString( getClass().getResourceAsStream( "velocity-toolmanager.expected.txt" ) );
assertEquals( expectedResult, renderResult );
}
public void testVelocityToolManagerForSkin() throws Exception
{
StringWriter writer = new StringWriter();
File skinFile = skinJar;
Map<String, ?> attributes = Collections.emptyMap();
SiteRenderingContext siteRenderingContext = renderer.createContextForSkin( skinFile, attributes, new DecorationModel(), "defaultWindowTitle", Locale.ENGLISH );
RenderingContext context = new RenderingContext( new File( "" ), "document.html" );
SiteRendererSink sink = new SiteRendererSink( context );
renderer.generateDocument( writer, sink, siteRenderingContext );
String renderResult = writer.toString();
String expectedResult = IOUtils.toString( getClass().getResourceAsStream( "velocity-toolmanager.expected.txt" ) );
assertEquals( expectedResult, renderResult );
}
private SiteRenderingContext getSiteRenderingContext( DecorationModel decoration, String siteDir, boolean validate )
{
SiteRenderingContext ctxt = new SiteRenderingContext();
ctxt.setTemplateName( "default-site.vm" );
ctxt.setTemplateClassLoader( getClassLoader() );
ctxt.setUsingDefaultTemplate( true );
final Map<String, String> templateProp = new HashMap<String, String>();
templateProp.put( "outputEncoding", "UTF-8" );
ctxt.setTemplateProperties( templateProp );
ctxt.setDecoration( decoration );
ctxt.addSiteDirectory( getTestFile( siteDir ) );
ctxt.setValidate( validate );
return ctxt;
}
/**
* @throws Exception if something goes wrong.
*/
public void verifyHeadPage()
throws Exception
{
new HeadVerifier().verify( "target/output/head.html" );
}
/**
* @throws Exception if something goes wrong.
*/
public void verifyCdcPage()
throws Exception
{
File nestedItems = getTestFile( "target/output/cdc.html" );
assertNotNull( nestedItems );
assertTrue( nestedItems.exists() );
}
/**
* @throws Exception if something goes wrong.
*/
public void verifyNestedItemsPage()
throws Exception
{
NestedItemsVerifier verifier = new NestedItemsVerifier();
verifier.verify( "target/output/nestedItems.html" );
}
/**
* @throws Exception if something goes wrong.
*/
public void verifyMultipleBlock()
throws Exception
{
MultipleBlockVerifier verifier = new MultipleBlockVerifier();
verifier.verify( "target/output/multipleblock.html" );
}
/**
* @throws Exception if something goes wrong.
*/
public void verifyMacro()
throws Exception
{
File macro = getTestFile( "target/output/macro.html" );
assertNotNull( macro );
assertTrue( macro.exists() );
Reader reader = null;
try
{
reader = ReaderFactory.newXmlReader( macro );
String content = IOUtil.toString( reader );
assertEquals( content.indexOf( "</macro>" ), -1 );
}
finally
{
IOUtil.close( reader );
}
}
/**
* @throws Exception if something goes wrong.
*/
public void verifyEntitiesPage()
throws Exception
{
EntitiesVerifier verifier = new EntitiesVerifier();
verifier.verify( "target/output/entityTest.html" );
}
/**
* @throws Exception if something goes wrong.
*/
public void verifyJavascriptPage()
throws Exception
{
JavascriptVerifier verifier = new JavascriptVerifier();
verifier.verify( "target/output/javascript.html" );
}
/**
* @throws Exception if something goes wrong.
*/
public void verifyFaqPage()
throws Exception
{
FaqVerifier verifier = new FaqVerifier();
verifier.verify( "target/output/faq.html" );
}
/**
* @throws Exception if something goes wrong.
*/
public void verifyAttributes()
throws Exception
{
AttributesVerifier verifier = new AttributesVerifier();
verifier.verify( "target/output/attributes.html" );
}
/**
* @throws Exception if something goes wrong.
*/
public void verifyMisc()
throws Exception
{
MiscVerifier verifier = new MiscVerifier();
verifier.verify( "target/output/misc.html" );
}
/**
* @throws Exception if something goes wrong.
*/
public void verifyDocbookPageExists()
throws Exception
{
File nestedItems = getTestFile( "target/output/docbook.html" );
assertNotNull( nestedItems );
assertTrue( nestedItems.exists() );
}
/**
* @throws Exception if something goes wrong.
*/
public void verifyApt()
throws Exception
{
AptVerifier verifier = new AptVerifier();
verifier.verify( "target/output/apt.html" );
}
/**
* Validate the generated pages.
*
* @throws Exception if something goes wrong.
* @since 1.1.1
*/
public void validatePages() throws Exception
{
new XhtmlValidatorTest().validateGeneratedPages();
}
protected static class XhtmlValidatorTest
extends AbstractXmlValidator
{
/**
* Validate the generated documents.
*
* @throws Exception
*/
public void validateGeneratedPages()
throws Exception
{
setUp();
testValidateFiles();
tearDown();
}
private static String[] getIncludes()
{
return new String[] { "**/*.html" };
}
/** {@inheritDoc} */
protected String addNamespaces( String content )
{
return content;
}
/** {@inheritDoc} */
protected EntityResolver getEntityResolver()
{
return new XhtmlEntityResolver();
}
/** {@inheritDoc} */
protected Map<String,String> getTestDocuments()
throws IOException
{
Map<String,String> testDocs = new HashMap<String,String>();
File dir = new File( getBasedir(), "target/output" );
@SuppressWarnings ( "unchecked" )
List<String> l = FileUtils.getFileNames( dir, getIncludes()[0], FileUtils.getDefaultExcludesAsString(), true );
for ( Iterator<String> it = l.iterator(); it.hasNext(); )
{
String file = it.next();
file = StringUtils.replace( file, "\\", "/" );
Reader reader = ReaderFactory.newXmlReader( new File( file ) );
try
{
testDocs.put( file, IOUtil.toString( reader ) );
}
finally
{
IOUtil.close( reader );
}
}
return testDocs;
}
/** {@inheritDoc} */
@Override
protected boolean isFailErrorMessage( String message )
{
return true;
}
}
}