File: //proc/self/root/opt/go/pkg/mod/github.com/go-openapi/
[email protected]/doc_test.go
// 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_test
import (
"encoding/json"
"fmt"
"os"
"path/filepath"
"testing"
"github.com/go-openapi/loads" // Spec loading
"github.com/go-openapi/spec"
"github.com/go-openapi/strfmt" // OpenAPI format extensions
"github.com/go-openapi/validate" // This package
"github.com/stretchr/testify/require"
)
func ExampleSpec() {
// Example with high level spec validation call, without showing warnings
// Example with spec file in this repo:
path := "fixtures/validation/valid-ref.json"
doc, err := loads.Spec(path)
if err == nil {
validate.SetContinueOnErrors(true) // Set global options
errs := validate.Spec(doc, strfmt.Default) // Validates spec with default Swagger 2.0 format definitions
if errs == nil {
fmt.Println("This spec is valid")
} else {
fmt.Printf("This spec has some validation errors: %v\n", errs)
}
} else {
fmt.Println("Could not load this spec")
}
// Output: This spec is valid
}
func ExampleSpec_second() {
// Example with high level spec validation call, without showing warnings
// Example with online spec URL:
url := "http://petstore.swagger.io/v2/swagger.json"
doc, err := loads.JSONSpec(url)
if err == nil {
validate.SetContinueOnErrors(true) // Set global options
errs := validate.Spec(doc, strfmt.Default) // Validates spec with default Swagger 2.0 format definitions
if errs == nil {
fmt.Println("This spec is valid")
} else {
fmt.Printf("This spec has some validation errors: %v\n", errs)
}
} else {
fmt.Println("Could not load this spec:", err)
}
// Output:
// This spec is valid
}
func ExampleSpecValidator_Validate() {
// Example of spec validation call with full result
// Example with online spec URL:
// url := "http://petstore.swagger.io/v2/swagger.json"
// doc, err := loads.JSONSpec(url)
// Example with spec file in this repo:
path := "fixtures/validation/valid-ref.json"
doc, err := loads.Spec(path)
if err == nil {
validator := validate.NewSpecValidator(doc.Schema(), strfmt.Default)
validator.SetContinueOnErrors(true) // Set option for this validator
result, _ := validator.Validate(doc) // Validates spec with default Swagger 2.0 format definitions
if result.IsValid() {
fmt.Println("This spec is valid")
} else {
fmt.Println("This spec has some validation errors")
}
if result.HasWarnings() {
fmt.Println("This spec has some validation warnings")
}
}
// Output:
// This spec is valid
// This spec has some validation warnings
}
func ExampleSpecValidator_Validate_url() {
// Example of spec validation call with full result
// Example with online spec URL:
url := "http://petstore.swagger.io/v2/swagger.json"
doc, err := loads.JSONSpec(url)
if err == nil {
validator := validate.NewSpecValidator(doc.Schema(), strfmt.Default)
validator.SetContinueOnErrors(true) // Set option for this validator
result, _ := validator.Validate(doc) // Validates spec with default Swagger 2.0 format definitions
if result.IsValid() {
fmt.Println("This spec is valid")
} else {
fmt.Println("This spec has some validation errors")
}
if result.HasWarnings() {
fmt.Println("This spec has some validation warnings")
}
}
// Output:
// This spec is valid
}
func ExampleAgainstSchema() {
// Example using encoding/json as unmarshaller
var schemaJSON = `
{
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z]+$",
"minLength": 1
}
},
"patternProperties": {
"address-[0-9]+": {
"type": "string",
"pattern": "^[\\s|a-z]+$"
}
},
"required": [
"name"
],
"additionalProperties": false
}`
schema := new(spec.Schema)
_ = json.Unmarshal([]byte(schemaJSON), schema)
input := map[string]interface{}{}
// JSON data to validate
inputJSON := `{"name": "Ivan","address-1": "sesame street"}`
_ = json.Unmarshal([]byte(inputJSON), &input)
// strfmt.Default is the registry of recognized formats
err := validate.AgainstSchema(schema, input, strfmt.Default)
if err != nil {
fmt.Printf("JSON does not validate against schema: %v", err)
} else {
fmt.Printf("OK")
}
// Output:
// OK
}
func TestValidate_Issue112(t *testing.T) {
t.Run("returns no error on body includes `items` key", func(t *testing.T) {
body := map[string]interface{}{"items1": nil}
err := validate.AgainstSchema(getSimpleSchema(), body, strfmt.Default)
require.NoError(t, err)
})
t.Run("returns no error when body includes `items` key", func(t *testing.T) {
body := map[string]interface{}{"items": nil}
err := validate.AgainstSchema(getSimpleSchema(), body, strfmt.Default)
require.NoError(t, err)
})
}
func getSimpleSchema() *spec.Schema {
return &spec.Schema{
SchemaProps: spec.SchemaProps{
Type: spec.StringOrArray{"object"},
},
}
}
func Test_Issue102_Circular(t *testing.T) {
// assert that the issue is fixed in go-openapi/spec
for _, fixture := range []string{
filepath.Join("fixtures", "bugs", "102", "fixture-102.json"),
filepath.Join("fixtures", "bugs", "123-validate", "fixture-123.json"),
} {
t.Run(fixture, func(t *testing.T) {
filebytes, err := os.ReadFile(fixture)
require.NoError(t, err)
openAPIv2Doc := json.RawMessage(filebytes)
doc, err := loads.Analyzed(openAPIv2Doc, "")
require.NoError(t, err)
validator := validate.NewSpecValidator(doc.Schema(), strfmt.Default)
validator.SetContinueOnErrors(true)
res, _ := validator.Validate(doc)
require.Emptyf(t, res.Errors, "unexpected validation erorrs: %v", res.Errors)
})
}
}