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 "acquisitions")

• Select your Suite and Crate Sections for test runs by + Add Section  (For our setup see image below)

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 FinanceApiTest

  FinanceApiTest Example

  public class FinanceApiTest extends AbstractTestRailIntegrationTest {
  
  	public FinanceApiTest() {
  		super(new TestRailIntegrationHelper(FINANCE_CONFIGURATION));
  	}
  
  	@Test
  	void budgetExpenseClasses() {
  		runFeatureTest("budget-expense-classes");
  	}
  }

• Add constructor with your own configuration see FinanceApiTest

• Add test method that will run your feature file like budget-expense-classes via runFeatureTest method that located in order to FINANCE_CONFIGURATION see budgetExpenseClasses

• Add your suite Configuration see Integrate TestRail with Karate setup section. For FinanceApiTest we use FINANCE_CONFIGURATION

• Add two setup mehtods into your test file like financeApiTestBeforeAll (to setup tenant, users and setup data for module run) and financeApiTestAfterAll (to destroy tenant and all related data for module run)

  
  

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

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

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

Configuration

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

public FinanceApiTest() { super(new TestRailIntegrationHelper(FINANCE_CONFIGURATION)); }

Finance Configuration use next data for configuration

• FINANCE_TEST_BASE_PATH - "classpath:domain/mod-finance/features/"
• FINANCE_TEST_SUITE_NAME - "mod-finance"
• TEST_SUITE_ID - "111"
• FINANCE_TEST_SECTION_ID - 1386

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

mvn test -Dtest=FinanceApiTest -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.