API and Test Automation Overview
With our extensive REST API, which comes free with TM4J, you have the ability to access testing data from Jira and carry out a variety of useful tasks, like migrating data from other testing tools, integrating with automated testing tools, and much more.
By using the API, you can publish automated test-execution results to Test Management for Jira and use our powerful reports to view metrics on your entire testing process. The API is HTTP-based and can be used from any framework, programming language, or tool.
You can easily submit data to TM4J through the API using POST/PUT/GET/DELETE requests.
Check out our API documentation.
Test Management for Jira enables you to automate tedious, time-intensive manual tasks.
Using the REST API, you can automate the creation of a test cycle from test cases associated to a list of Jira issues, folder creation for each sprint available as part of a Jira project, or the creation of new test cases from a list of Jira issues. And by writing your own scripts and using the REST API, there is no limit to the number of tasks you can automate.
When migrating complex sets of data from another test management tool or Excel spreadsheet, the self-service import options in Test Management for Jira may not meet your specific needs. In this event, we have a REST API with an extensive list of endpoints for tasks such as creating new test results and retrieving test cases. This allows you to seamlessly import your data into Test Management for Jira by pulling data from a file source, making relevant changes, and pushing the data to Test Management for Jira.
Automated testing has become an essential part of the testing process as it frees up time for the team and reduces the rate of errors that naturally occur in manual testing. Coding automated tests that run either locally or during the build process using continuous integration tools offers you a quick and standard set of data by which you can easily determine if your code is safe to release. This is why we have invested in efforts to improve our union with continuous integration tools like Jenkins and Bamboo, among other automated testing process improvements.
Test Management for Jira offers a range of features that simplify the integration process, including a plugin for Jenkins that allows you to both pull BDD test cases from Jira and report the results back to Jira.
REST API Endpoints
Regardless of which tool you use for automated testing, we have a public REST API with an extensive set of endpoints, which can be used to create custom scripts to enable full integration.
The following image demonstrates the flow of actions from your continuous integration tool, which outputs the results from automated tests as part of a build. Using our REST API, the results can be published back to Test Management for Jira.
Our API documentation provides data models and explanations of all our endpoints. You can find information on accessing the API, authentications basics, plus information about how to use statuses, environment fields, and date formats.
Integrate with Jenkins and Other Continuous Integration Tools
Setting up the integration between your continuous integration tool and Test Management for Jira is simple.
We have designed test annotations for Cucumber and JUnit tests that allow you to assign a test-case key from your test case in Jira to a test in your development project. Once annotated, the results can be sent straight to Test Management for Jira when the tests are run, either using our Jenkins plugin or a pre-made script if using another continuous integration tool or running tests locally. With the results in Test Management for Jira, you can generate reports for both manual and automated tests and analyze your metrics.
If you are writing BDD test cases within Test Management for Jira, our Jenkins plugin provides a build task that exports these test cases from Jira and includes them in your current build project to be executed against supporting automated tests. This task is to be used alongside the post-build task for publishing test results to Test Management for Jira.
Exporting BDD tests manually from Test Management for Jira can work as a reference or guide for developing automated tests.
When running automated tests locally or within a continuous integration tool other than Jenkins, you can use this handy script to send the results to Test Management for Jira.
And if you are running tests locally, you can add this script to your development project, and if you want to send automated test results from your continuous integration tool, you can add this as a build task/script within the tool itself to run after a build has completed.