sdk_test.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497
  1. // Copyright 2019 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. package sdk
  15. import (
  16. "log"
  17. "os"
  18. "runtime"
  19. "testing"
  20. "android/soong/android"
  21. "android/soong/java"
  22. "github.com/google/blueprint/proptools"
  23. )
  24. // Needed in an _test.go file in this package to ensure tests run correctly, particularly in IDE.
  25. func TestMain(m *testing.M) {
  26. if runtime.GOOS != "linux" {
  27. // b/145598135 - Generating host snapshots for anything other than linux is not supported.
  28. log.Printf("Skipping as sdk snapshot generation is only supported on linux not %s", runtime.GOOS)
  29. os.Exit(0)
  30. }
  31. os.Exit(m.Run())
  32. }
  33. // Ensure that prebuilt modules have the same effective visibility as the source
  34. // modules.
  35. func TestSnapshotVisibility(t *testing.T) {
  36. packageBp := `
  37. package {
  38. default_visibility: ["//other/foo"],
  39. }
  40. sdk {
  41. name: "mysdk",
  42. visibility: [
  43. "//other/foo",
  44. // This short form will be replaced with //package:__subpackages__ in the
  45. // generated sdk_snapshot.
  46. ":__subpackages__",
  47. ],
  48. prebuilt_visibility: [
  49. "//prebuilts/mysdk",
  50. ],
  51. java_header_libs: [
  52. "myjavalib",
  53. "mypublicjavalib",
  54. "mydefaultedjavalib",
  55. "myprivatejavalib",
  56. ],
  57. }
  58. java_library {
  59. name: "myjavalib",
  60. // Uses package default visibility
  61. srcs: ["Test.java"],
  62. system_modules: "none",
  63. sdk_version: "none",
  64. }
  65. java_defaults {
  66. name: "java-defaults",
  67. visibility: ["//other/bar"],
  68. }
  69. java_library {
  70. name: "mypublicjavalib",
  71. defaults: ["java-defaults"],
  72. visibility: ["//visibility:public"],
  73. srcs: ["Test.java"],
  74. system_modules: "none",
  75. sdk_version: "none",
  76. }
  77. java_defaults {
  78. name: "myjavadefaults",
  79. visibility: ["//other/bar"],
  80. }
  81. java_library {
  82. name: "mydefaultedjavalib",
  83. defaults: ["myjavadefaults"],
  84. srcs: ["Test.java"],
  85. system_modules: "none",
  86. sdk_version: "none",
  87. }
  88. java_library {
  89. name: "myprivatejavalib",
  90. srcs: ["Test.java"],
  91. visibility: ["//visibility:private"],
  92. system_modules: "none",
  93. sdk_version: "none",
  94. }
  95. `
  96. result := testSdkWithFs(t, ``,
  97. map[string][]byte{
  98. "package/Test.java": nil,
  99. "package/Android.bp": []byte(packageBp),
  100. })
  101. CheckSnapshot(t, result, "mysdk", "package",
  102. checkAndroidBpContents(`
  103. // This is auto-generated. DO NOT EDIT.
  104. java_import {
  105. name: "myjavalib",
  106. prefer: false,
  107. visibility: [
  108. "//other/foo",
  109. "//package",
  110. "//prebuilts/mysdk",
  111. ],
  112. apex_available: ["//apex_available:platform"],
  113. jars: ["java/myjavalib.jar"],
  114. }
  115. java_import {
  116. name: "mypublicjavalib",
  117. prefer: false,
  118. visibility: ["//visibility:public"],
  119. apex_available: ["//apex_available:platform"],
  120. jars: ["java/mypublicjavalib.jar"],
  121. }
  122. java_import {
  123. name: "mydefaultedjavalib",
  124. prefer: false,
  125. visibility: [
  126. "//other/bar",
  127. "//package",
  128. "//prebuilts/mysdk",
  129. ],
  130. apex_available: ["//apex_available:platform"],
  131. jars: ["java/mydefaultedjavalib.jar"],
  132. }
  133. java_import {
  134. name: "myprivatejavalib",
  135. prefer: false,
  136. visibility: [
  137. "//package",
  138. "//prebuilts/mysdk",
  139. ],
  140. apex_available: ["//apex_available:platform"],
  141. jars: ["java/myprivatejavalib.jar"],
  142. }
  143. `))
  144. }
  145. func TestPrebuiltVisibilityProperty_IsValidated(t *testing.T) {
  146. testSdkError(t, `prebuilt_visibility: cannot mix "//visibility:private" with any other visibility rules`, `
  147. sdk {
  148. name: "mysdk",
  149. prebuilt_visibility: [
  150. "//foo",
  151. "//visibility:private",
  152. ],
  153. }
  154. `)
  155. }
  156. func TestPrebuiltVisibilityProperty_AddPrivate(t *testing.T) {
  157. testSdkError(t, `prebuilt_visibility: "//visibility:private" does not widen the visibility`, `
  158. sdk {
  159. name: "mysdk",
  160. prebuilt_visibility: [
  161. "//visibility:private",
  162. ],
  163. java_header_libs: [
  164. "myjavalib",
  165. ],
  166. }
  167. java_library {
  168. name: "myjavalib",
  169. // Uses package default visibility
  170. srcs: ["Test.java"],
  171. system_modules: "none",
  172. sdk_version: "none",
  173. }
  174. `)
  175. }
  176. func TestSdkInstall(t *testing.T) {
  177. sdk := `
  178. sdk {
  179. name: "mysdk",
  180. }
  181. `
  182. result := testSdkWithFs(t, sdk, nil)
  183. CheckSnapshot(t, result, "mysdk", "",
  184. checkAllOtherCopyRules(`
  185. .intermediates/mysdk/common_os/mysdk-current.info -> mysdk-current.info
  186. .intermediates/mysdk/common_os/mysdk-current.zip -> mysdk-current.zip
  187. `))
  188. }
  189. type EmbeddedPropertiesStruct struct {
  190. S_Embedded_Common string `android:"arch_variant"`
  191. S_Embedded_Different string `android:"arch_variant"`
  192. }
  193. type testPropertiesStruct struct {
  194. name string
  195. private string
  196. Public_Ignore string `sdk:"ignore"`
  197. Public_Keep string `sdk:"keep"`
  198. S_Common string
  199. S_Different string `android:"arch_variant"`
  200. A_Common []string
  201. A_Different []string `android:"arch_variant"`
  202. F_Common *bool
  203. F_Different *bool `android:"arch_variant"`
  204. EmbeddedPropertiesStruct
  205. }
  206. func (p *testPropertiesStruct) optimizableProperties() interface{} {
  207. return p
  208. }
  209. func (p *testPropertiesStruct) String() string {
  210. return p.name
  211. }
  212. var _ propertiesContainer = (*testPropertiesStruct)(nil)
  213. func TestCommonValueOptimization(t *testing.T) {
  214. common := &testPropertiesStruct{name: "common"}
  215. structs := []propertiesContainer{
  216. &testPropertiesStruct{
  217. name: "struct-0",
  218. private: "common",
  219. Public_Ignore: "common",
  220. Public_Keep: "keep",
  221. S_Common: "common",
  222. S_Different: "upper",
  223. A_Common: []string{"first", "second"},
  224. A_Different: []string{"alpha", "beta"},
  225. F_Common: proptools.BoolPtr(false),
  226. F_Different: proptools.BoolPtr(false),
  227. EmbeddedPropertiesStruct: EmbeddedPropertiesStruct{
  228. S_Embedded_Common: "embedded_common",
  229. S_Embedded_Different: "embedded_upper",
  230. },
  231. },
  232. &testPropertiesStruct{
  233. name: "struct-1",
  234. private: "common",
  235. Public_Ignore: "common",
  236. Public_Keep: "keep",
  237. S_Common: "common",
  238. S_Different: "lower",
  239. A_Common: []string{"first", "second"},
  240. A_Different: []string{"alpha", "delta"},
  241. F_Common: proptools.BoolPtr(false),
  242. F_Different: proptools.BoolPtr(true),
  243. EmbeddedPropertiesStruct: EmbeddedPropertiesStruct{
  244. S_Embedded_Common: "embedded_common",
  245. S_Embedded_Different: "embedded_lower",
  246. },
  247. },
  248. }
  249. extractor := newCommonValueExtractor(common)
  250. err := extractor.extractCommonProperties(common, structs)
  251. android.AssertDeepEquals(t, "unexpected error", nil, err)
  252. android.AssertDeepEquals(t, "common properties not correct",
  253. &testPropertiesStruct{
  254. name: "common",
  255. private: "",
  256. Public_Ignore: "",
  257. Public_Keep: "keep",
  258. S_Common: "common",
  259. S_Different: "",
  260. A_Common: []string{"first", "second"},
  261. A_Different: []string(nil),
  262. F_Common: proptools.BoolPtr(false),
  263. F_Different: nil,
  264. EmbeddedPropertiesStruct: EmbeddedPropertiesStruct{
  265. S_Embedded_Common: "embedded_common",
  266. S_Embedded_Different: "",
  267. },
  268. },
  269. common)
  270. android.AssertDeepEquals(t, "updated properties[0] not correct",
  271. &testPropertiesStruct{
  272. name: "struct-0",
  273. private: "common",
  274. Public_Ignore: "common",
  275. Public_Keep: "keep",
  276. S_Common: "",
  277. S_Different: "upper",
  278. A_Common: nil,
  279. A_Different: []string{"alpha", "beta"},
  280. F_Common: nil,
  281. F_Different: proptools.BoolPtr(false),
  282. EmbeddedPropertiesStruct: EmbeddedPropertiesStruct{
  283. S_Embedded_Common: "",
  284. S_Embedded_Different: "embedded_upper",
  285. },
  286. },
  287. structs[0])
  288. android.AssertDeepEquals(t, "updated properties[1] not correct",
  289. &testPropertiesStruct{
  290. name: "struct-1",
  291. private: "common",
  292. Public_Ignore: "common",
  293. Public_Keep: "keep",
  294. S_Common: "",
  295. S_Different: "lower",
  296. A_Common: nil,
  297. A_Different: []string{"alpha", "delta"},
  298. F_Common: nil,
  299. F_Different: proptools.BoolPtr(true),
  300. EmbeddedPropertiesStruct: EmbeddedPropertiesStruct{
  301. S_Embedded_Common: "",
  302. S_Embedded_Different: "embedded_lower",
  303. },
  304. },
  305. structs[1])
  306. }
  307. func TestCommonValueOptimization_InvalidArchSpecificVariants(t *testing.T) {
  308. common := &testPropertiesStruct{name: "common"}
  309. structs := []propertiesContainer{
  310. &testPropertiesStruct{
  311. name: "struct-0",
  312. S_Common: "should-be-but-is-not-common0",
  313. },
  314. &testPropertiesStruct{
  315. name: "struct-1",
  316. S_Common: "should-be-but-is-not-common1",
  317. },
  318. }
  319. extractor := newCommonValueExtractor(common)
  320. err := extractor.extractCommonProperties(common, structs)
  321. android.AssertErrorMessageEquals(t, "unexpected error", `field "S_Common" is not tagged as "arch_variant" but has arch specific properties:
  322. "struct-0" has value "should-be-but-is-not-common0"
  323. "struct-1" has value "should-be-but-is-not-common1"`, err)
  324. }
  325. // Ensure that sdk snapshot related environment variables work correctly.
  326. func TestSnapshot_EnvConfiguration(t *testing.T) {
  327. bp := `
  328. sdk {
  329. name: "mysdk",
  330. java_header_libs: ["myjavalib"],
  331. }
  332. java_library {
  333. name: "myjavalib",
  334. srcs: ["Test.java"],
  335. system_modules: "none",
  336. sdk_version: "none",
  337. compile_dex: true,
  338. host_supported: true,
  339. }
  340. `
  341. preparer := android.GroupFixturePreparers(
  342. prepareForSdkTestWithJava,
  343. android.FixtureWithRootAndroidBp(bp),
  344. )
  345. checkZipFile := func(t *testing.T, result *android.TestResult, expected string) {
  346. zipRule := result.ModuleForTests("mysdk", "common_os").Rule("SnapshotZipFiles")
  347. android.AssertStringEquals(t, "snapshot zip file", expected, zipRule.Output.String())
  348. }
  349. t.Run("no env variables", func(t *testing.T) {
  350. result := preparer.RunTest(t)
  351. checkZipFile(t, result, "out/soong/.intermediates/mysdk/common_os/mysdk-current.zip")
  352. CheckSnapshot(t, result, "mysdk", "",
  353. checkAndroidBpContents(`
  354. // This is auto-generated. DO NOT EDIT.
  355. java_import {
  356. name: "myjavalib",
  357. prefer: false,
  358. visibility: ["//visibility:public"],
  359. apex_available: ["//apex_available:platform"],
  360. jars: ["java/myjavalib.jar"],
  361. }
  362. `),
  363. )
  364. })
  365. t.Run("SOONG_SDK_SNAPSHOT_TARGET_BUILD_RELEASE=S", func(t *testing.T) {
  366. result := android.GroupFixturePreparers(
  367. prepareForSdkTestWithJava,
  368. java.PrepareForTestWithJavaDefaultModules,
  369. java.PrepareForTestWithJavaSdkLibraryFiles,
  370. java.FixtureWithLastReleaseApis("mysdklibrary"),
  371. android.FixtureWithRootAndroidBp(`
  372. sdk {
  373. name: "mysdk",
  374. bootclasspath_fragments: ["mybootclasspathfragment"],
  375. }
  376. bootclasspath_fragment {
  377. name: "mybootclasspathfragment",
  378. apex_available: ["myapex"],
  379. contents: ["mysdklibrary"],
  380. hidden_api: {
  381. split_packages: ["*"],
  382. },
  383. }
  384. java_sdk_library {
  385. name: "mysdklibrary",
  386. srcs: ["Test.java"],
  387. compile_dex: true,
  388. sdk_version: "S",
  389. public: {enabled: true},
  390. permitted_packages: ["mysdklibrary"],
  391. }
  392. `),
  393. android.FixtureMergeEnv(map[string]string{
  394. "SOONG_SDK_SNAPSHOT_TARGET_BUILD_RELEASE": "S",
  395. }),
  396. ).RunTest(t)
  397. CheckSnapshot(t, result, "mysdk", "",
  398. checkAndroidBpContents(`
  399. // This is auto-generated. DO NOT EDIT.
  400. prebuilt_bootclasspath_fragment {
  401. name: "mybootclasspathfragment",
  402. prefer: false,
  403. visibility: ["//visibility:public"],
  404. apex_available: ["myapex"],
  405. contents: ["mysdklibrary"],
  406. hidden_api: {
  407. annotation_flags: "hiddenapi/annotation-flags.csv",
  408. metadata: "hiddenapi/metadata.csv",
  409. index: "hiddenapi/index.csv",
  410. stub_flags: "hiddenapi/stub-flags.csv",
  411. all_flags: "hiddenapi/all-flags.csv",
  412. },
  413. }
  414. java_sdk_library_import {
  415. name: "mysdklibrary",
  416. prefer: false,
  417. visibility: ["//visibility:public"],
  418. apex_available: ["//apex_available:platform"],
  419. shared_library: true,
  420. compile_dex: true,
  421. permitted_packages: ["mysdklibrary"],
  422. public: {
  423. jars: ["sdk_library/public/mysdklibrary-stubs.jar"],
  424. stub_srcs: ["sdk_library/public/mysdklibrary_stub_sources"],
  425. current_api: "sdk_library/public/mysdklibrary.txt",
  426. removed_api: "sdk_library/public/mysdklibrary-removed.txt",
  427. sdk_version: "current",
  428. },
  429. }
  430. `),
  431. checkAllCopyRules(`
  432. .intermediates/mybootclasspathfragment/android_common/modular-hiddenapi/annotation-flags.csv -> hiddenapi/annotation-flags.csv
  433. .intermediates/mybootclasspathfragment/android_common/modular-hiddenapi/metadata.csv -> hiddenapi/metadata.csv
  434. .intermediates/mybootclasspathfragment/android_common/modular-hiddenapi/index.csv -> hiddenapi/index.csv
  435. .intermediates/mybootclasspathfragment/android_common/modular-hiddenapi/stub-flags.csv -> hiddenapi/stub-flags.csv
  436. .intermediates/mybootclasspathfragment/android_common/modular-hiddenapi/all-flags.csv -> hiddenapi/all-flags.csv
  437. .intermediates/mysdklibrary.stubs/android_common/combined/mysdklibrary.stubs.jar -> sdk_library/public/mysdklibrary-stubs.jar
  438. .intermediates/mysdklibrary.stubs.source/android_common/metalava/mysdklibrary.stubs.source_api.txt -> sdk_library/public/mysdklibrary.txt
  439. .intermediates/mysdklibrary.stubs.source/android_common/metalava/mysdklibrary.stubs.source_removed.txt -> sdk_library/public/mysdklibrary-removed.txt
  440. `),
  441. )
  442. })
  443. }