[
https://issues.apache.org/jira/browse/MNG-7464?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17531151#comment-17531151
]
ASF GitHub Bot commented on MNG-7464:
-------------------------------------
michael-o commented on code in PR #731:
URL: https://github.com/apache/maven/pull/731#discussion_r863687256
##########
maven-core/src/main/java/org/apache/maven/plugin/internal/AbstractMavenPluginParametersValidator.java:
##########
@@ -0,0 +1,152 @@
+package org.apache.maven.plugin.internal;
+
+/*
+ * 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 java.util.Arrays;
+import java.util.List;
+
+import org.apache.maven.plugin.descriptor.Parameter;
+import org.apache.maven.shared.utils.logging.MessageBuilder;
+import org.apache.maven.shared.utils.logging.MessageUtils;
+import
org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
+import
org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
+import org.codehaus.plexus.configuration.PlexusConfiguration;
+import org.slf4j.Logger;
+
+/**
+ * Common implementations for plugin parameters configuration validation.
+ *
+ * @author Slawomir Jaranowski
+ */
+abstract class AbstractMavenPluginParametersValidator implements
MavenPluginConfigurationValidator
+{
+
+ // plugin author can provide @Parameter( property = "session" ) in this
case property will always evaluate
+ // so, we need ignore those
+
+ // source org.apache.maven.plugin.PluginParameterExpressionEvaluator
+ private static final List<String> IGNORED_PROPERTY_VALUES = Arrays.asList(
+ "basedir",
+ "executedProject",
+ "localRepository",
+ "mojo",
+ "mojoExecution",
+ "plugin",
+ "project",
+ "reactorProjects",
+ "session",
+ "settings"
+ );
+
+ private static final List<String> IGNORED_PROPERTY_PREFIX = Arrays.asList(
+ "mojo.",
+ "plugin.",
+ "project.",
+ "session.",
+ "settings."
+ );
+
+ protected abstract Logger getLogger();
+
+ protected static boolean isValueSet( PlexusConfiguration config,
+ ExpressionEvaluator
expressionEvaluator )
+ {
+ if ( config == null )
+ {
+ return false;
+ }
+
+ // there are sub items ... so configuration is declared
+ if ( config.getChildCount() > 0 )
+ {
+ return true;
+ }
+
+ String strValue = config.getValue();
+
+ if ( strValue == null || strValue.isEmpty() )
+ {
+ return false;
+ }
+
+ if ( isIgnoredProperty( strValue ) )
+ {
+ return false;
+ }
+
+ // for declaration like @Parameter( property = "config.property" )
+ // the value will contains ${config.property}
Review Comment:
will contain
##########
maven-core/src/main/java/org/apache/maven/plugin/internal/ReadOnlyPluginParametersValidator.java:
##########
@@ -0,0 +1,80 @@
+package org.apache.maven.plugin.internal;
+
+/*
+ * 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 javax.inject.Named;
+import javax.inject.Singleton;
+
+import org.apache.maven.plugin.descriptor.MojoDescriptor;
+import org.apache.maven.plugin.descriptor.Parameter;
+import
org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
+import org.codehaus.plexus.configuration.PlexusConfiguration;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Print warnings if read-only parameters of plugin are used in configuration.
+ *
+ * @author Slawomir Jaranowski
+ */
+@Named
+@Singleton
+public class ReadOnlyPluginParametersValidator extends
AbstractMavenPluginParametersValidator
+{
+ private static final Logger LOGGER = LoggerFactory.getLogger(
ReadOnlyPluginParametersValidator.class );
+
+ @Override
+ protected Logger getLogger()
+ {
+ return LOGGER;
+ }
+
+ @Override
+ protected String getParameterLogReason( Parameter parameter )
+ {
+ return "is read-only, should not be used in configuration";
Review Comment:
Are you going the change the message?
##########
maven-core/src/main/java/org/apache/maven/plugin/internal/ReadOnlyPluginParametersValidator.java:
##########
@@ -0,0 +1,80 @@
+package org.apache.maven.plugin.internal;
+
+/*
+ * 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 javax.inject.Named;
+import javax.inject.Singleton;
+
+import org.apache.maven.plugin.descriptor.MojoDescriptor;
+import org.apache.maven.plugin.descriptor.Parameter;
+import
org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
+import org.codehaus.plexus.configuration.PlexusConfiguration;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Print warnings if read-only parameters of plugin are used in configuration.
Review Comment:
"of a plugin"
> Warn about using read-only parameters for Mojo in configuration
> ---------------------------------------------------------------
>
> Key: MNG-7464
> URL: https://issues.apache.org/jira/browse/MNG-7464
> Project: Maven
> Issue Type: New Feature
> Reporter: Slawomir Jaranowski
> Assignee: Slawomir Jaranowski
> Priority: Major
> Fix For: 3.9.0, 4.0.0-alpha-1, 4.0.0
>
>
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
