jsonschema_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

import (
	"encoding/json"
	"io/ioutil"
	"net/http"
	"os"
	"path/filepath"
	"strings"
	"testing"
	"time"

	"github.com/go-openapi/spec"
	"github.com/go-openapi/strfmt"
	"github.com/go-openapi/swag"
	"github.com/stretchr/testify/assert"
)

// 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"`
	}
}

type schemasTestT struct {
	Schema  *spec.Schema `json:"schema"`
	Valid   interface{}  `json:"valid"`
	Invalid interface{}  `json:"invalid"`
}

var jsonSchemaFixturesPath = filepath.Join("fixtures", "jsonschema_suite")
var schemaFixturesPath = filepath.Join("fixtures", "schemas")
var formatFixturesPath = filepath.Join("fixtures", "formats")

var ints = []interface{}{
	1,
	int8(1),
	int16(1),
	int(1),
	int32(1),
	int64(1),
	uint8(1),
	uint16(1),
	uint(1),
	uint32(1),
	uint64(1),
	5.0,
	float32(5.0),
	float64(5.0),
}

var notInts = []interface{}{
	5.1,
	float32(5.1),
	float64(5.1),
}

var notNumbers = []interface{}{
	map[string]string{},
	struct{}{},
	time.Time{},
	"yada",
}

var enabled = []string{
	// Standard fixtures from JSON schema suite
	"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
//"zeroTerminatedFloats",
//"format",	/* error on strict URI formatting */
//"bignum",
//"ecmascript-regex",
}

var extendedFixtures = []string{
	"extended-format",
}

type noopResCache struct {
}

func (n *noopResCache) Get(key string) (interface{}, bool) {
	return nil, false
}
func (n *noopResCache) Set(string, interface{}) {

}

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 := ioutil.ReadDir(jsonSchemaFixturesPath)
	if err != nil {
		t.Fatal(err)
	}

	for _, f := range files {
		if f.IsDir() {
			continue
		}
		fileName := f.Name()
		specName := strings.TrimSuffix(fileName, filepath.Ext(fileName))
		if isEnabled(specName) {
			t.Log("Running " + specName)
			b, _ := ioutil.ReadFile(filepath.Join(jsonSchemaFixturesPath, fileName))

			var testDescriptions []schemaTestT
			json.Unmarshal(b, &testDescriptions)

			for _, testDescription := range testDescriptions {
				var err error
				b, _ := testDescription.Schema.MarshalJSON()
				tmpFile, err := ioutil.TempFile(os.TempDir(), "validate-test")
				assert.NoError(t, err)
				tmpFile.Write(b)
				tmpFile.Close()
				opts := &spec.ExpandOptions{
					RelativeBase:    tmpFile.Name(),
					SkipSchemas:     false,
					ContinueOnError: false,
				}
				err = spec.ExpandSchemaWithBasePath(testDescription.Schema, nil, opts)

				if assert.NoError(t, err, testDescription.Description+" should expand cleanly") {
					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")
						}
					}
				}
				os.Remove(tmpFile.Name())
			}
		} else {
			t.Logf("WARNING: fixture from jsonschema-test-suite not enabled: %s", specName)
		}
	}
}

func TestSchemaFixtures(t *testing.T) {
	files, err := ioutil.ReadDir(schemaFixturesPath)
	if err != nil {
		t.Fatal(err)
	}

	for _, f := range files {
		if f.IsDir() {
			continue
		}
		fileName := f.Name()
		specName := strings.TrimSuffix(fileName, filepath.Ext(fileName))

		t.Log("Running " + specName)
		b, _ := ioutil.ReadFile(filepath.Join(schemaFixturesPath, fileName))

		var testDescriptions []schemasTestT
		json.Unmarshal(b, &testDescriptions)

		for _, testDescription := range testDescriptions {

			err := spec.ExpandSchema(testDescription.Schema, nil, nil /*new(noopResCache)*/)
			if assert.NoError(t, err) {

				validator := NewSchemaValidator(testDescription.Schema, nil, "data", strfmt.Default)
				valid := validator.Validate(testDescription.Valid)
				if assert.NotNil(t, valid, specName+" should validate") {
					assert.Empty(t, valid.Errors, specName+".valid should not have errors")
				}
				invalid := validator.Validate(testDescription.Invalid)
				if assert.NotNil(t, invalid, specName+" should validate") {
					assert.NotEmpty(t, invalid.Errors, specName+".invalid should have errors")
				}
			}
		}
	}
}

func TestOptionalJSONSchemaSuite(t *testing.T) {
	jsonOptionalSchemaFixturesPath := filepath.Join(jsonSchemaFixturesPath, "optional")
	files, err := ioutil.ReadDir(jsonOptionalSchemaFixturesPath)
	if err != nil {
		t.Fatal(err)
	}

	for _, f := range files {
		if f.IsDir() {
			continue
		}
		fileName := f.Name()
		specName := strings.TrimSuffix(fileName, filepath.Ext(fileName))
		if isOptionalEnabled(specName) {
			t.Log("Running [optional] " + specName)
			b, _ := ioutil.ReadFile(filepath.Join(jsonOptionalSchemaFixturesPath, fileName))

			var testDescriptions []schemaTestT
			json.Unmarshal(b, &testDescriptions)

			for _, testDescription := range testDescriptions {
				var err error
				b, _ := testDescription.Schema.MarshalJSON()
				tmpFile, err := ioutil.TempFile(os.TempDir(), "validate-test")
				assert.NoError(t, err)
				tmpFile.Write(b)
				tmpFile.Close()
				opts := &spec.ExpandOptions{
					RelativeBase:    tmpFile.Name(),
					SkipSchemas:     false,
					ContinueOnError: false,
				}
				err = spec.ExpandSchemaWithBasePath(testDescription.Schema, nil, opts)

				if assert.NoError(t, err, testDescription.Description+" should expand cleanly") {
					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")
						}
					}
				}
				os.Remove(tmpFile.Name())
			}
		} else {
			t.Logf("INFO: fixture from jsonschema-test-suite [optional] not enabled: %s", specName)
		}
	}
}

// Further testing with all formats recognized by strfmt
func TestFormat_JSONSchemaExtended(t *testing.T) {
	jsonFormatSchemaFixturesPath := filepath.Join(formatFixturesPath)
	files, err := ioutil.ReadDir(jsonFormatSchemaFixturesPath)
	if err != nil {
		t.Fatal(err)
	}

	for _, f := range files {
		if f.IsDir() {
			continue
		}
		fileName := f.Name()
		specName := strings.TrimSuffix(fileName, filepath.Ext(fileName))
		if isExtendedEnabled(specName) {
			t.Log("Running [extended formats] " + specName)
			b, _ := ioutil.ReadFile(filepath.Join(jsonFormatSchemaFixturesPath, fileName))

			var testDescriptions []schemaTestT
			json.Unmarshal(b, &testDescriptions)

			for _, testDescription := range testDescriptions {
				var err error

				// 1. Compile schema
				b, _ := testDescription.Schema.MarshalJSON()
				tmpFile, err := ioutil.TempFile(os.TempDir(), "validate-test")
				assert.NoError(t, err)
				tmpFile.Write(b)
				tmpFile.Close()
				opts := &spec.ExpandOptions{
					RelativeBase:    tmpFile.Name(),
					SkipSchemas:     false,
					ContinueOnError: false,
				}
				err = spec.ExpandSchemaWithBasePath(testDescription.Schema, nil, opts)

				if assert.NoError(t, err, testDescription.Description+" should expand cleanly") {
					validator := NewSchemaValidator(testDescription.Schema, nil, "data", strfmt.Default)
					for _, test := range testDescription.Tests {
						// 2. Validates raw JSON values against schema
						result := validator.Validate(test.Data)
						assert.NotNil(t, result, test.Description+" should validate")

						if test.Valid {
							assert.Emptyf(t, result.Errors, test.Description+" should not have errors but got: %v", result.Errors)
						} else {
							assert.NotEmpty(t, result.Errors, test.Description+" should have errors")
						}
					}
				}
				os.Remove(tmpFile.Name())
			}
		} else {
			t.Logf("INFO: fixture from extended tests suite [formats] not enabled: %s", specName)
		}
	}
}