Due to some maintenance issues, this service has been switched in read-only mode, you can find more information about the why

and how to migrate your plugin documentation in this blogpost

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Plugin Information

View Testopia on the plugin site for more information.

This plug-in integrates Jenkins and Testopia and generates reports on automated test execution. With this plug-in you can manage your tests in Testopia, schedule and control in Jenkins, and execute using your favorite test execution tool (TestPartner, Selenium, TestNG, Perl modules, PHPUnit, among others).

When filing an issue, remember to include as much data as possible, but avoid including sensitive data, as attachments can take a while to be deleted from JIRA, as the process is manual and quite troublesome (smile)

Description

The Testopia plug-in integrates Jenkins with Testopia. Testopia plug-in uses testopia-java-api to access Testopia XML-RPC API. With the information that you provide in the build step configuration the plug-in retrieves automated tests from Testopia. With the plug-in, you are able to execute build steps that call testing tools. It reads TestNGJUnit and TAP test report formats, used to update Testopia test cases' executions.

The job configuration changed! Now there are three sections, what helps you to configure your job, and add extra build steps, result seeking strategies and general information about TestLink.

TestLink configuration section

Test Execution section

And Result Seeking Strategy section

You can use environment variables in Test project name, Test plan name or Build name. For instance, build-project-$BUILD_NUMBER would be replaced by build-project- and the number of the Build executed in Jenkins.

How does the plug-in execute my automated tests?

TestLink Plug-in retrieves automated test cases data from TestLink. This data is then set as environment variables. This way your build steps can make use of this information to execute your automated tests.

For instance, you could run ant passing a Test Class as parameter, more or less something like this, /opt/java/apache-ant-1.8.0/bin/ant -DtestClass=$TESTLINK_TESTCASE_TEST_CLASS. In this case, Test Case is the name of a custom field in TestLink.

List of environment variables available during TestLink Plug-in execution:

  • TESTLINK_TESTCASE_ID
  • TESTLINK_TESTCASE_NAME
  • TESTLINK_TESTCASE_TESTPROJECTID
  • TESTLINK_TESTCASE_AUTHOR
  • TESTLINK_TESTCASE_SUMMARY
  • TESTLINK_BUILD_NAME
  • TESTLINK_TESTPLAN_NAME
  • TESTLINK_TESTCASE_$CUSTOM_FIELD_NAME

For each Custom Field found, TestLink Plug-in defines an environment variable for with its name and value, as shown above (%CUSTOM_FIELD_NAME%). If the custom field name contains spaces the plug-in will convert them into _'s. i.e., Test Class can be accessed as %TESTLINK_TESTCASE_TEST_CLASS% in Windows or $TESTLINK_TESTCASE_TEST_CLASS in *nix-like systems.

How does the plug-in know if a test passed or failed?

You can choose among different result seeking strategies in your job configuration. The plug-in supports three result formatsTestNGJUnit and TAP

TestNG result seeking strategies

TestNG class name: The plug-in matches the TestNG class name (e.g.: org.tap4j.TestParser) and the key custom field value.

TestNG method name: The plug-in matches the TestNG method name (e.g.: org.tap4j.TestParser#testTokenizer) and the key custom field value.

TestNG suite name: The plug-in matches the TestNG suite name (e.g.: functional tests) and the key custom field value.

JUnit result seeking strategies

JUnit case class name: The plug-in matches the JUnit case class name (e.g.: org.tap4j.TestParser) and the key custom field value.

JUnit case name: The plug-in matches the JUnit case class name (e.g.: testTokenizer) and the key custom field value.

JUnit method name: The plug-in matches the JUnit case class name (e.g.: org.tap4j.TestParser#testTokenizer) and the key custom field value.

JUnit suite name: The plug-in matches the JUnit suite name (e.g.:functional tests) and the key custom field value.

TAP result seeking strategies

TAP file name: The plug-in matches the TAP file name (e.g.: testFtpProtocol.tap) and the key custom field value. 

Configuration

  1. Download and install the latest version of TestLink (http://www.teamst.org).
  2. Create automated tests in TestLink with Custom Field for automation.
  3. Install the TestLink plug-in from the Jenkins Plugin Manager
  4. Define a TestLink configuration from the Configure System page.
  5. Add a Invoke TestLink build step in the job you want execute automated tests.
  6. Configure the required properties.

Languages Supported

  1. English (American)
  2. Portuguese (Brazil)
  3. Spanish (Thanks to César Fernandes de Almeida)
  4. French (Thanks to Floréal Toumikian, Olivier Renault, Latifa Elkarama)

Want to see this plug-in in your language? Send us an e-mail and we will get in touch with the text that needs to be translated.

Feedback

Your feedback is very welcomed, but you don't need donate money, nay. You can drop a message in [http://www.tupilabs.com] with suggestions and ideas (or even patches or pull requests).

Compatibility Matrix

The plug-in 1.0 and 1.1 versions were pilot projects that should be ignored. They have issues in distributed environments and depend on Maven. Please, consider updating your plug-in to the 2.0 version.

We don't maintain the plug-in for Hudson. Issues happening in Hudson may not be fixed here.

Plugin

1.0

1.1

2.0

2.1

2.2

2.2.1

2.2.2

2.4

2.5

3.0+

3.1+

TestLink

1.9.0

1.9.0

1.9.0

1.9.0

1.9.0

1.9.0

1.9.0

1.9.2

1.9.3

1.9.3+

1.9.3+

Jenkins

1.366+

1.366+

1.388+

1.388+

1.388+

1.388+

1.388+

1.388+

1.398+

1.398+

1.398+

Hudson

1.366

1.366

1.388

1.388-1.395

1.388-1.395

1.388-1.395

1.388-1.395

?

Not supported 

Not Supported 

Not Supported 

Resources

  1. Article published in Testing Experience magazine issue number 12 (Open Source Tools) written by Bruno P. Kinoshita and Anderson dos Santos. 2010.
  2. Slides used in the lighting talk presented at Encontro Ágil 2010 in IME-USP (Portuguese Only). 2010.
  3. Article published in Automated Software Testing Magazine, volume 3, issue 1. March, 2011.
  4. Slides used in the presentation done in Belgium Testing Days 2011.
  5. Lighting talk for Encontro Ágil 2010, at IME-USP.
  6. More articles and tips on Bruno P. Kinoshita's website.
  7. Sponsor company (until May 2011): Sysmap Solutions - Brazil.
  8. Sponsor company: TupiLabs - Brazil
  9. Presentation at STPCon Spring March 2012 in New Orleans - USA.

Sponsors

Release Notes

Release 3.1.5

JENKINS-10904 - Include test step information as env vars. We had to update testlink-java-api, as the bug was in there. However, the TestLink data stored in builds will be lost. So if you need any of the data, back it up before updating the plug-in. 

Release 3.1.2

Added test summary. This way the user can see more details in TestLink reports.

Release 3.1.1

Fixing bugs in JUnit and TestNG strategies

Release 3.1
  1. Created Result Seeking Strategy extension point
  2. Fixed all blocker issues
  3. Added more result seeking strategies (TestNG method name, for example)
  4. Added new contributors to the project
  5. Code reviewed and refactored several parts of the code, it's way cleaner now
  6. Added configuration to make optional attachments upload
Release 3.0.2

Minor improvements for issues found during update of Jenkins TestLink Plug-in Tutorial

Release 3.0.1

JENKINS-11264 - Test execution notes being added twice and incorrectly formatted

Release 3.0
  1. JENKINS-10623 - Organize and update French, Spanish and Brazilian Portuguese translation and documentation
  2. JENKINS-9054 - Add support to platforms in TestLink plug-in
  3. JENKINS-10809 - Add a way to call other build steps in test execution for the plug-in (Yay for DRY!)
  4. JENKINS-10849 - OutOfMemoryError using TestLink plugin (Thanks to YourKit!)
Release 2.5
  1. JENKINS-9811 Add a POST <Single test command>-field, to execute a process after the plug-in iterates the retrieved automated test cases
  2. JENKINS-9672 Test link custom field parser split the String value by semicolon or comma.
  3. JENKINS-9993 Add root element for JUnit test results
Release 2.2.2
  1. FIXED-9444 - Add environment variables to single test command (actually, I used some code from Jenkins core to execute both commands now :-)
Release 2.2.1
  1. French translation
  2. Small issue with non-existent option Debug in Job configuration
  3. FIXED-9229 - JUnit wrong status
  4. Portuguese i18n messages typo
Release 2.2
  1. JUnit BUG fix
  2. Enhancement of the Build logs
Release 2.1
  1. Migration from Hudson to Jenkins
  2. Test transaction property.
  3. i18n (version 1.0 supports only English).
  4. Add Javascript validation functions to each field in the global and config pages.
  5. Add single test command feature (it will enable running test suites)
  6. Fixed Java class headers
  7. JFreechart graphics betterment
  8. Fixed BUG JENKINS-8636 TestLink Plugin FATAL: Error creating test project
  9. Fixed BUG JENKINS-8531 Unexprssive error message
Release 2.0.1
  1. Fixed BUG 8292 (java.lang.NullPointerException at hudson.plugins.testlink.updater.TestLinkTestStatusUpdater.updateTestCases(TestLinkTestStatusUpdater.java:55)
Release 2.0
  1. Settings automated tests properties as environment variables.
  2. Switch from dbfacade-testlink-java-api to testlink-java-api http://sourceforge.net/projects/testlinkjavaapi/.
  3. JUnit parser.
  4. TestNG parser.
  5. TAP parser using tap4j http://sourceforge.net/projects/tap4j/.
Release 1.1
  1. Execute Test Suites.
  2. Let the user define the custom fields name.
  3. Implement feature that lets user to use the latest revision from a SVN repository as Build name.
Release 1.0
  1. First version of the plug-in (the development was guided based on the source code of the following plug-ins: CCM , Sonar (how to ref maven installations)).

Roadmap

  1. Keep compatibility with latest versions of Jenkins and TestLink.
  2. Add test case steps (JENKINS-10904)

Open source licenses donated for this project

YourKit is kindly supporting open source projects with its full-featured Java Profiler.
YourKit, LLC is the creator of innovative and intelligent tools for profiling
Java and .NET applications. Take a look at YourKit's leading software products:
YourKit Java Profiler and
YourKit .NET Profiler.

  • No labels