Files
ziti/tests/context_json.go

302 lines
8.9 KiB
Go

/*
Copyright NetFoundry Inc.
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
https://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 tests
import (
"bytes"
"encoding/json"
"fmt"
"net/http"
"reflect"
"strings"
"github.com/Jeffail/gabs"
"github.com/michaelquigley/pfxlog"
"github.com/openziti/foundation/v2/errorz"
"github.com/openziti/foundation/v2/stringz"
)
func (ctx *TestContext) setJsonValue(container *gabs.Container, value interface{}, path ...string) {
_, err := container.Set(value, path...)
ctx.Req.NoError(err)
}
func (ctx *TestContext) setValue(container *gabs.Container, value interface{}, fields []string, field string) {
ctx.setValueWithPath(container, value, fields, field, field)
}
func (ctx *TestContext) setValueWithPath(container *gabs.Container, value interface{}, fields []string, field string, path ...string) {
if len(fields) == 0 || stringz.Contains(fields, field) {
_, err := container.Set(value, path...)
ctx.Req.NoError(err)
}
}
func (ctx *TestContext) parseJson(body []byte) *gabs.Container {
result, err := gabs.ParseJSON(body)
ctx.Req.NoError(err)
return result
}
func (ctx *TestContext) getEntityId(body []byte) string {
result := ctx.parseJson(body)
path := result.S("data", "id")
ctx.Req.NotNil(path)
return fmt.Sprintf("%v", path.Data())
}
func (ctx *TestContext) pathEquals(container *gabs.Container, val interface{}, path []string) {
pathValue := container.Search(path...)
if val == nil || (reflect.TypeOf(val).Kind() == reflect.Map && reflect.ValueOf(val).IsNil()) {
ctx.Req.True(pathValue == nil || pathValue.Data() == nil)
return
}
data := pathValue.Data()
if floatVal, isFloat := data.(float64); isFloat {
if cmpFloat, isCmp := ctx.toFloat(val); isCmp && isFloat {
ctx.Req.Equal(floatVal, cmpFloat)
return
}
}
ctx.Req.Equal(val, pathValue.Data())
}
func (ctx *TestContext) toFloat(val interface{}) (float64, bool) {
if v, ok := val.(int); ok {
return float64(v), true
}
if v, ok := val.(int32); ok {
return float64(v), true
}
if v, ok := val.(uint32); ok {
return float64(v), true
}
if v, ok := val.(int64); ok {
return float64(v), true
}
if v, ok := val.(uint64); ok {
return float64(v), true
}
if v, ok := val.(int16); ok {
return float64(v), true
}
if v, ok := val.(uint16); ok {
return float64(v), true
}
if v, ok := val.(int8); ok {
return float64(v), true
}
if v, ok := val.(uint8); ok {
return float64(v), true
}
return 0, false
}
func (ctx *TestContext) requireString(container *gabs.Container, path ...string) string {
pathValue := container.Search(path...)
ctx.Req.NotNil(pathValue)
result, ok := pathValue.Data().(string)
ctx.Req.True(ok, "%+v must be a string", path)
return result
}
func (ctx *TestContext) requireBool(container *gabs.Container, path ...string) bool {
pathValue := container.Search(path...)
ctx.Req.NotNil(pathValue)
result, ok := pathValue.Data().(bool)
ctx.Req.True(ok, "%+v must be a boolean", path)
return result
}
func (ctx *TestContext) requireInt(container *gabs.Container, path ...string) int {
pathValue := container.Search(path...)
ctx.Req.NotNil(pathValue)
result, ok := pathValue.Data().(float64)
ctx.Req.True(ok, "%+v must be a number, is type %v", path, reflect.TypeOf(pathValue.Data()))
return int(result)
}
func (ctx *TestContext) requireStringSlice(container *gabs.Container, path ...string) []string {
pathValue := container.Search(path...)
if pathValue == nil || pathValue.Data() == nil {
return nil
}
return ctx.toStringSlice(pathValue)
}
func (ctx *TestContext) pathEqualsStringSlice(container *gabs.Container, val interface{}, path []string) {
pathValue := container.Search(path...)
if val == nil || reflect.ValueOf(val).IsNil() {
if pathValue != nil {
ctx.Req.Nil(pathValue.Data())
}
} else {
slice := ctx.toStringSlice(pathValue)
ctx.Req.Equal(val, slice)
}
}
func (ctx *TestContext) pathEqualsCtrlChanListeners(container *gabs.Container, expected map[string][]string, path []string) {
pathValue := container.Search(path...)
if expected == nil {
if pathValue != nil {
ctx.Req.Nil(pathValue.Data())
}
} else {
ctx.Req.NotNil(pathValue, "expected non-nil value at path %v", path)
data := pathValue.Data()
if len(expected) == 0 {
if data == nil {
return
}
if m, ok := data.(map[string]interface{}); ok {
ctx.Req.Empty(m)
}
return
}
m, ok := data.(map[string]interface{})
ctx.Req.True(ok, "expected map at path %v, got %T", path, data)
ctx.Req.Equal(len(expected), len(m), "map length mismatch at path %v", path)
for addr, groups := range expected {
v, found := m[addr]
ctx.Req.True(found, "expected key %v in map at path %v", addr, path)
vc, err := gabs.Consume(v)
ctx.Req.NoError(err)
actualSlice := ctx.toStringSlice(vc)
if len(groups) == 0 && len(actualSlice) == 0 {
continue
}
ctx.Req.Equal(groups, actualSlice, "groups mismatch for key %v at path %v", addr, path)
}
}
}
func (ctx *TestContext) RequireGetNonNilPathValue(container *gabs.Container, searchPath ...string) *gabs.Container {
if len(searchPath) == 1 {
searchPath = path(searchPath[0])
}
elem := container.S(searchPath...)
ctx.Req.NotNil(elem)
return elem
}
func (ctx *TestContext) RequirePathExists(container *gabs.Container, searchPath ...string) {
if len(searchPath) == 1 {
searchPath = path(searchPath[0])
}
ctx.Req.True(container.Exists(searchPath...), fmt.Sprintf("path does not exist in JSON container: %s", strings.Join(searchPath, ".")))
}
func (ctx *TestContext) RequireChildWith(container *gabs.Container, attribute string, value interface{}) *gabs.Container {
child := ctx.childWith(container, attribute, value)
ctx.Req.NotNil(child, "no child found with %v = %v", attribute, value)
return child
}
func (ctx *TestContext) RequireNoChildWith(container *gabs.Container, attribute string, value interface{}) *gabs.Container {
child := ctx.childWith(container, attribute, value)
ctx.Req.Nil(child, "child found with %v = %v", attribute, value)
return child
}
func (ctx *TestContext) childWith(container *gabs.Container, attribute string, value interface{}) *gabs.Container {
children, err := container.Children()
ctx.Req.NoError(err)
for _, child := range children {
attr := child.S(path(attribute)...)
if attr == nil {
continue
}
if reflect.DeepEqual(attr.Data(), value) {
return child
}
pfxlog.Logger().Infof("for attr %v, %v did not match %v", attribute, value, attr.Data())
}
return nil
}
func (ctx *TestContext) toStringSlice(container *gabs.Container) []string {
var result []string
if container != nil {
if container.Data() == nil {
return nil
}
children, err := container.Children()
ctx.Req.NoError(err)
result = make([]string, 0, len(children))
for _, child := range children {
val, ok := child.Data().(string)
ctx.Req.True(ok, "expected child to be string value")
result = append(result, val)
}
}
return result
}
func (ctx *TestContext) requireFieldError(httpStatus int, body []byte, errorCode string, field string) *gabs.Container {
ctx.Req.Equal(http.StatusBadRequest, httpStatus)
parsed := ctx.parseJson(body)
ctx.pathEquals(parsed, errorCode, path("error.code"))
ctx.pathEquals(parsed, field, path("error.cause.field"))
return parsed
}
func (ctx *TestContext) RequireNotFoundError(httpStatus int, body []byte) *gabs.Container {
ctx.Req.Equal(http.StatusNotFound, httpStatus)
parsed := ctx.parseJson(body)
ctx.pathEquals(parsed, errorz.NotFoundCode, path("error.code"))
ctx.pathEquals(parsed, "The resource requested was not found or is no longer available", path("error.message"))
return parsed
}
func (ctx *TestContext) requireUnauthorizedError(httpStatus int, body []byte) *gabs.Container {
ctx.Req.Equal(http.StatusUnauthorized, httpStatus)
parsed := ctx.parseJson(body)
ctx.pathEquals(parsed, errorz.UnauthorizedCode, path("error.code"))
ctx.pathEquals(parsed, "The request could not be completed. The session is not authorized or the credentials are invalid", path("error.message"))
return parsed
}
func (ctx *TestContext) logJson(data []byte) {
if ctx.enabledJsonLogging {
var prettyJSON bytes.Buffer
if err := json.Indent(&prettyJSON, data, "", " "); err == nil {
if _, err := fmt.Printf("Result:\n%s\n", prettyJSON.String()); err != nil {
panic(err)
}
} else {
if _, err := fmt.Printf("Result:\n%s\n", data); err != nil {
panic(err)
}
}
}
}
func path(path ...string) []string {
if len(path) == 1 {
return strings.Split(path[0], ".")
}
return path
}
func s(vals ...string) []string {
return vals
}