com.diffplug.selfie.junit5.SelfieGC.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of selfie-runner-junit5 Show documentation
JUnit 5 test runner for Selfie
There is a newer version: 2.4.0
/*
 * Copyright (C) 2023-2024 DiffPlug
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.diffplug.selfie.junit5

import com.diffplug.selfie.ArrayMap
import com.diffplug.selfie.guts.WithinTestGC

/** Search for any test annotation classes which are present on the classpath. */
private val testAnnotations =
    listOf(
            "org.junit.jupiter.api.Test", // junit5,
            "org.junit.jupiter.params.ParameterizedTest",
            "org.junit.Test" // junit4
            )
        .mapNotNull {
          try {
            Class.forName(it).asSubclass(Annotation::class.java)
          } catch (e: ClassNotFoundException) {
            null
          }
        }
private val testSuperclasses =
    listOf(
            "io.kotest.core.spec.Spec", // kotest4+
        )
        .mapNotNull {
          try {
            Class.forName(it)
          } catch (e: ClassNotFoundException) {
            null
          }
        }

/**
 * Searches the whole snapshot directory, finds all the `.ss` files, and prunes any which don't have
 * matching test files anymore.
 */
internal fun findStaleSnapshotFiles(layout: SnapshotFileLayoutJUnit5): List {
  return layout.fs.fileWalk(layout.rootFolder) { walk ->
    walk
        .filter { it.name.endsWith(layout.extension) }
        .map { layout.subpathToClassname(layout.rootFolder.relativize(it)) }
        .filter { !classExistsAndHasTests(it) }
        .toMutableList()
  }
}
private fun classExistsAndHasTests(key: String): Boolean {
  try {
    val clazz = Class.forName(key)
    val isTestClass = testSuperclasses.any { it.isAssignableFrom(clazz) }
    if (isTestClass) {
      return true
    }
    val hasTestAnnotations =
        generateSequence(clazz) { it.superclass }
            .flatMap { it.declaredMethods.asSequence() }
            .any { method -> testAnnotations.any { method.isAnnotationPresent(it) } }
    return hasTestAnnotations
  } catch (e: ClassNotFoundException) {
    // class doesn't exist, so it's definitely stale
    return false
  }
}
internal fun findTestMethodsThatDidntRun(
    className: String,
    testsThatRan: ArrayMap,
): Sequence =
    generateSequence(Class.forName(className)) { it.superclass }
        .flatMap { it.declaredMethods.asSequence() }
        .filter { method -> !testsThatRan.containsKey(method.name) }
        .filter { method -> testAnnotations.any { method.isAnnotationPresent(it) } }
        .map { it.name }