maven-jxr-plugin/src/test/java/org/apache/maven/plugin/jxr/JxrReportTest.java

package org.apache.maven.plugin.jxr;

/*
 * 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 org.apache.commons.io.FileUtils;
import org.apache.maven.plugin.testing.AbstractMojoTestCase;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Locale;

/**
 * @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
 * @author <a href="mailto:dennisl@apache.org">Dennis Lundberg</a>
 */
public class JxrReportTest
    extends AbstractMojoTestCase
{
    /**
     * Test the plugin with original configuration
     *
     * @throws Exception
     */
    public void testDefaultConfiguration()
        throws Exception
    {
        File resourcesDir = new File( getBasedir(), "src/test/resources/unit/default-configuration" );

        File outputDir = new File( getBasedir(), "target/test/unit/default-configuration/target/site" );
        File xrefDir = new File( outputDir, "xref" );

        FileUtils.copyDirectory( new File( resourcesDir, "javadoc-files" ), outputDir );

        File testPom = new File( resourcesDir, "default-configuration-plugin-config.xml" );
        JxrReport mojo = (JxrReport) lookupMojo( "jxr", testPom );
        mojo.execute();

        //check if xref files were generated
        assertTrue( new File( xrefDir, "allclasses-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "index.html" ).exists() );
        assertTrue( new File( xrefDir, "overview-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "overview-summary.html" ).exists() );
        assertTrue( new File( xrefDir, "stylesheet.css" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/App.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/AppSample.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/package-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/package-summary.html" ).exists() );

        //check if there's a link to the javadoc files
        String str = readFile( xrefDir, "def/configuration/AppSample.html" );
        assertTrue( str.toLowerCase().contains( "/apidocs/def/configuration/appsample.html\"" ) );

        str = readFile( xrefDir, "def/configuration/App.html" );
        assertTrue( str.toLowerCase().contains( "/apidocs/def/configuration/app.html\"".toLowerCase() ) );

        // check if encoding is UTF-8, the default value
        assertTrue( str.contains( "text/html; charset=UTF-8" ) );
    }

    /**
     * Test the plugin with jdk-4 configuration
     *
     * @throws Exception
     */
    public void testJdk4Configuration()
        throws Exception
    {
        File resourcesDir = new File( getBasedir(), "src/test/resources/unit/default-configuration" );

        File outputDir = new File( getBasedir(), "target/test/unit/default-configuration/target/site/4" );
        File xrefDir = new File( outputDir, "xref" );

        FileUtils.copyDirectory( new File( resourcesDir, "javadoc-files" ), outputDir );

        File testPom = new File( resourcesDir, "default-configuration-plugin-config-4.xml" );
        JxrReport mojo = (JxrReport) lookupMojo( "jxr", testPom );
        mojo.execute();

        //check if xref files were generated
        assertTrue( new File( xrefDir, "allclasses-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "index.html" ).exists() );
        assertTrue( new File( xrefDir, "overview-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "overview-summary.html" ).exists() );
        assertTrue( new File( xrefDir, "stylesheet.css" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/App.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/AppSample.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/package-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/package-summary.html" ).exists() );

        //check if there's a link to the javadoc files
        String str = readFile( xrefDir, "def/configuration/AppSample.html" );
        assertTrue( str.toLowerCase( Locale.US ).contains( "/apidocs/def/configuration/appsample.html\"" ) );

        str = readFile( xrefDir, "def/configuration/App.html" );
        assertTrue( str.toLowerCase( Locale.US ).contains( "/apidocs/def/configuration/app.html\"" ) );

        // check if encoding is UTF-8, the default value
        assertTrue( str.contains( "text/html; charset=UTF-8" ) );
    }

    /**
     * Test the plugin with jdk-6 configuration
     *
     * @throws Exception
     */
    public void testJdk6Configuration()
        throws Exception
    {
        File resourcesDir = new File( getBasedir(), "src/test/resources/unit/default-configuration" );

        File outputDir = new File( getBasedir(), "target/test/unit/default-configuration/target/site/6" );
        File xrefDir = new File( outputDir, "xref" );

        FileUtils.copyDirectory( new File( resourcesDir, "javadoc-files" ), outputDir );

        File testPom = new File( resourcesDir, "default-configuration-plugin-config-6.xml" );
        JxrReport mojo = (JxrReport) lookupMojo( "jxr", testPom );
        mojo.execute();

        //check if xref files were generated
        assertTrue( new File( xrefDir, "allclasses-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "index.html" ).exists() );
        assertTrue( new File( xrefDir, "overview-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "overview-summary.html" ).exists() );
        assertTrue( new File( xrefDir, "stylesheet.css" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/App.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/AppSample.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/package-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/package-summary.html" ).exists() );

        //check if there's a link to the javadoc files
        String str = readFile( xrefDir, "def/configuration/AppSample.html" );
        assertTrue( str.toLowerCase( Locale.US ).contains( "/apidocs/def/configuration/appsample.html\"" ) );

        str = readFile( xrefDir, "def/configuration/App.html" );
        assertTrue( str.toLowerCase( Locale.US ).contains( "/apidocs/def/configuration/app.html\"" ) );

        // check if encoding is UTF-8, the default value
        assertTrue( str.contains( "text/html; charset=UTF-8" ) );
    }

    /**
     * Test the plugin with jdk-7 configuration
     *
     * @throws Exception
     */
    public void testJdk7Configuration()
        throws Exception
    {
        File resourcesDir = new File( getBasedir(), "src/test/resources/unit/default-configuration" );

        File outputDir = new File( getBasedir(), "target/test/unit/default-configuration/target/site/7" );
        File xrefDir = new File( outputDir, "xref" );

        FileUtils.copyDirectory( new File( resourcesDir, "javadoc-files" ), outputDir );

        File testPom = new File( resourcesDir, "default-configuration-plugin-config-7.xml" );
        JxrReport mojo = (JxrReport) lookupMojo( "jxr", testPom );
        mojo.execute();

        //check if xref files were generated
        assertTrue( new File( xrefDir, "allclasses-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "index.html" ).exists() );
        assertTrue( new File( xrefDir, "overview-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "overview-summary.html" ).exists() );
        assertTrue( new File( xrefDir, "stylesheet.css" ).exists() );
        assertTrue( new File( xrefDir, "resources/background.gif" ).exists() );
        assertTrue( new File( xrefDir, "resources/tab.gif" ).exists() );
        assertTrue( new File( xrefDir, "resources/titlebar.gif" ).exists() );
        assertTrue( new File( xrefDir, "resources/titlebar_end.gif" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/App.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/AppSample.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/package-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/package-summary.html" ).exists() );

        //check if there's a link to the javadoc files
        String str = readFile( xrefDir, "def/configuration/AppSample.html" );
        assertTrue( str.toLowerCase( Locale.US ).contains( "/apidocs/def/configuration/appsample.html\"" ) );

        str = readFile( xrefDir, "def/configuration/App.html" );
        assertTrue( str.toLowerCase( Locale.US ).contains( "/apidocs/def/configuration/app.html\"" ) );

        // check if encoding is UTF-8, the default value
        assertTrue( str.contains( "text/html; charset=UTF-8" ) );
    }

    /**
     * Test the plugin with jdk-8 configuration
     *
     * @throws Exception
     */
    public void testJdk8Configuration()
        throws Exception
    {
        File resourcesDir = new File( getBasedir(), "src/test/resources/unit/default-configuration" );

        File outputDir = new File( getBasedir(), "target/test/unit/default-configuration/target/site/8" );
        File xrefDir = new File( outputDir, "xref" );

        FileUtils.copyDirectory( new File( resourcesDir, "javadoc-files" ), outputDir );

        File testPom = new File( resourcesDir, "default-configuration-plugin-config-8.xml" );
        JxrReport mojo = (JxrReport) lookupMojo( "jxr", testPom );
        mojo.execute();

        //check if xref files were generated
        assertTrue( new File( xrefDir, "allclasses-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "index.html" ).exists() );
        assertTrue( new File( xrefDir, "overview-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "overview-summary.html" ).exists() );
        assertTrue( new File( xrefDir, "stylesheet.css" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/App.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/AppSample.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/package-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "def/configuration/package-summary.html" ).exists() );

        //check if there's a link to the javadoc files
        String str = readFile( xrefDir, "def/configuration/AppSample.html" );
        assertTrue( str.toLowerCase().contains( "/apidocs/def/configuration/appsample.html\"" ) );

        str = readFile( xrefDir, "def/configuration/App.html" );
        assertTrue( str.toLowerCase().contains( "/apidocs/def/configuration/app.html\"".toLowerCase() ) );

        // check if encoding is UTF-8, the default value
        assertTrue( str.contains( "text/html; charset=UTF-8" ) );
    }

    /**
     * Test when javadocLink is disabled in the configuration
     *
     * @throws Exception
     */
    public void testNoJavadocLink()
        throws Exception
    {
        File testPom = new File( getBasedir(),
                "src/test/resources/unit/nojavadoclink-configuration/nojavadoclink-configuration-plugin-config.xml" );
        JxrReport mojo = (JxrReport) lookupMojo( "jxr", testPom );
        mojo.execute();

        File xrefDir = new File( getBasedir(), "target/test/unit/nojavadoclink-configuration/target/site/xref" );

        //check if xref files were generated
        assertTrue( new File( xrefDir, "allclasses-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "index.html" ).exists() );
        assertTrue( new File( xrefDir, "overview-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "overview-summary.html" ).exists() );
        assertTrue( new File( xrefDir, "stylesheet.css" ).exists() );
        assertTrue( new File( xrefDir, "nojavadoclink/configuration/App.html" ).exists() );
        assertTrue( new File( xrefDir, "nojavadoclink/configuration/AppSample.html" ).exists() );
        assertTrue( new File( xrefDir, "nojavadoclink/configuration/package-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "nojavadoclink/configuration/package-summary.html" ).exists() );
        assertTrue( new File( xrefDir, "nojavadoclink/configuration/sample/package-summary.html" ).exists() );
        assertTrue( new File( xrefDir, "nojavadoclink/configuration/sample/package-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "nojavadoclink/configuration/sample/Sample.html" ).exists() );

        //check if there's a link to the javadoc files
        String str = readFile( xrefDir, "nojavadoclink/configuration/AppSample.html" );
        assertEquals( str.toLowerCase( Locale.US ).indexOf( "/apidocs/nojavadoclink/configuration/appsample.html\"" ),
                -1 );

        str = readFile( xrefDir, "nojavadoclink/configuration/App.html" );
        assertEquals( str.toLowerCase( Locale.US ).indexOf( "/apidocs/nojavadoclink/configuration/app.html\"" ), -1 );

        str = readFile( xrefDir, "nojavadoclink/configuration/sample/Sample.html" );
        assertEquals( str.toLowerCase().indexOf( "/apidocs/nojavadoclink/configuration/sample/sample.html\"" ), -1 );

        // check if encoding is ISO-8859-1, like specified in the plugin configuration
        assertTrue( str.contains( "text/html; charset=ISO-8859-1" ) );
    }

    /**
     * Method for testing plugin when aggregate parameter is set to true
     *
     * @throws Exception
     */
    public void testAggregate()
        throws Exception
    {
        File testPom = new File( getBasedir(),
                "src/test/resources/unit/aggregate-test/aggregate-test-plugin-config.xml" );
        JxrReport mojo = (JxrReport) lookupMojo( "jxr", testPom );
        mojo.execute();

        File xrefDir = new File( getBasedir(), "target/test/unit/aggregate-test/target/site/xref" );

        //check if xref files were generated for submodule1
        assertTrue( new File( xrefDir, "aggregate/test/submodule1/package-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "aggregate/test/submodule1/package-summary.html" ).exists() );
        assertTrue( new File( xrefDir, "aggregate/test/submodule1/Submodule1App.html" ).exists() );
        assertTrue( new File( xrefDir, "aggregate/test/submodule1/Submodule1AppSample.html" ).exists() );

        //check if xref files were generated for submodule2
        assertTrue( new File( xrefDir, "aggregate/test/submodule2/package-frame.html" ).exists() );
        assertTrue( new File( xrefDir, "aggregate/test/submodule2/package-summary.html" ).exists() );
        assertTrue( new File( xrefDir, "aggregate/test/submodule2/Submodule2App.html" ).exists() );
        assertTrue( new File( xrefDir, "aggregate/test/submodule2/Submodule2AppSample.html" ).exists() );

    }

    /**
     * Method for testing plugin when the specified javadocDir does not exist
     *
     * @throws Exception
     */
    public void testNoJavadocDir()
        throws Exception
    {
        File testPom = new File( getBasedir(),
                "src/test/resources/unit/nojavadocdir-test/nojavadocdir-test-plugin-config.xml" );
        JxrReport mojo = (JxrReport) lookupMojo( "jxr", testPom );
        mojo.execute();

        File xrefDir = new File( getBasedir(), "target/test/unit/nojavadocdir-test/target/site/xref" );

        //check if there's a link to the javadoc files
        String str = readFile( xrefDir, "nojavadocdir/test/AppSample.html" );
        assertTrue( str.toLowerCase( Locale.US ).contains( "/apidocs/nojavadocdir/test/appsample.html" ) );

        str = readFile( xrefDir, "nojavadocdir/test/App.html" );
        assertTrue( str.toLowerCase( Locale.US ).contains( "/apidocs/nojavadocdir/test/app.html" ) );

    }

    /**
     * Test the plugin with an exclude configuration.
     *
     * @throws Exception
     */
    public void testExclude()
        throws Exception
    {
        File testPom = new File( getBasedir(),
                "src/test/resources/unit/exclude-configuration/exclude-configuration-plugin-config.xml" );
        JxrReport mojo = (JxrReport) lookupMojo( "jxr", testPom );
        mojo.execute();

        Path xrefDir = new File( getBasedir(), "target/test/unit/exclude-configuration/target/site/xref" ).toPath();

        // check that the non-excluded xref files were generated
        assertTrue( Files.exists( xrefDir.resolve( "exclude/configuration/App.html" ) ) );

        // check that the excluded xref files were not generated
        assertFalse( Files.exists( xrefDir.resolve( "exclude/configuration/AppSample.html" ) ) );
    }

    /**
     * Test the plugin with an include configuration.
     *
     * @throws Exception
     */
    public void testInclude()
        throws Exception
    {
        File testPom = new File( getBasedir(),
                "src/test/resources/unit/include-configuration/include-configuration-plugin-config.xml" );
        JxrReport mojo = (JxrReport) lookupMojo( "jxr", testPom );
        mojo.execute();

        Path xrefDir = new File( getBasedir(), "target/test/unit/include-configuration/target/site/xref" ).toPath();

        // check that the included xref files were generated
        assertTrue( Files.exists( xrefDir.resolve( "include/configuration/App.html" )));

        // check that the non-included xref files were not generated
        assertFalse( Files.exists( xrefDir.resolve( "include/configuration/AppSample.html" )));
    }

    public void testExceptions() throws Exception
    {
        try
        {
            File testPom = new File( getBasedir(),
                    "src/test/resources/unit/default-configuration/exception-test-plugin-config.xml" );
            JxrReport mojo = (JxrReport) lookupMojo( "jxr", testPom );
            mojo.execute();

            fail( "Must throw exception" );
        }
        catch ( Exception e )
        {
            assertTrue( true );
        }
    }

    /**
     * Test the jxr for a POM project.
     *
     * @throws Exception
     */
    public void testPom()
        throws Exception
    {
        File testPom = new File( getBasedir(), "src/test/resources/unit/pom-test/pom-test-plugin-config.xml" );
        JxrReport mojo = (JxrReport) lookupMojo( "jxr", testPom );
        mojo.execute();

        assertFalse( new File( getBasedir(), "target/test/unit/pom-test" ).exists() );
    }

    /**
     * Read the contents of the specified file object into a string
     */
    private String readFile( File xrefTestDir, String fileName ) throws IOException
    {
        return new String( Files.readAllBytes( xrefTestDir.toPath().resolve( fileName ) ) );
    }
}