Revize b3c80ccb

Re #8570 - Added logs

src/dao/certificate_repository.py

@@ -1 @@
-from sqlite3 import Connection, Error
+from sqlite3 import Connection, Error, DatabaseError, IntegrityError, ProgrammingError, OperationalError, NotSupportedError
 from typing import Dict, List
 
 from src.exceptions.database_exception import DatabaseException
@@ -7 +7 @@
 from src.model.certificate import Certificate
 from src.utils.logger import Logger
 
+INTEGRITY_ERROR_MSG = "Database relational integrity corrupted."
+PROGRAMMING_ERROR_MSG = "Exception raised for programming errors (etc. SQL statement)."
+OPERATIONAL_ERROR_MSG = "Exception raised for errors that are related to the database’s operation."
+NOT_SUPPORTED_ERROR_MSG = "Method or database API was used which is not supported by the database"
+DATABASE_ERROR_MSG = "Unknown exception that are related to the database."
+ERROR_MSG = "Unknown exception."
+
 
 class CertificateRepository:
 
@@ -30 +37 @@
         :return: the result of whether the creation was successful
         """
 
+        Logger.debug("Function launched.")
+
         try:
             sql = (f"INSERT INTO {TAB_CERTIFICATES} "
                    f"({COL_COMMON_NAME},"
@@ -66 +75 @@
                         values = [last_id, usage_id]
                         self.cursor.execute(sql, values)
                         self.connection.commit()
-        except Error as e:
-            raise DatabaseException(e)
+        except IntegrityError:
+            Logger.error(INTEGRITY_ERROR_MSG)
+            raise DatabaseException(INTEGRITY_ERROR_MSG)
+        except ProgrammingError:
+            Logger.error(PROGRAMMING_ERROR_MSG)
+            raise DatabaseException(PROGRAMMING_ERROR_MSG)
+        except OperationalError:
+            Logger.error(OPERATIONAL_ERROR_MSG)
+            raise DatabaseException(OPERATIONAL_ERROR_MSG)
+        except NotSupportedError:
+            Logger.error(NOT_SUPPORTED_ERROR_MSG)
+            raise DatabaseException(NOT_SUPPORTED_ERROR_MSG)
+        except DatabaseError:
+            Logger.error(DATABASE_ERROR_MSG)
+            raise DatabaseException(DATABASE_ERROR_MSG)
+        except Error:
+            Logger.error(ERROR_MSG)
+            raise DatabaseException(ERROR_MSG)
 
         return last_id
 
@@ -80 +105 @@
         :return: instance of the Certificate object
         """
 
+        Logger.debug("Function launched.")
+
         try:
             sql = (f"SELECT * FROM {TAB_CERTIFICATES} "
                    f"WHERE {COL_ID} = ?")
@@ -110 +137 @@
                                                    usage_dict,
                                                    certificate_row[5],
                                                    certificate_row[6])
-        except Error as e:
-            raise DatabaseException(e)
+        except IntegrityError:
+            Logger.error(INTEGRITY_ERROR_MSG)
+            raise DatabaseException(INTEGRITY_ERROR_MSG)
+        except ProgrammingError:
+            Logger.error(PROGRAMMING_ERROR_MSG)
+            raise DatabaseException(PROGRAMMING_ERROR_MSG)
+        except OperationalError:
+            Logger.error(OPERATIONAL_ERROR_MSG)
+            raise DatabaseException(OPERATIONAL_ERROR_MSG)
+        except NotSupportedError:
+            Logger.error(NOT_SUPPORTED_ERROR_MSG)
+            raise DatabaseException(NOT_SUPPORTED_ERROR_MSG)
+        except DatabaseError:
+            Logger.error(DATABASE_ERROR_MSG)
+            raise DatabaseException(DATABASE_ERROR_MSG)
+        except Error:
+            Logger.error(ERROR_MSG)
+            raise DatabaseException(ERROR_MSG)
 
         return certificate
 
@@ -124 +167 @@
         :return: list of certificates
         """
 
+        Logger.debug("Function launched.")
+
         try:
             sql_extension = ""
             values = []
@@ -159 +204 @@
                                                 usage_dict,
                                                 certificate_row[5],
                                                 certificate_row[6]))
-        except Error as e:
-            raise DatabaseException(e)
+        except IntegrityError:
+            Logger.error(INTEGRITY_ERROR_MSG)
+            raise DatabaseException(INTEGRITY_ERROR_MSG)
+        except ProgrammingError:
+            Logger.error(PROGRAMMING_ERROR_MSG)
+            raise DatabaseException(PROGRAMMING_ERROR_MSG)
+        except OperationalError:
+            Logger.error(OPERATIONAL_ERROR_MSG)
+            raise DatabaseException(OPERATIONAL_ERROR_MSG)
+        except NotSupportedError:
+            Logger.error(NOT_SUPPORTED_ERROR_MSG)
+            raise DatabaseException(NOT_SUPPORTED_ERROR_MSG)
+        except DatabaseError:
+            Logger.error(DATABASE_ERROR_MSG)
+            raise DatabaseException(DATABASE_ERROR_MSG)
+        except Error:
+            Logger.error(ERROR_MSG)
+            raise DatabaseException(ERROR_MSG)
 
         return certificates
 
@@ -176 +237 @@
         :return: the result of whether the updation was successful
         """
 
+        Logger.debug("Function launched.")
+
         try:
             sql = (f"UPDATE {TAB_CERTIFICATES} "
                    f"SET {COL_COMMON_NAME} = ?, "
@@ -213 +276 @@
                     values = [certificate_id, usage_id]
                     self.cursor.execute(sql, values)
                     self.connection.commit()
-        except Error as e:
-            raise DatabaseException(e)
+        except IntegrityError:
+            Logger.error(INTEGRITY_ERROR_MSG)
+            raise DatabaseException(INTEGRITY_ERROR_MSG)
+        except ProgrammingError:
+            Logger.error(PROGRAMMING_ERROR_MSG)
+            raise DatabaseException(PROGRAMMING_ERROR_MSG)
+        except OperationalError:
+            Logger.error(OPERATIONAL_ERROR_MSG)
+            raise DatabaseException(OPERATIONAL_ERROR_MSG)
+        except NotSupportedError:
+            Logger.error(NOT_SUPPORTED_ERROR_MSG)
+            raise DatabaseException(NOT_SUPPORTED_ERROR_MSG)
+        except DatabaseError:
+            Logger.error(DATABASE_ERROR_MSG)
+            raise DatabaseException(DATABASE_ERROR_MSG)
+        except Error:
+            Logger.error(ERROR_MSG)
+            raise DatabaseException(ERROR_MSG)
 
         return self.cursor.rowcount > 0
 
@@ -227 +306 @@
         :return: the result of whether the deletion was successful
         """
 
+        Logger.debug("Function launched.")
+
         try:
             sql = (f"DELETE FROM {TAB_CERTIFICATES} "
                    f"WHERE {COL_ID} = ?")
             values = [certificate_id]
             self.cursor.execute(sql, values)
             self.connection.commit()
-        except Error as e:
-            raise DatabaseException(e)
+        except IntegrityError:
+            Logger.error(INTEGRITY_ERROR_MSG)
+            raise DatabaseException(INTEGRITY_ERROR_MSG)
+        except ProgrammingError:
+            Logger.error(PROGRAMMING_ERROR_MSG)
+            raise DatabaseException(PROGRAMMING_ERROR_MSG)
+        except OperationalError:
+            Logger.error(OPERATIONAL_ERROR_MSG)
+            raise DatabaseException(OPERATIONAL_ERROR_MSG)
+        except NotSupportedError:
+            Logger.error(NOT_SUPPORTED_ERROR_MSG)
+            raise DatabaseException(NOT_SUPPORTED_ERROR_MSG)
+        except DatabaseError:
+            Logger.error(DATABASE_ERROR_MSG)
+            raise DatabaseException(DATABASE_ERROR_MSG)
+        except Error:
+            Logger.error(ERROR_MSG)
+            raise DatabaseException(ERROR_MSG)
 
         return self.cursor.rowcount > 0
 
@@ -252 +349 @@
             sqlite3.Error if an exception is thrown
         """
 
+        Logger.debug("Function launched.")
+
         try:
             if revocation_date != "" and revocation_reason == "":
                 revocation_reason = REV_REASON_UNSPECIFIED
@@ -267 +366 @@
                       certificate_id]
             self.cursor.execute(sql, values)
             self.connection.commit()
-        except Error as e:
-            raise DatabaseException(e)
+        except IntegrityError:
+            Logger.error(INTEGRITY_ERROR_MSG)
+            raise DatabaseException(INTEGRITY_ERROR_MSG)
+        except ProgrammingError:
+            Logger.error(PROGRAMMING_ERROR_MSG)
+            raise DatabaseException(PROGRAMMING_ERROR_MSG)
+        except OperationalError:
+            Logger.error(OPERATIONAL_ERROR_MSG)
+            raise DatabaseException(OPERATIONAL_ERROR_MSG)
+        except NotSupportedError:
+            Logger.error(NOT_SUPPORTED_ERROR_MSG)
+            raise DatabaseException(NOT_SUPPORTED_ERROR_MSG)
+        except DatabaseError:
+            Logger.error(DATABASE_ERROR_MSG)
+            raise DatabaseException(DATABASE_ERROR_MSG)
+        except Error:
+            Logger.error(ERROR_MSG)
+            raise DatabaseException(ERROR_MSG)
 
         return self.cursor.rowcount > 0
 
@@ -283 +398 @@
             sqlite3.Error if an exception is thrown
         """
 
+        Logger.debug("Function launched.")
+
         try:
             sql = (f"UPDATE {TAB_CERTIFICATES} "
                    f"SET {COL_REVOCATION_DATE} = '', "
@@ -291 +408 @@
             values = [certificate_id]
             self.cursor.execute(sql, values)
             self.connection.commit()
-        except Error as e:
-            raise DatabaseException(e)
+        except IntegrityError:
+            Logger.error(INTEGRITY_ERROR_MSG)
+            raise DatabaseException(INTEGRITY_ERROR_MSG)
+        except ProgrammingError:
+            Logger.error(PROGRAMMING_ERROR_MSG)
+            raise DatabaseException(PROGRAMMING_ERROR_MSG)
+        except OperationalError:
+            Logger.error(OPERATIONAL_ERROR_MSG)
+            raise DatabaseException(OPERATIONAL_ERROR_MSG)
+        except NotSupportedError:
+            Logger.error(NOT_SUPPORTED_ERROR_MSG)
+            raise DatabaseException(NOT_SUPPORTED_ERROR_MSG)
+        except DatabaseError:
+            Logger.error(DATABASE_ERROR_MSG)
+            raise DatabaseException(DATABASE_ERROR_MSG)
+        except Error:
+            Logger.error(ERROR_MSG)
+            raise DatabaseException(ERROR_MSG)
 
         return self.cursor.rowcount > 0
 
@@ -308 +441 @@
             sqlite3.Error if an exception is thrown
         """
 
+        Logger.debug("Function launched.")
+
         try:
             sql = (f"SELECT * FROM {TAB_CERTIFICATES} "
                    f"WHERE {COL_PARENT_ID} = ? AND {COL_REVOCATION_DATE} IS NOT NULL AND {COL_REVOCATION_DATE} != ''")
@@ -338 +473 @@
                                                 usage_dict,
                                                 certificate_row[5],
                                                 certificate_row[6]))
-        except Error as e:
-            raise DatabaseException(e)
+        except IntegrityError:
+            Logger.error(INTEGRITY_ERROR_MSG)
+            raise DatabaseException(INTEGRITY_ERROR_MSG)
+        except ProgrammingError:
+            Logger.error(PROGRAMMING_ERROR_MSG)
+            raise DatabaseException(PROGRAMMING_ERROR_MSG)
+        except OperationalError:
+            Logger.error(OPERATIONAL_ERROR_MSG)
+            raise DatabaseException(OPERATIONAL_ERROR_MSG)
+        except NotSupportedError:
+            Logger.error(NOT_SUPPORTED_ERROR_MSG)
+            raise DatabaseException(NOT_SUPPORTED_ERROR_MSG)
+        except DatabaseError:
+            Logger.error(DATABASE_ERROR_MSG)
+            raise DatabaseException(DATABASE_ERROR_MSG)
+        except Error:
+            Logger.error(ERROR_MSG)
+            raise DatabaseException(ERROR_MSG)
 
         return certificates
 
@@ -355 +506 @@
             sqlite3.Error if an exception is thrown
         """
 
+        Logger.debug("Function launched.")
+
         try:
             sql = (f"SELECT * FROM {TAB_CERTIFICATES} "
                    f"WHERE {COL_PARENT_ID} = ? AND {COL_ID} != ?")
@@ -385 +538 @@
                                                 usage_dict,
                                                 certificate_row[5],
                                                 certificate_row[6]))
-        except Error as e:
-            raise DatabaseException(e)
+        except IntegrityError:
+            Logger.error(INTEGRITY_ERROR_MSG)
+            raise DatabaseException(INTEGRITY_ERROR_MSG)
+        except ProgrammingError:
+            Logger.error(PROGRAMMING_ERROR_MSG)
+            raise DatabaseException(PROGRAMMING_ERROR_MSG)
+        except OperationalError:
+            Logger.error(OPERATIONAL_ERROR_MSG)
+            raise DatabaseException(OPERATIONAL_ERROR_MSG)
+        except NotSupportedError:
+            Logger.error(NOT_SUPPORTED_ERROR_MSG)
+            raise DatabaseException(NOT_SUPPORTED_ERROR_MSG)
+        except DatabaseError:
+            Logger.error(DATABASE_ERROR_MSG)
+            raise DatabaseException(DATABASE_ERROR_MSG)
+        except Error:
+            Logger.error(ERROR_MSG)
+            raise DatabaseException(ERROR_MSG)
 
         return certificates
 
@@ -397 +566 @@
         :param certificate_id: target certificate ID
         :return: list of all descendants
         """
-        def dfs(children_of, this, collection: list):
-            for child in children_of(this.certificate_id):
-                dfs(children_of, child, collection)
-            collection.append(this)
 
-        subtree_root = self.read(certificate_id)
-        if subtree_root is None:
-            return None
+        Logger.debug("Function launched.")
+
+        try:
+            def dfs(children_of, this, collection: list):
+                for child in children_of(this.certificate_id):
+                    dfs(children_of, child, collection)
+                collection.append(this)
+
+            subtree_root = self.read(certificate_id)
+            if subtree_root is None:
+                return None
+
+            all_certs = []
+            dfs(self.get_all_issued_by, subtree_root, all_certs)
+        except IntegrityError:
+            Logger.error(INTEGRITY_ERROR_MSG)
+            raise DatabaseException(INTEGRITY_ERROR_MSG)
+        except ProgrammingError:
+            Logger.error(PROGRAMMING_ERROR_MSG)
+            raise DatabaseException(PROGRAMMING_ERROR_MSG)
+        except OperationalError:
+            Logger.error(OPERATIONAL_ERROR_MSG)
+            raise DatabaseException(OPERATIONAL_ERROR_MSG)
+        except NotSupportedError:
+            Logger.error(NOT_SUPPORTED_ERROR_MSG)
+            raise DatabaseException(NOT_SUPPORTED_ERROR_MSG)
+        except DatabaseError:
+            Logger.error(DATABASE_ERROR_MSG)
+            raise DatabaseException(DATABASE_ERROR_MSG)
+        except Error:
+            Logger.error(ERROR_MSG)
+            raise DatabaseException(ERROR_MSG)
 
-        all_certs = []
-        dfs(self.get_all_issued_by, subtree_root, all_certs)
         return all_certs
 
     def get_next_id(self) -> int:
@@ -415 +607 @@
         Get identifier of the next certificate that will be inserted into the database
         :return: identifier of the next certificate that will be added into the database
         """
-        # get next IDs of all tables
-        self.cursor.execute("SELECT * FROM SQLITE_SEQUENCE")
-        results = self.cursor.fetchall()
-
-        # search for next ID in Certificates table and return it
-        for result in results:
-            if result[0] == TAB_CERTIFICATES:
-                return result[1] + 1  # current last id + 1
-        # if certificates table is not present in the query results, return 1
+
+        Logger.debug("Function launched.")
+
+        try:
+            # get next IDs of all tables
+            self.cursor.execute("SELECT * FROM SQLITE_SEQUENCE")
+            results = self.cursor.fetchall()
+
+            # search for next ID in Certificates table and return it
+            for result in results:
+                if result[0] == TAB_CERTIFICATES:
+                    return result[1] + 1  # current last id + 1
+            # if certificates table is not present in the query results, return 1
+        except IntegrityError:
+            Logger.error(INTEGRITY_ERROR_MSG)
+            raise DatabaseException(INTEGRITY_ERROR_MSG)
+        except ProgrammingError:
+            Logger.error(PROGRAMMING_ERROR_MSG)
+            raise DatabaseException(PROGRAMMING_ERROR_MSG)
+        except OperationalError:
+            Logger.error(OPERATIONAL_ERROR_MSG)
+            raise DatabaseException(OPERATIONAL_ERROR_MSG)
+        except NotSupportedError:
+            Logger.error(NOT_SUPPORTED_ERROR_MSG)
+            raise DatabaseException(NOT_SUPPORTED_ERROR_MSG)
+        except DatabaseError:
+            Logger.error(DATABASE_ERROR_MSG)
+            raise DatabaseException(DATABASE_ERROR_MSG)
+        except Error:
+            Logger.error(ERROR_MSG)
+            raise DatabaseException(ERROR_MSG)
+
         return 1