StrixOS/build_soong
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add test-only and test-target fields to all_teams proto.

Browse Source 
The `test-only` flag designates the module contains test-only, not
production code.  In order to generate code-coverage reports, we wanted
a way to filter out code (like java_library) that is test-only and
doesn't need to be in the report.
   The XXX_test modules will have test-only set automatically.
   For modules like `java_library`, users will be a able to set this in
   the Android.bp file.
   As a follow-up, I'll run some queries to find modules that are only
   reachable from top level test targets and mark them test-only as
   appropriate.

`test-only` is being added to the team.proto and will be written via the
`all_teams` target.

Currently, it is challenging to find "all top level test targets".
I'm adding another field to mark the target as a "top level test
target" if it is a XXX_test or XXX_test_host module.  The goal is to
mark all modules the user intended to run as a test, either with
tradefed or directly as a native test.

I added 'module-type/kind' to the proto so I can do some queries:

 gqui from  "flatten(out/soong/ownership/all_teams.pb, teams)" proto team.proto:AllTeams 'select teams.kind, count(*) where teams.top_level_target = true group by teams.kind'
+--------------+----------+
|  teams.kind  | count(*) |
+--------------+----------+
| android_test |     1379 |
| art_cc_test  |       56 |
| cc_benchmark |       68 |
| cc_fuzz      |      515 |
| cc_test      |     3519 |
| cc_test_host |        6 |
| java_fuzz    |        5 |
| java_test    |      773 |
+--------------+----------+

% gqui from  "flatten(~/aosp-main-with-phones/out/soong/ownership/all_teams.pb, teams)" proto team.proto:AllTeams 'select teams.kind ,count(*) where teams.test_only = true group by teams.kind'
+--------------------------+----------+
|        teams.kind        | count(*) |
+--------------------------+----------+
| android_test             |     1379 |
| android_test_helper_app  |     1678 |
| art_cc_test              |       56 |
| art_cc_test_library      |       13 |
| cc_benchmark             |       68 |
| cc_fuzz                  |      515 |
| cc_test                  |     3519 |
| cc_test_host             |        6 |
| cc_test_library          |      484 |
| java_library             |        2 |
| java_test                |      773 |
| java_test_helper_library |       29 |
+--------------------------+----------+

All modules can be seen here: https://docs.google.com/spreadsheets/d/1Zqbh7lDDdlI1xVmrN9fZ8bm8XD7EoORjjiPqbMvAKgQ/edit#gid=396553017

FOLLOW UP cls:
  *) Add more top level tests, like sh_test and python_test
  *) Add validation so that only modules currently marked test-only
     can depend on modules marked test-only
  *) Remove test_spec, code_metadata, TestModuleProviderKey: aosp/2928500

Test: go test ./java ./cc ./android
Test: m blueprint_tests
Test: m nothing --no-skip-soong-tests
    !!  android already failing on selects_test
Test: m all_teams  && gqui from  "flatten(out/soong/ownership/all_teams.pb, teams)"

Change-Id: Ib97dca60989aa9d7f000727c92af2e354926f072
This commit is contained in:
Ronald Braunstein
2024-03-27 06:46:47 -07:00
parent 8982b1c49e
commit c560309e30
8 changed files with 220 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
android/all_teams.go
View File

@@ -23,9 +23,18 @@ func registerAllTeamBuildComponents(ctx RegistrationContext) {
}
// For each module, list the team or the bpFile the module is defined in.
type moduleTeamInfo struct {
type moduleTeamAndTestInfo struct {
// Name field from bp file for the team
teamName string
bpFile string
// Blueprint file the module is located in.
bpFile string
// Is this module only used by tests.
testOnly bool
// Is this a directly testable target by running the module directly
// or via tradefed.
topLevelTestTarget bool
// String name indicating the module, like `java_library` for reporting.
kind string
}
type allTeamsSingleton struct {
@@ -37,16 +46,16 @@ type allTeamsSingleton struct {
// Map of all team modules we visit during GenerateBuildActions
teams map[string]teamProperties
// Keeps track of team information or bp file for each module we visit.
teams_for_mods map[string]moduleTeamInfo
teams_for_mods map[string]moduleTeamAndTestInfo
}
// See if there is a package module for the given bpFilePath with a team defined, if so return the team.
// If not ascend up to the parent directory and do the same.
func (this *allTeamsSingleton) lookupDefaultTeam(bpFilePath string) (teamProperties, bool) {
func (t *allTeamsSingleton) lookupDefaultTeam(bpFilePath string) (teamProperties, bool) {
// return the Default_team listed in the package if is there.
if p, ok := this.packages[bpFilePath]; ok {
if t := p.Default_team; t != nil {
return this.teams[*p.Default_team], true
if p, ok := t.packages[bpFilePath]; ok {
if defaultTeam := p.Default_team; defaultTeam != nil {
return t.teams[*defaultTeam], true
}
}
// Strip a directory and go up.
@@ -57,72 +66,79 @@ func (this *allTeamsSingleton) lookupDefaultTeam(bpFilePath string) (teamPropert
if current == "." {
return teamProperties{}, false
}
return this.lookupDefaultTeam(filepath.Join(parent, base))
return t.lookupDefaultTeam(filepath.Join(parent, base))
}
// Create a rule to run a tool to collect all the intermediate files
// which list the team per module into one proto file.
func (this *allTeamsSingleton) GenerateBuildActions(ctx SingletonContext) {
this.packages = make(map[string]packageProperties)
this.teams = make(map[string]teamProperties)
this.teams_for_mods = make(map[string]moduleTeamInfo)
// Visit all modules and collect all teams and use WriteFileRuleVerbatim
// to write it out.
func (t *allTeamsSingleton) GenerateBuildActions(ctx SingletonContext) {
t.packages = make(map[string]packageProperties)
t.teams = make(map[string]teamProperties)
t.teams_for_mods = make(map[string]moduleTeamAndTestInfo)
ctx.VisitAllModules(func(module Module) {
bpFile := ctx.BlueprintFile(module)
testModInfo := TestModuleInformation{}
if tmi, ok := SingletonModuleProvider(ctx, module, TestOnlyProviderKey); ok {
testModInfo = tmi
}
// Package Modules and Team Modules are stored in a map so we can look them up by name for
// modules without a team.
if pack, ok := module.(*packageModule); ok {
// Packages don't have names, use the blueprint file as the key. we can't get qualifiedModuleId in this context.
// Packages don't have names, use the blueprint file as the key. we can't get qualifiedModuleId in t context.
pkgKey := bpFile
this.packages[pkgKey] = pack.properties
t.packages[pkgKey] = pack.properties
return
}
if team, ok := module.(*teamModule); ok {
this.teams[team.Name()] = team.properties
t.teams[team.Name()] = team.properties
return
}
// If a team name is given for a module, store it.
// Otherwise store the bpFile so we can do a package walk later.
if module.base().Team() != "" {
this.teams_for_mods[module.Name()] = moduleTeamInfo{teamName: module.base().Team(), bpFile: bpFile}
} else {
this.teams_for_mods[module.Name()] = moduleTeamInfo{bpFile: bpFile}
entry := moduleTeamAndTestInfo{
bpFile: bpFile,
testOnly: testModInfo.TestOnly,
topLevelTestTarget: testModInfo.TopLevelTarget,
kind: ctx.ModuleType(module),
teamName: module.base().Team(),
}
t.teams_for_mods[module.Name()] = entry
})
// Visit all modules again and lookup the team name in the package or parent package if the team
// isn't assignged at the module level.
allTeams := this.lookupTeamForAllModules()
allTeams := t.lookupTeamForAllModules()
this.outputPath = PathForOutput(ctx, ownershipDirectory, allTeamsFile)
t.outputPath = PathForOutput(ctx, ownershipDirectory, allTeamsFile)
data, err := proto.Marshal(allTeams)
if err != nil {
ctx.Errorf("Unable to marshal team data. %s", err)
}
WriteFileRuleVerbatim(ctx, this.outputPath, string(data))
ctx.Phony("all_teams", this.outputPath)
WriteFileRuleVerbatim(ctx, t.outputPath, string(data))
ctx.Phony("all_teams", t.outputPath)
}
func (this *allTeamsSingleton) MakeVars(ctx MakeVarsContext) {
ctx.DistForGoal("all_teams", this.outputPath)
func (t *allTeamsSingleton) MakeVars(ctx MakeVarsContext) {
ctx.DistForGoal("all_teams", t.outputPath)
}
// Visit every (non-package, non-team) module and write out a proto containing
// either the declared team data for that module or the package default team data for that module.
func (this *allTeamsSingleton) lookupTeamForAllModules() *team_proto.AllTeams {
teamsProto := make([]*team_proto.Team, len(this.teams_for_mods))
for i, moduleName := range SortedKeys(this.teams_for_mods) {
m, _ := this.teams_for_mods[moduleName]
func (t *allTeamsSingleton) lookupTeamForAllModules() *team_proto.AllTeams {
teamsProto := make([]*team_proto.Team, len(t.teams_for_mods))
for i, moduleName := range SortedKeys(t.teams_for_mods) {
m, _ := t.teams_for_mods[moduleName]
teamName := m.teamName
var teamProperties teamProperties
found := false
if teamName != "" {
teamProperties, found = this.teams[teamName]
teamProperties, found = t.teams[teamName]
} else {
teamProperties, found = this.lookupDefaultTeam(m.bpFile)
teamProperties, found = t.lookupDefaultTeam(m.bpFile)
}
trendy_team_id := ""
@@ -130,22 +146,18 @@ func (this *allTeamsSingleton) lookupTeamForAllModules() *team_proto.AllTeams {
trendy_team_id = *teamProperties.Trendy_team_id
}
var files []string
teamData := new(team_proto.Team)
*teamData = team_proto.Team{
TargetName: proto.String(moduleName),
Path: proto.String(m.bpFile),
TestOnly: proto.Bool(m.testOnly),
TopLevelTarget: proto.Bool(m.topLevelTestTarget),
Kind: proto.String(m.kind),
}
if trendy_team_id != "" {
*teamData = team_proto.Team{
TrendyTeamId: proto.String(trendy_team_id),
TargetName: proto.String(moduleName),
Path: proto.String(m.bpFile),
File: files,
}
teamData.TrendyTeamId = proto.String(trendy_team_id)
} else {
// Clients rely on the TrendyTeamId optional field not being set.
*teamData = team_proto.Team{
TargetName: proto.String(moduleName),
Path: proto.String(m.bpFile),
File: files,
}
}
teamsProto[i] = teamData
}