Skip to content

[MBUILDCACHE-66] Mojo need some values seed in scope #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 2, 2023
Merged

[MBUILDCACHE-66] Mojo need some values seed in scope #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ under the License.

<groupId>org.apache.maven.extensions</groupId>
<artifactId>maven-build-cache-extension</artifactId>
<version>1.0.2-SNAPSHOT</version>
<version>1.1.0-SNAPSHOT</version>
<packaging>jar</packaging>

<name>Apache Maven Build Cache Extension</name>
Expand Down
192 changes: 110 additions & 82 deletions src/main/java/org/apache/maven/buildcache/BuildCacheMojosExecutionStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,13 @@
import org.apache.maven.buildcache.xml.config.TrackedProperty;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.execution.MojoExecutionEvent;
import org.apache.maven.execution.scope.internal.MojoExecutionScope;
import org.apache.maven.lifecycle.LifecycleExecutionException;
import org.apache.maven.plugin.MavenPluginManager;
import org.apache.maven.plugin.Mojo;
import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.plugin.MojoExecution.Source;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoExecutionRunner;
import org.apache.maven.plugin.MojosExecutionStrategy;
import org.apache.maven.plugin.PluginConfigurationException;
Expand Down Expand Up @@ -74,73 +76,82 @@ public class BuildCacheMojosExecutionStrategy implements MojosExecutionStrategy
private final MojoParametersListener mojoListener;
private final LifecyclePhasesHelper lifecyclePhasesHelper;
private final MavenPluginManager mavenPluginManager;
private MojoExecutionScope mojoExecutionScope;

@Inject
public BuildCacheMojosExecutionStrategy(
CacheController cacheController,
CacheConfig cacheConfig,
MojoParametersListener mojoListener,
LifecyclePhasesHelper lifecyclePhasesHelper,
MavenPluginManager mavenPluginManager) {
MavenPluginManager mavenPluginManager,
MojoExecutionScope mojoExecutionScope) {
this.cacheController = cacheController;
this.cacheConfig = cacheConfig;
this.mojoListener = mojoListener;
this.lifecyclePhasesHelper = lifecyclePhasesHelper;
this.mavenPluginManager = mavenPluginManager;
this.mojoExecutionScope = mojoExecutionScope;
}

public void execute(
List<MojoExecution> mojoExecutions, MavenSession session, MojoExecutionRunner mojoExecutionRunner)
throws LifecycleExecutionException {
final MavenProject project = session.getCurrentProject();
final Source source = getSource(mojoExecutions);

// execute clean bound goals before restoring to not interfere/slowdown clean
CacheState cacheState = DISABLED;
CacheResult result = CacheResult.empty();
boolean skipCache = cacheConfig.isSkipCache() || MavenProjectInput.isSkipCache(project);
boolean cacheIsDisabled = MavenProjectInput.isCacheDisabled(project);
// Forked execution should be thought as a part of originating mojo internal implementation
// If forkedExecution is detected, it means that originating mojo is not cached so forks should rerun too
boolean forkedExecution = lifecyclePhasesHelper.isForkedProject(project);
if (source == Source.LIFECYCLE && !forkedExecution) {
List<MojoExecution> cleanPhase = lifecyclePhasesHelper.getCleanSegment(project, mojoExecutions);
for (MojoExecution mojoExecution : cleanPhase) {
mojoExecutionRunner.run(mojoExecution);
}
if (!cacheIsDisabled) {
cacheState = cacheConfig.initialize();
} else {
LOGGER.info("Cache is explicitly disabled on project level for {}", getVersionlessProjectKey(project));
}
if (cacheState == INITIALIZED || skipCache) {
result = cacheController.findCachedBuild(session, project, mojoExecutions, skipCache);
try {
final MavenProject project = session.getCurrentProject();
final Source source = getSource(mojoExecutions);

// execute clean bound goals before restoring to not interfere/slowdown clean
CacheState cacheState = DISABLED;
CacheResult result = CacheResult.empty();
boolean skipCache = cacheConfig.isSkipCache() || MavenProjectInput.isSkipCache(project);
boolean cacheIsDisabled = MavenProjectInput.isCacheDisabled(project);
// Forked execution should be thought as a part of originating mojo internal implementation
// If forkedExecution is detected, it means that originating mojo is not cached so forks should rerun too
boolean forkedExecution = lifecyclePhasesHelper.isForkedProject(project);
if (source == Source.LIFECYCLE && !forkedExecution) {
List<MojoExecution> cleanPhase = lifecyclePhasesHelper.getCleanSegment(project, mojoExecutions);
for (MojoExecution mojoExecution : cleanPhase) {
mojoExecutionRunner.run(mojoExecution);
}
if (!cacheIsDisabled) {
cacheState = cacheConfig.initialize();
} else {
LOGGER.info(
"Cache is explicitly disabled on project level for {}", getVersionlessProjectKey(project));
}
if (cacheState == INITIALIZED || skipCache) {
result = cacheController.findCachedBuild(session, project, mojoExecutions, skipCache);
}
}
}

boolean restorable = result.isSuccess() || result.isPartialSuccess();
boolean restored = result.isSuccess(); // if partially restored need to save increment
if (restorable) {
restored &= restoreProject(result, mojoExecutions, mojoExecutionRunner, cacheConfig);
} else {
for (MojoExecution mojoExecution : mojoExecutions) {
if (source == Source.CLI
|| mojoExecution.getLifecyclePhase() == null
|| lifecyclePhasesHelper.isLaterPhaseThanClean(mojoExecution.getLifecyclePhase())) {
mojoExecutionRunner.run(mojoExecution);
boolean restorable = result.isSuccess() || result.isPartialSuccess();
boolean restored = result.isSuccess(); // if partially restored need to save increment
if (restorable) {
restored &= restoreProject(result, mojoExecutions, mojoExecutionRunner, cacheConfig);
} else {
for (MojoExecution mojoExecution : mojoExecutions) {
if (source == Source.CLI
|| mojoExecution.getLifecyclePhase() == null
|| lifecyclePhasesHelper.isLaterPhaseThanClean(mojoExecution.getLifecyclePhase())) {
mojoExecutionRunner.run(mojoExecution);
}
}
}
}

if (cacheState == INITIALIZED && (!restorable || !restored)) {
final Map<String, MojoExecutionEvent> executionEvents = mojoListener.getProjectExecutions(project);
cacheController.save(result, mojoExecutions, executionEvents);
}
if (cacheState == INITIALIZED && (!restorable || !restored)) {
final Map<String, MojoExecutionEvent> executionEvents = mojoListener.getProjectExecutions(project);
cacheController.save(result, mojoExecutions, executionEvents);
}

if (cacheConfig.isFailFast() && !result.isSuccess() && !skipCache && !forkedExecution) {
throw new LifecycleExecutionException(
"Failed to restore project[" + getVersionlessProjectKey(project) + "] from cache, failing build.",
project);
if (cacheConfig.isFailFast() && !result.isSuccess() && !skipCache && !forkedExecution) {
throw new LifecycleExecutionException(
"Failed to restore project[" + getVersionlessProjectKey(project)
+ "] from cache, failing build.",
project);
}
} catch (MojoExecutionException e) {
throw new LifecycleExecutionException(e.getMessage(), e);
}
}

Expand All @@ -161,51 +172,68 @@ private boolean restoreProject(
List<MojoExecution> mojoExecutions,
MojoExecutionRunner mojoExecutionRunner,
CacheConfig cacheConfig)
throws LifecycleExecutionException {
final Build build = cacheResult.getBuildInfo();
final MavenProject project = cacheResult.getContext().getProject();
final MavenSession session = cacheResult.getContext().getSession();
final List<MojoExecution> cachedSegment =
lifecyclePhasesHelper.getCachedSegment(project, mojoExecutions, build);

boolean restored = cacheController.restoreProjectArtifacts(cacheResult);
if (!restored) {
LOGGER.info("Cannot restore project artifacts, continuing with non cached build");
return false;
}
throws LifecycleExecutionException, MojoExecutionException {
mojoExecutionScope.enter();
try {
final Build build = cacheResult.getBuildInfo();
final MavenProject project = cacheResult.getContext().getProject();
final MavenSession session = cacheResult.getContext().getSession();
mojoExecutionScope.seed(MavenProject.class, project);
mojoExecutionScope.seed(MavenSession.class, session);
final List<MojoExecution> cachedSegment =
lifecyclePhasesHelper.getCachedSegment(project, mojoExecutions, build);

boolean restored = cacheController.restoreProjectArtifacts(cacheResult);
if (!restored) {
LOGGER.info("Cannot restore project artifacts, continuing with non cached build");
return false;
}

for (MojoExecution cacheCandidate : cachedSegment) {
if (cacheController.isForcedExecution(project, cacheCandidate)) {
LOGGER.info(
"Mojo execution is forced by project property: {}",
cacheCandidate.getMojoDescriptor().getFullGoalName());
mojoExecutionRunner.run(cacheCandidate);
} else {
restored = verifyCacheConsistency(
cacheCandidate, build, project, session, mojoExecutionRunner, cacheConfig);
if (!restored) {
break;
for (MojoExecution cacheCandidate : cachedSegment) {
if (cacheController.isForcedExecution(project, cacheCandidate)) {
LOGGER.info(
"Mojo execution is forced by project property: {}",
cacheCandidate.getMojoDescriptor().getFullGoalName());
mojoExecutionScope.seed(MojoExecution.class, cacheCandidate);
// need maven 4 as minumum
// mojoExecutionScope.seed(
// org.apache.maven.api.plugin.Log.class,
// new DefaultLog(LoggerFactory.getLogger(
// cacheCandidate.getMojoDescriptor().getFullGoalName())));
// mojoExecutionScope.seed(Project.class, ((DefaultSession)
// session.getSession()).getProject(project));
// mojoExecutionScope.seed(
// org.apache.maven.api.MojoExecution.class, new DefaultMojoExecution(cacheCandidate));
mojoExecutionRunner.run(cacheCandidate);
} else {
restored = verifyCacheConsistency(
cacheCandidate, build, project, session, mojoExecutionRunner, cacheConfig);
if (!restored) {
break;
}
}
}
}

if (!restored) {
// cleanup partial state
project.getArtifact().setFile(null);
project.getArtifact().setResolved(false);
mojoListener.remove(project);
// build as usual
for (MojoExecution mojoExecution : cachedSegment) {
mojoExecutionRunner.run(mojoExecution);
if (!restored) {
// cleanup partial state
project.getArtifact().setFile(null);
project.getArtifact().setResolved(false);
mojoListener.remove(project);
// build as usual
for (MojoExecution mojoExecution : cachedSegment) {
mojoExecutionRunner.run(mojoExecution);
}
}
}

List<MojoExecution> postCachedSegment =
lifecyclePhasesHelper.getPostCachedSegment(project, mojoExecutions, build);
for (MojoExecution mojoExecution : postCachedSegment) {
mojoExecutionRunner.run(mojoExecution);
List<MojoExecution> postCachedSegment =
lifecyclePhasesHelper.getPostCachedSegment(project, mojoExecutions, build);
for (MojoExecution mojoExecution : postCachedSegment) {
mojoExecutionRunner.run(mojoExecution);
}
return restored;
} finally {
mojoExecutionScope.exit();
}
return restored;
}

private boolean verifyCacheConsistency(
Expand Down
4 changes: 3 additions & 1 deletion src/test/java/org/apache/maven/buildcache/BuildCacheMojosExecutionStrategyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import org.apache.maven.buildcache.xml.build.CompletedExecution;
import org.apache.maven.buildcache.xml.build.PropertyValue;
import org.apache.maven.buildcache.xml.config.TrackedProperty;
import org.apache.maven.execution.scope.internal.MojoExecutionScope;
import org.apache.maven.plugin.MavenPluginManager;
import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.project.MavenProject;
Expand Down Expand Up @@ -62,7 +63,8 @@ void setUp() {
cacheConfigMock,
mock(MojoParametersListener.class),
mock(LifecyclePhasesHelper.class),
mock(MavenPluginManager.class));
mock(MavenPluginManager.class),
mock(MojoExecutionScope.class));

projectMock = mock(MavenProject.class);
executionMock = mock(MojoExecution.class);
Expand Down