LoggingRule.kt 2.0 KB
/*
 * Copyright 2023-2024 LiveKit, Inc.
 *
 * 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
 *
 *     http://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 io.livekit.android.test.util

import android.util.Log
import io.livekit.android.LiveKit
import io.livekit.android.util.LoggingLevel
import org.junit.rules.TestRule
import org.junit.runner.Description
import org.junit.runners.model.Statement
import timber.log.Timber

/**
 * Add this rule to a test class to turn on logs.
 */
class LoggingRule : TestRule {

    companion object {

        val logTree = object : Timber.DebugTree() {
            override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
                val priorityChar = when (priority) {
                    Log.VERBOSE -> "v"
                    Log.DEBUG -> "d"
                    Log.INFO -> "i"
                    Log.WARN -> "w"
                    Log.ERROR -> "e"
                    Log.ASSERT -> "a"
                    else -> "?"
                }

                println("$priorityChar: $tag: $message")
                if (t != null) {
                    println(t.toString())
                }
            }
        }
    }

    override fun apply(base: Statement, description: Description?) = object : Statement() {
        override fun evaluate() {
            val oldLoggingLevel = LiveKit.loggingLevel
            Timber.plant(logTree)
            LiveKit.loggingLevel = LoggingLevel.VERBOSE
            base.evaluate()
            Timber.uproot(logTree)
            LiveKit.loggingLevel = oldLoggingLevel
        }
    }
}