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,
443 ns_action
= { # TODO for the moment it is only contemplated the vnfd primitive execution
444 "title": "ns action input schema",
445 "$schema": "http://json-schema.org/draft-04/schema#",
448 "lcmOperationType": string_schema
,
449 "nsInstanceId": id_schema
,
450 "member_vnf_index": name_schema
,
451 "vnf_member_index": name_schema
, # TODO for backward compatibility. To remove in future
452 "vdu_id": name_schema
,
453 "vdu_count_index": integer0_schema
,
454 "kdu_name": name_schema
,
455 "primitive": name_schema
,
456 "timeout_ns_action": integer1_schema
,
457 "primitive_params": {"type": "object"},
459 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
460 "additionalProperties": False,
462 ns_scale
= { # TODO for the moment it is only VDU-scaling
463 "title": "ns scale input schema",
464 "$schema": "http://json-schema.org/draft-04/schema#",
467 "lcmOperationType": string_schema
,
468 "nsInstanceId": id_schema
,
469 "scaleType": {"enum": ["SCALE_VNF"]},
470 "timeout_ns_scale": integer1_schema
,
474 "vnfInstanceId": name_schema
,
475 "scaleVnfType": {"enum": ["SCALE_OUT", "SCALE_IN"]},
479 "scaling-group-descriptor": name_schema
,
480 "member-vnf-index": name_schema
,
481 "scaling-policy": name_schema
,
483 "required": ["scaling-group-descriptor", "member-vnf-index"],
484 "additionalProperties": False,
487 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
488 "additionalProperties": False,
490 "scaleTime": time_schema
,
492 "required": ["scaleType", "scaleVnfData"],
493 "additionalProperties": False,
497 schema_version
= {"type": "string", "enum": ["1.0"]}
498 schema_type
= {"type": "string"}
499 vim_type
= shortname_schema
# {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
501 vim_account_edit_schema
= {
502 "title": "vim_account edit input schema",
503 "$schema": "http://json-schema.org/draft-04/schema#",
507 "description": description_schema
,
509 "datacenter": name_schema
,
510 "vim_type": vim_type
,
511 "vim_url": description_schema
,
512 # "vim_url_admin": description_schema,
513 # "vim_tenant": name_schema,
514 "vim_tenant_name": name_schema
,
515 "vim_user": string_schema
,
516 "vim_password": passwd_schema
,
518 "config": {"type": "object"},
519 "prometheus-config": {"type": "object"},
521 "additionalProperties": False,
524 vim_account_new_schema
= {
525 "title": "vim_account creation input schema",
526 "$schema": "http://json-schema.org/draft-04/schema#",
529 "schema_version": schema_version
,
530 "schema_type": schema_type
,
532 "description": description_schema
,
534 "datacenter": name_schema
,
535 "vim_type": vim_type
,
536 "vim_url": description_schema
,
537 # "vim_url_admin": description_schema,
538 # "vim_tenant": name_schema,
539 "vim_tenant_name": name_schema
,
540 "vim_user": string_schema
,
541 "vim_password": passwd_schema
,
543 "config": {"type": "object"},
544 "prometheus-config": {"type": "object"},
554 "additionalProperties": False,
557 wim_type
= shortname_schema
# {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
559 wim_account_edit_schema
= {
560 "title": "wim_account edit input schema",
561 "$schema": "http://json-schema.org/draft-04/schema#",
565 "description": description_schema
,
567 "wim_type": wim_type
,
568 "wim_url": description_schema
,
569 "user": string_schema
,
570 "password": passwd_schema
,
571 "config": {"type": "object"},
573 "additionalProperties": False,
576 wim_account_new_schema
= {
577 "title": "wim_account creation input schema",
578 "$schema": "http://json-schema.org/draft-04/schema#",
581 "schema_version": schema_version
,
582 "schema_type": schema_type
,
584 "description": description_schema
,
586 "wim_type": wim_type
,
587 "wim_url": description_schema
,
588 "user": string_schema
,
589 "password": passwd_schema
,
592 "patternProperties": {".": {"not": {"type": "null"}}},
595 "required": ["name", "wim_url", "wim_type"],
596 "additionalProperties": False,
601 "type": {"type": "string"},
602 "url": {"type": "string"},
603 "user": string_schema
,
604 "password": passwd_schema
,
605 "config": {"type": "object"},
606 "description": description_schema
,
607 # The folowing are deprecated. Maintanied for backward compatibility
611 "version": {"type": "string", "minLength": 1, "maxLength": 12},
614 "title": "sdn controller information schema",
615 "$schema": "http://json-schema.org/draft-04/schema#",
617 "properties": sdn_properties
,
618 "required": ["name", "type"],
619 "additionalProperties": False,
622 "title": "sdn controller update information schema",
623 "$schema": "http://json-schema.org/draft-04/schema#",
625 "properties": sdn_properties
,
626 # "required": ["name", "port", 'ip', 'dpid', 'type'],
627 "additionalProperties": False,
629 sdn_port_mapping_schema
= {
630 "$schema": "http://json-schema.org/draft-04/schema#",
631 "title": "sdn port mapping information schema",
636 "compute_node": shortname_schema
,
642 "pci": pci_extended_schema
,
643 "switch_port": shortname_schema
,
644 "switch_mac": mac_schema
,
650 "required": ["compute_node", "ports"],
653 sdn_external_port_schema
= {
654 "$schema": "http://json-schema.org/draft-04/schema#",
655 "title": "External port information",
658 "port": {"type": "string", "minLength": 1, "maxLength": 60},
662 "required": ["port"],
666 k8scluster_nets_schema
= {
667 "title": "k8scluster nets input schema",
668 "$schema": "http://json-schema.org/draft-04/schema#",
670 "patternProperties": {".": {"oneOf": [name_schema
, null_schema
]}},
672 "additionalProperties": False,
674 k8scluster_new_schema
= {
675 "title": "k8scluster creation input schema",
676 "$schema": "http://json-schema.org/draft-04/schema#",
679 "schema_version": schema_version
,
680 "schema_type": schema_type
,
682 "description": description_schema
,
683 "credentials": object_schema
,
684 "vim_account": id_schema
,
686 "k8s_version": string_schema
,
687 "nets": k8scluster_nets_schema
,
688 "namespace": name_schema
,
689 "cni": nameshort_list_schema
,
691 "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
692 "additionalProperties": False,
694 k8scluster_edit_schema
= {
695 "title": "vim_account edit input schema",
696 "$schema": "http://json-schema.org/draft-04/schema#",
700 "description": description_schema
,
701 "credentials": object_schema
,
702 "vim_account": id_schema
,
704 "k8s_version": string_schema
,
705 "nets": k8scluster_nets_schema
,
706 "namespace": name_schema
,
707 "cni": nameshort_list_schema
,
709 "additionalProperties": False,
714 "title": "vca creation input schema",
715 "$schema": "http://json-schema.org/draft-04/schema#",
718 "schema_version": schema_version
,
719 "schema_type": schema_type
,
721 "description": description_schema
,
722 "endpoints": description_list_schema
,
723 "user": string_schema
,
724 "secret": passwd_schema
,
725 "cacert": long_description_schema
,
726 "lxd-cloud": shortname_schema
,
727 "lxd-credentials": shortname_schema
,
728 "k8s-cloud": shortname_schema
,
729 "k8s-credentials": shortname_schema
,
730 "model-config": object_schema
,
743 "additionalProperties": False,
746 "title": "vca creation input schema",
747 "$schema": "http://json-schema.org/draft-04/schema#",
751 "description": description_schema
,
752 "endpoints": description_list_schema
,
753 "port": integer1_schema
,
754 "user": string_schema
,
755 "secret": passwd_schema
,
756 "cacert": long_description_schema
,
757 "lxd-cloud": shortname_schema
,
758 "lxd-credentials": shortname_schema
,
759 "k8s-cloud": shortname_schema
,
760 "k8s-credentials": shortname_schema
,
761 "model-config": object_schema
,
763 "additionalProperties": False,
767 k8srepo_types
= {"enum": ["helm-chart", "juju-bundle"]}
768 k8srepo_properties
= {
770 "description": description_schema
,
771 "type": k8srepo_types
,
772 "url": description_schema
,
774 k8srepo_new_schema
= {
775 "title": "k8scluster creation input schema",
776 "$schema": "http://json-schema.org/draft-04/schema#",
778 "properties": k8srepo_properties
,
779 "required": ["name", "type", "url"],
780 "additionalProperties": False,
782 k8srepo_edit_schema
= {
783 "title": "vim_account edit input schema",
784 "$schema": "http://json-schema.org/draft-04/schema#",
786 "properties": k8srepo_properties
,
787 "additionalProperties": False,
791 osmrepo_types
= {"enum": ["osm"]}
792 osmrepo_properties
= {
794 "description": description_schema
,
795 "type": osmrepo_types
,
796 "url": description_schema
797 # "user": string_schema,
798 # "password": passwd_schema
800 osmrepo_new_schema
= {
801 "title": "osm repo creation input schema",
802 "$schema": "http://json-schema.org/draft-04/schema#",
804 "properties": osmrepo_properties
,
805 "required": ["name", "type", "url"],
806 "additionalProperties": False,
808 osmrepo_edit_schema
= {
809 "title": "osm repo edit input schema",
810 "$schema": "http://json-schema.org/draft-04/schema#",
812 "properties": osmrepo_properties
,
813 "additionalProperties": False,
820 "name": shortname_schema
,
822 "type": {"enum": ["overlay", "underlay"]},
823 "ip-address": {"oneOf": [ip_schema
, ipv6_schema
]},
824 # TODO, add user, password, ssh-key
825 "mac-address": mac_schema
,
826 "vim-network-name": shortname_schema
, # interface is connected to one vim network, or switch port
827 "vim-network-id": shortname_schema
,
828 # # provide this in case SDN assist must deal with this interface
829 # "switch-dpid": dpid_Schema,
830 # "switch-port": shortname_schema,
831 # "switch-mac": shortname_schema,
832 # "switch-vlan": vlan_schema,
834 "required": ["name", "mgmt", "ip-address"],
835 "additionalProperties": False,
838 "title": "pdu creation input schema",
839 "$schema": "http://json-schema.org/draft-04/schema#",
842 "name": shortname_schema
,
843 "type": shortname_schema
,
844 "description": description_schema
,
845 "shared": bool_schema
,
846 "vims": nameshort_list_schema
,
847 "vim_accounts": nameshort_list_schema
,
848 "interfaces": {"type": "array", "items": pdu_interface
, "minItems": 1},
850 "required": ["name", "type", "interfaces"],
851 "additionalProperties": False,
854 "title": "pdu edit input schema",
855 "$schema": "http://json-schema.org/draft-04/schema#",
858 "name": shortname_schema
,
859 "type": shortname_schema
,
860 "description": description_schema
,
861 "shared": bool_schema
,
862 "vims": {"oneOf": [array_edition_schema
, nameshort_list_schema
]},
863 "vim_accounts": {"oneOf": [array_edition_schema
, nameshort_list_schema
]},
866 array_edition_schema
,
867 {"type": "array", "items": pdu_interface
, "minItems": 1},
871 "additionalProperties": False,
876 vnfpkgop_new_schema
= {
877 "title": "VNF PKG operation creation input schema",
878 "$schema": "http://json-schema.org/draft-04/schema#",
881 "lcmOperationType": string_schema
,
882 "vnfPkgId": id_schema
,
883 "kdu_name": name_schema
,
884 "primitive": name_schema
,
885 "primitive_params": {"type": "object"},
894 "additionalProperties": False,
898 project_role_mappings
= {
899 "title": "list pf projects/roles",
900 "$schema": "http://json-schema.org/draft-04/schema#",
904 "properties": {"project": shortname_schema
, "role": shortname_schema
},
905 "required": ["project", "role"],
906 "additionalProperties": False,
910 project_role_mappings_optional
= {
911 "title": "list of projects/roles or projects only",
912 "$schema": "http://json-schema.org/draft-04/schema#",
916 "properties": {"project": shortname_schema
, "role": shortname_schema
},
917 "required": ["project"],
918 "additionalProperties": False,
923 "$schema": "http://json-schema.org/draft-04/schema#",
924 "title": "New user schema",
927 "username": string_schema
,
928 "domain_name": shortname_schema
,
929 "password": passwd_schema
,
930 "projects": nameshort_list_schema
,
931 "project_role_mappings": project_role_mappings
,
933 "required": ["username", "password"],
934 "additionalProperties": False,
937 "$schema": "http://json-schema.org/draft-04/schema#",
938 "title": "User edit schema for administrators",
941 "password": passwd_schema
,
942 "old_password": passwd_schema
,
943 "username": string_schema
, # To allow User Name modification
944 "projects": {"oneOf": [nameshort_list_schema
, array_edition_schema
]},
945 "project_role_mappings": project_role_mappings
,
946 "add_project_role_mappings": project_role_mappings
,
947 "remove_project_role_mappings": project_role_mappings_optional
,
950 "additionalProperties": False,
954 topics_with_quota
= [
970 project_new_schema
= {
971 "$schema": "http://json-schema.org/draft-04/schema#",
972 "title": "New project schema for administrators",
975 "name": shortname_schema
,
976 "admin": bool_schema
,
977 "domain_name": shortname_schema
,
980 "properties": {topic
: integer0_schema
for topic
in topics_with_quota
},
981 "additionalProperties": False,
984 "required": ["name"],
985 "additionalProperties": False,
987 project_edit_schema
= {
988 "$schema": "http://json-schema.org/draft-04/schema#",
989 "title": "Project edit schema for administrators",
992 "admin": bool_schema
,
993 "name": shortname_schema
, # To allow Project Name modification
997 topic
: {"oneOf": [integer0_schema
, null_schema
]}
998 for topic
in topics_with_quota
1000 "additionalProperties": False,
1003 "additionalProperties": False,
1008 roles_new_schema
= {
1009 "$schema": "http://json-schema.org/draft-04/schema#",
1010 "title": "New role schema for administrators",
1013 "name": shortname_schema
,
1016 "patternProperties": {
1019 # "minProperties": 1,
1022 "required": ["name"],
1023 "additionalProperties": False,
1025 roles_edit_schema
= {
1026 "$schema": "http://json-schema.org/draft-04/schema#",
1027 "title": "Roles edit schema for administrators",
1030 "name": shortname_schema
,
1033 "patternProperties": {".": {"oneOf": [bool_schema
, null_schema
]}},
1034 # "minProperties": 1,
1037 "additionalProperties": False,
1043 nbi_new_input_schemas
= {
1044 "users": user_new_schema
,
1045 "projects": project_new_schema
,
1046 "vim_accounts": vim_account_new_schema
,
1047 "sdns": sdn_new_schema
,
1048 "ns_instantiate": ns_instantiate
,
1049 "ns_action": ns_action
,
1050 "ns_scale": ns_scale
,
1051 "pdus": pdu_new_schema
,
1054 nbi_edit_input_schemas
= {
1055 "users": user_edit_schema
,
1056 "projects": project_edit_schema
,
1057 "vim_accounts": vim_account_edit_schema
,
1058 "sdns": sdn_edit_schema
,
1059 "pdus": pdu_edit_schema
,
1063 nsi_subnet_instantiate
= deepcopy(ns_instantiate
)
1064 nsi_subnet_instantiate
["title"] = "netslice subnet instantiation params input schema"
1065 nsi_subnet_instantiate
["properties"]["id"] = name_schema
1066 del nsi_subnet_instantiate
["required"]
1068 nsi_vld_instantiate
= {
1069 "title": "netslice vld instantiation params input schema",
1070 "$schema": "http://json-schema.org/draft-04/schema#",
1073 "name": string_schema
,
1074 "vim-network-name": {"oneOf": [string_schema
, object_schema
]},
1075 "vim-network-id": {"oneOf": [string_schema
, object_schema
]},
1076 "ip-profile": object_schema
,
1078 "required": ["name"],
1079 "additionalProperties": False,
1083 "title": "netslice action instantiate input schema",
1084 "$schema": "http://json-schema.org/draft-04/schema#",
1087 "lcmOperationType": string_schema
,
1088 "netsliceInstanceId": id_schema
,
1089 "nsiName": name_schema
,
1090 "nsiDescription": {"oneOf": [description_schema
, null_schema
]},
1091 "nstId": string_schema
,
1092 "vimAccountId": id_schema
,
1093 "timeout_nsi_deploy": integer1_schema
,
1094 "ssh_keys": {"type": "array", "items": {"type": "string"}},
1095 "nsi_id": id_schema
,
1096 "additionalParamsForNsi": object_schema
,
1097 "netslice-subnet": {
1100 "items": nsi_subnet_instantiate
,
1102 "netslice-vld": {"type": "array", "minItems": 1, "items": nsi_vld_instantiate
},
1104 "required": ["nsiName", "nstId", "vimAccountId"],
1105 "additionalProperties": False,
1112 nsinstancesubscriptionfilter_schema
= {
1113 "title": "instance identifier schema",
1114 "$schema": "http://json-schema.org/draft-07/schema#",
1117 "nsdIds": {"type": "array"},
1118 "vnfdIds": {"type": "array"},
1119 "pnfdIds": {"type": "array"},
1120 "nsInstanceIds": {"type": "array"},
1121 "nsInstanceNames": {"type": "array"},
1126 "title": "nslcmsubscription input schema",
1127 "$schema": "http://json-schema.org/draft-07/schema#",
1130 "nsInstanceSubscriptionFilter": nsinstancesubscriptionfilter_schema
,
1131 "notificationTypes": {
1135 "NsLcmOperationOccurrenceNotification",
1136 "NsChangeNotification",
1137 "NsIdentifierCreationNotification",
1138 "NsIdentifierDeletionNotification",
1144 "items": {"enum": ["INSTANTIATE", "SCALE", "TERMINATE", "UPDATE", "HEAL"]},
1146 "operationStates": {
1152 "PARTIALLY_COMPLETED",
1160 "nsComponentTypes": {"type": "array", "items": {"enum": ["VNF", "NS", "PNF"]}},
1161 "lcmOpNameImpactingNsComponent": {
1167 "VNF_SCALE_TO_LEVEL",
1168 "VNF_CHANGE_FLAVOUR",
1172 "VNF_CHANGE_EXT_CONN",
1182 "lcmOpOccStatusImpactingNsComponent": {
1188 "PARTIALLY_COMPLETED",
1199 "notificationTypes": {
1200 "contains": {"const": "NsLcmOperationOccurrenceNotification"}
1206 {"required": ["operationTypes"]},
1207 {"required": ["operationStates"]},
1214 "notificationTypes": {"contains": {"const": "NsChangeNotification"}}
1219 {"required": ["nsComponentTypes"]},
1220 {"required": ["lcmOpNameImpactingNsComponent"]},
1221 {"required": ["lcmOpOccStatusImpactingNsComponent"]},
1228 authentication_schema
= {
1229 "title": "authentication schema for subscription",
1230 "$schema": "http://json-schema.org/draft-07/schema#",
1233 "authType": {"enum": ["basic"]},
1237 "userName": string_schema
,
1238 "password": passwd_schema
,
1245 "title": "subscription input schema",
1246 "$schema": "http://json-schema.org/draft-07/schema#",
1249 "filter": nslcmsub_schema
,
1250 "CallbackUri": description_schema
,
1251 "authentication": authentication_schema
,
1253 "required": ["CallbackUri"],
1257 class ValidationError(Exception):
1258 def __init__(self
, message
, http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
):
1259 self
.http_code
= http_code
1260 Exception.__init
__(self
, message
)
1263 def validate_input(indata
, schema_to_use
):
1265 Validates input data against json schema
1266 :param indata: user input data. Should be a dictionary
1267 :param schema_to_use: jsonschema to test
1268 :return: None if ok, raises ValidationError exception on error
1272 js_v(indata
, schema_to_use
)
1274 except js_e
.ValidationError
as e
:
1276 error_pos
= "at '" + ":".join(map(str, e
.path
)) + "'"
1279 raise ValidationError("Format error {} '{}' ".format(error_pos
, e
.message
))
1280 except js_e
.SchemaError
:
1281 raise ValidationError(
1282 "Bad json schema {}".format(schema_to_use
),
1283 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
,
1287 def is_valid_uuid(x
):
1289 Test for a valid UUID
1290 :param x: string to test
1291 :return: True if x is a valid uuid, False otherwise
1296 except (TypeError, ValueError, AttributeError):