org.gradle.execution.plan.DefaultNodeValidator 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 2020 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.execution.plan;

import org.gradle.api.internal.GeneratedSubclasses;
import org.gradle.internal.deprecation.DeprecationLogger;
import org.gradle.internal.execution.WorkValidationContext;
import org.gradle.internal.reflect.validation.TypeValidationContext;
import org.gradle.internal.reflect.validation.TypeValidationProblem;
import org.gradle.internal.reflect.validation.UserManualReference;

import java.util.List;
import java.util.Optional;

import static org.gradle.internal.reflect.validation.TypeValidationProblemRenderer.convertToSingleLine;
import static org.gradle.internal.reflect.validation.TypeValidationProblemRenderer.renderMinimalInformationAbout;

public class DefaultNodeValidator implements NodeValidator {
    @Override
    public boolean hasValidationProblems(Node node) {
        if (node instanceof LocalTaskNode) {
            LocalTaskNode taskNode = (LocalTaskNode) node;
            WorkValidationContext validationContext = taskNode.getValidationContext();
            Class taskType = GeneratedSubclasses.unpackType(taskNode.getTask());
            // We don't know whether the task is cacheable or not, so we ignore cacheability problems for scheduling
            TypeValidationContext taskValidationContext = validationContext.forType(taskType, false);
            taskNode.getTaskProperties().validateType(taskValidationContext);
            List problems = validationContext.getProblems();
            problems.stream()
                .filter(problem -> problem.getSeverity().isWarning())
                .forEach(problem -> {
                    Optional userManualReference = problem.getUserManualReference();
                    String docId = "more_about_tasks";
                    String section = "sec:up_to_date_checks";
                    if (userManualReference.isPresent()) {
                        UserManualReference docref = userManualReference.get();
                        docId = docref.getId();
                        section = docref.getSection();
                    }
                    // Because our deprecation warning system doesn't support multiline strings (bummer!) both in rendering
                    // **and** testing (no way to capture multiline deprecation warnings), we have to resort to removing details
                    // and rendering
                    String warning = convertToSingleLine(renderMinimalInformationAbout(problem, false, false));
                    DeprecationLogger.deprecateBehaviour(warning)
                        .withContext("Execution optimizations are disabled to ensure correctness.")
                        .willBeRemovedInGradle8()
                        .withUserManual(docId, section)
                        .nagUser();
                });
            return !problems.isEmpty();
        } else {
            return false;
        }
    }
}