Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

config: add extensible "Extra" field, use it ActiveConfig #6056

Merged
merged 1 commit into from
Jun 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
49 changes: 36 additions & 13 deletions config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ import (
"fmt"
"os"
"path/filepath"
"reflect"
"sort"
"strings"

"github.com/open-policy-agent/opa/ast"
"github.com/open-policy-agent/opa/internal/ref"
Expand Down Expand Up @@ -41,15 +43,33 @@ type Config struct {
Storage *struct {
Disk json.RawMessage `json:"disk,omitempty"`
} `json:"storage,omitempty"`
Extra map[string]json.RawMessage `json:"-"`
}

// ParseConfig returns a valid Config object with defaults injected. The id
// and version parameters will be set in the labels map.
func ParseConfig(raw []byte, id string) (*Config, error) {
// NOTE(sr): based on https://stackoverflow.com/a/33499066/993018
var result Config
if err := util.Unmarshal(raw, &result); err != nil {
objValue := reflect.ValueOf(&result).Elem()
knownFields := map[string]reflect.Value{}
for i := 0; i != objValue.NumField(); i++ {
jsonName := strings.Split(objValue.Type().Field(i).Tag.Get("json"), ",")[0]
knownFields[jsonName] = objValue.Field(i)
}

if err := util.Unmarshal(raw, &result.Extra); err != nil {
return nil, err
}

for key, chunk := range result.Extra {
if field, found := knownFields[key]; found {
if err := util.Unmarshal(chunk, field.Addr().Interface()); err != nil {
return nil, err
}
delete(result.Extra, key)
}
}
return &result, result.validateAndInjectDefaults(id)
}

Expand Down Expand Up @@ -149,30 +169,32 @@ func (c *Config) ActiveConfig() (interface{}, error) {
}

var result map[string]interface{}
if err := util.Unmarshal(bs, &result); err != nil {
if err := util.UnmarshalJSON(bs, &result); err != nil {
return nil, err
}

if result["services"] != nil {
err = removeServiceCredentials(result["services"])
if err != nil {
for k, e := range c.Extra {
var v any
if err := util.UnmarshalJSON(e, &v); err != nil {
return nil, err
}
result[k] = v
}

if result["keys"] != nil {
err = removeCryptoKeys(result["keys"])
if err != nil {
return nil, err
}
if err := removeServiceCredentials(result["services"]); err != nil {
return nil, err
}

if err := removeCryptoKeys(result["keys"]); err != nil {
return nil, err
}

return result, nil
}

func removeServiceCredentials(x interface{}) error {

switch x := x.(type) {
case nil:
return nil
case []interface{}:
for _, v := range x {
err := removeKey(v, "credentials")
Expand All @@ -196,8 +218,9 @@ func removeServiceCredentials(x interface{}) error {
}

func removeCryptoKeys(x interface{}) error {

switch x := x.(type) {
case nil:
return nil
case map[string]interface{}:
for _, v := range x {
err := removeKey(v, "key", "private_key")
Expand Down
33 changes: 33 additions & 0 deletions config/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -377,3 +377,36 @@ func TestActiveConfig(t *testing.T) {
}

}

func TestExtraConfigFieldsRoundtrip(t *testing.T) {
raw := []byte(`
decision_logger:
console: true
foo: baz
bar:
really: yes!`)
conf, err := ParseConfig(raw, "id")
if err != nil {
t.Fatal(err)
}

actual, err := conf.ActiveConfig()
if err != nil {
t.Fatal(err)
}

expected := map[string]any{
"foo": "baz",
"bar": map[string]any{"really": "yes!"},
"decision_logger": map[string]any{"console": true},
"default_authorization_decision": "/system/authz/allow",
"default_decision": "/system/main",
"labels": map[string]any{
"id": "id",
"version": version.Version,
},
}
if !reflect.DeepEqual(actual, expected) {
t.Fatalf("want %v got %v", expected, actual)
}
}