RendererManagerMarkdownTest.java

/**
 * Copyright 2015-2017 Linagora, Université Joseph Fourier, Floralis
 *
 * The present code is developed in the scope of the joint LINAGORA -
 * Université Joseph Fourier - Floralis research program and is designated
 * as a "Result" pursuant to the terms and conditions of the LINAGORA
 * - Université Joseph Fourier - Floralis research program. Each copyright
 * holder of Results enumerated here above fully & independently holds complete
 * ownership of the complete Intellectual Property rights applicable to the whole
 * of said Results, and may freely exploit it in any manner which does not infringe
 * the moral rights of the other copyright holders.
 *
 * Licensed 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.
 */

package net.roboconf.doc.generator;

import java.io.File;
import java.util.HashMap;
import java.util.Map;

import org.junit.Assert;
import org.junit.Test;

import net.roboconf.core.utils.Utils;
import net.roboconf.doc.generator.RenderingManager.Renderer;

/**
 * @author Vincent Zurczak - Linagora
 */
public class RendererManagerMarkdownTest extends AbstractTestForRendererManager {

	@Test
	public void testMarkdown_nullOptions() throws Exception {

		Assert.assertEquals( 0, this.outputDir.listFiles().length );
		this.rm.render( this.outputDir, this.alr.getApplicationTemplate(), this.applicationDirectory, Renderer.MARKDOWN, null, null );

		verifyMarkdown( true );
	}


	@Test
	public void testMarkdown_withDocDirectoryLikeInMaven() throws Exception {

		File newDocDirectory = new File( this.applicationDirectory, "../" + DocConstants.DOC_DIR );
		File oldDocDirectory = new File( this.applicationDirectory, DocConstants.DOC_DIR );

		Utils.deleteFilesRecursively( newDocDirectory );
		Assert.assertFalse( newDocDirectory.exists());

		Utils.copyDirectory( oldDocDirectory, newDocDirectory );
		Assert.assertTrue( newDocDirectory.exists());

		Assert.assertEquals( 0, this.outputDir.listFiles().length );
		this.rm.render( this.outputDir, this.alr.getApplicationTemplate(), this.applicationDirectory, Renderer.MARKDOWN, null, null );

		verifyMarkdown( true );
	}


	@Test
	public void testMarkdown_withFrenchLocale() throws Exception {

		Assert.assertEquals( 0, this.outputDir.listFiles().length );
		Map<String,String> options = new HashMap<> ();
		options.put( DocConstants.OPTION_LOCALE, "fr_FR" );

		this.rm.render( this.outputDir, this.alr.getApplicationTemplate(), this.applicationDirectory, Renderer.MARKDOWN, options, null );

		verifyMarkdown( false );
	}


	@Test
	public void testMarkdown_emptyOptions() throws Exception {

		Assert.assertEquals( 0, this.outputDir.listFiles().length );
		Map<String,String> options = new HashMap<> ();
		this.rm.render( this.outputDir, this.alr.getApplicationTemplate(), this.applicationDirectory, Renderer.MARKDOWN, options, null );

		verifyMarkdown( true );
	}


	@Test
	public void testMarkdown_withoutInstances_customColorInOptions() throws Exception {

		Assert.assertEquals( 0, this.outputDir.listFiles().length );
		this.alr.getApplicationTemplate().getRootInstances().clear();

		Map<String,String> options = new HashMap<> ();
		options.put( DocConstants.OPTION_IMG_HIGHLIGHT_BG_COLOR, "#dddddd" );
		options.put( DocConstants.OPTION_IMG_BACKGROUND_COLOR, "#4582ad" );
		options.put( DocConstants.OPTION_IMG_FOREGROUND_COLOR, "#000000" );
		options.put( DocConstants.OPTION_HTML_EXPLODED, "boom" );

		this.rm.render( this.outputDir, this.alr.getApplicationTemplate(), this.applicationDirectory, Renderer.MARKDOWN, options, null );

		verifyMarkdown( true );
	}


	/**
	 * Verifies assertions about markdown files.
	 * @param defaultLocale true to search for English content, false for French
	 * @return the main file's content
	 */
	private void verifyMarkdown( boolean defaultLocale ) throws Exception {

		File f = new File( this.outputDir, "png" );
		Assert.assertTrue( f.isDirectory());

		f = new File( this.outputDir, "index.md" );
		Assert.assertTrue( f.exists());

		String content = Utils.readFileContent( f );
		verifyContent( content );

		if( defaultLocale )
			Assert.assertTrue( content.contains( "extra information about Apache." ));
		else
			Assert.assertTrue( content.contains( "une belle information à ajouter dans" ));
	}
}