Skip to content

In failed build limit reactor summary to only failed modules #12330

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

Open
slawekjaranowski wants to merge 1 commit into
base: master
Choose a base branch
from
Open

In failed build limit reactor summary to only failed modules #12330

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
69 changes: 45 additions & 24 deletions compat/maven-embedder/src/main/java/org/apache/maven/cli/event/ExecutionEventLogger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,34 @@ private void logReactorSummary(MavenSession session) {

StringBuilder buffer = new StringBuilder(128);

String skippedMessage = builder().warning("SKIPPED").build();
String successMessage = builder().success("SUCCESS").build();
String failureMessage = builder().failure("FAILURE").build();
String unknownMessage = builder().warning("UNKNOWN").build();

for (MavenProject project : projects) {
BuildSummary buildSummary = result.getBuildSummary(project);

String statusMessage;
boolean shouldSkip = result.hasExceptions();
if (buildSummary == null) {
statusMessage = skippedMessage;
} else if (buildSummary instanceof BuildSuccess) {
statusMessage = successMessage;
} else if (buildSummary instanceof BuildFailure) {
statusMessage = failureMessage;
shouldSkip = false;
} else {
statusMessage = unknownMessage;
}

if (shouldSkip) {
if (project.isExecutionRoot()) {
logger.info("...");
}
continue;
}

buffer.append(project.getName());
buffer.append(' ');

Expand All @@ -217,35 +244,29 @@ private void logReactorSummary(MavenSession session) {
buffer.append(' ');
}

BuildSummary buildSummary = result.getBuildSummary(project);

if (buildSummary == null) {
buffer.append(builder().warning("SKIPPED"));
} else if (buildSummary instanceof BuildSuccess) {
buffer.append(builder().success("SUCCESS"));
buffer.append(" [");
String buildTimeDuration = formatDuration(buildSummary.getTime());
int padSize = MAX_PADDED_BUILD_TIME_DURATION_LENGTH - buildTimeDuration.length();
if (padSize > 0) {
buffer.append(chars(' ', padSize));
}
buffer.append(buildTimeDuration);
buffer.append(']');
} else if (buildSummary instanceof BuildFailure) {
buffer.append(builder().failure("FAILURE"));
buffer.append(" [");
String buildTimeDuration = formatDuration(buildSummary.getTime());
int padSize = MAX_PADDED_BUILD_TIME_DURATION_LENGTH - buildTimeDuration.length();
if (padSize > 0) {
buffer.append(chars(' ', padSize));
}
buffer.append(buildTimeDuration);
buffer.append(']');
buffer.append(statusMessage);
if (buildSummary != null) {
formatBuildTime(buffer, buildSummary);
}

logger.info(buffer.toString());
buffer.setLength(0);
}

if (result.hasExceptions()) {
logger.info("...");
}
}

private void formatBuildTime(StringBuilder buffer, BuildSummary buildSummary) {
buffer.append(" [");
String buildTimeDuration = formatDuration(buildSummary.getTime());
int padSize = MAX_PADDED_BUILD_TIME_DURATION_LENGTH - buildTimeDuration.length();
if (padSize > 0) {
buffer.append(chars(' ', padSize));
}
buffer.append(buildTimeDuration);
buffer.append(']');
}

private void logResult(MavenSession session) {
Expand Down
171 changes: 152 additions & 19 deletions compat/maven-embedder/src/test/java/org/apache/maven/cli/event/ExecutionEventLoggerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,33 +19,49 @@
package org.apache.maven.cli.event;

import java.io.File;
import java.util.Arrays;
import java.util.List;

import org.apache.maven.execution.BuildFailure;
import org.apache.maven.execution.BuildSuccess;
import org.apache.maven.execution.DefaultMavenExecutionRequest;
import org.apache.maven.execution.DefaultMavenExecutionResult;
import org.apache.maven.execution.ExecutionEvent;
import org.apache.maven.execution.MavenExecutionRequest;
import org.apache.maven.execution.MavenExecutionResult;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.execution.ProjectDependencyGraph;
import org.apache.maven.jline.JLineMessageBuilderFactory;
import org.apache.maven.jline.MessageUtils;
import org.apache.maven.project.MavenProject;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.InOrder;
import org.mockito.Mockito;
import org.mockito.MockitoSession;
import org.slf4j.Logger;

import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.matches;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.lenient;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

@Deprecated
class ExecutionEventLoggerTest {

private MockitoSession mockitoSession;

private Logger logger;
private ExecutionEventLogger executionEventLogger;
private JLineMessageBuilderFactory messageBuilderFactory = new JLineMessageBuilderFactory();
private final JLineMessageBuilderFactory messageBuilderFactory = new JLineMessageBuilderFactory();

@BeforeAll
static void setUp() {
Expand All @@ -59,11 +75,17 @@ static void tearDown() {

@BeforeEach
void beforeEach() {
mockitoSession = Mockito.mockitoSession().startMocking();
logger = mock(Logger.class);
when(logger.isInfoEnabled()).thenReturn(true);
executionEventLogger = new ExecutionEventLogger(messageBuilderFactory, logger);
}

@AfterEach
void afterEach() {
mockitoSession.finishMocking();
}

@Test
void testProjectStarted() {
// prepare
Expand All @@ -78,10 +100,7 @@ void testProjectStarted() {
when(project.getFile()).thenReturn(new File(basedir, "maven-embedder/pom.xml"));
when(event.getProject()).thenReturn(project);

MavenProject rootProject = mock(MavenProject.class);
when(rootProject.getBasedir()).thenReturn(basedir);
MavenSession session = mock(MavenSession.class);
when(session.getTopLevelProject()).thenReturn(rootProject);
when(session.getTopDirectory()).thenReturn(basedir.toPath());
when(event.getSession()).thenReturn(session);

Expand Down Expand Up @@ -110,10 +129,8 @@ void testProjectStartedOverflow() {
when(project.getVersion()).thenReturn("3.0.0-SNAPSHOT");
when(event.getProject()).thenReturn(project);
when(project.getFile()).thenReturn(new File(basedir, "pom.xml"));
when(project.getBasedir()).thenReturn(basedir);

MavenSession session = mock(MavenSession.class);
when(session.getTopLevelProject()).thenReturn(project);
when(event.getSession()).thenReturn(session);
when(session.getTopDirectory()).thenReturn(basedir.toPath());

Expand All @@ -132,9 +149,6 @@ void testProjectStartedOverflow() {
@Test
void testTerminalWidth() {
// prepare
Logger logger = mock(Logger.class);
when(logger.isInfoEnabled()).thenReturn(true);

ExecutionEvent event = mock(ExecutionEvent.class);
MavenProject project = mock(MavenProject.class);
when(project.getGroupId()).thenReturn("org.apache.maven.plugins.overflow");
Expand All @@ -146,33 +160,32 @@ void testTerminalWidth() {

// default width
new ExecutionEventLogger(messageBuilderFactory, logger, -1).projectStarted(event);
Mockito.verify(logger).info("----------------------------[ maven-plugin ]----------------------------");
verify(logger).info("----------------------------[ maven-plugin ]----------------------------");

// terminal width: 30
new ExecutionEventLogger(messageBuilderFactory, logger, 30).projectStarted(event);
Mockito.verify(logger).info("------------------[ maven-plugin ]------------------");
verify(logger).info("------------------[ maven-plugin ]------------------");

// terminal width: 70
new ExecutionEventLogger(messageBuilderFactory, logger, 70).projectStarted(event);
Mockito.verify(logger).info("-----------------------[ maven-plugin ]-----------------------");
verify(logger).info("-----------------------[ maven-plugin ]-----------------------");

// terminal width: 110
new ExecutionEventLogger(messageBuilderFactory, logger, 110).projectStarted(event);
Mockito.verify(logger)
verify(logger)
.info(
"-------------------------------------------[ maven-plugin ]-------------------------------------------");

// terminal width: 200
new ExecutionEventLogger(messageBuilderFactory, logger, 200).projectStarted(event);
Mockito.verify(logger)
verify(logger)
.info(
"-----------------------------------------------------[ maven-plugin ]-----------------------------------------------------");
}

@Test
void testProjectStartedNoPom() {
// prepare
File basedir = new File("").getAbsoluteFile();
ExecutionEvent event = mock(ExecutionEvent.class);
MavenProject project = mock(MavenProject.class);
when(project.getGroupId()).thenReturn("org.apache.maven");
Expand All @@ -182,7 +195,6 @@ void testProjectStartedNoPom() {
when(project.getVersion()).thenReturn("1");
when(event.getProject()).thenReturn(project);
when(project.getFile()).thenReturn(null);
when(project.getBasedir()).thenReturn(basedir);

// execute
executionEventLogger.projectStarted(event);
Expand Down Expand Up @@ -258,11 +270,132 @@ void testMultiModuleProjectResumeFromProgress() {
inOrder.verify(logger).info(matches(".*Apache Maven Embedder 3.*\\[3\\/3\\]"));
}

@Test
public void testSessionEndedSingleProject() {
// prepare
MavenExecutionResult executionResult = new DefaultMavenExecutionResult();

MavenExecutionRequest executionRequest = new DefaultMavenExecutionRequest();

MavenSession mavenSession = mock(MavenSession.class);
when(mavenSession.getResult()).thenReturn(executionResult);
when(mavenSession.getRequest()).thenReturn(executionRequest);

ExecutionEvent event = mock(ExecutionEvent.class);
when(event.getSession()).thenReturn(mavenSession);

// execute
executionEventLogger.sessionEnded(event);

// verify
InOrder inOrder = inOrder(logger);
inOrder.verify(logger).info("------------------------------------------------------------------------");
inOrder.verify(logger).info("BUILD SUCCESS");
inOrder.verify(logger).info("------------------------------------------------------------------------");
inOrder.verify(logger).info(eq("Total time: {}{}"), anyString(), anyString());
inOrder.verify(logger).info(eq("Finished at: {}"), anyString());
inOrder.verify(logger).info("------------------------------------------------------------------------");
}

@Test
public void testSessionEndedSuccessMultimodule() {
// prepare
MavenProject project1 = generateMavenProject("Maven Project artifact1");
MavenProject project2 = generateMavenProject("Maven Project artifact2");
MavenProject project3 = generateMavenProject("Maven Project artifact3");

MavenExecutionResult executionResult = new DefaultMavenExecutionResult();
executionResult.addBuildSummary(new BuildSuccess(project1, 1000));
executionResult.addBuildSummary(new BuildSuccess(project2, 2000));
executionResult.addBuildSummary(new BuildSuccess(project3, 3000));

MavenExecutionRequest executionRequest = new DefaultMavenExecutionRequest();

ProjectDependencyGraph projectDependencyGraph = mock(ProjectDependencyGraph.class);
when(projectDependencyGraph.getSortedProjects()).thenReturn(Arrays.asList(project1, project2, project3));

MavenSession mavenSession = mock(MavenSession.class);
when(mavenSession.getResult()).thenReturn(executionResult);
when(mavenSession.getRequest()).thenReturn(executionRequest);
when(mavenSession.getProjects()).thenReturn(Arrays.asList(project1, project2, project3));
when(mavenSession.getTopLevelProject()).thenReturn(project1);
when(mavenSession.getProjectDependencyGraph()).thenReturn(projectDependencyGraph);

ExecutionEvent event = mock(ExecutionEvent.class);
when(event.getSession()).thenReturn(mavenSession);

// execute
executionEventLogger.sessionEnded(event);

// verify
InOrder inOrder = inOrder(logger);
inOrder.verify(logger).info("------------------------------------------------------------------------");
inOrder.verify(logger).info("Reactor Summary for Maven Project artifact1 3.5.4-SNAPSHOT:");
inOrder.verify(logger).info("");
inOrder.verify(logger).info("Maven Project artifact1 ............................ SUCCESS [ 1.000 s]");
inOrder.verify(logger).info("Maven Project artifact2 ............................ SUCCESS [ 2.000 s]");
inOrder.verify(logger).info("Maven Project artifact3 ............................ SUCCESS [ 3.000 s]");
inOrder.verify(logger).info("------------------------------------------------------------------------");
inOrder.verify(logger).info("BUILD SUCCESS");
inOrder.verify(logger).info("------------------------------------------------------------------------");
inOrder.verify(logger).info(eq("Total time: {}{}"), anyString(), anyString());
inOrder.verify(logger).info(eq("Finished at: {}"), anyString());
inOrder.verify(logger).info("------------------------------------------------------------------------");
}

@Test
public void testSessionEndedFailureMultimodule() {
// prepare
MavenProject project1 = generateMavenProject("Maven Project artifact1");
when(project1.isExecutionRoot()).thenReturn(true);

MavenProject project2 = generateMavenProject("Maven Project artifact2");
MavenProject project3 = generateMavenProject("Maven Project artifact3");

MavenExecutionResult executionResult = new DefaultMavenExecutionResult();
executionResult.addBuildSummary(new BuildSuccess(project1, 1000));
executionResult.addBuildSummary(new BuildFailure(project2, 2000, new Exception("Failure")));
executionResult.addException(new Exception("Failure"));

MavenExecutionRequest executionRequest = new DefaultMavenExecutionRequest();

ProjectDependencyGraph projectDependencyGraph = mock(ProjectDependencyGraph.class);
when(projectDependencyGraph.getSortedProjects()).thenReturn(Arrays.asList(project1, project2, project3));

MavenSession mavenSession = mock(MavenSession.class);
when(mavenSession.getResult()).thenReturn(executionResult);
when(mavenSession.getRequest()).thenReturn(executionRequest);
when(mavenSession.getProjects()).thenReturn(Arrays.asList(project1, project2, project3));
when(mavenSession.getTopLevelProject()).thenReturn(project1);
when(mavenSession.getProjectDependencyGraph()).thenReturn(projectDependencyGraph);

ExecutionEvent event = mock(ExecutionEvent.class);
when(event.getSession()).thenReturn(mavenSession);

// execute
executionEventLogger.sessionEnded(event);

// verify
InOrder inOrder = inOrder(logger);
inOrder.verify(logger).info("------------------------------------------------------------------------");
inOrder.verify(logger).info("Reactor Summary for Maven Project artifact1 3.5.4-SNAPSHOT:");
inOrder.verify(logger).info("");
inOrder.verify(logger).info("...");
inOrder.verify(logger).info("Maven Project artifact2 ............................ FAILURE [ 2.000 s]");
inOrder.verify(logger).info("...");
inOrder.verify(logger).info("------------------------------------------------------------------------");
inOrder.verify(logger).info("BUILD FAILURE");
inOrder.verify(logger).info("------------------------------------------------------------------------");
inOrder.verify(logger).info(eq("Total time: {}{}"), anyString(), anyString());
inOrder.verify(logger).info(eq("Finished at: {}"), anyString());
inOrder.verify(logger).info("------------------------------------------------------------------------");
}

private static MavenProject generateMavenProject(String projectName) {
MavenProject project = mock(MavenProject.class);
when(project.getPackaging()).thenReturn("jar");
when(project.getVersion()).thenReturn("3.5.4-SNAPSHOT");
when(project.getName()).thenReturn(projectName);
lenient().when(project.getPackaging()).thenReturn("jar");
lenient().when(project.getVersion()).thenReturn("3.5.4-SNAPSHOT");
lenient().when(project.getName()).thenReturn(projectName);
return project;
}

Expand Down
Loading
Loading