Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 28eda09c authored by Anton Hansson's avatar Anton Hansson
Browse files

Refactor api.go to simplify Android.bp further 

The gitlinter tool consumes the Android.bp file and from it mines
the module names of libraries that contribute to the public API surface.
The format required by the previous incarnation of api.go (creating a
list in Android.bp and passing that multiple times) did not lend itself
to being easily consumed by gitlinter.

So, change some of the constructs to simplify the Android.bp definition:
- hardcode a couple of "anomalies" inside the go code instead (which
  modules have only public APIs and what modules should be filtered
  from the lint DB). There's no real benefit to plumb them through the
  Android.bp.
- only pass the list of modules once (this allows inlining the list)

Also change the output filename of the genrules. This makes no practical
difference but does match the existing genrules.

Bug: 169103987
Test: in the followup-change that defines a combined_apis
Change-Id: I6715fa9d24603e3cbb8b09510b64c2bf6bac1f27
parent ebe021a6

api/api.go

+25 −24
Original line number Diff line number Diff line
@@ -30,22 +30,10 @@ import ( 


// The properties of the combined_apis module type.

type CombinedApisProperties struct {

	// Module libraries that have public APIs

	Public []string

	// Module libraries that have system APIs

	System []string

	// Module libraries that have module_library APIs

	Module_lib []string

	// Module libraries that have system_server APIs

	System_server []string

	// ART module library. The only API library not removed from the filtered api database, because

	// 1) ART apis are available by default to all modules, while other module-to-module deps are

	//    explicit and probably receive more scrutiny anyway

	// 2) The number of ART/libcore APIs is large, so not linting them would create a large gap

	// 3) It's a compromise. Ideally we wouldn't be filtering out any module APIs, and have

	//    per-module lint databases that excludes just that module's APIs. Alas, that's more

	//    difficult to achieve.

	Art_module string

	// Module libraries in the bootclasspath

	Bootclasspath []string

	// Module libraries in system server

	System_server_classpath []string

}



type CombinedApis struct {
@@ -105,7 +93,7 @@ func createMergedTxt(ctx android.LoadHookContext, txt MergedTxtDefinition) { 
	props := genruleProps{}

	props.Name = proptools.StringPtr(ctx.ModuleName() + "-" + filename)

	props.Tools = []string{"metalava"}

	props.Out = []string{txt.TxtFilename}

	props.Out = []string{filename}

	props.Cmd = proptools.StringPtr(metalavaCmd + "$(in) --api $(out)")

	props.Srcs = createSrcs(txt.BaseTxt, txt.Modules, txt.ModuleTag)

	props.Dists = []android.Dist{
@@ -170,33 +158,38 @@ func remove(s []string, v string) []string { 


func createMergedTxts(ctx android.LoadHookContext, props CombinedApisProperties) {

	var textFiles []MergedTxtDefinition

	// Two module libraries currently do not support @SystemApi so only have the public scope.

	bcpWithSystemApi := props.Bootclasspath

	bcpWithSystemApi = remove(bcpWithSystemApi, "conscrypt.module.public.api")

	bcpWithSystemApi = remove(bcpWithSystemApi, "i18n.module.public.api")



	tagSuffix := []string{".api.txt}", ".removed-api.txt}"}

	for i, f := range []string{"current.txt", "removed.txt"} {

		textFiles = append(textFiles, MergedTxtDefinition{

			TxtFilename: f,

			BaseTxt:     ":non-updatable-" + f,

			Modules:     props.Public,

			Modules:     props.Bootclasspath,

			ModuleTag:   "{.public" + tagSuffix[i],

			Scope:       "public",

		})

		textFiles = append(textFiles, MergedTxtDefinition{

			TxtFilename: f,

			BaseTxt:     ":non-updatable-system-" + f,

			Modules:     props.System,

			Modules:     bcpWithSystemApi,

			ModuleTag:   "{.system" + tagSuffix[i],

			Scope:       "system",

		})

		textFiles = append(textFiles, MergedTxtDefinition{

			TxtFilename: f,

			BaseTxt:     ":non-updatable-module-lib-" + f,

			Modules:     props.Module_lib,

			Modules:     bcpWithSystemApi,

			ModuleTag:   "{.module-lib" + tagSuffix[i],

			Scope:       "module-lib",

		})

		textFiles = append(textFiles, MergedTxtDefinition{

			TxtFilename: f,

			BaseTxt:     ":non-updatable-system-server-" + f,

			Modules:     props.System_server,

			Modules:     props.System_server_classpath,

			ModuleTag:   "{.system-server" + tagSuffix[i],

			Scope:       "system-server",

		})
@@ -209,10 +202,18 @@ func createMergedTxts(ctx android.LoadHookContext, props CombinedApisProperties) 
func (a *CombinedApis) createInternalModules(ctx android.LoadHookContext) {

	createMergedTxts(ctx, a.properties)



	createMergedStubsSrcjar(ctx, a.properties.Public)

	createMergedStubsSrcjar(ctx, a.properties.Bootclasspath)



	// For the filtered api versions, we prune all APIs except art module's APIs.

	createFilteredApiVersions(ctx, remove(a.properties.Public, a.properties.Art_module))

	// For the filtered api versions, we prune all APIs except art module's APIs. because

	// 1) ART apis are available by default to all modules, while other module-to-module deps are

	//    explicit and probably receive more scrutiny anyway

	// 2) The number of ART/libcore APIs is large, so not linting them would create a large gap

	// 3) It's a compromise. Ideally we wouldn't be filtering out any module APIs, and have

	//    per-module lint databases that excludes just that module's APIs. Alas, that's more

	//    difficult to achieve.

	filteredModules := a.properties.Bootclasspath

	filteredModules = remove(filteredModules, "art.module.public.api")

	createFilteredApiVersions(ctx, filteredModules)

}



func combinedApisModuleFactory() android.Module {