FilesExpand file tree

main

/

default_validator_test.go

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

113 lines (98 loc) · 3.26 KB

main

/

default_validator_test.go

Copy path

Top

File metadata and controls

• Code
• Blame

113 lines (98 loc) · 3.26 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

// SPDX-FileCopyrightText: Copyright 2015-2025 go-swagger maintainers

// SPDX-License-Identifier: Apache-2.0

package validate

import (

"path/filepath"

"testing"

analysis "github.com/allons-y/openapi-analysis"

loads "github.com/allons-y/openapi-loads"

spec "github.com/allons-y/openapi-spec"

"github.com/go-openapi/strfmt"

"github.com/go-openapi/testify/v2/assert"

"github.com/go-openapi/testify/v2/require"

)

const (

jsonExt = ".json"

hasErrorMsg = " should have errors"

noErrorMsg = " should not have errors"

hasWarningMsg = " should have warnings"

)

func TestDefault_ValidatePetStore(t *testing.T) {

doc, _ := loads.Analyzed(PetStoreJSONMessage, "")

validator := NewSpecValidator(spec.MustLoadSwagger20Schema(), strfmt.Default)

validator.spec = doc

validator.analyzer = analysis.New(doc.Spec())

myDefaultValidator := &defaultValidator{SpecValidator: validator}

res := myDefaultValidator.Validate()

assert.Empty(t, res.Errors)

}

func makeSpecValidator(t *testing.T, fp string) *SpecValidator {

doc, err := loads.Spec(fp)

require.NoError(t, err)

validator := NewSpecValidator(spec.MustLoadSwagger20Schema(), strfmt.Default)

validator.spec = doc

validator.analyzer = analysis.New(doc.Spec())

return validator

}

func TestDefault_ValidateDefaults(t *testing.T) {

tests := []string{

"parameter",

"parameter-required",

"parameter-ref",

"parameter-items",

"header",

"header-items",

"schema",

"schema-ref",

"schema-additionalProperties",

"schema-patternProperties",

"schema-items",

"schema-allOf",

"parameter-schema",

"default-response",

"header-response",

"header-items-default-response",

"header-items-response",

"header-pattern",

"header-badpattern",

"schema-items-allOf",

"response-ref",

}

for _, tt := range tests {

path := filepath.Join("fixtures", "validation", "default", "valid-default-value-"+tt+jsonExt)

if DebugTest {

t.Logf("Testing valid default values for: %s", path)

}

validator := makeSpecValidator(t, path)

myDefaultValidator := &defaultValidator{SpecValidator: validator}

res := myDefaultValidator.Validate()

assert.Empty(t, res.Errors, tt+noErrorMsg)

// Special case: warning only

if tt == "parameter-required" {

warns := verifiedTestWarnings(res)

assert.Contains(t, warns, "limit in query has a default value and is required as parameter")

}

path = filepath.Join("fixtures", "validation", "default", "invalid-default-value-"+tt+jsonExt)

if DebugTest {

t.Logf("Testing invalid default values for: %s", path)

}

validator = makeSpecValidator(t, path)

myDefaultValidator = &defaultValidator{SpecValidator: validator}

res = myDefaultValidator.Validate()

assert.NotEmpty(t, res.Errors, tt+hasErrorMsg)

// Update: now we have an additional message to explain it's all about a default value

// Example:

// - default value for limit in query does not validate its Schema

// - limit in query must be of type integer: "string"]

assert.NotEmptyf(t, res.Errors, tt+" should have at least 1 error")

}

}

func TestDefault_EdgeCase(t *testing.T) {

// Testing guards

var myDefaultvalidator *defaultValidator

res := myDefaultvalidator.Validate()

assert.True(t, res.IsValid())

myDefaultvalidator = &defaultValidator{}

res = myDefaultvalidator.Validate()

assert.True(t, res.IsValid())

}