1 # -*- coding: utf-8 -*-
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 from jsonschema
import validate
as js_v
, exceptions
as js_e
17 from http
import HTTPStatus
18 from copy
import deepcopy
19 from uuid
import UUID
# To test for valid UUID
21 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
23 version_date
= "Mar 2018"
26 Validator of input data using JSON schemas for those items that not contains an OSM yang information model
30 patern_name
= "^[ -~]+$"
35 "pattern": "^[^,;()\\.\\$'\"]+$",
37 passwd_schema
= {"type": "string", "minLength": 1, "maxLength": 60}
42 "pattern": "^[^,;()'\"]+$",
44 string_schema
= {"type": "string", "minLength": 1, "maxLength": 255}
51 description_schema
= {
52 "type": ["string", "null"],
54 "pattern": "^[^'\"]+$",
56 long_description_schema
= {
57 "type": ["string", "null"],
59 "pattern": "^[^'\"]+$",
61 id_schema_fake
= {"type": "string", "minLength": 2, "maxLength": 36}
62 bool_schema
= {"type": "boolean"}
63 null_schema
= {"type": "null"}
64 # "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
67 "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$",
71 "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}",
75 "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\\.[0-9a-fA-F]$",
77 # allows [] for wildcards. For that reason huge length limit is set
78 pci_extended_schema
= {"type": "string", "pattern": "^[0-9a-fA-F.:-\\[\\]]{12,40}$"}
79 http_schema
= {"type": "string", "pattern": "^(https?|http)://[^'\"=]+$"}
80 bandwidth_schema
= {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
81 memory_schema
= {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
82 integer0_schema
= {"type": "integer", "minimum": 0}
83 integer1_schema
= {"type": "integer", "minimum": 1}
84 path_schema
= {"type": "string", "pattern": "^(\\.){0,2}(/[^/\"':{}\\(\\)]+)+$"}
85 vlan_schema
= {"type": "integer", "minimum": 1, "maximum": 4095}
86 vlan1000_schema
= {"type": "integer", "minimum": 1000, "maximum": 4095}
89 "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$",
90 } # must be unicast: LSB bit of MSB byte ==0
91 dpid_Schema
= {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"}
92 # mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
95 "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
99 "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))",
103 "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}"
104 "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$",
106 port_schema
= {"type": "integer", "minimum": 1, "maximum": 65534}
107 object_schema
= {"type": "object"}
108 schema_version_2
= {"type": "integer", "minimum": 2, "maximum": 2}
109 # schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
112 "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
114 checksum_schema
= {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
115 size_schema
= {"type": "integer", "minimum": 1, "maximum": 100}
116 array_edition_schema
= {
118 "patternProperties": {"^\\$": {}},
119 "additionalProperties": False,
122 nameshort_list_schema
= {
125 "items": shortname_schema
,
128 description_list_schema
= {
131 "items": description_schema
,
134 ns_instantiate_vdu
= {
135 "title": "ns action instantiate input schema for vdu",
136 "$schema": "http://json-schema.org/draft-04/schema#",
147 "vim-volume-id": name_schema
,
149 "required": ["name", "vim-volume-id"],
150 "additionalProperties": False,
160 "ip-address": {"oneOf": [ip_schema
, ipv6_schema
]},
161 "mac-address": mac_schema
,
162 "floating-ip-required": bool_schema
,
164 "required": ["name"],
165 "additionalProperties": False,
170 "additionalProperties": False,
173 ip_profile_dns_schema
= {
179 "address": {"oneOf": [ip_schema
, ipv6_schema
]},
181 "required": ["address"],
182 "additionalProperties": False,
186 ip_profile_dhcp_schema
= {
189 "enabled": {"type": "boolean"},
190 "count": integer1_schema
,
191 "start-address": ip_schema
,
193 "additionalProperties": False,
196 ip_profile_schema
= {
197 "title": "ip profile validation schema",
198 "$schema": "http://json-schema.org/draft-04/schema#",
201 "ip-version": {"enum": ["ipv4", "ipv6"]},
202 "subnet-address": ip_prefix_schema
,
203 "gateway-address": ip_schema
,
204 "dns-server": ip_profile_dns_schema
,
205 "dhcp-params": ip_profile_dhcp_schema
,
209 ip_profile_update_schema
= {
210 "title": "ip profile validation schema",
211 "$schema": "http://json-schema.org/draft-04/schema#",
214 "ip-version": {"enum": ["ipv4", "ipv6"]},
215 "subnet-address": {"oneOf": [null_schema
, ip_prefix_schema
]},
216 "gateway-address": {"oneOf": [null_schema
, ip_schema
]},
217 "dns-server": {"oneOf": [null_schema
, ip_profile_dns_schema
]},
218 "dhcp-params": {"oneOf": [null_schema
, ip_profile_dhcp_schema
]},
220 "additionalProperties": False,
223 provider_network_schema
= {
224 "title": "provider network validation schema",
225 "$schema": "http://json-schema.org/draft-04/schema#",
228 "physical-network": name_schema
,
229 "segmentation-id": name_schema
,
230 "sdn-ports": { # external ports to append to the SDN-assist network
235 "switch_id": shortname_schema
,
236 "switch_port": shortname_schema
,
237 "mac_address": mac_schema
,
240 "additionalProperties": True,
243 "network-type": shortname_schema
,
245 "additionalProperties": True,
248 ns_instantiate_internal_vld
= {
249 "title": "ns action instantiate input schema for vld",
250 "$schema": "http://json-schema.org/draft-04/schema#",
254 "vim-network-name": name_schema
,
255 "vim-network-id": name_schema
,
256 "ip-profile": ip_profile_update_schema
,
257 "provider-network": provider_network_schema
,
258 "internal-connection-point": {
264 "id-ref": name_schema
,
265 "ip-address": ip_schema
,
266 # "mac-address": mac_schema,
268 "required": ["id-ref"],
270 "additionalProperties": False,
274 "required": ["name"],
276 "additionalProperties": False,
279 additional_params_for_vnf
= {
284 "member-vnf-index": name_schema
,
285 "additionalParams": object_schema
,
286 "k8s-namespace": name_schema
,
287 "config-units": integer1_schema
, # number of configuration units of this vnf, by default 1
288 "additionalParamsForVdu": {
293 "vdu_id": name_schema
,
294 "additionalParams": object_schema
,
295 "config-units": integer1_schema
, # number of configuration units of this vdu, by default 1
297 "required": ["vdu_id"],
299 "additionalProperties": False,
302 "additionalParamsForKdu": {
307 "kdu_name": name_schema
,
308 "additionalParams": object_schema
,
309 "kdu_model": name_schema
,
310 "k8s-namespace": name_schema
,
311 "config-units": integer1_schema
, # number of configuration units of this knf, by default 1
312 "kdu-deployment-name": name_schema
,
314 "required": ["kdu_name"],
316 "additionalProperties": False,
319 "affinity-or-anti-affinity-group": {
325 "vim-affinity-group-id": name_schema
,
329 "additionalProperties": False,
333 "required": ["member-vnf-index"],
335 "additionalProperties": False,
340 "title": "ns action instantiate input schema",
341 "$schema": "http://json-schema.org/draft-04/schema#",
344 "lcmOperationType": string_schema
,
345 "nsInstanceId": id_schema
,
346 "netsliceInstanceId": id_schema
,
347 "nsName": name_schema
,
348 "nsDescription": {"oneOf": [description_schema
, null_schema
]},
350 "vimAccountId": id_schema
,
351 "wimAccountId": {"oneOf": [id_schema
, bool_schema
, null_schema
]},
352 "placement-engine": string_schema
,
353 "placement-constraints": object_schema
,
354 "additionalParamsForNs": object_schema
,
355 "additionalParamsForVnf": additional_params_for_vnf
,
356 "config-units": integer1_schema
, # number of configuration units of this ns, by default 1
357 "k8s-namespace": name_schema
,
358 "ssh_keys": {"type": "array", "items": {"type": "string"}},
359 "timeout_ns_deploy": integer1_schema
,
361 "vduImage": name_schema
,
368 "member-vnf-index": name_schema
,
369 "vimAccountId": id_schema
,
373 "items": ns_instantiate_vdu
,
378 "items": ns_instantiate_internal_vld
,
381 "required": ["member-vnf-index"],
383 "additionalProperties": False,
392 "name": string_schema
,
393 "vim-network-name": {"oneOf": [string_schema
, object_schema
]},
394 "vim-network-id": {"oneOf": [string_schema
, object_schema
]},
395 "ns-net": object_schema
,
396 "wimAccountId": {"oneOf": [id_schema
, bool_schema
, null_schema
]},
397 "ip-profile": object_schema
,
398 "provider-network": provider_network_schema
,
399 "vnfd-connection-point-ref": {
405 "member-vnf-index-ref": name_schema
,
406 "vnfd-connection-point-ref": name_schema
,
407 "ip-address": {"oneOf": [ip_schema
, ipv6_schema
]},
408 # "mac-address": mac_schema,
411 "member-vnf-index-ref",
412 "vnfd-connection-point-ref",
415 "additionalProperties": False,
419 "required": ["name"],
420 "additionalProperties": False,
424 "required": ["nsName", "nsdId", "vimAccountId"],
425 "additionalProperties": False,
429 "title": "ns terminate input schema",
430 "$schema": "http://json-schema.org/draft-04/schema#",
433 "lcmOperationType": string_schema
,
434 "nsInstanceId": id_schema
,
435 "autoremove": bool_schema
,
436 "timeout_ns_terminate": integer1_schema
,
437 "skip_terminate_primitives": bool_schema
,
438 "netsliceInstanceId": id_schema
,
440 "additionalProperties": False,
444 "title": "ns update input schema",
445 "$schema": "http://json-schema.org/draft-04/schema#",
448 "lcmOperationType": string_schema
,
449 "nsInstanceId": id_schema
,
450 "timeout_ns_update": integer1_schema
,
452 "enum": ["CHANGE_VNFPKG", "REMOVE_VNF", "MODIFY_VNF_INFORMATION"]
454 "modifyVnfInfoData": {
457 "vnfInstanceId": id_schema
,
460 "required": ["vnfInstanceId", "vnfdId"],
462 "removeVnfInstanceId": id_schema
,
463 "changeVnfPackageData": {
466 "vnfInstanceId": id_schema
,
469 "required": ["vnfInstanceId", "vnfdId"],
472 "required": ["updateType"],
473 "additionalProperties": False,
476 ns_action
= { # TODO for the moment it is only contemplated the vnfd primitive execution
477 "title": "ns action input schema",
478 "$schema": "http://json-schema.org/draft-04/schema#",
481 "lcmOperationType": string_schema
,
482 "nsInstanceId": id_schema
,
483 "member_vnf_index": name_schema
,
484 "vnf_member_index": name_schema
, # TODO for backward compatibility. To remove in future
485 "vdu_id": name_schema
,
486 "vdu_count_index": integer0_schema
,
487 "kdu_name": name_schema
,
488 "primitive": name_schema
,
489 "timeout_ns_action": integer1_schema
,
490 "primitive_params": {"type": "object"},
492 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
493 "additionalProperties": False,
496 ns_scale
= { # TODO for the moment it is only VDU-scaling
497 "title": "ns scale input schema",
498 "$schema": "http://json-schema.org/draft-04/schema#",
501 "lcmOperationType": string_schema
,
502 "nsInstanceId": id_schema
,
503 "scaleType": {"enum": ["SCALE_VNF"]},
504 "timeout_ns_scale": integer1_schema
,
508 "vnfInstanceId": name_schema
,
509 "scaleVnfType": {"enum": ["SCALE_OUT", "SCALE_IN"]},
513 "scaling-group-descriptor": name_schema
,
514 "member-vnf-index": name_schema
,
515 "scaling-policy": name_schema
,
517 "required": ["scaling-group-descriptor", "member-vnf-index"],
518 "additionalProperties": False,
521 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
522 "additionalProperties": False,
524 "scaleTime": time_schema
,
526 "required": ["scaleType", "scaleVnfData"],
527 "additionalProperties": False,
531 "title": "ns migrate input schema",
532 "$schema": "http://json-schema.org/draft-04/schema#",
535 "lcmOperationType": string_schema
,
536 "nsInstanceId": id_schema
,
537 "vnfInstanceId": id_schema
,
538 "migrateToHost": string_schema
,
542 "vduId": name_schema
,
543 "vduCountIndex": integer0_schema
,
545 "required": ["vduId"],
546 "additionalProperties": False,
549 "required": ["vnfInstanceId"],
550 "additionalProperties": False
554 "title": "ns heal input schema",
555 "$schema": "http://json-schema.org/draft-04/schema#",
558 "lcmOperationType": string_schema
,
559 "nsInstanceId": id_schema
,
560 "timeout_ns_heal": integer1_schema
,
566 "vnfInstanceId": id_schema
,
567 "cause": description_schema
,
568 "additionalParams": {
571 "run-day1": bool_schema
,
577 "run-day1": bool_schema
,
578 "vdu-id": name_schema
,
579 "count-index": integer0_schema
,
581 "required": ["vdu-id"],
582 "additionalProperties": False,
586 "additionalProperties": False,
589 "required": ["vnfInstanceId"],
590 "additionalProperties": False,
594 "required": ["healVnfData"],
595 "additionalProperties": False,
598 schema_version
= {"type": "string", "enum": ["1.0"]}
599 schema_type
= {"type": "string"}
600 vim_type
= shortname_schema
# {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
602 vim_account_edit_schema
= {
603 "title": "vim_account edit input schema",
604 "$schema": "http://json-schema.org/draft-04/schema#",
608 "description": description_schema
,
610 "datacenter": name_schema
,
611 "vim_type": vim_type
,
612 "vim_url": description_schema
,
613 # "vim_url_admin": description_schema,
614 # "vim_tenant": name_schema,
615 "vim_tenant_name": name_schema
,
616 "vim_user": string_schema
,
617 "vim_password": passwd_schema
,
619 "config": {"type": "object"},
620 "prometheus-config": {"type": "object"},
622 "additionalProperties": False,
625 vim_account_new_schema
= {
626 "title": "vim_account creation input schema",
627 "$schema": "http://json-schema.org/draft-04/schema#",
630 "schema_version": schema_version
,
631 "schema_type": schema_type
,
633 "description": description_schema
,
635 "datacenter": name_schema
,
636 "vim_type": vim_type
,
637 "vim_url": description_schema
,
638 # "vim_url_admin": description_schema,
639 # "vim_tenant": name_schema,
640 "vim_tenant_name": name_schema
,
641 "vim_user": string_schema
,
642 "vim_password": passwd_schema
,
644 "config": {"type": "object"},
645 "prometheus-config": {"type": "object"},
655 "additionalProperties": False,
658 wim_type
= shortname_schema
# {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
660 wim_account_edit_schema
= {
661 "title": "wim_account edit input schema",
662 "$schema": "http://json-schema.org/draft-04/schema#",
666 "description": description_schema
,
668 "wim_type": wim_type
,
669 "wim_url": description_schema
,
670 "user": string_schema
,
671 "password": passwd_schema
,
672 "config": {"type": "object"},
674 "additionalProperties": False,
677 wim_account_new_schema
= {
678 "title": "wim_account creation input schema",
679 "$schema": "http://json-schema.org/draft-04/schema#",
682 "schema_version": schema_version
,
683 "schema_type": schema_type
,
685 "description": description_schema
,
687 "wim_type": wim_type
,
688 "wim_url": description_schema
,
689 "user": string_schema
,
690 "password": passwd_schema
,
693 "patternProperties": {".": {"not": {"type": "null"}}},
696 "required": ["name", "wim_url", "wim_type"],
697 "additionalProperties": False,
702 "type": {"type": "string"},
703 "url": {"type": "string"},
704 "user": string_schema
,
705 "password": passwd_schema
,
706 "config": {"type": "object"},
707 "description": description_schema
,
708 # The folowing are deprecated. Maintanied for backward compatibility
712 "version": {"type": "string", "minLength": 1, "maxLength": 12},
715 "title": "sdn controller information schema",
716 "$schema": "http://json-schema.org/draft-04/schema#",
718 "properties": sdn_properties
,
719 "required": ["name", "type"],
720 "additionalProperties": False,
723 "title": "sdn controller update information schema",
724 "$schema": "http://json-schema.org/draft-04/schema#",
726 "properties": sdn_properties
,
727 # "required": ["name", "port", 'ip', 'dpid', 'type'],
728 "additionalProperties": False,
730 sdn_port_mapping_schema
= {
731 "$schema": "http://json-schema.org/draft-04/schema#",
732 "title": "sdn port mapping information schema",
737 "compute_node": shortname_schema
,
743 "pci": pci_extended_schema
,
744 "switch_port": shortname_schema
,
745 "switch_mac": mac_schema
,
751 "required": ["compute_node", "ports"],
754 sdn_external_port_schema
= {
755 "$schema": "http://json-schema.org/draft-04/schema#",
756 "title": "External port information",
759 "port": {"type": "string", "minLength": 1, "maxLength": 60},
763 "required": ["port"],
767 k8scluster_deploy_method_schema
= {
768 "$schema": "http://json-schema.org/draft-04/schema#",
769 "title": "Deployment methods for K8s cluster",
772 "helm-chart": {"type": "boolean"},
773 "juju-bundle": {"type": "boolean"},
774 "helm-chart-v3": {"type": "boolean"},
776 "additionalProperties": False,
779 k8scluster_nets_schema
= {
780 "title": "k8scluster nets input schema",
781 "$schema": "http://json-schema.org/draft-04/schema#",
783 "patternProperties": {".": {"oneOf": [name_schema
, null_schema
]}},
785 "additionalProperties": False,
787 k8scluster_new_schema
= {
788 "title": "k8scluster creation input schema",
789 "$schema": "http://json-schema.org/draft-04/schema#",
792 "schema_version": schema_version
,
793 "schema_type": schema_type
,
795 "description": description_schema
,
796 "credentials": object_schema
,
797 "vim_account": id_schema
,
799 "k8s_version": string_schema
,
800 "nets": k8scluster_nets_schema
,
801 "deployment_methods": k8scluster_deploy_method_schema
,
802 "namespace": name_schema
,
803 "cni": nameshort_list_schema
,
805 "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
806 "additionalProperties": False,
808 k8scluster_edit_schema
= {
809 "title": "vim_account edit input schema",
810 "$schema": "http://json-schema.org/draft-04/schema#",
814 "description": description_schema
,
815 "credentials": object_schema
,
816 "vim_account": id_schema
,
818 "k8s_version": string_schema
,
819 "nets": k8scluster_nets_schema
,
820 "namespace": name_schema
,
821 "cni": nameshort_list_schema
,
823 "additionalProperties": False,
828 "title": "vca creation input schema",
829 "$schema": "http://json-schema.org/draft-04/schema#",
832 "schema_version": schema_version
,
833 "schema_type": schema_type
,
835 "description": description_schema
,
836 "endpoints": description_list_schema
,
837 "user": string_schema
,
838 "secret": passwd_schema
,
839 "cacert": long_description_schema
,
840 "lxd-cloud": shortname_schema
,
841 "lxd-credentials": shortname_schema
,
842 "k8s-cloud": shortname_schema
,
843 "k8s-credentials": shortname_schema
,
844 "model-config": object_schema
,
857 "additionalProperties": False,
860 "title": "vca creation input schema",
861 "$schema": "http://json-schema.org/draft-04/schema#",
865 "description": description_schema
,
866 "endpoints": description_list_schema
,
867 "port": integer1_schema
,
868 "user": string_schema
,
869 "secret": passwd_schema
,
870 "cacert": long_description_schema
,
871 "lxd-cloud": shortname_schema
,
872 "lxd-credentials": shortname_schema
,
873 "k8s-cloud": shortname_schema
,
874 "k8s-credentials": shortname_schema
,
875 "model-config": object_schema
,
877 "additionalProperties": False,
881 k8srepo_types
= {"enum": ["helm-chart", "juju-bundle"]}
882 k8srepo_properties
= {
884 "description": description_schema
,
885 "type": k8srepo_types
,
886 "url": description_schema
,
888 k8srepo_new_schema
= {
889 "title": "k8scluster creation input schema",
890 "$schema": "http://json-schema.org/draft-04/schema#",
892 "properties": k8srepo_properties
,
893 "required": ["name", "type", "url"],
894 "additionalProperties": False,
896 k8srepo_edit_schema
= {
897 "title": "vim_account edit input schema",
898 "$schema": "http://json-schema.org/draft-04/schema#",
900 "properties": k8srepo_properties
,
901 "additionalProperties": False,
905 osmrepo_types
= {"enum": ["osm"]}
906 osmrepo_properties
= {
908 "description": description_schema
,
909 "type": osmrepo_types
,
910 "url": description_schema
911 # "user": string_schema,
912 # "password": passwd_schema
914 osmrepo_new_schema
= {
915 "title": "osm repo creation input schema",
916 "$schema": "http://json-schema.org/draft-04/schema#",
918 "properties": osmrepo_properties
,
919 "required": ["name", "type", "url"],
920 "additionalProperties": False,
922 osmrepo_edit_schema
= {
923 "title": "osm repo edit input schema",
924 "$schema": "http://json-schema.org/draft-04/schema#",
926 "properties": osmrepo_properties
,
927 "additionalProperties": False,
934 "name": shortname_schema
,
936 "type": {"enum": ["overlay", "underlay"]},
937 "ip-address": {"oneOf": [ip_schema
, ipv6_schema
]},
938 # TODO, add user, password, ssh-key
939 "mac-address": mac_schema
,
940 "vim-network-name": shortname_schema
, # interface is connected to one vim network, or switch port
941 "vim-network-id": shortname_schema
,
942 # # provide this in case SDN assist must deal with this interface
943 # "switch-dpid": dpid_Schema,
944 # "switch-port": shortname_schema,
945 # "switch-mac": shortname_schema,
946 # "switch-vlan": vlan_schema,
948 "required": ["name", "mgmt", "ip-address"],
949 "additionalProperties": False,
952 "title": "pdu creation input schema",
953 "$schema": "http://json-schema.org/draft-04/schema#",
956 "name": shortname_schema
,
957 "type": shortname_schema
,
958 "description": description_schema
,
959 "shared": bool_schema
,
960 "vims": nameshort_list_schema
,
961 "vim_accounts": nameshort_list_schema
,
962 "interfaces": {"type": "array", "items": pdu_interface
, "minItems": 1},
964 "required": ["name", "type", "interfaces"],
965 "additionalProperties": False,
968 "title": "pdu edit input schema",
969 "$schema": "http://json-schema.org/draft-04/schema#",
972 "name": shortname_schema
,
973 "type": shortname_schema
,
974 "description": description_schema
,
975 "shared": bool_schema
,
976 "vims": {"oneOf": [array_edition_schema
, nameshort_list_schema
]},
977 "vim_accounts": {"oneOf": [array_edition_schema
, nameshort_list_schema
]},
980 array_edition_schema
,
981 {"type": "array", "items": pdu_interface
, "minItems": 1},
985 "additionalProperties": False,
990 vnfpkgop_new_schema
= {
991 "title": "VNF PKG operation creation input schema",
992 "$schema": "http://json-schema.org/draft-04/schema#",
995 "lcmOperationType": string_schema
,
996 "vnfPkgId": id_schema
,
997 "kdu_name": name_schema
,
998 "primitive": name_schema
,
999 "primitive_params": {"type": "object"},
1008 "additionalProperties": False,
1012 project_role_mappings
= {
1013 "title": "list pf projects/roles",
1014 "$schema": "http://json-schema.org/draft-04/schema#",
1018 "properties": {"project": shortname_schema
, "role": shortname_schema
},
1019 "required": ["project", "role"],
1020 "additionalProperties": False,
1024 project_role_mappings_optional
= {
1025 "title": "list of projects/roles or projects only",
1026 "$schema": "http://json-schema.org/draft-04/schema#",
1030 "properties": {"project": shortname_schema
, "role": shortname_schema
},
1031 "required": ["project"],
1032 "additionalProperties": False,
1037 "$schema": "http://json-schema.org/draft-04/schema#",
1038 "title": "New user schema",
1041 "username": string_schema
,
1042 "domain_name": shortname_schema
,
1043 "password": passwd_schema
,
1044 "projects": nameshort_list_schema
,
1045 "project_role_mappings": project_role_mappings
,
1047 "required": ["username", "password"],
1048 "additionalProperties": False,
1050 user_edit_schema
= {
1051 "$schema": "http://json-schema.org/draft-04/schema#",
1052 "title": "User edit schema for administrators",
1055 "password": passwd_schema
,
1056 "old_password": passwd_schema
,
1057 "username": string_schema
, # To allow User Name modification
1058 "projects": {"oneOf": [nameshort_list_schema
, array_edition_schema
]},
1059 "project_role_mappings": project_role_mappings
,
1060 "add_project_role_mappings": project_role_mappings
,
1061 "remove_project_role_mappings": project_role_mappings_optional
,
1064 "additionalProperties": False,
1068 topics_with_quota
= [
1084 project_new_schema
= {
1085 "$schema": "http://json-schema.org/draft-04/schema#",
1086 "title": "New project schema for administrators",
1089 "name": shortname_schema
,
1090 "admin": bool_schema
,
1091 "domain_name": shortname_schema
,
1094 "properties": {topic
: integer0_schema
for topic
in topics_with_quota
},
1095 "additionalProperties": False,
1098 "required": ["name"],
1099 "additionalProperties": False,
1101 project_edit_schema
= {
1102 "$schema": "http://json-schema.org/draft-04/schema#",
1103 "title": "Project edit schema for administrators",
1106 "admin": bool_schema
,
1107 "name": shortname_schema
, # To allow Project Name modification
1111 topic
: {"oneOf": [integer0_schema
, null_schema
]}
1112 for topic
in topics_with_quota
1114 "additionalProperties": False,
1117 "additionalProperties": False,
1122 roles_new_schema
= {
1123 "$schema": "http://json-schema.org/draft-04/schema#",
1124 "title": "New role schema for administrators",
1127 "name": shortname_schema
,
1130 "patternProperties": {
1133 # "minProperties": 1,
1136 "required": ["name"],
1137 "additionalProperties": False,
1139 roles_edit_schema
= {
1140 "$schema": "http://json-schema.org/draft-04/schema#",
1141 "title": "Roles edit schema for administrators",
1144 "name": shortname_schema
,
1147 "patternProperties": {".": {"oneOf": [bool_schema
, null_schema
]}},
1148 # "minProperties": 1,
1151 "additionalProperties": False,
1157 nbi_new_input_schemas
= {
1158 "users": user_new_schema
,
1159 "projects": project_new_schema
,
1160 "vim_accounts": vim_account_new_schema
,
1161 "sdns": sdn_new_schema
,
1162 "ns_instantiate": ns_instantiate
,
1163 "ns_action": ns_action
,
1164 "ns_scale": ns_scale
,
1165 "ns_update": ns_update
,
1167 "pdus": pdu_new_schema
,
1170 nbi_edit_input_schemas
= {
1171 "users": user_edit_schema
,
1172 "projects": project_edit_schema
,
1173 "vim_accounts": vim_account_edit_schema
,
1174 "sdns": sdn_edit_schema
,
1175 "pdus": pdu_edit_schema
,
1179 nsi_subnet_instantiate
= deepcopy(ns_instantiate
)
1180 nsi_subnet_instantiate
["title"] = "netslice subnet instantiation params input schema"
1181 nsi_subnet_instantiate
["properties"]["id"] = name_schema
1182 del nsi_subnet_instantiate
["required"]
1184 nsi_vld_instantiate
= {
1185 "title": "netslice vld instantiation params input schema",
1186 "$schema": "http://json-schema.org/draft-04/schema#",
1189 "name": string_schema
,
1190 "vim-network-name": {"oneOf": [string_schema
, object_schema
]},
1191 "vim-network-id": {"oneOf": [string_schema
, object_schema
]},
1192 "ip-profile": object_schema
,
1194 "required": ["name"],
1195 "additionalProperties": False,
1199 "title": "netslice action instantiate input schema",
1200 "$schema": "http://json-schema.org/draft-04/schema#",
1203 "lcmOperationType": string_schema
,
1204 "netsliceInstanceId": id_schema
,
1205 "nsiName": name_schema
,
1206 "nsiDescription": {"oneOf": [description_schema
, null_schema
]},
1207 "nstId": string_schema
,
1208 "vimAccountId": id_schema
,
1209 "timeout_nsi_deploy": integer1_schema
,
1210 "ssh_keys": {"type": "array", "items": {"type": "string"}},
1211 "nsi_id": id_schema
,
1212 "additionalParamsForNsi": object_schema
,
1213 "netslice-subnet": {
1216 "items": nsi_subnet_instantiate
,
1218 "netslice-vld": {"type": "array", "minItems": 1, "items": nsi_vld_instantiate
},
1220 "required": ["nsiName", "nstId", "vimAccountId"],
1221 "additionalProperties": False,
1228 nsinstancesubscriptionfilter_schema
= {
1229 "title": "instance identifier schema",
1230 "$schema": "http://json-schema.org/draft-07/schema#",
1233 "nsdIds": {"type": "array"},
1234 "vnfdIds": {"type": "array"},
1235 "pnfdIds": {"type": "array"},
1236 "nsInstanceIds": {"type": "array"},
1237 "nsInstanceNames": {"type": "array"},
1242 "title": "nslcmsubscription input schema",
1243 "$schema": "http://json-schema.org/draft-07/schema#",
1246 "nsInstanceSubscriptionFilter": nsinstancesubscriptionfilter_schema
,
1247 "notificationTypes": {
1251 "NsLcmOperationOccurrenceNotification",
1252 "NsChangeNotification",
1253 "NsIdentifierCreationNotification",
1254 "NsIdentifierDeletionNotification",
1260 "items": {"enum": ["INSTANTIATE", "SCALE", "TERMINATE", "UPDATE", "HEAL"]},
1262 "operationStates": {
1268 "PARTIALLY_COMPLETED",
1276 "nsComponentTypes": {"type": "array", "items": {"enum": ["VNF", "NS", "PNF"]}},
1277 "lcmOpNameImpactingNsComponent": {
1283 "VNF_SCALE_TO_LEVEL",
1284 "VNF_CHANGE_FLAVOUR",
1288 "VNF_CHANGE_EXT_CONN",
1298 "lcmOpOccStatusImpactingNsComponent": {
1304 "PARTIALLY_COMPLETED",
1315 "notificationTypes": {
1316 "contains": {"const": "NsLcmOperationOccurrenceNotification"}
1322 {"required": ["operationTypes"]},
1323 {"required": ["operationStates"]},
1330 "notificationTypes": {"contains": {"const": "NsChangeNotification"}}
1335 {"required": ["nsComponentTypes"]},
1336 {"required": ["lcmOpNameImpactingNsComponent"]},
1337 {"required": ["lcmOpOccStatusImpactingNsComponent"]},
1344 authentication_schema
= {
1345 "title": "authentication schema for subscription",
1346 "$schema": "http://json-schema.org/draft-07/schema#",
1349 "authType": {"enum": ["basic"]},
1353 "userName": string_schema
,
1354 "password": passwd_schema
,
1361 "title": "subscription input schema",
1362 "$schema": "http://json-schema.org/draft-07/schema#",
1365 "filter": nslcmsub_schema
,
1366 "CallbackUri": description_schema
,
1367 "authentication": authentication_schema
,
1369 "required": ["CallbackUri"],
1372 vnflcmsub_schema
= {
1373 "title": "vnflcmsubscription input schema",
1374 "$schema": "http://json-schema.org/draft-07/schema#",
1377 "VnfInstanceSubscriptionFilter": {
1380 "vnfdIds": {"type": "array"},
1381 "vnfInstanceIds": {"type": "array"},
1384 "notificationTypes": {
1388 "VnfIdentifierCreationNotification",
1389 "VnfLcmOperationOccurrenceNotification",
1390 "VnfIdentifierDeletionNotification"
1398 "INSTANTIATE", "SCALE", "SCALE_TO_LEVEL", "CHANGE_FLAVOUR", "TERMINATE",
1399 "HEAL", "OPERATE", "CHANGE_EXT_CONN", "MODIFY_INFO", "CREATE_SNAPSHOT",
1400 "REVERT_TO_SNAPSHOT", "CHANGE_VNFPKG"
1404 "operationStates": {
1408 "STARTING", "PROCESSING", "COMPLETED", "FAILED_TEMP", "FAILED",
1409 "ROLLING_BACK", "ROLLED_BACK"
1414 "required": ["VnfInstanceSubscriptionFilter", "notificationTypes"]
1417 vnf_subscription
= {
1418 "title": "vnf subscription input schema",
1419 "$schema": "http://json-schema.org/draft-07/schema#",
1422 "filter": vnflcmsub_schema
,
1423 "CallbackUri": description_schema
,
1424 "authentication": authentication_schema
1426 "required": ["filter", "CallbackUri"]
1430 class ValidationError(Exception):
1431 def __init__(self
, message
, http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
):
1432 self
.http_code
= http_code
1433 Exception.__init
__(self
, message
)
1436 def validate_input(indata
, schema_to_use
):
1438 Validates input data against json schema
1439 :param indata: user input data. Should be a dictionary
1440 :param schema_to_use: jsonschema to test
1441 :return: None if ok, raises ValidationError exception on error
1445 js_v(indata
, schema_to_use
)
1447 except js_e
.ValidationError
as e
:
1449 error_pos
= "at '" + ":".join(map(str, e
.path
)) + "'"
1452 raise ValidationError("Format error {} '{}' ".format(error_pos
, e
.message
))
1453 except js_e
.SchemaError
:
1454 raise ValidationError(
1455 "Bad json schema {}".format(schema_to_use
),
1456 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
,
1460 def is_valid_uuid(x
):
1462 Test for a valid UUID
1463 :param x: string to test
1464 :return: True if x is a valid uuid, False otherwise
1469 except (TypeError, ValueError, AttributeError):