You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by cs...@apache.org on 2023/02/23 14:49:59 UTC
[maven] branch maven-3.9.x updated: [MNG-7706] Deprecate 'localRepository' parameter expression (#1009)
This is an automated email from the ASF dual-hosted git repository.
cstamas pushed a commit to branch maven-3.9.x
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/maven-3.9.x by this push:
new 95ceb71cc [MNG-7706] Deprecate 'localRepository' parameter expression (#1009)
95ceb71cc is described below
commit 95ceb71ccc6327546df89ab623d708009439dd1a
Author: Tamas Cservenak <ta...@cservenak.net>
AuthorDate: Thu Feb 23 15:49:47 2023 +0100
[MNG-7706] Deprecate 'localRepository' parameter expression (#1009)
This PR deprecates the 'localRepository' mojo parameter expression, and Core will emit warning if used by any Mojo.
---
https://issues.apache.org/jira/browse/MNG-7706
---
.../artifact/repository/ArtifactRepository.java | 3 +
.../repository/ArtifactRepositoryPolicy.java | 2 +
.../layout/ArtifactRepositoryLayout.java | 8 ++-
.../plugin/PluginParameterExpressionEvaluator.java | 2 +-
...PluginDescriptorSourcedParametersValidator.java | 65 ++++++++++++++++++++++
.../AbstractMavenPluginParametersValidator.java | 53 +++++++-----------
...java => DeprecatedCoreExpressionValidator.java} | 46 +++++++--------
.../plugin/internal/DeprecatedPluginValidator.java | 26 +++------
.../ReadOnlyPluginParametersValidator.java | 19 +------
9 files changed, 128 insertions(+), 96 deletions(-)
diff --git a/maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepository.java b/maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepository.java
index 5e35c4239..870e191ba 100644
--- a/maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepository.java
+++ b/maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepository.java
@@ -28,7 +28,10 @@ import org.apache.maven.repository.Proxy;
/**
* Abstraction of an artifact repository. Artifact repositories can be remote, local, or even build reactor or
* IDE workspace.
+ *
+ * @deprecated Avoid use of this type, if you need access to local repository use repository system classes instead.
*/
+@Deprecated
public interface ArtifactRepository {
String pathOf(Artifact artifact);
diff --git a/maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepositoryPolicy.java b/maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepositoryPolicy.java
index 3c8425b02..deda1af5d 100644
--- a/maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepositoryPolicy.java
+++ b/maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepositoryPolicy.java
@@ -25,7 +25,9 @@ import java.util.Date;
* Describes a set of policies for a repository to use under certain conditions.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
+ * @deprecated Avoid use of this type, if you need access to local repository use repository system session instead.
*/
+@Deprecated
public class ArtifactRepositoryPolicy {
public static final String UPDATE_POLICY_NEVER = "never";
diff --git a/maven-artifact/src/main/java/org/apache/maven/artifact/repository/layout/ArtifactRepositoryLayout.java b/maven-artifact/src/main/java/org/apache/maven/artifact/repository/layout/ArtifactRepositoryLayout.java
index a71c04429..d44675cdb 100644
--- a/maven-artifact/src/main/java/org/apache/maven/artifact/repository/layout/ArtifactRepositoryLayout.java
+++ b/maven-artifact/src/main/java/org/apache/maven/artifact/repository/layout/ArtifactRepositoryLayout.java
@@ -22,7 +22,13 @@ import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.metadata.ArtifactMetadata;
import org.apache.maven.artifact.repository.ArtifactRepository;
-/** @author jdcasey */
+/**
+ * Repository layout.
+ *
+ * @author jdcasey
+ * @deprecated Avoid use of this type, if you need access to local repository use repository system session instead.
+ */
+@Deprecated
public interface ArtifactRepositoryLayout {
String ROLE = ArtifactRepositoryLayout.class.getName();
diff --git a/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java b/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java
index dd62795e4..b81f91bc9 100644
--- a/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java
+++ b/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java
@@ -40,7 +40,7 @@ import org.codehaus.plexus.util.introspection.ReflectionValueExtractor;
* <tr><td><code>session</code></td> <td></td> <td>the actual {@link MavenSession}</td></tr>
* <tr><td><code>session.*</code></td> <td>(since Maven 3)</td><td></td></tr>
* <tr><td><code>localRepository</code></td> <td></td>
- * <td>{@link MavenSession#getLocalRepository()}</td></tr>
+ * <td>{@link MavenSession#getLocalRepository()} DEPRECATED: Avoid use of {@link org.apache.maven.artifact.repository.ArtifactRepository} type. If you need access to local repository, switch to '${repositorySystemSession}' expression and get LRM from it instead. See <a href="https://issues.apache.org/jira/browse/MNG-7706">MNG-7706</a></td></tr>
* <tr><td><code>reactorProjects</code></td> <td></td> <td>{@link MavenSession#getProjects()}</td></tr>
* <tr><td><code>repositorySystemSession</code></td><td> (since Maven 3)</td>
* <td>{@link MavenSession#getRepositorySession()}</td></tr>
diff --git a/maven-core/src/main/java/org/apache/maven/plugin/internal/AbstractMavenPluginDescriptorSourcedParametersValidator.java b/maven-core/src/main/java/org/apache/maven/plugin/internal/AbstractMavenPluginDescriptorSourcedParametersValidator.java
new file mode 100644
index 000000000..94ca55781
--- /dev/null
+++ b/maven-core/src/main/java/org/apache/maven/plugin/internal/AbstractMavenPluginDescriptorSourcedParametersValidator.java
@@ -0,0 +1,65 @@
+/*
+ * 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 java.util.Arrays;
+import java.util.List;
+
+/**
+ * Common implementations for plugin parameters configuration validation that relies on Mojo descriptor (leaves out
+ * core parameters by default).
+ *
+ * @author Slawomir Jaranowski
+ */
+abstract class AbstractMavenPluginDescriptorSourcedParametersValidator extends AbstractMavenPluginParametersValidator {
+
+ // 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.", "pom.", "plugin.", "project.", "session.", "settings.");
+
+ @Override
+ protected 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);
+ }
+}
diff --git a/maven-core/src/main/java/org/apache/maven/plugin/internal/AbstractMavenPluginParametersValidator.java b/maven-core/src/main/java/org/apache/maven/plugin/internal/AbstractMavenPluginParametersValidator.java
index 620b0ee2c..809a75dfc 100644
--- a/maven-core/src/main/java/org/apache/maven/plugin/internal/AbstractMavenPluginParametersValidator.java
+++ b/maven-core/src/main/java/org/apache/maven/plugin/internal/AbstractMavenPluginParametersValidator.java
@@ -18,9 +18,7 @@
*/
package org.apache.maven.plugin.internal;
-import java.util.Arrays;
-import java.util.List;
-
+import org.apache.maven.plugin.descriptor.MojoDescriptor;
import org.apache.maven.plugin.descriptor.Parameter;
import org.apache.maven.shared.utils.logging.MessageBuilder;
import org.apache.maven.shared.utils.logging.MessageUtils;
@@ -28,6 +26,7 @@ import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluatio
import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
import org.codehaus.plexus.configuration.PlexusConfiguration;
import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
/**
* Common implementations for plugin parameters configuration validation.
@@ -36,28 +35,9 @@ import org.slf4j.Logger;
*/
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.", "pom.", "plugin.", "project.", "session.", "settings.");
+ protected final Logger logger = LoggerFactory.getLogger(getClass());
- protected abstract Logger getLogger();
-
- protected static boolean isValueSet(PlexusConfiguration config, ExpressionEvaluator expressionEvaluator) {
+ protected boolean isValueSet(PlexusConfiguration config, ExpressionEvaluator expressionEvaluator) {
if (config == null) {
return false;
}
@@ -91,18 +71,25 @@ abstract class AbstractMavenPluginParametersValidator implements MavenPluginConf
return false;
}
- private static boolean isIgnoredProperty(String strValue) {
- if (!strValue.startsWith("${")) {
- return false;
+ @Override
+ public final void validate(
+ MojoDescriptor mojoDescriptor,
+ PlexusConfiguration pomConfiguration,
+ ExpressionEvaluator expressionEvaluator) {
+ if (!logger.isWarnEnabled()) {
+ return;
}
- String propertyName = strValue.replace("${", "").replace("}", "");
+ doValidate(mojoDescriptor, pomConfiguration, expressionEvaluator);
+ }
- if (IGNORED_PROPERTY_VALUES.contains(propertyName)) {
- return true;
- }
+ protected abstract void doValidate(
+ MojoDescriptor mojoDescriptor,
+ PlexusConfiguration pomConfiguration,
+ ExpressionEvaluator expressionEvaluator);
- return IGNORED_PROPERTY_PREFIX.stream().anyMatch(propertyName::startsWith);
+ protected boolean isIgnoredProperty(String strValue) {
+ return false;
}
protected abstract String getParameterLogReason(Parameter parameter);
@@ -120,6 +107,6 @@ abstract class AbstractMavenPluginParametersValidator implements MavenPluginConf
messageBuilder.warning(" ").warning(getParameterLogReason(parameter));
- getLogger().warn(messageBuilder.toString());
+ logger.warn(messageBuilder.toString());
}
}
diff --git a/maven-core/src/main/java/org/apache/maven/plugin/internal/ReadOnlyPluginParametersValidator.java b/maven-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedCoreExpressionValidator.java
similarity index 58%
copy from maven-core/src/main/java/org/apache/maven/plugin/internal/ReadOnlyPluginParametersValidator.java
copy to maven-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedCoreExpressionValidator.java
index 45f76992f..0437b6252 100644
--- a/maven-core/src/main/java/org/apache/maven/plugin/internal/ReadOnlyPluginParametersValidator.java
+++ b/maven-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedCoreExpressionValidator.java
@@ -21,57 +21,49 @@ package org.apache.maven.plugin.internal;
import javax.inject.Named;
import javax.inject.Singleton;
+import java.util.HashMap;
+
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 a plugin are used in configuration.
+ * Print warnings if deprecated core parameters are used in mojo.
*
- * @author Slawomir Jaranowski
+ * @since 3.9.1
*/
-@Named
@Singleton
-public class ReadOnlyPluginParametersValidator extends AbstractMavenPluginParametersValidator {
- private static final Logger LOGGER = LoggerFactory.getLogger(ReadOnlyPluginParametersValidator.class);
+@Named
+class DeprecatedCoreExpressionValidator extends AbstractMavenPluginParametersValidator {
+ private static final HashMap<String, String> DEPRECATED_CORE_PARAMETERS;
- @Override
- protected Logger getLogger() {
- return LOGGER;
+ private static final String ARTIFACT_REPOSITORY_REASON =
+ "Avoid use of ArtifactRepository type. If you need access to local repository, switch to '${repositorySystemSession}' expression and get LRM from it instead.";
+
+ static {
+ HashMap<String, String> deprecatedCoreParameters = new HashMap<>();
+ deprecatedCoreParameters.put("localRepository", ARTIFACT_REPOSITORY_REASON);
+ deprecatedCoreParameters.put("session.localRepository", ARTIFACT_REPOSITORY_REASON);
+ DEPRECATED_CORE_PARAMETERS = deprecatedCoreParameters;
}
@Override
protected String getParameterLogReason(Parameter parameter) {
- return "is read-only, must not be used in configuration";
+ return "is deprecated core expression; " + DEPRECATED_CORE_PARAMETERS.get(parameter.getName());
}
@Override
- public void validate(
+ protected void doValidate(
MojoDescriptor mojoDescriptor,
PlexusConfiguration pomConfiguration,
ExpressionEvaluator expressionEvaluator) {
- if (!LOGGER.isWarnEnabled()) {
- return;
- }
-
if (mojoDescriptor.getParameters() == null) {
return;
}
mojoDescriptor.getParameters().stream()
- .filter(parameter -> !parameter.isEditable())
- .forEach(parameter -> checkParameter(parameter, pomConfiguration, expressionEvaluator));
- }
-
- protected void checkParameter(
- Parameter parameter, PlexusConfiguration pomConfiguration, ExpressionEvaluator expressionEvaluator) {
- PlexusConfiguration config = pomConfiguration.getChild(parameter.getName(), false);
-
- if (isValueSet(config, expressionEvaluator)) {
- logParameter(parameter);
- }
+ .filter(parameter -> DEPRECATED_CORE_PARAMETERS.containsKey(parameter.getName()))
+ .forEach(this::logParameter);
}
}
diff --git a/maven-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedPluginValidator.java b/maven-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedPluginValidator.java
index e9bf0d7b6..d229d8a57 100644
--- a/maven-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedPluginValidator.java
+++ b/maven-core/src/main/java/org/apache/maven/plugin/internal/DeprecatedPluginValidator.java
@@ -18,43 +18,33 @@
*/
package org.apache.maven.plugin.internal;
+import javax.inject.Named;
+import javax.inject.Singleton;
+
import org.apache.maven.plugin.descriptor.MojoDescriptor;
import org.apache.maven.plugin.descriptor.Parameter;
import org.apache.maven.shared.utils.logging.MessageUtils;
-import org.codehaus.plexus.component.annotations.Component;
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 deprecated mojo or parameters of plugin are used in configuration.
*
* @author Slawomir Jaranowski
*/
-@Component(role = MavenPluginConfigurationValidator.class)
-class DeprecatedPluginValidator extends AbstractMavenPluginParametersValidator {
- private static final Logger LOGGER = LoggerFactory.getLogger(DeprecatedPluginValidator.class);
-
- @Override
- protected Logger getLogger() {
- return LOGGER;
- }
-
+@Singleton
+@Named
+class DeprecatedPluginValidator extends AbstractMavenPluginDescriptorSourcedParametersValidator {
@Override
protected String getParameterLogReason(Parameter parameter) {
return "is deprecated: " + parameter.getDeprecated();
}
@Override
- public void validate(
+ protected void doValidate(
MojoDescriptor mojoDescriptor,
PlexusConfiguration pomConfiguration,
ExpressionEvaluator expressionEvaluator) {
- if (!LOGGER.isWarnEnabled()) {
- return;
- }
-
if (mojoDescriptor.getDeprecated() != null) {
logDeprecatedMojo(mojoDescriptor);
}
@@ -86,6 +76,6 @@ class DeprecatedPluginValidator extends AbstractMavenPluginParametersValidator {
.warning(mojoDescriptor.getDeprecated())
.toString();
- LOGGER.warn(message);
+ logger.warn(message);
}
}
diff --git a/maven-core/src/main/java/org/apache/maven/plugin/internal/ReadOnlyPluginParametersValidator.java b/maven-core/src/main/java/org/apache/maven/plugin/internal/ReadOnlyPluginParametersValidator.java
index 45f76992f..6c1555079 100644
--- a/maven-core/src/main/java/org/apache/maven/plugin/internal/ReadOnlyPluginParametersValidator.java
+++ b/maven-core/src/main/java/org/apache/maven/plugin/internal/ReadOnlyPluginParametersValidator.java
@@ -25,8 +25,6 @@ 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 a plugin are used in configuration.
@@ -35,28 +33,17 @@ import org.slf4j.LoggerFactory;
*/
@Named
@Singleton
-public class ReadOnlyPluginParametersValidator extends AbstractMavenPluginParametersValidator {
- private static final Logger LOGGER = LoggerFactory.getLogger(ReadOnlyPluginParametersValidator.class);
-
- @Override
- protected Logger getLogger() {
- return LOGGER;
- }
-
+class ReadOnlyPluginParametersValidator extends AbstractMavenPluginDescriptorSourcedParametersValidator {
@Override
protected String getParameterLogReason(Parameter parameter) {
return "is read-only, must not be used in configuration";
}
@Override
- public void validate(
+ protected void doValidate(
MojoDescriptor mojoDescriptor,
PlexusConfiguration pomConfiguration,
ExpressionEvaluator expressionEvaluator) {
- if (!LOGGER.isWarnEnabled()) {
- return;
- }
-
if (mojoDescriptor.getParameters() == null) {
return;
}
@@ -66,7 +53,7 @@ public class ReadOnlyPluginParametersValidator extends AbstractMavenPluginParame
.forEach(parameter -> checkParameter(parameter, pomConfiguration, expressionEvaluator));
}
- protected void checkParameter(
+ private void checkParameter(
Parameter parameter, PlexusConfiguration pomConfiguration, ExpressionEvaluator expressionEvaluator) {
PlexusConfiguration config = pomConfiguration.getChild(parameter.getName(), false);