Implements #1353

Author: micafer

IM/InfrastructureManager.py

@@ -1733,20 +1733,21 @@ def ChangeInfrastructureAuth(inf_id, new_auth, overwrite, auth):
         return ""
 
     @staticmethod
-    def GetStats(date, auth):
+    def GetStats(init_date, end_date, auth):
         """
         Get the statistics from the IM DB.
 
         Args:
 
         - init_date(str): Only will be returned infrastructure created afther this date.
+        - end_date(str): Only will be returned infrastructure created before this date.
         - auth(Authentication): parsed authentication tokens.
 
         Return: a list of dict with the stats.
         """
         # First check the auth data
         auth = InfrastructureManager.check_auth_data(auth)
-        stats = Stats.get_stats(date, auth)
+        stats = Stats.get_stats(init_date, end_date, auth)
         if stats is None:
             raise Exception("ERROR connecting with the database!.")
         else:

IM/REST.py

@@ -1066,6 +1066,7 @@ def RESTGetStats():
         return return_error(401, "No authentication data provided")
 
     try:
+        init_date = None
         if "init_date" in bottle.request.params.keys():
             init_date = bottle.request.params.get("init_date").lower()
             init_date = init_date.replace("/", "-")
@@ -1080,7 +1081,20 @@ def RESTGetStats():
         else:
             init_date = "1970-01-01"
 
-        stats = InfrastructureManager.GetStats(init_date, auth)
+        end_date = None
+        if "end_date" in bottle.request.params.keys():
+            end_date = bottle.request.params.get("end_date").lower()
+            end_date = end_date.replace("/", "-")
+            parts = end_date.split("-")
+            try:
+                year = int(parts[0])
+                month = int(parts[1])
+                day = int(parts[2])
+                datetime.date(year, month, day)
+            except Exception:
+                return return_error(400, "Incorrect format in end_date parameter: YYYY/MM/dd")
+
+        stats = InfrastructureManager.GetStats(init_date, end_date, auth)
         bottle.response.content_type = "application/json"
         return format_output(stats, default_type="application/json", field_name="stats")
     except Exception as ex:

IM/ServiceRequests.py

@@ -457,5 +457,5 @@ class Request_GetStats(IMBaseRequest):
 
     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))
+        (init_date, end_date, auth_data) = self.arguments
+        return IM.InfrastructureManager.InfrastructureManager.GetStats(init_date, end_date, Authentication(auth_data))

IM/Stats.py

@@ -80,13 +80,14 @@ def _get_data(str_data, auth=None):
         return resp
 
     @staticmethod
-    def get_stats(init_date="1970-01-01", auth=None):
+    def get_stats(init_date="1970-01-01", end_date=None, auth=None):
         """
         Get the statistics from the IM DB.
 
         Args:
 
         - init_date(str): Only will be returned infrastructure created afther this date.
+        - end_date(str): Only will be returned infrastructure created afther this date.
         - auth(Authentication): parsed authentication tokens.
 
         Return: a list of dict with the stats with the following format:
@@ -105,7 +106,17 @@ def get_stats(init_date="1970-01-01", auth=None):
         stats = []
         db = DataBase(Config.DATA_DB)
         if db.connect():
-            res = db.select("SELECT data, date, id FROM inf_list WHERE date > '%s' order by rowid desc;" % init_date)
+            where = "creation_date > '%s'" % init_date
+            if end_date:
+                where += " and creation_date < %s" % end_date
+            if auth:
+                where += " and ("
+                for num, elem in enumerate(auth.getAuthInfo("InfrastructureManager")):
+                    if num > 0:
+                        where += " or "
+                    where += "auth == '%s:%s'" % (elem["username"], elem["password"])
+                where += ")"
+            res = db.select("SELECT data, date, id FROM inf_list WHERE %s order by rowid desc;" % where)
             for elem in res:
                 data = elem[0]
                 date = elem[1]

doc/source/REST.rst

@@ -459,6 +459,7 @@ GET ``http://imserver.com/stats``
    :Response Content-type: application/json
    :ok response: 200 OK
    :input fields: ``init_date`` (optional)
+   :input fields: ``end_date`` (optional)
    :fail response: 401, 400
 
    Return the stats of the current user in the IM service.

doc/source/xmlrpc.rst

@@ -417,13 +417,14 @@ This is the list of method names:
 
 ``GetStat``
    :parameter 0: ``init_date``: string
-   :parameter 1: ``auth``: array of structs
+   :parameter 1: ``end_date``: string
+   :parameter 2: ``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::
+   Return all the infrastructures in the interval ``init_date``-``end-date`` deployed by the user
+   showing some aggregated information. In JSON format::
       
       [
          {"creation_date": "2022-03-07 13:16:14",

doc/swagger_api.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.0
 
 info:
   description: Infrastructure Manager (IM) REST API.
-  version: 1.11.0
+  version: 1.12.0
   title: Infrastructure Manager (IM) REST API
   contact:
     email: [email protected]
@@ -47,9 +47,26 @@ paths:
       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
+        Return all the infrastructures in the interval init_date-end_date parameters deployed
         by the user showing some aggregated information.
       operationId: GetStats
+      parameters:
+        - name: init_date
+          in: query
+          description: >-
+            The init_date parameter is optional and it is a date with format
+            YYYY/MM/dd. Only will be returned infrastructure created afther this date.
+          required: false
+          schema:
+            type: string
+        - name: end_date
+          in: query
+          description: >-
+            The end_date parameter is optional and it is a date with format
+            YYYY/MM/dd. Only will be returned infrastructure created before this date.
+          required: false
+          schema:
+            type: string
       responses:
         '200':
           description: successful operation

im_service.py

@@ -220,9 +220,9 @@ def ChangeInfrastructureAuth(inf_id, new_auth_data, overwrite, auth_data):
     return WaitRequest(request)
 
 
-def GetStats(init_date, auth_data):
+def GetStats(init_date, end_date, auth_data):
     request = IMBaseRequest.create_request(
-        IMBaseRequest.GET_STATS, (init_date, auth_data))
+        IMBaseRequest.GET_STATS, (init_date, end_date, auth_data))
     return WaitRequest(request)
 
 

scripts/db_1_10_to_1_12.py

@@ -45,11 +45,10 @@ def load_data(db_url):
             sys.exit(-1)
 
     @staticmethod
-    def rename_old_data(db_url):
+    def rename_old_data(db_url, now):
         db = DataBase(db_url)
         if db.connect():
             if db.table_exists("inf_list"):
-                now = str(int(time.time() * 100))
                 if db.db_type == DataBase.SQLITE:
                     db.execute('ALTER TABLE inf_list RENAME TO inf_list_%s;' % now)
                     db.close()
@@ -82,8 +81,9 @@ def rename_old_data(db_url):
     sys.stdout.write("Loading Data...\n")
     inf_list = DB110to112.load_data(db_url)
     if inf_list:
-        sys.stdout.write("Previous table inf_list will be renamed to inf_list_XXXXXX.\n")
-        DB110to112.rename_old_data(db_url)
+        now = str(int(time.time() * 100))
+        sys.stdout.write("Previous table inf_list will be renamed to inf_list_%s.\n" % now)
+        DB110to112.rename_old_data(db_url, now)
         # To create the new table
         sys.stdout.write("Saving Data...\n")
         DB110to112.save_data(db_url, inf_list)

test/unit/REST.py

@@ -758,7 +758,7 @@ def test_RebootVM(self, bottle_request, StopVM):
         self.assertEqual(res, "Error rebooting VM: Invalid VM ID")
 
     def test_GeVersion(self):
-        res = RESTGeVersion()
+        res = RESTGetVersion()
         self.assertEqual(res, version)
 
     @patch("IM.InfrastructureManager.InfrastructureManager.CreateDiskSnapshot")
@@ -1081,12 +1081,13 @@ def test_GetStats(self, GetStats, bottle_request):
         """Test REST GetStats."""
         bottle_request.return_value = MagicMock()
         bottle_request.headers = {"AUTHORIZATION": "type = InfrastructureManager; username = user; password = pass"}
-        GetStats.return_value = [{"stats"}]
-        bottle_request.params = {'init_date': '2010-01-01'}
+        GetStats.return_value = [{"key": 1}]
+        bottle_request.params = {'init_date': '2010-01-01', 'end_date': '2022-01-01'}
         res = RESTGetStats()
-        self.assertEqual(res, [{"stats"}])
+        self.assertEqual(json.loads(res), {"stats": [{"key": 1}]})
         self.assertEqual(GetStats.call_args_list[0][0][0], '2010-01-01')
-        self.assertEqual(GetStats.call_args_list[0][0][1].auth_list, [{"type": "InfrastructureManager",
+        self.assertEqual(GetStats.call_args_list[0][0][1], '2022-01-01')
+        self.assertEqual(GetStats.call_args_list[0][0][2].auth_list, [{"type": "InfrastructureManager",
                                                                        "username": "user",
                                                                        "password": "pass"}])
 

test/unit/ServiceRequests.py

@@ -204,7 +204,7 @@ def test_change_auth(self, inflist):
     def test_get_stats(self, inflist):
         import IM.ServiceRequests
         req = IM.ServiceRequests.IMBaseRequest.create_request(
-            IM.ServiceRequests.IMBaseRequest.GET_STATS, ("", ""))
+            IM.ServiceRequests.IMBaseRequest.GET_STATS, ("", "", ""))
         req._call_function()
 
 

test/unit/test_im_logic.py

@@ -1418,7 +1418,7 @@ def test_get_stats(self, check_auth_data, DataBase):
         db.select.return_value = [(json.dumps(inf_data), '2022-03-23', '1')]
         DataBase.return_value = db
 
-        stats = IM.GetStats('2001-01-01', auth)
+        stats = IM.GetStats('2001-01-01', '2122-01-01', auth)
         expected_res = [{'creation_date': '2022-03-07 13:16:14',
                          'tosca_name': 'kubernetes',
                          'vm_count': 2,