Paul Duffin | 047fdca | 2020-02-21 16:06:25 +0000 | [diff] [blame] | 1 | // Copyright (C) 2020 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 | |
| 15 | package sdk |
| 16 | |
| 17 | import ( |
| 18 | "testing" |
| 19 | |
| 20 | "android/soong/android" |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 21 | |
| 22 | "github.com/google/blueprint/proptools" |
Paul Duffin | 047fdca | 2020-02-21 16:06:25 +0000 | [diff] [blame] | 23 | ) |
| 24 | |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 25 | func propertySetFixture() interface{} { |
| 26 | set := newPropertySet() |
| 27 | set.AddProperty("x", "taxi") |
| 28 | set.AddPropertyWithTag("y", 1729, "tag_y") |
| 29 | subset := set.AddPropertySet("sub") |
| 30 | subset.AddPropertyWithTag("x", "taxi", "tag_x") |
| 31 | subset.AddProperty("y", 1729) |
| 32 | return set |
| 33 | } |
| 34 | |
| 35 | func intPtr(i int) *int { return &i } |
| 36 | |
| 37 | type propertyStruct struct { |
| 38 | X *string |
| 39 | Y *int |
| 40 | Unset *bool |
| 41 | Sub struct { |
| 42 | X *string |
| 43 | Y *int |
| 44 | Unset *bool |
| 45 | } |
| 46 | } |
| 47 | |
| 48 | func propertyStructFixture() interface{} { |
| 49 | str := &propertyStruct{} |
| 50 | str.X = proptools.StringPtr("taxi") |
| 51 | str.Y = intPtr(1729) |
| 52 | str.Sub.X = proptools.StringPtr("taxi") |
| 53 | str.Sub.Y = intPtr(1729) |
| 54 | return str |
| 55 | } |
| 56 | |
Paul Duffin | 36474d3 | 2021-03-12 12:19:43 +0000 | [diff] [blame] | 57 | func checkPropertySetFixture(t *testing.T, val interface{}, hasTags bool) { |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 58 | set := val.(*bpPropertySet) |
Paul Duffin | 36474d3 | 2021-03-12 12:19:43 +0000 | [diff] [blame] | 59 | android.AssertDeepEquals(t, "wrong x value", "taxi", set.getValue("x")) |
| 60 | android.AssertDeepEquals(t, "wrong y value", 1729, set.getValue("y")) |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 61 | |
| 62 | subset := set.getValue("sub").(*bpPropertySet) |
Paul Duffin | 36474d3 | 2021-03-12 12:19:43 +0000 | [diff] [blame] | 63 | android.AssertDeepEquals(t, "wrong sub.x value", "taxi", subset.getValue("x")) |
| 64 | android.AssertDeepEquals(t, "wrong sub.y value", 1729, subset.getValue("y")) |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 65 | |
| 66 | if hasTags { |
Paul Duffin | 36474d3 | 2021-03-12 12:19:43 +0000 | [diff] [blame] | 67 | android.AssertDeepEquals(t, "wrong y tag", "tag_y", set.getTag("y")) |
| 68 | android.AssertDeepEquals(t, "wrong sub.x tag", "tag_x", subset.getTag("x")) |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 69 | } else { |
Paul Duffin | 36474d3 | 2021-03-12 12:19:43 +0000 | [diff] [blame] | 70 | android.AssertDeepEquals(t, "wrong y tag", nil, set.getTag("y")) |
| 71 | android.AssertDeepEquals(t, "wrong sub.x tag", nil, subset.getTag("x")) |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 72 | } |
| 73 | } |
| 74 | |
| 75 | func TestAddPropertySimple(t *testing.T) { |
Colin Cross | aba8cd9 | 2025-02-05 16:39:18 -0800 | [diff] [blame^] | 76 | t.Parallel() |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 77 | set := newPropertySet() |
| 78 | for name, val := range map[string]interface{}{ |
| 79 | "x": "taxi", |
| 80 | "y": 1729, |
| 81 | "t": true, |
| 82 | "f": false, |
| 83 | "arr": []string{"a", "b", "c"}, |
| 84 | } { |
| 85 | set.AddProperty(name, val) |
Paul Duffin | 36474d3 | 2021-03-12 12:19:43 +0000 | [diff] [blame] | 86 | android.AssertDeepEquals(t, "wrong value", val, set.getValue(name)) |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 87 | } |
Paul Duffin | 9f4b3bb | 2021-03-16 13:47:36 +0000 | [diff] [blame] | 88 | android.AssertPanicMessageContains(t, "adding x again should panic", `Property "x" already exists in property set`, |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 89 | func() { set.AddProperty("x", "taxi") }) |
Paul Duffin | 9f4b3bb | 2021-03-16 13:47:36 +0000 | [diff] [blame] | 90 | android.AssertPanicMessageContains(t, "adding arr again should panic", `Property "arr" already exists in property set`, |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 91 | func() { set.AddProperty("arr", []string{"d"}) }) |
| 92 | } |
| 93 | |
| 94 | func TestAddPropertySubset(t *testing.T) { |
Colin Cross | aba8cd9 | 2025-02-05 16:39:18 -0800 | [diff] [blame^] | 95 | t.Parallel() |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 96 | getFixtureMap := map[string]func() interface{}{ |
| 97 | "property set": propertySetFixture, |
| 98 | "property struct": propertyStructFixture, |
| 99 | } |
| 100 | |
| 101 | t.Run("add new subset", func(t *testing.T) { |
Colin Cross | aba8cd9 | 2025-02-05 16:39:18 -0800 | [diff] [blame^] | 102 | t.Parallel() |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 103 | for name, getFixture := range getFixtureMap { |
| 104 | t.Run(name, func(t *testing.T) { |
Colin Cross | aba8cd9 | 2025-02-05 16:39:18 -0800 | [diff] [blame^] | 105 | t.Parallel() |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 106 | set := propertySetFixture().(*bpPropertySet) |
| 107 | set.AddProperty("new", getFixture()) |
Paul Duffin | 36474d3 | 2021-03-12 12:19:43 +0000 | [diff] [blame] | 108 | checkPropertySetFixture(t, set, true) |
| 109 | checkPropertySetFixture(t, set.getValue("new"), name == "property set") |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 110 | }) |
| 111 | } |
| 112 | }) |
| 113 | |
| 114 | t.Run("merge existing subset", func(t *testing.T) { |
Colin Cross | aba8cd9 | 2025-02-05 16:39:18 -0800 | [diff] [blame^] | 115 | t.Parallel() |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 116 | for name, getFixture := range getFixtureMap { |
| 117 | t.Run(name, func(t *testing.T) { |
Colin Cross | aba8cd9 | 2025-02-05 16:39:18 -0800 | [diff] [blame^] | 118 | t.Parallel() |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 119 | set := newPropertySet() |
| 120 | subset := set.AddPropertySet("sub") |
| 121 | subset.AddProperty("flag", false) |
| 122 | subset.AddPropertySet("sub") |
| 123 | set.AddProperty("sub", getFixture()) |
| 124 | merged := set.getValue("sub").(*bpPropertySet) |
Paul Duffin | 36474d3 | 2021-03-12 12:19:43 +0000 | [diff] [blame] | 125 | android.AssertDeepEquals(t, "wrong flag value", false, merged.getValue("flag")) |
| 126 | checkPropertySetFixture(t, merged, name == "property set") |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 127 | }) |
| 128 | } |
| 129 | }) |
| 130 | |
| 131 | t.Run("add conflicting subset", func(t *testing.T) { |
Colin Cross | aba8cd9 | 2025-02-05 16:39:18 -0800 | [diff] [blame^] | 132 | t.Parallel() |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 133 | set := propertySetFixture().(*bpPropertySet) |
Paul Duffin | 9f4b3bb | 2021-03-16 13:47:36 +0000 | [diff] [blame] | 134 | android.AssertPanicMessageContains(t, "adding x again should panic", `Property "x" already exists in property set`, |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 135 | func() { set.AddProperty("x", propertySetFixture()) }) |
| 136 | }) |
| 137 | |
| 138 | t.Run("add non-pointer struct", func(t *testing.T) { |
Colin Cross | aba8cd9 | 2025-02-05 16:39:18 -0800 | [diff] [blame^] | 139 | t.Parallel() |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 140 | set := propertySetFixture().(*bpPropertySet) |
| 141 | str := propertyStructFixture().(*propertyStruct) |
Paul Duffin | 9f4b3bb | 2021-03-16 13:47:36 +0000 | [diff] [blame] | 142 | android.AssertPanicMessageContains(t, "adding a non-pointer struct should panic", "Value is a struct, not a pointer to one:", |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 143 | func() { set.AddProperty("new", *str) }) |
| 144 | }) |
| 145 | } |
| 146 | |
| 147 | func TestAddPropertySetNew(t *testing.T) { |
Colin Cross | aba8cd9 | 2025-02-05 16:39:18 -0800 | [diff] [blame^] | 148 | t.Parallel() |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 149 | set := newPropertySet() |
| 150 | subset := set.AddPropertySet("sub") |
| 151 | subset.AddProperty("new", "d^^b") |
Paul Duffin | 36474d3 | 2021-03-12 12:19:43 +0000 | [diff] [blame] | 152 | android.AssertDeepEquals(t, "wrong sub.new value", "d^^b", set.getValue("sub").(*bpPropertySet).getValue("new")) |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 153 | } |
| 154 | |
| 155 | func TestAddPropertySetExisting(t *testing.T) { |
Colin Cross | aba8cd9 | 2025-02-05 16:39:18 -0800 | [diff] [blame^] | 156 | t.Parallel() |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 157 | set := propertySetFixture().(*bpPropertySet) |
| 158 | subset := set.AddPropertySet("sub") |
| 159 | subset.AddProperty("new", "d^^b") |
Paul Duffin | 36474d3 | 2021-03-12 12:19:43 +0000 | [diff] [blame] | 160 | android.AssertDeepEquals(t, "wrong sub.new value", "d^^b", set.getValue("sub").(*bpPropertySet).getValue("new")) |
Martin Stjernholm | 191c25f | 2020-09-10 00:40:37 +0100 | [diff] [blame] | 161 | } |
| 162 | |
Paul Duffin | 047fdca | 2020-02-21 16:06:25 +0000 | [diff] [blame] | 163 | type removeFredTransformation struct { |
| 164 | identityTransformation |
| 165 | } |
| 166 | |
| 167 | func (t removeFredTransformation) transformProperty(name string, value interface{}, tag android.BpPropertyTag) (interface{}, android.BpPropertyTag) { |
| 168 | if name == "fred" { |
| 169 | return nil, nil |
| 170 | } |
| 171 | return value, tag |
| 172 | } |
| 173 | |
Paul Duffin | 180a006 | 2020-02-21 16:06:25 +0000 | [diff] [blame] | 174 | func (t removeFredTransformation) transformPropertySetBeforeContents(name string, propertySet *bpPropertySet, tag android.BpPropertyTag) (*bpPropertySet, android.BpPropertyTag) { |
Paul Duffin | 047fdca | 2020-02-21 16:06:25 +0000 | [diff] [blame] | 175 | if name == "fred" { |
| 176 | return nil, nil |
| 177 | } |
| 178 | return propertySet, tag |
| 179 | } |
| 180 | |
Paul Duffin | 180a006 | 2020-02-21 16:06:25 +0000 | [diff] [blame] | 181 | func (t removeFredTransformation) transformPropertySetAfterContents(name string, propertySet *bpPropertySet, tag android.BpPropertyTag) (*bpPropertySet, android.BpPropertyTag) { |
| 182 | if len(propertySet.properties) == 0 { |
| 183 | return nil, nil |
| 184 | } |
| 185 | return propertySet, tag |
| 186 | } |
| 187 | |
Paul Duffin | 047fdca | 2020-02-21 16:06:25 +0000 | [diff] [blame] | 188 | func TestTransformRemoveProperty(t *testing.T) { |
Colin Cross | aba8cd9 | 2025-02-05 16:39:18 -0800 | [diff] [blame^] | 189 | t.Parallel() |
Paul Duffin | 047fdca | 2020-02-21 16:06:25 +0000 | [diff] [blame] | 190 | set := newPropertySet() |
| 191 | set.AddProperty("name", "name") |
| 192 | set.AddProperty("fred", "12") |
| 193 | |
| 194 | set.transformContents(removeFredTransformation{}) |
| 195 | |
| 196 | contents := &generatedContents{} |
| 197 | outputPropertySet(contents, set) |
Paul Duffin | 36474d3 | 2021-03-12 12:19:43 +0000 | [diff] [blame] | 198 | android.AssertTrimmedStringEquals(t, "removing property failed", "name: \"name\",\n", contents.content.String()) |
Paul Duffin | 047fdca | 2020-02-21 16:06:25 +0000 | [diff] [blame] | 199 | } |
| 200 | |
| 201 | func TestTransformRemovePropertySet(t *testing.T) { |
Colin Cross | aba8cd9 | 2025-02-05 16:39:18 -0800 | [diff] [blame^] | 202 | t.Parallel() |
Paul Duffin | 047fdca | 2020-02-21 16:06:25 +0000 | [diff] [blame] | 203 | set := newPropertySet() |
| 204 | set.AddProperty("name", "name") |
| 205 | set.AddPropertySet("fred") |
| 206 | |
| 207 | set.transformContents(removeFredTransformation{}) |
| 208 | |
| 209 | contents := &generatedContents{} |
| 210 | outputPropertySet(contents, set) |
Paul Duffin | 36474d3 | 2021-03-12 12:19:43 +0000 | [diff] [blame] | 211 | android.AssertTrimmedStringEquals(t, "removing property set failed", "name: \"name\",\n", contents.content.String()) |
Paul Duffin | 047fdca | 2020-02-21 16:06:25 +0000 | [diff] [blame] | 212 | } |