[MSHARED-831] Configuration in reporting section not taken into account when running from cli

[jira-importer]

Hans Aikema opened MSHARED-831 and commented

Investigating on jeremylong/DependencyCheck#1444 my conclusion is that plugin configuration using the reporting section does not work as documented on https://maven.apache.org/guides/mini/guide-configuring-plugins.html#Using_the_reporting_Tag_VS_build_Tag

When configuring the plugin using the reporting section of the pom the configuration is not applied when calling the plugin goal from the CLI whereas the guide states that it is first looked up there and only when not found searched for in the build section.

Don't know if this is the intended behaviour of the CLI-invocation of the plugins (and thus a documentation bug) or an actual bug in the configuration evaluation, but I spotted similar behaviour with the maven-project-info-reports-plugin

---

Affects: maven-reporting-impl 3.0

0 votes, 5 watchers

[jira-importer]

Hans Aikema commented

The following POM will still generate a dependencies report when called with mvn clean project-info-reports:dependencies

<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>net.aikebah</groupId>
    <artifactId>mng6540-faulty</artifactId>
    <version>1.0-SNAPSHOT</version>

    <name>mng6540-faulty</name>

    <dependencies>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.7</version>
        </dependency>
    </dependencies>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <artifactId>maven-project-info-reports-plugin</artifactId>
                    <version>3.0.0</version>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
    <reporting>
        <plugins>
            <plugin>
                <artifactId>maven-project-info-reports-plugin</artifactId>
                <version>3.0.0</version>
                <configuration>
                    <skip>true</skip>
                </configuration>
            </plugin>
        </plugins>
    </reporting>
</project>

[jira-importer]

Hans Aikema commented

Whereas no dependencies report is created when called with mvn clean project-info-reports:dependencies for

<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>net.aikebah</groupId>
    <artifactId>mng6540-faulty</artifactId>
    <version>1.0-SNAPSHOT</version>

    <name>mng6540-faulty</name>

    <dependencies>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.7</version>
        </dependency>
    </dependencies>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <artifactId>maven-project-info-reports-plugin</artifactId>
                    <version>3.0.0</version>
                    <configuration>
                        <skip>true</skip>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
    <reporting>
        <plugins>
            <plugin>
                <artifactId>maven-project-info-reports-plugin</artifactId>
                <version>3.0.0</version>
            </plugin>
        </plugins>
    </reporting>
</project>

[jira-importer]

Michael Osipov commented

Indeed, the behavior does not match the docs. Does 3.6.2-SNAPSHOT make any change?
Hervé Boutemy, any idea?

[jira-importer]

Hervé Boutemy commented

thank you Michael for pinging me
it's an edge case (AFAIK not explicited anywhere): when you launch "mvn project-info-reports:dependencies", you don't really launch a report from a Maven perspective
you're launching a goal
a report is something launched by site plugin: and site plugin mimics normal plugins behavour (through maven-report-exec https://maven.apache.org/shared/maven-reporting-exec/ )
then defining the configuration in pluginManagement is perfectly taken into account both by Maven (as a normal goal) and by maven-site-plugin (as a report)
but defining the configuration in reporting section is only taken into account by maven-site-plugin: for Maven, it's a goal, not a report (even if this goal simulates site plugin to generate a report)

the code for a goal to "simulate site plugin to generate a report" is maven-reporting-impl: https://maven.apache.org/shared/maven-reporting-impl/
it could perhaps be enhanced to better simulate site plugin: this is where the improvement should be

I propose to move this issue into maven-reporting-impl

and for the mini-guide, perhaps it's not consistent with real behaviour and should be updated: this one is for MNGSITE

[jira-importer]

Michael Osipov commented

Re-reviewing this: This is not a bug, but expected behavior. Running outside of Maven Site Plugin, as Hervé Boutemy said, is completely different. I am included to close this one out.

[jira-importer]

Hervé Boutemy commented

I'd not close this issue but I'd change from "bug" to "improvement" or "new feature"

I have a question for Hans Aikema: do you really use mvn clean project-info-reports:dependencies for serious use, instead of generating the full site? why?

[jira-importer]

Hervé Boutemy commented

notice that when I read https://maven.apache.org/guides/mini/guide-configuring-plugins.html#Using_the_reporting_Tag_VS_build_Tag , it's very inaccurate:

• on the site aspect, it describes old maven-site-plugin 2.x behaviour
• on the direct report CLI invocation, it says reporting section config is used: it never was used, and I fear it won't be for a long time because the current improvement is not so easy to code (I really don't see how a running Mojo can update the way it was configured...)

looking at Git blame, no surprise as this part was written 13 years ago apache/maven-site@8967e64

[jira-importer]

Michael Osipov commented

The proportion between a sound new solution and the benefit is truly unhealthy for me.

[jira-importer]

Hervé Boutemy commented

what we need is to fix site, because it's clearly wrong now
on implementing the improvement, sure, I don't see really the interest...

[jira-importer]

Michael Osipov commented

I agree with that. Let's update the docs with the reality and move on.

[jira-importer]

Hervé Boutemy commented

documentation updated in apache/maven-site@b3db55e

[jira-importer]

Michael Osipov commented

Update looks good to me.

[jira-importer]

Michael Osipov commented

Hervé Boutemy, shall we close this now as wontfix?

[jira-importer]

Hervé Boutemy commented

it would be useful to have feedback on usage: doc is fixed, that was the minimum, but learning on the interest of trying to change

[jira-importer]

Hans Aikema commented

Hervé Boutemy

I have a question for Hans Aikema: do you really use mvn clean project-info-reports:dependencies for serious use, instead of generating the full site?

It was the information in the docs that got me thinking there would be something wrong in the code of the plugin. By using one of maven's own reporting mojos I validated that the issue (reporting section configuration not taken into account during direct-plugin-goal-invocation) was not isolated to our plugin. That's the only reason why I had the project-info-reports:dependencies as a direct invocation.

I see no reason to run a reporting-plugin configured in the reporting section outside the maven site generation for serious use.

As for the cases where there might be a good reason I see no problem in then having to move configuration to the build/plugins section to have it taken into account in both direct-goal invocation and site generation.

I'm perfectly fine with closing this one as a wontfix (assuming that something resembling a docsfixed resolution is not available, otherwise that would be more appropriate in my view - the reported issue was solved by bringing the docs in line with the actual implementation)

As a side-note: The new text needs a typo-fix in line 635 https://github.com/apache/maven-site/blob/b3db55e331c3070e79870f96196268a4d60ad208/content/apt/guides/mini/guide-configuring-plugins.apt#L635 Sine should be Since