File: validate_references_test.py

package info (click to toggle)
swagger-spec-validator 3.0.4-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 696 kB
  • sloc: python: 2,321; makefile: 28; sh: 2
file content (68 lines) | stat: -rw-r--r-- 2,343 bytes parent folder | download | duplicates (3)
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
import pytest

from swagger_spec_validator.common import SwaggerValidationWarning
from swagger_spec_validator.validator20 import validate_references


@pytest.mark.parametrize(
    "raw_spec",
    [
        {"$ref": "#/"},
        {"description": "Description sibling is acceptable", "$ref": "#/"},
        [{"$ref": "#/"}],
    ],
)
def test_validate_valid_references(recwarn, raw_spec):
    validate_references(raw_spec=raw_spec, deref=lambda x: x)
    assert len(recwarn) == 0


@pytest.mark.parametrize(
    "raw_spec, expected_warning_messages",
    [
        (
            {"sibling-attribute": "", "$ref": "#/"},
            (
                'Found "$ref: #/" with siblings that will be overwritten. '
                "See https://stackoverflow.com/a/48114924 for more information. (path #)",
            ),
        ),
        (
            [{"sibling-attribute": "", "$ref": "#/"}],
            (
                'Found "$ref: #/" with siblings that will be overwritten. '
                "See https://stackoverflow.com/a/48114924 for more information. (path #/0)",
            ),
        ),
        (
            {"$ref": None},
            (
                "Identified $ref with None value. This is usually an error, although technically it might be allowed. "
                "(path: #)",
            ),
        ),
        (
            {"key": {"$ref": None}},
            (
                "Identified $ref with None value. This is usually an error, although technically it might be allowed. "
                "(path: #/key)",
            ),
        ),
        (
            {"key": [{"sibling-attribute": 1, "$ref": None}]},
            (
                'Found "$ref: None" with siblings that will be overwritten. '
                "See https://stackoverflow.com/a/48114924 for more information. (path #/key/0)",
                "Identified $ref with None value. This is usually an error, although technically it might be allowed. "
                "(path: #/key/0)",
            ),
        ),
    ],
)
def test_validate_references_to_warn(raw_spec, expected_warning_messages):
    with pytest.warns(SwaggerValidationWarning) as warninfo:
        validate_references(raw_spec=raw_spec, deref=lambda x: x)

    assert sorted(expected_warning_messages) == sorted(
        str(warning.message) for warning in warninfo.list
    )