org.gradle.api.tasks.diagnostics.ResolutionErrorRenderer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
There is a newer version: 8.11.1
/*
 * Copyright 2018 the original author or authors.
 *
 * Licensed 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.gradle.api.tasks.diagnostics;

import com.google.common.collect.Lists;
import org.gradle.api.Action;
import org.gradle.api.artifacts.ModuleVersionIdentifier;
import org.gradle.api.artifacts.ResolveException;
import org.gradle.api.artifacts.component.ComponentSelector;
import org.gradle.api.artifacts.result.DependencyResult;
import org.gradle.api.artifacts.result.ResolvedComponentResult;
import org.gradle.api.internal.artifacts.ivyservice.resolveengine.graph.conflicts.VersionConflictException;
import org.gradle.api.specs.Spec;
import org.gradle.internal.UncheckedException;
import org.gradle.internal.component.external.model.DefaultModuleComponentSelector;
import org.gradle.internal.locking.LockOutOfDateException;
import org.gradle.internal.logging.text.StyledTextOutput;

import java.util.List;

class ResolutionErrorRenderer implements Action {
    private final Spec dependencySpec;
    private final List> errorActions = Lists.newArrayListWithExpectedSize(1);

    public ResolutionErrorRenderer(Spec dependencySpec) {
        this.dependencySpec = dependencySpec;
    }

    @Override
    public void execute(Throwable throwable) {
        if (throwable instanceof ResolveException) {
            Throwable cause = throwable.getCause();
            handleResolutionError(cause);
        } else {
            throw UncheckedException.throwAsUncheckedException(throwable);
        }
    }

    private void handleResolutionError(Throwable cause) {
        if (cause instanceof VersionConflictException) {
            handleConflict((VersionConflictException) cause);
        } else if (cause instanceof LockOutOfDateException) {
            handleOutOfDateLocks((LockOutOfDateException) cause);
        } else {
            // Fallback to failing the task in case we don't know anything special
            // about the error
            throw UncheckedException.throwAsUncheckedException(cause);
        }
    }

    private void handleOutOfDateLocks(final LockOutOfDateException cause) {
        registerError(new Action() {
            @Override
            public void execute(StyledTextOutput output) {
                List errors = cause.getErrors();
                output.text("The dependency locks are out-of-date:");
                output.println();
                for (String error : errors) {
                    output.text("   - " + error);
                    output.println();
                }
                output.println();
            }
        });
    }

    private void handleConflict(final VersionConflictException conflict) {
        registerError(new Action() {
            @Override
            public void execute(StyledTextOutput output) {
                for (List moduleVersionIdentifiers : conflict.getConflicts()) {
                    boolean matchesSpec = hasVersionConflictOnRequestedDependency(moduleVersionIdentifiers);
                    if (!matchesSpec) {
                        continue;
                    }
                    output.text("Dependency resolution failed because of conflicts between the following modules:");
                    output.println();
                    for (ModuleVersionIdentifier moduleVersionIdentifier : moduleVersionIdentifiers) {
                        output.text("   - ");
                        output.withStyle(StyledTextOutput.Style.Error).text(moduleVersionIdentifier.toString());
                        output.println();
                    }
                    output.println();
                }
            }
        });

    }

    public void renderErrors(StyledTextOutput output) {
        for (Action errorAction : errorActions) {
            errorAction.execute(output);
        }
    }

    private void registerError(Action errorAction) {
        errorActions.add(errorAction);
    }

    private boolean hasVersionConflictOnRequestedDependency(List moduleVersionIdentifiers) {
        boolean matchesSpec = false;
        for (final ModuleVersionIdentifier mvi : moduleVersionIdentifiers) {
            matchesSpec |= dependencySpec.isSatisfiedBy(new DependencyResult() {
                @Override
                public ComponentSelector getRequested() {
                    return DefaultModuleComponentSelector.newSelector(mvi.getModule(), mvi.getVersion());
                }

                @Override
                public ResolvedComponentResult getFrom() {
                    return null;
                }

                @Override
                public boolean isConstraint() {
                    return false;
                }
            });
        }
        return matchesSpec;
    }

}