Skip to content

Commit

Permalink
Resolves mojohaus#359: XML Property Updates Report
Browse files Browse the repository at this point in the history
  • Loading branch information
@andrzejj0
andrzejj0 committed Nov 3, 2022
1 parent 780cf6e commit 0a5c55d
Show file tree
Hide file tree
Showing 17 changed files with 531 additions and 78 deletions.
1 change: 0 additions & 1 deletion model-report/src/main/mdo/dependency-updates-report.mdo
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ under the License.
</field>
<field>
<name>nextIncrementalAvailable</name>
<version>1.0.0+</version>
<required>true</required>
<type>String</type>
</field>
Expand Down
1 change: 0 additions & 1 deletion model-report/src/main/mdo/plugin-updates-report.mdo
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ under the License.
</field>
<field>
<name>nextIncrementalAvailable</name>
<version>1.0.0+</version>
<required>true</required>
<type>String</type>
</field>
Expand Down
171 changes: 171 additions & 0 deletions model-report/src/main/mdo/property-updates-report.mdo
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
<?xml version="1.0" encoding="UTF-8"?>

<!--
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.
-->

<model xmlns="http://codehaus-plexus.github.io/MODELLO/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://codehaus-plexus.github.io/MODELLO/2.0.0 https://codehaus-plexus.github.io/modello/xsd/modello-2.0.0.xsd"
xml.namespace="https://www.mojohaus.org/VERSIONS/PROPERTY-UPDATES-REPORT/${version}"
xml.schemaLocation="https://www.mojohaus.org/versions-maven-plugin/xsd/property-updates-report-${version}.xsd">
<id>property-updates-report</id>
<name>PropertyUpdatesReport</name>
<description>
XML version of the Property Updates Report
</description>

<defaults>
<default>
<key>package</key>
<value>org.codehaus.mojo.versions.reporting.model</value>
</default>
</defaults>

<versionDefinition>
<type>namespace</type>
</versionDefinition>

<classes>

<class rootElement="true" xml.tagName="PropertyUpdatesReport">
<name>PropertyUpdatesReport</name>
<fields>
<field>
<name>summary</name>
<required>true</required>
<association>
<type>PropertyReportSummary</type>
<multiplicity>1</multiplicity>
</association>
</field>
<field>
<name>properties</name>
<association xml.itemsStyle="wrapped" xml.tagName="property">
<type>PropertyInfo</type>
<multiplicity>*</multiplicity>
</association>
</field>
</fields>
</class>

<class>
<name>PropertyReportSummary</name>
<fields>
<field>
<name>usingLastVersion</name>
<required>true</required>
<type>String</type>
</field>
<field>
<name>nextVersionAvailable</name>
<required>true</required>
<type>String</type>
</field>
<field>
<name>nextIncrementalAvailable</name>
<required>true</required>
<type>String</type>
</field>
<field>
<name>nextMinorAvailable</name>
<required>true</required>
<type>String</type>
</field>
<field>
<name>nextMajorAvailable</name>
<required>true</required>
<type>String</type>
</field>
</fields>
</class>

<class>
<name>PropertyInfo</name>
<fields>
<field>
<name>propertyName</name>
<required>true</required>
<type>String</type>
</field>
<field>
<name>propertyAssociations</name>
<association xml.itemsStyle="wrapped" xml.tagName="propertyAssociation">
<type>PropertyAssociation</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field>
<name>currentVersion</name>
<type>String</type>
</field>
<field>
<name>lastVersion</name>
<type>String</type>
</field>
<field>
<name>any</name>
<association xml.itemsStyle="wrapped" xml.tagName="any">
<type>String</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field>
<name>incrementals</name>
<association xml.itemsStyle="wrapped" xml.tagName="incremental">
<type>String</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field>
<name>minors</name>
<association xml.itemsStyle="wrapped" xml.tagName="minor">
<type>String</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field>
<name>majors</name>
<association xml.itemsStyle="wrapped" xml.tagName="major">
<type>String</type>
<multiplicity>*</multiplicity>
</association>
</field>
<field>
<name>status</name>
<required>true</required>
<type>String</type>
</field>
</fields>
</class>

<class>
<name>PropertyAssociation</name>
<fields>
<field>
<name>groupId</name>
<type>String</type>
</field>
<field>
<name>artifactId</name>
<type>String</type>
</field>
</fields>
</class>

</classes>
</model>
2 changes: 2 additions & 0 deletions src/it/it-xml-property-updates-report-001/invoker.properties
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
invoker.goals = ${project.groupId}:${project.artifactId}:${project.version}:property-updates-report
invoker.mavenOpts = -DpropertyUpdatesReportFormats=xml
45 changes: 45 additions & 0 deletions src/it/it-xml-property-updates-report-001/pom.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>localhost</groupId>
<artifactId>it-xml-property-updates-report-001</artifactId>
<version>1.0</version>

<properties>
<api-version>1.0</api-version>
<impl-version>2.0</impl-version>
<plugin-version>3.0</plugin-version>
</properties>

<dependencies>
<dependency>
<groupId>localhost</groupId>
<artifactId>dummy-api</artifactId>
<version>[${api-version},2.1-!)</version>
</dependency>
<dependency>
<groupId>localhost</groupId>
<artifactId>dummy-impl</artifactId>
<version>${impl-version}</version>
</dependency>
</dependencies>
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>localhost</groupId>
<artifactId>dummy-maven-plugin</artifactId>
<version>${plugin-version}</version>
<dependencies>
<dependency>
<groupId>localhost</groupId>
<artifactId>dummy-api</artifactId>
<version>${plugin-version}</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</pluginManagement>
</build>
</project>
42 changes: 42 additions & 0 deletions src/it/it-xml-property-updates-report-001/verify.groovy
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
class Fragment
{
private fragment

Fragment( output, beginString, endString )
{
def startIndex = output.indexOf( beginString )
def endIndex = output.indexOf( endString, startIndex )
assert startIndex != -1
assert endIndex != -1
fragment = output.substring( startIndex, endIndex + endString.length() )
}

def contains( String searchString )
{
return fragment.contains( searchString )
}

String toString()
{
return fragment
}
}

def output = new File( basedir, 'target/property-updates-report.xml' ).text
.replaceAll( '\\n', '' )
.replaceAll( '\\r', '' )

summary = new Fragment( output, '<summary>', '</summary>' )

assert summary.contains( '<usingLastVersion>1</usingLastVersion>' )
assert summary.contains( '<nextIncrementalAvailable>1</nextIncrementalAvailable>' )
assert summary.contains( '<nextMinorAvailable>1</nextMinorAvailable>' )

assert new Fragment( output, '<propertyName>api-version</propertyName>',
'</property>' ).contains( '<status>incremental available</status>' )

assert new Fragment( output, '<propertyName>impl-version</propertyName>',
'</property>' ).contains( '<status>minor available</status>' )

assert new Fragment( output, '<propertyName>plugin-version</propertyName>',
'</property>' ).contains( '<status>no new available</status>' )
24 changes: 24 additions & 0 deletions src/site/markdown/xsd/index.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
title: XML schemas
author: Slawomir Jaranowski
date: 2022-10-17

<!-- GitHub pages doesn't generate index page ... we need prepare one -->

# Versions - XML schemas

## dependency-updates-report.xsd

- [dependency-updates-report-2.1.0.xsd](dependency-updates-report-2.1.0.xsd)

## plugin-updates-report.xsd

- [plugin-updates-report-2.1.0.xsd](plugin-updates-report-2.1.0.xsd)

## property-updates-report.xsd

- [property-updates-report-2.1.0.xsd](property-updates-report-2.1.0.xsd)

## rule.xsd

- [rule-2.0.0.xsd](rule-2.0.0.xsd)
- [rule-2.1.0.xsd](rule-2.1.0.xsd)
3 changes: 1 addition & 2 deletions ...ns-maven-plugin/src/main/java/org/codehaus/mojo/versions/DependencyUpdatesReportMojo.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -224,10 +224,9 @@ && getProject().getOriginalModel().getDependencyManagement().getDependencies() !
.collect( Collectors.joining( ", " ) ) ) );
}

DependencyUpdatesModel model = new DependencyUpdatesModel( dependencyUpdates, dependencyManagementUpdates );
for ( String format : formats )
{
DependencyUpdatesModel model =
new DependencyUpdatesModel( dependencyUpdates, dependencyManagementUpdates );
if ( "html".equals( format ) )
{
rendererFactory.createReportRenderer( getOutputName(), sink, locale, model ).render();
Expand Down
40 changes: 38 additions & 2 deletions ...ions-maven-plugin/src/main/java/org/codehaus/mojo/versions/PropertyUpdatesReportMojo.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@

import javax.inject.Inject;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Locale;
import java.util.Map;
import java.util.TreeMap;
Expand All @@ -40,6 +44,7 @@
import org.codehaus.mojo.versions.reporting.ReportRendererFactory;
import org.codehaus.mojo.versions.reporting.model.PropertyUpdatesModel;
import org.codehaus.mojo.versions.utils.PropertyComparator;
import org.codehaus.mojo.versions.xml.PropertyUpdatesXmlReportRenderer;
import org.codehaus.plexus.i18n.I18N;

/**
Expand Down Expand Up @@ -93,6 +98,14 @@ public class PropertyUpdatesReportMojo extends AbstractVersionsReport<PropertyUp
@Parameter( property = "includeParent", defaultValue = "true" )
private boolean includeParent = true;

/**
* Report formats (html and/or xml). HTML by default.
*
* @since 2.14.0
*/
@Parameter( property = "propertyUpdatesReportFormats", defaultValue = "html" )
protected String[] formats = new String[] {"html"};

@Inject
protected PropertyUpdatesReportMojo( I18N i18n, RepositorySystem repositorySystem,
ArtifactResolver artifactResolver,
Expand Down Expand Up @@ -142,8 +155,31 @@ protected void doGenerateReport( Locale locale, Sink sink )
{
throw new MavenReportException( e.getMessage(), e );
}
rendererFactory.createReportRenderer( getOutputName(), getSink(), locale,
new PropertyUpdatesModel( updateSet ) ).render();
PropertyUpdatesModel model = new PropertyUpdatesModel( updateSet );
for ( String format : formats )
{
if ( "html".equals( format ) )
{
rendererFactory.createReportRenderer( getOutputName(), getSink(), locale, model ).render();
}
else if ( "xml".equals( format ) )
{
Path outputDir = Paths.get( getProject().getBuild().getDirectory() );
if ( !Files.exists( outputDir ) )
{
try
{
Files.createDirectories( outputDir );
}
catch ( IOException e )
{
throw new MavenReportException( "Could not create the output directory" );
}
}
Path outputFile = outputDir.resolve( getOutputName() + ".xml" );
new PropertyUpdatesXmlReportRenderer( model, outputFile ).render();
}
}
}

/**
Expand Down
Loading

0 comments on commit 0a5c55d

Please sign in to comment.