View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.plugin.internal;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  import javax.inject.Singleton;
24  
25  import java.util.Set;
26  import java.util.stream.Collectors;
27  
28  import org.apache.maven.execution.MavenSession;
29  import org.apache.maven.plugin.PluginValidationManager;
30  import org.apache.maven.plugin.descriptor.MojoDescriptor;
31  
32  /**
33   * Detects Maven3 artifacts in bad scope in plugins.
34   *
35   * @since 3.9.2
36   */
37  @Singleton
38  @Named
39  class MavenScopeDependenciesValidator extends AbstractMavenPluginDependenciesValidator {
40  
41      @Inject
42      MavenScopeDependenciesValidator(PluginValidationManager pluginValidationManager) {
43          super(pluginValidationManager);
44      }
45  
46      @Override
47      protected void doValidate(MavenSession mavenSession, MojoDescriptor mojoDescriptor) {
48          Set<String> mavenArtifacts = mojoDescriptor.getPluginDescriptor().getDependencies().stream()
49                  .filter(d -> "org.apache.maven".equals(d.getGroupId()))
50                  .filter(d -> !expectedProvidedScopeExclusions.contains(d.getGroupId() + ":" + d.getArtifactId()))
51                  .filter(d -> d.getVersion().startsWith("3."))
52                  .map(d -> d.getGroupId() + ":" + d.getArtifactId() + ":" + d.getVersion())
53                  .collect(Collectors.toSet());
54  
55          if (!mavenArtifacts.isEmpty()) {
56              pluginValidationManager.reportPluginValidationIssue(
57                      mavenSession,
58                      mojoDescriptor,
59                      "Plugin should declare these Maven artifacts in `provided` scope: " + mavenArtifacts);
60          }
61      }
62  }