platform_build_soong/android/team.go

68 lines
1.8 KiB
Go
Raw Normal View History

// Copyright 2020 Google Inc. All rights reserved.
//
// 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
Add test-only and test-target fields to all_teams proto. 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
2024-03-27 14:46:47 +01:00
import "github.com/google/blueprint"
func init() {
RegisterTeamBuildComponents(InitRegistrationContext)
}
func RegisterTeamBuildComponents(ctx RegistrationContext) {
ctx.RegisterModuleType("team", TeamFactory)
}
var PrepareForTestWithTeamBuildComponents = GroupFixturePreparers(
FixtureRegisterWithContext(RegisterTeamBuildComponents),
)
type teamProperties struct {
Trendy_team_id *string `json:"trendy_team_id"`
}
type teamModule struct {
ModuleBase
DefaultableModuleBase
properties teamProperties
}
Add test-only and test-target fields to all_teams proto. 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
2024-03-27 14:46:47 +01:00
type TestModuleInformation struct {
TestOnly bool
TopLevelTarget bool
}
var TestOnlyProviderKey = blueprint.NewProvider[TestModuleInformation]()
// Real work is done for the module that depends on us.
// If needed, the team can serialize the config to json/proto file as well.
func (t *teamModule) GenerateAndroidBuildActions(ctx ModuleContext) {}
func (t *teamModule) TrendyTeamId(ctx ModuleContext) string {
return *t.properties.Trendy_team_id
}
func TeamFactory() Module {
module := &teamModule{}
base := module.base()
module.AddProperties(&base.nameProperties, &module.properties)
InitAndroidModule(module)
InitDefaultableModule(module)
return module
}