Implements: #1353

Author: micafer

IM/REST.py

@@ -1080,7 +1080,9 @@ def RESTGetStats():
         else:
             init_date = "1970-01-01"
 
-        return InfrastructureManager.GetStats(init_date, auth)
+        stats = InfrastructureManager.GetStats(init_date, auth)
+        bottle.response.content_type = "application/json"
+        return format_output(stats, default_type="application/json", field_name="stats")
     except Exception as ex:
         logger.exception("Error getting stats")
         return return_error(400, "Error getting stats: %s" % get_ex_error(ex))

IM/ServiceRequests.py

@@ -58,6 +58,7 @@ class IMBaseRequest(AsyncRequest):
     GET_CLOUD_IMAGE_LIST = "GetCloudImageList"
     GET_CLOUD_QUOTAS = "GetCloudQuotas"
     CHANGE_INFRASTRUCTURE_AUTH = "ChangeInfrastructureAuth"
+    GET_STATS = "GetStats"
 
     @staticmethod
     def create_request(function, arguments=()):
@@ -113,6 +114,8 @@ def create_request(function, arguments=()):
             return Request_GetCloudQuotas(arguments)
         elif function == IMBaseRequest.CHANGE_INFRASTRUCTURE_AUTH:
             return Request_ChangeInfrastructureAuth(arguments)
+        elif function == IMBaseRequest.GET_STATS:
+            return Request_GetStats(arguments)
         else:
             raise NotImplementedError("Function not Implemented")
 
@@ -445,3 +448,14 @@ def _call_function(self):
                                                                                        Authentication(new_auth),
                                                                                        overwrite,
                                                                                        Authentication(auth_data))
+
+
+class Request_GetStats(IMBaseRequest):
+    """
+    Request class for the GetStats function
+    """
+
+    def _call_function(self):
+        self._error_mesage = "Error getting stats"
+        (init_date, auth_data) = self.arguments
+        return IM.InfrastructureManager.InfrastructureManager.GetStats(init_date, Authentication(auth_data))

IM/Stats.py

@@ -41,12 +41,12 @@ def _get_data(str_data, auth=None):
         resp = {'creation_date': None}
         if 'creation_date' in dic and dic['creation_date']:
             resp['creation_date'] = str(datetime.datetime.fromtimestamp(float(dic['creation_date'])))
-        resp['icon'] = None
+        resp['tosca_name'] = None
         if 'extra_info' in dic and dic['extra_info'] and "TOSCA" in dic['extra_info']:
             try:
                 tosca = yaml.safe_load(dic['extra_info']['TOSCA'])
                 icon = tosca.get("metadata", {}).get("icon", "")
-                resp['icon'] = os.path.basename(icon)[:-4]
+                resp['tosca_name'] = os.path.basename(icon)[:-4]
             except Exception:
                 Stats.logger.exception("Error loading TOSCA.")
 
@@ -89,7 +89,7 @@ def get_stats(init_date="1970-01-01", auth=None):
 
         Return: a list of dict with the stats with the following format:
             {'creation_date': '2022-03-07 13:16:14',
-             'icon': 'kubernetes',
+             'tosca_name': 'kubernetes',
              'vm_count': 2,
              'cpu_count': 4,
              'memory_size': 1024,

doc/source/REST.rst

@@ -50,7 +50,7 @@ Next tables summaries the resources and the HTTP methods available.
 +-------------+------------------------------------------------------+------------------------------------------------------+
 | **POST**    |                                                      | | **Modify** the specified property ``property_name``|
 |             |                                                      | | associated to the infrastructure ``infId``.        |
-|             |                                                      | | only ``authorization`` property is valid.         |
+|             |                                                      | | only ``authorization`` property is valid.          |
 +-------------+------------------------------------------------------+------------------------------------------------------+
 
 
@@ -421,7 +421,7 @@ GET ``http://imserver.com/clouds/<cloudId>/images``
    The id ``cloudId`` is relative to the id field in the AUTHORIZATION header.
    The result is JSON format has the following format::
 
-   {
+    {
       "images":
          [
             {
@@ -433,7 +433,7 @@ GET ``http://imserver.com/clouds/<cloudId>/images``
                "name" : "Image Name2"
             }
          ]
-   }
+    }
 
 GET ``http://imserver.com/clouds/<cloudId>/quotas``
    :Response Content-type: application/json
@@ -454,3 +454,29 @@ GET ``http://imserver.com/clouds/<cloudId>/quotas``
          "security_groups": {"used": 1, "limit": 10}
       }
     }
+
+GET ``http://imserver.com/stats``
+   :Response Content-type: application/json
+   :ok response: 200 OK
+   :input fields: ``init_date`` (optional)
+   :fail response: 401, 400
+
+   Return the stats of the current user in the IM service.
+   Return all the infrastructures deployed by the user showing some
+   aggregated information. In JSON format::
+
+    {
+      "stats": [
+                  {"creation_date": "2022-03-07 13:16:14",
+                  "tosca_name": "kubernetes",
+                  "vm_count": 2,
+                  "cpu_count": 4,
+                  "memory_size": 1024,
+                  "cloud_type": "OSCAR",
+                  "cloud_host": "sharp-elbakyan5.im.grycap.net",
+                  "hybrid": false,
+                  "im_user": "__OPENID__mcaballer",
+                  "inf_id": "1",
+                  "last_date": "2022-03-23"}
+      ]
+    }

doc/source/xmlrpc.rst

@@ -406,3 +406,35 @@ This is the list of method names:
    Change the authentication data of the infrastructure with ID ``infId``. using
    the ``newAuth`` provider. If ``overwrite`` is true, the authentication data will
    be overwrited otherwise it will be appended.
+
+``GetVersion``
+   :ok response: [true, string]
+   :fail response: [false, ``error``: string]
+
+   Return the version of the IM service.
+
+.. _GetStat-xmlrpc:
+
+``GetStat``
+   :parameter 0: ``init_date``: string
+   :parameter 1: ``auth``: array of structs
+   :ok response: [true, list of dicts]
+   :fail response: [false, ``error``: string]
+
+   Return the stats of the current user in the IM service.
+   Return all the infrastructures since ``init_date`` deployed by the user showing some
+   aggregated information. In JSON format::
+      
+      [
+         {"creation_date": "2022-03-07 13:16:14",
+         "tosca_name": "kubernetes",
+         "vm_count": 2,
+         "cpu_count": 4,
+         "memory_size": 1024,
+         "cloud_type": "OSCAR",
+         "cloud_host": "sharp-elbakyan5.im.grycap.net",
+         "hybrid": false,
+         "im_user": "__OPENID__mcaballer",
+         "inf_id": "1",
+         "last_date": "2022-03-23"}
+      ]

doc/swagger_api.yaml

@@ -15,6 +15,8 @@ tags:
     description: Manages Virtual Infrastructures.
   - name: version
     description: Get IM server version.
+  - name: stats
+    description: Get IM server stats.
   - name: clouds
     description: Get cloud information.
 
@@ -38,6 +40,40 @@ paths:
         '400':
           description: Invalid status value
 
+  /stats:
+    get:
+      tags:
+        - stats
+      summary: Get IM server stats.
+      description: >-
+        Return the stats of the current user in the IM service.
+        Return all the infrastructures since the init_date parameter deployed
+        by the user showing some aggregated information.
+      operationId: GetStats
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              examples:
+                response:
+                  value:
+                    - creation_date: '2022-03-07 13:16:14'
+                      tosca_name: 'kubernetes'
+                      vm_count: 2
+                      cpu_count: 4
+                      memory_size: 1024
+                      cloud_type: 'OSCAR'
+                      cloud_host: 'sharp-elbakyan5.im.grycap.net'
+                      hybrid: false
+                      im_user: '__OPENID__mcaballer'
+                      inf_id: '1'
+                      last_date: '2022-03-23'
+        '400':
+          description: Invalid status value
+        '401':
+          description: Unauthorized
+
   /infrastructures:
     get:
       tags:

im_service.py

@@ -220,6 +220,12 @@ def ChangeInfrastructureAuth(inf_id, new_auth_data, overwrite, auth_data):
     return WaitRequest(request)
 
 
+def GetStats(init_date, auth_data):
+    request = IMBaseRequest.create_request(
+        IMBaseRequest.GET_STATS, (init_date, auth_data))
+    return WaitRequest(request)
+
+
 def launch_daemon():
     """
     Launch the IM daemon
@@ -266,6 +272,7 @@ def launch_daemon():
     server.register_function(GetCloudImageList)
     server.register_function(GetCloudQuotas)
     server.register_function(ChangeInfrastructureAuth)
+    server.register_function(GetStats)
 
     InfrastructureManager.logger.info(
         '************ Start Infrastructure Manager daemon (v.%s) ************' % version)

test/unit/ServiceRequests.py

@@ -200,6 +200,13 @@ def test_change_auth(self, inflist):
             IM.ServiceRequests.IMBaseRequest.CHANGE_INFRASTRUCTURE_AUTH, ("", "", False, ""))
         req._call_function()
 
+    @patch('IM.InfrastructureManager.InfrastructureManager')
+    def test_get_stats(self, inflist):
+        import IM.ServiceRequests
+        req = IM.ServiceRequests.IMBaseRequest.create_request(
+            IM.ServiceRequests.IMBaseRequest.GET_STATS, ("", ""))
+        req._call_function()
+
 
 if __name__ == '__main__':
     unittest.main()

test/unit/test_im_logic.py

@@ -1432,7 +1432,7 @@ def test_get_stats(self, check_auth_data, DataBase):
 
         stats = IM.GetStats('2001-01-01', auth)
         expected_res = [{'creation_date': '2022-03-07 13:16:14',
-                         'icon': 'kubernetes',
+                         'tosca_name': 'kubernetes',
                          'vm_count': 2,
                          'cpu_count': 4,
                          'memory_size': 1024,