2020-02-05 22:45:11 +01:00
|
|
|
// Copyright 2020 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 proptools
|
|
|
|
|
2023-12-01 05:53:54 +01:00
|
|
|
import (
|
Select statements
Select statements are a new blueprint feature inspired by bazel's select
statements. They are essentially alternative syntax for soong config
variables that require less boilerplate. In addition, they support
making decisions based on a module's variant, which will eliminate
the need for manual property struct manipulation, such as the arch
mutator's arch: and target: properties.
In order to support decisions based on the variant, select statements
cannot be evaluated as soon as they're parsed. Instead, they must be
stored in the property struct unevaluated. This means that individual
properties need to change their type from say, string, to
Configurable[string]. Currently, only configurable strings, bools, and
string slices are supported, but more types can be added later.
The module implementation must call my_property.Evaluate(ctx) in order
to get the final, resolved value of the select statement.
Bug: 323382414
Test: go tests
Change-Id: I62f8721d7f0ac3d1df4a06d7eaa260a5aa7fcba3
2024-02-02 02:44:27 +01:00
|
|
|
"reflect"
|
2023-12-01 05:53:54 +01:00
|
|
|
"testing"
|
|
|
|
)
|
2020-02-05 22:45:11 +01:00
|
|
|
|
|
|
|
func TestPropertyNameForField(t *testing.T) {
|
|
|
|
tests := []struct {
|
|
|
|
name string
|
|
|
|
input string
|
|
|
|
want string
|
|
|
|
}{
|
|
|
|
{
|
|
|
|
name: "short",
|
|
|
|
input: "S",
|
|
|
|
want: "s",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "long",
|
|
|
|
input: "String",
|
|
|
|
want: "string",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "uppercase",
|
|
|
|
input: "STRING",
|
|
|
|
want: "STRING",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "mixed",
|
|
|
|
input: "StRiNg",
|
|
|
|
want: "stRiNg",
|
|
|
|
},
|
2020-02-06 02:10:18 +01:00
|
|
|
{
|
|
|
|
name: "underscore",
|
|
|
|
input: "Under_score",
|
|
|
|
want: "under_score",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "uppercase underscore",
|
|
|
|
input: "UNDER_SCORE",
|
|
|
|
want: "UNDER_SCORE",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "x86",
|
|
|
|
input: "X86",
|
|
|
|
want: "x86",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "x86_64",
|
|
|
|
input: "X86_64",
|
|
|
|
want: "x86_64",
|
|
|
|
},
|
2020-02-05 22:45:11 +01:00
|
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
|
|
if got := PropertyNameForField(tt.input); got != tt.want {
|
|
|
|
t.Errorf("PropertyNameForField(%v) = %v, want %v", tt.input, got, tt.want)
|
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestFieldNameForProperty(t *testing.T) {
|
|
|
|
tests := []struct {
|
|
|
|
name string
|
|
|
|
input string
|
|
|
|
want string
|
|
|
|
}{
|
|
|
|
{
|
|
|
|
name: "short lowercase",
|
|
|
|
input: "s",
|
|
|
|
want: "S",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "short uppercase",
|
|
|
|
input: "S",
|
|
|
|
want: "S",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "long lowercase",
|
|
|
|
input: "string",
|
|
|
|
want: "String",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "long uppercase",
|
|
|
|
input: "STRING",
|
|
|
|
want: "STRING",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "mixed",
|
|
|
|
input: "StRiNg",
|
|
|
|
want: "StRiNg",
|
|
|
|
},
|
|
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
|
|
if got := FieldNameForProperty(tt.input); got != tt.want {
|
|
|
|
t.Errorf("FieldNameForProperty(%v) = %v, want %v", tt.input, got, tt.want)
|
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
2023-12-01 05:53:54 +01:00
|
|
|
|
|
|
|
func TestClearField(t *testing.T) {
|
|
|
|
props := struct {
|
|
|
|
i int
|
|
|
|
s string
|
|
|
|
ps *string
|
|
|
|
ss []string
|
|
|
|
c struct {
|
|
|
|
n int
|
|
|
|
}
|
|
|
|
}{}
|
|
|
|
|
|
|
|
props.i = 42
|
|
|
|
Clear(&props.i)
|
|
|
|
if props.i != 0 {
|
|
|
|
t.Error("int field is not cleared to zero.")
|
|
|
|
}
|
|
|
|
|
|
|
|
props.s = "foo"
|
|
|
|
Clear(&props.s)
|
|
|
|
if props.s != "" {
|
|
|
|
t.Error("string field is not cleared to zero.")
|
|
|
|
}
|
|
|
|
|
|
|
|
props.ps = StringPtr("foo")
|
|
|
|
Clear(&props.ps)
|
|
|
|
if props.ps != nil {
|
|
|
|
t.Error("string pointer field is not cleared to zero.")
|
|
|
|
}
|
|
|
|
|
|
|
|
props.ss = []string{"foo"}
|
|
|
|
Clear(&props.ss)
|
|
|
|
if props.ss != nil {
|
|
|
|
t.Error("string array field is not cleared to zero.")
|
|
|
|
}
|
|
|
|
|
|
|
|
props.c.n = 42
|
|
|
|
Clear(&props.c)
|
|
|
|
if props.c.n != 0 {
|
|
|
|
t.Error("struct field is not cleared to zero.")
|
|
|
|
}
|
|
|
|
}
|
Select statements
Select statements are a new blueprint feature inspired by bazel's select
statements. They are essentially alternative syntax for soong config
variables that require less boilerplate. In addition, they support
making decisions based on a module's variant, which will eliminate
the need for manual property struct manipulation, such as the arch
mutator's arch: and target: properties.
In order to support decisions based on the variant, select statements
cannot be evaluated as soon as they're parsed. Instead, they must be
stored in the property struct unevaluated. This means that individual
properties need to change their type from say, string, to
Configurable[string]. Currently, only configurable strings, bools, and
string slices are supported, but more types can be added later.
The module implementation must call my_property.Evaluate(ctx) in order
to get the final, resolved value of the select statement.
Bug: 323382414
Test: go tests
Change-Id: I62f8721d7f0ac3d1df4a06d7eaa260a5aa7fcba3
2024-02-02 02:44:27 +01:00
|
|
|
|
|
|
|
func TestIsConfigurable(t *testing.T) {
|
|
|
|
testCases := []struct {
|
|
|
|
name string
|
|
|
|
value interface{}
|
|
|
|
expected bool
|
|
|
|
}{
|
|
|
|
{
|
|
|
|
name: "Configurable string",
|
|
|
|
value: Configurable[string]{},
|
|
|
|
expected: true,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "Configurable string list",
|
|
|
|
value: Configurable[[]string]{},
|
|
|
|
expected: true,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "Configurable bool",
|
|
|
|
value: Configurable[bool]{},
|
|
|
|
expected: true,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "Other struct with a bool as the first field",
|
|
|
|
value: struct {
|
|
|
|
x bool
|
|
|
|
}{},
|
|
|
|
expected: false,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
|
|
value := reflect.ValueOf(tc.value)
|
|
|
|
if isConfigurable(value.Type()) != tc.expected {
|
|
|
|
t.Errorf("Expected isConfigurable to return %t", tc.expected)
|
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|