0fe7866897
This allows Soong (Go) plugins to get custom configurations set in the
current product's BoardConfig.mk.
I'll have some more comprehensive documentation later, but the general
concept is that you'd have one namespace per plugin, defined in the
BoardConfig.mk (though they would work in the product.mk files too):
SOONG_CONFIG_NAMESPACES += myPlugin
Within that namespace you can set key-value pairs:
SOONG_CONFIG_myPlugin := key1 key2 ...
...
SOONG_CONFIG_myPlugin_key1 := value
...
SOONG_CONFIG_myPlugin_key2 := true
Then in your plugin, you can ask for your namespace:
vars := ctx.Config().VendorConfig("myPlugin")
And then use them:
str := vars.String("key1")
if vars.Bool("key2") { ... }
if vars.IsSet("key3") { ... }
Warning: It's not a good idea to fail on missing inputs, since an
android tree may contain plugins from multiple owners, and we may
configure your modules (but not build/install them) even if they're not
meant for the currently configured product.
Bug: 76168832
Test: define some variables, use them
Test: m blueprint_tools
Change-Id: I4c38f5a4344022c6f332de279d9bbef24502e741
93 lines
3.1 KiB
Go
93 lines
3.1 KiB
Go
// Copyright 2017 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 android
|
|
|
|
import (
|
|
"fmt"
|
|
"reflect"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
func validateConfigAnnotations(configurable jsonConfigurable) (err error) {
|
|
reflectType := reflect.TypeOf(configurable)
|
|
reflectType = reflectType.Elem()
|
|
for i := 0; i < reflectType.NumField(); i++ {
|
|
field := reflectType.Field(i)
|
|
jsonTag := field.Tag.Get("json")
|
|
// Check for mistakes in the json tag
|
|
if jsonTag != "" && !strings.HasPrefix(jsonTag, ",") {
|
|
if !strings.Contains(jsonTag, ",") {
|
|
// Probably an accidental rename, most likely "omitempty" instead of ",omitempty"
|
|
return fmt.Errorf("Field %s.%s has tag %s which specifies to change its json field name to %q.\n"+
|
|
"Did you mean to use an annotation of %q?\n"+
|
|
"(Alternatively, to change the json name of the field, rename the field in source instead.)",
|
|
reflectType.Name(), field.Name, field.Tag, jsonTag, ","+jsonTag)
|
|
} else {
|
|
// Although this rename was probably intentional,
|
|
// a json annotation is still more confusing than renaming the source variable
|
|
requestedName := strings.Split(jsonTag, ",")[0]
|
|
return fmt.Errorf("Field %s.%s has tag %s which specifies to change its json field name to %q.\n"+
|
|
"To change the json name of the field, rename the field in source instead.",
|
|
reflectType.Name(), field.Name, field.Tag, requestedName)
|
|
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
type configType struct {
|
|
populateMe *bool `json:"omitempty"`
|
|
}
|
|
|
|
func (c *configType) SetDefaultConfig() {
|
|
}
|
|
|
|
// tests that ValidateConfigAnnotation works
|
|
func TestValidateConfigAnnotations(t *testing.T) {
|
|
config := configType{}
|
|
err := validateConfigAnnotations(&config)
|
|
expectedError := `Field configType.populateMe has tag json:"omitempty" which specifies to change its json field name to "omitempty".
|
|
Did you mean to use an annotation of ",omitempty"?
|
|
(Alternatively, to change the json name of the field, rename the field in source instead.)`
|
|
if err.Error() != expectedError {
|
|
t.Errorf("Incorrect error; expected:\n"+
|
|
"%s\n"+
|
|
"got:\n"+
|
|
"%s",
|
|
expectedError, err.Error())
|
|
}
|
|
}
|
|
|
|
// run validateConfigAnnotations against each type that might have json annotations
|
|
func TestProductConfigAnnotations(t *testing.T) {
|
|
err := validateConfigAnnotations(&productVariables{})
|
|
if err != nil {
|
|
t.Errorf(err.Error())
|
|
}
|
|
|
|
validateConfigAnnotations(&FileConfigurableOptions{})
|
|
if err != nil {
|
|
t.Errorf(err.Error())
|
|
}
|
|
}
|
|
|
|
func TestMissingVendorConfig(t *testing.T) {
|
|
c := &config{}
|
|
if c.VendorConfig("test").Bool("not_set") {
|
|
t.Errorf("Expected false")
|
|
}
|
|
}
|