Package hudson.tasks.test
Class TestObject
- java.lang.Object
-
- hudson.model.AbstractModelObject
-
- hudson.tasks.junit.TestObject
-
- hudson.tasks.test.TestObject
-
- All Implemented Interfaces:
ModelObject
,SearchableModelObject
,SearchItem
,Serializable
- Direct Known Subclasses:
TestResult
@ExportedBean public abstract class TestObject extends TestObject
Base class for all test result objects. For compatibility with code that expects this class to be in hudson.tasks.junit, we've created a pure-abstract class, hudson.tasks.junit.TestObject. That stub class is deprecated; instead, people should use this class.- Author:
- Kohsuke Kawaguchi
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description TestObject()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description org.kohsuke.stapler.HttpResponse
doSubmitDescription(String description)
abstract TestResult
findCorrespondingResult(String id)
Find the test result corresponding to the one identified byid
within this test result.Api
getApi()
Exposes this object through the remote API.String
getDescription()
abstract float
getDuration()
Time took to run this test.String
getDurationString()
Returns the string representation of thegetDuration()
, in a human readable format.Object
getDynamic(String token, org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
abstract int
getFailCount()
Gets the total number of failed tests.String
getFullDisplayName()
String
getFullName()
Gets the full name of this object.History
getHistory()
String
getId()
String
getName()
Gets the name of this object.abstract TestObject
getParent()
Reverse pointer ofTabulatedResult.getChildren()
.abstract int
getPassCount()
Gets the total number of passed tests.abstract TestResult
getPreviousResult()
Gets the counterpart of thisTestResult
in the previous run.String
getRelativePathFrom(TestObject it)
Computes the relative path to get to this test object fromit
.TestResult
getResultInBuild(AbstractBuild<?,?> build)
Deprecated.TestResult
getResultInRun(Run<?,?> run)
Gets the counterpart of thisTestResult
in the specified run.String
getSafeName()
Gets the version ofgetName()
that's URL-safe.String
getSearchUrl()
abstract int
getSkipCount()
Gets the total number of skipped tests.<T> T
getTestAction(Class<T> klazz)
Gets a test action of the class passed in.List<TestAction>
getTestActions()
Get a list of all TestActions associated with this TestObject.TestResult
getTestResult()
Deprecated.This method returns a JUnit specific class.AbstractTestResultAction
getTestResultAction()
Subclasses may override this method if they are associated with a particular subclass of AbstractTestResultAction.TestResult
getTopLevelTestResult()
Returns the top level test result data.int
getTotalCount()
Gets the total number of tests.String
getUrl()
Returns the URL of thisTestObject
, relative to the context root.static String
safe(String s)
Replaces URL-unsafe characters.void
setDescription(String description)
protected String
uniquifyName(Collection<? extends TestObject> siblings, String base)
#2988: uniquifies agetSafeName()
amongst children of the parent.-
Methods inherited from class hudson.tasks.junit.TestObject
getOwner, getRun
-
Methods inherited from class hudson.model.AbstractModelObject
getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface hudson.model.ModelObject
getDisplayName
-
-
-
-
Method Detail
-
getParent
public abstract TestObject getParent()
Reverse pointer ofTabulatedResult.getChildren()
.- Specified by:
getParent
in classTestObject
- Returns:
- the parent
TestObject
.
-
getId
public final String getId()
- Specified by:
getId
in classTestObject
-
getUrl
public String getUrl()
Description copied from class:TestObject
Returns the URL of thisTestObject
, relative to the context root.- Specified by:
getUrl
in classTestObject
- Returns:
- String like "job/foo/32/testReport/junit/com.company/Class" with no trailing or leading slash.
-
getFullDisplayName
public String getFullDisplayName()
-
getTestResult
public TestResult getTestResult()
Deprecated.This method returns a JUnit specific class. UsegetTopLevelTestResult()
instead for a more general interface.Returns the top level test result data.- Specified by:
getTestResult
in classTestObject
-
getTopLevelTestResult
public TestResult getTopLevelTestResult()
Returns the top level test result data.- Returns:
- the top level test result data.
-
getRelativePathFrom
public String getRelativePathFrom(TestObject it)
Computes the relative path to get to this test object fromit
. Ifit
does not appear in the parent chain for this object, a relative path from the server root will be returned.- Parameters:
it
- Target test object.- Returns:
- A relative path to this object, potentially from the top of the Hudson object model
-
getTestResultAction
public AbstractTestResultAction getTestResultAction()
Subclasses may override this method if they are associated with a particular subclass of AbstractTestResultAction.- Specified by:
getTestResultAction
in classTestObject
- Returns:
- the test result action that connects this test result to a particular build
-
getTestActions
@Exported(visibility=3) public List<TestAction> getTestActions()
Get a list of all TestActions associated with this TestObject.- Specified by:
getTestActions
in classTestObject
-
getTestAction
public <T> T getTestAction(Class<T> klazz)
Gets a test action of the class passed in.- Specified by:
getTestAction
in classTestObject
- Type Parameters:
T
- an instance of the class passed in- Parameters:
klazz
- Type of the action to return.
-
getPreviousResult
public abstract TestResult getPreviousResult()
Gets the counterpart of thisTestResult
in the previous run.- Specified by:
getPreviousResult
in classTestObject
- Returns:
- null if no such counter part exists.
-
getResultInBuild
@Deprecated public TestResult getResultInBuild(AbstractBuild<?,?> build)
Deprecated.- Overrides:
getResultInBuild
in classTestObject
-
getResultInRun
public TestResult getResultInRun(Run<?,?> run)
Gets the counterpart of thisTestResult
in the specified run.- Overrides:
getResultInRun
in classTestObject
- Parameters:
run
- The run for which the run is requested.- Returns:
- null if no such counter part exists.
-
findCorrespondingResult
public abstract TestResult findCorrespondingResult(String id)
Find the test result corresponding to the one identified byid
within this test result.- Parameters:
id
- The path to the original test result- Returns:
- A corresponding test result, or null if there is no corresponding result.
-
getDuration
public abstract float getDuration()
Time took to run this test. In seconds.- Specified by:
getDuration
in classTestObject
- Returns:
- the time in seconds the test ran.
-
getDurationString
public String getDurationString()
Returns the string representation of thegetDuration()
, in a human readable format.- Specified by:
getDurationString
in classTestObject
- Returns:
- a string representation of
TestObject.getDuration()
.
-
getDescription
public String getDescription()
- Specified by:
getDescription
in classTestObject
-
setDescription
public void setDescription(String description)
- Specified by:
setDescription
in classTestObject
-
getApi
public Api getApi()
Exposes this object through the remote API.- Specified by:
getApi
in classTestObject
- Returns:
- the api for this test object.
-
getName
public String getName()
Gets the name of this object.- Specified by:
getName
in classTestObject
- Returns:
- the name of this object.
-
getFullName
public String getFullName()
Gets the full name of this object.- Returns:
- the full name of this object.
- Since:
- 1.551
-
getSafeName
public String getSafeName()
Gets the version ofgetName()
that's URL-safe.- Specified by:
getSafeName
in classTestObject
- Returns:
- the URL-safe name of this object.
-
getSearchUrl
public String getSearchUrl()
- Specified by:
getSearchUrl
in interfaceSearchItem
- Specified by:
getSearchUrl
in classTestObject
-
uniquifyName
protected final String uniquifyName(Collection<? extends TestObject> siblings, String base)
#2988: uniquifies agetSafeName()
amongst children of the parent.- Parameters:
siblings
- Siblings of the currentbase
- Prefix to use for the name.- Returns:
- an unique name amongst children of the parent.
-
safe
public static String safe(String s)
Replaces URL-unsafe characters. If s is an empty string, returns "(empty)" otherwise the generated URL would contain two slashes one after the other and getDynamic() would fail.- Parameters:
s
- String to process.- Returns:
- the string with the unsafe characters replaced.
-
getPassCount
public abstract int getPassCount()
Gets the total number of passed tests.- Specified by:
getPassCount
in classTestObject
- Returns:
- the total number of passed tests.
-
getFailCount
public abstract int getFailCount()
Gets the total number of failed tests.- Specified by:
getFailCount
in classTestObject
- Returns:
- the total number of failed tests.
-
getSkipCount
public abstract int getSkipCount()
Gets the total number of skipped tests.- Specified by:
getSkipCount
in classTestObject
- Returns:
- the total number of skipped tests.
-
getTotalCount
public int getTotalCount()
Gets the total number of tests.- Specified by:
getTotalCount
in classTestObject
- Returns:
- the total number of tests.
-
getHistory
public History getHistory()
- Specified by:
getHistory
in classTestObject
-
getDynamic
public Object getDynamic(String token, org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
-
doSubmitDescription
public org.kohsuke.stapler.HttpResponse doSubmitDescription(@QueryParameter String description) throws IOException, javax.servlet.ServletException
- Throws:
IOException
javax.servlet.ServletException
-
-