feat(zettabgp): add docstrings

Author: DlieBG

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Benedikt Schwering
+Copyright (c) 2024 Benedikt Schwering and Sebastian Forstner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

src/adapters/mongodb.py

@@ -1,3 +1,15 @@
+# -*- coding: utf-8 -*-
+'''
+ZettaBGP - Advanced Anomaly Detection in Internet Routing
+Copyright (c) 2024 Benedikt Schwering and Sebastian Forstner
+
+This work is licensed under the terms of the MIT license.
+For a copy, see LICENSE in the project root.
+
+Author:
+    Benedikt Schwering <bes9584@thi.de>
+    Sebastian Forstner <sef9869@thi.de>
+'''
 from src.parsers.route_update import RouteUpdateParser
 from src.models.route_update import RouteUpdate
 from src.models.route_update import ChangeType
@@ -7,10 +19,28 @@
 import os
 
 class MongoDBAdapter:
-    '''This class is responsible for receiving the parsed messages and forwarding them to both MongoDB databases'''
+    '''
+    This class is responsible for receiving the parsed messages and forwarding them to both MongoDB databases.
+
+    Author:
+        Sebastian Forstner <sef9869@thi.de>
+    '''
     def __init__(self, parser: RouteUpdateParser, no_mongodb_log: bool, no_mongodb_state: bool, no_mongodb_statistics: bool, clear_mongodb: bool):
+        '''
+        Initializes the MongoDBAdapter.
+
+        Author:
+            Sebastian Forstner <sef9869@thi.de>
+
+        Args:
+            parser (RouteUpdateParser): The parser to receive the parsed messages from.
+            no_mongodb_log (bool): Whether to disable the log storage.
+            no_mongodb_state (bool): Whether to disable the state storage.
+            no_mongodb_statistics (bool): Whether to disable the statistics storage.
+            clear_mongodb (bool): Whether to clear the MongoDB databases.
+        '''
         try:
-            '''Connects to MongoDB-Container running with Docker'''
+            # Connects to MongoDB-Container running with Docker
             database_client = MongoClient(
                 host=os.getenv('MONGO_DB_HOST', 'localhost'),
                 port=int(os.getenv('MONGO_DB_PORT', 27017)),
@@ -21,21 +51,22 @@ def __init__(self, parser: RouteUpdateParser, no_mongodb_log: bool, no_mongodb_s
         log_flag = no_mongodb_log
         state_flag = no_mongodb_state
         statistics_flag = no_mongodb_statistics
-        '''Creates database and collection for log storrage'''
+
+        # Creates database and collection for log storage
         if not log_flag:
             log_db = database_client.message_log
             log_collection = log_db.storage
             if clear_mongodb:
                 log_collection.delete_many({})
 
-        '''Creates database and collection for state storrage'''
+        # Creates database and collection for state storage
         if not state_flag:
             state_db = database_client.message_state
             state_collection = state_db.storage
             if clear_mongodb:
                 state_collection.delete_many({})
 
-        '''Creates database and collection for statistics storrage'''
+        # Creates database and collection for statistics storage
         if not statistics_flag:
             statistics_db = database_client.message_statistics
             statistics_collection = statistics_db.storage
@@ -45,7 +76,7 @@ def __init__(self, parser: RouteUpdateParser, no_mongodb_log: bool, no_mongodb_s
         @parser.on_update
         def on_update(message: RouteUpdate):
 
-            '''saves optional, non-base-type attributes for later use; required to guarantee save use of mongodb'''
+            # Saves optional, non-base-type attributes for later use; required to guarantee save use of mongodb
             if message.path_attributes.origin:
                 origins = message.path_attributes.origin.value
             else:
@@ -75,7 +106,7 @@ def on_update(message: RouteUpdate):
                     else:
                         extended_community.append(str(ext_com)) 
 
-            '''creates dict for message with _id and other unique attributes, that dont change'''
+            # Creates dict for message with _id and other unique attributes, that don't change
             new_message_id = {
                 'timestamp' : message.timestamp,
                 'peer_ip' : message.peer_ip,
@@ -103,7 +134,8 @@ def on_update(message: RouteUpdate):
                 },
                 '_id' : ObjectId(),
             }
-            '''creates dict used for collection updates, MUST NOT contain _id and should not contain other non changing attributes'''
+
+            # Creates dict used for collection updates, MUST NOT contain _id and should not contain other non changing attributes
             set_message = { 
                 '$set': {
                     'timestamp' : message.timestamp,
@@ -127,7 +159,7 @@ def on_update(message: RouteUpdate):
                 }
             }
 
-            '''route got withdrawn, db actions accordingly'''
+            # Route got withdrawn, db actions accordingly
             if message.change_type == ChangeType.WITHDRAW:
                 if not log_flag:
                     log_announce = log_collection.insert_one(new_message_id)
@@ -159,7 +191,7 @@ def on_update(message: RouteUpdate):
                         }
                     statistics_announce = statistics_collection.update_one(statistics_filter, new_values, upsert=True)
 
-            '''route got announced, db actions accordingly'''
+            # Route got announced, db actions accordingly
             if message.change_type == ChangeType.ANNOUNCE:
                 if not log_flag:
                     log_announce = log_collection.insert_one(new_message_id)

src/adapters/rabbitmq.py

@@ -1,25 +1,53 @@
+# -*- coding: utf-8 -*-
+'''
+ZettaBGP - Advanced Anomaly Detection in Internet Routing
+Copyright (c) 2024 Benedikt Schwering and Sebastian Forstner
+
+This work is licensed under the terms of the MIT license.
+For a copy, see LICENSE in the project root.
+
+Author:
+    Benedikt Schwering <bes9584@thi.de>
+    Sebastian Forstner <sef9869@thi.de>
+'''
 from src.parsers.route_update import RouteUpdateParser
 from src.models.route_update import RouteUpdate
 from datetime import timedelta, datetime
 import pika, json, os
 
 class RabbitMQAdapter:
-    '''This class is responsible for receiving the parsed messages and forwarding them to the RabbitMQ message broker'''
+    '''
+    This class is responsible for receiving the parsed messages and forwarding them to the RabbitMQ message broker.
+
+    Author:
+        Benedikt Schwering <bes9584@thi.de>
+    '''
     def __init__(self, parser: RouteUpdateParser, no_direct: bool, queue_interval: int):
+        '''
+        Initializes the RabbitMQAdapter.
+
+        Author:
+            Benedikt Schwering <bes9584@thi.de>
+
+        Args:
+            parser (RouteUpdateParser): The parser to receive the parsed messages from.
+            no_direct (bool): Whether to disable the direct route updates.
+            queue_interval (int): The interval in minutes to group the route updates.
+        '''
         connection = pika.BlockingConnection(
             pika.ConnectionParameters(
                 host=os.getenv('RABBIT_MQ_HOST', 'localhost'),
             )
         )
 
-        '''Creates a channel for the connection and declares the zettabgp exchange'''
+        # Creates a channel for the connection and declares the zettabgp exchange
         channel = connection.channel()
         channel.exchange_declare(
             exchange='zettabgp',
             exchange_type='direct',
         )
 
-        '''Declares the test_bgp_updates queue and binds it to the zettabgp exchange'''
+        # Declares the test_bgp_updates queue and binds it to the zettabgp exchange
         def _declare_test_queue(queue_name: str, routing_key: str):
             channel.queue_declare(
                 queue=queue_name,

src/controllers/mrt_library.py

@@ -1,3 +1,15 @@
+# -*- coding: utf-8 -*-
+'''
+ZettaBGP - Advanced Anomaly Detection in Internet Routing
+Copyright (c) 2024 Benedikt Schwering and Sebastian Forstner
+
+This work is licensed under the terms of the MIT license.
+For a copy, see LICENSE in the project root.
+
+Author:
+    Benedikt Schwering <bes9584@thi.de>
+    Sebastian Forstner <sef9869@thi.de>
+'''
 from src.models.mrt_library import MRTScenarioRequest, MRTScenarioResult, MRTScenario, MRTLibrary
 from src.services.mrt_simulation import mrt_simulation
 from fastapi import APIRouter, HTTPException
@@ -7,6 +19,15 @@
 mrt_library_router = APIRouter()
 
 def _get_mrt_library() -> MRTLibrary:
+    '''
+    This function returns the MRT library.
+
+    Author:
+        Benedikt Schwering <bes9584@thi.de>
+
+    Returns:
+        MRTLibrary: The MRT library.
+    '''
     mrt_library = MRTLibrary(
         scenarios=[],
     )
@@ -28,16 +49,49 @@ def _get_mrt_library() -> MRTLibrary:
     return mrt_library
 
 def _get_mrt_scenario(id: str) -> MRTScenario:
+    '''
+    This function returns an MRT scenario by its ID.
+
+    Author:
+        Benedikt Schwering <bes9584@thi.de>
+
+    Args:
+        id (str): The ID of the MRT scenario.
+
+    Returns:
+        MRTScenario: The MRT scenario.
+    '''
     for scenario in _get_mrt_library().scenarios:
         if scenario.id == id:
             return scenario
 
 @mrt_library_router.get('/')
 def get_mrt_library() -> MRTLibrary:
+    '''
+    This function returns the MRT library.
+
+    Author:
+        Benedikt Schwering <bes9584@thi.de>
+
+    Returns:
+        MRTLibrary: The MRT library.
+    '''
     return _get_mrt_library()
 
 @mrt_library_router.post('/')
 def start_mrt_scenario(mrt_scenario_request: MRTScenarioRequest) -> MRTScenarioResult:
+    '''
+    This function starts an MRT scenario.
+
+    Author:
+        Benedikt Schwering <bes9584@thi.de>
+
+    Args:
+        mrt_scenario_request (MRTScenarioRequest): The MRT scenario request.
+
+    Returns:
+        MRTScenarioResult: The MRT scenario result.
+    '''
     scenario = _get_mrt_scenario(
         id=mrt_scenario_request.id,
     )

src/controllers/version.py

@@ -1,8 +1,29 @@
+# -*- coding: utf-8 -*-
+'''
+ZettaBGP - Advanced Anomaly Detection in Internet Routing
+Copyright (c) 2024 Benedikt Schwering and Sebastian Forstner
+
+This work is licensed under the terms of the MIT license.
+For a copy, see LICENSE in the project root.
+
+Author:
+    Benedikt Schwering <bes9584@thi.de>
+    Sebastian Forstner <sef9869@thi.de>
+'''
 from fastapi import APIRouter
 import pkg_resources
 
 version_router = APIRouter()
 
 @version_router.get('/')
-def get_version():
+def get_version() -> str:
+    '''
+    This function returns the version of the ZettaBGP package.
+
+    Author:
+        Benedikt Schwering <bes9584@thi.de>
+
+    Returns:
+        str: The version of the ZettaBGP package.
+    '''
     return pkg_resources.get_distribution('zettabgp').version

src/main.py

@@ -1,3 +1,15 @@
+# -*- coding: utf-8 -*-
+'''
+ZettaBGP - Advanced Anomaly Detection in Internet Routing
+Copyright (c) 2024 Benedikt Schwering and Sebastian Forstner
+
+This work is licensed under the terms of the MIT license.
+For a copy, see LICENSE in the project root.
+
+Author:
+    Benedikt Schwering <bes9584@thi.de>
+    Sebastian Forstner <sef9869@thi.de>
+'''
 import src.services.mrt_simulation as mrt_simulation_service
 import src.services.exabgp as exabgp_service
 from src.webapp import start_webapp
@@ -47,6 +59,21 @@ def cli():
     is_flag=True,
 )
 def exabgp(no_rabbitmq_direct: bool, rabbitmq_grouped: int, no_mongodb_log: bool, no_mongodb_state: bool, no_mongodb_statistics: bool, clear_mongodb: bool):
+    '''
+    ExaBGP command for retrieving BGP messages from ExaBGP via stdin and processing them.
+
+    Author:
+        Benedikt Schwering <bes9584@thi.de>
+        Sebastian Forstner <sef9869@thi.de>
+
+    Args:
+        no_rabbitmq_direct (bool): Disable direct RabbitMQ direct queue..
+        rabbitmq_grouped (int): Queue group interval in minutes.
+        no_mongodb_log (bool): Disable logging to MongoDB.
+        no_mongodb_state (bool): Disable state storage to MongoDB.
+        no_mongodb_statistics (bool): Disable statistics storage to MongoDB.
+        clear_mongodb (bool): Clear MongoDB collections.
+    '''
     exabgp_service.exabgp(
         no_rabbitmq_direct=no_rabbitmq_direct,
         rabbitmq_grouped=rabbitmq_grouped,
@@ -124,7 +151,25 @@ def exabgp(no_rabbitmq_direct: bool, rabbitmq_grouped: int, no_mongodb_log: bool
     required=True,
     nargs=-1,
 )
-def mrt_simulation(no_rabbitmq_direct: bool, rabbitmq_grouped: int, no_mongodb_log: bool, no_mongodb_state: bool, no_mongodb_statistics: bool, clear_mongodb: bool, playback_speed: int, playback_interval: int, mrt_files: tuple[str]):
+def mrt_simulation(no_rabbitmq_direct: bool, rabbitmq_grouped: int, no_mongodb_log: bool, no_mongodb_state: bool, no_mongodb_statistics: bool, clear_mongodb: bool, playback_speed: int, playback_interval: int, mrt_files: tuple[str, ...]):
+    '''
+    MRT Simulation command for retrieving BGP messages from MRT files and processing them.
+
+    Author:
+        Benedikt Schwering <bes9584@thi.de>
+        Sebastian Forstner <sef9869@thi.de>
+
+    Args:
+        no_rabbitmq_direct (bool): Disable direct RabbitMQ direct queue..
+        rabbitmq_grouped (int): Queue group interval in minutes.
+        no_mongodb_log (bool): Disable logging to MongoDB.
+        no_mongodb_state (bool): Disable state storage to MongoDB.
+        no_mongodb_statistics (bool): Disable statistics storage to MongoDB.
+        clear_mongodb (bool): Clear MongoDB collections.
+        playback_speed (int): Playback speed in multiples of real time.
+        playback_interval (int): Playback interval in minutes.
+        mrt_files (tuple[str, ...]): MRT files to process.
+    '''
     mrt_simulation_service.mrt_simulation(
         no_rabbitmq_direct=no_rabbitmq_direct,
         rabbitmq_grouped=rabbitmq_grouped,
@@ -147,6 +192,15 @@ def mrt_simulation(no_rabbitmq_direct: bool, rabbitmq_grouped: int, no_mongodb_l
     is_flag=True,
 )
 def webapp(reload: bool):
+    '''
+    WebApp command for launching the admin WebApp.
+
+    Author:
+        Benedikt Schwering <bes9584@thi.de>
+
+    Args:
+        reload (bool): Reload the WebApp on changes.
+    '''
     start_webapp(
         reload=reload,
     )