mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-11-01 02:57:59 +00:00
6a2586747c
This pull request adds 3 functions (and corresponding tests): `testhelpers/response_validation.go`: - `ValidateResponse` - `ValidateResponseData` field_data.go: - `ValidateStrict` (has the "strict" validation logic) The functions are primarily meant to be used in tests to ensure that the responses are consistent with the defined response schema. An example of how the functions can be used in tests can be found in #18636. ### Background This PR is part of the ongoing work to add structured responses in Vault OpenAPI (VLT-234)
79 lines
2.3 KiB
Go
79 lines
2.3 KiB
Go
package schema
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/hashicorp/vault/sdk/framework"
|
|
"github.com/hashicorp/vault/sdk/logical"
|
|
)
|
|
|
|
// ValidateResponseData is a test helper that validates whether the given
|
|
// response data map conforms to the response schema (schema.Fields). It cycles
|
|
// through the data map and validates conversions in the schema. In "strict"
|
|
// mode, this function will also ensure that the data map has all schema's
|
|
// requred fields and does not have any fields outside of the schema.
|
|
func ValidateResponse(t *testing.T, schema *framework.Response, response *logical.Response, strict bool) {
|
|
t.Helper()
|
|
|
|
if response != nil {
|
|
ValidateResponseData(t, schema, response.Data, strict)
|
|
} else {
|
|
ValidateResponseData(t, schema, nil, strict)
|
|
}
|
|
}
|
|
|
|
// ValidateResponse is a test helper that validates whether the given response
|
|
// object conforms to the response schema (schema.Fields). It cycles through
|
|
// the data map and validates conversions in the schema. In "strict" mode, this
|
|
// function will also ensure that the data map has all schema-required fields
|
|
// and does not have any fields outside of the schema.
|
|
func ValidateResponseData(t *testing.T, schema *framework.Response, data map[string]interface{}, strict bool) {
|
|
t.Helper()
|
|
|
|
if err := validateResponseDataImpl(
|
|
schema,
|
|
data,
|
|
strict,
|
|
); err != nil {
|
|
t.Fatalf("validation error: %v; response data: %#v", err, data)
|
|
}
|
|
}
|
|
|
|
// validateResponseDataImpl is extracted so that it can be tested
|
|
func validateResponseDataImpl(schema *framework.Response, data map[string]interface{}, strict bool) error {
|
|
// nothing to validate
|
|
if schema == nil {
|
|
return nil
|
|
}
|
|
|
|
// Marshal the data to JSON and back to convert the map's values into
|
|
// JSON strings expected by Validate() and ValidateStrict(). This is
|
|
// not efficient and is done for testing purposes only.
|
|
jsonBytes, err := json.Marshal(data)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to convert input to json: %w", err)
|
|
}
|
|
|
|
var dataWithStringValues map[string]interface{}
|
|
if err := json.Unmarshal(
|
|
jsonBytes,
|
|
&dataWithStringValues,
|
|
); err != nil {
|
|
return fmt.Errorf("failed to unmashal data: %w", err)
|
|
}
|
|
|
|
// Validate
|
|
fd := framework.FieldData{
|
|
Raw: dataWithStringValues,
|
|
Schema: schema.Fields,
|
|
}
|
|
|
|
if strict {
|
|
return fd.ValidateStrict()
|
|
}
|
|
|
|
return fd.Validate()
|
|
}
|