/**
* Determines if the given configuration is currently running. If any of the configurations are
* currently stuck in the queue, it is logged.
*
* @param execution Contains information about the general build, including the listener used to
* log queue blockage.
* @param configuration The configuration being checked to see if it's running.
* @param mutableWhyMap Mutable map used to track the reasons a configuration is stuck in the
* queue. This prevents duplicate reasons from flooding the logs.
* @return True if the build represented by the given configuration is currently running or stuck
* in the queue. False if the build has finished running.
*/
private boolean isBuilding(
MatrixBuild.MatrixBuildExecution execution,
MatrixConfiguration configuration,
Map<String, String> mutableWhyMap) {
MatrixRun build = configuration.getBuildByNumber(execution.getBuild().getNumber());
if (build != null) {
return build.isBuilding();
}
Queue.Item queueItem = configuration.getQueueItem();
if (queueItem != null) {
String why = queueItem.getWhy();
String key = queueItem.task.getFullDisplayName() + " " + queueItem.id;
String oldWhy = mutableWhyMap.get(key);
if (why == null) {
mutableWhyMap.remove(key);
}
if (why != null && !why.equals(oldWhy)) {
mutableWhyMap.put(key, why);
BuildListener listener = execution.getListener();
PrintStream logger = listener.getLogger();
logger.print(
"Configuration "
+ ModelHyperlinkNote.encodeTo(configuration)
+ " is still in the queue: ");
queueItem.getCauseOfBlockage().print(listener); // this is still shown on the same line
}
}
return true;
}
/**
* Checks if the logs of the given run match any of the given patterns, line-by-line.
*
* @param matrixRun The run to be considered.
* @param patterns The patterns to match with.
* @return True if at least one line of the logs match at least one of the given patterns.
* @throws IOException If there's a problem reading the log file.
*/
private boolean matchesPattern(MatrixRun matrixRun, List<Pattern> patterns) throws IOException {
if (patterns == null || patterns.isEmpty()) {
return true; // No specific patterns specified. Accept everything.
}
BufferedReader reader =
new BufferedReader(
new InputStreamReader(
new FileInputStream(matrixRun.getLogFile()), matrixRun.getCharset()));
try {
for (String line = reader.readLine(); line != null; line = reader.readLine()) {
for (Pattern pattern : patterns) {
Matcher matcher = pattern.matcher(line);
if (matcher.find()) {
return true;
}
}
}
} finally {
reader.close();
}
return false;
}
/**
* Waits for the given configurations to finish, retrying any that qualify to be rerun.
*
* @param execution Provided by the plugin.
* @param patterns List of regular expression patterns used to scan the log to determine if a
* build should be rerun.
* @param retries Mutable map that tracks the number of times a specific configuration has been
* retried.
* @param configurations The configurations that have already been scheduled to run that should be
* waited for to finish.
* @return The worst result of all the runs. If a build was rerun, only the result of the rerun is
* considered.
* @throws InterruptedException
* @throws IOException
*/
private Result waitForMatrixRuns(
MatrixBuild.MatrixBuildExecution execution,
List<Pattern> patterns,
Map<MatrixConfiguration, Integer> retries,
LinkedList<MatrixConfiguration> configurations)
throws InterruptedException, IOException {
BuildListener listener = execution.getListener();
PrintStream logger = listener.getLogger();
Map<String, String> whyBlockedMap =
new HashMap<
String,
String>(); // keep track of why builds are blocked so we can print unique messages when
// they change.
Result finalResult = Result.SUCCESS;
int iteration = 0;
boolean continueRetrying = true;
while (!configurations.isEmpty()) {
++iteration;
MatrixConfiguration configuration = configurations.removeFirst();
if (isBuilding(execution, configuration, whyBlockedMap)) {
if (iteration >= configurations.size()) {
// Every time we loop through all the configurations, sleep for a bit.
// This is to prevent polling too often while everything is still building.
iteration = 0;
Thread.sleep(1000);
}
configurations.add(configuration);
continue;
}
Run parentBuild = execution.getBuild();
MatrixRun matrixRun = configuration.getBuildByNumber(parentBuild.getNumber());
Result runResult = matrixRun.getResult();
if (continueRetrying
&& runResult.isWorseOrEqualTo(getWorseThanOrEqualTo())
&& runResult.isBetterOrEqualTo(getBetterThanOrEqualTo())) {
if (matchesPattern(matrixRun, patterns)) {
int retriedCount = retries.get(configuration);
if (retriedCount < getMaxRetries()) {
++retriedCount;
retries.put(configuration, retriedCount);
// rerun
String logMessage =
String.format(
"%s was %s. Matched pattern to rerun. Rerunning (%d).",
matrixRun, runResult, retriedCount);
listener.error(logMessage);
HealedAction action = parentBuild.getAction(HealedAction.class);
if (action == null) {
//noinspection SynchronizationOnLocalVariableOrMethodParameter
synchronized (parentBuild.getActions()) {
action = parentBuild.getAction(HealedAction.class);
if (action == null) {
action = new HealedAction(matrixRun.getCharset());
parentBuild.addAction(action);
}
}
}
action.addAutoHealedJob(matrixRun);
MatrixConfiguration parent = matrixRun.getParent();
if (parent != null) {
// I'm paranoid about NPEs
parent.removeRun(matrixRun);
matrixRun.delete();
} else {
LOGGER.severe(
"couldn't remove old run, parent was null. This is a Jenkins core bug.");
}
scheduleConfigurationBuild(
execution, configuration, new SelfHealingCause(parentBuild, retriedCount));
configurations.add(configuration);
continue;
} else {
String logMessage =
String.format(
"%s was %s. Matched pattern to rerun, but the max number of retries (%d) has been met.",
matrixRun, runResult, getMaxRetries());
listener.error(logMessage);
if (getStopRetryingAfterOneFails()) {
listener.error("Not retrying any more builds.");
continueRetrying = false;
}
}
} else {
String logMessage =
String.format(
"%s was %s. It did not match the pattern to rerun. Accepting result.",
matrixRun, runResult);
logger.println(logMessage);
}
}
notifyEndRun(matrixRun, execution.getAggregators(), execution.getListener());
finalResult = finalResult.combine(runResult);
}
return finalResult;
}