org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter 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
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
/*
* Copyright 2010 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.internal.tasks.execution;
import com.google.common.collect.ImmutableSortedMap;
import com.google.common.collect.Lists;
import org.gradle.api.execution.TaskActionListener;
import org.gradle.api.internal.OverlappingOutputs;
import org.gradle.api.internal.TaskInternal;
import org.gradle.api.internal.tasks.CacheableTaskOutputFilePropertySpec;
import org.gradle.api.internal.tasks.ContextAwareTaskAction;
import org.gradle.api.internal.tasks.TaskExecuter;
import org.gradle.api.internal.tasks.TaskExecuterResult;
import org.gradle.api.internal.tasks.TaskExecutionContext;
import org.gradle.api.internal.tasks.TaskExecutionOutcome;
import org.gradle.api.internal.tasks.TaskOutputFilePropertySpec;
import org.gradle.api.internal.tasks.TaskStateInternal;
import org.gradle.api.logging.Logger;
import org.gradle.api.logging.Logging;
import org.gradle.api.tasks.StopActionException;
import org.gradle.api.tasks.StopExecutionException;
import org.gradle.api.tasks.TaskExecutionException;
import org.gradle.caching.BuildCacheKey;
import org.gradle.caching.internal.origin.OriginMetadata;
import org.gradle.internal.UncheckedException;
import org.gradle.internal.exceptions.Contextual;
import org.gradle.internal.exceptions.DefaultMultiCauseException;
import org.gradle.internal.exceptions.MultiCauseException;
import org.gradle.internal.execution.CacheHandler;
import org.gradle.internal.execution.ExecutionException;
import org.gradle.internal.execution.ExecutionOutcome;
import org.gradle.internal.execution.UnitOfWork;
import org.gradle.internal.execution.WorkExecutor;
import org.gradle.internal.execution.history.AfterPreviousExecutionState;
import org.gradle.internal.execution.history.BeforeExecutionState;
import org.gradle.internal.execution.history.ExecutionHistoryStore;
import org.gradle.internal.execution.history.OutputFilesRepository;
import org.gradle.internal.execution.history.changes.ExecutionStateChanges;
import org.gradle.internal.execution.history.changes.OutputFileChanges;
import org.gradle.internal.execution.impl.OutputFilterUtil;
import org.gradle.internal.execution.impl.steps.UpToDateResult;
import org.gradle.internal.fingerprint.CurrentFileCollectionFingerprint;
import org.gradle.internal.fingerprint.FileCollectionFingerprint;
import org.gradle.internal.operations.BuildOperationContext;
import org.gradle.internal.operations.BuildOperationDescriptor;
import org.gradle.internal.operations.BuildOperationExecutor;
import org.gradle.internal.operations.BuildOperationRef;
import org.gradle.internal.operations.RunnableBuildOperation;
import org.gradle.internal.work.AsyncWorkTracker;
import java.io.File;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Function;
/**
* A {@link TaskExecuter} which executes the actions of a task.
*/
public class ExecuteActionsTaskExecuter implements TaskExecuter {
private static final Logger LOGGER = Logging.getLogger(ExecuteActionsTaskExecuter.class);
private final boolean buildCacheEnabled;
private final TaskFingerprinter taskFingerprinter;
private final ExecutionHistoryStore executionHistoryStore;
private final OutputFilesRepository outputFilesRepository;
private final BuildOperationExecutor buildOperationExecutor;
private final AsyncWorkTracker asyncWorkTracker;
private final TaskActionListener actionListener;
private final WorkExecutor workExecutor;
public ExecuteActionsTaskExecuter(
boolean buildCacheEnabled,
TaskFingerprinter taskFingerprinter,
ExecutionHistoryStore executionHistoryStore,
OutputFilesRepository outputFilesRepository,
BuildOperationExecutor buildOperationExecutor,
AsyncWorkTracker asyncWorkTracker,
TaskActionListener actionListener,
WorkExecutor workExecutor
) {
this.buildCacheEnabled = buildCacheEnabled;
this.taskFingerprinter = taskFingerprinter;
this.executionHistoryStore = executionHistoryStore;
this.outputFilesRepository = outputFilesRepository;
this.buildOperationExecutor = buildOperationExecutor;
this.asyncWorkTracker = asyncWorkTracker;
this.actionListener = actionListener;
this.workExecutor = workExecutor;
}
@Override
public TaskExecuterResult execute(final TaskInternal task, final TaskStateInternal state, TaskExecutionContext context) {
final UpToDateResult result = workExecutor.execute(new TaskExecution(task, context));
result.getOutcome().ifSuccessfulOrElse(
new Consumer() {
@Override
public void accept(ExecutionOutcome outcome) {
state.setOutcome(TaskExecutionOutcome.valueOf(outcome));
}
},
new Consumer() {
@Override
public void accept(Throwable failure) {
state.setOutcome(failure instanceof ExecutionException
? new TaskExecutionException(task, failure.getCause())
: new TaskExecutionException(task, failure));
}
}
);
context.setUpToDateMessages(result.getOutOfDateReasons());
return new TaskExecuterResult() {
@Override
public Optional getReusedOutputOriginMetadata() {
//noinspection RedundantTypeArguments
return result.isReused()
? Optional.of(result.getOriginMetadata())
: Optional.empty();
}
};
}
private class TaskExecution implements UnitOfWork {
private final TaskInternal task;
private final TaskExecutionContext context;
public TaskExecution(TaskInternal task, TaskExecutionContext context) {
this.task = task;
this.context = context;
}
@Override
public String getIdentity() {
return task.getPath();
}
@Override
public ExecutionOutcome execute() {
task.getState().setExecuting(true);
try {
LOGGER.debug("Executing actions for {}.", task);
actionListener.beforeActions(task);
executeActions(task, context);
return task.getState().getDidWork()
? ExecutionOutcome.EXECUTED
: ExecutionOutcome.UP_TO_DATE;
} finally {
task.getState().setExecuting(false);
actionListener.afterActions(task);
}
}
@Override
public void visitOutputProperties(OutputPropertyVisitor visitor) {
for (final TaskOutputFilePropertySpec property : context.getTaskProperties().getOutputFileProperties()) {
visitor.visitOutputProperty(property.getPropertyName(), property.getOutputType(), property.getPropertyFiles());
}
}
@Override
public void visitOutputTrees(CacheableTreeVisitor visitor) {
for (final TaskOutputFilePropertySpec property : context.getTaskProperties().getOutputFileProperties()) {
if (!(property instanceof CacheableTaskOutputFilePropertySpec)) {
throw new IllegalStateException("Non-cacheable property: " + property);
}
File cacheRoot = ((CacheableTaskOutputFilePropertySpec) property).getOutputFile();
if (cacheRoot == null) {
continue;
}
visitor.visitOutputTree(property.getPropertyName(), property.getOutputType(), cacheRoot);
}
}
@Override
public void visitLocalState(LocalStateVisitor visitor) {
for (File localStateFile : context.getTaskProperties().getLocalStateFiles()) {
visitor.visitLocalStateRoot(localStateFile);
}
}
@Override
public Optional getChangesSincePreviousExecution() {
return context.getExecutionStateChanges();
}
@Override
public Optional> getChangingOutputs() {
return Optional.empty();
}
@Override
public CacheHandler createCacheHandler() {
return new CacheHandler() {
@Override
public Optional load(Function loader) {
// TODO Log this when creating the build cache key perhaps?
if (task.isHasCustomActions()) {
LOGGER.info("Custom actions are attached to {}.", task);
}
if (buildCacheEnabled
&& context.isTaskCachingEnabled()
&& context.getTaskExecutionMode().isAllowedToUseCachedResults()
&& context.getBuildCacheKey().isValid()
) {
return Optional.ofNullable(loader.apply(context.getBuildCacheKey()));
} else {
return Optional.empty();
}
}
@Override
public void store(Consumer storer) {
if (buildCacheEnabled
&& context.isTaskCachingEnabled()
&& context.getBuildCacheKey().isValid()
) {
storer.accept(context.getBuildCacheKey());
}
}
};
}
@Override
public void outputsRemovedAfterFailureToLoadFromCache() {
context.setOutputRemovedBeforeExecution(true);
}
@Override
public Optional getTimeout() {
return Optional.ofNullable(task.getTimeout().getOrNull());
}
@Override
public ImmutableSortedMap snapshotAfterOutputsGenerated() {
final AfterPreviousExecutionState afterPreviousExecutionState = context.getAfterPreviousExecution();
final ImmutableSortedMap outputsAfterExecution = taskFingerprinter.fingerprintTaskFiles(task, context.getTaskProperties().getOutputFileProperties());
return context.getOverlappingOutputs()
.map(new Function>() {
@Override
public ImmutableSortedMap apply(OverlappingOutputs overlappingOutputs) {
return OutputFilterUtil.filterOutputFingerprints(
afterPreviousExecutionState == null ? null : afterPreviousExecutionState.getOutputFileProperties(),
context.getOutputFilesBeforeExecution(),
outputsAfterExecution
);
}
}).orElse(outputsAfterExecution);
}
@Override
public void persistResult(final ImmutableSortedMap finalOutputs, final boolean successful, final OriginMetadata originMetadata) {
AfterPreviousExecutionState afterPreviousExecutionState = context.getAfterPreviousExecution();
// Only persist history if there was no failure, or some output files have been changed
if (successful || afterPreviousExecutionState == null || hasAnyOutputFileChanges(afterPreviousExecutionState.getOutputFileProperties(), finalOutputs)) {
context.getBeforeExecutionState().ifPresent(new Consumer() {
@Override
public void accept(BeforeExecutionState execution) {
executionHistoryStore.store(
task.getPath(),
originMetadata,
execution.getImplementation(),
execution.getAdditionalImplementations(),
execution.getInputProperties(),
execution.getInputFileProperties(),
finalOutputs,
successful
);
outputFilesRepository.recordOutputs(finalOutputs.values());
}
});
}
}
private boolean hasAnyOutputFileChanges(ImmutableSortedMap previous, ImmutableSortedMap current) {
return !previous.keySet().equals(current.keySet())
|| new OutputFileChanges(previous, current).hasAnyChanges();
}
@Override
public long markExecutionTime() {
return context.markExecutionTime();
}
@Override
public String getDisplayName() {
return task.toString();
}
}
private void executeActions(TaskInternal task, TaskExecutionContext context) {
for (ContextAwareTaskAction action : new ArrayList(task.getTaskActions())) {
task.getState().setDidWork(true);
task.getStandardOutputCapture().start();
try {
executeAction(action.getDisplayName(), task, action, context);
} catch (StopActionException e) {
// Ignore
LOGGER.debug("Action stopped by some action with message: {}", e.getMessage());
} catch (StopExecutionException e) {
LOGGER.info("Execution stopped by some action with message: {}", e.getMessage());
break;
} finally {
task.getStandardOutputCapture().stop();
}
}
}
private void executeAction(final String actionDisplayName, final TaskInternal task, final ContextAwareTaskAction action, TaskExecutionContext context) {
action.contextualise(context);
buildOperationExecutor.run(new RunnableBuildOperation() {
@Override
public BuildOperationDescriptor.Builder description() {
return BuildOperationDescriptor.displayName(actionDisplayName + " for " + task.getIdentityPath().getPath()).name(actionDisplayName);
}
@Override
public void run(BuildOperationContext context) {
BuildOperationRef currentOperation = buildOperationExecutor.getCurrentOperation();
Throwable actionFailure = null;
try {
action.execute(task);
} catch (Throwable t) {
actionFailure = t;
} finally {
action.releaseContext();
}
try {
asyncWorkTracker.waitForCompletion(currentOperation, true);
} catch (Throwable t) {
List failures = Lists.newArrayList();
if (actionFailure != null) {
failures.add(actionFailure);
}
if (t instanceof MultiCauseException) {
failures.addAll(((MultiCauseException) t).getCauses());
} else {
failures.add(t);
}
if (failures.size() > 1) {
throw new MultipleTaskActionFailures("Multiple task action failures occurred:", failures);
} else {
throw UncheckedException.throwAsUncheckedException(failures.get(0));
}
}
if (actionFailure != null) {
throw UncheckedException.throwAsUncheckedException(actionFailure);
}
}
});
}
@Contextual
private static class MultipleTaskActionFailures extends DefaultMultiCauseException {
public MultipleTaskActionFailures(String message, Iterable causes) {
super(message, causes);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy