Overview

Here are described the steps to connect TestRail with karate integration tests.

Steps

TestRail Setup

To prepare running karate tests you need to setup TestRail before by creation Test Suite and Sections

Open Test Suites & Cases by testRail top menu and choose + Add Test Suite button

Set any name. (For our example it is "mod-orders")

Select your Suite and Crate Sections for test runs by + Add Section and create default section (mod-orders for our case)

Project Setup

Copy all related files from package org.folio.testrail of acquisitions to your project path

Create jUnit test file and extend from AbstractTestRailIntegrationTest like OrdersApiTest

FinanceApiTest Example

public class OrdersApiTest extends AbstractTestRailIntegrationTest {

// default module settings
private static final String TEST_BASE_PATH = "classpath:domain/mod-orders/features/";
private static final String TEST_SUITE_NAME = "mod-orders";
private static final long TEST_SECTION_ID = 3337L;
private static final long TEST_SUITE_ID = 159L;

public OrdersApiTest() {
	super(new TestRailIntegrationService(
		new TestModuleConfiguration(TEST_BASE_PATH, TEST_SUITE_NAME, TEST_SUITE_ID, TEST_SECTION_ID)));
}

@Test
void deleteOpenedOrderAndOrderLines() {
	runFeatureTest("delete-opened-order-and-lines.feature");
}

Add your suite Configuration see 50299221 section. For OrdersApiTest we use TEST_SUITE_ID = 159 and TEST_SECTION_ID = 3337
Add constructor with your own configuration see OrdersApiTest
Add test method that will run your feature file like delete-opened-order-and-lines.feature via runFeatureTest method
Add two setup mehtods into your test file like ordersApiTestBeforeAll (to setup tenant, users and setup data for module run) andordersApiTestAfterAll (to destroy tenant and all related data for module run)

Note: orders-junit.feature and destroy-data.feature should contain logic to setup and destroy data for tenant.

Setup and Destroy methods

@BeforeAll
public void ordersApiTestBeforeAll() {
	runFeature("classpath:domain/mod-orders/orders-junit.feature");
}

@AfterAll
public void ordersApiTestAfterAll() {
	runFeature("classpath:common/destroy-data.feature");
}

Configuration

For interaction with TestRail we need to Configure our test in constructor with your own configuration. Example:

Configuration example

public OrdersApiTest() { 
	super(new TestRailIntegrationService(new TestModuleConfiguration(TEST_BASE_PATH, TEST_SUITE_NAME, TEST_SUITE_ID, TEST_SECTION_ID))); 
}

Orders Configuration use next data for configuration

FINANCE_TEST_BASE_PATH - "classpath:domain/mod-finance/features/"
FINANCE_TEST_SUITE_NAME - "mod-finance"
TEST_SUITE_ID - "159"
FINANCE_TEST_SECTION_ID - 3337

To get suite id and section id you can use postman collection Test Rail.postman_collection.json (Note: Update Authorization with basic Auth and your credentials)

Run tests with TestRail integration

Run examples

mvn test -Dtest=OrdersApiTest -pl acquisitions -Dtestrail_url=https://foliotest.testrail.io -Dtestrail_userId=<your_user_id> -Dtestrail_pwd=<password> -Dtestrail_projectId=<test_rail_project_id>

Where you populate your out values like <your_user_id>, <password>, <test_rail_project_id> and instead of "-pl acquisitions" argument you should use your own project.

Result of TestRail Run

If Tests has passed successfully then you should see result "Test Runs & Results" menu section

Integrate TestRail with Karate setup