Restructure modules (#1572)
* Move portbase into monorepo * Add new simple module mgr * [WIP] Switch to new simple module mgr * Add StateMgr and more worker variants * [WIP] Switch more modules * [WIP] Switch more modules * [WIP] swtich more modules * [WIP] switch all SPN modules * [WIP] switch all service modules * [WIP] Convert all workers to the new module system * [WIP] add new task system to module manager * [WIP] Add second take for scheduling workers * [WIP] Add FIXME for bugs in new scheduler * [WIP] Add minor improvements to scheduler * [WIP] Add new worker scheduler * [WIP] Fix more bug related to new module system * [WIP] Fix start handing of the new module system * [WIP] Improve startup process * [WIP] Fix minor issues * [WIP] Fix missing subsystem in settings * [WIP] Initialize managers in constructor * [WIP] Move module event initialization to constrictors * [WIP] Fix setting for enabling and disabling the SPN module * [WIP] Move API registeration into module construction * [WIP] Update states mgr for all modules * [WIP] Add CmdLine operation support * Add state helper methods to module group and instance * Add notification and module status handling to status package * Fix starting issues * Remove pilot widget and update security lock to new status data * Remove debug logs * Improve http server shutdown * Add workaround for cleanly shutting down firewall+netquery * Improve logging * Add syncing states with notifications for new module system * Improve starting, stopping, shutdown; resolve FIXMEs/TODOs * [WIP] Fix most unit tests * Review new module system and fix minor issues * Push shutdown and restart events again via API * Set sleep mode via interface * Update example/template module * [WIP] Fix spn/cabin unit test * Remove deprecated UI elements * Make log output more similar for the logging transition phase * Switch spn hub and observer cmds to new module system * Fix log sources * Make worker mgr less error prone * Fix tests and minor issues * Fix observation hub * Improve shutdown and restart handling * Split up big connection.go source file * Move varint and dsd packages to structures repo * Improve expansion test * Fix linter warnings * Fix interception module on windows * Fix linter errors --------- Co-authored-by: Vladimir Stoilov <vladimir@safing.io>
This commit is contained in:
Daniel Hååvi
116
base/database/accessor/accessor-json-bytes.go
Normal file
116
base/database/accessor/accessor-json-bytes.go
Normal file
@@ -0,0 +1,116 @@
|
||||
package accessor
|
||||
|
||||
import (
|
||||
"github.com/tidwall/gjson"
|
||||
"github.com/tidwall/sjson"
|
||||
)
|
||||
|
||||
// JSONBytesAccessor is a json string with get functions.
|
||||
type JSONBytesAccessor struct {
|
||||
json *[]byte
|
||||
}
|
||||
|
||||
// NewJSONBytesAccessor adds the Accessor interface to a JSON bytes string.
|
||||
func NewJSONBytesAccessor(json *[]byte) *JSONBytesAccessor {
|
||||
return &JSONBytesAccessor{
|
||||
json: json,
|
||||
}
|
||||
}
|
||||
|
||||
// Set sets the value identified by key.
|
||||
func (ja *JSONBytesAccessor) Set(key string, value interface{}) error {
|
||||
result := gjson.GetBytes(*ja.json, key)
|
||||
if result.Exists() {
|
||||
err := checkJSONValueType(result, key, value)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
newJSON, err := sjson.SetBytes(*ja.json, key, value)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
*ja.json = newJSON
|
||||
return nil
|
||||
}
|
||||
|
||||
// Get returns the value found by the given json key and whether it could be successfully extracted.
|
||||
func (ja *JSONBytesAccessor) Get(key string) (value interface{}, ok bool) {
|
||||
result := gjson.GetBytes(*ja.json, key)
|
||||
if !result.Exists() {
|
||||
return nil, false
|
||||
}
|
||||
return result.Value(), true
|
||||
}
|
||||
|
||||
// GetString returns the string found by the given json key and whether it could be successfully extracted.
|
||||
func (ja *JSONBytesAccessor) GetString(key string) (value string, ok bool) {
|
||||
result := gjson.GetBytes(*ja.json, key)
|
||||
if !result.Exists() || result.Type != gjson.String {
|
||||
return emptyString, false
|
||||
}
|
||||
return result.String(), true
|
||||
}
|
||||
|
||||
// GetStringArray returns the []string found by the given json key and whether it could be successfully extracted.
|
||||
func (ja *JSONBytesAccessor) GetStringArray(key string) (value []string, ok bool) {
|
||||
result := gjson.GetBytes(*ja.json, key)
|
||||
if !result.Exists() && !result.IsArray() {
|
||||
return nil, false
|
||||
}
|
||||
slice := result.Array()
|
||||
sliceCopy := make([]string, len(slice))
|
||||
for i, res := range slice {
|
||||
if res.Type == gjson.String {
|
||||
sliceCopy[i] = res.String()
|
||||
} else {
|
||||
return nil, false
|
||||
}
|
||||
}
|
||||
return sliceCopy, true
|
||||
}
|
||||
|
||||
// GetInt returns the int found by the given json key and whether it could be successfully extracted.
|
||||
func (ja *JSONBytesAccessor) GetInt(key string) (value int64, ok bool) {
|
||||
result := gjson.GetBytes(*ja.json, key)
|
||||
if !result.Exists() || result.Type != gjson.Number {
|
||||
return 0, false
|
||||
}
|
||||
return result.Int(), true
|
||||
}
|
||||
|
||||
// GetFloat returns the float found by the given json key and whether it could be successfully extracted.
|
||||
func (ja *JSONBytesAccessor) GetFloat(key string) (value float64, ok bool) {
|
||||
result := gjson.GetBytes(*ja.json, key)
|
||||
if !result.Exists() || result.Type != gjson.Number {
|
||||
return 0, false
|
||||
}
|
||||
return result.Float(), true
|
||||
}
|
||||
|
||||
// GetBool returns the bool found by the given json key and whether it could be successfully extracted.
|
||||
func (ja *JSONBytesAccessor) GetBool(key string) (value bool, ok bool) {
|
||||
result := gjson.GetBytes(*ja.json, key)
|
||||
switch {
|
||||
case !result.Exists():
|
||||
return false, false
|
||||
case result.Type == gjson.True:
|
||||
return true, true
|
||||
case result.Type == gjson.False:
|
||||
return false, true
|
||||
default:
|
||||
return false, false
|
||||
}
|
||||
}
|
||||
|
||||
// Exists returns the whether the given key exists.
|
||||
func (ja *JSONBytesAccessor) Exists(key string) bool {
|
||||
result := gjson.GetBytes(*ja.json, key)
|
||||
return result.Exists()
|
||||
}
|
||||
|
||||
// Type returns the accessor type as a string.
|
||||
func (ja *JSONBytesAccessor) Type() string {
|
||||
return "JSONBytesAccessor"
|
||||
}
|
||||
140
base/database/accessor/accessor-json-string.go
Normal file
140
base/database/accessor/accessor-json-string.go
Normal file
@@ -0,0 +1,140 @@
|
||||
package accessor
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/tidwall/gjson"
|
||||
"github.com/tidwall/sjson"
|
||||
)
|
||||
|
||||
// JSONAccessor is a json string with get functions.
|
||||
type JSONAccessor struct {
|
||||
json *string
|
||||
}
|
||||
|
||||
// NewJSONAccessor adds the Accessor interface to a JSON string.
|
||||
func NewJSONAccessor(json *string) *JSONAccessor {
|
||||
return &JSONAccessor{
|
||||
json: json,
|
||||
}
|
||||
}
|
||||
|
||||
// Set sets the value identified by key.
|
||||
func (ja *JSONAccessor) Set(key string, value interface{}) error {
|
||||
result := gjson.Get(*ja.json, key)
|
||||
if result.Exists() {
|
||||
err := checkJSONValueType(result, key, value)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
newJSON, err := sjson.Set(*ja.json, key, value)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
*ja.json = newJSON
|
||||
return nil
|
||||
}
|
||||
|
||||
func checkJSONValueType(jsonValue gjson.Result, key string, value interface{}) error {
|
||||
switch value.(type) {
|
||||
case string:
|
||||
if jsonValue.Type != gjson.String {
|
||||
return fmt.Errorf("tried to set field %s (%s) to a %T value", key, jsonValue.Type.String(), value)
|
||||
}
|
||||
case int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64, float32, float64:
|
||||
if jsonValue.Type != gjson.Number {
|
||||
return fmt.Errorf("tried to set field %s (%s) to a %T value", key, jsonValue.Type.String(), value)
|
||||
}
|
||||
case bool:
|
||||
if jsonValue.Type != gjson.True && jsonValue.Type != gjson.False {
|
||||
return fmt.Errorf("tried to set field %s (%s) to a %T value", key, jsonValue.Type.String(), value)
|
||||
}
|
||||
case []string:
|
||||
if !jsonValue.IsArray() {
|
||||
return fmt.Errorf("tried to set field %s (%s) to a %T value", key, jsonValue.Type.String(), value)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Get returns the value found by the given json key and whether it could be successfully extracted.
|
||||
func (ja *JSONAccessor) Get(key string) (value interface{}, ok bool) {
|
||||
result := gjson.Get(*ja.json, key)
|
||||
if !result.Exists() {
|
||||
return nil, false
|
||||
}
|
||||
return result.Value(), true
|
||||
}
|
||||
|
||||
// GetString returns the string found by the given json key and whether it could be successfully extracted.
|
||||
func (ja *JSONAccessor) GetString(key string) (value string, ok bool) {
|
||||
result := gjson.Get(*ja.json, key)
|
||||
if !result.Exists() || result.Type != gjson.String {
|
||||
return emptyString, false
|
||||
}
|
||||
return result.String(), true
|
||||
}
|
||||
|
||||
// GetStringArray returns the []string found by the given json key and whether it could be successfully extracted.
|
||||
func (ja *JSONAccessor) GetStringArray(key string) (value []string, ok bool) {
|
||||
result := gjson.Get(*ja.json, key)
|
||||
if !result.Exists() && !result.IsArray() {
|
||||
return nil, false
|
||||
}
|
||||
slice := result.Array()
|
||||
sliceCopy := make([]string, len(slice))
|
||||
for i, res := range slice {
|
||||
if res.Type == gjson.String {
|
||||
sliceCopy[i] = res.String()
|
||||
} else {
|
||||
return nil, false
|
||||
}
|
||||
}
|
||||
return sliceCopy, true
|
||||
}
|
||||
|
||||
// GetInt returns the int found by the given json key and whether it could be successfully extracted.
|
||||
func (ja *JSONAccessor) GetInt(key string) (value int64, ok bool) {
|
||||
result := gjson.Get(*ja.json, key)
|
||||
if !result.Exists() || result.Type != gjson.Number {
|
||||
return 0, false
|
||||
}
|
||||
return result.Int(), true
|
||||
}
|
||||
|
||||
// GetFloat returns the float found by the given json key and whether it could be successfully extracted.
|
||||
func (ja *JSONAccessor) GetFloat(key string) (value float64, ok bool) {
|
||||
result := gjson.Get(*ja.json, key)
|
||||
if !result.Exists() || result.Type != gjson.Number {
|
||||
return 0, false
|
||||
}
|
||||
return result.Float(), true
|
||||
}
|
||||
|
||||
// GetBool returns the bool found by the given json key and whether it could be successfully extracted.
|
||||
func (ja *JSONAccessor) GetBool(key string) (value bool, ok bool) {
|
||||
result := gjson.Get(*ja.json, key)
|
||||
switch {
|
||||
case !result.Exists():
|
||||
return false, false
|
||||
case result.Type == gjson.True:
|
||||
return true, true
|
||||
case result.Type == gjson.False:
|
||||
return false, true
|
||||
default:
|
||||
return false, false
|
||||
}
|
||||
}
|
||||
|
||||
// Exists returns the whether the given key exists.
|
||||
func (ja *JSONAccessor) Exists(key string) bool {
|
||||
result := gjson.Get(*ja.json, key)
|
||||
return result.Exists()
|
||||
}
|
||||
|
||||
// Type returns the accessor type as a string.
|
||||
func (ja *JSONAccessor) Type() string {
|
||||
return "JSONAccessor"
|
||||
}
|
||||
169
base/database/accessor/accessor-struct.go
Normal file
169
base/database/accessor/accessor-struct.go
Normal file
@@ -0,0 +1,169 @@
|
||||
package accessor
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"reflect"
|
||||
)
|
||||
|
||||
// StructAccessor is a json string with get functions.
|
||||
type StructAccessor struct {
|
||||
object reflect.Value
|
||||
}
|
||||
|
||||
// NewStructAccessor adds the Accessor interface to a JSON string.
|
||||
func NewStructAccessor(object interface{}) *StructAccessor {
|
||||
return &StructAccessor{
|
||||
object: reflect.ValueOf(object).Elem(),
|
||||
}
|
||||
}
|
||||
|
||||
// Set sets the value identified by key.
|
||||
func (sa *StructAccessor) Set(key string, value interface{}) error {
|
||||
field := sa.object.FieldByName(key)
|
||||
if !field.IsValid() {
|
||||
return errors.New("struct field does not exist")
|
||||
}
|
||||
if !field.CanSet() {
|
||||
return fmt.Errorf("field %s or struct is immutable", field.String())
|
||||
}
|
||||
|
||||
newVal := reflect.ValueOf(value)
|
||||
|
||||
// set directly if type matches
|
||||
if newVal.Kind() == field.Kind() {
|
||||
field.Set(newVal)
|
||||
return nil
|
||||
}
|
||||
|
||||
// handle special cases
|
||||
switch field.Kind() { // nolint:exhaustive
|
||||
|
||||
// ints
|
||||
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||
var newInt int64
|
||||
switch newVal.Kind() { // nolint:exhaustive
|
||||
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||
newInt = newVal.Int()
|
||||
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
||||
newInt = int64(newVal.Uint())
|
||||
default:
|
||||
return fmt.Errorf("tried to set field %s (%s) to a %s value", key, field.Kind().String(), newVal.Kind().String())
|
||||
}
|
||||
if field.OverflowInt(newInt) {
|
||||
return fmt.Errorf("setting field %s (%s) to %d would overflow", key, field.Kind().String(), newInt)
|
||||
}
|
||||
field.SetInt(newInt)
|
||||
|
||||
// uints
|
||||
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
||||
var newUint uint64
|
||||
switch newVal.Kind() { // nolint:exhaustive
|
||||
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||
newUint = uint64(newVal.Int())
|
||||
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
||||
newUint = newVal.Uint()
|
||||
default:
|
||||
return fmt.Errorf("tried to set field %s (%s) to a %s value", key, field.Kind().String(), newVal.Kind().String())
|
||||
}
|
||||
if field.OverflowUint(newUint) {
|
||||
return fmt.Errorf("setting field %s (%s) to %d would overflow", key, field.Kind().String(), newUint)
|
||||
}
|
||||
field.SetUint(newUint)
|
||||
|
||||
// floats
|
||||
case reflect.Float32, reflect.Float64:
|
||||
switch newVal.Kind() { // nolint:exhaustive
|
||||
case reflect.Float32, reflect.Float64:
|
||||
field.SetFloat(newVal.Float())
|
||||
default:
|
||||
return fmt.Errorf("tried to set field %s (%s) to a %s value", key, field.Kind().String(), newVal.Kind().String())
|
||||
}
|
||||
default:
|
||||
return fmt.Errorf("tried to set field %s (%s) to a %s value", key, field.Kind().String(), newVal.Kind().String())
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Get returns the value found by the given json key and whether it could be successfully extracted.
|
||||
func (sa *StructAccessor) Get(key string) (value interface{}, ok bool) {
|
||||
field := sa.object.FieldByName(key)
|
||||
if !field.IsValid() || !field.CanInterface() {
|
||||
return nil, false
|
||||
}
|
||||
return field.Interface(), true
|
||||
}
|
||||
|
||||
// GetString returns the string found by the given json key and whether it could be successfully extracted.
|
||||
func (sa *StructAccessor) GetString(key string) (value string, ok bool) {
|
||||
field := sa.object.FieldByName(key)
|
||||
if !field.IsValid() || field.Kind() != reflect.String {
|
||||
return "", false
|
||||
}
|
||||
return field.String(), true
|
||||
}
|
||||
|
||||
// GetStringArray returns the []string found by the given json key and whether it could be successfully extracted.
|
||||
func (sa *StructAccessor) GetStringArray(key string) (value []string, ok bool) {
|
||||
field := sa.object.FieldByName(key)
|
||||
if !field.IsValid() || field.Kind() != reflect.Slice || !field.CanInterface() {
|
||||
return nil, false
|
||||
}
|
||||
v := field.Interface()
|
||||
slice, ok := v.([]string)
|
||||
if !ok {
|
||||
return nil, false
|
||||
}
|
||||
return slice, true
|
||||
}
|
||||
|
||||
// GetInt returns the int found by the given json key and whether it could be successfully extracted.
|
||||
func (sa *StructAccessor) GetInt(key string) (value int64, ok bool) {
|
||||
field := sa.object.FieldByName(key)
|
||||
if !field.IsValid() {
|
||||
return 0, false
|
||||
}
|
||||
switch field.Kind() { // nolint:exhaustive
|
||||
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||
return field.Int(), true
|
||||
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
||||
return int64(field.Uint()), true
|
||||
default:
|
||||
return 0, false
|
||||
}
|
||||
}
|
||||
|
||||
// GetFloat returns the float found by the given json key and whether it could be successfully extracted.
|
||||
func (sa *StructAccessor) GetFloat(key string) (value float64, ok bool) {
|
||||
field := sa.object.FieldByName(key)
|
||||
if !field.IsValid() {
|
||||
return 0, false
|
||||
}
|
||||
switch field.Kind() { // nolint:exhaustive
|
||||
case reflect.Float32, reflect.Float64:
|
||||
return field.Float(), true
|
||||
default:
|
||||
return 0, false
|
||||
}
|
||||
}
|
||||
|
||||
// GetBool returns the bool found by the given json key and whether it could be successfully extracted.
|
||||
func (sa *StructAccessor) GetBool(key string) (value bool, ok bool) {
|
||||
field := sa.object.FieldByName(key)
|
||||
if !field.IsValid() || field.Kind() != reflect.Bool {
|
||||
return false, false
|
||||
}
|
||||
return field.Bool(), true
|
||||
}
|
||||
|
||||
// Exists returns the whether the given key exists.
|
||||
func (sa *StructAccessor) Exists(key string) bool {
|
||||
field := sa.object.FieldByName(key)
|
||||
return field.IsValid()
|
||||
}
|
||||
|
||||
// Type returns the accessor type as a string.
|
||||
func (sa *StructAccessor) Type() string {
|
||||
return "StructAccessor"
|
||||
}
|
||||
18
base/database/accessor/accessor.go
Normal file
18
base/database/accessor/accessor.go
Normal file
@@ -0,0 +1,18 @@
|
||||
package accessor
|
||||
|
||||
const (
|
||||
emptyString = ""
|
||||
)
|
||||
|
||||
// Accessor provides an interface to supply the query matcher a method to retrieve values from an object.
|
||||
type Accessor interface {
|
||||
Get(key string) (value interface{}, ok bool)
|
||||
GetString(key string) (value string, ok bool)
|
||||
GetStringArray(key string) (value []string, ok bool)
|
||||
GetInt(key string) (value int64, ok bool)
|
||||
GetFloat(key string) (value float64, ok bool)
|
||||
GetBool(key string) (value bool, ok bool)
|
||||
Exists(key string) bool
|
||||
Set(key string, value interface{}) error
|
||||
Type() string
|
||||
}
|
||||
291
base/database/accessor/accessor_test.go
Normal file
291
base/database/accessor/accessor_test.go
Normal file
@@ -0,0 +1,291 @@
|
||||
//nolint:maligned,unparam
|
||||
package accessor
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"testing"
|
||||
|
||||
"github.com/safing/portmaster/base/utils"
|
||||
)
|
||||
|
||||
type TestStruct struct {
|
||||
S string
|
||||
A []string
|
||||
I int
|
||||
I8 int8
|
||||
I16 int16
|
||||
I32 int32
|
||||
I64 int64
|
||||
UI uint
|
||||
UI8 uint8
|
||||
UI16 uint16
|
||||
UI32 uint32
|
||||
UI64 uint64
|
||||
F32 float32
|
||||
F64 float64
|
||||
B bool
|
||||
}
|
||||
|
||||
var (
|
||||
testStruct = &TestStruct{
|
||||
S: "banana",
|
||||
A: []string{"black", "white"},
|
||||
I: 42,
|
||||
I8: 42,
|
||||
I16: 42,
|
||||
I32: 42,
|
||||
I64: 42,
|
||||
UI: 42,
|
||||
UI8: 42,
|
||||
UI16: 42,
|
||||
UI32: 42,
|
||||
UI64: 42,
|
||||
F32: 42.42,
|
||||
F64: 42.42,
|
||||
B: true,
|
||||
}
|
||||
testJSONBytes, _ = json.Marshal(testStruct) //nolint:errchkjson
|
||||
testJSON = string(testJSONBytes)
|
||||
)
|
||||
|
||||
func testGetString(t *testing.T, acc Accessor, key string, shouldSucceed bool, expectedValue string) {
|
||||
t.Helper()
|
||||
|
||||
v, ok := acc.GetString(key)
|
||||
switch {
|
||||
case !ok && shouldSucceed:
|
||||
t.Errorf("%s failed to get string with key %s", acc.Type(), key)
|
||||
case ok && !shouldSucceed:
|
||||
t.Errorf("%s should have failed to get string with key %s, it returned %v", acc.Type(), key, v)
|
||||
}
|
||||
if v != expectedValue {
|
||||
t.Errorf("%s returned an unexpected value: wanted %v, got %v", acc.Type(), expectedValue, v)
|
||||
}
|
||||
}
|
||||
|
||||
func testGetStringArray(t *testing.T, acc Accessor, key string, shouldSucceed bool, expectedValue []string) {
|
||||
t.Helper()
|
||||
|
||||
v, ok := acc.GetStringArray(key)
|
||||
switch {
|
||||
case !ok && shouldSucceed:
|
||||
t.Errorf("%s failed to get []string with key %s", acc.Type(), key)
|
||||
case ok && !shouldSucceed:
|
||||
t.Errorf("%s should have failed to get []string with key %s, it returned %v", acc.Type(), key, v)
|
||||
}
|
||||
if !utils.StringSliceEqual(v, expectedValue) {
|
||||
t.Errorf("%s returned an unexpected value: wanted %v, got %v", acc.Type(), expectedValue, v)
|
||||
}
|
||||
}
|
||||
|
||||
func testGetInt(t *testing.T, acc Accessor, key string, shouldSucceed bool, expectedValue int64) {
|
||||
t.Helper()
|
||||
|
||||
v, ok := acc.GetInt(key)
|
||||
switch {
|
||||
case !ok && shouldSucceed:
|
||||
t.Errorf("%s failed to get int with key %s", acc.Type(), key)
|
||||
case ok && !shouldSucceed:
|
||||
t.Errorf("%s should have failed to get int with key %s, it returned %v", acc.Type(), key, v)
|
||||
}
|
||||
if v != expectedValue {
|
||||
t.Errorf("%s returned an unexpected value: wanted %v, got %v", acc.Type(), expectedValue, v)
|
||||
}
|
||||
}
|
||||
|
||||
func testGetFloat(t *testing.T, acc Accessor, key string, shouldSucceed bool, expectedValue float64) {
|
||||
t.Helper()
|
||||
|
||||
v, ok := acc.GetFloat(key)
|
||||
switch {
|
||||
case !ok && shouldSucceed:
|
||||
t.Errorf("%s failed to get float with key %s", acc.Type(), key)
|
||||
case ok && !shouldSucceed:
|
||||
t.Errorf("%s should have failed to get float with key %s, it returned %v", acc.Type(), key, v)
|
||||
}
|
||||
if int64(v) != int64(expectedValue) {
|
||||
t.Errorf("%s returned an unexpected value: wanted %v, got %v", acc.Type(), expectedValue, v)
|
||||
}
|
||||
}
|
||||
|
||||
func testGetBool(t *testing.T, acc Accessor, key string, shouldSucceed bool, expectedValue bool) {
|
||||
t.Helper()
|
||||
|
||||
v, ok := acc.GetBool(key)
|
||||
switch {
|
||||
case !ok && shouldSucceed:
|
||||
t.Errorf("%s failed to get bool with key %s", acc.Type(), key)
|
||||
case ok && !shouldSucceed:
|
||||
t.Errorf("%s should have failed to get bool with key %s, it returned %v", acc.Type(), key, v)
|
||||
}
|
||||
if v != expectedValue {
|
||||
t.Errorf("%s returned an unexpected value: wanted %v, got %v", acc.Type(), expectedValue, v)
|
||||
}
|
||||
}
|
||||
|
||||
func testExists(t *testing.T, acc Accessor, key string, shouldSucceed bool) {
|
||||
t.Helper()
|
||||
|
||||
ok := acc.Exists(key)
|
||||
switch {
|
||||
case !ok && shouldSucceed:
|
||||
t.Errorf("%s should report key %s as existing", acc.Type(), key)
|
||||
case ok && !shouldSucceed:
|
||||
t.Errorf("%s should report key %s as non-existing", acc.Type(), key)
|
||||
}
|
||||
}
|
||||
|
||||
func testSet(t *testing.T, acc Accessor, key string, shouldSucceed bool, valueToSet interface{}) {
|
||||
t.Helper()
|
||||
|
||||
err := acc.Set(key, valueToSet)
|
||||
switch {
|
||||
case err != nil && shouldSucceed:
|
||||
t.Errorf("%s failed to set %s to %+v: %s", acc.Type(), key, valueToSet, err)
|
||||
case err == nil && !shouldSucceed:
|
||||
t.Errorf("%s should have failed to set %s to %+v", acc.Type(), key, valueToSet)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAccessor(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// Test interface compliance.
|
||||
accs := []Accessor{
|
||||
NewJSONAccessor(&testJSON),
|
||||
NewJSONBytesAccessor(&testJSONBytes),
|
||||
NewStructAccessor(testStruct),
|
||||
}
|
||||
|
||||
// get
|
||||
for _, acc := range accs {
|
||||
testGetString(t, acc, "S", true, "banana")
|
||||
testGetStringArray(t, acc, "A", true, []string{"black", "white"})
|
||||
testGetInt(t, acc, "I", true, 42)
|
||||
testGetInt(t, acc, "I8", true, 42)
|
||||
testGetInt(t, acc, "I16", true, 42)
|
||||
testGetInt(t, acc, "I32", true, 42)
|
||||
testGetInt(t, acc, "I64", true, 42)
|
||||
testGetInt(t, acc, "UI", true, 42)
|
||||
testGetInt(t, acc, "UI8", true, 42)
|
||||
testGetInt(t, acc, "UI16", true, 42)
|
||||
testGetInt(t, acc, "UI32", true, 42)
|
||||
testGetInt(t, acc, "UI64", true, 42)
|
||||
testGetFloat(t, acc, "F32", true, 42.42)
|
||||
testGetFloat(t, acc, "F64", true, 42.42)
|
||||
testGetBool(t, acc, "B", true, true)
|
||||
}
|
||||
|
||||
// set
|
||||
for _, acc := range accs {
|
||||
testSet(t, acc, "S", true, "coconut")
|
||||
testSet(t, acc, "A", true, []string{"green", "blue"})
|
||||
testSet(t, acc, "I", true, uint32(44))
|
||||
testSet(t, acc, "I8", true, uint64(44))
|
||||
testSet(t, acc, "I16", true, uint8(44))
|
||||
testSet(t, acc, "I32", true, uint16(44))
|
||||
testSet(t, acc, "I64", true, 44)
|
||||
testSet(t, acc, "UI", true, 44)
|
||||
testSet(t, acc, "UI8", true, int64(44))
|
||||
testSet(t, acc, "UI16", true, int32(44))
|
||||
testSet(t, acc, "UI32", true, int8(44))
|
||||
testSet(t, acc, "UI64", true, int16(44))
|
||||
testSet(t, acc, "F32", true, 44.44)
|
||||
testSet(t, acc, "F64", true, 44.44)
|
||||
testSet(t, acc, "B", true, false)
|
||||
}
|
||||
|
||||
// get again to check if new values were set
|
||||
for _, acc := range accs {
|
||||
testGetString(t, acc, "S", true, "coconut")
|
||||
testGetStringArray(t, acc, "A", true, []string{"green", "blue"})
|
||||
testGetInt(t, acc, "I", true, 44)
|
||||
testGetInt(t, acc, "I8", true, 44)
|
||||
testGetInt(t, acc, "I16", true, 44)
|
||||
testGetInt(t, acc, "I32", true, 44)
|
||||
testGetInt(t, acc, "I64", true, 44)
|
||||
testGetInt(t, acc, "UI", true, 44)
|
||||
testGetInt(t, acc, "UI8", true, 44)
|
||||
testGetInt(t, acc, "UI16", true, 44)
|
||||
testGetInt(t, acc, "UI32", true, 44)
|
||||
testGetInt(t, acc, "UI64", true, 44)
|
||||
testGetFloat(t, acc, "F32", true, 44.44)
|
||||
testGetFloat(t, acc, "F64", true, 44.44)
|
||||
testGetBool(t, acc, "B", true, false)
|
||||
}
|
||||
|
||||
// failures
|
||||
for _, acc := range accs {
|
||||
testSet(t, acc, "S", false, true)
|
||||
testSet(t, acc, "S", false, false)
|
||||
testSet(t, acc, "S", false, 1)
|
||||
testSet(t, acc, "S", false, 1.1)
|
||||
|
||||
testSet(t, acc, "A", false, "1")
|
||||
testSet(t, acc, "A", false, true)
|
||||
testSet(t, acc, "A", false, false)
|
||||
testSet(t, acc, "A", false, 1)
|
||||
testSet(t, acc, "A", false, 1.1)
|
||||
|
||||
testSet(t, acc, "I", false, "1")
|
||||
testSet(t, acc, "I8", false, "1")
|
||||
testSet(t, acc, "I16", false, "1")
|
||||
testSet(t, acc, "I32", false, "1")
|
||||
testSet(t, acc, "I64", false, "1")
|
||||
testSet(t, acc, "UI", false, "1")
|
||||
testSet(t, acc, "UI8", false, "1")
|
||||
testSet(t, acc, "UI16", false, "1")
|
||||
testSet(t, acc, "UI32", false, "1")
|
||||
testSet(t, acc, "UI64", false, "1")
|
||||
|
||||
testSet(t, acc, "F32", false, "1.1")
|
||||
testSet(t, acc, "F64", false, "1.1")
|
||||
|
||||
testSet(t, acc, "B", false, "false")
|
||||
testSet(t, acc, "B", false, 1)
|
||||
testSet(t, acc, "B", false, 1.1)
|
||||
}
|
||||
|
||||
// get again to check if values werent changed when an error occurred
|
||||
for _, acc := range accs {
|
||||
testGetString(t, acc, "S", true, "coconut")
|
||||
testGetStringArray(t, acc, "A", true, []string{"green", "blue"})
|
||||
testGetInt(t, acc, "I", true, 44)
|
||||
testGetInt(t, acc, "I8", true, 44)
|
||||
testGetInt(t, acc, "I16", true, 44)
|
||||
testGetInt(t, acc, "I32", true, 44)
|
||||
testGetInt(t, acc, "I64", true, 44)
|
||||
testGetInt(t, acc, "UI", true, 44)
|
||||
testGetInt(t, acc, "UI8", true, 44)
|
||||
testGetInt(t, acc, "UI16", true, 44)
|
||||
testGetInt(t, acc, "UI32", true, 44)
|
||||
testGetInt(t, acc, "UI64", true, 44)
|
||||
testGetFloat(t, acc, "F32", true, 44.44)
|
||||
testGetFloat(t, acc, "F64", true, 44.44)
|
||||
testGetBool(t, acc, "B", true, false)
|
||||
}
|
||||
|
||||
// test existence
|
||||
for _, acc := range accs {
|
||||
testExists(t, acc, "S", true)
|
||||
testExists(t, acc, "A", true)
|
||||
testExists(t, acc, "I", true)
|
||||
testExists(t, acc, "I8", true)
|
||||
testExists(t, acc, "I16", true)
|
||||
testExists(t, acc, "I32", true)
|
||||
testExists(t, acc, "I64", true)
|
||||
testExists(t, acc, "UI", true)
|
||||
testExists(t, acc, "UI8", true)
|
||||
testExists(t, acc, "UI16", true)
|
||||
testExists(t, acc, "UI32", true)
|
||||
testExists(t, acc, "UI64", true)
|
||||
testExists(t, acc, "F32", true)
|
||||
testExists(t, acc, "F64", true)
|
||||
testExists(t, acc, "B", true)
|
||||
}
|
||||
|
||||
// test non-existence
|
||||
for _, acc := range accs {
|
||||
testExists(t, acc, "X", false)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user