blob: b57bb3fd6a28239b34c4373a7827522ec5a06abf [file] [log] [blame]
Logan Chienee97c3e2018-03-12 16:34:26 +08001// Copyright 2018 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package android
16
17import (
Logan Chienee97c3e2018-03-12 16:34:26 +080018 "testing"
Paul Duffin35781882019-07-25 15:41:09 +010019
20 "github.com/google/blueprint"
Logan Chienee97c3e2018-03-12 16:34:26 +080021)
22
23var neverallowTests = []struct {
Paul Duffin115445b2019-08-07 15:31:07 +010024 // The name of the test.
25 name string
26
27 // Optional test specific rules. If specified then they are used instead of the default rules.
28 rules []Rule
29
30 // Additional contents to add to the virtual filesystem used by the tests.
31 fs map[string][]byte
32
33 // The expected error patterns. If empty then no errors are expected, otherwise each error
34 // reported must be matched by at least one of these patterns. A pattern matches if the error
35 // message contains the pattern. A pattern does not have to match the whole error message.
Paul Duffinb5af6202019-08-05 15:07:57 +010036 expectedErrors []string
Logan Chienee97c3e2018-03-12 16:34:26 +080037}{
Paul Duffin35781882019-07-25 15:41:09 +010038 // Test General Functionality
39
40 // in direct deps tests
41 {
42 name: "not_allowed_in_direct_deps",
Paul Duffin115445b2019-08-07 15:31:07 +010043 rules: []Rule{
44 NeverAllow().InDirectDeps("not_allowed_in_direct_deps"),
45 },
Paul Duffin35781882019-07-25 15:41:09 +010046 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -080047 "top/Android.bp": []byte(`
Paul Duffin35781882019-07-25 15:41:09 +010048 cc_library {
49 name: "not_allowed_in_direct_deps",
50 }`),
Colin Cross98be1bb2019-12-13 20:41:13 -080051 "other/Android.bp": []byte(`
Paul Duffin35781882019-07-25 15:41:09 +010052 cc_library {
53 name: "libother",
54 static_libs: ["not_allowed_in_direct_deps"],
55 }`),
56 },
Paul Duffinb5af6202019-08-05 15:07:57 +010057 expectedErrors: []string{
58 `module "libother": violates neverallow deps:not_allowed_in_direct_deps`,
59 },
Paul Duffin35781882019-07-25 15:41:09 +010060 },
61
Paul Duffin115445b2019-08-07 15:31:07 +010062 // Test android specific rules
Paul Duffin35781882019-07-25 15:41:09 +010063
Paul Duffinc8111702019-07-22 12:13:55 +010064 // include_dir rule tests
65 {
66 name: "include_dir not allowed to reference art",
67 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -080068 "other/Android.bp": []byte(`
Paul Duffinc8111702019-07-22 12:13:55 +010069 cc_library {
70 name: "libother",
71 include_dirs: ["art/libdexfile/include"],
72 }`),
73 },
Paul Duffinb5af6202019-08-05 15:07:57 +010074 expectedErrors: []string{
75 "all usages of 'art' have been migrated",
76 },
Paul Duffinc8111702019-07-22 12:13:55 +010077 },
78 {
79 name: "include_dir can reference another location",
80 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -080081 "other/Android.bp": []byte(`
Paul Duffinc8111702019-07-22 12:13:55 +010082 cc_library {
83 name: "libother",
84 include_dirs: ["another/include"],
85 }`),
86 },
87 },
88 // Treble rule tests
Logan Chienee97c3e2018-03-12 16:34:26 +080089 {
90 name: "no vndk.enabled under vendor directory",
91 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -080092 "vendor/Android.bp": []byte(`
Logan Chienee97c3e2018-03-12 16:34:26 +080093 cc_library {
94 name: "libvndk",
95 vendor_available: true,
96 vndk: {
97 enabled: true,
98 },
99 }`),
100 },
Paul Duffinb5af6202019-08-05 15:07:57 +0100101 expectedErrors: []string{
102 "VNDK can never contain a library that is device dependent",
103 },
Logan Chienee97c3e2018-03-12 16:34:26 +0800104 },
105 {
106 name: "no vndk.enabled under device directory",
107 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -0800108 "device/Android.bp": []byte(`
Logan Chienee97c3e2018-03-12 16:34:26 +0800109 cc_library {
110 name: "libvndk",
111 vendor_available: true,
112 vndk: {
113 enabled: true,
114 },
115 }`),
116 },
Paul Duffinb5af6202019-08-05 15:07:57 +0100117 expectedErrors: []string{
118 "VNDK can never contain a library that is device dependent",
119 },
Logan Chienee97c3e2018-03-12 16:34:26 +0800120 },
Logan Chienaf29bad2018-03-12 16:35:58 +0800121 {
122 name: "vndk-ext under vendor or device directory",
123 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -0800124 "device/Android.bp": []byte(`
Logan Chienaf29bad2018-03-12 16:35:58 +0800125 cc_library {
126 name: "libvndk1_ext",
127 vendor: true,
128 vndk: {
129 enabled: true,
130 },
131 }`),
Colin Cross98be1bb2019-12-13 20:41:13 -0800132 "vendor/Android.bp": []byte(`
Logan Chienaf29bad2018-03-12 16:35:58 +0800133 cc_library {
134 name: "libvndk2_ext",
135 vendor: true,
136 vndk: {
137 enabled: true,
138 },
139 }`),
140 },
Logan Chienaf29bad2018-03-12 16:35:58 +0800141 },
Logan Chienee97c3e2018-03-12 16:34:26 +0800142
143 {
144 name: "no enforce_vintf_manifest.cflags",
145 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -0800146 "Android.bp": []byte(`
Logan Chienee97c3e2018-03-12 16:34:26 +0800147 cc_library {
148 name: "libexample",
149 product_variables: {
150 enforce_vintf_manifest: {
151 cflags: ["-DSHOULD_NOT_EXIST"],
152 },
153 },
154 }`),
155 },
Paul Duffinb5af6202019-08-05 15:07:57 +0100156 expectedErrors: []string{
157 "manifest enforcement should be independent",
158 },
Logan Chienee97c3e2018-03-12 16:34:26 +0800159 },
Logan Chienee97c3e2018-03-12 16:34:26 +0800160
161 {
162 name: "no treble_linker_namespaces.cflags",
163 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -0800164 "Android.bp": []byte(`
Logan Chienee97c3e2018-03-12 16:34:26 +0800165 cc_library {
166 name: "libexample",
167 product_variables: {
168 treble_linker_namespaces: {
169 cflags: ["-DSHOULD_NOT_EXIST"],
170 },
171 },
172 }`),
173 },
Paul Duffinb5af6202019-08-05 15:07:57 +0100174 expectedErrors: []string{
175 "nothing should care if linker namespaces are enabled or not",
176 },
Logan Chienee97c3e2018-03-12 16:34:26 +0800177 },
178 {
179 name: "libc_bionic_ndk treble_linker_namespaces.cflags",
180 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -0800181 "Android.bp": []byte(`
Logan Chienee97c3e2018-03-12 16:34:26 +0800182 cc_library {
183 name: "libc_bionic_ndk",
184 product_variables: {
185 treble_linker_namespaces: {
186 cflags: ["-DSHOULD_NOT_EXIST"],
187 },
188 },
189 }`),
190 },
Logan Chienee97c3e2018-03-12 16:34:26 +0800191 },
Neil Fullerdf5f3562018-10-21 17:19:10 +0100192 {
Dongwon Kang50a299f2019-02-04 09:00:51 -0800193 name: "dependency on updatable-media",
194 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -0800195 "Android.bp": []byte(`
Dongwon Kang50a299f2019-02-04 09:00:51 -0800196 java_library {
197 name: "needs_updatable_media",
198 libs: ["updatable-media"],
199 }`),
200 },
Paul Duffinb5af6202019-08-05 15:07:57 +0100201 expectedErrors: []string{
202 "updatable-media includes private APIs. Use updatable_media_stubs instead.",
203 },
Dongwon Kang50a299f2019-02-04 09:00:51 -0800204 },
Colin Crossfd4f7432019-03-05 15:06:16 -0800205 {
Jeff Sharkey38338a92019-12-15 22:05:02 -0700206 name: "dependency on framework-mediaprovider",
207 fs: map[string][]byte{
208 "Android.bp": []byte(`
209 java_library {
210 name: "needs_framework_mediaprovider",
211 libs: ["framework-mediaprovider"],
212 }`),
213 },
214 expectedErrors: []string{
215 "framework-mediaprovider includes private APIs. Use framework_mediaprovider_stubs instead.",
216 },
217 },
218 {
Colin Crossfd4f7432019-03-05 15:06:16 -0800219 name: "java_device_for_host",
220 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -0800221 "Android.bp": []byte(`
Colin Crossfd4f7432019-03-05 15:06:16 -0800222 java_device_for_host {
223 name: "device_for_host",
224 libs: ["core-libart"],
225 }`),
226 },
Paul Duffinb5af6202019-08-05 15:07:57 +0100227 expectedErrors: []string{
228 "java_device_for_host can only be used in whitelisted projects",
229 },
Colin Crossfd4f7432019-03-05 15:06:16 -0800230 },
Paul Duffinb6c6bdd2019-06-07 11:43:55 +0100231 // Libcore rule tests
232 {
Paul Duffin52d398a2019-06-11 12:31:14 +0100233 name: "sdk_version: \"none\" inside core libraries",
234 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -0800235 "libcore/Android.bp": []byte(`
Paul Duffin52d398a2019-06-11 12:31:14 +0100236 java_library {
237 name: "inside_core_libraries",
238 sdk_version: "none",
239 }`),
240 },
241 },
242 {
243 name: "sdk_version: \"none\" outside core libraries",
244 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -0800245 "Android.bp": []byte(`
Paul Duffin52d398a2019-06-11 12:31:14 +0100246 java_library {
247 name: "outside_core_libraries",
248 sdk_version: "none",
249 }`),
250 },
Paul Duffinb5af6202019-08-05 15:07:57 +0100251 expectedErrors: []string{
252 "module \"outside_core_libraries\": violates neverallow",
253 },
Paul Duffin52d398a2019-06-11 12:31:14 +0100254 },
255 {
256 name: "sdk_version: \"current\"",
257 fs: map[string][]byte{
Colin Cross98be1bb2019-12-13 20:41:13 -0800258 "Android.bp": []byte(`
Paul Duffin52d398a2019-06-11 12:31:14 +0100259 java_library {
260 name: "outside_core_libraries",
261 sdk_version: "current",
262 }`),
263 },
264 },
Logan Chienee97c3e2018-03-12 16:34:26 +0800265}
266
267func TestNeverallow(t *testing.T) {
Logan Chienee97c3e2018-03-12 16:34:26 +0800268 for _, test := range neverallowTests {
Paul Duffin115445b2019-08-07 15:31:07 +0100269 // Create a test per config to allow for test specific config, e.g. test rules.
Colin Cross98be1bb2019-12-13 20:41:13 -0800270 config := TestConfig(buildDir, nil, "", test.fs)
Logan Chienee97c3e2018-03-12 16:34:26 +0800271
Paul Duffinb5af6202019-08-05 15:07:57 +0100272 t.Run(test.name, func(t *testing.T) {
Paul Duffin115445b2019-08-07 15:31:07 +0100273 // If the test has its own rules then use them instead of the default ones.
274 if test.rules != nil {
275 setTestNeverallowRules(config, test.rules)
276 }
Colin Cross98be1bb2019-12-13 20:41:13 -0800277 _, errs := testNeverallow(config)
Paul Duffinb5af6202019-08-05 15:07:57 +0100278 CheckErrorsAgainstExpectations(t, errs, test.expectedErrors)
Logan Chienee97c3e2018-03-12 16:34:26 +0800279 })
280 }
281}
282
Colin Cross98be1bb2019-12-13 20:41:13 -0800283func testNeverallow(config Config) (*TestContext, []error) {
Logan Chienee97c3e2018-03-12 16:34:26 +0800284 ctx := NewTestContext()
Colin Cross4b49b762019-11-22 15:25:03 -0800285 ctx.RegisterModuleType("cc_library", newMockCcLibraryModule)
286 ctx.RegisterModuleType("java_library", newMockJavaLibraryModule)
287 ctx.RegisterModuleType("java_library_host", newMockJavaLibraryModule)
288 ctx.RegisterModuleType("java_device_for_host", newMockJavaLibraryModule)
Logan Chienee97c3e2018-03-12 16:34:26 +0800289 ctx.PostDepsMutators(registerNeverallowMutator)
Colin Cross98be1bb2019-12-13 20:41:13 -0800290 ctx.Register(config)
Logan Chienee97c3e2018-03-12 16:34:26 +0800291
Colin Cross98be1bb2019-12-13 20:41:13 -0800292 _, errs := ctx.ParseBlueprintsFiles("Android.bp")
Logan Chienee97c3e2018-03-12 16:34:26 +0800293 if len(errs) > 0 {
294 return ctx, errs
295 }
296
297 _, errs = ctx.PrepareBuildActions(config)
298 return ctx, errs
299}
300
Neil Fullerdf5f3562018-10-21 17:19:10 +0100301type mockCcLibraryProperties struct {
Paul Duffinc8111702019-07-22 12:13:55 +0100302 Include_dirs []string
Logan Chienee97c3e2018-03-12 16:34:26 +0800303 Vendor_available *bool
Paul Duffin35781882019-07-25 15:41:09 +0100304 Static_libs []string
Logan Chienee97c3e2018-03-12 16:34:26 +0800305
306 Vndk struct {
307 Enabled *bool
308 Support_system_process *bool
309 Extends *string
310 }
311
312 Product_variables struct {
313 Enforce_vintf_manifest struct {
314 Cflags []string
315 }
316
317 Treble_linker_namespaces struct {
318 Cflags []string
319 }
320 }
321}
322
323type mockCcLibraryModule struct {
324 ModuleBase
Neil Fullerdf5f3562018-10-21 17:19:10 +0100325 properties mockCcLibraryProperties
Logan Chienee97c3e2018-03-12 16:34:26 +0800326}
327
328func newMockCcLibraryModule() Module {
329 m := &mockCcLibraryModule{}
330 m.AddProperties(&m.properties)
331 InitAndroidModule(m)
332 return m
333}
334
Paul Duffin35781882019-07-25 15:41:09 +0100335type neverallowTestDependencyTag struct {
336 blueprint.BaseDependencyTag
337 name string
338}
339
340var staticDepTag = neverallowTestDependencyTag{name: "static"}
341
342func (c *mockCcLibraryModule) DepsMutator(ctx BottomUpMutatorContext) {
343 for _, lib := range c.properties.Static_libs {
344 ctx.AddDependency(ctx.Module(), staticDepTag, lib)
345 }
346}
347
Logan Chienee97c3e2018-03-12 16:34:26 +0800348func (p *mockCcLibraryModule) GenerateAndroidBuildActions(ModuleContext) {
349}
Neil Fullerdf5f3562018-10-21 17:19:10 +0100350
351type mockJavaLibraryProperties struct {
Paul Duffina3d09862019-06-11 13:40:47 +0100352 Libs []string
353 Sdk_version *string
Neil Fullerdf5f3562018-10-21 17:19:10 +0100354}
355
356type mockJavaLibraryModule struct {
357 ModuleBase
358 properties mockJavaLibraryProperties
359}
360
361func newMockJavaLibraryModule() Module {
362 m := &mockJavaLibraryModule{}
363 m.AddProperties(&m.properties)
364 InitAndroidModule(m)
365 return m
366}
367
Neil Fullerdf5f3562018-10-21 17:19:10 +0100368func (p *mockJavaLibraryModule) GenerateAndroidBuildActions(ModuleContext) {
369}