You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by GitBox <gi...@apache.org> on 2022/04/30 08:33:31 UTC
[GitHub] [maven] slawekjaranowski commented on a diff in pull request #731: [MNG-7464] Warn about using read-only parameters for Mojo in configuration
slawekjaranowski commented on code in PR #731:
URL: https://github.com/apache/maven/pull/731#discussion_r862330410
##########
maven-core/src/main/java/org/apache/maven/plugin/internal/AbstractMavenPluginParametersValidator.java:
##########
@@ -0,0 +1,153 @@
+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.",
+ "pom.",
Review Comment:
still exist in `PluginParameterExpressionEvaluator`
https://github.com/apache/maven/blob/master/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java#L245
I can remove it here if there is plan to remove such prefix from maven ... IHMO should be done together with change in `PluginParameterExpressionEvaluator`
##########
maven-core/src/main/java/org/apache/maven/plugin/internal/AbstractMavenPluginParametersValidator.java:
##########
@@ -0,0 +1,153 @@
+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.",
+ "pom.",
+ "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}
+
+ try
+ {
+ return expressionEvaluator.evaluate( strValue ) != null;
+ }
+ catch ( ExpressionEvaluationException e )
+ {
+ // not important
+ // will be reported during Mojo fields populate
+ }
+
+ // fallback - in case of error in expressionEvaluator
+ return false;
+ }
+
+ private static boolean isIgnoredProperty( String strValue )
+ {
+ if ( !strValue.startsWith( "${" ) )
+ {
+ return false;
+ }
+
+ String propertyName = strValue.replace( "${", "" ).replace( "}", "" );
+
+ if ( IGNORED_PROPERTY_VALUES.contains( propertyName ) )
+ {
+ return true;
+ }
+
+ return IGNORED_PROPERTY_PREFIX.stream().anyMatch( propertyName::startsWith );
Review Comment:
lambda way ... what is your proposition instead of ...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org