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", "OPERATE_VNF"]
454 "modifyVnfInfoData": {
457 "vnfInstanceId": id_schema
,
460 "required": ["vnfInstanceId", "vnfdId"],
462 "removeVnfInstanceId": id_schema
,
463 "changeVnfPackageData": {
466 "vnfInstanceId": id_schema
,
469 "required": ["vnfInstanceId", "vnfdId"],
474 "vnfInstanceId": id_schema
,
475 "changeStateTo": name_schema
,
479 "run-day1": bool_schema
,
480 "vdu_id": name_schema
,
481 "count-index": integer0_schema
,
483 "required": ["vdu_id", "count-index"],
484 "additionalProperties": False,
487 "required": ["vnfInstanceId", "changeStateTo"],
490 "required": ["updateType"],
491 "additionalProperties": False,
494 ns_action
= { # TODO for the moment it is only contemplated the vnfd primitive execution
495 "title": "ns action input schema",
496 "$schema": "http://json-schema.org/draft-04/schema#",
499 "lcmOperationType": string_schema
,
500 "nsInstanceId": id_schema
,
501 "member_vnf_index": name_schema
,
502 "vnf_member_index": name_schema
, # TODO for backward compatibility. To remove in future
503 "vdu_id": name_schema
,
504 "vdu_count_index": integer0_schema
,
505 "kdu_name": name_schema
,
506 "primitive": name_schema
,
507 "timeout_ns_action": integer1_schema
,
508 "primitive_params": {"type": "object"},
510 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
511 "additionalProperties": False,
514 ns_scale
= { # TODO for the moment it is only VDU-scaling
515 "title": "ns scale input schema",
516 "$schema": "http://json-schema.org/draft-04/schema#",
519 "lcmOperationType": string_schema
,
520 "nsInstanceId": id_schema
,
521 "scaleType": {"enum": ["SCALE_VNF"]},
522 "timeout_ns_scale": integer1_schema
,
526 "vnfInstanceId": name_schema
,
527 "scaleVnfType": {"enum": ["SCALE_OUT", "SCALE_IN"]},
531 "scaling-group-descriptor": name_schema
,
532 "member-vnf-index": name_schema
,
533 "scaling-policy": name_schema
,
535 "required": ["scaling-group-descriptor", "member-vnf-index"],
536 "additionalProperties": False,
539 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
540 "additionalProperties": False,
542 "scaleTime": time_schema
,
544 "required": ["scaleType", "scaleVnfData"],
545 "additionalProperties": False,
549 "title": "ns migrate input schema",
550 "$schema": "http://json-schema.org/draft-04/schema#",
553 "lcmOperationType": string_schema
,
554 "nsInstanceId": id_schema
,
555 "vnfInstanceId": id_schema
,
556 "migrateToHost": string_schema
,
560 "vduId": name_schema
,
561 "vduCountIndex": integer0_schema
,
563 "required": ["vduId"],
564 "additionalProperties": False,
567 "required": ["vnfInstanceId"],
568 "additionalProperties": False
572 "title": "ns heal input schema",
573 "$schema": "http://json-schema.org/draft-04/schema#",
576 "lcmOperationType": string_schema
,
577 "nsInstanceId": id_schema
,
578 "timeout_ns_heal": integer1_schema
,
584 "vnfInstanceId": id_schema
,
585 "cause": description_schema
,
586 "additionalParams": {
589 "run-day1": bool_schema
,
595 "run-day1": bool_schema
,
596 "vdu-id": name_schema
,
597 "count-index": integer0_schema
,
599 "required": ["vdu-id"],
600 "additionalProperties": False,
604 "additionalProperties": False,
607 "required": ["vnfInstanceId"],
608 "additionalProperties": False,
612 "required": ["healVnfData"],
613 "additionalProperties": False,
617 "title": "vertial scale input schema",
618 "$schema": "http://json-schema.org/draft-04/schema#",
621 "lcmOperationType": string_schema
,
622 "nsInstanceId": id_schema
,
623 "vnfInstanceId": id_schema
,
624 "migrateToHost": string_schema
,
628 "vduId": name_schema
,
629 "vduCountIndex": integer0_schema
,
631 "required": ["vduId"],
632 "additionalProperties": False,
635 "required": ["vnfInstanceId"],
636 "additionalProperties": False
639 schema_version
= {"type": "string", "enum": ["1.0"]}
640 schema_type
= {"type": "string"}
641 vim_type
= shortname_schema
# {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
643 vim_account_edit_schema
= {
644 "title": "vim_account edit input schema",
645 "$schema": "http://json-schema.org/draft-04/schema#",
649 "description": description_schema
,
651 "datacenter": name_schema
,
652 "vim_type": vim_type
,
653 "vim_url": description_schema
,
654 # "vim_url_admin": description_schema,
655 # "vim_tenant": name_schema,
656 "vim_tenant_name": name_schema
,
657 "vim_user": string_schema
,
658 "vim_password": passwd_schema
,
660 "config": {"type": "object"},
661 "prometheus-config": {"type": "object"},
663 "additionalProperties": False,
666 vim_account_new_schema
= {
667 "title": "vim_account creation input schema",
668 "$schema": "http://json-schema.org/draft-04/schema#",
671 "schema_version": schema_version
,
672 "schema_type": schema_type
,
674 "description": description_schema
,
676 "datacenter": name_schema
,
677 "vim_type": vim_type
,
678 "vim_url": description_schema
,
679 # "vim_url_admin": description_schema,
680 # "vim_tenant": name_schema,
681 "vim_tenant_name": name_schema
,
682 "vim_user": string_schema
,
683 "vim_password": passwd_schema
,
685 "config": {"type": "object"},
686 "prometheus-config": {"type": "object"},
696 "additionalProperties": False,
699 wim_type
= shortname_schema
# {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
701 wim_account_edit_schema
= {
702 "title": "wim_account edit input schema",
703 "$schema": "http://json-schema.org/draft-04/schema#",
707 "description": description_schema
,
709 "wim_type": wim_type
,
710 "wim_url": description_schema
,
711 "user": string_schema
,
712 "password": passwd_schema
,
713 "config": {"type": "object"},
715 "additionalProperties": False,
718 wim_account_new_schema
= {
719 "title": "wim_account creation input schema",
720 "$schema": "http://json-schema.org/draft-04/schema#",
723 "schema_version": schema_version
,
724 "schema_type": schema_type
,
726 "description": description_schema
,
728 "wim_type": wim_type
,
729 "wim_url": description_schema
,
730 "user": string_schema
,
731 "password": passwd_schema
,
734 "patternProperties": {".": {"not": {"type": "null"}}},
737 "required": ["name", "wim_url", "wim_type"],
738 "additionalProperties": False,
743 "type": {"type": "string"},
744 "url": {"type": "string"},
745 "user": string_schema
,
746 "password": passwd_schema
,
747 "config": {"type": "object"},
748 "description": description_schema
,
749 # The folowing are deprecated. Maintanied for backward compatibility
753 "version": {"type": "string", "minLength": 1, "maxLength": 12},
756 "title": "sdn controller information schema",
757 "$schema": "http://json-schema.org/draft-04/schema#",
759 "properties": sdn_properties
,
760 "required": ["name", "type"],
761 "additionalProperties": False,
764 "title": "sdn controller update information schema",
765 "$schema": "http://json-schema.org/draft-04/schema#",
767 "properties": sdn_properties
,
768 # "required": ["name", "port", 'ip', 'dpid', 'type'],
769 "additionalProperties": False,
771 sdn_port_mapping_schema
= {
772 "$schema": "http://json-schema.org/draft-04/schema#",
773 "title": "sdn port mapping information schema",
778 "compute_node": shortname_schema
,
784 "pci": pci_extended_schema
,
785 "switch_port": shortname_schema
,
786 "switch_mac": mac_schema
,
792 "required": ["compute_node", "ports"],
795 sdn_external_port_schema
= {
796 "$schema": "http://json-schema.org/draft-04/schema#",
797 "title": "External port information",
800 "port": {"type": "string", "minLength": 1, "maxLength": 60},
804 "required": ["port"],
808 k8scluster_deploy_method_schema
= {
809 "$schema": "http://json-schema.org/draft-04/schema#",
810 "title": "Deployment methods for K8s cluster",
813 "helm-chart": {"type": "boolean"},
814 "juju-bundle": {"type": "boolean"},
815 "helm-chart-v3": {"type": "boolean"},
817 "additionalProperties": False,
820 k8scluster_nets_schema
= {
821 "title": "k8scluster nets input schema",
822 "$schema": "http://json-schema.org/draft-04/schema#",
824 "patternProperties": {".": {"oneOf": [name_schema
, null_schema
]}},
826 "additionalProperties": False,
828 k8scluster_new_schema
= {
829 "title": "k8scluster creation input schema",
830 "$schema": "http://json-schema.org/draft-04/schema#",
833 "schema_version": schema_version
,
834 "schema_type": schema_type
,
836 "description": description_schema
,
837 "credentials": object_schema
,
838 "vim_account": id_schema
,
840 "k8s_version": string_schema
,
841 "nets": k8scluster_nets_schema
,
842 "deployment_methods": k8scluster_deploy_method_schema
,
843 "namespace": name_schema
,
844 "cni": nameshort_list_schema
,
846 "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
847 "additionalProperties": False,
849 k8scluster_edit_schema
= {
850 "title": "vim_account edit input schema",
851 "$schema": "http://json-schema.org/draft-04/schema#",
855 "description": description_schema
,
856 "credentials": object_schema
,
857 "vim_account": id_schema
,
859 "k8s_version": string_schema
,
860 "nets": k8scluster_nets_schema
,
861 "namespace": name_schema
,
862 "cni": nameshort_list_schema
,
864 "additionalProperties": False,
869 "title": "vca creation input schema",
870 "$schema": "http://json-schema.org/draft-04/schema#",
873 "schema_version": schema_version
,
874 "schema_type": schema_type
,
876 "description": description_schema
,
877 "endpoints": description_list_schema
,
878 "user": string_schema
,
879 "secret": passwd_schema
,
880 "cacert": long_description_schema
,
881 "lxd-cloud": shortname_schema
,
882 "lxd-credentials": shortname_schema
,
883 "k8s-cloud": shortname_schema
,
884 "k8s-credentials": shortname_schema
,
885 "model-config": object_schema
,
898 "additionalProperties": False,
901 "title": "vca creation input schema",
902 "$schema": "http://json-schema.org/draft-04/schema#",
906 "description": description_schema
,
907 "endpoints": description_list_schema
,
908 "port": integer1_schema
,
909 "user": string_schema
,
910 "secret": passwd_schema
,
911 "cacert": long_description_schema
,
912 "lxd-cloud": shortname_schema
,
913 "lxd-credentials": shortname_schema
,
914 "k8s-cloud": shortname_schema
,
915 "k8s-credentials": shortname_schema
,
916 "model-config": object_schema
,
918 "additionalProperties": False,
922 k8srepo_types
= {"enum": ["helm-chart", "juju-bundle"]}
923 k8srepo_properties
= {
925 "description": description_schema
,
926 "type": k8srepo_types
,
927 "url": description_schema
,
929 k8srepo_new_schema
= {
930 "title": "k8scluster creation input schema",
931 "$schema": "http://json-schema.org/draft-04/schema#",
933 "properties": k8srepo_properties
,
934 "required": ["name", "type", "url"],
935 "additionalProperties": False,
937 k8srepo_edit_schema
= {
938 "title": "vim_account edit input schema",
939 "$schema": "http://json-schema.org/draft-04/schema#",
941 "properties": k8srepo_properties
,
942 "additionalProperties": False,
946 osmrepo_types
= {"enum": ["osm"]}
947 osmrepo_properties
= {
949 "description": description_schema
,
950 "type": osmrepo_types
,
951 "url": description_schema
952 # "user": string_schema,
953 # "password": passwd_schema
955 osmrepo_new_schema
= {
956 "title": "osm repo creation input schema",
957 "$schema": "http://json-schema.org/draft-04/schema#",
959 "properties": osmrepo_properties
,
960 "required": ["name", "type", "url"],
961 "additionalProperties": False,
963 osmrepo_edit_schema
= {
964 "title": "osm repo edit input schema",
965 "$schema": "http://json-schema.org/draft-04/schema#",
967 "properties": osmrepo_properties
,
968 "additionalProperties": False,
975 "name": shortname_schema
,
977 "type": {"enum": ["overlay", "underlay"]},
978 "ip-address": {"oneOf": [ip_schema
, ipv6_schema
]},
979 # TODO, add user, password, ssh-key
980 "mac-address": mac_schema
,
981 "vim-network-name": shortname_schema
, # interface is connected to one vim network, or switch port
982 "vim-network-id": shortname_schema
,
983 # # provide this in case SDN assist must deal with this interface
984 # "switch-dpid": dpid_Schema,
985 # "switch-port": shortname_schema,
986 # "switch-mac": shortname_schema,
987 # "switch-vlan": vlan_schema,
989 "required": ["name", "mgmt", "ip-address"],
990 "additionalProperties": False,
993 "title": "pdu creation input schema",
994 "$schema": "http://json-schema.org/draft-04/schema#",
997 "name": shortname_schema
,
998 "type": shortname_schema
,
999 "description": description_schema
,
1000 "shared": bool_schema
,
1001 "vims": nameshort_list_schema
,
1002 "vim_accounts": nameshort_list_schema
,
1003 "interfaces": {"type": "array", "items": pdu_interface
, "minItems": 1},
1005 "required": ["name", "type", "interfaces"],
1006 "additionalProperties": False,
1009 "title": "pdu edit input schema",
1010 "$schema": "http://json-schema.org/draft-04/schema#",
1013 "name": shortname_schema
,
1014 "type": shortname_schema
,
1015 "description": description_schema
,
1016 "shared": bool_schema
,
1017 "vims": {"oneOf": [array_edition_schema
, nameshort_list_schema
]},
1018 "vim_accounts": {"oneOf": [array_edition_schema
, nameshort_list_schema
]},
1021 array_edition_schema
,
1022 {"type": "array", "items": pdu_interface
, "minItems": 1},
1026 "additionalProperties": False,
1030 # VNF PKG OPERATIONS
1031 vnfpkgop_new_schema
= {
1032 "title": "VNF PKG operation creation input schema",
1033 "$schema": "http://json-schema.org/draft-04/schema#",
1036 "lcmOperationType": string_schema
,
1037 "vnfPkgId": id_schema
,
1038 "kdu_name": name_schema
,
1039 "primitive": name_schema
,
1040 "primitive_params": {"type": "object"},
1049 "additionalProperties": False,
1053 project_role_mappings
= {
1054 "title": "list pf projects/roles",
1055 "$schema": "http://json-schema.org/draft-04/schema#",
1059 "properties": {"project": shortname_schema
, "role": shortname_schema
},
1060 "required": ["project", "role"],
1061 "additionalProperties": False,
1065 project_role_mappings_optional
= {
1066 "title": "list of projects/roles or projects only",
1067 "$schema": "http://json-schema.org/draft-04/schema#",
1071 "properties": {"project": shortname_schema
, "role": shortname_schema
},
1072 "required": ["project"],
1073 "additionalProperties": False,
1078 "$schema": "http://json-schema.org/draft-04/schema#",
1079 "title": "New user schema",
1082 "username": string_schema
,
1083 "domain_name": shortname_schema
,
1084 "password": passwd_schema
,
1085 "projects": nameshort_list_schema
,
1086 "project_role_mappings": project_role_mappings
,
1088 "required": ["username", "password"],
1089 "additionalProperties": False,
1091 user_edit_schema
= {
1092 "$schema": "http://json-schema.org/draft-04/schema#",
1093 "title": "User edit schema for administrators",
1096 "password": passwd_schema
,
1097 "old_password": passwd_schema
,
1098 "username": string_schema
, # To allow User Name modification
1099 "projects": {"oneOf": [nameshort_list_schema
, array_edition_schema
]},
1100 "project_role_mappings": project_role_mappings
,
1101 "add_project_role_mappings": project_role_mappings
,
1102 "remove_project_role_mappings": project_role_mappings_optional
,
1105 "additionalProperties": False,
1109 topics_with_quota
= [
1125 project_new_schema
= {
1126 "$schema": "http://json-schema.org/draft-04/schema#",
1127 "title": "New project schema for administrators",
1130 "name": shortname_schema
,
1131 "admin": bool_schema
,
1132 "domain_name": shortname_schema
,
1135 "properties": {topic
: integer0_schema
for topic
in topics_with_quota
},
1136 "additionalProperties": False,
1139 "required": ["name"],
1140 "additionalProperties": False,
1142 project_edit_schema
= {
1143 "$schema": "http://json-schema.org/draft-04/schema#",
1144 "title": "Project edit schema for administrators",
1147 "admin": bool_schema
,
1148 "name": shortname_schema
, # To allow Project Name modification
1152 topic
: {"oneOf": [integer0_schema
, null_schema
]}
1153 for topic
in topics_with_quota
1155 "additionalProperties": False,
1158 "additionalProperties": False,
1163 roles_new_schema
= {
1164 "$schema": "http://json-schema.org/draft-04/schema#",
1165 "title": "New role schema for administrators",
1168 "name": shortname_schema
,
1171 "patternProperties": {
1174 # "minProperties": 1,
1177 "required": ["name"],
1178 "additionalProperties": False,
1180 roles_edit_schema
= {
1181 "$schema": "http://json-schema.org/draft-04/schema#",
1182 "title": "Roles edit schema for administrators",
1185 "name": shortname_schema
,
1188 "patternProperties": {".": {"oneOf": [bool_schema
, null_schema
]}},
1189 # "minProperties": 1,
1192 "additionalProperties": False,
1198 nbi_new_input_schemas
= {
1199 "users": user_new_schema
,
1200 "projects": project_new_schema
,
1201 "vim_accounts": vim_account_new_schema
,
1202 "sdns": sdn_new_schema
,
1203 "ns_instantiate": ns_instantiate
,
1204 "ns_action": ns_action
,
1205 "ns_scale": ns_scale
,
1206 "ns_update": ns_update
,
1208 "pdus": pdu_new_schema
,
1211 nbi_edit_input_schemas
= {
1212 "users": user_edit_schema
,
1213 "projects": project_edit_schema
,
1214 "vim_accounts": vim_account_edit_schema
,
1215 "sdns": sdn_edit_schema
,
1216 "pdus": pdu_edit_schema
,
1220 nsi_subnet_instantiate
= deepcopy(ns_instantiate
)
1221 nsi_subnet_instantiate
["title"] = "netslice subnet instantiation params input schema"
1222 nsi_subnet_instantiate
["properties"]["id"] = name_schema
1223 del nsi_subnet_instantiate
["required"]
1225 nsi_vld_instantiate
= {
1226 "title": "netslice vld instantiation params input schema",
1227 "$schema": "http://json-schema.org/draft-04/schema#",
1230 "name": string_schema
,
1231 "vim-network-name": {"oneOf": [string_schema
, object_schema
]},
1232 "vim-network-id": {"oneOf": [string_schema
, object_schema
]},
1233 "ip-profile": object_schema
,
1235 "required": ["name"],
1236 "additionalProperties": False,
1240 "title": "netslice action instantiate input schema",
1241 "$schema": "http://json-schema.org/draft-04/schema#",
1244 "lcmOperationType": string_schema
,
1245 "netsliceInstanceId": id_schema
,
1246 "nsiName": name_schema
,
1247 "nsiDescription": {"oneOf": [description_schema
, null_schema
]},
1248 "nstId": string_schema
,
1249 "vimAccountId": id_schema
,
1250 "timeout_nsi_deploy": integer1_schema
,
1251 "ssh_keys": {"type": "array", "items": {"type": "string"}},
1252 "nsi_id": id_schema
,
1253 "additionalParamsForNsi": object_schema
,
1254 "netslice-subnet": {
1257 "items": nsi_subnet_instantiate
,
1259 "netslice-vld": {"type": "array", "minItems": 1, "items": nsi_vld_instantiate
},
1261 "required": ["nsiName", "nstId", "vimAccountId"],
1262 "additionalProperties": False,
1269 nsinstancesubscriptionfilter_schema
= {
1270 "title": "instance identifier schema",
1271 "$schema": "http://json-schema.org/draft-07/schema#",
1274 "nsdIds": {"type": "array"},
1275 "vnfdIds": {"type": "array"},
1276 "pnfdIds": {"type": "array"},
1277 "nsInstanceIds": {"type": "array"},
1278 "nsInstanceNames": {"type": "array"},
1283 "title": "nslcmsubscription input schema",
1284 "$schema": "http://json-schema.org/draft-07/schema#",
1287 "nsInstanceSubscriptionFilter": nsinstancesubscriptionfilter_schema
,
1288 "notificationTypes": {
1292 "NsLcmOperationOccurrenceNotification",
1293 "NsChangeNotification",
1294 "NsIdentifierCreationNotification",
1295 "NsIdentifierDeletionNotification",
1301 "items": {"enum": ["INSTANTIATE", "SCALE", "TERMINATE", "UPDATE", "HEAL"]},
1303 "operationStates": {
1309 "PARTIALLY_COMPLETED",
1317 "nsComponentTypes": {"type": "array", "items": {"enum": ["VNF", "NS", "PNF"]}},
1318 "lcmOpNameImpactingNsComponent": {
1324 "VNF_SCALE_TO_LEVEL",
1325 "VNF_CHANGE_FLAVOUR",
1329 "VNF_CHANGE_EXT_CONN",
1339 "lcmOpOccStatusImpactingNsComponent": {
1345 "PARTIALLY_COMPLETED",
1356 "notificationTypes": {
1357 "contains": {"const": "NsLcmOperationOccurrenceNotification"}
1363 {"required": ["operationTypes"]},
1364 {"required": ["operationStates"]},
1371 "notificationTypes": {"contains": {"const": "NsChangeNotification"}}
1376 {"required": ["nsComponentTypes"]},
1377 {"required": ["lcmOpNameImpactingNsComponent"]},
1378 {"required": ["lcmOpOccStatusImpactingNsComponent"]},
1385 authentication_schema
= {
1386 "title": "authentication schema for subscription",
1387 "$schema": "http://json-schema.org/draft-07/schema#",
1390 "authType": {"enum": ["basic"]},
1394 "userName": string_schema
,
1395 "password": passwd_schema
,
1402 "title": "subscription input schema",
1403 "$schema": "http://json-schema.org/draft-07/schema#",
1406 "filter": nslcmsub_schema
,
1407 "CallbackUri": description_schema
,
1408 "authentication": authentication_schema
,
1410 "required": ["CallbackUri"],
1413 vnflcmsub_schema
= {
1414 "title": "vnflcmsubscription input schema",
1415 "$schema": "http://json-schema.org/draft-07/schema#",
1418 "VnfInstanceSubscriptionFilter": {
1421 "vnfdIds": {"type": "array"},
1422 "vnfInstanceIds": {"type": "array"},
1425 "notificationTypes": {
1429 "VnfIdentifierCreationNotification",
1430 "VnfLcmOperationOccurrenceNotification",
1431 "VnfIdentifierDeletionNotification"
1439 "INSTANTIATE", "SCALE", "SCALE_TO_LEVEL", "CHANGE_FLAVOUR", "TERMINATE",
1440 "HEAL", "OPERATE", "CHANGE_EXT_CONN", "MODIFY_INFO", "CREATE_SNAPSHOT",
1441 "REVERT_TO_SNAPSHOT", "CHANGE_VNFPKG"
1445 "operationStates": {
1449 "STARTING", "PROCESSING", "COMPLETED", "FAILED_TEMP", "FAILED",
1450 "ROLLING_BACK", "ROLLED_BACK"
1455 "required": ["VnfInstanceSubscriptionFilter", "notificationTypes"]
1458 vnf_subscription
= {
1459 "title": "vnf subscription input schema",
1460 "$schema": "http://json-schema.org/draft-07/schema#",
1463 "filter": vnflcmsub_schema
,
1464 "CallbackUri": description_schema
,
1465 "authentication": authentication_schema
1467 "required": ["filter", "CallbackUri"]
1471 class ValidationError(Exception):
1472 def __init__(self
, message
, http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
):
1473 self
.http_code
= http_code
1474 Exception.__init
__(self
, message
)
1477 def validate_input(indata
, schema_to_use
):
1479 Validates input data against json schema
1480 :param indata: user input data. Should be a dictionary
1481 :param schema_to_use: jsonschema to test
1482 :return: None if ok, raises ValidationError exception on error
1486 js_v(indata
, schema_to_use
)
1488 except js_e
.ValidationError
as e
:
1490 error_pos
= "at '" + ":".join(map(str, e
.path
)) + "'"
1493 raise ValidationError("Format error {} '{}' ".format(error_pos
, e
.message
))
1494 except js_e
.SchemaError
:
1495 raise ValidationError(
1496 "Bad json schema {}".format(schema_to_use
),
1497 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
,
1501 def is_valid_uuid(x
):
1503 Test for a valid UUID
1504 :param x: string to test
1505 :return: True if x is a valid uuid, False otherwise
1510 except (TypeError, ValueError, AttributeError):