lint-checks/src/test/java/androidx/build/lint/BanInlineOptInTest.kt

/*
 * Copyright 2021 The Android Open Source Project
 *
 * 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.
 */

@file:Suppress("UnstableApiUsage")

package androidx.build.lint

import org.junit.Test
import org.junit.runner.RunWith
import org.junit.runners.JUnit4

@RunWith(JUnit4::class)
class BanInlineOptInTest :
    AbstractLintDetectorTest(
        useDetector = BanInlineOptIn(),
        useIssues = listOf(BanInlineOptIn.ISSUE),
    ) {

    @Test
    fun `Detect inline function with an OptIn annotation`() {
        val input =
            kotlin(
                """
@RequiresOptIn
annotation class ExperimentalSampleAnnotation

@OptIn(ExperimentalSampleAnnotation::class)
inline fun String.myInlineFun() = this.length
            """
                    .trimIndent()
            )

        val expected =
            """
src/ExperimentalSampleAnnotation.kt:5: Error: Inline functions cannot opt into experimental APIs. [BanInlineOptIn]
inline fun String.myInlineFun() = this.length
                  ~~~~~~~~~~~
1 errors, 0 warnings
          """
                .trimIndent()

        check(input).expect(expected)
    }

    @Test
    fun `Detect inline function without an OptIn annotation`() {
        val input =
            kotlin(
                """
inline fun String.myInlineFun() = this.length
            """
                    .trimIndent()
            )

        check(input).expectClean()
    }
}