Package org.jvnet.hudson.test

Class TailLog

java.lang.Object

org.jvnet.hudson.test.TailLog

All Implemented Interfaces:

AutoCloseable

public final class TailLog
extends Object
implements AutoCloseable

Utility to display the log of a build in real time. Unlike BuildWatcher, this works well with both RealJenkinsRule and LocalData. Use in a try-with-resources block, typically calling waitForCompletion() at the end.

Constructor Summary

Constructors

Constructor	Description
TailLog(hudson.model.Run<?,?> b)	Watch a build already loaded in the current JVM.
TailLog(File buildDirectory, String job, int number)	Watch a build expected to run at a specific file location.
TailLog(JenkinsRule jr, String job, int number)	Watch a build expected to be loaded in the current JVM.
TailLog(RealJenkinsRule rjr, String job, int number)	Watch a build expected to be loaded in a controller JVM.

Method Summary

Modifier and Type	Method	Description
void	close()
void	waitForCompletion()
TailLog	withColor(PrefixedOutputStream.AnsiColor color)	Applies ANSI coloration to log lines produced by this instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TailLog

public TailLog(hudson.model.Run<?,?> b)

Watch a build already loaded in the current JVM.

TailLog

public TailLog(JenkinsRule jr,
               String job,
               int number)

Watch a build expected to be loaded in the current JVM. Note: this constructor will not work for a branch project (child of MultiBranchProject).

Parameters:

job - a AbstractItem.getFullName()

TailLog

public TailLog(RealJenkinsRule rjr,
               String job,
               int number)

Watch a build expected to be loaded in a controller JVM. Note: this constructor will not work for a branch project (child of MultiBranchProject).

Parameters:

job - a AbstractItem.getFullName()

TailLog

public TailLog(File buildDirectory,
               String job,
               int number)

Watch a build expected to run at a specific file location.

Parameters:

buildDirectory - expected Run.getRootDir()

job - a AbstractItem.getFullName()

Method Detail

withColor

public TailLog withColor(PrefixedOutputStream.AnsiColor color)

Applies ANSI coloration to log lines produced by this instance. Ignored when on CI. Does not work when the build has already started by the time this method is called.

waitForCompletion

public void waitForCompletion()
                       throws InterruptedException

Throws:

InterruptedException

close

public void close()

Specified by:

close in interface AutoCloseable