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
,
455 "MODIFY_VNF_INFORMATION",
459 "modifyVnfInfoData": {
462 "vnfInstanceId": id_schema
,
465 "required": ["vnfInstanceId", "vnfdId"],
467 "removeVnfInstanceId": id_schema
,
468 "changeVnfPackageData": {
471 "vnfInstanceId": id_schema
,
474 "required": ["vnfInstanceId", "vnfdId"],
479 "vnfInstanceId": id_schema
,
480 "changeStateTo": name_schema
,
484 "run-day1": bool_schema
,
485 "vdu_id": name_schema
,
486 "count-index": integer0_schema
,
488 "required": ["vdu_id", "count-index"],
489 "additionalProperties": False,
492 "required": ["vnfInstanceId", "changeStateTo"],
495 "required": ["updateType"],
496 "additionalProperties": False,
499 ns_action
= { # TODO for the moment it is only contemplated the vnfd primitive execution
500 "title": "ns action input schema",
501 "$schema": "http://json-schema.org/draft-04/schema#",
504 "lcmOperationType": string_schema
,
505 "nsInstanceId": id_schema
,
506 "member_vnf_index": name_schema
,
507 "vnf_member_index": name_schema
, # TODO for backward compatibility. To remove in future
508 "vdu_id": name_schema
,
509 "vdu_count_index": integer0_schema
,
510 "kdu_name": name_schema
,
511 "primitive": name_schema
,
512 "timeout_ns_action": integer1_schema
,
513 "primitive_params": {"type": "object"},
515 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
516 "additionalProperties": False,
519 ns_scale
= { # TODO for the moment it is only VDU-scaling
520 "title": "ns scale input schema",
521 "$schema": "http://json-schema.org/draft-04/schema#",
524 "lcmOperationType": string_schema
,
525 "nsInstanceId": id_schema
,
526 "scaleType": {"enum": ["SCALE_VNF"]},
527 "timeout_ns_scale": integer1_schema
,
531 "vnfInstanceId": name_schema
,
532 "scaleVnfType": {"enum": ["SCALE_OUT", "SCALE_IN"]},
536 "scaling-group-descriptor": name_schema
,
537 "member-vnf-index": name_schema
,
538 "scaling-policy": name_schema
,
540 "required": ["scaling-group-descriptor", "member-vnf-index"],
541 "additionalProperties": False,
544 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
545 "additionalProperties": False,
547 "scaleTime": time_schema
,
549 "required": ["scaleType", "scaleVnfData"],
550 "additionalProperties": False,
554 "title": "ns migrate input schema",
555 "$schema": "http://json-schema.org/draft-04/schema#",
558 "lcmOperationType": string_schema
,
559 "nsInstanceId": id_schema
,
560 "vnfInstanceId": id_schema
,
561 "migrateToHost": string_schema
,
565 "vduId": name_schema
,
566 "vduCountIndex": integer0_schema
,
568 "required": ["vduId"],
569 "additionalProperties": False,
572 "required": ["vnfInstanceId"],
573 "additionalProperties": False,
577 "title": "ns heal input schema",
578 "$schema": "http://json-schema.org/draft-04/schema#",
581 "lcmOperationType": string_schema
,
582 "nsInstanceId": id_schema
,
583 "timeout_ns_heal": integer1_schema
,
589 "vnfInstanceId": id_schema
,
590 "cause": description_schema
,
591 "additionalParams": {
594 "run-day1": bool_schema
,
600 "run-day1": bool_schema
,
601 "vdu-id": name_schema
,
602 "count-index": integer0_schema
,
604 "required": ["vdu-id"],
605 "additionalProperties": False,
609 "additionalProperties": False,
612 "required": ["vnfInstanceId"],
613 "additionalProperties": False,
617 "required": ["healVnfData"],
618 "additionalProperties": False,
622 "title": "vertial scale input schema",
623 "$schema": "http://json-schema.org/draft-04/schema#",
626 "lcmOperationType": string_schema
,
627 "verticalScale": string_schema
,
628 "nsInstanceId": id_schema
,
629 "changeVnfFlavorData": {
632 "vnfInstanceId": id_schema
,
633 "additionalParams": {
636 "vduid": string_schema
,
637 "vduCountIndex": integer0_schema
,
638 "virtualMemory": integer1_schema
,
639 "sizeOfStorage": integer0_schema
,
640 "numVirtualCpu": integer1_schema
,
644 "required": ["vnfInstanceId", "additionalParams"],
645 "additionalProperties": False,
648 "required": ["lcmOperationType", "verticalScale", "nsInstanceId"],
649 "additionalProperties": False,
652 schema_version
= {"type": "string", "enum": ["1.0"]}
653 schema_type
= {"type": "string"}
654 vim_type
= shortname_schema
# {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
656 vim_account_edit_schema
= {
657 "title": "vim_account edit input schema",
658 "$schema": "http://json-schema.org/draft-04/schema#",
662 "description": description_schema
,
664 "datacenter": name_schema
,
665 "vim_type": vim_type
,
666 "vim_url": description_schema
,
667 # "vim_url_admin": description_schema,
668 # "vim_tenant": name_schema,
669 "vim_tenant_name": name_schema
,
670 "vim_user": string_schema
,
671 "vim_password": passwd_schema
,
673 "config": {"type": "object"},
674 "prometheus-config": {"type": "object"},
676 "additionalProperties": False,
679 vim_account_new_schema
= {
680 "title": "vim_account creation input schema",
681 "$schema": "http://json-schema.org/draft-04/schema#",
684 "schema_version": schema_version
,
685 "schema_type": schema_type
,
687 "description": description_schema
,
689 "datacenter": name_schema
,
690 "vim_type": vim_type
,
691 "vim_url": description_schema
,
692 # "vim_url_admin": description_schema,
693 # "vim_tenant": name_schema,
694 "vim_tenant_name": name_schema
,
695 "vim_user": string_schema
,
696 "vim_password": passwd_schema
,
698 "config": {"type": "object"},
699 "prometheus-config": {"type": "object"},
709 "additionalProperties": False,
712 wim_type
= shortname_schema
# {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
714 wim_account_edit_schema
= {
715 "title": "wim_account edit input schema",
716 "$schema": "http://json-schema.org/draft-04/schema#",
720 "description": description_schema
,
722 "wim_type": wim_type
,
723 "wim_url": description_schema
,
724 "user": string_schema
,
725 "password": passwd_schema
,
726 "config": {"type": "object"},
728 "additionalProperties": False,
731 wim_account_new_schema
= {
732 "title": "wim_account creation input schema",
733 "$schema": "http://json-schema.org/draft-04/schema#",
736 "schema_version": schema_version
,
737 "schema_type": schema_type
,
739 "description": description_schema
,
741 "wim_type": wim_type
,
742 "wim_url": description_schema
,
743 "user": string_schema
,
744 "password": passwd_schema
,
747 "patternProperties": {".": {"not": {"type": "null"}}},
750 "required": ["name", "wim_url", "wim_type"],
751 "additionalProperties": False,
756 "type": {"type": "string"},
757 "url": {"type": "string"},
758 "user": string_schema
,
759 "password": passwd_schema
,
760 "config": {"type": "object"},
761 "description": description_schema
,
762 # The folowing are deprecated. Maintanied for backward compatibility
766 "version": {"type": "string", "minLength": 1, "maxLength": 12},
769 "title": "sdn controller information schema",
770 "$schema": "http://json-schema.org/draft-04/schema#",
772 "properties": sdn_properties
,
773 "required": ["name", "type"],
774 "additionalProperties": False,
777 "title": "sdn controller update information schema",
778 "$schema": "http://json-schema.org/draft-04/schema#",
780 "properties": sdn_properties
,
781 # "required": ["name", "port", 'ip', 'dpid', 'type'],
782 "additionalProperties": False,
784 sdn_port_mapping_schema
= {
785 "$schema": "http://json-schema.org/draft-04/schema#",
786 "title": "sdn port mapping information schema",
791 "compute_node": shortname_schema
,
797 "pci": pci_extended_schema
,
798 "switch_port": shortname_schema
,
799 "switch_mac": mac_schema
,
805 "required": ["compute_node", "ports"],
808 sdn_external_port_schema
= {
809 "$schema": "http://json-schema.org/draft-04/schema#",
810 "title": "External port information",
813 "port": {"type": "string", "minLength": 1, "maxLength": 60},
817 "required": ["port"],
821 k8scluster_deploy_method_schema
= {
822 "$schema": "http://json-schema.org/draft-04/schema#",
823 "title": "Deployment methods for K8s cluster",
826 "helm-chart": {"type": "boolean"},
827 "juju-bundle": {"type": "boolean"},
828 "helm-chart-v3": {"type": "boolean"},
830 "additionalProperties": False,
833 k8scluster_nets_schema
= {
834 "title": "k8scluster nets input schema",
835 "$schema": "http://json-schema.org/draft-04/schema#",
837 "patternProperties": {".": {"oneOf": [name_schema
, null_schema
]}},
839 "additionalProperties": False,
841 k8scluster_new_schema
= {
842 "title": "k8scluster creation input schema",
843 "$schema": "http://json-schema.org/draft-04/schema#",
846 "schema_version": schema_version
,
847 "schema_type": schema_type
,
849 "description": description_schema
,
850 "credentials": object_schema
,
851 "vim_account": id_schema
,
853 "k8s_version": string_schema
,
854 "nets": k8scluster_nets_schema
,
855 "deployment_methods": k8scluster_deploy_method_schema
,
856 "namespace": name_schema
,
857 "cni": nameshort_list_schema
,
859 "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
860 "additionalProperties": False,
862 k8scluster_edit_schema
= {
863 "title": "vim_account edit input schema",
864 "$schema": "http://json-schema.org/draft-04/schema#",
868 "description": description_schema
,
869 "credentials": object_schema
,
870 "vim_account": id_schema
,
872 "k8s_version": string_schema
,
873 "nets": k8scluster_nets_schema
,
874 "namespace": name_schema
,
875 "cni": nameshort_list_schema
,
877 "additionalProperties": False,
882 "title": "vca creation input schema",
883 "$schema": "http://json-schema.org/draft-04/schema#",
886 "schema_version": schema_version
,
887 "schema_type": schema_type
,
889 "description": description_schema
,
890 "endpoints": description_list_schema
,
891 "user": string_schema
,
892 "secret": passwd_schema
,
893 "cacert": long_description_schema
,
894 "lxd-cloud": shortname_schema
,
895 "lxd-credentials": shortname_schema
,
896 "k8s-cloud": shortname_schema
,
897 "k8s-credentials": shortname_schema
,
898 "model-config": object_schema
,
911 "additionalProperties": False,
914 "title": "vca creation input schema",
915 "$schema": "http://json-schema.org/draft-04/schema#",
919 "description": description_schema
,
920 "endpoints": description_list_schema
,
921 "port": integer1_schema
,
922 "user": string_schema
,
923 "secret": passwd_schema
,
924 "cacert": long_description_schema
,
925 "lxd-cloud": shortname_schema
,
926 "lxd-credentials": shortname_schema
,
927 "k8s-cloud": shortname_schema
,
928 "k8s-credentials": shortname_schema
,
929 "model-config": object_schema
,
931 "additionalProperties": False,
935 paas_types
= {"enum": ["juju"]}
937 "title": "paas creation input schema",
938 "$schema": "http://json-schema.org/draft-04/schema#",
941 "schema_version": schema_version
,
942 "schema_type": schema_type
,
944 "paas_type": paas_types
,
945 "description": description_schema
,
946 "endpoints": description_list_schema
,
947 "user": string_schema
,
948 "secret": passwd_schema
,
949 "config": object_schema
,
958 "additionalProperties": False,
961 "title": "paas edition input schema",
962 "$schema": "http://json-schema.org/draft-04/schema#",
966 "paas_type": paas_types
,
967 "description": description_schema
,
968 "endpoints": description_list_schema
,
969 "user": string_schema
,
970 "secret": passwd_schema
,
971 "config": object_schema
,
973 "additionalProperties": False,
977 k8srepo_types
= {"enum": ["helm-chart", "juju-bundle"]}
978 k8srepo_properties
= {
980 "description": description_schema
,
981 "type": k8srepo_types
,
982 "url": description_schema
,
984 k8srepo_new_schema
= {
985 "title": "k8scluster creation input schema",
986 "$schema": "http://json-schema.org/draft-04/schema#",
988 "properties": k8srepo_properties
,
989 "required": ["name", "type", "url"],
990 "additionalProperties": False,
992 k8srepo_edit_schema
= {
993 "title": "vim_account edit input schema",
994 "$schema": "http://json-schema.org/draft-04/schema#",
996 "properties": k8srepo_properties
,
997 "additionalProperties": False,
1001 osmrepo_types
= {"enum": ["osm"]}
1002 osmrepo_properties
= {
1003 "name": name_schema
,
1004 "description": description_schema
,
1005 "type": osmrepo_types
,
1006 "url": description_schema
1007 # "user": string_schema,
1008 # "password": passwd_schema
1010 osmrepo_new_schema
= {
1011 "title": "osm repo creation input schema",
1012 "$schema": "http://json-schema.org/draft-04/schema#",
1014 "properties": osmrepo_properties
,
1015 "required": ["name", "type", "url"],
1016 "additionalProperties": False,
1018 osmrepo_edit_schema
= {
1019 "title": "osm repo edit input schema",
1020 "$schema": "http://json-schema.org/draft-04/schema#",
1022 "properties": osmrepo_properties
,
1023 "additionalProperties": False,
1030 "name": shortname_schema
,
1031 "mgmt": bool_schema
,
1032 "type": {"enum": ["overlay", "underlay"]},
1033 "ip-address": {"oneOf": [ip_schema
, ipv6_schema
]},
1034 # TODO, add user, password, ssh-key
1035 "mac-address": mac_schema
,
1036 "vim-network-name": shortname_schema
, # interface is connected to one vim network, or switch port
1037 "vim-network-id": shortname_schema
,
1038 # # provide this in case SDN assist must deal with this interface
1039 # "switch-dpid": dpid_Schema,
1040 # "switch-port": shortname_schema,
1041 # "switch-mac": shortname_schema,
1042 # "switch-vlan": vlan_schema,
1044 "required": ["name", "mgmt", "ip-address"],
1045 "additionalProperties": False,
1048 "title": "pdu creation input schema",
1049 "$schema": "http://json-schema.org/draft-04/schema#",
1052 "name": shortname_schema
,
1053 "type": shortname_schema
,
1054 "description": description_schema
,
1055 "shared": bool_schema
,
1056 "vims": nameshort_list_schema
,
1057 "vim_accounts": nameshort_list_schema
,
1058 "interfaces": {"type": "array", "items": pdu_interface
, "minItems": 1},
1060 "required": ["name", "type", "interfaces"],
1061 "additionalProperties": False,
1064 "title": "pdu edit input schema",
1065 "$schema": "http://json-schema.org/draft-04/schema#",
1068 "name": shortname_schema
,
1069 "type": shortname_schema
,
1070 "description": description_schema
,
1071 "shared": bool_schema
,
1072 "vims": {"oneOf": [array_edition_schema
, nameshort_list_schema
]},
1073 "vim_accounts": {"oneOf": [array_edition_schema
, nameshort_list_schema
]},
1076 array_edition_schema
,
1077 {"type": "array", "items": pdu_interface
, "minItems": 1},
1081 "additionalProperties": False,
1085 # VNF PKG OPERATIONS
1086 vnfpkgop_new_schema
= {
1087 "title": "VNF PKG operation creation input schema",
1088 "$schema": "http://json-schema.org/draft-04/schema#",
1091 "lcmOperationType": string_schema
,
1092 "vnfPkgId": id_schema
,
1093 "kdu_name": name_schema
,
1094 "primitive": name_schema
,
1095 "primitive_params": {"type": "object"},
1104 "additionalProperties": False,
1108 project_role_mappings
= {
1109 "title": "list pf projects/roles",
1110 "$schema": "http://json-schema.org/draft-04/schema#",
1114 "properties": {"project": shortname_schema
, "role": shortname_schema
},
1115 "required": ["project", "role"],
1116 "additionalProperties": False,
1120 project_role_mappings_optional
= {
1121 "title": "list of projects/roles or projects only",
1122 "$schema": "http://json-schema.org/draft-04/schema#",
1126 "properties": {"project": shortname_schema
, "role": shortname_schema
},
1127 "required": ["project"],
1128 "additionalProperties": False,
1133 "$schema": "http://json-schema.org/draft-04/schema#",
1134 "title": "New user schema",
1137 "username": string_schema
,
1138 "domain_name": shortname_schema
,
1139 "password": passwd_schema
,
1140 "projects": nameshort_list_schema
,
1141 "project_role_mappings": project_role_mappings
,
1143 "required": ["username", "password"],
1144 "additionalProperties": False,
1146 user_edit_schema
= {
1147 "$schema": "http://json-schema.org/draft-04/schema#",
1148 "title": "User edit schema for administrators",
1151 "password": passwd_schema
,
1152 "old_password": passwd_schema
,
1153 "username": string_schema
, # To allow User Name modification
1154 "projects": {"oneOf": [nameshort_list_schema
, array_edition_schema
]},
1155 "project_role_mappings": project_role_mappings
,
1156 "add_project_role_mappings": project_role_mappings
,
1157 "remove_project_role_mappings": project_role_mappings_optional
,
1160 "additionalProperties": False,
1164 topics_with_quota
= [
1181 project_new_schema
= {
1182 "$schema": "http://json-schema.org/draft-04/schema#",
1183 "title": "New project schema for administrators",
1186 "name": shortname_schema
,
1187 "admin": bool_schema
,
1188 "domain_name": shortname_schema
,
1191 "properties": {topic
: integer0_schema
for topic
in topics_with_quota
},
1192 "additionalProperties": False,
1195 "required": ["name"],
1196 "additionalProperties": False,
1198 project_edit_schema
= {
1199 "$schema": "http://json-schema.org/draft-04/schema#",
1200 "title": "Project edit schema for administrators",
1203 "admin": bool_schema
,
1204 "name": shortname_schema
, # To allow Project Name modification
1208 topic
: {"oneOf": [integer0_schema
, null_schema
]}
1209 for topic
in topics_with_quota
1211 "additionalProperties": False,
1214 "additionalProperties": False,
1219 roles_new_schema
= {
1220 "$schema": "http://json-schema.org/draft-04/schema#",
1221 "title": "New role schema for administrators",
1224 "name": shortname_schema
,
1227 "patternProperties": {
1230 # "minProperties": 1,
1233 "required": ["name"],
1234 "additionalProperties": False,
1236 roles_edit_schema
= {
1237 "$schema": "http://json-schema.org/draft-04/schema#",
1238 "title": "Roles edit schema for administrators",
1241 "name": shortname_schema
,
1244 "patternProperties": {".": {"oneOf": [bool_schema
, null_schema
]}},
1245 # "minProperties": 1,
1248 "additionalProperties": False,
1254 nbi_new_input_schemas
= {
1255 "users": user_new_schema
,
1256 "projects": project_new_schema
,
1257 "vim_accounts": vim_account_new_schema
,
1258 "sdns": sdn_new_schema
,
1259 "ns_instantiate": ns_instantiate
,
1260 "ns_action": ns_action
,
1261 "ns_scale": ns_scale
,
1262 "ns_update": ns_update
,
1264 "pdus": pdu_new_schema
,
1267 nbi_edit_input_schemas
= {
1268 "users": user_edit_schema
,
1269 "projects": project_edit_schema
,
1270 "vim_accounts": vim_account_edit_schema
,
1271 "sdns": sdn_edit_schema
,
1272 "pdus": pdu_edit_schema
,
1276 nsi_subnet_instantiate
= deepcopy(ns_instantiate
)
1277 nsi_subnet_instantiate
["title"] = "netslice subnet instantiation params input schema"
1278 nsi_subnet_instantiate
["properties"]["id"] = name_schema
1279 del nsi_subnet_instantiate
["required"]
1281 nsi_vld_instantiate
= {
1282 "title": "netslice vld instantiation params input schema",
1283 "$schema": "http://json-schema.org/draft-04/schema#",
1286 "name": string_schema
,
1287 "vim-network-name": {"oneOf": [string_schema
, object_schema
]},
1288 "vim-network-id": {"oneOf": [string_schema
, object_schema
]},
1289 "ip-profile": object_schema
,
1291 "required": ["name"],
1292 "additionalProperties": False,
1296 "title": "netslice action instantiate input schema",
1297 "$schema": "http://json-schema.org/draft-04/schema#",
1300 "lcmOperationType": string_schema
,
1301 "netsliceInstanceId": id_schema
,
1302 "nsiName": name_schema
,
1303 "nsiDescription": {"oneOf": [description_schema
, null_schema
]},
1304 "nstId": string_schema
,
1305 "vimAccountId": id_schema
,
1306 "timeout_nsi_deploy": integer1_schema
,
1307 "ssh_keys": {"type": "array", "items": {"type": "string"}},
1308 "nsi_id": id_schema
,
1309 "additionalParamsForNsi": object_schema
,
1310 "netslice-subnet": {
1313 "items": nsi_subnet_instantiate
,
1315 "netslice-vld": {"type": "array", "minItems": 1, "items": nsi_vld_instantiate
},
1317 "required": ["nsiName", "nstId", "vimAccountId"],
1318 "additionalProperties": False,
1325 nsinstancesubscriptionfilter_schema
= {
1326 "title": "instance identifier schema",
1327 "$schema": "http://json-schema.org/draft-07/schema#",
1330 "nsdIds": {"type": "array"},
1331 "vnfdIds": {"type": "array"},
1332 "pnfdIds": {"type": "array"},
1333 "nsInstanceIds": {"type": "array"},
1334 "nsInstanceNames": {"type": "array"},
1339 "title": "nslcmsubscription input schema",
1340 "$schema": "http://json-schema.org/draft-07/schema#",
1343 "nsInstanceSubscriptionFilter": nsinstancesubscriptionfilter_schema
,
1344 "notificationTypes": {
1348 "NsLcmOperationOccurrenceNotification",
1349 "NsChangeNotification",
1350 "NsIdentifierCreationNotification",
1351 "NsIdentifierDeletionNotification",
1357 "items": {"enum": ["INSTANTIATE", "SCALE", "TERMINATE", "UPDATE", "HEAL"]},
1359 "operationStates": {
1365 "PARTIALLY_COMPLETED",
1373 "nsComponentTypes": {"type": "array", "items": {"enum": ["VNF", "NS", "PNF"]}},
1374 "lcmOpNameImpactingNsComponent": {
1380 "VNF_SCALE_TO_LEVEL",
1381 "VNF_CHANGE_FLAVOUR",
1385 "VNF_CHANGE_EXT_CONN",
1395 "lcmOpOccStatusImpactingNsComponent": {
1401 "PARTIALLY_COMPLETED",
1412 "notificationTypes": {
1413 "contains": {"const": "NsLcmOperationOccurrenceNotification"}
1419 {"required": ["operationTypes"]},
1420 {"required": ["operationStates"]},
1427 "notificationTypes": {"contains": {"const": "NsChangeNotification"}}
1432 {"required": ["nsComponentTypes"]},
1433 {"required": ["lcmOpNameImpactingNsComponent"]},
1434 {"required": ["lcmOpOccStatusImpactingNsComponent"]},
1441 authentication_schema
= {
1442 "title": "authentication schema for subscription",
1443 "$schema": "http://json-schema.org/draft-07/schema#",
1446 "authType": {"enum": ["basic"]},
1450 "userName": string_schema
,
1451 "password": passwd_schema
,
1458 "title": "subscription input schema",
1459 "$schema": "http://json-schema.org/draft-07/schema#",
1462 "filter": nslcmsub_schema
,
1463 "CallbackUri": description_schema
,
1464 "authentication": authentication_schema
,
1466 "required": ["CallbackUri"],
1469 vnflcmsub_schema
= {
1470 "title": "vnflcmsubscription input schema",
1471 "$schema": "http://json-schema.org/draft-07/schema#",
1474 "VnfInstanceSubscriptionFilter": {
1477 "vnfdIds": {"type": "array"},
1478 "vnfInstanceIds": {"type": "array"},
1481 "notificationTypes": {
1485 "VnfIdentifierCreationNotification",
1486 "VnfLcmOperationOccurrenceNotification",
1487 "VnfIdentifierDeletionNotification",
1505 "REVERT_TO_SNAPSHOT",
1510 "operationStates": {
1525 "required": ["VnfInstanceSubscriptionFilter", "notificationTypes"],
1528 vnf_subscription
= {
1529 "title": "vnf subscription input schema",
1530 "$schema": "http://json-schema.org/draft-07/schema#",
1533 "filter": vnflcmsub_schema
,
1534 "CallbackUri": description_schema
,
1535 "authentication": authentication_schema
,
1537 "required": ["filter", "CallbackUri"],
1541 class ValidationError(Exception):
1542 def __init__(self
, message
, http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
):
1543 self
.http_code
= http_code
1544 Exception.__init
__(self
, message
)
1547 def validate_input(indata
, schema_to_use
):
1549 Validates input data against json schema
1550 :param indata: user input data. Should be a dictionary
1551 :param schema_to_use: jsonschema to test
1552 :return: None if ok, raises ValidationError exception on error
1556 js_v(indata
, schema_to_use
)
1558 except js_e
.ValidationError
as e
:
1560 error_pos
= "at '" + ":".join(map(str, e
.path
)) + "'"
1563 raise ValidationError("Format error {} '{}' ".format(error_pos
, e
.message
))
1564 except js_e
.SchemaError
:
1565 raise ValidationError(
1566 "Bad json schema {}".format(schema_to_use
),
1567 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
,
1571 def is_valid_uuid(x
):
1573 Test for a valid UUID
1574 :param x: string to test
1575 :return: True if x is a valid uuid, False otherwise
1580 except (TypeError, ValueError, AttributeError):