Adds ruff lint workflow, config and autofixes issues

Author: nkakouros

.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: ~
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+
+      - name: Install Ruff
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+
+      - name: Check Code with Ruff
+        run: |
+          ruff check --statistics
+          ruff format --check

docs/conf.py

@@ -19,13 +19,16 @@
 
 project = 'MAL Toolbox'
 copyright = '2024, Andrei Buhaiu, Giuseppe Nebbione, Nikolaos Kakouros, Jakob Nyberg, Joakim Loxdal'
-author = 'Andrei Buhaiu, Giuseppe Nebbione, Nikolaos Kakouros, Jakob Nyberg, Joakim Loxdal'
+author = (
+    'Andrei Buhaiu, Giuseppe Nebbione, Nikolaos Kakouros, Jakob Nyberg, Joakim Loxdal'
+)
 
 
 # -- General configuration ---------------------------------------------------
 
 import os
 import sys
+
 sys.path.insert(0, os.path.abspath('../'))  # Source code dir relative to this file
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -53,9 +56,9 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme' # pip install sphinx_rtd_theme
+html_theme = 'sphinx_rtd_theme'  # pip install sphinx_rtd_theme
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+# html_static_path = ['_static']

maltoolbox/__init__.py

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 # MAL Toolbox v0.2.0
 # Copyright 2024, Andrei Buhaiu.
 #
@@ -16,41 +15,40 @@
 #
 
 
-"""
-MAL-Toolbox Framework
-"""
+"""MAL-Toolbox Framework."""
 
 __title__ = 'maltoolbox'
 __version__ = '0.2.0'
-__authors__ = ['Andrei Buhaiu',
+__authors__ = [
+    'Andrei Buhaiu',
     'Giuseppe Nebbione',
     'Nikolaos Kakouros',
     'Jakob Nyberg',
-    'Joakim Loxdal']
+    'Joakim Loxdal',
+]
 __license__ = 'Apache 2.0'
 __docformat__ = 'restructuredtext en'
 
 __all__ = ()
 
-import os
 import configparser
 import logging
+import os
 
 ERROR_INCORRECT_CONFIG = 1
 
-CONFIGFILE = os.path.join(
-    os.path.dirname(os.path.abspath(__file__)),
-    "default.conf"
-)
+CONFIGFILE = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'default.conf')
 
 config = configparser.ConfigParser()
 config.read(CONFIGFILE)
 
 if 'logging' not in config:
-    raise ValueError('Config file is missing essential information, cannot proceed.')
+    msg = 'Config file is missing essential information, cannot proceed.'
+    raise ValueError(msg)
 
 if 'log_file' not in config['logging']:
-    raise ValueError('Config file is missing a log_file location, cannot proceed.')
+    msg = 'Config file is missing a log_file location, cannot proceed.'
+    raise ValueError(msg)
 
 log_configs = {
     'log_file': config['logging']['log_file'],
@@ -60,9 +58,11 @@
     'langspec_file': config['logging']['langspec_file'],
 }
 
-os.makedirs(os.path.dirname(log_configs['log_file']), exist_ok = True)
+os.makedirs(os.path.dirname(log_configs['log_file']), exist_ok=True)
 
-formatter = logging.Formatter('%(asctime)s %(name)-12s %(levelname)-8s %(message)s', datefmt='%m-%d %H:%M')
+formatter = logging.Formatter(
+    '%(asctime)s %(name)-12s %(levelname)-8s %(message)s', datefmt='%m-%d %H:%M'
+)
 file_handler = logging.FileHandler(log_configs['log_file'], mode='w')
 file_handler.setFormatter(formatter)
 
@@ -78,7 +78,6 @@
 if 'neo4j' in config:
     for term in ['uri', 'username', 'password', 'dbname']:
         if term not in config['neo4j']:
-
             msg = (
                 'Config file is missing essential Neo4J '
                 f'information: {term}, cannot proceed.'

maltoolbox/__main__.py

@@ -1,5 +1,4 @@
-"""
-Command-line interface for MAL toolbox operations
+"""Command-line interface for MAL toolbox operations.
 
 Usage:
     maltoolbox attack-graph generate [options] <model> <lang_file>
@@ -20,58 +19,61 @@
     - If --neo4j is used, the Neo4j instance should be running. The connection
       parameters required for this app to reach the Neo4j instance should be
       defined in the default.conf file.
+
 """
 
-import logging
 import json
+import logging
+
 import docopt
 
 from maltoolbox.wrappers import create_attack_graph
+
 from . import log_configs, neo4j_configs
-from .language.compiler import MalCompiler
 from .ingestors import neo4j
+from .language.compiler import MalCompiler
 
 logger = logging.getLogger(__name__)
 
-def generate_attack_graph(
-        model_file: str,
-        lang_file: str,
-        send_to_neo4j: bool
-    ) -> None:
-    """Create an attack graph and optionally send to neo4j
-    
+
+def generate_attack_graph(model_file: str, lang_file: str, send_to_neo4j: bool) -> None:
+    """Create an attack graph and optionally send to neo4j.
+
     Args:
     model_file      - path to the model file
     lang_file       - path to the language file
     send_to_neo4j   - whether to ingest into neo4j or not
+
     """
     attack_graph = create_attack_graph(lang_file, model_file)
     if log_configs['attackgraph_file']:
-        attack_graph.save_to_file(
-            log_configs['attackgraph_file']
-        )
+        attack_graph.save_to_file(log_configs['attackgraph_file'])
 
     if send_to_neo4j:
         logger.debug('Ingest model graph into Neo4J database.')
-        neo4j.ingest_model(attack_graph.model,
+        neo4j.ingest_model(
+            attack_graph.model,
             neo4j_configs['uri'],
             neo4j_configs['username'],
             neo4j_configs['password'],
             neo4j_configs['dbname'],
-            delete=True)
+            delete=True,
+        )
         logger.debug('Ingest attack graph into Neo4J database.')
-        neo4j.ingest_attack_graph(attack_graph,
+        neo4j.ingest_attack_graph(
+            attack_graph,
             neo4j_configs['uri'],
             neo4j_configs['username'],
             neo4j_configs['password'],
             neo4j_configs['dbname'],
-            delete=False)
+            delete=False,
+        )
 
 
 def compile(lang_file: str, output_file: str) -> None:
-    """Compile language and dump into output file"""
+    """Compile language and dump into output file."""
     compiler = MalCompiler()
-    with open(output_file, "w") as f:
+    with open(output_file, 'w', encoding='utf-8') as f:
         json.dump(compiler.compile(lang_file), f, indent=2)
 
 

maltoolbox/attackgraph/__init__.py

@@ -1,8 +1,7 @@
-"""
-Contains tools used to generate attack graphs from MAL instance
+"""Contains tools used to generate attack graphs from MAL instance
 models and analyze attack graphs.
 """
 
-from .attacker import Attacker
-from .attackgraph import AttackGraph
-from .node import AttackGraphNode
+from .attacker import Attacker as Attacker
+from .attackgraph import AttackGraph as AttackGraph
+from .node import AttackGraphNode as AttackGraphNode