cmframework/src/cmframework/lib/cmclientimpl.py

   1 # Copyright 2019 Nokia
   2
   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 implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14 import json
  15 import time
  16 import requests
  17
  18 from cmframework.apis import cmerror
  19 from cmframework.apis import cmchangestate
  20
  21
  22 class CMClientImpl(object):
  23     def __init__(self, server_ip, server_port, verbose_logger):
  24         self.version = 'v1.0'
  25         self.server_ip = server_ip
  26         self.server_port = server_port
  27         base_url = str.format('http://{ip}:{port}/cm/{api}', ip=self.server_ip,
  28                               port=self.server_port, api=self.version)
  29         self.props_base_url = str.format('{base}/properties', base=base_url)
  30         self.snapshots_base_url = str.format('{base}/snapshots', base=base_url)
  31         self.activator_url = str.format('{base}/activator', base=base_url)
  32         self.reboot_url = str.format('{base}/reboot', base=base_url)
  33         self.changes_url = str.format('{base}/changes', base=base_url)
  34         self.verbose_logger = verbose_logger
  35
  36     def get_property(self, prop_name, snapshot_name=None):
  37         resource = str.format('{base}/{prop}', base=self.props_base_url, prop=prop_name)
  38         if snapshot_name:
  39             resource = str.format('{}?snapshot={snapshot}', resource, snapshot=snapshot_name)
  40         result = self._get_rpc(resource)
  41         try:
  42             value = result['value']
  43         except KeyError:
  44             raise cmerror.CMError('Invalid response')
  45         except TypeError:
  46             raise cmerror.CMError('Invalid response')
  47         except Exception as exp:  # pylint: disable=broad-except
  48             raise cmerror.CMError(str(exp))
  49         return value
  50
  51     def get_properties(self, prop_filter, snapshot_name=None):
  52         resource = str.format('{base}?prop-name-filter={f}', base=self.props_base_url,
  53                               f=prop_filter)
  54         if snapshot_name:
  55             resource = str.format('{}&snapshot={snapshot}', resource,
  56                                   snapshot=snapshot_name)
  57         result = self._get_rpc(resource)
  58         props = {}
  59         try:
  60             properties = result['properties']
  61             for item in properties:
  62                 name = item['name']
  63                 value = item['value']
  64                 props[name] = value
  65         except KeyError as exp:
  66             raise cmerror.CMError('Invalid response')
  67         except TypeError as exp:
  68             raise cmerror.CMError('Invalid response')
  69         except Exception as exp:
  70             raise cmerror.CMError(str(exp))
  71         return props
  72
  73     def set_property(self, prop_name, prop_value):
  74         resource = str.format('{base}/{prop}', base=self.props_base_url, prop=prop_name)
  75         body = {}
  76         body['value'] = prop_value
  77         result = self._post_rpc(resource, body)
  78         return result['change-uuid']
  79
  80     def set_properties(self, props, overwrite=False):
  81         body = {}
  82         items = []
  83         for key, value in props.iteritems():
  84             item = {}
  85             item['name'] = key
  86             item['value'] = value
  87             items.append(item)
  88         body['overwrite'] = overwrite
  89         body['properties'] = items
  90         result = self._post_rpc(self.props_base_url, body)
  91         return result['change-uuid']
  92
  93     def delete_property(self, prop_name):
  94         resource = str.format('{base}/{prop}', base=self.props_base_url, prop=prop_name)
  95         result = self._delete_rpc(resource, None)
  96         return result['change-uuid']
  97
  98     def delete_properties(self, arg):
  99         result = {}
 100         if isinstance(arg, str):
 101             resource = str.format('{base}?prop-name-filter={f}', base=self.props_base_url, f=arg)
 102             result = self._delete_rpc(resource, None)
 103         else:
 104             resource = str.format('{base}', base=self.props_base_url)
 105             body = {}
 106             body['properties'] = arg
 107             result = self._delete_rpc(resource, body)
 108         return result['change-uuid']
 109
 110     def create_snapshot(self, snapshot_name):
 111         resource = str.format('{base}/{snapshot}',
 112                               base=self.snapshots_base_url,
 113                               snapshot=snapshot_name)
 114         self._get_rpc(resource)
 115
 116     def restore_snapshot(self, snapshot_name):
 117         resource = str.format('{base}/{snapshot}',
 118                               base=self.snapshots_base_url,
 119                               snapshot=snapshot_name)
 120         self._post_rpc(resource, None)
 121
 122     def delete_snapshot(self, snapshot_name):
 123         resource = str.format('{base}/{snapshot}',
 124                               base=self.snapshots_base_url,
 125                               snapshot=snapshot_name)
 126         self._delete_rpc(resource, None)
 127
 128     def list_snapshots(self):
 129         resource = str.format('{base}', base=self.snapshots_base_url)
 130         result = self._get_rpc(resource)
 131
 132         return result['snapshots']
 133
 134     def activate(self, node_name):
 135         if not node_name:
 136             resource = str.format('{base}', base=self.activator_url)
 137         else:
 138             resource = str.format('{base}/{node}', base=self.activator_url, node=node_name)
 139         result = self._post_rpc(resource, None)
 140
 141         return result['change-uuid']
 142
 143     def activate_node(self, node_name):
 144         resource = str.format('{base}/agent/{node}', base=self.activator_url, node=node_name)
 145         result = self._get_rpc(resource)
 146         try:
 147             return result['reboot']
 148         except KeyError as exp:
 149             raise cmerror.CMError('Invalid response')
 150         except TypeError as exp:
 151             raise cmerror.CMError('Invalid response')
 152         except Exception as exp:
 153             raise cmerror.CMError(str(exp))
 154
 155     def reboot_node(self, node_name):
 156         resource = str.format('{base}?node-name={f}', base=self.reboot_url, f=node_name)
 157         result = self._get_rpc(resource)
 158         try:
 159             return result['node-name']
 160         except KeyError as exp:
 161             raise cmerror.CMError('Invalid response')
 162         except TypeError as exp:
 163             raise cmerror.CMError('Invalid response')
 164         except Exception as exp:
 165             raise cmerror.CMError(str(exp))
 166
 167     def enable_automatic_activation(self):
 168         resource = str.format('{base}/enable', base=self.activator_url)
 169         self._post_rpc(resource, None)
 170
 171     def disable_automatic_activation(self):
 172         resource = str.format('{base}/disable', base=self.activator_url)
 173         self._post_rpc(resource, None)
 174
 175     def get_changes_states(self, change_uuid):
 176         if change_uuid:
 177             resource = str.format('{base}?change-uuid-filter={change_uuid}',
 178                                   base=self.changes_url,
 179                                   change_uuid=change_uuid)
 180         else:
 181             resource = str.format('{base}', base=self.changes_url)
 182         result = self._get_rpc(resource)
 183         return result
 184
 185     def wait_activation(self, change_uuid):
 186         self.verbose_log('Waiting for activation (%s) to finish' % change_uuid)
 187         state = None
 188         failed_plugins = None
 189         while True:
 190             try:
 191                 changes = self.get_changes_states(change_uuid)
 192                 state = changes[change_uuid]['state']
 193                 failed_plugins = changes[change_uuid]['failed-plugins']
 194                 self.verbose_log('State of change is %s' % state)
 195                 if state != cmchangestate.CM_CHANGE_STATE_ONGOING:
 196                     break
 197                 time.sleep(5)
 198             except Exception as exp:  # pylint: disable=broad-except
 199                 raise cmerror.CMError(str(exp))
 200
 201         if state != cmchangestate.CM_CHANGE_STATE_OK:
 202             raise cmerror.CMError("Activation was unsuccessful! Failed plugins: {}"
 203                                   .format(failed_plugins))
 204
 205     def verbose_log(self, msg):
 206         if self.verbose_logger:
 207             self.verbose_logger(msg)
 208
 209     def _get_rpc(self, resource):
 210         self.verbose_log('Sending GET %s' % resource)
 211         response = requests.get(resource)
 212         return self._handle_response(response)
 213
 214     def _post_rpc(self, resource, body):
 215         self.verbose_log('Sending POST %s' % resource)
 216         self.verbose_log('        BODY %s' % body)
 217         if body:
 218             headers = {}
 219             headers['Content-type'] = 'application/json'
 220             response = requests.post(resource, data=json.dumps(body), headers=headers)
 221         else:
 222             response = requests.post(resource)
 223
 224         return self._handle_response(response)
 225
 226     def _delete_rpc(self, resource, body):
 227         self.verbose_log('Sending DELETE %s' % resource)
 228         self.verbose_log('        BODY %s' % body)
 229         if body:
 230             headers = {}
 231             headers['Content-type'] = 'application/json'
 232             response = requests.delete(resource, data=json.dumps(body), headers=headers)
 233         else:
 234             headers = {}
 235             headers['Content-type'] = 'text'
 236             response = requests.delete(resource)
 237         return self._handle_response(response)
 238
 239     def _handle_response(self, response):
 240         self.verbose_log('Got STATUS %s' % response.reason)
 241         self.verbose_log('    CONTENT %s' % response.content)
 242         if not response.ok:
 243             raise cmerror.CMError(response.reason)
 244
 245         try:
 246             if response.content:
 247                 return response.json()
 248         except ValueError as exp:
 249             raise cmerror.CMError(str(exp))
 250         return None