This is an automated email from the ASF dual-hosted git repository. adangel pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-pmd-plugin.git
The following commit(s) were added to refs/heads/master by this push: new d57e632 [MPMD-251] Invalid report XML is generated with includeXmlInSite=true d57e632 is described below commit d57e632e34f938f0ccda095a9b4e02bacdc738f1 Author: Andreas Dangel <adan...@apache.org> AuthorDate: Thu Jan 18 11:10:30 2018 +0100 [MPMD-251] Invalid report XML is generated with includeXmlInSite=true Use the same fix for CPD --- .../org/apache/maven/plugins/pmd/CpdReport.java | 1 + .../apache/maven/plugins/pmd/CpdReportTest.java | 63 +++++++++++++++++----- ...pd-report-include-xml-in-site-plugin-config.xml | 62 +++++++++++++++++++++ 3 files changed, 114 insertions(+), 12 deletions(-) diff --git a/src/main/java/org/apache/maven/plugins/pmd/CpdReport.java b/src/main/java/org/apache/maven/plugins/pmd/CpdReport.java index f139e06..99ddb34 100644 --- a/src/main/java/org/apache/maven/plugins/pmd/CpdReport.java +++ b/src/main/java/org/apache/maven/plugins/pmd/CpdReport.java @@ -378,6 +378,7 @@ public class CpdReport try ( Writer writer = new OutputStreamWriter( new FileOutputStream( targetFile ), getOutputEncoding() ) ) { writer.write( buffer ); + writer.flush(); if ( includeXmlInSite ) { diff --git a/src/test/java/org/apache/maven/plugins/pmd/CpdReportTest.java b/src/test/java/org/apache/maven/plugins/pmd/CpdReportTest.java index 6cb23a4..88a794c 100644 --- a/src/test/java/org/apache/maven/plugins/pmd/CpdReportTest.java +++ b/src/test/java/org/apache/maven/plugins/pmd/CpdReportTest.java @@ -186,18 +186,10 @@ public class CpdReportTest return str.toString(); } - public void testWriteNonHtml() - throws Exception + private CPD prepareMockCpd( String duplicatedCodeFragment ) { - 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", 2 ); TokenEntry tSecondEntry = new TokenEntry( "public java", "MyClass3.java", 2 ); - String duplicatedCodeFragment = "// ----- duplicated code example -----"; SourceCode sourceCodeFirst = new SourceCode(new SourceCode.StringCodeLoader( PMD.EOL + duplicatedCodeFragment + PMD.EOL, "MyClass.java")); SourceCode sourceCodeSecond = new SourceCode(new SourceCode.StringCodeLoader( @@ -220,21 +212,68 @@ public class CpdReportTest CPD tCpd = new MockCpd( cpdConfiguration, tList.iterator() ); tCpd.go(); + return tCpd; + } + + 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 ); + + String duplicatedCodeFragment = "// ----- duplicated code example -----"; + CPD tCpd = prepareMockCpd( duplicatedCodeFragment ); mojo.writeNonHtml( tCpd ); - File tReport = new File( "target/test/unit/default-configuration/target/cpd.xml" ); - // parseDocument( new BufferedInputStream( new FileInputStream( report ) ) ); + File tReport = new File( getBasedir(), "target/test/unit/default-configuration/target/cpd.xml" ); DocumentBuilder builder = DocumentBuilderFactory.newInstance().newDocumentBuilder(); Document pmdCpdDocument = builder.parse( tReport ); assertNotNull( pmdCpdDocument ); - String str = readFile( new File( getBasedir(), "target/test/unit/default-configuration/target/cpd.xml" ) ); + String str = readFile( tReport ); assertTrue( lowerCaseContains( str, "MyClass.java" ) ); assertTrue( lowerCaseContains( str, "MyClass3.java" ) ); assertTrue( lowerCaseContains( str, duplicatedCodeFragment ) ); } + /** + * verify the cpd.xml file is included in the site when requested. + * @throws Exception + */ + public void testIncludeXmlInSite() + throws Exception + { + File testPom = + new File( getBasedir(), + "src/test/resources/unit/default-configuration/cpd-report-include-xml-in-site-plugin-config.xml" ); + CpdReport mojo = (CpdReport) lookupMojo( "cpd", testPom ); + assertNotNull( mojo ); + + String duplicatedCodeFragment = "// ----- duplicated code example -----"; + CPD tCpd = prepareMockCpd( duplicatedCodeFragment ); + mojo.writeNonHtml( tCpd ); + + File tReport = new File( getBasedir(), "target/test/unit/default-configuration/target/cpd.xml" ); + assertTrue( FileUtils.fileExists( tReport.getAbsolutePath() ) ); + + DocumentBuilder builder = DocumentBuilderFactory.newInstance().newDocumentBuilder(); + Document pmdCpdDocument = builder.parse( tReport ); + assertNotNull( pmdCpdDocument ); + + String str = readFile( tReport ); + assertTrue( str.contains( "</pmd-cpd>" ) ); + + File siteReport = new File( getBasedir(), "target/test/unit/default-configuration/target/site/cpd.xml" ); + assertTrue( FileUtils.fileExists( siteReport.getAbsolutePath() ) ); + String siteReportContent = readFile( siteReport ); + assertTrue( siteReportContent.contains( "</pmd-cpd>" ) ); + } + + public void testSkipEmptyReportConfiguration() throws Exception { diff --git a/src/test/resources/unit/default-configuration/cpd-report-include-xml-in-site-plugin-config.xml b/src/test/resources/unit/default-configuration/cpd-report-include-xml-in-site-plugin-config.xml new file mode 100644 index 0000000..cccb881 --- /dev/null +++ b/src/test/resources/unit/default-configuration/cpd-report-include-xml-in-site-plugin-config.xml @@ -0,0 +1,62 @@ +<!-- +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. +--> + +<project> + <modelVersion>4.0.0</modelVersion> + <groupId>def.configuration</groupId> + <artifactId>default-configuration</artifactId> + <packaging>jar</packaging> + <version>1.0-SNAPSHOT</version> + <inceptionYear>2006</inceptionYear> + <name>Maven CPD Plugin Default Configuration Test With includeXmlInSite</name> + <url>http://maven.apache.org</url> + <build> + <finalName>default-configuration</finalName> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-pmd-plugin</artifactId> + <configuration> + <project implementation="org.apache.maven.plugins.pmd.stubs.DefaultConfigurationMavenProjectStub"/> + <outputDirectory>${basedir}/target/test/unit/default-configuration/target/site</outputDirectory> + <targetDirectory>${basedir}/target/test/unit/default-configuration/target</targetDirectory> + <format>xml</format> + <linkXRef>false</linkXRef> + <xrefLocation>${basedir}/target/test/unit/default-configuration/target/site/xref</xrefLocation> + <minimumTokens>100</minimumTokens> + + <compileSourceRoots> + <compileSourceRoot>${basedir}/src/test/resources/unit/default-configuration/</compileSourceRoot> + </compileSourceRoots> + <sourceEncoding>UTF-8</sourceEncoding> + <includeXmlInSite>true</includeXmlInSite> + <format>xml</format> + </configuration> + </plugin> + </plugins> + </build> + <reporting> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-jxr-plugin</artifactId> + </plugin> + </plugins> + </reporting> +</project> -- To stop receiving notification emails like this one, please contact ['"commits@maven.apache.org" <commits@maven.apache.org>'].