/**
* 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;
}
/**
* Logic is more-or-less copied from {@link
* DefaultMatrixExecutionStrategyImpl#notifyStartBuild(java.util.List)}
*
* <p>Triggers the startBuild event on all aggregators. This should be called before any run is
* started.
*
* @param aggregators The aggregators to be notified.
* @param listener Listener from parent build that can be logged to.
* @return True if all aggregators return true. If any aggregator returns false, false is
* immediately returned and no new aggregators are called.
* @throws IOException
* @throws InterruptedException
*/
private boolean notifyStartBuild(List<MatrixAggregator> aggregators, BuildListener listener)
throws IOException, InterruptedException {
for (MatrixAggregator aggregator : aggregators) {
if (!aggregator.startBuild()) {
listener.error("Aggregator terminated build: " + aggregator.toString());
return false;
}
}
return true;
}
/**
* Schedules the given configuration.
*
* <p>Copied from the {@link
* DefaultMatrixExecutionStrategyImpl#scheduleConfigurationBuild(hudson.matrix.MatrixBuild.MatrixBuildExecution,
* hudson.matrix.MatrixConfiguration)}
*
* @param execution Contains information about the general build, including the listener used to
* log queue blockage.
* @param configuration The configuration to schedule.
* @param upstreamCause The cause of the build. Will either be an {@link
* hudson.model.Cause.UpstreamCause} or {@link
* com.attask.jenkins.healingmatrixproject.SelfHealingCause}.
*/
private void scheduleConfigurationBuild(
MatrixBuild.MatrixBuildExecution execution,
MatrixConfiguration configuration,
Cause.UpstreamCause upstreamCause)
throws InterruptedException {
MatrixBuild build = (MatrixBuild) execution.getBuild();
execution
.getListener()
.getLogger()
.println(Messages.MatrixBuild_Triggering(ModelHyperlinkNote.encodeTo(configuration)));
// filter the parent actions for those that can be passed to the individual jobs.
List<MatrixChildAction> childActions = Util.filter(build.getActions(), MatrixChildAction.class);
BuildListener listener = execution.getListener();
while (!configuration.scheduleBuild(childActions, upstreamCause)) {
String msg = "Unable to schedule build " + configuration.getFullDisplayName() + ". Retrying.";
listener.error(msg);
Thread.sleep(500);
}
}
/**
* Logic is copied from {@link
* DefaultMatrixExecutionStrategyImpl#notifyEndBuild(hudson.matrix.MatrixRun, java.util.List)}
*/
private void notifyEndRun(
MatrixRun run, List<MatrixAggregator> aggregators, BuildListener listener)
throws InterruptedException, IOException {
if (run == null)
return; // can happen if the configuration run gets cancelled before it gets started.
for (MatrixAggregator aggregator : aggregators) {
if (!aggregator.endRun(run)) {
listener.error("Aggregator terminated build: " + aggregator.toString());
throw new AbortException();
}
}
}
protected static String resolveParametersInString(
AbstractBuild<?, ?> build, BuildListener listener, String input) {
try {
return build.getEnvironment(listener).expand(input);
} catch (Exception e) {
listener
.getLogger()
.println(
"Failed to resolve parameters in string \""
+ input
+ "\" due to following error:\n"
+ e.getMessage());
}
return input;
}
@Override
public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener)
throws InterruptedException {
listener.getLogger().println("[htmlpublisher] Archiving HTML reports...");
// Grab the contents of the header and footer as arrays
ArrayList<String> headerLines;
ArrayList<String> footerLines;
try {
headerLines = this.readFile("/htmlpublisher/HtmlPublisher/header.html");
footerLines = this.readFile("/htmlpublisher/HtmlPublisher/footer.html");
} catch (FileNotFoundException e1) {
e1.printStackTrace();
return false;
} catch (IOException e1) {
e1.printStackTrace();
return false;
}
for (int i = 0; i < this.reportTargets.size(); i++) {
// Create an array of lines we will eventually write out, initially the header.
ArrayList<String> reportLines = new ArrayList<String>(headerLines);
HtmlPublisherTarget reportTarget = this.reportTargets.get(i);
boolean keepAll = reportTarget.getKeepAll();
FilePath archiveDir =
build
.getWorkspace()
.child(resolveParametersInString(build, listener, reportTarget.getReportDir()));
FilePath targetDir = reportTarget.getArchiveTarget(build);
String levelString = keepAll ? "BUILD" : "PROJECT";
listener
.getLogger()
.println(
"[htmlpublisher] Archiving at "
+ levelString
+ " level "
+ archiveDir
+ " to "
+ targetDir);
// The index name might be a comma separated list of names, so let's figure out all the pages
// we should index.
String[] csvReports =
resolveParametersInString(build, listener, reportTarget.getReportFiles()).split(",");
ArrayList<String> reports = new ArrayList<String>();
for (int j = 0; j < csvReports.length; j++) {
String report = csvReports[j];
report = report.trim();
// Ignore blank report names caused by trailing or double commas.
if (report.equals("")) {
continue;
}
reports.add(report);
String tabNo = "tab" + (j + 1);
// Make the report name the filename without the extension.
int end = report.lastIndexOf(".");
String reportName;
if (end > 0) {
reportName = report.substring(0, end);
} else {
reportName = report;
}
String tabItem =
"<li id=\""
+ tabNo
+ "\" class=\"unselected\" onclick=\"updateBody('"
+ tabNo
+ "');\" value=\""
+ report
+ "\">"
+ reportName
+ "</li>";
reportLines.add(tabItem);
}
// Add the JS to change the link as appropriate.
String hudsonUrl = Hudson.getInstance().getRootUrl();
AbstractProject job = build.getProject();
reportLines.add(
"<script type=\"text/javascript\">document.getElementById(\"hudson_link\").innerHTML=\"Back to "
+ job.getName()
+ "\";</script>");
// If the URL isn't configured in Hudson, the best we can do is attempt to go Back.
if (hudsonUrl == null) {
reportLines.add(
"<script type=\"text/javascript\">document.getElementById(\"hudson_link\").onclick = function() { history.go(-1); return false; };</script>");
} else {
String jobUrl = hudsonUrl + job.getUrl();
reportLines.add(
"<script type=\"text/javascript\">document.getElementById(\"hudson_link\").href=\""
+ jobUrl
+ "\";</script>");
}
reportLines.add(
"<script type=\"text/javascript\">document.getElementById(\"zip_link\").href=\"*zip*/"
+ reportTarget.getSanitizedName()
+ ".zip\";</script>");
try {
if (!archiveDir.exists()) {
listener.error("Specified HTML directory '" + archiveDir + "' does not exist.");
build.setResult(Result.FAILURE);
return true;
} else if (!keepAll) {
// We are only keeping one copy at the project level, so remove the old one.
targetDir.deleteRecursive();
}
if (archiveDir.copyRecursiveTo("**/*", targetDir) == 0) {
listener.error(
"Directory '" + archiveDir + "' exists but failed copying to '" + targetDir + "'.");
if (build.getResult().isBetterOrEqualTo(Result.UNSTABLE)) {
// If the build failed, don't complain that there was no coverage.
// The build probably didn't even get to the point where it produces coverage.
listener.error("This is especially strange since your build otherwise succeeded.");
}
build.setResult(Result.FAILURE);
return true;
}
} catch (IOException e) {
Util.displayIOException(e, listener);
e.printStackTrace(listener.fatalError("HTML Publisher failure"));
build.setResult(Result.FAILURE);
return true;
}
reportTarget.handleAction(build);
// Now add the footer.
reportLines.addAll(footerLines);
// And write this as the index
try {
writeFile(reportLines, new File(targetDir.getRemote(), reportTarget.getWrapperName()));
} catch (IOException e) {
e.printStackTrace();
}
}
return true;
}
@Override
public BuildWrapper.Environment setUp(
AbstractBuild build, Launcher launcher, BuildListener listener)
throws IOException, InterruptedException {
final PrintStream logger = listener.getLogger();
final DeviceFarmApi api = new DeviceFarmApiImpl();
long start = System.currentTimeMillis();
try {
EnvVars environment = build.getEnvironment(listener);
String expendedTag = environment.expand(tag);
log(logger, Messages.TRYING_TO_CONNECT_API_SERVER(deviceApiUrl, expendedTag));
api.connectApiServer(
logger,
deviceApiUrl,
expendedTag,
build.getProject().getAbsoluteUrl() + build.getNumber());
final RemoteDevice reserved =
api.waitApiResponse(
logger, DEVICE_WAIT_TIMEOUT_IN_MILLIS, DEVICE_READY_CHECK_INTERVAL_IN_MS);
log(
logger,
Messages.DEVICE_IS_READY(passedSeconds(start), reserved.ip, reserved.port, reserved.url));
if (descriptor == null) {
descriptor = Hudson.getInstance().getDescriptorByType(DescriptorImpl.class);
}
// Substitute environment and build variables into config
final String androidHome = discoverAndroidSdkHome(build, launcher, listener);
log(logger, Messages.USING_SDK(androidHome));
AndroidSdk sdk = new AndroidSdk(androidHome, androidHome);
final AndroidDeviceContext device =
new AndroidDeviceContext(build, launcher, listener, sdk, reserved.ip, reserved.port);
// disconnect first to workaround previous error
device.disconnect();
// connect device with adb
device.connect(DEVICE_CONNECT_TIMEOUT_IN_MILLIS);
device.waitDeviceReady(logger, DEVICE_CONNECT_TIMEOUT_IN_MILLIS, 1000);
// check availability
device.devices();
// unlock screen
device.unlockScreen();
// Start dumping logcat to temporary file
final LogcatCollector logcatCollector = new LogcatCollector(build, device);
logcatCollector.start();
return new BuildWrapper.Environment() {
@Override
public void buildEnvVars(Map<String, String> env) {
env.put("ANDROID_IP", device.ip());
env.put("ANDROID_HOME", androidHome);
env.put("ANDROID_SDK_HOME", androidHome);
env.put("ANDROID_PORT", Integer.toString(device.port()));
env.put("ANDROID_SERIAL", device.serial());
}
@Override
public boolean tearDown(AbstractBuild build, BuildListener listener)
throws IOException, InterruptedException {
cleanUp(build, device, api, logcatCollector);
return true;
}
};
} catch (FailedToConnectApiServerException e) {
log(logger, Messages.FAILED_TO_CONNECT_API_SERVER());
} catch (MalformedResponseException e) {
log(logger, Messages.FAILED_TO_PARSE_DEVICE_FARM_RESPONSE());
} catch (TimeoutException e) {
log(logger, Messages.DEVICE_WAIT_TIMEOUT(passedSeconds(start)));
} catch (NoDeviceAvailableException e) {
log(logger, Messages.NO_SUCH_DEVICE());
}
build.setResult(Result.NOT_BUILT);
cleanUp(null, null, api, null);
return null;
}
/**
* 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;
}
