File: //proc/thread-self/root/opt/go/pkg/mod/github.com/go-openapi/
[email protected]/items_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 spec
import (
"encoding/json"
"testing"
"github.com/go-openapi/swag"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
var items = Items{
Refable: Refable{Ref: MustCreateRef("Dog")},
CommonValidations: CommonValidations{
Maximum: float64Ptr(100),
ExclusiveMaximum: true,
ExclusiveMinimum: true,
Minimum: float64Ptr(5),
MaxLength: int64Ptr(100),
MinLength: int64Ptr(5),
Pattern: "\\w{1,5}\\w+",
MaxItems: int64Ptr(100),
MinItems: int64Ptr(5),
UniqueItems: true,
MultipleOf: float64Ptr(5),
Enum: []interface{}{"hello", "world"},
},
SimpleSchema: SimpleSchema{
Type: "string",
Format: "date",
Items: &Items{
Refable: Refable{Ref: MustCreateRef("Cat")},
},
CollectionFormat: "csv",
Default: "8",
},
}
const itemsJSON = `{
"items": {
"$ref": "Cat"
},
"$ref": "Dog",
"maximum": 100,
"minimum": 5,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"maxLength": 100,
"minLength": 5,
"pattern": "\\w{1,5}\\w+",
"maxItems": 100,
"minItems": 5,
"uniqueItems": true,
"multipleOf": 5,
"enum": ["hello", "world"],
"type": "string",
"format": "date",
"collectionFormat": "csv",
"default": "8"
}`
func TestIntegrationItems(t *testing.T) {
var actual Items
require.NoError(t, json.Unmarshal([]byte(itemsJSON), &actual))
assert.EqualValues(t, actual, items)
assertParsesJSON(t, itemsJSON, items)
}
func TestTypeNameItems(t *testing.T) {
var nilItems Items
assert.Equal(t, "", nilItems.TypeName())
assert.Equal(t, "date", items.TypeName())
assert.Equal(t, "", items.ItemsTypeName())
nested := Items{
SimpleSchema: SimpleSchema{
Type: "array",
Items: &Items{
SimpleSchema: SimpleSchema{
Type: "integer",
Format: "int32",
},
},
CollectionFormat: "csv",
},
}
assert.Equal(t, "array", nested.TypeName())
assert.Equal(t, "int32", nested.ItemsTypeName())
simple := SimpleSchema{
Type: "string",
Items: nil,
}
assert.Equal(t, "string", simple.TypeName())
assert.Equal(t, "", simple.ItemsTypeName())
simple.Items = NewItems()
simple.Type = "array"
simple.Items.Type = "string"
assert.Equal(t, "array", simple.TypeName())
assert.Equal(t, "string", simple.ItemsTypeName())
}
func TestItemsBuilder(t *testing.T) {
simple := SimpleSchema{
Type: "array",
Items: NewItems().
Typed("string", "uuid").
WithDefault([]string{"default-value"}).
WithEnum([]string{"abc", "efg"}, []string{"hij"}).
WithMaxItems(4).
WithMinItems(1).
UniqueValues(),
}
assert.Equal(t, SimpleSchema{
Type: "array",
Items: &Items{
SimpleSchema: SimpleSchema{
Type: "string",
Format: "uuid",
Default: []string{"default-value"},
},
CommonValidations: CommonValidations{
Enum: []interface{}{[]string{"abc", "efg"}, []string{"hij"}},
MinItems: swag.Int64(1),
MaxItems: swag.Int64(4),
UniqueItems: true,
},
},
}, simple)
}
func TestJSONLookupItems(t *testing.T) {
res, err := items.JSONLookup("$ref")
require.NoError(t, err)
require.NotNil(t, res)
require.IsType(t, &Ref{}, res)
var ok bool
ref, ok := res.(*Ref)
require.True(t, ok)
assert.EqualValues(t, MustCreateRef("Dog"), *ref)
var max *float64
res, err = items.JSONLookup("maximum")
require.NoError(t, err)
require.NotNil(t, res)
require.IsType(t, max, res)
max, ok = res.(*float64)
require.True(t, ok)
assert.InDelta(t, float64(100), *max, epsilon)
var f string
res, err = items.JSONLookup("collectionFormat")
require.NoError(t, err)
require.NotNil(t, res)
require.IsType(t, f, res)
f, ok = res.(string)
require.True(t, ok)
assert.Equal(t, "csv", f)
res, err = items.JSONLookup("unknown")
require.Error(t, err)
require.Nil(t, res)
}
func TestItemsWithValidation(t *testing.T) {
i := new(Items).WithValidations(CommonValidations{MaxLength: swag.Int64(15)})
assert.EqualValues(t, swag.Int64(15), i.MaxLength)
}