xref: /aosp_15_r20/frameworks/base/api/coverage/tools/ExtractFlaggedApisTest.kt (revision d57664e9bc4670b3ecf6748a746a57c557b6bc9e)

/*
 * Copyright (C) 2024 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.
 */

package android.platform.coverage

import com.google.common.truth.extensions.proto.ProtoTruth.assertThat
import com.google.protobuf.TextFormat
import java.nio.file.Files
import java.nio.file.Path
import java.nio.file.StandardOpenOption
import org.junit.After
import org.junit.Before
import org.junit.Test
import org.junit.runner.RunWith
import org.junit.runners.JUnit4

@RunWith(JUnit4::class)
class ExtractFlaggedApisTest {

    companion object {
        const val COMMAND = "java -jar extract-flagged-apis.jar %s %s"
    }

    private var apiTextFile: Path = Files.createTempFile("current", ".txt")
    private var flagToApiMap: Path = Files.createTempFile("flag_api_map", ".textproto")

    @Before
    fun setup() {
        apiTextFile = Files.createTempFile("current", ".txt")
        flagToApiMap = Files.createTempFile("flag_api_map", ".textproto")
    }

    @After
    fun cleanup() {
        Files.deleteIfExists(apiTextFile)
        Files.deleteIfExists(flagToApiMap)
    }

    @Test
    fun extractFlaggedApis_onlyMethodFlag_useMethodFlag() {
        val apiText =
            """
            // Signature format: 2.0
            package android.net.ipsec.ike {
              public final class IkeSession implements java.lang.AutoCloseable {
                method @FlaggedApi("com.android.ipsec.flags.dumpsys_api") public void dump(@NonNull java.io.PrintWriter);
              }
            }
        """
                .trimIndent()
        Files.write(apiTextFile, apiText.toByteArray(Charsets.UTF_8), StandardOpenOption.APPEND)

        val process = Runtime.getRuntime().exec(createCommand())
        process.waitFor()

        val content = Files.readAllBytes(flagToApiMap).toString(Charsets.UTF_8)
        val result = TextFormat.parse(content, FlagApiMap::class.java)

        val expected = FlagApiMap.newBuilder()
        val api =
            JavaMethod.newBuilder()
                .setPackageName("android.net.ipsec.ike")
                .setClassName("IkeSession")
                .setMethodName("dump")
        api.addParameters("java.io.PrintWriter")
        addFlaggedApi(expected, api, "com.android.ipsec.flags.dumpsys_api")
        assertThat(result).isEqualTo(expected.build())
    }

    @Test
    fun extractFlaggedApis_onlyClassFlag_useClassFlag() {
        val apiText =
            """
            // Signature format: 2.0
            package android.net.ipsec.ike {
              @FlaggedApi("com.android.ipsec.flags.dumpsys_api") public final class IkeSession implements java.lang.AutoCloseable {
                method public void dump(@NonNull java.io.PrintWriter);
              }
            }
        """
                .trimIndent()
        Files.write(apiTextFile, apiText.toByteArray(Charsets.UTF_8), StandardOpenOption.APPEND)

        val process = Runtime.getRuntime().exec(createCommand())
        process.waitFor()

        val content = Files.readAllBytes(flagToApiMap).toString(Charsets.UTF_8)
        val result = TextFormat.parse(content, FlagApiMap::class.java)

        val expected = FlagApiMap.newBuilder()
        val api =
            JavaMethod.newBuilder()
                .setPackageName("android.net.ipsec.ike")
                .setClassName("IkeSession")
                .setMethodName("dump")
        api.addParameters("java.io.PrintWriter")
        addFlaggedApi(expected, api, "com.android.ipsec.flags.dumpsys_api")
        assertThat(result).isEqualTo(expected.build())
    }

    @Test
    fun extractFlaggedApis_flaggedConstructorsAreFlaggedApis() {
        val apiText =
            """
            // Signature format: 2.0
            package android.app.pinner {
              @FlaggedApi("android.app.pinner_service_client_api") public class PinnerServiceClient {
                ctor @FlaggedApi("android.app.pinner_service_client_api") public PinnerServiceClient();
              }
            }
        """
                .trimIndent()
        Files.write(apiTextFile, apiText.toByteArray(Charsets.UTF_8), StandardOpenOption.APPEND)

        val process = Runtime.getRuntime().exec(createCommand())
        process.waitFor()

        val content = Files.readAllBytes(flagToApiMap).toString(Charsets.UTF_8)
        val result = TextFormat.parse(content, FlagApiMap::class.java)

        val expected = FlagApiMap.newBuilder()
        val api =
            JavaMethod.newBuilder()
                .setPackageName("android.app.pinner")
                .setClassName("PinnerServiceClient")
                .setMethodName("PinnerServiceClient")
        addFlaggedApi(expected, api, "android.app.pinner_service_client_api")
        assertThat(result).isEqualTo(expected.build())
    }

    @Test
    fun extractFlaggedApis_unflaggedNestedClassShouldUseOuterClassFlag() {
        val apiText =
            """
            // Signature format: 2.0
            package android.location.provider {
              @FlaggedApi(Flags.FLAG_NEW_GEOCODER) public final class ForwardGeocodeRequest implements android.os.Parcelable {
                method public int describeContents();
              }
              public static final class ForwardGeocodeRequest.Builder {
                method @NonNull public android.location.provider.ForwardGeocodeRequest build();
              }
            }
        """
                .trimIndent()
        Files.write(apiTextFile, apiText.toByteArray(Charsets.UTF_8), StandardOpenOption.APPEND)

        val process = Runtime.getRuntime().exec(createCommand())
        process.waitFor()

        val content = Files.readAllBytes(flagToApiMap).toString(Charsets.UTF_8)
        val result = TextFormat.parse(content, FlagApiMap::class.java)

        val expected = FlagApiMap.newBuilder()
        val api1 =
            JavaMethod.newBuilder()
                .setPackageName("android.location.provider")
                .setClassName("ForwardGeocodeRequest")
                .setMethodName("describeContents")
        addFlaggedApi(expected, api1, "Flags.FLAG_NEW_GEOCODER")
        val api2 =
            JavaMethod.newBuilder()
                .setPackageName("android.location.provider")
                .setClassName("ForwardGeocodeRequest.Builder")
                .setMethodName("build")
        addFlaggedApi(expected, api2, "Flags.FLAG_NEW_GEOCODER")
        assertThat(result).ignoringRepeatedFieldOrder().isEqualTo(expected.build())
    }

    @Test
    fun extractFlaggedApis_unflaggedNestedClassShouldUseOuterClassFlag_deeplyNested() {
        val apiText =
            """
            // Signature format: 2.0
            package android.package.xyz {
              @FlaggedApi(outer_class_flag) public final class OuterClass {
                method public int apiInOuterClass();
              }
              public final class OuterClass.Deeply.NestedClass {
                method public void apiInNestedClass();
              }
            }
        """
                .trimIndent()
        Files.write(apiTextFile, apiText.toByteArray(Charsets.UTF_8), StandardOpenOption.APPEND)

        val process = Runtime.getRuntime().exec(createCommand())
        process.waitFor()

        val content = Files.readAllBytes(flagToApiMap).toString(Charsets.UTF_8)
        val result = TextFormat.parse(content, FlagApiMap::class.java)

        val expected = FlagApiMap.newBuilder()
        val api1 =
            JavaMethod.newBuilder()
                .setPackageName("android.package.xyz")
                .setClassName("OuterClass")
                .setMethodName("apiInOuterClass")
        addFlaggedApi(expected, api1, "outer_class_flag")
        val api2 =
            JavaMethod.newBuilder()
                .setPackageName("android.package.xyz")
                .setClassName("OuterClass.Deeply.NestedClass")
                .setMethodName("apiInNestedClass")
        addFlaggedApi(expected, api2, "outer_class_flag")
        assertThat(result).ignoringRepeatedFieldOrder().isEqualTo(expected.build())
    }

    private fun addFlaggedApi(builder: FlagApiMap.Builder, api: JavaMethod.Builder, flag: String) {
        if (builder.containsFlagToApi(flag)) {
            val updatedApis =
                builder.getFlagToApiOrThrow(flag).toBuilder().addJavaMethods(api).build()
            builder.putFlagToApi(flag, updatedApis)
        } else {
            val apis = FlaggedApis.newBuilder().addJavaMethods(api).build()
            builder.putFlagToApi(flag, apis)
        }
    }

    private fun createCommand(): Array<String> {
        val command =
            String.format(COMMAND, apiTextFile.toAbsolutePath(), flagToApiMap.toAbsolutePath())
        return command.split(" ").toTypedArray()
    }
}