| # Copyright 2018 Telefonica |
| # |
| # All Rights Reserved. |
| # |
| # Licensed under the Apache License, Version 2.0 (the "License"); you may |
| # not use this file except in compliance with the License. You may obtain |
| # a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| # License for the specific language governing permissions and limitations |
| # under the License. |
| |
| """ |
| OSM wim API handling |
| """ |
| |
| from osmclient.common import utils |
| from osmclient.common import wait as WaitForStatus |
| from osmclient.common.exceptions import ClientException |
| from osmclient.common.exceptions import NotFound |
| import yaml |
| import json |
| import logging |
| |
| |
| class Wim(object): |
| def __init__(self, http=None, client=None): |
| self._http = http |
| self._client = client |
| self._logger = logging.getLogger("osmclient") |
| self._apiName = "/admin" |
| self._apiVersion = "/v1" |
| self._apiResource = "/wim_accounts" |
| self._apiBase = "{}{}{}".format( |
| self._apiName, self._apiVersion, self._apiResource |
| ) |
| |
| # WIM '--wait' option |
| def _wait(self, id, wait_time, deleteFlag=False): |
| self._logger.debug("") |
| self._client.get_token() |
| # Endpoint to get operation status |
| apiUrlStatus = "{}{}{}".format(self._apiName, self._apiVersion, "/wim_accounts") |
| # Wait for status for WIM instance creation/deletion |
| if isinstance(wait_time, bool): |
| wait_time = WaitForStatus.TIMEOUT_WIM_OPERATION |
| WaitForStatus.wait_for_status( |
| "WIM", |
| str(id), |
| wait_time, |
| apiUrlStatus, |
| self._http.get2_cmd, |
| deleteFlag=deleteFlag, |
| ) |
| |
| def _get_id_for_wait(self, name): |
| """Returns id of name, or the id itself if given as argument""" |
| self._logger.debug("") |
| for wim in self.list(): |
| if name == wim["uuid"]: |
| return wim["uuid"] |
| for wim in self.list(): |
| if name == wim["name"]: |
| return wim["uuid"] |
| return "" |
| |
| def create(self, name, wim_input, wim_port_mapping=None, wait=False): |
| self._logger.debug("") |
| self._client.get_token() |
| if "wim_type" not in wim_input: |
| raise Exception("wim type not provided") |
| |
| wim_account = wim_input |
| wim_account["name"] = name |
| |
| wim_config = {} |
| if "config" in wim_input and wim_input["config"] is not None: |
| wim_config = yaml.safe_load(wim_input["config"]) |
| if wim_port_mapping: |
| with open(wim_port_mapping, "r") as f: |
| wim_config["wim_port_mapping"] = yaml.safe_load(f.read()) |
| if wim_config: |
| wim_account["config"] = wim_config |
| # wim_account['config'] = json.dumps(wim_config) |
| |
| http_code, resp = self._http.post_cmd( |
| endpoint=self._apiBase, postfields_dict=wim_account |
| ) |
| # print('HTTP CODE: {}'.format(http_code)) |
| # print('RESP: {}'.format(resp)) |
| # if http_code in (200, 201, 202, 204): |
| if resp: |
| resp = json.loads(resp) |
| if not resp or "id" not in resp: |
| raise ClientException("unexpected response from server - {}".format(resp)) |
| if wait: |
| # Wait for status for WIM instance creation |
| self._wait(resp.get("id"), wait) |
| print(resp["id"]) |
| # else: |
| # msg = "" |
| # if resp: |
| # try: |
| # msg = json.loads(resp) |
| # except ValueError: |
| # msg = resp |
| # raise ClientException("failed to create wim {} - {}".format(name, msg)) |
| |
| def update(self, wim_name, wim_account, wim_port_mapping=None, wait=False): |
| self._logger.debug("") |
| self._client.get_token() |
| wim = self.get(wim_name) |
| wim_id_for_wait = self._get_id_for_wait(wim_name) |
| wim_config = {} |
| if "config" in wim_account: |
| if wim_account.get("config") == "" and (wim_port_mapping): |
| raise ClientException( |
| "clearing config is incompatible with updating SDN info" |
| ) |
| if wim_account.get("config") == "": |
| wim_config = None |
| else: |
| wim_config = yaml.safe_load(wim_account["config"]) |
| if wim_port_mapping: |
| with open(wim_port_mapping, "r") as f: |
| wim_config["wim_port_mapping"] = yaml.safe_load(f.read()) |
| wim_account["config"] = wim_config |
| # wim_account['config'] = json.dumps(wim_config) |
| http_code, resp = self._http.patch_cmd( |
| endpoint="{}/{}".format(self._apiBase, wim["_id"]), |
| postfields_dict=wim_account, |
| ) |
| # print('HTTP CODE: {}'.format(http_code)) |
| # print('RESP: {}'.format(resp)) |
| # if http_code in (200, 201, 202, 204): |
| if wait: |
| # In this case, 'resp' always returns None, so 'resp['id']' cannot be used. |
| # Use the previously obtained id instead. |
| wait_id = wim_id_for_wait |
| # Wait for status for WIM instance update |
| self._wait(wait_id, wait) |
| # else: |
| # pass |
| # else: |
| # msg = "" |
| # if resp: |
| # try: |
| # msg = json.loads(resp) |
| # except ValueError: |
| # msg = resp |
| # raise ClientException("failed to update wim {} - {}".format(wim_name, msg)) |
| |
| def update_wim_account_dict(self, wim_account, wim_input): |
| self._logger.debug("") |
| self._logger.debug(str(wim_input)) |
| wim_account["wim_type"] = wim_input["wim_type"] |
| wim_account["description"] = wim_input["description"] |
| wim_account["wim_url"] = wim_input["url"] |
| wim_account["user"] = wim_input.get("wim-username") |
| wim_account["password"] = wim_input.get("wim-password") |
| return wim_account |
| |
| def get_id(self, name): |
| """Returns a WIM id from a WIM name""" |
| self._logger.debug("") |
| for wim in self.list(): |
| if name == wim["name"]: |
| return wim["uuid"] |
| raise NotFound("wim {} not found".format(name)) |
| |
| def delete(self, wim_name, force=False, wait=False): |
| self._logger.debug("") |
| self._client.get_token() |
| wim_id = wim_name |
| wim_id_for_wait = self._get_id_for_wait(wim_name) |
| if not utils.validate_uuid4(wim_name): |
| wim_id = self.get_id(wim_name) |
| querystring = "" |
| if force: |
| querystring = "?FORCE=True" |
| http_code, resp = self._http.delete_cmd( |
| "{}/{}{}".format(self._apiBase, wim_id, querystring) |
| ) |
| # print('HTTP CODE: {}'.format(http_code)) |
| # print('RESP: {}'.format(resp)) |
| # print('WIM_ID: {}'.format(wim_id)) |
| if http_code == 202: |
| if wait: |
| # 'resp' may be None. |
| # In that case, 'resp['id']' cannot be used, so use the previously obtained id instead |
| wait_id = wim_id_for_wait |
| if resp: |
| resp = json.loads(resp) |
| wait_id = resp.get("id") |
| # Wait for status for WIM account deletion |
| self._wait(wait_id, wait, deleteFlag=True) |
| else: |
| print("Deletion in progress") |
| elif http_code == 204: |
| print("Deleted") |
| else: |
| msg = resp or "" |
| # if resp: |
| # try: |
| # msg = json.loads(resp) |
| # except ValueError: |
| # msg = resp |
| raise ClientException("failed to delete wim {} - {}".format(wim_name, msg)) |
| |
| def list(self, filter=None): |
| """Returns a list of VIM accounts""" |
| self._logger.debug("") |
| self._client.get_token() |
| filter_string = "" |
| if filter: |
| filter_string = "?{}".format(filter) |
| _, resp = self._http.get2_cmd("{}{}".format(self._apiBase, filter_string)) |
| if not resp: |
| return list() |
| wim_accounts = [] |
| for datacenter in json.loads(resp): |
| wim_accounts.append( |
| { |
| "name": datacenter["name"], |
| "uuid": datacenter["_id"] if "_id" in datacenter else None, |
| } |
| ) |
| return wim_accounts |
| |
| def get(self, name): |
| """Returns a VIM account based on name or id""" |
| self._logger.debug("") |
| self._client.get_token() |
| wim_id = name |
| if not utils.validate_uuid4(name): |
| wim_id = self.get_id(name) |
| try: |
| _, resp = self._http.get2_cmd("{}/{}".format(self._apiBase, wim_id)) |
| if resp: |
| resp = json.loads(resp) |
| if not resp or "_id" not in resp: |
| raise ClientException("failed to get wim info: {}".format(resp)) |
| return resp |
| except NotFound: |
| raise NotFound("wim '{}' not found".format(name)) |