SpiderFoot automates OSINT for threat intelligence and mapping your attack surface.
Python attacksurfacecticybersecurityfootprintinghackinginformation-gatheringinformation-securityinfosecintelligence-gatheringosintosint-frameworkosint-reconnaissanceosint-toolpentestingpythonreconsecurity-toolsthreat-intelligencethreatintel
sfscan: SpiderFootScanner raise TypeError for invalid param types upon init
Brendan Colesf7267a036d50
diff --git a/sfscan.py b/sfscan.pyindex 72115173..17aa689f 100644--- a/sfscan.py+++ b/sfscan.py@@ -25,10 +25,34 @@ class SpiderFootScanner():# Temporary storagetemp = None- # moduleOpts not yet useddef __init__(self, scanName, scanTarget, targetType, scanId, moduleList,globalOpts, moduleOpts):-+ """Initialize SpiderFootScanner object and immediately start a scan+ of the specified target.++ Args:+ scanName (str): name of the scan+ scanTarget (str): scan target+ targetType (str): scan target type+ scanId (str): scan identifier+ moduleList (list): list of modules to run+ globalOpts (dict): scan options+ moduleOpts (dict): unused++ Returns:+ None+ """++ 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))+ if not isinstance(scanId, str):+ raise TypeError("scanId is %s; expected str()" % type(scanId))+ if not isinstance(moduleList, list):+ raise TypeError("moduleList is %s; expected list()" % type(moduleList))+ if not isinstance(globalOpts, dict):+ raise TypeError("globalOpts is %s; expected dict()" % type(globalOpts))self.temp = dict()self.temp['config'] = deepcopy(globalOpts)@@ -39,8 +63,18 @@ class SpiderFootScanner():self.temp['scanId'] = scanIdself.startScan()- # Set the status of the currently running scan (if any)def setStatus(self, status, started=None, ended=None):+ """Set the status of the currently running scan (if any).++ Args:+ status (str): scan status ("RUNNING", "STARTING", "STARTED", "ABORT-REQUESTED", "ABORTED", "FINISHED", "ERROR-FAILED")+ started (str): TBD+ ended (str): TBD++ Returns:+ None+ """+#if self is None:# print(("Internal Error: Status set attempted before " + \# "SpiderFootScanner was ready."))@@ -51,6 +85,7 @@ class SpiderFootScanner():return Nonedef run(self):+ """Start running a scan."""self.startScan()def getId(self):@@ -58,9 +93,8 @@ class SpiderFootScanner():return self.scanIdreturn None- # Start running a scandef startScan(self):-+ """Start running a scan."""self.moduleInstances = dict()self.sf = SpiderFoot(self.temp['config'])self.config = deepcopy(self.temp['config'])@@ -258,4 +292,4 @@ class SpiderFootScanner():self.sf.status("Scan [" + self.scanId + "] failed: " + str(e))self.setStatus("ERROR-FAILED", None, time.time() * 1000)- self.dbh.close()\ No newline at end of file+ self.dbh.close()diff --git a/test/unit/test_spiderfootscanner.py b/test/unit/test_spiderfootscanner.pynew file mode 100644index 00000000..bbf496ab--- /dev/null+++ b/test/unit/test_spiderfootscanner.py@@ -0,0 +1,55 @@+# test_spiderfootscanner.py+from sfscan import SpiderFootScanner+import unittest++class TestSpiderFootScanStatus(unittest.TestCase):+ """+ Test SpiderFootScanStatus+ """++ def test_init_no_options_should_raise(self):+ """+ Test __init__(self, scanName, scanTarget, targetType, scanId, moduleList, globalOpts, moduleOpts)+ """+ with self.assertRaises(TypeError) as cm:+ sfscan = SpiderFootScanner(None, None, None, None, None, None, None)++ @unittest.skip("todo")+ def test_init(self):+ """+ Test __init__(self, scanName, scanTarget, targetType, scanId, moduleList, globalOpts, moduleOpts)+ """+ #sfscan = SpiderFootScanner("", "", "", "", list(), dict(), dict())+ self.assertEqual('TBD', 'TBD')++ @unittest.skip("todo")+ def test_set_status_should_return_none(self):+ """+ Test def setStatus(self, status, started=None, ended=None)+ """+ self.assertEqual('TBD', 'TBD')++ @unittest.skip("todo")+ def test_run_should_return_none(self):+ """+ Test def run(self)+ """+ self.assertEqual('TBD', 'TBD')++ @unittest.skip("todo")+ def test_get_id_should_return_none(self):+ """+ Test def getId(self)+ """+ self.assertEqual('TBD', 'TBD')++ @unittest.skip("todo")+ def test_start_scan_should_return_none(self):+ """+ Test def startScan(self)+ """+ self.assertEqual('TBD', 'TBD')++if __name__ == '__main__':+ unittest.main()+