main.tech.apter.junit.jupiter.robolectric.internal.JUnit5RobolectricTestRunner.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of robolectric-extension Show documentation

This repository aims to bridge the gap between JUnit 5 and Robolectric, enabling developers to leverage the benefits of both frameworks for unit testing Android applications. While Robolectric currently lacks a dedicated JUnit 5 extension, this project proposes a community-driven solution to achieve seamless integration.

The newest version!

package tech.apter.junit.jupiter.robolectric.internal

import org.junit.runners.model.FrameworkMethod
import org.robolectric.RobolectricTestRunner
import org.robolectric.internal.AndroidSandbox
import org.robolectric.internal.SandboxManager
import org.robolectric.internal.SandboxManager.SandboxBuilder
import org.robolectric.internal.SandboxTestRunner
import org.robolectric.internal.bytecode.InstrumentationConfiguration
import org.robolectric.internal.bytecode.Sandbox
import org.robolectric.internal.dependency.DependencyResolver
import org.robolectric.util.inject.Injector
import tech.apter.junit.jupiter.robolectric.RobolectricExtension
import tech.apter.junit.jupiter.robolectric.internal.extensions.createLogger
import tech.apter.junit.jupiter.robolectric.internal.extensions.hasTheSameParameterTypes
import java.lang.reflect.Method

internal data class TestClassContainer(val testClass: Class<*>)

@Suppress("TooManyFunctions")
internal class JUnit5RobolectricTestRunner(
    clazz: Class<*>,
    injector: Injector = defaultInjectorBuilder().bind(
        TestClassContainer::class.java,
        TestClassContainer(testClass = clazz),
    ).build(),
) : RobolectricTestRunner(clazz, injector) {
    private inline val logger get() = createLogger()
    private val childrenCache = mutableListOf()

    override fun getChildren(): MutableList {
        if (childrenCache.isEmpty()) {
            synchronized(childrenCache) {
                if (childrenCache.isEmpty()) {
                    childrenCache.addAll(super.getChildren())
                }
            }
        }
        return childrenCache
    }

    fun frameworkMethod(method: Method): FrameworkMethod = children.first {
        method.name == it.method.name &&
            method.declaringClass.name == it.declaringClass.name &&
            method.hasTheSameParameterTypes(it.method)
    }

    fun bootstrapSdkEnvironment(): AndroidSandbox = sdkEnvironment(children.first())

    fun sdkEnvironment(frameworkMethod: FrameworkMethod): AndroidSandbox {
        return getSandbox(frameworkMethod).also {
            configureSandbox(it, frameworkMethod)
        }
    }

    fun runBeforeTest(
        sdkEnvironment: Sandbox,
        frameworkMethod: FrameworkMethod,
        bootstrappedMethod: Method,
    ) {
        logger.trace { "runBeforeTest ${bootstrappedMethod.declaringClass.simpleName}::${bootstrappedMethod.name}" }
        super.beforeTest(sdkEnvironment, frameworkMethod, bootstrappedMethod)
    }

    fun runAfterTest(frameworkMethod: FrameworkMethod, bootstrappedMethod: Method) {
        logger.trace { "runAfterTest ${frameworkMethod.declaringClass.simpleName}::${frameworkMethod.name}" }
        super.afterTest(frameworkMethod, bootstrappedMethod)
    }

    fun runFinallyAfterTest(sdkEnvironment: Sandbox, frameworkMethod: FrameworkMethod) {
        logger.trace { "runFinallyAfterTest ${frameworkMethod.declaringClass.simpleName}::${frameworkMethod.name}" }
        super.finallyAfterTest(frameworkMethod)
        sdkEnvironment.clearShadowLooperCache()
        sdkEnvironment.resetLooper()
    }

    override fun createClassLoaderConfig(method: FrameworkMethod): InstrumentationConfiguration {
        return InstrumentationConfiguration.Builder(super.createClassLoaderConfig(method))
            .doNotAcquirePackage("tech.apter.junit.jupiter.robolectric.internal.")
            .doNotAcquireClass(RobolectricExtension::class.java).build()
    }

    override fun computeTestMethods() = computeJUnit5TestMethods()

    override fun validateNoNonStaticInnerClass(errors: MutableList) {
        // Skip validation
    }

    override fun isIgnored(child: FrameworkMethod) = isJUnit5Ignored(child)

    override fun validatePublicVoidNoArgMethods(
        annotation: Class,
        isStatic: Boolean,
        errors: MutableList,
    ) = validatePublicVoidNoArgJUnit5Methods(annotation, isStatic, errors)

    override fun getHelperTestRunner(bootstrappedTestClass: Class<*>): SandboxTestRunner.HelperTestRunner =
        HelperTestRunner(bootstrappedTestClass)

    private class HelperTestRunner(bootstrappedTestClass: Class<*>) :
        RobolectricTestRunner.HelperTestRunner(bootstrappedTestClass) {
        override fun computeTestMethods(): MutableList = computeJUnit5TestMethods()

        override fun validateNoNonStaticInnerClass(errors: MutableList) {
            // Skip validation
        }

        override fun isIgnored(child: FrameworkMethod) = isJUnit5Ignored(child)

        override fun validatePublicVoidNoArgMethods(
            annotation: Class,
            isStatic: Boolean,
            errors: MutableList,
        ) = validatePublicVoidNoArgJUnit5Methods(annotation, isStatic, errors)
    }

    internal companion object {
        private fun defaultInjectorBuilder() =
            defaultInjector().bind(SandboxBuilder::class.java, JUnit5RobolectricSandboxBuilder::class.java)
                .bind(DependencyResolver::class.java, JUnit5MavenDependencyResolver::class.java)
                .bind(SandboxManager::class.java, JUnit5RobolectricSandboxManager::class.java)
    }
}