1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
// Copyright 2017 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 java
// Rules for instrumenting classes using jacoco
import (
"fmt"
"path/filepath"
"slices"
"strings"
"github.com/google/blueprint"
"github.com/google/blueprint/proptools"
"android/soong/android"
"android/soong/java/config"
)
func init() {
android.InitRegistrationContext.RegisterParallelSingletonType("device_tests_jacoco_zip", deviceTestsJacocoZipSingletonFactory)
}
var (
jacoco = pctx.AndroidStaticRule("jacoco", blueprint.RuleParams{
Command: `rm -rf $tmpDir && mkdir -p $tmpDir && ` +
`${config.Zip2ZipCmd} -i $in -o $strippedJar $stripSpec && ` +
`${config.JavaCmd} ${config.JavaVmFlags} -jar ${config.JacocoCLIJar} ` +
` instrument --quiet --dest $tmpDir $strippedJar && ` +
`${config.MergeZipsCmd} --ignore-duplicates -j $out $tmpJar $in`,
CommandDeps: []string{
"${config.Zip2ZipCmd}",
"${config.JavaCmd}",
"${config.JacocoCLIJar}",
"${config.MergeZipsCmd}",
},
},
"strippedJar", "stripSpec", "tmpDir", "tmpJar")
)
func jacocoDepsMutator(ctx android.BottomUpMutatorContext) {
type instrumentable interface {
shouldInstrument(ctx android.BaseModuleContext) bool
shouldInstrumentInApex(ctx android.BaseModuleContext) bool
setInstrument(value bool)
}
j, ok := ctx.Module().(instrumentable)
if !ctx.Module().Enabled(ctx) || !ok {
return
}
if j.shouldInstrumentInApex(ctx) {
j.setInstrument(true)
}
if j.shouldInstrument(ctx) && ctx.ModuleName() != "jacocoagent" {
// We can use AddFarVariationDependencies here because, since this dep
// is added as libs only (i.e. a compiletime CLASSPATH entry only),
// the first variant of jacocoagent is sufficient to prevent
// compile time errors.
// At this stage in the build, AddVariationDependencies is not always
// able to procure a variant of jacocoagent that matches the calling
// module.
ctx.AddFarVariationDependencies(ctx.Module().Target().Variations(), libTag, "jacocoagent")
}
}
// Instruments a jar using the Jacoco command line interface. Uses stripSpec to extract a subset
// of the classes in inputJar into strippedJar, instruments strippedJar into tmpJar, and then
// combines the classes in tmpJar with inputJar (preferring the instrumented classes in tmpJar)
// to produce instrumentedJar.
func jacocoInstrumentJar(ctx android.ModuleContext, instrumentedJar, strippedJar android.WritablePath,
inputJar android.Path, stripSpec string) {
// The basename of tmpJar has to be the same as the basename of strippedJar
tmpJar := android.PathForModuleOut(ctx, "jacoco", "tmp", strippedJar.Base())
ctx.Build(pctx, android.BuildParams{
Rule: jacoco,
Description: "jacoco",
Output: instrumentedJar,
ImplicitOutput: strippedJar,
Input: inputJar,
Args: map[string]string{
"strippedJar": strippedJar.String(),
"stripSpec": stripSpec,
"tmpDir": filepath.Dir(tmpJar.String()),
"tmpJar": tmpJar.String(),
},
})
}
func (j *Module) jacocoModuleToZipCommand(ctx android.ModuleContext) string {
includes, err := jacocoFiltersToSpecs(j.properties.Jacoco.Include_filter)
if err != nil {
ctx.PropertyErrorf("jacoco.include_filter", "%s", err.Error())
}
// Also include the default list of classes to exclude from instrumentation.
excludes, err := jacocoFiltersToSpecs(append(j.properties.Jacoco.Exclude_filter, config.DefaultJacocoExcludeFilter...))
if err != nil {
ctx.PropertyErrorf("jacoco.exclude_filter", "%s", err.Error())
}
return jacocoFiltersToZipCommand(includes, excludes)
}
func jacocoFiltersToZipCommand(includes, excludes []string) string {
specs := ""
if len(excludes) > 0 {
specs += android.JoinWithPrefix(excludes, "-x ") + " "
}
if len(includes) > 0 {
specs += strings.Join(includes, " ")
} else {
specs += "'**/*.class'"
}
return specs
}
func jacocoFiltersToSpecs(filters []string) ([]string, error) {
specs := make([]string, len(filters))
var err error
for i, f := range filters {
specs[i], err = jacocoFilterToSpec(f)
if err != nil {
return nil, err
}
}
return proptools.NinjaAndShellEscapeList(specs), nil
}
func jacocoFilterToSpec(filter string) (string, error) {
recursiveWildcard := strings.HasSuffix(filter, "**")
nonRecursiveWildcard := false
if !recursiveWildcard {
nonRecursiveWildcard = strings.HasSuffix(filter, "*")
filter = strings.TrimSuffix(filter, "*")
} else {
filter = strings.TrimSuffix(filter, "**")
}
if recursiveWildcard && !(strings.HasSuffix(filter, ".") || filter == "") {
return "", fmt.Errorf("only '**' or '.**' is supported as recursive wildcard in a filter")
}
if strings.ContainsRune(filter, '*') {
return "", fmt.Errorf("'*' is only supported as the last character in a filter")
}
spec := strings.Replace(filter, ".", "/", -1)
if recursiveWildcard {
spec += "**/*.class"
} else if nonRecursiveWildcard {
spec += "*.class"
} else {
spec += ".class"
}
return spec, nil
}
type JacocoInfo struct {
ReportClassesFile android.Path
Class string
ModuleName string
}
var ApexJacocoInfoProvider = blueprint.NewProvider[[]JacocoInfo]()
type BuildJacocoZipContext interface {
android.BuilderContext
android.OtherModuleProviderContext
}
func BuildJacocoZip(ctx BuildJacocoZipContext, modules []android.ModuleOrProxy, outputFile android.WritablePath) {
jacocoZipBuilder := android.NewRuleBuilder(pctx, ctx)
jacocoZipCmd := jacocoZipBuilder.Command().BuiltTool("soong_zip").
FlagWithOutput("-o ", outputFile).
Flag("-L 0")
for _, m := range modules {
if javaInfo, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok && javaInfo.JacocoInfo.ReportClassesFile != nil {
jacoco := javaInfo.JacocoInfo
jacocoZipCmd.FlagWithArg("-e ", fmt.Sprintf("out/target/common/obj/%s/%s_intermediates/jacoco-report-classes.jar", jacoco.Class, jacoco.ModuleName)).
FlagWithInput("-f ", jacoco.ReportClassesFile)
} else if info, ok := android.OtherModuleProvider(ctx, m, ApexJacocoInfoProvider); ok {
for _, jacoco := range info {
jacocoZipCmd.FlagWithArg("-e ", fmt.Sprintf("out/target/common/obj/%s/%s_intermediates/jacoco-report-classes.jar", jacoco.Class, jacoco.ModuleName)).
FlagWithInput("-f ", jacoco.ReportClassesFile)
}
}
}
jacocoZipBuilder.Build("jacoco_report_classes_zip", "Building jacoco report zip")
}
func deviceTestsJacocoZipSingletonFactory() android.Singleton {
return &deviceTestsJacocoZipSingleton{}
}
type deviceTestsJacocoZipSingleton struct{}
// GenerateBuildActions implements android.Singleton.
func (d *deviceTestsJacocoZipSingleton) GenerateBuildActions(ctx android.SingletonContext) {
var deviceTestModules []android.ModuleOrProxy
ctx.VisitAllModuleProxies(func(m android.ModuleProxy) {
if tsm, ok := android.OtherModuleProvider(ctx, m, android.TestSuiteInfoProvider); ok {
if slices.Contains(tsm.TestSuites, "device-tests") {
deviceTestModules = append(deviceTestModules, m)
}
}
})
jacocoZip := DeviceTestsJacocoReportZip(ctx)
BuildJacocoZip(ctx, deviceTestModules, jacocoZip)
}
func DeviceTestsJacocoReportZip(ctx android.PathContext) android.WritablePath {
return android.PathForOutput(ctx, "device_tests_jacoco_report_classes_all.jar")
}
|
