check-flagged-apis: parse flag names and values
Teach check-flagged-apis to parse the parsed_flags protobuf generated by aconfig. Note: `m all_aconfig_declarations` generates a protobuf file that contains all info about all flags. Bug: 334870672 Test: atest --host check-flagged-apis-test Test: check-flagged-apis --api-signature out/target/product/mainline_x86/obj/ETC/frameworks-base-api-current.txt_intermediates/frameworks-base-api-current.txt --flag-values out/soong/.intermediates/all_aconfig_declarations.pb Change-Id: I397b32ae2a373b429ef6ce22e0a06a0f15202b91
This commit is contained in:
@@ -23,6 +23,7 @@ java_defaults {
|
|||||||
"src/com/android/checkflaggedapis/Main.kt",
|
"src/com/android/checkflaggedapis/Main.kt",
|
||||||
],
|
],
|
||||||
static_libs: [
|
static_libs: [
|
||||||
|
"libaconfig_java_proto_lite",
|
||||||
"metalava-signature-reader",
|
"metalava-signature-reader",
|
||||||
"metalava-tools-common-m2-deps",
|
"metalava-tools-common-m2-deps",
|
||||||
],
|
],
|
||||||
|
@@ -15,8 +15,11 @@
|
|||||||
*/
|
*/
|
||||||
package com.android.checkflaggedapis
|
package com.android.checkflaggedapis
|
||||||
|
|
||||||
|
import android.aconfig.Aconfig
|
||||||
import com.android.tradefed.testtype.DeviceJUnit4ClassRunner
|
import com.android.tradefed.testtype.DeviceJUnit4ClassRunner
|
||||||
import com.android.tradefed.testtype.junit4.BaseHostJUnit4Test
|
import com.android.tradefed.testtype.junit4.BaseHostJUnit4Test
|
||||||
|
import java.io.ByteArrayInputStream
|
||||||
|
import java.io.ByteArrayOutputStream
|
||||||
import org.junit.Assert.assertEquals
|
import org.junit.Assert.assertEquals
|
||||||
import org.junit.Test
|
import org.junit.Test
|
||||||
import org.junit.runner.RunWith
|
import org.junit.runner.RunWith
|
||||||
@@ -33,6 +36,22 @@ private val API_SIGNATURE =
|
|||||||
"""
|
"""
|
||||||
.trim()
|
.trim()
|
||||||
|
|
||||||
|
private val PARSED_FLAGS =
|
||||||
|
{
|
||||||
|
val parsed_flag =
|
||||||
|
Aconfig.parsed_flag
|
||||||
|
.newBuilder()
|
||||||
|
.setPackage("android.flag")
|
||||||
|
.setName("foo")
|
||||||
|
.setState(Aconfig.flag_state.ENABLED)
|
||||||
|
.setPermission(Aconfig.flag_permission.READ_ONLY)
|
||||||
|
.build()
|
||||||
|
val parsed_flags = Aconfig.parsed_flags.newBuilder().addParsedFlag(parsed_flag).build()
|
||||||
|
val binaryProto = ByteArrayOutputStream()
|
||||||
|
parsed_flags.writeTo(binaryProto)
|
||||||
|
ByteArrayInputStream(binaryProto.toByteArray())
|
||||||
|
}()
|
||||||
|
|
||||||
@RunWith(DeviceJUnit4ClassRunner::class)
|
@RunWith(DeviceJUnit4ClassRunner::class)
|
||||||
class CheckFlaggedApisTest : BaseHostJUnit4Test() {
|
class CheckFlaggedApisTest : BaseHostJUnit4Test() {
|
||||||
@Test
|
@Test
|
||||||
@@ -41,4 +60,11 @@ class CheckFlaggedApisTest : BaseHostJUnit4Test() {
|
|||||||
val actual = parseApiSignature("in-memory", API_SIGNATURE.byteInputStream())
|
val actual = parseApiSignature("in-memory", API_SIGNATURE.byteInputStream())
|
||||||
assertEquals(expected, actual)
|
assertEquals(expected, actual)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun testParseFlagValues() {
|
||||||
|
val expected: Map<Flag, Boolean> = mapOf(Flag("android.flag.foo") to true)
|
||||||
|
val actual = parseFlagValues(PARSED_FLAGS)
|
||||||
|
assertEquals(expected, actual)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@@ -17,6 +17,7 @@
|
|||||||
|
|
||||||
package com.android.checkflaggedapis
|
package com.android.checkflaggedapis
|
||||||
|
|
||||||
|
import android.aconfig.Aconfig
|
||||||
import com.android.tools.metalava.model.BaseItemVisitor
|
import com.android.tools.metalava.model.BaseItemVisitor
|
||||||
import com.android.tools.metalava.model.FieldItem
|
import com.android.tools.metalava.model.FieldItem
|
||||||
import com.android.tools.metalava.model.text.ApiFile
|
import com.android.tools.metalava.model.text.ApiFile
|
||||||
@@ -98,6 +99,15 @@ The tool will exit with a non-zero exit code if any flagged APIs are found to be
|
|||||||
""")
|
""")
|
||||||
.path(mustExist = true, canBeDir = false, mustBeReadable = true)
|
.path(mustExist = true, canBeDir = false, mustBeReadable = true)
|
||||||
.required()
|
.required()
|
||||||
|
private val flagValuesPath by
|
||||||
|
option("--flag-values")
|
||||||
|
.help(
|
||||||
|
"""
|
||||||
|
Path to aconfig parsed_flags binary proto file.
|
||||||
|
Tip: `m all_aconfig_declarations` will generate a file that includes all information about all flags.
|
||||||
|
""")
|
||||||
|
.path(mustExist = true, canBeDir = false, mustBeReadable = true)
|
||||||
|
.required()
|
||||||
|
|
||||||
override fun run() {
|
override fun run() {
|
||||||
@Suppress("UNUSED_VARIABLE")
|
@Suppress("UNUSED_VARIABLE")
|
||||||
@@ -105,6 +115,8 @@ The tool will exit with a non-zero exit code if any flagged APIs are found to be
|
|||||||
apiSignaturePath.toFile().inputStream().use {
|
apiSignaturePath.toFile().inputStream().use {
|
||||||
parseApiSignature(apiSignaturePath.toString(), it)
|
parseApiSignature(apiSignaturePath.toString(), it)
|
||||||
}
|
}
|
||||||
|
@Suppress("UNUSED_VARIABLE")
|
||||||
|
val flags = flagValuesPath.toFile().inputStream().use { parseFlagValues(it) }
|
||||||
throw ProgramResult(0)
|
throw ProgramResult(0)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -132,4 +144,11 @@ internal fun parseApiSignature(path: String, input: InputStream): Set<Pair<Symbo
|
|||||||
return output
|
return output
|
||||||
}
|
}
|
||||||
|
|
||||||
|
internal fun parseFlagValues(input: InputStream): Map<Flag, Boolean> {
|
||||||
|
val parsedFlags = Aconfig.parsed_flags.parseFrom(input).getParsedFlagList()
|
||||||
|
return parsedFlags.associateBy(
|
||||||
|
{ Flag("${it.getPackage()}.${it.getName()}") },
|
||||||
|
{ it.getState() == Aconfig.flag_state.ENABLED })
|
||||||
|
}
|
||||||
|
|
||||||
fun main(args: Array<String>) = CheckCommand().main(args)
|
fun main(args: Array<String>) = CheckCommand().main(args)
|
||||||
|
Reference in New Issue
Block a user