Passed
Pull Request — master (#90)
by Antonio
01:03
created

build.utils.validate()   B

Complexity

Conditions 5

Size

Total Lines 48
Code Lines 36

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 5
eloc 36
nop 1
dl 0
loc 48
rs 8.5493
c 0
b 0
f 0
1
"""Utility functions."""
2
import functools
3
from pathlib import Path
4
5
from flask import request
6
from openapi_core import create_spec
7
from openapi_core.contrib.flask import FlaskOpenAPIRequest
8
from openapi_core.validation.request.validators import RequestValidator
9
from openapi_spec_validator import validate_spec
10
from openapi_spec_validator.readers import read_from_filename
11
from werkzeug.exceptions import BadRequest, UnsupportedMediaType
12
13
from kytos.core import log
14
from kytos.core.events import KytosEvent
15
16
17
def emit_event(controller, name, **kwargs):
18
    """Send an event when something happens with an EVC."""
19
    event_name = f"kytos/mef_eline.{name}"
20
    event = KytosEvent(name=event_name, content=kwargs)
21
    controller.buffers.app.put(event)
22
23
24
def compare_endpoint_trace(endpoint, vlan, trace):
25
    """Compare and endpoint with a trace step."""
26
    return (
27
        endpoint.switch.dpid == trace["dpid"]
28
        and endpoint.port_number == trace["port"]
29
        and vlan == trace["vlan"]
30
    )
31
32
33
def load_spec():
34
    """Validate openapi spec."""
35
    napp_dir = Path(__file__).parent
36
    yml_file = napp_dir / "openapi.yml"
37
    spec_dict, _ = read_from_filename(yml_file)
38
39
    validate_spec(spec_dict)
40
41
    return create_spec(spec_dict)
42
43
44
def validate(spec):
45
    """Decorator to validate a REST endpoint input.
46
47
    Uses the schema defined in the openapi.yml file
48
    to validate.
49
    """
50
51
    def validate_decorator(func):
52
        @functools.wraps(func)
53
        def wrapper_validate(*args, **kwargs):
54
            print(f"Spec {spec}")
55
            try:
56
                data = request.get_json()
57
            except BadRequest:
58
                result = "The request body is not a well-formed JSON."
59
                log.debug("create_circuit result %s %s", result, 400)
60
                raise BadRequest(result) from BadRequest
61
            if data is None:
62
                result = "The request body mimetype is not application/json."
63
                log.debug("update result %s %s", result, 415)
64
                raise UnsupportedMediaType(result)
65
66
            validator = RequestValidator(spec)
67
            openapi_request = FlaskOpenAPIRequest(request)
68
            result = validator.validate(openapi_request)
69
            if result.errors:
70
                errors = result.errors[0]
71
                if hasattr(errors, "schema_errors"):
72
                    schema_errors = errors.schema_errors[0]
73
                    error_response = {
74
                        "error_message": schema_errors.message,
75
                        "error_validator": schema_errors.validator,
76
                        "error_validator_value": schema_errors.validator_value,
77
                        "error_path": list(schema_errors.path),
78
                        "error_schema": schema_errors.schema,
79
                        "error_schema_path": list(schema_errors.schema_path),
80
                    }
81
                    log.debug("error response: %s", error_response)
82
                else:
83
                    error_response = (
84
                        "The request body mimetype is not application/json."
85
                    )
86
                raise BadRequest(error_response) from BadRequest
87
            return func(*args, data=data, **kwargs)
88
89
        return wrapper_validate
90
91
    return validate_decorator
92