Finalise test + add docstring + correct bug in plugins mongo&sql

bmx0r · bmx0r · commit 53722cf4df52 · 2013-05-26T13:46:46.000+02:00
modified:   ../plugins/mongodb.py
	modified:   ../plugins/sql.py
	modified:   test_backend_plugin_factory.py
diff --git a/libnmap/plugins/mongodb.py b/libnmap/plugins/mongodb.py
@@ -19,17 +19,23 @@ def __init__(self, dbname=None, store=None, **kwargs):
         self.collection = self.dbclient[self.dbname][self.store]
 
     def insert(self, report):
-        # create a json object from an NmapReport instance
+        """
+            create a json object from an NmapReport instance
+            :param NmapReport: obj to insert
+            :return: str id
+        """
         j = json.dumps(report, cls=ReportEncoder)
         try:
             id = self.collection.insert(json.loads(j))
         except:
             print "MONGODB cannot insert"
             raise
-        return id
+        return str(id)
 
     def get(self, str_report_id=None):
-        """get return a NmapReport object
+        """ select a NmapReport by Id
+            :param str: id
+            :return: NmapReport object
         """
         rid = str_report_id
         nmapreport = None
@@ -38,11 +44,11 @@ def get(self, str_report_id=None):
 
         if isinstance(rid, ObjectId):
             #get a specific report by mongo's id
-            r = self.collection.find({'_id': rid})
-            if r is not None:
+            resultSet = self.collection.find({'_id': rid})
+            if resultSet.count() == 1:
                 #search by id means only one in the iterator
-                record = r[0]
-                #remove mongo's id
+                record = resultSet[0]
+                #remove mongo's id to recreate the NmapReport Obj
                 del record['_id']
                 nmapreport = NmapParser.parse_fromdict(record)
         return nmapreport
@@ -60,7 +66,12 @@ def getall(self, dict_filter=None):
         return nmapreportList
 
     def delete(self, report_id=None):
+        """
+            delete an obj from the backend
+            :param str: id
+            :return: dict document with result or None
+        """
         if report_id is not None and isinstance(report_id, str):
-            self.collection.remove({'_id': ObjectId(report_id)})
+            return self.collection.remove({'_id': ObjectId(report_id)})
         else:
-            self.collection.remove({'_id': report_id})
+            return self.collection.remove({'_id': report_id})
diff --git a/libnmap/plugins/sql.py b/libnmap/plugins/sql.py
@@ -140,8 +140,15 @@ def getall(self):
         return nmapreportList
 
     def delete(self, report_id=None):
+        """
+            Remove a report from the backend
+            :param id: str
+            :return: The number of rows deleted
+        """
         if report_id is None:
             raise ValueError
+        nb_line = 0
         sess = self.Session()
-        sess.query(NmapSqlPlugin.Reports).filter_by(id=report_id).delete()
+        nb_line = sess.query(NmapSqlPlugin.Reports).filter_by(id=report_id).delete()
         sess.commit()
+        return nb_line
diff --git a/libnmap/test/test_backend_plugin_factory.py b/libnmap/test/test_backend_plugin_factory.py
@@ -95,7 +95,6 @@ def test_backend_get(self):
         id_list = []
         result_list = []
         for url in self.urls:
-            print url
             backend = BackendPluginFactory.create(**url)
             for nrp in self.reportList:
                 id_list.append(nrp.save(backend))
@@ -105,8 +104,6 @@ def test_backend_get(self):
             #print self.reportList[0]
             self.assertEqual(len(result_list), len(self.reportList))
             self.assertEqual((result_list), (self.reportList))
-            #for index in range(len(result_list)):
-            #    self.assertEqual(result_list[index], self.reportList[index])
             id_list = []
             result_list = []
 
@@ -118,11 +115,17 @@ def test_backend_delete(self):
             inset all report and save the returned id in a list
             for each id remove the item and test if not present
         """
-        pass
-#        for nrp in self.reportList:
-#            for url in self.urls:
-#                backend = BackendPluginFactory.create(**url)
-#                returncode = nrp.save(backend)
+        id_list = []
+        result_list = []
+        for url in self.urls:
+            backend = BackendPluginFactory.create(**url)
+            for nrp in self.reportList:
+                id_list.append(nrp.save(backend))
+            for rep_id in id_list:
+                result_list.append(backend.delete(rep_id))
+                self.assertEqual(backend.get(rep_id),None)
+            id_list = []
+            result_list = []
 
 
 if __name__ == '__main__':
