[ https://issues.apache.org/jira/browse/MNG-7754?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17708742#comment-17708742 ]
ASF GitHub Bot commented on MNG-7754: ------------------------------------- slawekjaranowski commented on code in PR #1079: URL: https://github.com/apache/maven/pull/1079#discussion_r1158173224 ########## maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultPluginValidationManager.java: ########## @@ -0,0 +1,248 @@ +/* + * 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. + */ +package org.apache.maven.plugin.internal; + +import javax.inject.Named; +import javax.inject.Singleton; + +import java.io.File; +import java.util.Arrays; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.Locale; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +import org.apache.maven.AbstractMavenLifecycleParticipant; +import org.apache.maven.execution.MavenSession; +import org.apache.maven.model.InputLocation; +import org.apache.maven.plugin.PluginValidationManager; +import org.apache.maven.plugin.descriptor.MojoDescriptor; +import org.apache.maven.plugin.descriptor.PluginDescriptor; +import org.apache.maven.project.MavenProject; +import org.eclipse.aether.RepositorySystemSession; +import org.eclipse.aether.artifact.Artifact; +import org.eclipse.aether.util.ConfigUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Singleton +@Named +public final class DefaultPluginValidationManager extends AbstractMavenLifecycleParticipant + implements PluginValidationManager { + + private static final String ISSUES_KEY = DefaultPluginValidationManager.class.getName() + ".issues"; + + private static final String MAVEN_PLUGIN_VALIDATION_KEY = "maven.plugin.validation"; + + private enum ValidationLevel { + DISABLED, + DEFAULT, + VERBOSE + } + + private final Logger logger = LoggerFactory.getLogger(getClass()); + + @Override + public void afterSessionEnd(MavenSession session) { + reportSessionCollectedValidationIssues(session); + } + + private ValidationLevel validationLevel(RepositorySystemSession session) { + String level = ConfigUtils.getString(session, null, MAVEN_PLUGIN_VALIDATION_KEY); + if (level == null || level.isEmpty()) { + return ValidationLevel.DEFAULT; + } + try { + return ValidationLevel.valueOf(level.toUpperCase(Locale.ENGLISH)); + } catch (IllegalArgumentException e) { + logger.warn( + "Invalid value specified for property '{}': '{}'. Supported values are (case insensitive): {}", + MAVEN_PLUGIN_VALIDATION_KEY, + level, + Arrays.toString(ValidationLevel.values())); + return ValidationLevel.DEFAULT; + } + } + + private String pluginKey(String groupId, String artifactId, String version) { + return groupId + ":" + artifactId + ":" + version; + } + + private String pluginKey(MojoDescriptor mojoDescriptor) { + PluginDescriptor pd = mojoDescriptor.getPluginDescriptor(); + return pluginKey(pd.getGroupId(), pd.getArtifactId(), pd.getVersion()); + } + + private String pluginKey(Artifact pluginArtifact) { + return pluginKey(pluginArtifact.getGroupId(), pluginArtifact.getArtifactId(), pluginArtifact.getVersion()); + } + + @Override + public void reportPluginValidationIssue(RepositorySystemSession session, Artifact pluginArtifact, String issue) { + String pluginKey = pluginKey(pluginArtifact); + PluginValidationIssues pluginIssues = + pluginIssues(session).computeIfAbsent(pluginKey, k -> new PluginValidationIssues()); + pluginIssues.reportPluginIssue(null, null, issue); + } + + @Override + public void reportPluginValidationIssue(MavenSession mavenSession, MojoDescriptor mojoDescriptor, String issue) { + String pluginKey = pluginKey(mojoDescriptor); + PluginValidationIssues pluginIssues = pluginIssues(mavenSession.getRepositorySession()) + .computeIfAbsent(pluginKey, k -> new PluginValidationIssues()); + pluginIssues.reportPluginIssue(pluginDeclaration(mojoDescriptor), pluginOccurrence(mavenSession), issue); + } + + @Override + public void reportPluginMojoValidationIssue( + MavenSession mavenSession, MojoDescriptor mojoDescriptor, Class<?> mojoClass, String issue) { + String pluginKey = pluginKey(mojoDescriptor); + PluginValidationIssues pluginIssues = pluginIssues(mavenSession.getRepositorySession()) + .computeIfAbsent(pluginKey, k -> new PluginValidationIssues()); + pluginIssues.reportPluginMojoIssue( + pluginDeclaration(mojoDescriptor), + pluginOccurrence(mavenSession), + mojoInfo(mojoDescriptor, mojoClass), + issue); + } + + private void reportSessionCollectedValidationIssues(MavenSession mavenSession) { + ValidationLevel validationLevel = validationLevel(mavenSession.getRepositorySession()); + ConcurrentHashMap<String, PluginValidationIssues> issuesMap = pluginIssues(mavenSession.getRepositorySession()); + if (!issuesMap.isEmpty()) { + + logger.warn(""); + logger.warn("Plugin validation issues were detected in {} plugin(s)", issuesMap.size()); + logger.warn(""); + if (validationLevel == ValidationLevel.DISABLED || !logger.isWarnEnabled()) { + return; + } Review Comment: If disable nothing should be logged > Improvement and extension of plugin validation > ---------------------------------------------- > > Key: MNG-7754 > URL: https://issues.apache.org/jira/browse/MNG-7754 > Project: Maven > Issue Type: Task > Components: Core > Affects Versions: 3.9.1 > Reporter: Tamas Cservenak > Priority: Major > Fix For: 3.9.2, 4.0.0-alpha-6, 4.0.0 > > > Some users when see following warning: > {noformat} > [INFO] --- remote-resources:1.7.0:process (process-resource-bundles) @ maven > --- > [WARNING] Parameter 'localRepository' is deprecated core expression; Avoid > use of ArtifactRepository type. If you need access to local repository, > switch to '${repositorySystemSession}' expression and get LRM from it > instead. {noformat} > on their console, immediately grep their {{$HOME}} to find out that they DO > HAVE afore mentioned string present in their {{{}settings.xml{}}}, and then > scratch their head how to get rid of it. > Hence, we should improve error message – at least add some clue that message > targets given Mojo developers (as message appears immediately under Mojo > execution log message) and not users. Best users could do is nag Mojo > developers, and not us, to make message disappear. > Improvements: > * report at end, instead multiple times same warning (for reactor builds) > * possibility to suppress validation > * new check: maven-compat, maven2, p-c-d, mixed maven verions,, wrong scopes > (similar as m-p-p does on build time) -- This message was sent by Atlassian Jira (v8.20.10#820010)