build_release_test.go 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  1. // Copyright (C) 2021 The Android Open Source Project
  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. "encoding/json"
  17. "fmt"
  18. "testing"
  19. "android/soong/android"
  20. )
  21. // Tests for build_release.go
  22. var (
  23. // Some additional test specific releases that are added after the currently supported ones and
  24. // so are treated as being for future releases.
  25. buildReleaseFuture1 = initBuildRelease("F1")
  26. buildReleaseFuture2 = initBuildRelease("F2")
  27. )
  28. func TestNameToRelease(t *testing.T) {
  29. t.Run("single release", func(t *testing.T) {
  30. release, err := nameToRelease("S")
  31. android.AssertDeepEquals(t, "errors", nil, err)
  32. android.AssertDeepEquals(t, "release", buildReleaseS, release)
  33. })
  34. t.Run("invalid release", func(t *testing.T) {
  35. release, err := nameToRelease("A")
  36. android.AssertDeepEquals(t, "release", (*buildRelease)(nil), release)
  37. // Uses a wildcard in the error message to allow for additional build releases to be added to
  38. // the supported set without breaking this test.
  39. android.FailIfNoMatchingErrors(t, `unknown release "A", expected one of \[S,Tiramisu,UpsideDownCake,F1,F2,current\]`, []error{err})
  40. })
  41. }
  42. func TestParseBuildReleaseSet(t *testing.T) {
  43. t.Run("single release", func(t *testing.T) {
  44. set, err := parseBuildReleaseSet("S")
  45. android.AssertDeepEquals(t, "errors", nil, err)
  46. android.AssertStringEquals(t, "set", "[S]", set.String())
  47. })
  48. t.Run("open range", func(t *testing.T) {
  49. set, err := parseBuildReleaseSet("F1+")
  50. android.AssertDeepEquals(t, "errors", nil, err)
  51. android.AssertStringEquals(t, "set", "[F1,F2,current]", set.String())
  52. })
  53. t.Run("closed range", func(t *testing.T) {
  54. set, err := parseBuildReleaseSet("S-F1")
  55. android.AssertDeepEquals(t, "errors", nil, err)
  56. android.AssertStringEquals(t, "set", "[S,Tiramisu,UpsideDownCake,F1]", set.String())
  57. })
  58. invalidAReleaseMessage := `unknown release "A", expected one of ` + allBuildReleaseSet.String()
  59. t.Run("invalid release", func(t *testing.T) {
  60. set, err := parseBuildReleaseSet("A")
  61. android.AssertDeepEquals(t, "set", (*buildReleaseSet)(nil), set)
  62. android.AssertStringDoesContain(t, "errors", fmt.Sprint(err), invalidAReleaseMessage)
  63. })
  64. t.Run("invalid release in open range", func(t *testing.T) {
  65. set, err := parseBuildReleaseSet("A+")
  66. android.AssertDeepEquals(t, "set", (*buildReleaseSet)(nil), set)
  67. android.AssertStringDoesContain(t, "errors", fmt.Sprint(err), invalidAReleaseMessage)
  68. })
  69. t.Run("invalid release in closed range start", func(t *testing.T) {
  70. set, err := parseBuildReleaseSet("A-S")
  71. android.AssertDeepEquals(t, "set", (*buildReleaseSet)(nil), set)
  72. android.AssertStringDoesContain(t, "errors", fmt.Sprint(err), invalidAReleaseMessage)
  73. })
  74. t.Run("invalid release in closed range end", func(t *testing.T) {
  75. set, err := parseBuildReleaseSet("Tiramisu-A")
  76. android.AssertDeepEquals(t, "set", (*buildReleaseSet)(nil), set)
  77. android.AssertStringDoesContain(t, "errors", fmt.Sprint(err), invalidAReleaseMessage)
  78. })
  79. t.Run("invalid closed range reversed", func(t *testing.T) {
  80. set, err := parseBuildReleaseSet("F1-S")
  81. android.AssertDeepEquals(t, "set", (*buildReleaseSet)(nil), set)
  82. android.AssertStringDoesContain(t, "errors", fmt.Sprint(err), `invalid closed range, start release "F1" is later than end release "S"`)
  83. })
  84. }
  85. func TestBuildReleaseSetContains(t *testing.T) {
  86. t.Run("contains", func(t *testing.T) {
  87. set, _ := parseBuildReleaseSet("F1-F2")
  88. android.AssertBoolEquals(t, "set contains F1", true, set.contains(buildReleaseFuture1))
  89. android.AssertBoolEquals(t, "set does not contain S", false, set.contains(buildReleaseS))
  90. android.AssertBoolEquals(t, "set contains F2", true, set.contains(buildReleaseFuture2))
  91. android.AssertBoolEquals(t, "set does not contain T", false, set.contains(buildReleaseT))
  92. })
  93. }
  94. func TestPropertyPrunerInvalidTag(t *testing.T) {
  95. type brokenStruct struct {
  96. Broken string `supported_build_releases:"A"`
  97. }
  98. type containingStruct struct {
  99. Nested brokenStruct
  100. }
  101. t.Run("broken struct", func(t *testing.T) {
  102. android.AssertPanicMessageContains(t, "error", "invalid `supported_build_releases` tag on Broken of *sdk.brokenStruct: unknown release \"A\"", func() {
  103. newPropertyPrunerByBuildRelease(&brokenStruct{}, buildReleaseS)
  104. })
  105. })
  106. t.Run("nested broken struct", func(t *testing.T) {
  107. android.AssertPanicMessageContains(t, "error", "invalid `supported_build_releases` tag on Nested.Broken of *sdk.containingStruct: unknown release \"A\"", func() {
  108. newPropertyPrunerByBuildRelease(&containingStruct{}, buildReleaseS)
  109. })
  110. })
  111. }
  112. func TestPropertyPrunerByBuildRelease(t *testing.T) {
  113. type nested struct {
  114. F1_only string `supported_build_releases:"F1"`
  115. }
  116. type mapped struct {
  117. Default string
  118. T_only string `supported_build_releases:"Tiramisu"`
  119. }
  120. type testBuildReleasePruner struct {
  121. Default string
  122. S_and_T_only string `supported_build_releases:"S-Tiramisu"`
  123. T_later string `supported_build_releases:"Tiramisu+"`
  124. Nested nested
  125. Mapped map[string]*mapped
  126. }
  127. inputFactory := func() testBuildReleasePruner {
  128. return testBuildReleasePruner{
  129. Default: "Default",
  130. S_and_T_only: "S_and_T_only",
  131. T_later: "T_later",
  132. Nested: nested{
  133. F1_only: "F1_only",
  134. },
  135. Mapped: map[string]*mapped{
  136. "one": {
  137. Default: "one-default",
  138. T_only: "one-t-only",
  139. },
  140. "two": {
  141. Default: "two-default",
  142. T_only: "two-t-only",
  143. },
  144. },
  145. }
  146. }
  147. marshal := func(t interface{}) string {
  148. bytes, err := json.MarshalIndent(t, "", " ")
  149. if err != nil {
  150. panic(err)
  151. }
  152. return string(bytes)
  153. }
  154. assertJsonEquals := func(t *testing.T, expected, actual interface{}) {
  155. t.Helper()
  156. expectedJson := marshal(expected)
  157. actualJson := marshal(actual)
  158. if actualJson != expectedJson {
  159. t.Errorf("test struct: expected:\n%s\n got:\n%s", expectedJson, actualJson)
  160. }
  161. }
  162. t.Run("target S", func(t *testing.T) {
  163. testStruct := inputFactory()
  164. pruner := newPropertyPrunerByBuildRelease(&testStruct, buildReleaseS)
  165. pruner.pruneProperties(&testStruct)
  166. expected := inputFactory()
  167. expected.T_later = ""
  168. expected.Nested.F1_only = ""
  169. expected.Mapped["one"].T_only = ""
  170. expected.Mapped["two"].T_only = ""
  171. assertJsonEquals(t, expected, testStruct)
  172. })
  173. t.Run("target T", func(t *testing.T) {
  174. testStruct := inputFactory()
  175. pruner := newPropertyPrunerByBuildRelease(&testStruct, buildReleaseT)
  176. pruner.pruneProperties(&testStruct)
  177. expected := inputFactory()
  178. expected.Nested.F1_only = ""
  179. assertJsonEquals(t, expected, testStruct)
  180. })
  181. t.Run("target F1", func(t *testing.T) {
  182. testStruct := inputFactory()
  183. pruner := newPropertyPrunerByBuildRelease(&testStruct, buildReleaseFuture1)
  184. pruner.pruneProperties(&testStruct)
  185. expected := inputFactory()
  186. expected.S_and_T_only = ""
  187. expected.Mapped["one"].T_only = ""
  188. expected.Mapped["two"].T_only = ""
  189. assertJsonEquals(t, expected, testStruct)
  190. })
  191. t.Run("target F2", func(t *testing.T) {
  192. testStruct := inputFactory()
  193. pruner := newPropertyPrunerByBuildRelease(&testStruct, buildReleaseFuture2)
  194. pruner.pruneProperties(&testStruct)
  195. expected := inputFactory()
  196. expected.S_and_T_only = ""
  197. expected.Nested.F1_only = ""
  198. expected.Mapped["one"].T_only = ""
  199. expected.Mapped["two"].T_only = ""
  200. assertJsonEquals(t, expected, testStruct)
  201. })
  202. }