testrail

SectionHelper

class SectionHelper( val sections: Sections, val ignoredSections: Set<Long> = DEFAULT_IGNORED_SECTIONS, val sectionDirectoryNaming: (Section) -> String = { "${it.name}-${it.id}" }, val caseFileNaming: (Case) -> String = { case -> "C${case.id}.feature" })

TestRailClient

class TestRailClient( val baseUrl: Url, val authentication: BasicAuthCredentials, val client: HttpClient = HttpClient() { install(ContentNegotiation) { json( Json { prettyPrint = true isLenient = true ignoreUnknownKeys = true }, ) } install(Auth) { basic { credentials { authentication } } } })

TestRailConfig

data class TestRailConfig( val username: String, val password: String, val suiteId: Long, val projectId: Long, val excludingTags: Set<String>, val ignoredParentSections: List<Long>, val testCaseDirectory: String, val mapsDirectory: String)

convertTables

fun String.convertTables(): String

downloadCase

suspend fun TestRailClient.downloadCase( caseId: Long, sectionHelper: SectionHelper, outputDirectory: File, overwrite: Boolean = false)

downloadEverything

suspend fun TestRailClient.downloadEverything( sectionIds: List<Long> = listOf(49388, 50008), projectId: Long = TestRailClient.SE_PROJECT_ID, suiteId: Long = TestRailClient.SE_SUITE_ID, overwrite: Boolean = false, ignoredParentSections: Set<Long> = SectionHelper.DEFAULT_IGNORED_SECTIONS, testCaseDirectory: File = File("./src/jvmTest/resources/testrail/features/"), mapDirectory: File = File("./src/jvmTest/resources/testrail/maps")): Map<Long, File>

downloadMaps

suspend fun TestRailClient.downloadMaps(suiteId: Long, destination: File): List<String>?

downloadSection

suspend fun TestRailClient.downloadSection( sectionId: Long, suiteId: Long = TestRailClient.SE_SUITE_ID, projectId: Long = TestRailClient.SE_PROJECT_ID, sectionHelper: SectionHelper, overwrite: Boolean = false, excludingTags: Set<String> = setOf("ignore", "duplicate", "creative", "difficult", "todo"), testCaseDirectory: File = File("./src/jvmTest/resources/features/testrail-2/"))

featureContent

fun Case.featureContent(): String

formattedTags

fun Case.formattedTags(): String

getTestrailPaths

suspend fun getTestrailPaths( sectionIds: List<Long>, username: String, password: String, ignoredParentSections: Set<Long>): Map<Long, File>

parseTags

fun parseTags(title: String): List<String>

relativeUrl

fun Case.relativeUrl(): String

save

fun Case.save( sectionHelper: SectionHelper, outputDirectory: File, overwrite: Boolean = false)

sectionHelper

suspend fun TestRailClient.sectionHelper( projectId: Long = TestRailClient.SE_PROJECT_ID, suiteId: Long = TestRailClient.SE_SUITE_ID, ignoredSections: Set<Long> = setOf(49384L, 49385L, 49386L)): SectionHelper

Package testrail

Types

Functions

Properties