Skip to content

SpiderFoot automates OSINT for threat intelligence and mapping your attack surface.

sfdb: validate instanceId parameters

Brendan Coles3af528bb780a
diff --git a/sfdb.py b/sfdb.py
index e827bd1b..dfbd57d7 100644
--- a/sfdb.py
+++ b/sfdb.py
@@ -464,6 +464,7 @@ class SpiderFootDb:
Todo:
Do something smarter to handle database locks
"""
+
if not isinstance(instanceId, str):
raise TypeError("instanceId is %s; expected str()" % type(instanceId))
@@ -506,9 +507,19 @@ class SpiderFootDb:
None: success
Raises:
+ TypeError: arg type was invalid
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
+ if not isinstance(scanName, str):
+ raise TypeError("scanName is %s; expected str()" % type(scanName))
+
+ if not isinstance(scanTarget, str):
+ raise TypeError("scanTarget is %s; expected str()" % type(scanTarget))
+
qry = "INSERT INTO tbl_scan_instance \
(guid, name, seed_target, created, status) \
VALUES (?, ?, ?, ?, ?)"
@@ -535,9 +546,13 @@ class SpiderFootDb:
None: success
Raises:
+ TypeError: arg type was invalid
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
qvars = list()
qry = "UPDATE tbl_scan_instance SET "
@@ -574,9 +589,13 @@ class SpiderFootDb:
list: scan instance info
Raises:
+ TypeError: arg type was invalid
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
qry = "SELECT name, seed_target, ROUND(created/1000) AS created, \
ROUND(started/1000) AS started, ROUND(ended/1000) AS ended, status \
FROM tbl_scan_instance WHERE guid = ?"
@@ -595,16 +614,23 @@ class SpiderFootDb:
Args:
instanceId (str): scan instance ID
- by (str): filter
+ by (str): filter by type
Returns:
list: scan instance info
Raises:
- ValueError: arg value was invalid
+ TypeError: arg type was invalid
+ ValueError: arg valie was invalid
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
+ if not isinstance(by, str):
+ raise TypeError("by is %s; expected str()" % type(by))
+
if by not in ["type", "module", "entity"]:
raise ValueError("Invalid filter by value: %s" % by)
@@ -653,6 +679,9 @@ class SpiderFootDb:
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
if not isinstance(eventType, str):
raise TypeError("eventType is %s; expected str()" % type(eventType))
@@ -700,6 +729,9 @@ class SpiderFootDb:
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
if not isinstance(eventType, str):
raise TypeError("eventType is %s; expected str()" % type(eventType))
@@ -736,9 +768,13 @@ class SpiderFootDb:
list: scan logs
Raises:
+ TypeError: arg type was invalid
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
qry = "SELECT generated AS generated, component, \
type, message, rowid FROM tbl_scan_log WHERE scan_instance_id = ?"
if fromRowId:
@@ -776,9 +812,13 @@ class SpiderFootDb:
list: scan errors
Raises:
+ TypeError: arg type was invalid
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
qry = "SELECT generated AS generated, component, \
message FROM tbl_scan_log WHERE scan_instance_id = ? \
AND type = 'ERROR' ORDER BY generated DESC"
@@ -806,9 +846,13 @@ class SpiderFootDb:
None: success
Raises:
+ TypeError: arg type was invalid
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
qry1 = "DELETE FROM tbl_scan_instance WHERE guid = ?"
qry2 = "DELETE FROM tbl_scan_config WHERE scan_instance_id = ?"
qry3 = "DELETE FROM tbl_scan_results WHERE scan_instance_id = ?"
@@ -837,9 +881,13 @@ class SpiderFootDb:
bool: success
Raises:
+ TypeError: arg type was invalid
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
with self.dbhLock:
for resultHash in resultHashes:
qry = "UPDATE tbl_scan_results SET false_positive = ? WHERE \
@@ -999,9 +1047,13 @@ class SpiderFootDb:
dict: configuration data
Raises:
+ TypeError: arg type was invalid
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
qry = "SELECT component, opt, val FROM tbl_scan_config \
WHERE scan_instance_id = ? ORDER BY component, opt"
qvars = [instanceId]
@@ -1024,7 +1076,7 @@ class SpiderFootDb:
"""Store an event in the database.
Args:
- instanceId (int): scan instance ID
+ instanceId (str): scan instance ID
sfEvent (SpiderFootEvent): A SpiderFootEvent object with the following variables:
- eventType: the event, e.g. URL_FORM, RAW_DATA, etc.
- generated: time the event occurred
@@ -1041,35 +1093,40 @@ class SpiderFootDb:
Raises:
TypeError: arg type was invalid
+ ValueError: arg value was invalid
IOError: database I/O failed
Todo:
- Validate args and modify error handling to raise instead of calling fatal()
+ Review event attribute validation and error handling
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
+ if not instanceId:
+ raise ValueError("instanceId is empty")
+
if not isinstance(sfEvent, SpiderFootEvent):
raise TypeError("sfEvent is %s; expected SpiderFootEvent()" % type(sfEvent))
- storeData = ''
+ if not isinstance(sfEvent.data, str):
+ raise TypeError("sfEvent.data is %s; expected str()" % type(sfEvent.data))
- if type(sfEvent.data) is not str:
- # If sfEvent.data is a dict or list, convert it to a string first, as
- # those types do not have a unicode converter.
- if type(sfEvent.data) is str:
- storeData = str(sfEvent.data)
- else:
- try:
- storeData = str(sfEvent.data)
- except BaseException as e:
- self.sf.fatal("Unhandled type detected: " + str(type(sfEvent.data)))
- else:
- storeData = sfEvent.data
+ if not sfEvent.data:
+ raise ValueError("sfEvent.data is empty")
- if truncateSize > 0:
- storeData = storeData[0:truncateSize]
+ if not isinstance(sfEvent.sourceEventhash, str):
+ raise TypeError("sfEvent.sourceEventHash is %s; expected str()" % type(sfEvent.sourceEventHash))
- if sfEvent.sourceEventHash in ["", None]:
- self.sf.fatal("UNABLE TO CREATE RECORD WITH EMPTY SOURCE EVENT HASH!")
+ if not sfEvent.sourceEventHash:
+ raise ValueError("sfEvent.sourceEventHash is empty")
+
+ storeData = sfEvent.data
+
+ # truncate if required
+ if isinstance(truncateSize, int):
+ if truncateSize > 0:
+ storeData = storeData[0:truncateSize]
# retrieve scan results
# sfEvent.getHash() will return the event hash for the input sfEvent event
@@ -1082,7 +1139,7 @@ class SpiderFootDb:
sfEvent.confidence, sfEvent.visibility, sfEvent.risk,
sfEvent.module, storeData, sfEvent.sourceEventHash]
- #print("STORING: " + str(qvals))
+ #print("STORING: %s" % qvals)
with self.dbhLock:
try:
@@ -1129,9 +1186,13 @@ class SpiderFootDb:
list: scan data history
Raises:
+ TypeError: arg type was invalid
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
qry = "SELECT STRFTIME('%H:%M %w', generated, 'unixepoch') AS hourmin, \
type, COUNT(*) FROM tbl_scan_results \
WHERE scan_instance_id = ? GROUP BY hourmin, type"
@@ -1159,6 +1220,9 @@ class SpiderFootDb:
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
if not isinstance(elementIdList, list):
raise TypeError("elementIdList is %s; expected list()" % type(elementIdList))
@@ -1205,6 +1269,9 @@ class SpiderFootDb:
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
if not isinstance(elementIdList, list):
raise TypeError("elementIdList is %s; expected list()" % type(elementIdList))
@@ -1251,12 +1318,15 @@ class SpiderFootDb:
Raises:
TypeError: arg type was invalid
- ValueError: arg value was invalid
IOError: database I/O failed
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
if not isinstance(childData, list):
raise TypeError("childData is %s; expected list()" % type(childData))
+
if not childData:
raise ValueError("childData is empty")
@@ -1318,10 +1388,20 @@ class SpiderFootDb:
Returns:
list: TBD
- Note: FOR NOW THE BEHAVIOR IS NOT THE SAME AS THE scanElementParent*
- FUNCTIONS - THIS ONLY RETURNS IDS!!
+ Raises:
+ TypeError: arg type was invalid
+ IOError: database I/O failed
+
+ Note: This function is not the same as the scanElementParent* functions.
+ This function returns only ids.
"""
+ if not isinstance(instanceId, str):
+ raise TypeError("instanceId is %s; expected str()" % type(instanceId))
+
+ if not isinstance(parentIds, list):
+ raise TypeError("parentIds is %s; expected list()" % type(parentIds))
+
datamap = list()
keepGoing = True
nextIds = list()
diff --git a/sfwebui.py b/sfwebui.py
index 5bedd041..a47f30d9 100644
--- a/sfwebui.py
+++ b/sfwebui.py
@@ -1000,8 +1000,13 @@ class SpiderFootWebUi:
# Scan log data
def scanlog(self, id, limit=None, rowId=None, reverse=None):
dbh = SpiderFootDb(self.config)
- data = dbh.scanLogs(id, limit, rowId, reverse)
retdata = []
+
+ try:
+ data = dbh.scanLogs(id, limit, rowId, reverse)
+ except:
+ return json.dumps(retdata)
+
for row in data:
generated = time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(row[0] / 1000))
retdata.append([generated, row[1], row[2], html.escape(row[3]), row[4]])
@@ -1012,8 +1017,13 @@ class SpiderFootWebUi:
# Scan error data
def scanerrors(self, id, limit=None):
dbh = SpiderFootDb(self.config)
- data = dbh.scanErrors(id, limit)
retdata = []
+
+ try:
+ data = dbh.scanErrors(id, limit)
+ except:
+ return json.dumps(retdata)
+
for row in data:
generated = time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(row[0] / 1000))
retdata.append([generated, row[1],
@@ -1101,8 +1111,13 @@ class SpiderFootWebUi:
# Unique event results for a scan
def scaneventresultsunique(self, id, eventType, filterfp=False):
dbh = SpiderFootDb(self.config)
- data = dbh.scanResultEventUnique(id, eventType, filterfp)
retdata = []
+
+ try:
+ data = dbh.scanResultEventUnique(id, eventType, filterfp)
+ except:
+ return json.dumps(retdata)
+
for row in data:
escaped = html.escape(row[0])
retdata.append([escaped, row[1], row[2]])
@@ -1112,15 +1127,24 @@ class SpiderFootWebUi:
# Search
def search(self, id=None, eventType=None, value=None):
- retdata = self.searchBase(id, eventType, value)
- return json.dumps(retdata, ensure_ascii=False)
+ try:
+ data = self.searchBase(id, eventType, value)
+ except:
+ return json.dumps([])
+
+ return json.dumps(data, ensure_ascii=False)
search.exposed = True
# Historical data for the scan, graphs will be rendered in JS
def scanhistory(self, id):
dbh = SpiderFootDb(self.config)
- data = dbh.scanResultHistory(id)
+
+ try:
+ data = dbh.scanResultHistory(id)
+ except:
+ return json.dumps([])
+
return json.dumps(data, ensure_ascii=False)
scanhistory.exposed = True
diff --git a/test/unit/test_spiderfootdb.py b/test/unit/test_spiderfootdb.py
index a653d64b..c7d107ec 100644
--- a/test/unit/test_spiderfootdb.py
+++ b/test/unit/test_spiderfootdb.py
@@ -151,11 +151,12 @@ class TestSpiderFootDb(unittest.TestCase):
"""
sfdb = SpiderFootDb(self.default_options, False)
+ instance_id = "example instance id"
invalid_types = [None, list(), dict()]
for invalid_type in invalid_types:
with self.subTest(invalid_type=invalid_type):
with self.assertRaises(TypeError) as cm:
- sfdb.scanLogEvent("", invalid_type, "")
+ sfdb.scanLogEvent(instance_id, invalid_type, "")
def test_scan_log_event_invalid_message_should_raise(self):
"""
@@ -163,11 +164,12 @@ class TestSpiderFootDb(unittest.TestCase):
"""
sfdb = SpiderFootDb(self.default_options, False)
+ instance_id = "example instance id"
invalid_types = [None, list(), dict()]
for invalid_type in invalid_types:
with self.subTest(invalid_type=invalid_type):
with self.assertRaises(TypeError) as cm:
- sfdb.scanLogEvent("", "", invalid_type)
+ sfdb.scanLogEvent(instance_id, "", invalid_type)
@unittest.skip("todo")
def test_scan_instance_create(self):
@@ -179,6 +181,48 @@ class TestSpiderFootDb(unittest.TestCase):
self.assertEqual('TBD', 'TBD')
+ def test_scan_instance_create_invalid_instanceid_should_raise(self):
+ """
+ Test scanInstanceCreate(self, instanceId, scanName, scanTarget)
+ """
+ sfdb = SpiderFootDb(self.default_options, False)
+
+ scan_name = ""
+ scan_target = "spiderfoot.net"
+ invalid_types = [None, list(), dict()]
+ for invalid_type in invalid_types:
+ with self.subTest(invalid_type=invalid_type):
+ with self.assertRaises(TypeError) as cm:
+ sfdb.scanInstanceCreate(invalid_type, scan_name, scan_target)
+
+ def test_scan_instance_create_invalid_scan_name_should_raise(self):
+ """
+ Test scanInstanceCreate(self, instanceId, scanName, scanTarget)
+ """
+ sfdb = SpiderFootDb(self.default_options, False)
+
+ instance_id = "example instance id"
+ scan_target = "spiderfoot.net"
+ invalid_types = [None, list(), dict()]
+ for invalid_type in invalid_types:
+ with self.subTest(invalid_type=invalid_type):
+ with self.assertRaises(TypeError) as cm:
+ sfdb.scanInstanceCreate(instance_id, invalid_type, scan_target)
+
+ def test_scan_instance_create_invalid_scan_target_should_raise(self):
+ """
+ Test scanInstanceCreate(self, instanceId, scanName, scanTarget)
+ """
+ sfdb = SpiderFootDb(self.default_options, False)
+
+ instance_id = "example instance id"
+ scan_name = ""
+ invalid_types = [None, list(), dict()]
+ for invalid_type in invalid_types:
+ with self.subTest(invalid_type=invalid_type):
+ with self.assertRaises(TypeError) as cm:
+ sfdb.scanInstanceCreate(instance_id, scan_name, invalid_type)
+
def test_scan_instance_set(self):
"""
Test scanInstanceSet(self, instanceId, started=None, ended=None, status=None)
@@ -208,7 +252,8 @@ class TestSpiderFootDb(unittest.TestCase):
"""
sfdb = SpiderFootDb(self.default_options, False)
- scan_results_summary = sfdb.scanResultSummary("", "type")
+ instance_id = "example instance id"
+ scan_results_summary = sfdb.scanResultSummary(instance_id, "type")
self.assertIsInstance(scan_results_summary, list)
def test_scan_result_summary_invalid_type_should_raise(self):
@@ -217,18 +262,30 @@ class TestSpiderFootDb(unittest.TestCase):
"""
sfdb = SpiderFootDb(self.default_options, False)
- with self.assertRaises(ValueError) as cm:
- scan_results_summary = sfdb.scanResultSummary(None, None)
+ invalid_types = [None, list(), dict()]
+ for invalid_type in invalid_types:
+ with self.subTest(invalid_type=invalid_type):
+ with self.assertRaises(TypeError) as cm:
+ scan_results_summary = sfdb.scanResultSummary(invalid_type)
+
+ instance_id = "example instance id"
+ invalid_types = [None, list(), dict()]
+ for invalid_type in invalid_types:
+ with self.subTest(invalid_type=invalid_type):
+ with self.assertRaises(TypeError) as cm:
+ scan_results_summary = sfdb.scanResultSummary(instance_id, None)
with self.assertRaises(ValueError) as cm:
- scan_results_summary = sfdb.scanResultSummary("", "invalid filter type")
+ scan_results_summary = sfdb.scanResultSummary(instance_id, "invalid filter type")
def test_scan_result_event_should_return_a_list(self):
"""
Test scanResultEvent(self, instanceId, eventType='ALL', filterFp=False)
"""
sfdb = SpiderFootDb(self.default_options, False)
- scan_result_event = sfdb.scanResultEvent("", "", False)
+
+ instance_id = "example instance id"
+ scan_result_event = sfdb.scanResultEvent(instance_id, "", False)
self.assertIsInstance(scan_result_event, list)
def test_scan_result_event_invalid_event_type_should_raise(self):
@@ -237,18 +294,21 @@ class TestSpiderFootDb(unittest.TestCase):
"""
sfdb = SpiderFootDb(self.default_options, False)
+ instance_id = "example instance id"
invalid_types = [None, list(), dict()]
for invalid_type in invalid_types:
with self.subTest(invalid_type=invalid_type):
with self.assertRaises(TypeError) as cm:
- scan_result_event = sfdb.scanResultEvent("", invalid_type, None)
+ scan_result_event = sfdb.scanResultEvent(instance_id, invalid_type, None)
def test_scan_result_event_unique_should_return_a_list(self):
"""
Test scanResultEventUnique(self, instanceId, eventType='ALL', filterFp=False)
"""
sfdb = SpiderFootDb(self.default_options, False)
- scan_result_event = sfdb.scanResultEventUnique("", "", False)
+
+ instance_id = "example instance id"
+ scan_result_event = sfdb.scanResultEventUnique(instance_id, "", False)
self.assertIsInstance(scan_result_event, list)
def test_scan_result_event_unique_invalid_event_type_should_raise(self):
@@ -257,18 +317,21 @@ class TestSpiderFootDb(unittest.TestCase):
"""
sfdb = SpiderFootDb(self.default_options, False)
+ instance_id = "example instance id"
invalid_types = [None, list(), dict()]
for invalid_type in invalid_types:
with self.subTest(invalid_type=invalid_type):
with self.assertRaises(TypeError) as cm:
- scan_result_event = sfdb.scanResultEventUnique("", invalid_type, None)
+ scan_result_event = sfdb.scanResultEventUnique(instance_id, invalid_type, None)
def test_scan_logs_should_return_a_list(self):
"""
Test scanLogs(self, instanceId, limit=None, fromRowId=None, reverse=False)
"""
sfdb = SpiderFootDb(self.default_options, False)
- scan_logs = sfdb.scanLogs(None, None, None, None)
+
+ instance_id = "example instance id"
+ scan_logs = sfdb.scanLogs(instance_id, None, None, None)
self.assertIsInstance(scan_logs, list)
self.assertEqual('TBD', 'TBD')
@@ -278,16 +341,17 @@ class TestSpiderFootDb(unittest.TestCase):
Test scanErrors(self, instanceId, limit=None)
"""
sfdb = SpiderFootDb(self.default_options, False)
- scan_instance = sfdb.scanErrors(None, None)
+ instance_id = "example instance id"
+ scan_instance = sfdb.scanErrors(instance_id, None)
self.assertIsInstance(scan_instance, list)
- @unittest.skip("todo")
def test_scan_instance_delete(self):
"""
Test scanInstanceDelete(self, instanceId)
"""
sfdb = SpiderFootDb(self.default_options, False)
- sfdb.scanConfigDelete(None)
+ instance_id = "example instance id"
+ scan_instance_delete = sfdb.scanInstanceDelete(instance_id)
self.assertEqual('TBD', 'TBD')
@@ -296,6 +360,7 @@ class TestSpiderFootDb(unittest.TestCase):
"""
Test scanResultsUpdateFP(self, instanceId, resultHashes, fpFlag)
"""
+ instance_id = "example instance id"
self.assertEqual('TBD', 'TBD')
def test_config_set_should_set_config_opts(self):
@@ -375,20 +440,39 @@ class TestSpiderFootDb(unittest.TestCase):
Test scanConfigGet(self, instanceId)
"""
sfdb = SpiderFootDb(self.default_options, False)
- scan_config = sfdb.scanConfigGet(None)
+
+ instance_id = "example instance id"
+ scan_config = sfdb.scanConfigGet(instance_id)
self.assertIsInstance(scan_config, dict)
+ def test_scan_event_store_invalid_instanceid_should_raise(self):
+ """
+ Test scanEventStore(self, instanceId, sfEvent, truncateSize=0)
+ """
+ sfdb = SpiderFootDb(self.default_options, False)
+
+ event = ""
+ invalid_types = [None, list(), dict()]
+ for invalid_type in invalid_types:
+ with self.subTest(invalid_type=invalid_type):
+ with self.assertRaises(TypeError) as cm:
+ sfdb.scanEventStore(invalid_type, event)
+
+ with self.assertRaises(ValueError) as cm:
+ sfdb.scanEventStore("", event)
+
def test_scan_event_store_invalid_event_should_raise(self):
"""
Test scanEventStore(self, instanceId, sfEvent, truncateSize=0)
"""
sfdb = SpiderFootDb(self.default_options, False)
- invalid_types = [None, "", dict()]
+ instance_id = "example instance id"
+ invalid_types = [None, "", list(), dict()]
for invalid_type in invalid_types:
with self.subTest(invalid_type=invalid_type):
with self.assertRaises(TypeError) as cm:
- sfdb.scanEventStore("", invalid_type)
+ sfdb.scanEventStore(instance_id, invalid_type)
def test_scan_instance_list_should_return_a_list(self):
"""
@@ -405,28 +489,44 @@ class TestSpiderFootDb(unittest.TestCase):
"""
sfdb = SpiderFootDb(self.default_options, False)
- scan_result_history = sfdb.scanResultHistory(None)
+ instance_id = "example instance id"
+ scan_result_history = sfdb.scanResultHistory(instance_id)
self.assertIsInstance(scan_result_history, list)
- @unittest.skip("todo")
def test_scan_element_sources_direct_should_return_a_list(self):
"""
Test scanElementSourcesDirect(self, instanceId, elementIdList)
"""
sfdb = SpiderFootDb(self.default_options, False)
- scan_element_sources_direct = sfdb.scanElementSourcesDirect(None, None)
+ instance_id = "example instance id"
+ element_id_list = []
+ scan_element_sources_direct = sfdb.scanElementSourcesDirect(instance_id, element_id_list)
self.assertIsInstance(scan_element_sources_direct, list)
self.assertEqual('TBD', 'TBD')
+ def test_scan_element_sources_direct_invalid_instanceid_should_raise(self):
+ """
+ Test scanElementSourcesDirect(self, instanceId, elementIdList)
+ """
+ sfdb = SpiderFootDb(self.default_options, False)
+
+ element_id_list = []
+ invalid_types = [None, list(), dict()]
+ for invalid_type in invalid_types:
+ with self.subTest(invalid_type=invalid_type):
+ with self.assertRaises(TypeError) as cm:
+ scan_element_sources_direct = sfdb.scanElementSourcesDirect(invalid_type, element_id_list)
+
def test_scan_element_children_direct_should_return_a_list(self):
"""
Test scanElementChildrenDirect(self, instanceId, elementIdList)
"""
sfdb = SpiderFootDb(self.default_options, False)
- scan_element_children_direct = sfdb.scanElementChildrenDirect(None, list())
+ instance_id = "example instance id"
+ scan_element_children_direct = sfdb.scanElementChildrenDirect(instance_id, list())
self.assertIsInstance(scan_element_children_direct, list)
self.assertEqual('TBD', 'TBD')
@@ -437,11 +537,12 @@ class TestSpiderFootDb(unittest.TestCase):
"""
sfdb = SpiderFootDb(self.default_options, False)
+ instance_id = "example instance id"
invalid_types = [None, "", dict()]
for invalid_type in invalid_types:
with self.subTest(invalid_type=invalid_type):
with self.assertRaises(TypeError) as cm:
- scan_element_children_direct = sfdb.scanElementChildrenDirect("", invalid_type)
+ scan_element_children_direct = sfdb.scanElementChildrenDirect(instance_id, invalid_type)
@unittest.skip("todo")
def test_scan_element_sources_all_should_return_a_list(self):
@@ -450,7 +551,9 @@ class TestSpiderFootDb(unittest.TestCase):
"""
sfdb = SpiderFootDb(self.default_options, False)
- scan_element_sources_all = sfdb.scanElementSourcesAll(None, list())
+ instance_id = "example instance id"
+ child_data = []
+ scan_element_sources_all = sfdb.scanElementSourcesAll(instance_id, child_data)
self.assertIsInstance(scan_element_sources_all, list)
self.assertEqual('TBD', 'TBD')
@@ -461,14 +564,15 @@ class TestSpiderFootDb(unittest.TestCase):
"""
sfdb = SpiderFootDb(self.default_options, False)
+ instance_id = "example instance id"
invalid_types = [None, "", dict()]
for invalid_type in invalid_types:
with self.subTest(invalid_type=invalid_type):
with self.assertRaises(TypeError) as cm:
- scan_element_sources_all = sfdb.scanElementSourcesAll("", invalid_type)
+ scan_element_sources_all = sfdb.scanElementSourcesAll(instance_id, invalid_type)
with self.assertRaises(ValueError) as cm:
- scan_element_sources_all = sfdb.scanElementSourcesAll("", list())
+ scan_element_sources_all = sfdb.scanElementSourcesAll(instance_id, list())
def test_scan_element_children_all_should_return_a_list(self):
"""
@@ -476,7 +580,8 @@ class TestSpiderFootDb(unittest.TestCase):
"""
sfdb = SpiderFootDb(self.default_options, False)
- scan_element_children_all = sfdb.scanElementChildrenAll(None, list())
+ instance_id = "example instance id"
+ scan_element_children_all = sfdb.scanElementChildrenAll(instance_id, list())
self.assertIsInstance(scan_element_children_all, list)
self.assertEqual('TBD', 'TBD')
@@ -487,11 +592,12 @@ class TestSpiderFootDb(unittest.TestCase):
"""
sfdb = SpiderFootDb(self.default_options, False)
+ instance_id = "example instance id"
invalid_types = [None, "", dict()]
for invalid_type in invalid_types:
with self.subTest(invalid_type=invalid_type):
with self.assertRaises(TypeError) as cm:
- scan_element_children_all = sfdb.scanElementChildrenAll("", invalid_type)
+ scan_element_children_all = sfdb.scanElementChildrenAll(instance_id, invalid_type)
if __name__ == '__main__':
unittest.main()