Code format (#54)

* Reformat code with Black linter

* Update makefile

Author: manmolecular

Makefile

@@ -17,3 +17,4 @@ tests:
 
 clean:
 	docker-compose down
+	docker volume rm osint-framework_postgres -f

src/core/base/base.py

@@ -11,6 +11,7 @@ class BaseRunner:
     """
     Defines base runner class to create childs from
     """
+
     required = []
 
     def __init__(self, logger: str = __name__):

src/core/runner/manager.py

@@ -28,7 +28,9 @@ class CaseManager:
         "default": BaseCase,
     }
 
-    def __init__(self, cases: list or None = None, max_workers: int = CoreDefaults.MAX_PROCESSES):
+    def __init__(
+        self, cases: list or None = None, max_workers: int = CoreDefaults.MAX_PROCESSES
+    ):
         """
         Init manager
         :param cases: cases to run
@@ -63,10 +65,7 @@ def single_case_runner(
             "case_class": self.MAPPING.get(case_class, "default").__name__,
             "case_name": case_name,
             "case_description": case_description,
-            "case_data": {
-                "args": args,
-                "kwargs": kwargs
-            },
+            "case_data": {"args": args, "kwargs": kwargs},
             "case_results": case.get_results() or {},
         }
 
@@ -93,7 +92,8 @@ def multi_case_runner(
                     case_description=case.get("description"),
                     *case.get("args", []),
                     **case.get("kwargs", {}),
-                ): sleep(1.0) for case in cases
+                ): sleep(1.0)
+                for case in cases
             }
         for future in as_completed(futures):
             yield future.result()

src/core/runner/runner.py

@@ -119,7 +119,7 @@ def run_category(
         max_workers: int = CoreDefaults.MAX_THREADS,
         timeout: int = CoreDefaults.CASE_TIMEOUT,
         *args,
-        **kwargs
+        **kwargs,
     ) -> None:
         """
         Run a category with scripts
@@ -132,7 +132,9 @@ def run_category(
             self.get_scripts()
         with ThreadPoolExecutor(max_workers=max_workers) as executor:
             futures = {
-                executor.submit(self.exec_script, path=script, args=args, kwargs=kwargs): sleep(0.1)
+                executor.submit(
+                    self.exec_script, path=script, args=args, kwargs=kwargs
+                ): sleep(0.1)
                 for script in self.scripts.get(category, [])
             }
         try:

src/core/utils/log.py

@@ -31,7 +31,11 @@ def get_logger(name: str, separate_name: bool = True) -> getLogger:
         formatter = Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
 
         # Choose the right handler: color Rich handler for CLI, StreamHandler for server part and Docker
-        handler = RichHandler() if environ.get("LOG_HANDLER", default="rich") == "rich" else StreamHandler()
+        handler = (
+            RichHandler()
+            if environ.get("LOG_HANDLER", default="rich") == "rich"
+            else StreamHandler()
+        )
         handler.setFormatter(formatter)
 
         logger.addHandler(handler)

src/core/values/defaults.py

@@ -19,7 +19,9 @@ class TestDefaults:
     PORT_RANGE = (20_000, 65_535)
     PORT = None
 
-    def __init__(self, host: str or None = None, down_timeout: float or None = None) -> None:
+    def __init__(
+        self, host: str or None = None, down_timeout: float or None = None
+    ) -> None:
         """
         Init random port
         :param host: host to set

src/db/crud.py

@@ -35,7 +35,7 @@ def wrapped_function(*args, **kwargs):
                 try:
                     return function(*args, **kwargs)
                 except exc.DBAPIError:
-                    sleep(0.5*attempt)
+                    sleep(0.5 * attempt)
                     continue
             return function(*args, **kwargs)
 

src/db/database.py

@@ -24,7 +24,8 @@ class DefaultValues:
     f"postgres+psycopg2://"
     f"{DefaultValues.POSTGRES_USER}:{DefaultValues.POSTGRES_PASSWORD}@"
     f"{DefaultValues.POSTGRES_HOST}:{str(DefaultValues.POSTGRES_PORT)}/"
-    f"{DefaultValues.POSTGRES_DATABASE}", poolclass=NullPool
+    f"{DefaultValues.POSTGRES_DATABASE}",
+    poolclass=NullPool,
 )
 if not database_exists(Engine.url):
     create_database(Engine.url)

src/queue/consumer.py

@@ -14,18 +14,17 @@
 
 
 class Consumer:
-    def __init__(self, host: str = Default.RABBITMQ_HOST, port: int = Default.RABBITMQ_PORT):
+    def __init__(
+        self, host: str = Default.RABBITMQ_HOST, port: int = Default.RABBITMQ_PORT
+    ):
         """
         Init rabbitmq consumer
         :param host: rabbitmq host
         :param port: rabbitmq port
         """
         self.queue = Default.QUEUE
         self.connection = pika.BlockingConnection(
-            pika.ConnectionParameters(
-                host=host,
-                port=port,
-            )
+            pika.ConnectionParameters(host=host, port=port,)
         )
         self.channel = self.connection.channel()
         self.channel.queue_declare(queue=self.queue)
@@ -82,4 +81,4 @@ def __del__(self):
         try:
             self.connection.close()
         except:
-            pass
+            pass

src/queue/defaults.py

@@ -7,4 +7,4 @@ class DefaultValues:
     RABBITMQ_HOST = str(environ.get("RABBITMQ_HOST", default="localhost"))
     RABBITMQ_PORT = int(environ.get("RABBITMQ_PORT", default=5672))
 
-    QUEUE = "case_queue"
+    QUEUE = "case_queue"

src/queue/publisher.py

@@ -12,18 +12,17 @@
 
 
 class Publisher:
-    def __init__(self, host: str = Default.RABBITMQ_HOST, port: int = Default.RABBITMQ_PORT):
+    def __init__(
+        self, host: str = Default.RABBITMQ_HOST, port: int = Default.RABBITMQ_PORT
+    ):
         """
         Init rabbitmq publisher
         :param host: rabbitmq host
         :param port: rabbitmq port
         """
         self.queue = Default.QUEUE
         self.connection = pika.BlockingConnection(
-            pika.ConnectionParameters(
-                host=host,
-                port=port,
-            )
+            pika.ConnectionParameters(host=host, port=port,)
         )
         self.channel = self.connection.channel()
         result = self.channel.queue_declare(queue="", exclusive=True)
@@ -76,4 +75,4 @@ def __del__(self):
         try:
             self.connection.close()
         except:
-            pass
+            pass

src/scripts/convert/email_generator/module.py

@@ -51,6 +51,7 @@ class Runner(BaseRunner):
     """
     Class that generates different email addresses
     """
+
     required = ["username"]
 
     def __init__(self, logger: str = __name__):

src/scripts/convert/phone_num_generator/__main__.py

@@ -8,6 +8,6 @@
 runner = Runner()
 result = runner.run(
     phone=argv[1] if len(argv) >= 2 else "+79131161111",
-    region=argv[2] if len(argv) >= 3 else "ru"
+    region=argv[2] if len(argv) >= 3 else "ru",
 )
 pprint(result)

src/scripts/convert/phone_num_generator/module.py

@@ -10,6 +10,7 @@ class Runner(OsintRunner):
     """
     Class that generates different phone numbers
     """
+
     required = ["phone", "region"]
 
     def __init__(self, logger: str = __name__):
@@ -33,9 +34,10 @@ def __gen_all(formatted_num: str) -> [str]:
             num_list.append(joined)
         phone_w_brackets = "{prefix}({code}){rest}".format(
             prefix=number_groups[0],
-            code=number_groups[1][1:-1] if number_groups[1][0] == '(' and number_groups[1][-1] == ')' else
-            number_groups[1],
-            rest="".join(number_groups[2:])
+            code=number_groups[1][1:-1]
+            if number_groups[1][0] == "(" and number_groups[1][-1] == ")"
+            else number_groups[1],
+            rest="".join(number_groups[2:]),
         )
         num_list.append(phone_w_brackets)
         return num_list
@@ -53,15 +55,18 @@ def run(self, *args, **kwargs) -> ScriptResponse.success or ScriptResponse.error
             region = kwargs.get("region")
             parsed_num = parse(phone, region)
         except NumberParseException:
-            return ScriptResponse.error(result=None, message="Not viable number or not international format")
+            return ScriptResponse.error(
+                result=None, message="Not viable number or not international format"
+            )
         except Exception:
             return ScriptResponse.error(result=None, message="Something went wrong!")
         try:
             result = [
-                phone for phone_format in [
+                phone
+                for phone_format in [
                     PhoneNumberFormat.NATIONAL,
                     PhoneNumberFormat.INTERNATIONAL,
-                    PhoneNumberFormat.E164
+                    PhoneNumberFormat.E164,
                 ]
                 for phone in self.__gen_all(format_number(parsed_num, phone_format))
             ]

src/scripts/convert/phone_num_generator/test_module.py

@@ -5,20 +5,19 @@
 
 
 class Test(unittest.TestCase):
-
     def setUp(self):
         self.runner = module.Runner()
 
     def test_num_1(self):
         runner = Runner()
         response = runner.run(phone="+442083661177", region=None)
-        self.assertIn("020-8366-1177", response.get('result'))
+        self.assertIn("020-8366-1177", response.get("result"))
 
     def test_num_2(self):
         runner = Runner()
         response = runner.run(phone="8137777777", region="RU")
-        self.assertIn("+7-813-777-77-77", response.get('result'))
+        self.assertIn("+7-813-777-77-77", response.get("result"))
 
 
-if __name__ == '_main_':
+if __name__ == "_main_":
     unittest.main()

src/scripts/osint/check_nickname/module.py

@@ -67,6 +67,7 @@ class Runner(OsintRunner):
     """
     Class that performs nickname check
     """
+
     required = ["username"]
 
     def __init__(self, logger: str = __name__):

src/scripts/osint/check_nickname/test_module.py

@@ -32,7 +32,9 @@ def test_nicknames(self) -> None:
         response = self.runner.run(username="")
         self.assertEqual(response.get("status"), "success")
         for _ in range(5):
-            nickname = "".join(choice(string.ascii_letters) for _ in range(randrange(5, 10)))
+            nickname = "".join(
+                choice(string.ascii_letters) for _ in range(randrange(5, 10))
+            )
             response = self.runner.run(username=nickname)
             self.assertEqual(response.get("status"), "success")
 
@@ -45,6 +47,8 @@ def test_special_nicknames(self) -> None:
         response = self.runner.run(username=None)
         self.assertEqual(response.get("status"), "error")
         for _ in range(5):
-            nickname = "".join(choice(string.punctuation) for _ in range(randrange(3, 5)))
+            nickname = "".join(
+                choice(string.punctuation) for _ in range(randrange(3, 5))
+            )
             response = self.runner.run(username=nickname)
             self.assertEqual(response.get("status"), "error")

src/scripts/osint/check_vk_reg/module.py

@@ -43,6 +43,7 @@ class Runner(OsintRunner):
     """
     Class that performs VK.com registration status (by phone number)
     """
+
     required = ["phone"]
 
     def __init__(self, logger: str = __name__) -> None:
@@ -158,7 +159,11 @@ def __get_driver_path(self) -> str:
         path: str = str(
             Path(__file__).parent.parent.parent.parent
             / "drivers"
-            / ("chromedriver_" + system + ".exe" if system == "windows" else "chromedriver_" + system)
+            / (
+                "chromedriver_" + system + ".exe"
+                if system == "windows"
+                else "chromedriver_" + system
+            )
         )
 
         self.__set_execution_rights(path)

src/scripts/osint/email_verifier/module.py

@@ -11,6 +11,7 @@ class Runner(OsintRunner):
     """
     Class that performs email verification
     """
+
     required = ["email"]
 
     def __init__(self, logger: str = __name__):

src/scripts/osint/extremism/module.py

@@ -11,6 +11,7 @@ class Runner(OsintRunner):
     """
     Class that performs Russian Extremists list check
     """
+
     required = ["fullname"]
 
     def __init__(self, logger: str = __name__):

src/scripts/osint/region_check/module.py

@@ -11,6 +11,7 @@ class Runner(OsintRunner):
     """
     Class that performs region check by phone number
     """
+
     required = ["phone"]
 
     def __init__(self, logger: str = __name__):

src/scripts/other/network_usage/module.py

@@ -10,6 +10,7 @@ class Runner(ReconRunner):
     """
     Simple example module to returh headers
     """
+
     required = ["hostname"]
 
     def __init__(self, logger: str = __name__):

src/scripts/other/simple_example/module.py

@@ -9,6 +9,7 @@ class Runner(BaseRunner):
     """
     Basic example
     """
+
     required = []
 
     def __init__(self, logger: str = __name__):

src/scripts/other/user_greeting/module.py

@@ -9,6 +9,7 @@ class Runner(OsintRunner):
     """
     Class that greets users
     """
+
     required = ["username"]
 
     def __init__(self, logger: str = __name__):

src/scripts/recon/allowed_methods/module.py

@@ -56,6 +56,7 @@ class Runner(ReconRunner):
     """
     Class that performs allowed methods check
     """
+
     required = ["url"]
 
     def __init__(self, logger: str = __name__):

src/scripts/recon/cookie_checker/module.py

@@ -11,6 +11,7 @@ class Runner(ReconRunner):
     """
     Class that performs cookie flags checking.
     """
+
     required = ["url"]
 
     def __init__(self, logger: str = __name__):

src/scripts/recon/get_host_status/module.py

@@ -10,6 +10,7 @@ class Runner(ReconRunner):
     """
     Class that performs host status check
     """
+
     required = ["url"]
 
     def __init__(self, logger: str = __name__):

src/scripts/recon/get_title/module.py

@@ -11,6 +11,7 @@ class Runner(ReconRunner):
     """
     Class that performs HTTP title checking
     """
+
     required = ["url"]
 
     def __init__(self, logger: str = __name__):

src/scripts/recon/ip_info/__main__.py

@@ -4,8 +4,6 @@
 from src.core.utils.module import run_module
 from .module import Runner
 
-result = run_module(
-    Runner, args=argv, arg_name="ip", arg_default="8.8.8.8"
-)
+result = run_module(Runner, args=argv, arg_name="ip", arg_default="8.8.8.8")
 
 pprint(result)