Get Results

To view results of a test job run, you can either use the web interface of TestEngine or send a request to the TestEngine API using curl, ReadyAPI, or any other similar tool.

Using API

Get an overview of test jobs in TestEngine

Use the following operation:

GET  http://<testengine-host>:8080/api/v1/testjobs

Authentication

The request must be authenticated by a TestEngine user.

Note:

If you authenticate as a non-admin user, you will be able to view only those reports on test jobs that you have started. If you authenticate as an administrator, you will be able to view all the test jobs in TestEngine.

See details on SwaggerHub.

Example

ExampleHide example

• curl
• ReadyAPI

Use the following command line:

curl -u "user:password" -X GET "http://localhost:8080/api/v1/testjobs"

In this example:

-u user:password

Authenticates the request with the user’s credentials.

-X GET

Specifies the GET method.

"http://localhost:8080/api/v1/testjobs"

The endpoint of the request.

1. Create a project by using the TestEngine API definition. See Creating Project From OpenAPI/Swagger Definition to learn how to do it.

   Tip:	You can also create the needed request from scratch.

2. Select the GET request to the /testjobs resource:

   

   Click the image to enlarge it.

3. Open the Auth panel.

4. Select the Basic (Built-in) authorization type.

   Tip:	If you use the same credentials in several requests, use authorization profiles.

5. Specify user credentials and select the Authenticate pre-emptively option:

   

   Click the image to enlarge it.

6. Send the request:

   

   Click the image to enlarge it.

7. The response will list all the test jobs the user is authorized to view.

   

Get a full report on a test job

Use the following operation:

GET  http://<testengine-host>:8080/api/v1/testjobs/{testjobId}/report

Authentication

The request must be authenticated by a TestEngine user.

Note:

Results that you see depend on the authentication. If you authenticate as a user, you will see only the test jobs started by that user; if you authenticate as an administrator, you will see all the test jobs in TestEngine.

Headers

Header	Description
Accept	Specifies the format of the report. Possible values: application/json (for a JSON report) application/junit+xml (for a report of the JUnit XML format) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (for an Excel report) application/pdf (for a PDF report) If the header is not set explicitly, a JSON report will be returned.

See details on SwaggerHub.

Example

ExampleHide example

• curl
• ReadyAPI

Use the following command line:

curl -u "user:password" -H "Accept:application/junit+xml" -X GET "http://localhost:8080/api/v1/testjobs/{testjobId}/report"

In this example:

-u user:password

Authenticates the request with the user’s credentials.

-H "Accept:application/junit+xml"

Specifies the report format. In this example, TestEngine will send a report of the JUnit XML format.

-X GET

Specifies the GET method.

"http://localhost:8080/api/v1/testjobs/{testjobId}/report"

The endpoint of the request.

The response will contain a report on the test job run in the form of a file of the JUnit XML format.

1. Create a project by using the TestEngine API definition. See Creating Project From OpenAPI/Swagger Definition to learn how to do it.

   Tip:	You can also create the needed request from scratch.

2. Select the GET request to the /api/v1/testjobs/{testjobId}/report resource:

   

   Click the image to enlarge it.

3. Enter the test job's id in the Value field of the testjobId parameter:

   

   Click the image to enlarge it.

4. Add a new parameter:

   • Name: Accept

   • Value: The type of the report you want to get. For example, application/junit+xml (see above).

   • Type: HEADER

   

   Click the image to enlarge it.

5. Open the Auth panel.

6. Select the Basic (Built-in) authorization type.

   Tip:	If you use the same credentials in several requests, use authorization profiles.

7. Specify user credentials and select the Authenticate pre-emptively option:

   

   Click the image to enlarge it.

8. Send the request:

   

   Click the image to enlarge it.

9. The response will contain a report on the test job run in the form of a file of the JUnit XML format:

   

Using Web UI

To see test job results, go to the home page of TestEngine:

http://<testengine-host>:<port>/

For example, if TestEngine is installed on your local machine and you run it on the default port, use the following link:

http://localhost:8080/

The Overview page of the TestEngine web interface contains a list of existing test jobs:

Click the image to enlarge it.

Tip:	You can filter test jobs by a name, status, used tags, and the user who has sent the job. Besides that, you can search for a specific test job by a string included in its project, author, status, type, or tag.

The table contains brief information on test jobs:

Column	Description
Project	The name of the project to run.
Status	Current state of a test job. Possible statuses: QUEUED, RUNNING, CANCELED, FAILED, FINISHED.
Author	The name of the user, who sent the test job to TestEngine. Administrators can examine test jobs created by other users.
Test Type	Shows whether the test job is a functional test or security test. Currently, TestEngine does not support load tests.
Tags	Shows which tags were used to run the test job.
Submitted	A timestamp when the test job was sent to TestEngine.
Run Time	The time of the test run.
Queue Time	How much time the test was in the queue.
Total Time	The total time of the test run, including the time in the queue.
	Cancel the test job.
	Get the test job ID.
	Download the test job report in the JSON, JUnit XML, Excel or PDF format.

A transaction report is a JSON file that contains full information on HTTP transactions that took place during a test job run. Transactions are logged only for request test steps, such as SOAP Request, REST Request, and so on.

Get a report on all the transactions within a test job

Use the following operation:

GET  http://<testengine-host>:8080/api/v1/testjobs/{testjobId}/transactions

Authentication

The request must be authenticated by a TestEngine user.

Note:

Results that you see depend on the authentication. A user can see only the transactions of test jobs that they have started; an administrator can see transactions of all the jobs in TestEngine.

See details on SwaggerHub.

Example

ExampleHide example

• curl
• ReadyAPI

Use the following command line:

curl -u "user:password" -X GET "http://localhost:8080/api/v1/testjobs/{testjobId}/transactions/{transactionId}"

In this example:

-u user:password

Authenticates the request with the user’s credentials.

-X GET

Specifies the GET method.

"http://localhost:8080/api/v1/testjobs/{testjobId}/transactions/{transactionId}"

The endpoint of the request.

The response will contain a report on the transaction in the form of a JSON file.

1. Create a project by using the TestEngine API definition. See Creating Project From OpenAPI/Swagger Definition to learn how to do it.

   Tip:	You can also create the needed request from scratch.

2. Select the GET request to the /api/v1/testjobs/{testjobId}/transactions resource:

   

   Click the image to enlarge it.

3. Enter the test job id as the value of the testjobId parameter:

   

   Click the image to enlarge it.

4. Open the Auth panel.

5. Select the Basic (Built-in) authorization type.

   Tip:	If you use the same credentials in several requests, use authorization profiles.

6. Specify the user credentials and select the Authenticate pre-emptively option:

   

   Click the image to enlarge it.

7. Send the request:

   

   Click the image to enlarge it.

8. The response will contain a report on the transactions in the form of a JSON file:

   

Get a transaction report for a particular transaction

Use the following operation:

GET  http://<testengine-host>:8080/api/v1/testjobs/{testjobId}/transactions/{transactionId}

Authentication

The request must be authenticated by a TestEngine user.

Note:

Results that you see depend on the authentication. A user can see only the transactions of test jobs that they have started; an administrator can see transactions of all the jobs in TestEngine.

See details on SwaggerHub.

Example

ExampleHide example

• curl
• ReadyAPI

Use the following command line:

curl -u "user:password" -X GET "http://localhost:8080/api/v1/testjobs/{testjobId}/transactions/{transactionId}"

In this example:

-u user:password

Authenticates the request with the user’s credentials.

-X GET

Specifies the GET method.

"http://localhost:8080/api/v1/testjobs/{testjobId}/transactions/{transactionId}"

The endpoint of the request.

The response will contain a report on the transaction in the form of a JSON file.

1. Create a project by using the TestEngine API definition. See Creating Project From OpenAPI/Swagger Definition to learn how to do it.

   Tip:	You can also create the needed request from scratch.

2. Select the GET request to the /api/v1/testjobs/{testjobId}/transactions/{transactionId} resource:

   

   Click the image to enlarge it.

3. Enter the test job id and transaction id in the respective fields:

   

   Click the image to enlarge it.

4. Open the Auth panel.

5. Select the Basic (Built-in) authorization type.

   Tip:	If you use the same credentials in several requests, use authorization profiles.

6. Specify user credentials and select the Authenticate pre-emptively option:

   

   Click the image to enlarge it.

7. Send the request:

   

   Click the image to enlarge it.

8. The response will contain a report on the transaction in the form of a JSON file:

   

The address and port of your TestEngine installation.

The address and port of your TestEngine installation.

The id of the job. The id is included in the response that you receive when starting the job. Alternatively, you can click in the Web UI, or get an overview of test jobs and find the id of the needed job there.

The address and port of your TestEngine installation.

The id of the job. The id is included in the response that you receive when starting the job. Alternatively, you can click in the Web UI, or get an overview of test jobs and find the id of the needed job there.

The address and port of your TestEngine installation.

The id of the job. The id is included in the response that you receive when starting the job. Alternatively, you can click in the Web UI, or get an overview of test jobs and find the id of the needed job there.