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,
495 ns_scale
= { # TODO for the moment it is only VDU-scaling
496 "title": "ns scale input schema",
497 "$schema": "http://json-schema.org/draft-04/schema#",
500 "lcmOperationType": string_schema
,
501 "nsInstanceId": id_schema
,
502 "scaleType": {"enum": ["SCALE_VNF"]},
503 "timeout_ns_scale": integer1_schema
,
507 "vnfInstanceId": name_schema
,
508 "scaleVnfType": {"enum": ["SCALE_OUT", "SCALE_IN"]},
512 "scaling-group-descriptor": name_schema
,
513 "member-vnf-index": name_schema
,
514 "scaling-policy": name_schema
,
516 "required": ["scaling-group-descriptor", "member-vnf-index"],
517 "additionalProperties": False,
520 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
521 "additionalProperties": False,
523 "scaleTime": time_schema
,
525 "required": ["scaleType", "scaleVnfData"],
526 "additionalProperties": False,
530 "title": "ns migrate input schema",
531 "$schema": "http://json-schema.org/draft-04/schema#",
534 "lcmOperationType": string_schema
,
535 "nsInstanceId": id_schema
,
536 "vnfInstanceId": id_schema
,
537 "migrateToHost": string_schema
,
541 "vduId": name_schema
,
542 "vduCountIndex": integer0_schema
,
544 "required": ["vduId"],
545 "additionalProperties": False,
548 "required": ["vnfInstanceId"],
549 "additionalProperties": False
552 schema_version
= {"type": "string", "enum": ["1.0"]}
553 schema_type
= {"type": "string"}
554 vim_type
= shortname_schema
# {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
556 vim_account_edit_schema
= {
557 "title": "vim_account edit input schema",
558 "$schema": "http://json-schema.org/draft-04/schema#",
562 "description": description_schema
,
564 "datacenter": name_schema
,
565 "vim_type": vim_type
,
566 "vim_url": description_schema
,
567 # "vim_url_admin": description_schema,
568 # "vim_tenant": name_schema,
569 "vim_tenant_name": name_schema
,
570 "vim_user": string_schema
,
571 "vim_password": passwd_schema
,
573 "config": {"type": "object"},
574 "prometheus-config": {"type": "object"},
576 "additionalProperties": False,
579 vim_account_new_schema
= {
580 "title": "vim_account creation input schema",
581 "$schema": "http://json-schema.org/draft-04/schema#",
584 "schema_version": schema_version
,
585 "schema_type": schema_type
,
587 "description": description_schema
,
589 "datacenter": name_schema
,
590 "vim_type": vim_type
,
591 "vim_url": description_schema
,
592 # "vim_url_admin": description_schema,
593 # "vim_tenant": name_schema,
594 "vim_tenant_name": name_schema
,
595 "vim_user": string_schema
,
596 "vim_password": passwd_schema
,
598 "config": {"type": "object"},
599 "prometheus-config": {"type": "object"},
609 "additionalProperties": False,
612 wim_type
= shortname_schema
# {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
614 wim_account_edit_schema
= {
615 "title": "wim_account edit input schema",
616 "$schema": "http://json-schema.org/draft-04/schema#",
620 "description": description_schema
,
622 "wim_type": wim_type
,
623 "wim_url": description_schema
,
624 "user": string_schema
,
625 "password": passwd_schema
,
626 "config": {"type": "object"},
628 "additionalProperties": False,
631 wim_account_new_schema
= {
632 "title": "wim_account creation input schema",
633 "$schema": "http://json-schema.org/draft-04/schema#",
636 "schema_version": schema_version
,
637 "schema_type": schema_type
,
639 "description": description_schema
,
641 "wim_type": wim_type
,
642 "wim_url": description_schema
,
643 "user": string_schema
,
644 "password": passwd_schema
,
647 "patternProperties": {".": {"not": {"type": "null"}}},
650 "required": ["name", "wim_url", "wim_type"],
651 "additionalProperties": False,
656 "type": {"type": "string"},
657 "url": {"type": "string"},
658 "user": string_schema
,
659 "password": passwd_schema
,
660 "config": {"type": "object"},
661 "description": description_schema
,
662 # The folowing are deprecated. Maintanied for backward compatibility
666 "version": {"type": "string", "minLength": 1, "maxLength": 12},
669 "title": "sdn controller information schema",
670 "$schema": "http://json-schema.org/draft-04/schema#",
672 "properties": sdn_properties
,
673 "required": ["name", "type"],
674 "additionalProperties": False,
677 "title": "sdn controller update information schema",
678 "$schema": "http://json-schema.org/draft-04/schema#",
680 "properties": sdn_properties
,
681 # "required": ["name", "port", 'ip', 'dpid', 'type'],
682 "additionalProperties": False,
684 sdn_port_mapping_schema
= {
685 "$schema": "http://json-schema.org/draft-04/schema#",
686 "title": "sdn port mapping information schema",
691 "compute_node": shortname_schema
,
697 "pci": pci_extended_schema
,
698 "switch_port": shortname_schema
,
699 "switch_mac": mac_schema
,
705 "required": ["compute_node", "ports"],
708 sdn_external_port_schema
= {
709 "$schema": "http://json-schema.org/draft-04/schema#",
710 "title": "External port information",
713 "port": {"type": "string", "minLength": 1, "maxLength": 60},
717 "required": ["port"],
721 k8scluster_deploy_method_schema
= {
722 "$schema": "http://json-schema.org/draft-04/schema#",
723 "title": "Deployment methods for K8s cluster",
726 "helm-chart": {"type": "boolean"},
727 "juju-bundle": {"type": "boolean"},
728 "helm-chart-v3": {"type": "boolean"},
730 "additionalProperties": False,
733 k8scluster_nets_schema
= {
734 "title": "k8scluster nets input schema",
735 "$schema": "http://json-schema.org/draft-04/schema#",
737 "patternProperties": {".": {"oneOf": [name_schema
, null_schema
]}},
739 "additionalProperties": False,
741 k8scluster_new_schema
= {
742 "title": "k8scluster creation input schema",
743 "$schema": "http://json-schema.org/draft-04/schema#",
746 "schema_version": schema_version
,
747 "schema_type": schema_type
,
749 "description": description_schema
,
750 "credentials": object_schema
,
751 "vim_account": id_schema
,
753 "k8s_version": string_schema
,
754 "nets": k8scluster_nets_schema
,
755 "deployment_methods": k8scluster_deploy_method_schema
,
756 "namespace": name_schema
,
757 "cni": nameshort_list_schema
,
759 "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
760 "additionalProperties": False,
762 k8scluster_edit_schema
= {
763 "title": "vim_account edit input schema",
764 "$schema": "http://json-schema.org/draft-04/schema#",
768 "description": description_schema
,
769 "credentials": object_schema
,
770 "vim_account": id_schema
,
772 "k8s_version": string_schema
,
773 "nets": k8scluster_nets_schema
,
774 "namespace": name_schema
,
775 "cni": nameshort_list_schema
,
777 "additionalProperties": False,
782 "title": "vca creation input schema",
783 "$schema": "http://json-schema.org/draft-04/schema#",
786 "schema_version": schema_version
,
787 "schema_type": schema_type
,
789 "description": description_schema
,
790 "endpoints": description_list_schema
,
791 "user": string_schema
,
792 "secret": passwd_schema
,
793 "cacert": long_description_schema
,
794 "lxd-cloud": shortname_schema
,
795 "lxd-credentials": shortname_schema
,
796 "k8s-cloud": shortname_schema
,
797 "k8s-credentials": shortname_schema
,
798 "model-config": object_schema
,
811 "additionalProperties": False,
814 "title": "vca creation input schema",
815 "$schema": "http://json-schema.org/draft-04/schema#",
819 "description": description_schema
,
820 "endpoints": description_list_schema
,
821 "port": integer1_schema
,
822 "user": string_schema
,
823 "secret": passwd_schema
,
824 "cacert": long_description_schema
,
825 "lxd-cloud": shortname_schema
,
826 "lxd-credentials": shortname_schema
,
827 "k8s-cloud": shortname_schema
,
828 "k8s-credentials": shortname_schema
,
829 "model-config": object_schema
,
831 "additionalProperties": False,
835 k8srepo_types
= {"enum": ["helm-chart", "juju-bundle"]}
836 k8srepo_properties
= {
838 "description": description_schema
,
839 "type": k8srepo_types
,
840 "url": description_schema
,
842 k8srepo_new_schema
= {
843 "title": "k8scluster creation input schema",
844 "$schema": "http://json-schema.org/draft-04/schema#",
846 "properties": k8srepo_properties
,
847 "required": ["name", "type", "url"],
848 "additionalProperties": False,
850 k8srepo_edit_schema
= {
851 "title": "vim_account edit input schema",
852 "$schema": "http://json-schema.org/draft-04/schema#",
854 "properties": k8srepo_properties
,
855 "additionalProperties": False,
859 osmrepo_types
= {"enum": ["osm"]}
860 osmrepo_properties
= {
862 "description": description_schema
,
863 "type": osmrepo_types
,
864 "url": description_schema
865 # "user": string_schema,
866 # "password": passwd_schema
868 osmrepo_new_schema
= {
869 "title": "osm repo creation input schema",
870 "$schema": "http://json-schema.org/draft-04/schema#",
872 "properties": osmrepo_properties
,
873 "required": ["name", "type", "url"],
874 "additionalProperties": False,
876 osmrepo_edit_schema
= {
877 "title": "osm repo edit input schema",
878 "$schema": "http://json-schema.org/draft-04/schema#",
880 "properties": osmrepo_properties
,
881 "additionalProperties": False,
888 "name": shortname_schema
,
890 "type": {"enum": ["overlay", "underlay"]},
891 "ip-address": {"oneOf": [ip_schema
, ipv6_schema
]},
892 # TODO, add user, password, ssh-key
893 "mac-address": mac_schema
,
894 "vim-network-name": shortname_schema
, # interface is connected to one vim network, or switch port
895 "vim-network-id": shortname_schema
,
896 # # provide this in case SDN assist must deal with this interface
897 # "switch-dpid": dpid_Schema,
898 # "switch-port": shortname_schema,
899 # "switch-mac": shortname_schema,
900 # "switch-vlan": vlan_schema,
902 "required": ["name", "mgmt", "ip-address"],
903 "additionalProperties": False,
906 "title": "pdu creation input schema",
907 "$schema": "http://json-schema.org/draft-04/schema#",
910 "name": shortname_schema
,
911 "type": shortname_schema
,
912 "description": description_schema
,
913 "shared": bool_schema
,
914 "vims": nameshort_list_schema
,
915 "vim_accounts": nameshort_list_schema
,
916 "interfaces": {"type": "array", "items": pdu_interface
, "minItems": 1},
918 "required": ["name", "type", "interfaces"],
919 "additionalProperties": False,
922 "title": "pdu edit input schema",
923 "$schema": "http://json-schema.org/draft-04/schema#",
926 "name": shortname_schema
,
927 "type": shortname_schema
,
928 "description": description_schema
,
929 "shared": bool_schema
,
930 "vims": {"oneOf": [array_edition_schema
, nameshort_list_schema
]},
931 "vim_accounts": {"oneOf": [array_edition_schema
, nameshort_list_schema
]},
934 array_edition_schema
,
935 {"type": "array", "items": pdu_interface
, "minItems": 1},
939 "additionalProperties": False,
944 vnfpkgop_new_schema
= {
945 "title": "VNF PKG operation creation input schema",
946 "$schema": "http://json-schema.org/draft-04/schema#",
949 "lcmOperationType": string_schema
,
950 "vnfPkgId": id_schema
,
951 "kdu_name": name_schema
,
952 "primitive": name_schema
,
953 "primitive_params": {"type": "object"},
962 "additionalProperties": False,
966 project_role_mappings
= {
967 "title": "list pf projects/roles",
968 "$schema": "http://json-schema.org/draft-04/schema#",
972 "properties": {"project": shortname_schema
, "role": shortname_schema
},
973 "required": ["project", "role"],
974 "additionalProperties": False,
978 project_role_mappings_optional
= {
979 "title": "list of projects/roles or projects only",
980 "$schema": "http://json-schema.org/draft-04/schema#",
984 "properties": {"project": shortname_schema
, "role": shortname_schema
},
985 "required": ["project"],
986 "additionalProperties": False,
991 "$schema": "http://json-schema.org/draft-04/schema#",
992 "title": "New user schema",
995 "username": string_schema
,
996 "domain_name": shortname_schema
,
997 "password": passwd_schema
,
998 "projects": nameshort_list_schema
,
999 "project_role_mappings": project_role_mappings
,
1001 "required": ["username", "password"],
1002 "additionalProperties": False,
1004 user_edit_schema
= {
1005 "$schema": "http://json-schema.org/draft-04/schema#",
1006 "title": "User edit schema for administrators",
1009 "password": passwd_schema
,
1010 "old_password": passwd_schema
,
1011 "username": string_schema
, # To allow User Name modification
1012 "projects": {"oneOf": [nameshort_list_schema
, array_edition_schema
]},
1013 "project_role_mappings": project_role_mappings
,
1014 "add_project_role_mappings": project_role_mappings
,
1015 "remove_project_role_mappings": project_role_mappings_optional
,
1018 "additionalProperties": False,
1022 topics_with_quota
= [
1038 project_new_schema
= {
1039 "$schema": "http://json-schema.org/draft-04/schema#",
1040 "title": "New project schema for administrators",
1043 "name": shortname_schema
,
1044 "admin": bool_schema
,
1045 "domain_name": shortname_schema
,
1048 "properties": {topic
: integer0_schema
for topic
in topics_with_quota
},
1049 "additionalProperties": False,
1052 "required": ["name"],
1053 "additionalProperties": False,
1055 project_edit_schema
= {
1056 "$schema": "http://json-schema.org/draft-04/schema#",
1057 "title": "Project edit schema for administrators",
1060 "admin": bool_schema
,
1061 "name": shortname_schema
, # To allow Project Name modification
1065 topic
: {"oneOf": [integer0_schema
, null_schema
]}
1066 for topic
in topics_with_quota
1068 "additionalProperties": False,
1071 "additionalProperties": False,
1076 roles_new_schema
= {
1077 "$schema": "http://json-schema.org/draft-04/schema#",
1078 "title": "New role schema for administrators",
1081 "name": shortname_schema
,
1084 "patternProperties": {
1087 # "minProperties": 1,
1090 "required": ["name"],
1091 "additionalProperties": False,
1093 roles_edit_schema
= {
1094 "$schema": "http://json-schema.org/draft-04/schema#",
1095 "title": "Roles edit schema for administrators",
1098 "name": shortname_schema
,
1101 "patternProperties": {".": {"oneOf": [bool_schema
, null_schema
]}},
1102 # "minProperties": 1,
1105 "additionalProperties": False,
1111 nbi_new_input_schemas
= {
1112 "users": user_new_schema
,
1113 "projects": project_new_schema
,
1114 "vim_accounts": vim_account_new_schema
,
1115 "sdns": sdn_new_schema
,
1116 "ns_instantiate": ns_instantiate
,
1117 "ns_action": ns_action
,
1118 "ns_scale": ns_scale
,
1119 "ns_update": ns_update
,
1120 "pdus": pdu_new_schema
,
1123 nbi_edit_input_schemas
= {
1124 "users": user_edit_schema
,
1125 "projects": project_edit_schema
,
1126 "vim_accounts": vim_account_edit_schema
,
1127 "sdns": sdn_edit_schema
,
1128 "pdus": pdu_edit_schema
,
1132 nsi_subnet_instantiate
= deepcopy(ns_instantiate
)
1133 nsi_subnet_instantiate
["title"] = "netslice subnet instantiation params input schema"
1134 nsi_subnet_instantiate
["properties"]["id"] = name_schema
1135 del nsi_subnet_instantiate
["required"]
1137 nsi_vld_instantiate
= {
1138 "title": "netslice vld instantiation params input schema",
1139 "$schema": "http://json-schema.org/draft-04/schema#",
1142 "name": string_schema
,
1143 "vim-network-name": {"oneOf": [string_schema
, object_schema
]},
1144 "vim-network-id": {"oneOf": [string_schema
, object_schema
]},
1145 "ip-profile": object_schema
,
1147 "required": ["name"],
1148 "additionalProperties": False,
1152 "title": "netslice action instantiate input schema",
1153 "$schema": "http://json-schema.org/draft-04/schema#",
1156 "lcmOperationType": string_schema
,
1157 "netsliceInstanceId": id_schema
,
1158 "nsiName": name_schema
,
1159 "nsiDescription": {"oneOf": [description_schema
, null_schema
]},
1160 "nstId": string_schema
,
1161 "vimAccountId": id_schema
,
1162 "timeout_nsi_deploy": integer1_schema
,
1163 "ssh_keys": {"type": "array", "items": {"type": "string"}},
1164 "nsi_id": id_schema
,
1165 "additionalParamsForNsi": object_schema
,
1166 "netslice-subnet": {
1169 "items": nsi_subnet_instantiate
,
1171 "netslice-vld": {"type": "array", "minItems": 1, "items": nsi_vld_instantiate
},
1173 "required": ["nsiName", "nstId", "vimAccountId"],
1174 "additionalProperties": False,
1181 nsinstancesubscriptionfilter_schema
= {
1182 "title": "instance identifier schema",
1183 "$schema": "http://json-schema.org/draft-07/schema#",
1186 "nsdIds": {"type": "array"},
1187 "vnfdIds": {"type": "array"},
1188 "pnfdIds": {"type": "array"},
1189 "nsInstanceIds": {"type": "array"},
1190 "nsInstanceNames": {"type": "array"},
1195 "title": "nslcmsubscription input schema",
1196 "$schema": "http://json-schema.org/draft-07/schema#",
1199 "nsInstanceSubscriptionFilter": nsinstancesubscriptionfilter_schema
,
1200 "notificationTypes": {
1204 "NsLcmOperationOccurrenceNotification",
1205 "NsChangeNotification",
1206 "NsIdentifierCreationNotification",
1207 "NsIdentifierDeletionNotification",
1213 "items": {"enum": ["INSTANTIATE", "SCALE", "TERMINATE", "UPDATE", "HEAL"]},
1215 "operationStates": {
1221 "PARTIALLY_COMPLETED",
1229 "nsComponentTypes": {"type": "array", "items": {"enum": ["VNF", "NS", "PNF"]}},
1230 "lcmOpNameImpactingNsComponent": {
1236 "VNF_SCALE_TO_LEVEL",
1237 "VNF_CHANGE_FLAVOUR",
1241 "VNF_CHANGE_EXT_CONN",
1251 "lcmOpOccStatusImpactingNsComponent": {
1257 "PARTIALLY_COMPLETED",
1268 "notificationTypes": {
1269 "contains": {"const": "NsLcmOperationOccurrenceNotification"}
1275 {"required": ["operationTypes"]},
1276 {"required": ["operationStates"]},
1283 "notificationTypes": {"contains": {"const": "NsChangeNotification"}}
1288 {"required": ["nsComponentTypes"]},
1289 {"required": ["lcmOpNameImpactingNsComponent"]},
1290 {"required": ["lcmOpOccStatusImpactingNsComponent"]},
1297 authentication_schema
= {
1298 "title": "authentication schema for subscription",
1299 "$schema": "http://json-schema.org/draft-07/schema#",
1302 "authType": {"enum": ["basic"]},
1306 "userName": string_schema
,
1307 "password": passwd_schema
,
1314 "title": "subscription input schema",
1315 "$schema": "http://json-schema.org/draft-07/schema#",
1318 "filter": nslcmsub_schema
,
1319 "CallbackUri": description_schema
,
1320 "authentication": authentication_schema
,
1322 "required": ["CallbackUri"],
1325 vnflcmsub_schema
= {
1326 "title": "vnflcmsubscription input schema",
1327 "$schema": "http://json-schema.org/draft-07/schema#",
1330 "VnfInstanceSubscriptionFilter": {
1333 "vnfdIds": {"type": "array"},
1334 "vnfInstanceIds": {"type": "array"},
1337 "notificationTypes": {
1341 "VnfIdentifierCreationNotification",
1342 "VnfLcmOperationOccurrenceNotification",
1343 "VnfIdentifierDeletionNotification"
1351 "INSTANTIATE", "SCALE", "SCALE_TO_LEVEL", "CHANGE_FLAVOUR", "TERMINATE",
1352 "HEAL", "OPERATE", "CHANGE_EXT_CONN", "MODIFY_INFO", "CREATE_SNAPSHOT",
1353 "REVERT_TO_SNAPSHOT", "CHANGE_VNFPKG"
1357 "operationStates": {
1361 "STARTING", "PROCESSING", "COMPLETED", "FAILED_TEMP", "FAILED",
1362 "ROLLING_BACK", "ROLLED_BACK"
1367 "required": ["VnfInstanceSubscriptionFilter", "notificationTypes"]
1370 vnf_subscription
= {
1371 "title": "vnf subscription input schema",
1372 "$schema": "http://json-schema.org/draft-07/schema#",
1375 "filter": vnflcmsub_schema
,
1376 "CallbackUri": description_schema
,
1377 "authentication": authentication_schema
1379 "required": ["filter", "CallbackUri"]
1383 class ValidationError(Exception):
1384 def __init__(self
, message
, http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
):
1385 self
.http_code
= http_code
1386 Exception.__init
__(self
, message
)
1389 def validate_input(indata
, schema_to_use
):
1391 Validates input data against json schema
1392 :param indata: user input data. Should be a dictionary
1393 :param schema_to_use: jsonschema to test
1394 :return: None if ok, raises ValidationError exception on error
1398 js_v(indata
, schema_to_use
)
1400 except js_e
.ValidationError
as e
:
1402 error_pos
= "at '" + ":".join(map(str, e
.path
)) + "'"
1405 raise ValidationError("Format error {} '{}' ".format(error_pos
, e
.message
))
1406 except js_e
.SchemaError
:
1407 raise ValidationError(
1408 "Bad json schema {}".format(schema_to_use
),
1409 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
,
1413 def is_valid_uuid(x
):
1415 Test for a valid UUID
1416 :param x: string to test
1417 :return: True if x is a valid uuid, False otherwise
1422 except (TypeError, ValueError, AttributeError):