1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
|
// Copyright 2015 go-swagger maintainers
//
// 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 validate
import (
"encoding/json"
"net/http"
"os"
"path/filepath"
"strings"
"testing"
"github.com/go-openapi/swag"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"k8s.io/kube-openapi/pkg/validation/spec"
"k8s.io/kube-openapi/pkg/validation/strfmt"
)
// Data structure for jsonschema-suite fixtures
type schemaTestT struct {
Description string `json:"description"`
Schema *spec.Schema `json:"schema"`
Tests []struct {
Description string `json:"description"`
Data interface{} `json:"data"`
Valid bool `json:"valid"`
}
}
var jsonSchemaFixturesPath = filepath.Join("fixtures", "jsonschema_suite")
var schemaFixturesPath = filepath.Join("fixtures", "schemas")
var formatFixturesPath = filepath.Join("fixtures", "formats")
func enabled() []string {
// Standard fixtures from JSON schema suite
return []string{
"minLength",
"maxLength",
"pattern",
"type",
"minimum",
"maximum",
"multipleOf",
"enum",
"default",
"dependencies",
"items",
"maxItems",
"maxProperties",
"minItems",
"minProperties",
"patternProperties",
"required",
"additionalItems",
"uniqueItems",
"properties",
"additionalProperties",
"allOf",
"not",
"oneOf",
"anyOf",
"ref",
"definitions",
"refRemote",
"format",
}
}
var optionalFixtures = []string{
// Optional fixtures from JSON schema suite: at the moment, these are disabled
//"zeroTerminatedFloats",
//"format", /* error on strict URI formatting */
//"bignum",
//"ecmascript-regex",
}
var extendedFixtures = []string{
"extended-format",
}
func isEnabled(nm string) bool {
return swag.ContainsStringsCI(enabled(), nm)
}
func isOptionalEnabled(nm string) bool {
return swag.ContainsStringsCI(optionalFixtures, nm)
}
func isExtendedEnabled(nm string) bool {
return swag.ContainsStringsCI(extendedFixtures, nm)
}
func TestJSONSchemaSuite(t *testing.T) {
// Internal local server to serve remote $ref
go func() {
err := http.ListenAndServe("localhost:1234", http.FileServer(http.Dir(jsonSchemaFixturesPath+"/remotes")))
if err != nil {
panic(err.Error())
}
}()
files, err := os.ReadDir(jsonSchemaFixturesPath)
if err != nil {
t.Fatal(err)
}
for _, f := range files {
if f.IsDir() {
continue
}
fileName := f.Name()
t.Run(fileName, func(t *testing.T) {
t.Parallel()
specName := strings.TrimSuffix(fileName, filepath.Ext(fileName))
if !isEnabled(specName) {
t.Logf("WARNING: fixture from jsonschema-test-suite not enabled: %s", specName)
return
}
t.Log("Running " + specName)
b, _ := os.ReadFile(filepath.Join(jsonSchemaFixturesPath, fileName))
doTestSchemaSuite(t, b)
})
}
}
func TestSchemaFixtures(t *testing.T) {
files, err := os.ReadDir(schemaFixturesPath)
if err != nil {
t.Fatal(err)
}
for _, f := range files {
if f.IsDir() {
continue
}
fileName := f.Name()
t.Run(fileName, func(t *testing.T) {
t.Parallel()
specName := strings.TrimSuffix(fileName, filepath.Ext(fileName))
t.Log("Running " + specName)
b, _ := os.ReadFile(filepath.Join(schemaFixturesPath, fileName))
doTestSchemaSuite(t, b)
})
}
}
func TestOptionalJSONSchemaSuite(t *testing.T) {
jsonOptionalSchemaFixturesPath := filepath.Join(jsonSchemaFixturesPath, "optional")
files, err := os.ReadDir(jsonOptionalSchemaFixturesPath)
if err != nil {
t.Fatal(err)
}
for _, f := range files {
if f.IsDir() {
continue
}
fileName := f.Name()
t.Run(fileName, func(t *testing.T) {
t.Parallel()
specName := strings.TrimSuffix(fileName, filepath.Ext(fileName))
if !isOptionalEnabled(specName) {
t.Logf("INFO: fixture from jsonschema-test-suite [optional] not enabled: %s", specName)
return
}
t.Log("Running [optional] " + specName)
b, _ := os.ReadFile(filepath.Join(jsonOptionalSchemaFixturesPath, fileName))
doTestSchemaSuite(t, b)
})
}
}
// Further testing with all formats recognized by strfmt
func TestFormat_JSONSchemaExtended(t *testing.T) {
jsonFormatSchemaFixturesPath := filepath.Join(formatFixturesPath)
files, err := os.ReadDir(jsonFormatSchemaFixturesPath)
if err != nil {
t.Fatal(err)
}
for _, f := range files {
if f.IsDir() {
continue
}
fileName := f.Name()
t.Run(fileName, func(t *testing.T) {
t.Parallel()
specName := strings.TrimSuffix(fileName, filepath.Ext(fileName))
if !isExtendedEnabled(specName) {
t.Logf("INFO: fixture from extended tests suite [formats] not enabled: %s", specName)
return
}
t.Log("Running [extended formats] " + specName)
b, _ := os.ReadFile(filepath.Join(jsonFormatSchemaFixturesPath, fileName))
doTestSchemaSuite(t, b)
})
}
}
func doTestSchemaSuite(t *testing.T, doc []byte) {
// run a test formatted as per jsonschema-test-suite
var testDescriptions []schemaTestT
eru := json.Unmarshal(doc, &testDescriptions)
require.NoError(t, eru)
for _, testDescription := range testDescriptions {
b, _ := testDescription.Schema.MarshalJSON()
tmpFile, err := os.CreateTemp(os.TempDir(), "validate-test")
assert.NoError(t, err)
_, _ = tmpFile.Write(b)
tmpFile.Close()
defer func() { _ = os.Remove(tmpFile.Name()) }()
validator := NewSchemaValidator(testDescription.Schema, nil, "data", strfmt.Default)
for _, test := range testDescription.Tests {
result := validator.Validate(test.Data)
assert.NotNil(t, result, test.Description+" should validate")
if test.Valid {
assert.Empty(t, result.Errors, test.Description+" should not have errors")
} else {
assert.NotEmpty(t, result.Errors, test.Description+" should have errors")
}
}
}
}
|