| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | |
| tierno | d125caf | 2018-11-22 16:05:54 +0000 | [diff] [blame] | 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 |
| 6 | # |
| 7 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 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 |
| 12 | # implied. |
| 13 | # See the License for the specific language governing permissions and |
| 14 | # limitations under the License. |
| 15 | |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 16 | from jsonschema import validate as js_v, exceptions as js_e |
| tierno | 36ec860 | 2018-11-02 17:27:11 +0100 | [diff] [blame] | 17 | from http import HTTPStatus |
| garciadeblas | daf8cc5 | 2018-11-30 14:17:20 +0100 | [diff] [blame] | 18 | from copy import deepcopy |
| delacruzramo | c061f56 | 2019-04-05 11:00:02 +0200 | [diff] [blame] | 19 | from uuid import UUID # To test for valid UUID |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 20 | |
| 21 | __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>" |
| 22 | __version__ = "0.1" |
| 23 | version_date = "Mar 2018" |
| 24 | |
| 25 | """ |
| 26 | Validator of input data using JSON schemas for those items that not contains an OSM yang information model |
| 27 | """ |
| 28 | |
| 29 | # Basis schemas |
| 30 | patern_name = "^[ -~]+$" |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 31 | shortname_schema = {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()\\.\\$'\"]+$"} |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 32 | passwd_schema = {"type": "string", "minLength": 1, "maxLength": 60} |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 33 | name_schema = {"type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^,;()'\"]+$"} |
| tierno | 0da5225 | 2018-06-27 15:47:22 +0200 | [diff] [blame] | 34 | string_schema = {"type": "string", "minLength": 1, "maxLength": 255} |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 35 | xml_text_schema = {"type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[^']+$"} |
| 36 | description_schema = {"type": ["string", "null"], "maxLength": 255, "pattern": "^[^'\"]+$"} |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 37 | id_schema_fake = {"type": "string", "minLength": 2, "maxLength": 36} |
| 38 | bool_schema = {"type": "boolean"} |
| 39 | null_schema = {"type": "null"} |
| tierno | 2236d20 | 2018-05-16 19:05:16 +0200 | [diff] [blame] | 40 | # "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}$" |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 41 | id_schema = {"type": "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"} |
| tierno | f759d82 | 2018-06-11 18:54:54 +0200 | [diff] [blame] | 42 | time_schema = {"type": "string", "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}"} |
| tierno | 8700604 | 2018-10-24 12:50:20 +0200 | [diff] [blame] | 43 | pci_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\\.[0-9a-fA-F]$"} |
| tierno | 42fce59 | 2018-11-02 09:23:43 +0100 | [diff] [blame] | 44 | # allows [] for wildcards. For that reason huge length limit is set |
| 45 | pci_extended_schema = {"type": "string", "pattern": "^[0-9a-fA-F.:-\\[\\]]{12,40}$"} |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 46 | http_schema = {"type": "string", "pattern": "^https?://[^'\"=]+$"} |
| 47 | bandwidth_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"} |
| 48 | memory_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"} |
| 49 | integer0_schema = {"type": "integer", "minimum": 0} |
| 50 | integer1_schema = {"type": "integer", "minimum": 1} |
| tierno | 8700604 | 2018-10-24 12:50:20 +0200 | [diff] [blame] | 51 | path_schema = {"type": "string", "pattern": "^(\\.){0,2}(/[^/\"':{}\\(\\)]+)+$"} |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 52 | vlan_schema = {"type": "integer", "minimum": 1, "maximum": 4095} |
| 53 | vlan1000_schema = {"type": "integer", "minimum": 1000, "maximum": 4095} |
| 54 | mac_schema = {"type": "string", |
| 55 | "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"} # must be unicast: LSB bit of MSB byte ==0 |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 56 | dpid_Schema = {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"} |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 57 | # mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"} |
| 58 | ip_schema = {"type": "string", |
| tierno | 8700604 | 2018-10-24 12:50:20 +0200 | [diff] [blame] | 59 | "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]?)$"} |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 60 | ip_prefix_schema = {"type": "string", |
| tierno | 8700604 | 2018-10-24 12:50:20 +0200 | [diff] [blame] | 61 | "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}" |
| tierno | 2236d20 | 2018-05-16 19:05:16 +0200 | [diff] [blame] | 62 | "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$"} |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 63 | port_schema = {"type": "integer", "minimum": 1, "maximum": 65534} |
| 64 | object_schema = {"type": "object"} |
| 65 | schema_version_2 = {"type": "integer", "minimum": 2, "maximum": 2} |
| 66 | # schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]} |
| 67 | log_level_schema = {"type": "string", "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]} |
| 68 | checksum_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"} |
| 69 | size_schema = {"type": "integer", "minimum": 1, "maximum": 100} |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 70 | array_edition_schema = { |
| 71 | "type": "object", |
| 72 | "patternProperties": { |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 73 | "^\\$": {} |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 74 | }, |
| 75 | "additionalProperties": False, |
| 76 | "minProperties": 1, |
| 77 | } |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 78 | nameshort_list_schema = { |
| 79 | "type": "array", |
| 80 | "minItems": 1, |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 81 | "items": shortname_schema, |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 82 | } |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 83 | |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 84 | |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 85 | ns_instantiate_vdu = { |
| 86 | "title": "ns action instantiate input schema for vdu", |
| 87 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 88 | "type": "object", |
| 89 | "properties": { |
| 90 | "id": name_schema, |
| 91 | "volume": { |
| 92 | "type": "array", |
| 93 | "minItems": 1, |
| 94 | "items": { |
| 95 | "type": "object", |
| 96 | "properties": { |
| 97 | "name": name_schema, |
| 98 | "vim-volume-id": name_schema, |
| 99 | }, |
| 100 | "required": ["name", "vim-volume-id"], |
| 101 | "additionalProperties": False |
| 102 | } |
| 103 | }, |
| 104 | "interface": { |
| 105 | "type": "array", |
| 106 | "minItems": 1, |
| 107 | "items": { |
| 108 | "type": "object", |
| 109 | "properties": { |
| 110 | "name": name_schema, |
| 111 | "ip-address": ip_schema, |
| 112 | "mac-address": mac_schema, |
| 113 | "floating-ip-required": bool_schema, |
| 114 | }, |
| 115 | "required": ["name"], |
| 116 | "additionalProperties": False |
| 117 | } |
| 118 | } |
| 119 | }, |
| 120 | "required": ["id"], |
| 121 | "additionalProperties": False |
| 122 | } |
| 123 | |
| 124 | ip_profile_dns_schema = { |
| 125 | "type": "array", |
| 126 | "minItems": 1, |
| 127 | "items": { |
| 128 | "type": "object", |
| 129 | "properties": { |
| 130 | "address": ip_schema, |
| 131 | }, |
| 132 | "required": ["address"], |
| 133 | "additionalProperties": False |
| 134 | } |
| 135 | } |
| 136 | |
| 137 | ip_profile_dhcp_schema = { |
| 138 | "type": "object", |
| 139 | "properties": { |
| 140 | "enabled": {"type": "boolean"}, |
| 141 | "count": integer1_schema, |
| 142 | "start-address": ip_schema |
| 143 | }, |
| 144 | "additionalProperties": False, |
| 145 | } |
| 146 | |
| 147 | ip_profile_schema = { |
| 148 | "title": "ip profile validation schame", |
| 149 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 150 | "type": "object", |
| 151 | "properties": { |
| 152 | "ip-version": {"enum": ["ipv4", "ipv6"]}, |
| 153 | "subnet-address": ip_prefix_schema, |
| 154 | "gateway-address": ip_schema, |
| 155 | "dns-server": ip_profile_dns_schema, |
| 156 | "dhcp-params": ip_profile_dhcp_schema, |
| 157 | } |
| 158 | } |
| 159 | |
| 160 | ip_profile_update_schema = { |
| 161 | "title": "ip profile validation schame", |
| 162 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 163 | "type": "object", |
| 164 | "properties": { |
| 165 | "ip-version": {"enum": ["ipv4", "ipv6"]}, |
| 166 | "subnet-address": {"oneOf": [null_schema, ip_prefix_schema]}, |
| 167 | "gateway-address": {"oneOf": [null_schema, ip_schema]}, |
| 168 | "dns-server": {"oneOf": [null_schema, ip_profile_dns_schema]}, |
| 169 | |
| 170 | "dhcp-params": {"oneOf": [null_schema, ip_profile_dhcp_schema]}, |
| 171 | }, |
| 172 | "additionalProperties": False |
| 173 | } |
| 174 | |
| kbsub | 21f03f5 | 2019-10-17 16:26:56 +0000 | [diff] [blame] | 175 | provider_network_schema = { |
| 176 | "title": "provider network validation schame", |
| 177 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 178 | "type": "object", |
| 179 | "properties": { |
| 180 | "physical-network": name_schema, |
| 181 | "segmentation-id": name_schema, |
| 182 | }, |
| 183 | "additionalProperties": False |
| 184 | } |
| 185 | |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 186 | ns_instantiate_internal_vld = { |
| 187 | "title": "ns action instantiate input schema for vdu", |
| 188 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 189 | "type": "object", |
| 190 | "properties": { |
| 191 | "name": name_schema, |
| 192 | "vim-network-name": name_schema, |
| gcalvino | 17d5b73 | 2018-12-17 16:26:21 +0100 | [diff] [blame] | 193 | "vim-network-id": name_schema, |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 194 | "ip-profile": ip_profile_update_schema, |
| kbsub | 21f03f5 | 2019-10-17 16:26:56 +0000 | [diff] [blame] | 195 | "provider-network": provider_network_schema, |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 196 | "internal-connection-point": { |
| 197 | "type": "array", |
| 198 | "minItems": 1, |
| 199 | "items": { |
| 200 | "type": "object", |
| 201 | "properties": { |
| 202 | "id-ref": name_schema, |
| 203 | "ip-address": ip_schema, |
| tierno | b7c6f2a | 2018-09-03 14:32:10 +0200 | [diff] [blame] | 204 | # "mac-address": mac_schema, |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 205 | }, |
| tierno | b7c6f2a | 2018-09-03 14:32:10 +0200 | [diff] [blame] | 206 | "required": ["id-ref"], |
| 207 | "minProperties": 2, |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 208 | "additionalProperties": False |
| 209 | }, |
| 210 | } |
| 211 | }, |
| 212 | "required": ["name"], |
| 213 | "minProperties": 2, |
| 214 | "additionalProperties": False |
| 215 | } |
| tierno | 65acb4d | 2018-04-06 16:42:40 +0200 | [diff] [blame] | 216 | |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 217 | additional_params_for_vnf = { |
| 218 | "type": "array", |
| 219 | "items": { |
| 220 | "type": "object", |
| 221 | "properties": { |
| 222 | "member-vnf-index": name_schema, |
| 223 | "additionalParams": object_schema, |
| tierno | 714954e | 2019-11-29 13:43:26 +0000 | [diff] [blame] | 224 | "additionalParamsForVdu": { |
| 225 | "type": "array", |
| 226 | "items": { |
| 227 | "type": "object", |
| 228 | "properties": { |
| 229 | "vdu_id": name_schema, |
| 230 | "additionalParams": object_schema, |
| 231 | }, |
| 232 | "required": ["vdu_id", "additionalParams"], |
| 233 | "additionalProperties": False, |
| 234 | }, |
| 235 | }, |
| 236 | "additionalParamsForKdu": { |
| 237 | "type": "array", |
| 238 | "items": { |
| 239 | "type": "object", |
| 240 | "properties": { |
| 241 | "kdu_name": name_schema, |
| 242 | "additionalParams": object_schema, |
| 243 | }, |
| 244 | "required": ["kdu_name", "additionalParams"], |
| 245 | "additionalProperties": False, |
| 246 | }, |
| 247 | }, |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 248 | }, |
| tierno | 714954e | 2019-11-29 13:43:26 +0000 | [diff] [blame] | 249 | "required": ["member-vnf-index"], |
| 250 | "minProperties": 2, |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 251 | "additionalProperties": False |
| 252 | } |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 253 | } |
| 254 | |
| tierno | 65acb4d | 2018-04-06 16:42:40 +0200 | [diff] [blame] | 255 | ns_instantiate = { |
| 256 | "title": "ns action instantiate input schema", |
| 257 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 258 | "type": "object", |
| tierno | 0da5225 | 2018-06-27 15:47:22 +0200 | [diff] [blame] | 259 | "properties": { |
| tierno | b24258a | 2018-10-04 18:39:49 +0200 | [diff] [blame] | 260 | "lcmOperationType": string_schema, |
| 261 | "nsInstanceId": id_schema, |
| Felipe Vicens | 07f3172 | 2018-10-29 15:16:44 +0100 | [diff] [blame] | 262 | "netsliceInstanceId": id_schema, |
| tierno | 0da5225 | 2018-06-27 15:47:22 +0200 | [diff] [blame] | 263 | "nsName": name_schema, |
| tierno | 4f9d4ae | 2019-03-20 17:24:11 +0000 | [diff] [blame] | 264 | "nsDescription": {"oneOf": [description_schema, null_schema]}, |
| tierno | 0da5225 | 2018-06-27 15:47:22 +0200 | [diff] [blame] | 265 | "nsdId": id_schema, |
| 266 | "vimAccountId": id_schema, |
| tierno | 4f9d4ae | 2019-03-20 17:24:11 +0000 | [diff] [blame] | 267 | "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]}, |
| tierno | bee085c | 2018-12-12 17:03:04 +0000 | [diff] [blame] | 268 | "additionalParamsForNs": object_schema, |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 269 | "additionalParamsForVnf": additional_params_for_vnf, |
| tierno | fc5089c | 2018-10-31 09:28:11 +0100 | [diff] [blame] | 270 | "ssh_keys": {"type": "array", "items": {"type": "string"}}, |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 271 | "nsr_id": id_schema, |
| tierno | cc10343 | 2018-10-19 14:10:35 +0200 | [diff] [blame] | 272 | "vduImage": name_schema, |
| tierno | 0da5225 | 2018-06-27 15:47:22 +0200 | [diff] [blame] | 273 | "vnf": { |
| 274 | "type": "array", |
| 275 | "minItems": 1, |
| 276 | "items": { |
| 277 | "type": "object", |
| 278 | "properties": { |
| 279 | "member-vnf-index": name_schema, |
| 280 | "vimAccountId": id_schema, |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 281 | "vdu": { |
| 282 | "type": "array", |
| 283 | "minItems": 1, |
| 284 | "items": ns_instantiate_vdu, |
| 285 | }, |
| 286 | "internal-vld": { |
| 287 | "type": "array", |
| 288 | "minItems": 1, |
| 289 | "items": ns_instantiate_internal_vld |
| 290 | } |
| tierno | 0da5225 | 2018-06-27 15:47:22 +0200 | [diff] [blame] | 291 | }, |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 292 | "required": ["member-vnf-index"], |
| 293 | "minProperties": 2, |
| 294 | "additionalProperties": False |
| tierno | 0da5225 | 2018-06-27 15:47:22 +0200 | [diff] [blame] | 295 | } |
| 296 | }, |
| 297 | "vld": { |
| 298 | "type": "array", |
| 299 | "minItems": 1, |
| 300 | "items": { |
| 301 | "type": "object", |
| 302 | "properties": { |
| 303 | "name": string_schema, |
| 304 | "vim-network-name": {"OneOf": [string_schema, object_schema]}, |
| gcalvino | 17d5b73 | 2018-12-17 16:26:21 +0100 | [diff] [blame] | 305 | "vim-network-id": {"OneOf": [string_schema, object_schema]}, |
| Felipe Vicens | 09e6542 | 2019-01-22 15:06:46 +0100 | [diff] [blame] | 306 | "ns-net": object_schema, |
| tierno | 4f9d4ae | 2019-03-20 17:24:11 +0000 | [diff] [blame] | 307 | "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]}, |
| tierno | 0da5225 | 2018-06-27 15:47:22 +0200 | [diff] [blame] | 308 | "ip-profile": object_schema, |
| kbsub | 21f03f5 | 2019-10-17 16:26:56 +0000 | [diff] [blame] | 309 | "provider-network": provider_network_schema, |
| tierno | b7c6f2a | 2018-09-03 14:32:10 +0200 | [diff] [blame] | 310 | "vnfd-connection-point-ref": { |
| 311 | "type": "array", |
| 312 | "minItems": 1, |
| 313 | "items": { |
| 314 | "type": "object", |
| 315 | "properties": { |
| 316 | "member-vnf-index-ref": name_schema, |
| 317 | "vnfd-connection-point-ref": name_schema, |
| 318 | "ip-address": ip_schema, |
| 319 | # "mac-address": mac_schema, |
| 320 | }, |
| 321 | "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"], |
| 322 | "minProperties": 3, |
| 323 | "additionalProperties": False |
| 324 | }, |
| 325 | } |
| tierno | 0da5225 | 2018-06-27 15:47:22 +0200 | [diff] [blame] | 326 | }, |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 327 | "required": ["name"], |
| 328 | "additionalProperties": False |
| tierno | 0da5225 | 2018-06-27 15:47:22 +0200 | [diff] [blame] | 329 | } |
| 330 | }, |
| 331 | }, |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 332 | "required": ["nsName", "nsdId", "vimAccountId"], |
| 333 | "additionalProperties": False |
| tierno | 65acb4d | 2018-04-06 16:42:40 +0200 | [diff] [blame] | 334 | } |
| tierno | 0da5225 | 2018-06-27 15:47:22 +0200 | [diff] [blame] | 335 | |
| tierno | 65acb4d | 2018-04-06 16:42:40 +0200 | [diff] [blame] | 336 | ns_action = { # TODO for the moment it is only contemplated the vnfd primitive execution |
| tierno | f759d82 | 2018-06-11 18:54:54 +0200 | [diff] [blame] | 337 | "title": "ns action input schema", |
| tierno | 65acb4d | 2018-04-06 16:42:40 +0200 | [diff] [blame] | 338 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 339 | "type": "object", |
| 340 | "properties": { |
| tierno | b24258a | 2018-10-04 18:39:49 +0200 | [diff] [blame] | 341 | "lcmOperationType": string_schema, |
| 342 | "nsInstanceId": id_schema, |
| tierno | f5298be | 2018-05-16 14:43:57 +0200 | [diff] [blame] | 343 | "member_vnf_index": name_schema, |
| 344 | "vnf_member_index": name_schema, # TODO for backward compatibility. To remove in future |
| tierno | 7ce1db9 | 2018-07-25 12:50:52 +0200 | [diff] [blame] | 345 | "vdu_id": name_schema, |
| tierno | f063705 | 2019-03-07 16:26:47 +0000 | [diff] [blame] | 346 | "vdu_count_index": integer0_schema, |
| tierno | 9cb7d67 | 2019-10-30 12:13:48 +0000 | [diff] [blame] | 347 | "kdu_name": name_schema, |
| tierno | 65acb4d | 2018-04-06 16:42:40 +0200 | [diff] [blame] | 348 | "primitive": name_schema, |
| 349 | "primitive_params": {"type": "object"}, |
| 350 | }, |
| tierno | f5298be | 2018-05-16 14:43:57 +0200 | [diff] [blame] | 351 | "required": ["primitive", "primitive_params"], # TODO add member_vnf_index |
| tierno | 65acb4d | 2018-04-06 16:42:40 +0200 | [diff] [blame] | 352 | "additionalProperties": False |
| 353 | } |
| tierno | f759d82 | 2018-06-11 18:54:54 +0200 | [diff] [blame] | 354 | ns_scale = { # TODO for the moment it is only VDU-scaling |
| 355 | "title": "ns scale input schema", |
| 356 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 357 | "type": "object", |
| 358 | "properties": { |
| tierno | b24258a | 2018-10-04 18:39:49 +0200 | [diff] [blame] | 359 | "lcmOperationType": string_schema, |
| 360 | "nsInstanceId": id_schema, |
| tierno | f759d82 | 2018-06-11 18:54:54 +0200 | [diff] [blame] | 361 | "scaleType": {"enum": ["SCALE_VNF"]}, |
| 362 | "scaleVnfData": { |
| 363 | "type": "object", |
| 364 | "properties": { |
| 365 | "vnfInstanceId": name_schema, |
| 366 | "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']}, |
| 367 | "scaleByStepData": { |
| 368 | "type": "object", |
| 369 | "properties": { |
| 370 | "scaling-group-descriptor": name_schema, |
| 371 | "member-vnf-index": name_schema, |
| 372 | "scaling-policy": name_schema, |
| 373 | }, |
| 374 | "required": ["scaling-group-descriptor", "member-vnf-index"], |
| 375 | "additionalProperties": False |
| 376 | }, |
| 377 | }, |
| 378 | "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId |
| 379 | "additionalProperties": False |
| 380 | }, |
| 381 | "scaleTime": time_schema, |
| 382 | }, |
| 383 | "required": ["scaleType", "scaleVnfData"], |
| 384 | "additionalProperties": False |
| 385 | } |
| tierno | 65acb4d | 2018-04-06 16:42:40 +0200 | [diff] [blame] | 386 | |
| 387 | |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 388 | schema_version = {"type": "string", "enum": ["1.0"]} |
| tierno | 55ba2e6 | 2018-12-11 17:22:22 +0000 | [diff] [blame] | 389 | schema_type = {"type": "string"} |
| tierno | b3d0a0e | 2019-11-13 15:57:51 +0000 | [diff] [blame] | 390 | vim_type = shortname_schema # {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]} |
| delacruzramo | 3a144c9 | 2019-10-25 09:46:33 +0200 | [diff] [blame] | 391 | |
| tierno | 09c073e | 2018-04-26 13:36:48 +0200 | [diff] [blame] | 392 | vim_account_edit_schema = { |
| 393 | "title": "vim_account edit input schema", |
| 394 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 395 | "type": "object", |
| 396 | "properties": { |
| 397 | "name": name_schema, |
| 398 | "description": description_schema, |
| tierno | 09c073e | 2018-04-26 13:36:48 +0200 | [diff] [blame] | 399 | "vim": name_schema, |
| 400 | "datacenter": name_schema, |
| delacruzramo | 3a144c9 | 2019-10-25 09:46:33 +0200 | [diff] [blame] | 401 | "vim_type": vim_type, |
| tierno | 09c073e | 2018-04-26 13:36:48 +0200 | [diff] [blame] | 402 | "vim_url": description_schema, |
| delacruzramo | 3a144c9 | 2019-10-25 09:46:33 +0200 | [diff] [blame] | 403 | # "vim_url_admin": description_schema, |
| 404 | # "vim_tenant": name_schema, |
| tierno | 09c073e | 2018-04-26 13:36:48 +0200 | [diff] [blame] | 405 | "vim_tenant_name": name_schema, |
| delacruzramo | 3a144c9 | 2019-10-25 09:46:33 +0200 | [diff] [blame] | 406 | "vim_user": shortname_schema, |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 407 | "vim_password": passwd_schema, |
| tierno | 09c073e | 2018-04-26 13:36:48 +0200 | [diff] [blame] | 408 | "config": {"type": "object"} |
| 409 | }, |
| 410 | "additionalProperties": False |
| 411 | } |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 412 | |
| tierno | 09c073e | 2018-04-26 13:36:48 +0200 | [diff] [blame] | 413 | vim_account_new_schema = { |
| 414 | "title": "vim_account creation input schema", |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 415 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 416 | "type": "object", |
| 417 | "properties": { |
| 418 | "schema_version": schema_version, |
| 419 | "schema_type": schema_type, |
| 420 | "name": name_schema, |
| 421 | "description": description_schema, |
| tierno | 09c073e | 2018-04-26 13:36:48 +0200 | [diff] [blame] | 422 | "vim": name_schema, |
| 423 | "datacenter": name_schema, |
| delacruzramo | 3a144c9 | 2019-10-25 09:46:33 +0200 | [diff] [blame] | 424 | "vim_type": vim_type, |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 425 | "vim_url": description_schema, |
| 426 | # "vim_url_admin": description_schema, |
| 427 | # "vim_tenant": name_schema, |
| 428 | "vim_tenant_name": name_schema, |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 429 | "vim_user": shortname_schema, |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 430 | "vim_password": passwd_schema, |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 431 | "config": {"type": "object"} |
| 432 | }, |
| 433 | "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"], |
| 434 | "additionalProperties": False |
| 435 | } |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 436 | |
| tierno | b3d0a0e | 2019-11-13 15:57:51 +0000 | [diff] [blame] | 437 | wim_type = shortname_schema # {"enum": ["tapi", "onos", "odl", "dynpac", "fake"]} |
| delacruzramo | 3a144c9 | 2019-10-25 09:46:33 +0200 | [diff] [blame] | 438 | |
| tierno | 55ba2e6 | 2018-12-11 17:22:22 +0000 | [diff] [blame] | 439 | wim_account_edit_schema = { |
| 440 | "title": "wim_account edit input schema", |
| 441 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 442 | "type": "object", |
| 443 | "properties": { |
| 444 | "name": name_schema, |
| 445 | "description": description_schema, |
| tierno | 55ba2e6 | 2018-12-11 17:22:22 +0000 | [diff] [blame] | 446 | "wim": name_schema, |
| delacruzramo | 3a144c9 | 2019-10-25 09:46:33 +0200 | [diff] [blame] | 447 | "wim_type": wim_type, |
| tierno | 55ba2e6 | 2018-12-11 17:22:22 +0000 | [diff] [blame] | 448 | "wim_url": description_schema, |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 449 | "user": shortname_schema, |
| tierno | 55ba2e6 | 2018-12-11 17:22:22 +0000 | [diff] [blame] | 450 | "password": passwd_schema, |
| 451 | "config": {"type": "object"} |
| 452 | }, |
| 453 | "additionalProperties": False |
| 454 | } |
| 455 | |
| 456 | wim_account_new_schema = { |
| 457 | "title": "wim_account creation input schema", |
| 458 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 459 | "type": "object", |
| 460 | "properties": { |
| 461 | "schema_version": schema_version, |
| 462 | "schema_type": schema_type, |
| 463 | "name": name_schema, |
| 464 | "description": description_schema, |
| 465 | "wim": name_schema, |
| delacruzramo | 3a144c9 | 2019-10-25 09:46:33 +0200 | [diff] [blame] | 466 | "wim_type": wim_type, |
| tierno | 55ba2e6 | 2018-12-11 17:22:22 +0000 | [diff] [blame] | 467 | "wim_url": description_schema, |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 468 | "user": shortname_schema, |
| tierno | 55ba2e6 | 2018-12-11 17:22:22 +0000 | [diff] [blame] | 469 | "password": passwd_schema, |
| tierno | f063705 | 2019-03-07 16:26:47 +0000 | [diff] [blame] | 470 | "config": { |
| 471 | "type": "object", |
| 472 | "patternProperties": { |
| 473 | ".": {"not": {"type": "null"}} |
| 474 | } |
| 475 | } |
| tierno | 55ba2e6 | 2018-12-11 17:22:22 +0000 | [diff] [blame] | 476 | }, |
| 477 | "required": ["name", "wim_url", "wim_type"], |
| 478 | "additionalProperties": False |
| 479 | } |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 480 | |
| 481 | sdn_properties = { |
| 482 | "name": name_schema, |
| tierno | 7adaeb0 | 2019-12-17 16:46:12 +0000 | [diff] [blame^] | 483 | "type": {"type": "string"}, |
| 484 | "url": {"type": "string"}, |
| 485 | "user": shortname_schema, |
| 486 | "password": passwd_schema, |
| 487 | "config": {"type": "object"}, |
| tierno | cfb07c6 | 2018-05-10 18:30:51 +0200 | [diff] [blame] | 488 | "description": description_schema, |
| tierno | 7adaeb0 | 2019-12-17 16:46:12 +0000 | [diff] [blame^] | 489 | # The folowing are deprecated. Maintanied for backward compatibility |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 490 | "dpid": dpid_Schema, |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 491 | "ip": ip_schema, |
| 492 | "port": port_schema, |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 493 | "version": {"type": "string", "minLength": 1, "maxLength": 12}, |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 494 | } |
| 495 | sdn_new_schema = { |
| 496 | "title": "sdn controller information schema", |
| 497 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 498 | "type": "object", |
| 499 | "properties": sdn_properties, |
| tierno | 7adaeb0 | 2019-12-17 16:46:12 +0000 | [diff] [blame^] | 500 | "required": ["name", 'type'], |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 501 | "additionalProperties": False |
| 502 | } |
| 503 | sdn_edit_schema = { |
| 504 | "title": "sdn controller update information schema", |
| 505 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 506 | "type": "object", |
| 507 | "properties": sdn_properties, |
| tierno | cfb07c6 | 2018-05-10 18:30:51 +0200 | [diff] [blame] | 508 | # "required": ["name", "port", 'ip', 'dpid', 'type'], |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 509 | "additionalProperties": False |
| 510 | } |
| 511 | sdn_port_mapping_schema = { |
| 512 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 513 | "title": "sdn port mapping information schema", |
| 514 | "type": "array", |
| 515 | "items": { |
| 516 | "type": "object", |
| 517 | "properties": { |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 518 | "compute_node": shortname_schema, |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 519 | "ports": { |
| 520 | "type": "array", |
| 521 | "items": { |
| 522 | "type": "object", |
| 523 | "properties": { |
| tierno | 42fce59 | 2018-11-02 09:23:43 +0100 | [diff] [blame] | 524 | "pci": pci_extended_schema, |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 525 | "switch_port": shortname_schema, |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 526 | "switch_mac": mac_schema |
| 527 | }, |
| 528 | "required": ["pci"] |
| 529 | } |
| 530 | } |
| 531 | }, |
| 532 | "required": ["compute_node", "ports"] |
| 533 | } |
| 534 | } |
| 535 | sdn_external_port_schema = { |
| 536 | "$schema": "http://json-schema.org/draft-04/schema#", |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 537 | "title": "External port information", |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 538 | "type": "object", |
| 539 | "properties": { |
| 540 | "port": {"type": "string", "minLength": 1, "maxLength": 60}, |
| 541 | "vlan": vlan_schema, |
| 542 | "mac": mac_schema |
| 543 | }, |
| 544 | "required": ["port"] |
| 545 | } |
| 546 | |
| delacruzramo | fe598fe | 2019-10-23 18:25:11 +0200 | [diff] [blame] | 547 | # K8s Clusters |
| 548 | k8scluster_nets_schema = { |
| 549 | "title": "k8scluster nets input schema", |
| 550 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 551 | "type": "object", |
| tierno | c67b0e9 | 2019-11-05 12:45:29 +0000 | [diff] [blame] | 552 | "patternProperties": {".": {"oneOf": [description_schema, null_schema]}}, |
| delacruzramo | fe598fe | 2019-10-23 18:25:11 +0200 | [diff] [blame] | 553 | "minProperties": 1, |
| 554 | "additionalProperties": False |
| 555 | } |
| 556 | k8scluster_new_schema = { |
| 557 | "title": "k8scluster creation input schema", |
| 558 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 559 | "type": "object", |
| 560 | "properties": { |
| 561 | "schema_version": schema_version, |
| 562 | "schema_type": schema_type, |
| 563 | "name": name_schema, |
| 564 | "description": description_schema, |
| 565 | "credentials": object_schema, |
| 566 | "vim_account": id_schema, |
| 567 | "k8s_version": string_schema, |
| 568 | "nets": k8scluster_nets_schema, |
| 569 | "namespace": name_schema, |
| 570 | "cni": nameshort_list_schema, |
| 571 | }, |
| 572 | "required": ["name", "credentials", "vim_account", "k8s_version", "nets"], |
| 573 | "additionalProperties": False |
| 574 | } |
| 575 | k8scluster_edit_schema = { |
| 576 | "title": "vim_account edit input schema", |
| 577 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 578 | "type": "object", |
| 579 | "properties": { |
| 580 | "name": name_schema, |
| 581 | "description": description_schema, |
| 582 | "credentials": object_schema, |
| 583 | "vim_account": id_schema, |
| 584 | "k8s_version": string_schema, |
| 585 | "nets": k8scluster_nets_schema, |
| 586 | "namespace": name_schema, |
| 587 | "cni": nameshort_list_schema, |
| 588 | }, |
| 589 | "additionalProperties": False |
| 590 | } |
| 591 | |
| 592 | # K8s Repos |
| tierno | 332e080 | 2019-12-03 23:50:49 +0000 | [diff] [blame] | 593 | k8srepo_types = {"enum": ["helm-chart", "juju-bundle"]} |
| delacruzramo | fe598fe | 2019-10-23 18:25:11 +0200 | [diff] [blame] | 594 | k8srepo_properties = { |
| 595 | "name": name_schema, |
| 596 | "description": description_schema, |
| 597 | "type": k8srepo_types, |
| 598 | "url": description_schema, |
| 599 | } |
| 600 | k8srepo_new_schema = { |
| 601 | "title": "k8scluster creation input schema", |
| 602 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 603 | "type": "object", |
| 604 | "properties": k8srepo_properties, |
| 605 | "required": ["name", "type", "url"], |
| 606 | "additionalProperties": False |
| 607 | } |
| 608 | k8srepo_edit_schema = { |
| 609 | "title": "vim_account edit input schema", |
| 610 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 611 | "type": "object", |
| 612 | "properties": k8srepo_properties, |
| 613 | "additionalProperties": False |
| 614 | } |
| 615 | |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 616 | # PDUs |
| 617 | pdu_interface = { |
| 618 | "type": "object", |
| 619 | "properties": { |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 620 | "name": shortname_schema, |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 621 | "mgmt": bool_schema, |
| 622 | "type": {"enum": ["overlay", 'underlay']}, |
| tierno | 36ec860 | 2018-11-02 17:27:11 +0100 | [diff] [blame] | 623 | "ip-address": ip_schema, |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 624 | # TODO, add user, password, ssh-key |
| tierno | 36ec860 | 2018-11-02 17:27:11 +0100 | [diff] [blame] | 625 | "mac-address": mac_schema, |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 626 | "vim-network-name": shortname_schema, # interface is connected to one vim network, or switch port |
| 627 | "vim-network-id": shortname_schema, |
| tierno | 36ec860 | 2018-11-02 17:27:11 +0100 | [diff] [blame] | 628 | # # provide this in case SDN assist must deal with this interface |
| 629 | # "switch-dpid": dpid_Schema, |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 630 | # "switch-port": shortname_schema, |
| 631 | # "switch-mac": shortname_schema, |
| tierno | 36ec860 | 2018-11-02 17:27:11 +0100 | [diff] [blame] | 632 | # "switch-vlan": vlan_schema, |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 633 | }, |
| tierno | 36ec860 | 2018-11-02 17:27:11 +0100 | [diff] [blame] | 634 | "required": ["name", "mgmt", "ip-address"], |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 635 | "additionalProperties": False |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 636 | } |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 637 | pdu_new_schema = { |
| 638 | "title": "pdu creation input schema", |
| 639 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 640 | "type": "object", |
| 641 | "properties": { |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 642 | "name": shortname_schema, |
| 643 | "type": shortname_schema, |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 644 | "description": description_schema, |
| 645 | "shared": bool_schema, |
| 646 | "vims": nameshort_list_schema, |
| 647 | "vim_accounts": nameshort_list_schema, |
| 648 | "interfaces": { |
| 649 | "type": "array", |
| tierno | 36ec860 | 2018-11-02 17:27:11 +0100 | [diff] [blame] | 650 | "items": pdu_interface, |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 651 | "minItems": 1 |
| 652 | } |
| 653 | }, |
| 654 | "required": ["name", "type", "interfaces"], |
| 655 | "additionalProperties": False |
| 656 | } |
| 657 | |
| 658 | pdu_edit_schema = { |
| 659 | "title": "pdu edit input schema", |
| 660 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 661 | "type": "object", |
| 662 | "properties": { |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 663 | "name": shortname_schema, |
| 664 | "type": shortname_schema, |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 665 | "description": description_schema, |
| 666 | "shared": bool_schema, |
| garciadeblas | 84bdd55 | 2018-11-30 22:59:45 +0100 | [diff] [blame] | 667 | "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]}, |
| 668 | "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]}, |
| 669 | "interfaces": {"oneOf": [ |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 670 | array_edition_schema, |
| 671 | { |
| 672 | "type": "array", |
| tierno | 36ec860 | 2018-11-02 17:27:11 +0100 | [diff] [blame] | 673 | "items": pdu_interface, |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 674 | "minItems": 1 |
| 675 | } |
| 676 | ]} |
| 677 | }, |
| 678 | "additionalProperties": False, |
| 679 | "minProperties": 1 |
| 680 | } |
| 681 | |
| 682 | # USERS |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 683 | project_role_mappings = { |
| 684 | "title": "list pf projects/roles", |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 685 | "$schema": "http://json-schema.org/draft-04/schema#", |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 686 | "type": "array", |
| 687 | "items": { |
| 688 | "type": "object", |
| 689 | "properties": { |
| 690 | "project": shortname_schema, |
| 691 | "role": shortname_schema |
| 692 | }, |
| 693 | "required": ["project", "role"], |
| 694 | "additionalProperties": False |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 695 | }, |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 696 | "minItems": 1 |
| 697 | } |
| 698 | project_role_mappings_optional = { |
| 699 | "title": "list of projects/roles or projects only", |
| 700 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 701 | "type": "array", |
| 702 | "items": { |
| 703 | "type": "object", |
| 704 | "properties": { |
| 705 | "project": shortname_schema, |
| 706 | "role": shortname_schema |
| 707 | }, |
| 708 | "required": ["project"], |
| 709 | "additionalProperties": False |
| 710 | }, |
| 711 | "minItems": 1 |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 712 | } |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 713 | user_new_schema = { |
| 714 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 715 | "title": "New user schema", |
| 716 | "type": "object", |
| 717 | "properties": { |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 718 | "username": shortname_schema, |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 719 | "password": passwd_schema, |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 720 | "projects": nameshort_list_schema, |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 721 | "project_role_mappings": project_role_mappings, |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 722 | }, |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 723 | "required": ["username", "password"], |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 724 | "additionalProperties": False |
| 725 | } |
| 726 | user_edit_schema = { |
| 727 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 728 | "title": "User edit schema for administrators", |
| 729 | "type": "object", |
| 730 | "properties": { |
| 731 | "password": passwd_schema, |
| delacruzramo | c061f56 | 2019-04-05 11:00:02 +0200 | [diff] [blame] | 732 | "username": shortname_schema, # To allow User Name modification |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 733 | "projects": { |
| garciadeblas | 84bdd55 | 2018-11-30 22:59:45 +0100 | [diff] [blame] | 734 | "oneOf": [ |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 735 | nameshort_list_schema, |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 736 | array_edition_schema |
| 737 | ] |
| 738 | }, |
| tierno | cf042d3 | 2019-06-13 09:06:40 +0000 | [diff] [blame] | 739 | "project_role_mappings": project_role_mappings, |
| 740 | "add_project_role_mappings": project_role_mappings, |
| 741 | "remove_project_role_mappings": project_role_mappings_optional, |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 742 | }, |
| 743 | "minProperties": 1, |
| 744 | "additionalProperties": False |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 745 | } |
| 746 | |
| 747 | # PROJECTS |
| delacruzramo | fe598fe | 2019-10-23 18:25:11 +0200 | [diff] [blame] | 748 | topics_with_quota = ["vnfds", "nsds", "nsts", "pdus", "nsrs", "nsis", "vim_accounts", "wim_accounts", "sdns", |
| 749 | "k8sclusters", "k8srepos"] |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 750 | project_new_schema = { |
| 751 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 752 | "title": "New project schema for administrators", |
| 753 | "type": "object", |
| 754 | "properties": { |
| tierno | fd16057 | 2019-01-21 10:41:37 +0000 | [diff] [blame] | 755 | "name": shortname_schema, |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 756 | "admin": bool_schema, |
| delacruzramo | 32bab47 | 2019-09-13 12:24:22 +0200 | [diff] [blame] | 757 | "quotas": { |
| 758 | "type": "object", |
| 759 | "properties": {topic: integer0_schema for topic in topics_with_quota}, |
| 760 | "additionalProperties": False |
| 761 | }, |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 762 | }, |
| 763 | "required": ["name"], |
| 764 | "additionalProperties": False |
| 765 | } |
| 766 | project_edit_schema = { |
| 767 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 768 | "title": "Project edit schema for administrators", |
| 769 | "type": "object", |
| 770 | "properties": { |
| 771 | "admin": bool_schema, |
| delacruzramo | c061f56 | 2019-04-05 11:00:02 +0200 | [diff] [blame] | 772 | "name": shortname_schema, # To allow Project Name modification |
| delacruzramo | 32bab47 | 2019-09-13 12:24:22 +0200 | [diff] [blame] | 773 | "quotas": { |
| 774 | "type": "object", |
| 775 | "properties": {topic: {"oneOf": [integer0_schema, null_schema]} for topic in topics_with_quota}, |
| 776 | "additionalProperties": False |
| 777 | }, |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 778 | }, |
| 779 | "additionalProperties": False, |
| 780 | "minProperties": 1 |
| 781 | } |
| 782 | |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 783 | # ROLES |
| 784 | roles_new_schema = { |
| 785 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 786 | "title": "New role schema for administrators", |
| 787 | "type": "object", |
| 788 | "properties": { |
| 789 | "name": shortname_schema, |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 790 | "permissions": { |
| 791 | "type": "object", |
| 792 | "patternProperties": { |
| 793 | ".": bool_schema, |
| 794 | }, |
| 795 | # "minProperties": 1, |
| 796 | } |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 797 | }, |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 798 | "required": ["name"], |
| 799 | "additionalProperties": False |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 800 | } |
| 801 | roles_edit_schema = { |
| 802 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 803 | "title": "Roles edit schema for administrators", |
| 804 | "type": "object", |
| 805 | "properties": { |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 806 | "name": shortname_schema, |
| 807 | "permissions": { |
| 808 | "type": "object", |
| 809 | "patternProperties": { |
| 810 | ".": { |
| 811 | "oneOf": [bool_schema, null_schema] |
| 812 | } |
| 813 | }, |
| 814 | # "minProperties": 1, |
| 815 | } |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 816 | }, |
| tierno | 1f029d8 | 2019-06-13 22:37:04 +0000 | [diff] [blame] | 817 | "additionalProperties": False, |
| Eduardo Sousa | 5c01e19 | 2019-05-08 02:35:47 +0100 | [diff] [blame] | 818 | "minProperties": 1 |
| 819 | } |
| 820 | |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 821 | # GLOBAL SCHEMAS |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 822 | |
| 823 | nbi_new_input_schemas = { |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 824 | "users": user_new_schema, |
| 825 | "projects": project_new_schema, |
| tierno | 09c073e | 2018-04-26 13:36:48 +0200 | [diff] [blame] | 826 | "vim_accounts": vim_account_new_schema, |
| tierno | 65acb4d | 2018-04-06 16:42:40 +0200 | [diff] [blame] | 827 | "sdns": sdn_new_schema, |
| 828 | "ns_instantiate": ns_instantiate, |
| 829 | "ns_action": ns_action, |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 830 | "ns_scale": ns_scale, |
| 831 | "pdus": pdu_new_schema, |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 832 | } |
| 833 | |
| 834 | nbi_edit_input_schemas = { |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 835 | "users": user_edit_schema, |
| 836 | "projects": project_edit_schema, |
| tierno | 09c073e | 2018-04-26 13:36:48 +0200 | [diff] [blame] | 837 | "vim_accounts": vim_account_edit_schema, |
| tierno | cb83c94 | 2018-09-24 17:28:13 +0200 | [diff] [blame] | 838 | "sdns": sdn_edit_schema, |
| 839 | "pdus": pdu_edit_schema, |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 840 | } |
| 841 | |
| Felipe Vicens | 07f3172 | 2018-10-29 15:16:44 +0100 | [diff] [blame] | 842 | # NETSLICE SCHEMAS |
| tierno | 032916c | 2019-03-22 13:27:12 +0000 | [diff] [blame] | 843 | nsi_subnet_instantiate = deepcopy(ns_instantiate) |
| 844 | nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema" |
| 845 | nsi_subnet_instantiate["properties"]["id"] = name_schema |
| 846 | del nsi_subnet_instantiate["required"] |
| garciadeblas | daf8cc5 | 2018-11-30 14:17:20 +0100 | [diff] [blame] | 847 | |
| 848 | nsi_vld_instantiate = { |
| 849 | "title": "netslice vld instantiation params input schema", |
| 850 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 851 | "type": "object", |
| 852 | "properties": { |
| 853 | "name": string_schema, |
| 854 | "vim-network-name": {"OneOf": [string_schema, object_schema]}, |
| gcalvino | 17d5b73 | 2018-12-17 16:26:21 +0100 | [diff] [blame] | 855 | "vim-network-id": {"OneOf": [string_schema, object_schema]}, |
| garciadeblas | daf8cc5 | 2018-11-30 14:17:20 +0100 | [diff] [blame] | 856 | "ip-profile": object_schema, |
| 857 | }, |
| delacruzramo | c061f56 | 2019-04-05 11:00:02 +0200 | [diff] [blame] | 858 | "required": ["name"], |
| garciadeblas | daf8cc5 | 2018-11-30 14:17:20 +0100 | [diff] [blame] | 859 | "additionalProperties": False |
| 860 | } |
| 861 | |
| Felipe Vicens | 07f3172 | 2018-10-29 15:16:44 +0100 | [diff] [blame] | 862 | nsi_instantiate = { |
| 863 | "title": "netslice action instantiate input schema", |
| 864 | "$schema": "http://json-schema.org/draft-04/schema#", |
| 865 | "type": "object", |
| 866 | "properties": { |
| 867 | "lcmOperationType": string_schema, |
| Felipe Vicens | 126af57 | 2019-06-05 19:13:04 +0200 | [diff] [blame] | 868 | "netsliceInstanceId": id_schema, |
| Felipe Vicens | 07f3172 | 2018-10-29 15:16:44 +0100 | [diff] [blame] | 869 | "nsiName": name_schema, |
| tierno | 4f9d4ae | 2019-03-20 17:24:11 +0000 | [diff] [blame] | 870 | "nsiDescription": {"oneOf": [description_schema, null_schema]}, |
| tierno | 9e5eea3 | 2018-11-29 09:42:09 +0000 | [diff] [blame] | 871 | "nstId": string_schema, |
| Felipe Vicens | 07f3172 | 2018-10-29 15:16:44 +0100 | [diff] [blame] | 872 | "vimAccountId": id_schema, |
| 873 | "ssh_keys": {"type": "string"}, |
| 874 | "nsi_id": id_schema, |
| tierno | 032916c | 2019-03-22 13:27:12 +0000 | [diff] [blame] | 875 | "additionalParamsForNsi": object_schema, |
| garciadeblas | daf8cc5 | 2018-11-30 14:17:20 +0100 | [diff] [blame] | 876 | "netslice-subnet": { |
| Felipe Vicens | 07f3172 | 2018-10-29 15:16:44 +0100 | [diff] [blame] | 877 | "type": "array", |
| 878 | "minItems": 1, |
| tierno | 032916c | 2019-03-22 13:27:12 +0000 | [diff] [blame] | 879 | "items": nsi_subnet_instantiate |
| garciadeblas | daf8cc5 | 2018-11-30 14:17:20 +0100 | [diff] [blame] | 880 | }, |
| 881 | "netslice-vld": { |
| 882 | "type": "array", |
| 883 | "minItems": 1, |
| 884 | "items": nsi_vld_instantiate |
| Felipe Vicens | 07f3172 | 2018-10-29 15:16:44 +0100 | [diff] [blame] | 885 | }, |
| 886 | }, |
| Felipe Vicens | c8bbaaa | 2018-12-01 04:42:40 +0100 | [diff] [blame] | 887 | "required": ["nsiName", "nstId", "vimAccountId"], |
| Felipe Vicens | 07f3172 | 2018-10-29 15:16:44 +0100 | [diff] [blame] | 888 | "additionalProperties": False |
| 889 | } |
| 890 | |
| 891 | nsi_action = { |
| 892 | |
| 893 | } |
| 894 | |
| 895 | nsi_terminate = { |
| delacruzramo | c061f56 | 2019-04-05 11:00:02 +0200 | [diff] [blame] | 896 | |
| Felipe Vicens | 07f3172 | 2018-10-29 15:16:44 +0100 | [diff] [blame] | 897 | } |
| 898 | |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 899 | |
| 900 | class ValidationError(Exception): |
| tierno | 36ec860 | 2018-11-02 17:27:11 +0100 | [diff] [blame] | 901 | def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY): |
| 902 | self.http_code = http_code |
| 903 | Exception.__init__(self, message) |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 904 | |
| 905 | |
| tierno | b24258a | 2018-10-04 18:39:49 +0200 | [diff] [blame] | 906 | def validate_input(indata, schema_to_use): |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 907 | """ |
| tierno | cd54a4a | 2018-09-12 16:40:35 +0200 | [diff] [blame] | 908 | Validates input data against json schema |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 909 | :param indata: user input data. Should be a dictionary |
| tierno | b24258a | 2018-10-04 18:39:49 +0200 | [diff] [blame] | 910 | :param schema_to_use: jsonschema to test |
| 911 | :return: None if ok, raises ValidationError exception on error |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 912 | """ |
| 913 | try: |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 914 | if schema_to_use: |
| 915 | js_v(indata, schema_to_use) |
| 916 | return None |
| 917 | except js_e.ValidationError as e: |
| 918 | if e.path: |
| tierno | 0da5225 | 2018-06-27 15:47:22 +0200 | [diff] [blame] | 919 | error_pos = "at '" + ":".join(map(str, e.path)) + "'" |
| tierno | 0f98af5 | 2018-03-19 10:28:22 +0100 | [diff] [blame] | 920 | else: |
| 921 | error_pos = "" |
| tierno | 441dbbf | 2018-07-10 12:52:48 +0200 | [diff] [blame] | 922 | raise ValidationError("Format error {} '{}' ".format(error_pos, e.message)) |
| tierno | 36ec860 | 2018-11-02 17:27:11 +0100 | [diff] [blame] | 923 | except js_e.SchemaError: |
| 924 | raise ValidationError("Bad json schema {}".format(schema_to_use), http_code=HTTPStatus.INTERNAL_SERVER_ERROR) |
| delacruzramo | c061f56 | 2019-04-05 11:00:02 +0200 | [diff] [blame] | 925 | |
| 926 | |
| 927 | def is_valid_uuid(x): |
| 928 | """ |
| 929 | Test for a valid UUID |
| 930 | :param x: string to test |
| 931 | :return: True if x is a valid uuid, False otherwise |
| 932 | """ |
| 933 | try: |
| 934 | if UUID(x): |
| 935 | return True |
| tierno | bdebce9 | 2019-07-01 15:36:49 +0000 | [diff] [blame] | 936 | except (TypeError, ValueError, AttributeError): |
| delacruzramo | c061f56 | 2019-04-05 11:00:02 +0200 | [diff] [blame] | 937 | return False |