hudson.plugins.testlink.util

Class TestLinkHelper

java.lang.Object

hudson.plugins.testlink.util.TestLinkHelper

public final class TestLinkHelper
extends Object

Helper methods for TestLink.

Since:

2.0

Author:

Bruno P. Kinoshita

Method Summary

Modifier and Type	Method and Description
static void	addCustomFieldEnvironmentVariableName(br.eti.kinoshita.testlinkjavaapi.model.CustomField customField, Map<String,String> testLinkEnvVar, String prefix) Formats a custom field into an environment variable.
static hudson.EnvVars	buildTestCaseEnvVars(int numberOfTests, br.eti.kinoshita.testlinkjavaapi.model.TestProject testProject, br.eti.kinoshita.testlinkjavaapi.model.TestPlan testPlan, br.eti.kinoshita.testlinkjavaapi.model.Build build, hudson.model.BuildListener listener) Creates EnvVars for TestLink entities.
static hudson.EnvVars	buildTestCaseEnvVars(TestCaseWrapper testCase, br.eti.kinoshita.testlinkjavaapi.model.TestProject testProject, br.eti.kinoshita.testlinkjavaapi.model.TestPlan testPlan, br.eti.kinoshita.testlinkjavaapi.model.Build build, hudson.model.BuildListener listener) Creates EnvVars for a TestLink Test Case.
static String[]	createArrayOfCustomFieldsNames(hudson.util.VariableResolver<String> variableResolver, hudson.EnvVars envVars, String customFields) Create an array of custom fields names using the Job configuration data.
static String	createReportSummary(Report testLinkReport, Report previous) Creates Report Summary.
static String	createReportSummaryDetails(Report report, Report previous) Creates detailed Report Summary.
static Map<String,String>	createTestLinkEnvironmentVariables(int numberOfTests, br.eti.kinoshita.testlinkjavaapi.model.TestProject testProject, br.eti.kinoshita.testlinkjavaapi.model.TestPlan testPlan, br.eti.kinoshita.testlinkjavaapi.model.Build build) Creates a Map (name, value) of environment variables for a TestLink Test Case.
static Map<String,String>	createTestLinkEnvironmentVariables(TestCaseWrapper testCase, br.eti.kinoshita.testlinkjavaapi.model.TestProject testProject, br.eti.kinoshita.testlinkjavaapi.model.TestPlan testPlan, br.eti.kinoshita.testlinkjavaapi.model.Build build) Creates a Map (name, value) of environment variables for a TestLink Test Case.
static String	expandVariable(hudson.util.VariableResolver<String> variableResolver, hudson.EnvVars envVars, String variable) Expands a text variable like BUILD-$VAR replacing the $VAR part with a environment variable that matches its name, minus $.
static String	getExecutionStatusTextColored(br.eti.kinoshita.testlinkjavaapi.constants.ExecutionStatus executionStatus) Retrieves the text for an execution status wrapped in html tags that add color to the text.
static String	getPlusSignal(int current, int previous) Prints the difference between two int values, showing a plus sign if the current number is greater than the previous.
static void	maybeAddSystemProperty(String systemProperty, hudson.model.BuildListener listener) Maybe adds a system property if it is in format (@code key=value}.
static void	setTestLinkJavaAPIProperties(String testLinkJavaAPIProperties, hudson.model.BuildListener listener) Defines TestLink Java API Properties.

Methods inherited from class java.lang.Object

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

Method Detail

getExecutionStatusTextColored

public static String getExecutionStatusTextColored(br.eti.kinoshita.testlinkjavaapi.constants.ExecutionStatus executionStatus)

Retrieves the text for an execution status wrapped in html tags that add color to the text. Green for sucess, yellow for blocked, gray for not ran and red for failed. If the plug-in supports the locale the text will be translated automatically.

Parameters:

executionStatus - the execution status.

Returns:

the text wrapped in html tags that add color to the text.

setTestLinkJavaAPIProperties

public static void setTestLinkJavaAPIProperties(String testLinkJavaAPIProperties,
                                                hudson.model.BuildListener listener)

Defines TestLink Java API Properties. Following is the list of available properties.

• xmlrpc.basicEncoding
• xmlrpc.basicPassword
• xmlrpc.basicUsername
• xmlrpc.connectionTimeout
• xmlrpc.contentLengthOptional
• xmlrpc.enabledForExceptions
• xmlrpc.encoding
• xmlrpc.gzipCompression
• xmlrpc.gzipRequesting
• xmlrpc.replyTimeout
• xmlrpc.userAgent

Parameters:

testLinkJavaAPIProperties -

listener - Jenkins Build listener

maybeAddSystemProperty

public static void maybeAddSystemProperty(String systemProperty,
                                          hudson.model.BuildListener listener)

Maybe adds a system property if it is in format (@code key=value}.

Parameters:

systemProperty - System property entry in format key=value.

listener - Jenkins Build listener

createTestLinkEnvironmentVariables

public static Map<String,String> createTestLinkEnvironmentVariables(TestCaseWrapper testCase,
                                                                    br.eti.kinoshita.testlinkjavaapi.model.TestProject testProject,
                                                                    br.eti.kinoshita.testlinkjavaapi.model.TestPlan testPlan,
                                                                    br.eti.kinoshita.testlinkjavaapi.model.Build build)

Creates a Map (name, value) of environment variables for a TestLink Test Case.

Parameters:

testCase - TestLink test Case.

testProject - TestLink Test Project.

testPlan - TestLink Test Plan.

build - TestLink Build.

Returns:

Map (name, value) of environment variables.

createTestLinkEnvironmentVariables

public static Map<String,String> createTestLinkEnvironmentVariables(int numberOfTests,
                                                                    br.eti.kinoshita.testlinkjavaapi.model.TestProject testProject,
                                                                    br.eti.kinoshita.testlinkjavaapi.model.TestPlan testPlan,
                                                                    br.eti.kinoshita.testlinkjavaapi.model.Build build)

Creates a Map (name, value) of environment variables for a TestLink Test Case.

Parameters:

testProject - TestLink Test Project.

testPlan - TestLink Test Plan.

build - TestLink Build.

Returns:

Map (name, value) of environment variables.

addCustomFieldEnvironmentVariableName

public static void addCustomFieldEnvironmentVariableName(br.eti.kinoshita.testlinkjavaapi.model.CustomField customField,
                                                         Map<String,String> testLinkEnvVar,
                                                         String prefix)

Formats a custom field into an environment variable. It appends the ${prefix} in front of the environment variable name.

So, for example, the custom field which name is Sample Custom Field, value is Sample Value, and prefix is TESTLINK_TESTCASE. It will be added into the environment variables as TESTLINK_TESTCASE_SAMPLE__CUSTOM_FIELD="Sample Value" (note for the double spaces).

If the custom's value contains commas (,), then this method splits the value and, for each token found, it creates a new environment variable appending a numeric index after its name

So, for example, the custom field which name is Sample Custom Field, value is Sample Value 1, Sample Value 2, and prefix is TESTLINK_TESTCASE. It will generate three environment variables: TESTLINK_TESTCASE_SAMPLE_CUSTOM_FIELD="Sample Value 1, Sample Value 2", TESTLINK_TESTCASE_SAMPLE_CUSTOM_FIELD_0="Sample Value 1" and TESTLINK_TESTCASE_SAMPLE_CUSTOM_FIELD_1="Sample Value 2".

Parameters:

customField - The custom field

testLinkEnvVar - TestLink envVars

prefix - the variables name prefix

buildTestCaseEnvVars

public static hudson.EnvVars buildTestCaseEnvVars(TestCaseWrapper testCase,
                                                  br.eti.kinoshita.testlinkjavaapi.model.TestProject testProject,
                                                  br.eti.kinoshita.testlinkjavaapi.model.TestPlan testPlan,
                                                  br.eti.kinoshita.testlinkjavaapi.model.Build build,
                                                  hudson.model.BuildListener listener)

Creates EnvVars for a TestLink Test Case.

Parameters:

testCase - TestLink test Case

testProject - TestLink Test Project

testPlan - TestLink Test Plan

build - TestLink Build

listener - Hudson Build Listener

Returns:

EnvVars (environment variables)

buildTestCaseEnvVars

public static hudson.EnvVars buildTestCaseEnvVars(int numberOfTests,
                                                  br.eti.kinoshita.testlinkjavaapi.model.TestProject testProject,
                                                  br.eti.kinoshita.testlinkjavaapi.model.TestPlan testPlan,
                                                  br.eti.kinoshita.testlinkjavaapi.model.Build build,
                                                  hudson.model.BuildListener listener)

Creates EnvVars for TestLink entities.

Parameters:

numberOfTests - number of tests

testProject - TestLink Test Project

testPlan - TestLink Test Plan

build - TestLink Build

listener - Hudson Build Listener

Returns:

EnvVars (environment variables)

createReportSummary

public static String createReportSummary(Report testLinkReport,
                                         Report previous)

Creates Report Summary.

Parameters:

testLinkReport - TestLink Report

previous - Previous TestLink Report

Returns:

Report Summary

createReportSummaryDetails

public static String createReportSummaryDetails(Report report,
                                                Report previous)

Creates detailed Report Summary.

Parameters:

report - TestLink report

previous - Previous TestLink report

Returns:

Detailed Report Summary

getPlusSignal

public static String getPlusSignal(int current,
                                   int previous)

Prints the difference between two int values, showing a plus sign if the current number is greater than the previous.

Parameters:

current - Current value

previous - Previous value

createArrayOfCustomFieldsNames

public static String[] createArrayOfCustomFieldsNames(hudson.util.VariableResolver<String> variableResolver,
                                                      hudson.EnvVars envVars,
                                                      String customFields)

Create an array of custom fields names using the Job configuration data.

Parameters:

variableResolver - Jenkins variable resolver

envVars - Jenkins environment variables

customFields - String containinig a comma separated list of custom fields

Returns:

String[] of custom fields names.

expandVariable

public static String expandVariable(hudson.util.VariableResolver<String> variableResolver,
                                    hudson.EnvVars envVars,
                                    String variable)

Expands a text variable like BUILD-$VAR replacing the $VAR part with a environment variable that matches its name, minus $.

Parameters:

variableResolver - Jenkins Build Variable Resolver.

envVars - Jenkins Build Environment Variables.

variable - Variable value (includes mask).

Returns:

Expanded test project name job configuration property.