cleanup

Author: alexandraBara

nodescraper/base/inbanddataplugin.py

@@ -39,23 +39,14 @@ class InBandDataPlugin(
     DataPlugin[InBandConnectionManager, SSHConnectionParams, TDataModel, TCollectArg, TAnalyzeArg],
     Generic[TDataModel, TCollectArg, TAnalyzeArg],
 ):
-    """Base class for in band plugins.
-
-    Supports loading and comparing plugin data from scraper run directories
-    (e.g. for compare-runs). Subclasses get find_datamodel_path_in_run,
-    load_datamodel_from_path, get_extracted_errors, and load_run_data.
-    """
+    """Base class for in band plugins."""
 
     CONNECTION_TYPE = InBandConnectionManager
 
     @classmethod
     def find_datamodel_path_in_run(cls, run_path: str) -> Optional[str]:
         """Find this plugin's collector datamodel file under a scraper run directory.
 
-        Looks for <run_path>/<plugin_snake>/<collector_snake>/ with result.json
-        whose parent matches this plugin, then a datamodel file (datamodel.json,
-        <data_model_name>.json, or .log).
-
         Args:
             run_path: Path to a scraper log run directory (e.g. scraper_logs_*).
 
@@ -130,9 +121,6 @@ def load_datamodel_from_path(cls, dm_path: str) -> Optional[TDataModel]:
     def get_extracted_errors(cls, data_model: DataModel) -> Optional[list[str]]:
         """Compute extracted errors from datamodel for compare-runs (in memory only).
 
-        Uses get_compare_content() on the datamodel and ANALYZER.get_error_matches
-        if this plugin has an ANALYZER; otherwise returns None.
-
         Args:
             data_model: Loaded DATA_MODEL instance.
 
@@ -164,10 +152,6 @@ def get_extracted_errors(cls, data_model: DataModel) -> Optional[list[str]]:
     def load_run_data(cls, run_path: str) -> Optional[dict[str, Any]]:
         """Load this plugin's run data from a scraper run directory for comparison.
 
-        Finds the datamodel file, loads it, and returns a JSON-serializable dict
-        (model_dump) with optional "extracted_errors" if the plugin supports
-        get_compare_content and ANALYZER.get_error_matches.
-
         Args:
             run_path: Path to a scraper log run directory or to a datamodel file.
 

nodescraper/cli/compare_runs.py

@@ -362,10 +362,6 @@ def run_compare_runs(
 ) -> None:
     """Compare datamodels from two run log directories and log results.
 
-    For each plugin present in either run:
-    - If plugin is only in one run, logs that it was not found in the other run.
-    - If plugin is in both runs, computes diff and logs differences or 'no differences'.
-
     Args:
         path1: Path to first run log directory.
         path2: Path to second run log directory.

nodescraper/plugins/inband/dmesg/run_compare.py

@@ -32,18 +32,12 @@
 
 
 def find_dmesg_datamodel_path(run_path: str) -> Optional[str]:
-    """Find the DmesgPlugin collector datamodel under a scraper run directory.
-
-    Delegates to DmesgPlugin.find_datamodel_path_in_run (see InBandDataPlugin).
-    """
+    """Find the DmesgPlugin collector datamodel under a scraper run directory."""
     return DmesgPlugin.find_datamodel_path_in_run(run_path)
 
 
 def load_dmesg_data(path: str) -> Tuple[Optional[DmesgData], Optional[str]]:
-    """Load DmesgData from a scraper run directory or a datamodel file path.
-
-    Uses DmesgPlugin.load_datamodel_from_path and find_datamodel_path_in_run.
-    """
+    """Load DmesgData from a scraper run directory or a datamodel file path."""
     path = os.path.abspath(path)
     if not os.path.exists(path):
         return None, None
@@ -55,10 +49,7 @@ def load_dmesg_data(path: str) -> Tuple[Optional[DmesgData], Optional[str]]:
 
 
 def compute_extracted_errors(dm: DmesgData) -> list[str]:
-    """Apply DmesgPlugin analyzer regexes to dmesg content (in memory only).
-
-    Delegates to DmesgPlugin.get_extracted_errors.
-    """
+    """Apply DmesgPlugin analyzer regexes to dmesg content (in memory only)."""
     out = DmesgPlugin.get_extracted_errors(dm)
     return out if out is not None else []
 
@@ -68,11 +59,7 @@ def compare_dmesg_runs(
     path2: str,
     logger: Optional[logging.Logger] = None,
 ) -> Tuple[list[str], list[str], str, str]:
-    """Load two DmesgPlugin runs, compute extracted errors in memory, and compare.
-
-    Uses DmesgPlugin.load_run_data; same logic is available for any InBandDataPlugin
-    via plugin.load_run_data and compare-runs.
-    """
+    """Load two DmesgPlugin runs, compute extracted errors in memory, and compare."""
     log = logger or logging.getLogger(__name__)
     label1 = os.path.basename(path1.rstrip(os.sep))
     label2 = os.path.basename(path2.rstrip(os.sep))

test/unit/framework/test_compare_runs.py

@@ -137,7 +137,6 @@ def test_run_compare_runs_with_fixture_dirs(caplog, framework_fixtures_path):
     run_compare_runs(str(base), str(base), plugin_reg, logger)
     assert "Loading run 1" in caplog.text
     assert "Loading run 2" in caplog.text
-    # Same dir twice: BiosPlugin should be found, no differences
     assert "Plugin" in caplog.text
     assert "No differences" in caplog.text or "difference" in caplog.text.lower()
 
@@ -154,7 +153,6 @@ def test_run_compare_runs_sysctl_fixture(caplog, framework_fixtures_path):
     assert "Loading run 1" in caplog.text
     assert "Loading run 2" in caplog.text
     assert "Sysctl" in caplog.text or "sysctl" in caplog.text
-    # Fixtures have different vm_swappiness etc. so we expect differences
     assert "difference" in caplog.text.lower() or "only in" in caplog.text.lower()
 
 
@@ -170,5 +168,4 @@ def test_run_compare_runs_one_run_missing_plugin(caplog, framework_fixtures_path
     run_compare_runs(str(run1), str(run2), plugin_reg, logger)
     assert "Loading run 1" in caplog.text
     assert "Loading run 2" in caplog.text
-    # BiosPlugin in run1 only -> we should see "not found in run 2"
     assert "not found in run 2" in caplog.text or "NOT_RAN" in caplog.text