package org.apache.maven.plugin.pmd;
/*
* 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 net.sourceforge.pmd.cpd.CPD;
import net.sourceforge.pmd.cpd.CPDConfiguration;
import net.sourceforge.pmd.cpd.JavaLanguage;
import net.sourceforge.pmd.cpd.Match;
import net.sourceforge.pmd.cpd.TokenEntry;
import org.codehaus.plexus.util.FileUtils;
import org.w3c.dom.Document;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
/**
* @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
* @version $Id: CpdReportTest.java 1610932 2014-07-16 08:22:56Z dennisl $
*/
public class CpdReportTest
extends AbstractPmdReportTest
{
/**
* {@inheritDoc}
*/
protected void setUp()
throws Exception
{
super.setUp();
FileUtils.deleteDirectory( new File( getBasedir(), "target/test/unit" ) );
}
/**
* Test CPDReport given the default configuration
*
* @throws Exception
*/
public void testDefaultConfiguration()
throws Exception
{
File testPom = new File( getBasedir(),
"src/test/resources/unit/default-configuration/cpd-default-configuration-plugin-config.xml" );
CpdReport mojo = (CpdReport) lookupMojo( "cpd", testPom );
mojo.execute();
// check if the CPD files were generated
File generatedFile = new File( getBasedir(), "target/test/unit/default-configuration/target/cpd.xml" );
assertTrue( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
generatedFile = new File( getBasedir(), "target/test/unit/default-configuration/target/site/cpd.html" );
renderer( mojo, generatedFile );
assertTrue( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
// check the contents of cpd.html
String str =
readFile( new File( getBasedir(), "target/test/unit/default-configuration/target/site/cpd.html" ) );
assertTrue(str.toLowerCase().contains("AppSample.java".toLowerCase()));
str = readFile( new File( getBasedir(), "target/test/unit/default-configuration/target/site/cpd.html" ) );
assertTrue(str.toLowerCase().contains("App.java".toLowerCase()));
str = readFile( new File( getBasedir(), "target/test/unit/default-configuration/target/site/cpd.html" ) );
assertTrue(str.toLowerCase().contains("public String dup( String str )".toLowerCase()));
str = readFile( new File( getBasedir(), "target/test/unit/default-configuration/target/site/cpd.html" ) );
assertTrue(str.toLowerCase().contains("tmp = tmp + str.substring( i, i + 1);".toLowerCase()));
}
/**
* Test CPDReport using custom configuration
*
* @throws Exception
*/
public void testCustomConfiguration()
throws Exception
{
File testPom = new File( getBasedir(),
"src/test/resources/unit/custom-configuration/cpd-custom-configuration-plugin-config.xml" );
CpdReport mojo = (CpdReport) lookupMojo( "cpd", testPom );
mojo.execute();
// check if the CPD files were generated
File generatedFile = new File( getBasedir(), "target/test/unit/custom-configuration/target/cpd.csv" );
assertTrue( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
generatedFile = new File( getBasedir(), "target/test/unit/custom-configuration/target/site/cpd.html" );
renderer( mojo, generatedFile );
assertTrue( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
// Contents that should NOT be in the report
String str = readFile( new File( getBasedir(), "target/test/unit/custom-configuration/target/site/cpd.html" ) );
assertTrue(!str.toLowerCase().contains("/Sample.java".toLowerCase()));
str = readFile( new File( getBasedir(), "target/test/unit/custom-configuration/target/site/cpd.html" ) );
assertTrue(!str.toLowerCase().contains("public void duplicateMethod( int i )".toLowerCase()));
// Contents that should be in the report
str = readFile( new File( getBasedir(), "target/test/unit/custom-configuration/target/site/cpd.html" ) );
assertTrue(str.toLowerCase().contains("AnotherSample.java".toLowerCase()));
str = readFile( new File( getBasedir(), "target/test/unit/custom-configuration/target/site/cpd.html" ) );
assertTrue(str.toLowerCase().contains("public static void main( String[] args )".toLowerCase()));
str = readFile( new File( getBasedir(), "target/test/unit/custom-configuration/target/site/cpd.html" ) );
assertTrue(str.toLowerCase().contains("private String unusedMethod(".toLowerCase()));
}
/**
* Test CPDReport with invalid format
*
* @throws Exception
*/
public void testInvalidFormat()
throws Exception
{
try
{
File testPom =
new File( getBasedir(), "src/test/resources/unit/invalid-format/cpd-invalid-format-plugin-config.xml" );
CpdReport mojo = (CpdReport) lookupMojo( "cpd", testPom );
setVariableValueToObject( mojo, "compileSourceRoots", mojo.project.getCompileSourceRoots() );
mojo.execute();
fail( "MavenReportException must be thrown" );
}
catch ( Exception e )
{
assertTrue( true );
}
}
/**
* Read the contents of the specified file object into a string
*
* @param file the file to be read
* @return a String object that contains the contents of the file
* @throws java.io.IOException
*/
private String readFile( File file )
throws IOException
{
String strTmp;
StringBuilder str = new StringBuilder( (int) file.length() );
BufferedReader in = new BufferedReader( new FileReader( file ) );
while ( ( strTmp = in.readLine() ) != null )
{
str.append( ' ' );
str.append( strTmp );
}
in.close();
return str.toString();
}
public void testWriteNonHtml()
throws Exception
{
File testPom = new File( getBasedir(),
"src/test/resources/unit/default-configuration/cpd-default-configuration-plugin-config.xml" );
CpdReport mojo = (CpdReport) lookupMojo( "cpd", testPom );
assertNotNull( mojo );
TokenEntry tFirstEntry = new TokenEntry( "public java", "MyClass.java", 34 );
TokenEntry tSecondEntry = new TokenEntry( "public java", "MyClass3.java", 55 );
List<Match> tList = new ArrayList<Match>();
Match tMatch = new Match( 2, tFirstEntry, tSecondEntry );
tMatch.setSourceCodeSlice( "// ----- ACCESSEURS avec �l�ments -----" );
tList.add( tMatch );
CPDConfiguration cpdConfiguration = new CPDConfiguration();
cpdConfiguration.setMinimumTileSize( 100 );
cpdConfiguration.setLanguage( new JavaLanguage() );
cpdConfiguration.setEncoding( "UTF-8" );
CPD tCpd = new MockCpd( cpdConfiguration, tList.iterator() );
tCpd.go();
mojo.writeNonHtml( tCpd );
File tReport = new File( "target/test/unit/default-configuration/target/cpd.xml" );
// parseDocument( new BufferedInputStream( new FileInputStream( report ) ) );
DocumentBuilder builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
Document pmdCpdDocument = builder.parse( tReport );
assertNotNull( pmdCpdDocument );
}
public void testSkipEmptyReportConfiguration()
throws Exception
{
File testPom = new File( getBasedir(), "src/test/resources/unit/empty-report/cpd-skip-empty-report-plugin-config.xml" );
CpdReport mojo = (CpdReport) lookupMojo( "cpd", testPom );
mojo.execute();
// verify the generated files do not exist because PMD was skipped
File generatedFile = new File( getBasedir(), "target/test/unit/empty-report/target/site/cpd.html" );
assertFalse( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
}
public void testEmptyReportConfiguration()
throws Exception
{
File testPom = new File( getBasedir(), "src/test/resources/unit/empty-report/cpd-empty-report-plugin-config.xml" );
CpdReport mojo = (CpdReport) lookupMojo( "cpd", testPom );
mojo.execute();
// verify the generated files do exist, even if there are no violations
File generatedFile = new File( getBasedir(), "target/test/unit/empty-report/target/site/cpd.html" );
assertTrue( FileUtils.fileExists( generatedFile.getAbsolutePath() ) );
String str = readFile( new File( getBasedir(), "target/test/unit/empty-report/target/site/cpd.html" ) );
assertTrue(!str.toLowerCase().contains("Hello.java".toLowerCase()));
}
public static class MockCpd
extends CPD
{
private Iterator<Match> matches;
public MockCpd( CPDConfiguration configuration, Iterator<Match> tMatch )
{
super( configuration );
matches = tMatch;
}
public Iterator<Match> getMatches()
{
return matches;
}
}
}