How to use DiscoveryResult class of io.kotest.framework.discovery package

Best Kotest code snippet using io.kotest.framework.discovery.DiscoveryResult

Discovery.kt

Source:Discovery.kt

...16 *17 * @specs these are classes which extend one of the spec types18 * @scripts these are kotlin scripts which may or may not contain tests19 */20data class DiscoveryResult(21   val specs: List<KClass<out Spec>>,22   val scripts: List<KClass<*>>,23   val error: Throwable?, // this error is set if there was an exception during discovery24) {25   companion object {26      fun error(t: Throwable): DiscoveryResult = DiscoveryResult(emptyList(), emptyList(), t)27   }28}29/**30 * Scans for tests as specified by a [DiscoveryRequest].31 *32 * [DiscoveryExtension] `afterScan` functions are applied after the scan is complete to33 * optionally filter the returned classes.34 */35class Discovery(private val discoveryExtensions: List<DiscoveryExtension> = emptyList()) {36   private val requests = ConcurrentHashMap<DiscoveryRequest, DiscoveryResult>()37   // the results of a classpath scan, lazily executed and memoized.38   private val scanResult = lazy { classgraph().scan() }39   // filter functions40   //private val isScript: (KClass<*>) -> Boolean = { ScriptTemplateWithArgs::class.java.isAssignableFrom(it.java) }41   private val isSpecSubclassKt: (KClass<*>) -> Boolean = { Spec::class.java.isAssignableFrom(it.java) }42   private val isSpecSubclass: (Class<*>) -> Boolean = { Spec::class.java.isAssignableFrom(it) }43   private val isAbstract: (KClass<*>) -> Boolean = { it.isAbstract }44   private val fromClassPaths: List<KClass<out Spec>> by lazy { scanUris() }45   /**46    * Returns a function that applies all the [DiscoveryFilter]s to a given class.47    * The class must pass all the filters to be included.48    */49   private fun filterFn(filters: List<DiscoveryFilter>): (KClass<out Spec>) -> Boolean = { kclass ->50      filters.isEmpty() || filters.all { it.test(kclass) }51   }52   /**53    * Returns a function that applies all the [DiscoverySelector]s to a given class.54    * The class must pass any one selector to be included.55    */56   private fun selectorFn(selectors: List<DiscoverySelector>): (KClass<out Spec>) -> Boolean = { kclass ->57      selectors.isEmpty() || selectors.any { it.test(kclass) }58   }59   fun discover(request: DiscoveryRequest): DiscoveryResult =60      requests.getOrPut(request) { doDiscovery(request).getOrElse { DiscoveryResult.error(it) } }61//   /**62//    * Scans the classpaths for kotlin script files.63//    */64//   private fun discoverScripts(): List<KClass<out ScriptTemplateWithArgs>> {65//      log { "Discovery: Running script scan" }66//      return scanResult.value67//         .allClasses68//         .filter { it.extendsSuperclass(ScriptTemplateWithArgs::class.java.name) }69//         .map { it.load(false) }70//         .filter(isScript)71//         .filterIsInstance<KClass<out ScriptTemplateWithArgs>>()72//   }73   /**74    * Loads a class reference from a [ClassInfo].75    *76    * @param init false to avoid initializing the class77    */78   private fun ClassInfo.load(init: Boolean): KClass<out Any> =79      Class.forName(name, init, this::class.java.classLoader).kotlin80   private fun doDiscovery(request: DiscoveryRequest): Result<DiscoveryResult> = runCatching {81      val specClasses =82         if (request.onlySelectsSingleClasses()) loadSelectedSpecs(request) else fromClassPaths83      val filtered = specClasses84         .asSequence()85         .filter(selectorFn(request.selectors))86         .filter(filterFn(request.filters))87         // all classes must subclass one of the spec parents88         .filter(isSpecSubclassKt)89         // we don't want abstract classes90         .filterNot(isAbstract)91         .toList()92      log { "After filters there are ${filtered.size} spec classes" }93      log { "[Discovery] Further filtering classes via discovery extensions [$discoveryExtensions]" }94      val afterExtensions = discoveryExtensions95         .fold(filtered) { cl, ext -> ext.afterScan(cl) }96         .sortedBy { it.simpleName }97      log { "After discovery extensions there are ${afterExtensions.size} spec classes" }98      val scriptsEnabled = System.getProperty(KotestEngineProperties.scriptsEnabled) == "true" ||99         System.getenv(KotestEngineProperties.scriptsEnabled) == "true"100//      val scripts = when {101//         scriptsEnabled -> discoverScripts()102//         else -> emptyList()103//      }104      if (scanResult.isInitialized()) runCatching { scanResult.value.close() }105      log { "Discovery result [${afterExtensions.size} specs; scripts]" }106      DiscoveryResult(afterExtensions, emptyList(), null)107   }108   /**109    * Returns whether this is a request that selects single classes110    * only. Used to avoid full classpath scans when not necessary.111    */112   private fun DiscoveryRequest.onlySelectsSingleClasses(): Boolean =113      selectors.isNotEmpty() &&114         selectors.all { it is DiscoverySelector.ClassDiscoverySelector }115   /**116    * Returns a list of [Spec] classes from discovery requests that only have117    * selectors of type [DiscoverySelector.ClassDiscoverySelector].118    */119   private fun loadSelectedSpecs(request: DiscoveryRequest): List<KClass<out Spec>> {120      log { "Discovery: Loading specified classes..." }...

launcher.kt

Source:launcher.kt

...9import io.kotest.engine.TestEngineLauncher10import io.kotest.engine.listener.TestEngineListener11import io.kotest.framework.discovery.Discovery12import io.kotest.framework.discovery.DiscoveryRequest13import io.kotest.framework.discovery.DiscoveryResult14import io.kotest.framework.discovery.DiscoverySelector15import kotlin.reflect.KClass16/**17 * Creates a [TestEngineLauncher] to be used to launch the test engine.18 */19internal fun setupLauncher(20   args: LauncherArgs,21   listener: TestEngineListener,22): Result<TestEngineLauncher> = runCatching {23   val specClass = args.spec?.let { (Class.forName(it) as Class<Spec>).kotlin }24   val (specs, _, error) = specs(specClass, args.packageName)25   val filter = if (args.testpath == null || specClass == null) null else {26      TestPathTestCaseFilter(args.testpath, specClass)27   }28   if (error != null) throw error29   TestEngineLauncher(listener)30      .withExtensions(listOfNotNull(filter))31      .withTagExpression(args.tagExpression?.let { TagExpression(it) })32      .withClasses(specs)33}34/**35 * Returns the spec classes to execute by using an FQN class name, a package scan,36 * or a full scan.37 */38private fun specs(specClass: KClass<out Spec>?, packageName: String?): DiscoveryResult {39   // if the spec class was null, then we perform discovery to locate all the classes40   // otherwise that specific spec class is used41   return when (specClass) {42      null -> scan(packageName)43      else -> DiscoveryResult(listOf(specClass), emptyList(), null)44   }45}46private fun scan(packageName: String?): DiscoveryResult {47   val packageSelector = packageName?.let { DiscoverySelector.PackageDiscoverySelector(it) }48   val req = DiscoveryRequest(selectors = listOfNotNull(packageSelector))49   val discovery = Discovery(emptyList())50   return discovery.discover(req)51}52/**53 * Compares test descriptions to a given test path (delimited with ' -- ').54 * The comparison ignores test prefixes, so an application using the launcher should not55 * include test name prefixes in the test path.56 */57private class TestPathTestCaseFilter(58   private val testPath: String,59   spec: KClass<out Spec>,60) : TestFilter {...

DiscoveryResult

Using AI Code Generation

1val result = DiscoveryResult(DiscoverySelector.Classpath, listOf(DiscoverySelector.Classpath))2val selector = DiscoverySelector.Directory("directory")3val selector = DiscoverySelector.File("file")4val selector = DiscoverySelector.Package("package")5val selector = DiscoverySelector.Script("script")6val selector = DiscoverySelector.Spec("spec")7val selector = DiscoverySelector.Tag("tag")8val selector = DiscoverySelector.Test("test")9val selector = DiscoverySelector.TestClass("testClass")10val selector = DiscoverySelector.TestId("testId")11val selector = DiscoverySelector.TestPath("testPath")12val selector = DiscoverySelector.TestSuite("testSuite")13val selector = DiscoverySelector.TestType("testType")14val selector = DiscoverySelector.Wildcard("wildcard")15val selector = DiscoverySelector.Worker("worker")16val selector = DiscoverySelector.WorkerId("workerId")17val selector = DiscoverySelector.WorkerPath("workerPath")

DiscoveryResult

Using AI Code Generation

1val discoveryResult = DiscoveryResult(DiscoverySelector.default(), DiscoveryConfiguration.default())2val discoveryResult = DiscoveryResult(DiscoverySelector.default(), DiscoveryConfiguration.default())3val discoveryResult = DiscoveryResult(DiscoverySelector.default(), DiscoveryConfiguration.default())4val discoveryResult = DiscoveryResult(DiscoverySelector.default(), DiscoveryConfiguration.default())5val discoveryResult = DiscoveryResult(DiscoverySelector.default(), DiscoveryConfiguration.default())6val discoveryResult = DiscoveryResult(DiscoverySelector.default(), DiscoveryConfiguration.default())7val discoveryResult = DiscoveryResult(DiscoverySelector.default(), DiscoveryConfiguration.default())8val discoveryResult = DiscoveryResult(DiscoverySelector.default(), DiscoveryConfiguration.default())9val discoveryResult = DiscoveryResult(DiscoverySelector.default(), DiscoveryConfiguration.default())10val discoveryResult = DiscoveryResult(DiscoverySelector.default(), DiscoveryConfiguration.default())11val discoveryResult = DiscoveryResult(DiscoverySelector.default(), DiscoveryConfiguration.default())

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.