enforcer-rules/src/main/java/org/apache/maven/enforcer/rules/RequireExplicitDependencyScope.java

/*
 * 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.enforcer.rules;

import javax.inject.Inject;
import javax.inject.Named;

import java.text.ChoiceFormat;
import java.util.List;
import java.util.Objects;

import org.apache.maven.enforcer.rule.api.EnforcerLevel;
import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
import org.apache.maven.model.Dependency;
import org.apache.maven.project.MavenProject;

/**
 * Checks that all dependencies have an explicitly declared scope in the non-effective pom (i.e. without taking
 * inheritance or dependency management into account).
 */
@Named("requireExplicitDependencyScope")
public final class RequireExplicitDependencyScope extends AbstractStandardEnforcerRule {

    private final MavenProject project;

    @Inject
    public RequireExplicitDependencyScope(MavenProject project) {
        this.project = Objects.requireNonNull(project);
    }

    @Override
    public void execute() throws EnforcerRuleException {
        int numMissingDependencyScopes = 0;
        List<Dependency> dependencies = project.getOriginalModel().getDependencies(); // this is the non-effective
        // model but the original one
        // without inheritance and
        // interpolation resolved
        // check scope without considering inheritance
        for (Dependency dependency : dependencies) {
            getLog().debug("Found dependency " + dependency);
            if (dependency.getScope() == null) {
                getLog().warnOrError(() -> new StringBuilder()
                        .append("Dependency ")
                        .append(dependency.getManagementKey())
                        .append(" @ ")
                        .append(formatLocation(project, dependency.getLocation("")))
                        .append(" does not have an explicit scope defined!"));
                numMissingDependencyScopes++;
            }
        }
        if (numMissingDependencyScopes > 0) {
            ChoiceFormat scopesFormat = new ChoiceFormat("1#scope|1<scopes");
            String logCategory = getLevel() == EnforcerLevel.ERROR ? "errors" : "warnings";
            throw new EnforcerRuleException("Found " + numMissingDependencyScopes + " missing dependency "
                    + scopesFormat.format(numMissingDependencyScopes)
                    + ". Look at the " + logCategory + " emitted above for the details.");
        }
    }
}