hudson.plugins.testlink.result

Class ResultSeeker

java.lang.Object

hudson.plugins.testlink.result.ResultSeeker

All Implemented Interfaces:

hudson.model.Describable<ResultSeeker>, Serializable, Comparable<ResultSeeker>

Direct Known Subclasses:

AbstractJUnitResultSeeker, AbstractTAPFileNameResultSeeker, AbstractTestNGResultSeeker

public abstract class ResultSeeker
extends Object
implements Serializable, hudson.model.Describable<ResultSeeker>, Comparable<ResultSeeker>

Seeks for Results.

Since:

2.2

Author:

Bruno P. Kinoshita - http://www.kinoshita.eti.br

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	includeNotes Whether the plug-in must include notes when updating test cases.
protected String	includePattern Include pattern used when looking for results.
protected String	keyCustomField Key custom field.

Constructor Summary

Constructors

Constructor and Description
ResultSeeker(String includePattern, String keyCustomField, boolean includeNotes) Creates a result seeker passing a ant-like pattern to look for results.

Method Summary

Modifier and Type	Method and Description
static hudson.DescriptorExtensionList<ResultSeeker,hudson.model.Descriptor<ResultSeeker>>	all()
static hudson.DescriptorExtensionList<ResultSeeker,hudson.model.Descriptor<ResultSeeker>>	allExcept(hudson.model.Node current)
int	compareTo(ResultSeeker o)
protected String	getBase64FileContent(File file) Retrieves the file content encoded in Base64.
ResultSeekerDescriptor	getDescriptor()
String	getIncludePattern()
String	getKeyCustomField()
protected br.eti.kinoshita.testlinkjavaapi.model.CustomField	getKeyCustomField(List<br.eti.kinoshita.testlinkjavaapi.model.CustomField> customFields, String keyCustomFieldName) Gets the key custom field out of a list using the key custom field name.
boolean	isIncludeNotes()
protected String[]	scan(File directory, String includes, hudson.model.BuildListener listener) Scans a directory for files matching the includes pattern.
abstract void	seek(TestCaseWrapper[] automatedTestCases, hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener, TestLinkSite testlink) Seeks for Test Results in a directory.

Methods inherited from class java.lang.Object

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

Field Detail

includePattern

protected final String includePattern

Include pattern used when looking for results.

keyCustomField

protected final String keyCustomField

Key custom field.

includeNotes

protected final boolean includeNotes

Whether the plug-in must include notes when updating test cases.

Constructor Detail

ResultSeeker

public ResultSeeker(String includePattern,
                    String keyCustomField,
                    boolean includeNotes)

Creates a result seeker passing a ant-like pattern to look for results.

Parameters:

includePattern - Include pattern when looking for results.

Method Detail

getIncludePattern

public String getIncludePattern()

Returns:

the includePattern

getKeyCustomField

public String getKeyCustomField()

Returns:

the keyCustomField

isIncludeNotes

public boolean isIncludeNotes()

Returns:

the enableNotes

getDescriptor

public ResultSeekerDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<ResultSeeker>

all

public static hudson.DescriptorExtensionList<ResultSeeker,hudson.model.Descriptor<ResultSeeker>> all()

allExcept

public static hudson.DescriptorExtensionList<ResultSeeker,hudson.model.Descriptor<ResultSeeker>> allExcept(hudson.model.Node current)

seek

public abstract void seek(TestCaseWrapper[] automatedTestCases,
                          hudson.model.AbstractBuild<?,?> build,
                          hudson.Launcher launcher,
                          hudson.model.BuildListener listener,
                          TestLinkSite testlink)
                   throws ResultSeekerException

Seeks for Test Results in a directory. It tries to match the includePattern with files in this directory.

It looks for results using the include pattern, but this value is matched within the workspace. It means that your result files have to be relative to your workspace.

For each result found, it is automatically updated in TestLink, and the Report is updated.

Parameters:

automatedTestCases - Automated test cases

listener - Build listener for logging

testlink - TestLink site for updating test status

Throws:

ResultSeekerException

getBase64FileContent

protected String getBase64FileContent(File file)
                               throws IOException

Retrieves the file content encoded in Base64.

Parameters:

file - file to read the content.

Returns:

file content encoded in Base64.

Throws:

IOException

scan

protected String[] scan(File directory,
                        String includes,
                        hudson.model.BuildListener listener)
                 throws IOException

Scans a directory for files matching the includes pattern.

Parameters:

directory - the directory to scan.

includes - the includes pattern.

listener - Hudson Build listener.

Returns:

array of strings of paths for files that match the includes pattern in the directory.

Throws:

IOException

getKeyCustomField

protected br.eti.kinoshita.testlinkjavaapi.model.CustomField getKeyCustomField(List<br.eti.kinoshita.testlinkjavaapi.model.CustomField> customFields,
                                                                               String keyCustomFieldName)

Gets the key custom field out of a list using the key custom field name.

compareTo

public int compareTo(ResultSeeker o)

Specified by:

compareTo in interface Comparable<ResultSeeker>