Use of PATCH method instead of PUT for projects
[osm/osmclient.git] / osmclient / sol005 / wim.py
index d2721cd..943ceb4 100644 (file)
@@ -19,6 +19,7 @@ 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
@@ -34,7 +35,33 @@ class Wim(object):
         self._apiResource = '/wim_accounts'
         self._apiBase = '{}{}{}'.format(self._apiName,
                                         self._apiVersion, self._apiResource)
-    def create(self, name, wim_input, wim_port_mapping=None):
+
+    # WIM '--wait' option
+    def _wait(self, id, deleteFlag=False):
+        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
+        WaitForStatus.wait_for_status(
+            'WIM',
+            str(id),
+            WaitForStatus.TIMEOUT_WIM_OPERATION,
+            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
+        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._client.get_token()
         if 'wim_type' not in wim_input:
             raise Exception("wim type not provided")
 
@@ -53,14 +80,17 @@ class Wim(object):
 
         http_code, resp = self._http.post_cmd(endpoint=self._apiBase,
                                        postfields_dict=wim_account)
-        #print 'HTTP CODE: {}'.format(http_code)
-        #print 'RESP: {}'.format(resp)
+        #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'))
             print(resp['id'])
         else:
             msg = ""
@@ -71,9 +101,10 @@ class Wim(object):
                     msg = resp
             raise ClientException("failed to create wim {} - {}".format(name, msg))
 
-    def update(self, wim_name, wim_account, wim_port_mapping=None):
+    def update(self, wim_name, wim_account, wim_port_mapping=None, wait=False):
+        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):
@@ -87,12 +118,19 @@ class Wim(object):
                 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.put_cmd(endpoint='{}/{}'.format(self._apiBase,wim['_id']),
+        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)
+        #print('HTTP CODE: {}'.format(http_code))
+        #print('RESP: {}'.format(resp))
         if http_code in (200, 201, 202, 204):
-            pass
+            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)
+            else:
+                pass
         else:
             msg = ""
             if resp:
@@ -103,7 +141,7 @@ class Wim(object):
             raise ClientException("failed to update wim {} - {}".format(wim_name, msg))
 
     def update_wim_account_dict(self, wim_account, wim_input):
-        print (wim_input)
+        print(wim_input)
         wim_account['wim_type'] = wim_input['wim_type']
         wim_account['description'] = wim_input['description']
         wim_account['wim_url'] = wim_input['url']
@@ -112,15 +150,17 @@ class Wim(object):
         return wim_account
 
     def get_id(self, name):
-        """Returns a VIM id from a VIM name
+        """Returns a WIM id from a WIM name
         """
         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):
+    def delete(self, wim_name, force=False, wait=False):
+        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 = ''
@@ -128,10 +168,21 @@ class Wim(object):
             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('HTTP CODE: {}'.format(http_code))
+        # print('RESP: {}'.format(resp))
+        # print('WIM_ID: {}'.format(wim_id))
         if http_code == 202:
-            print('Deletion in progress')
+            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, deleteFlag=True)
+            else:
+                print('Deletion in progress')
         elif http_code == 204:
             print('Deleted')
         else:
@@ -146,6 +197,7 @@ class Wim(object):
     def list(self, filter=None):
         """Returns a list of VIM accounts
         """
+        self._client.get_token()
         filter_string = ''
         if filter:
             filter_string = '?{}'.format(filter)
@@ -161,6 +213,7 @@ class Wim(object):
     def get(self, name):
         """Returns a VIM account based on name or id
         """
+        self._client.get_token()
         wim_id = name
         if not utils.validate_uuid4(name):
             wim_id = self.get_id(name)
@@ -171,4 +224,3 @@ class Wim(object):
         else:
             return resp
         raise NotFound("wim {} not found".format(name))
-