space-engineers-api/testrail/TestRailClient

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 } } } })

Constructors

TestRailClient

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

Types

Companion

object Companion

Functions

get

inline suspend fun <T> get(path: String): T

getAttachment

suspend fun getAttachment(id: String): ByteArray

getAttachmentsForCase

suspend fun getAttachmentsForCase(caseId: Long): AttachmentsForCase

getAttachmentsForSuite

suspend fun getAttachmentsForSuite(suiteId: Long): String

getCase

suspend fun getCase(id: Long): Case

getCases

suspend fun getCases(projectId: Long, suiteId: Long): Cases

getCaseString

suspend fun getCaseString(id: Long): String

getSections

suspend fun getSections(projectId: Long, suiteId: Long): Sections

getSectionsStr

suspend fun getSectionsStr(projectId: Long, suiteId: Long): String

getSuite

suspend fun getSuite(suiteId: Long): Suite

url

fun Case.url(): String

Properties

API_PREFIX

val API_PREFIX: String

authentication

val authentication: BasicAuthCredentials

baseUrl

val baseUrl: Url

client

val client: HttpClient

Extensions

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

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