moved syslog files to datamodel

Author: alexandraBara

nodescraper/plugins/inband/syslog/syslog_collector.py

@@ -42,7 +42,7 @@ class SyslogCollector(InBandDataCollector[SyslogData, None]):
 
     SYSLOG_CMD = r"ls -1 /var/log/syslog* 2>/dev/null | grep -E '^/var/log/syslog(\.[0-9]+(\.gz)?)?$' || true"
 
-    def _collect_syslog_rotations(self) -> list[str]:
+    def _collect_syslog_rotations(self) -> list[TextFileArtifact]:
         ret = []
         list_res = self._run_sut_cmd(self.SYSLOG_CMD, sudo=True)
         paths = [p.strip() for p in (list_res.stdout or "").splitlines() if p.strip()]
@@ -56,6 +56,7 @@ def _collect_syslog_rotations(self) -> list[str]:
             return []
 
         collected_logs, failed_logs = [], []
+        collected = []
         for p in paths:
             qp = shell_quote(p)
             if p.endswith(".gz"):
@@ -64,9 +65,7 @@ def _collect_syslog_rotations(self) -> list[str]:
                 if res.exit_code == 0 and res.stdout is not None:
                     fname = nice_rotated_name(p, "syslog")
                     self.logger.info("Collected syslog log: %s", fname)
-                    self.result.artifacts.append(
-                        TextFileArtifact(filename=fname, contents=res.stdout)
-                    )
+                    collected.append(TextFileArtifact(filename=fname, contents=res.stdout))
                     collected_logs.append(fname)
                 else:
                     failed_logs.append(p)
@@ -76,10 +75,8 @@ def _collect_syslog_rotations(self) -> list[str]:
                 if res.exit_code == 0 and res.stdout is not None:
                     fname = nice_rotated_name(p, "syslog")
                     self.logger.info("Collected syslog log: %s", fname)
-                    self.result.artifacts.append(
-                        TextFileArtifact(filename=fname, contents=res.stdout)
-                    )
                     collected_logs.append(fname)
+                    collected.append(TextFileArtifact(filename=fname, contents=res.stdout))
                 else:
                     failed_logs.append(p)
 
@@ -100,8 +97,8 @@ def _collect_syslog_rotations(self) -> list[str]:
                 priority=EventPriority.WARNING,
             )
 
-        if collected_logs:
-            ret = collected_logs
+        if collected:
+            ret = collected
         return ret
 
     def collect_data(

nodescraper/plugins/inband/syslog/syslogdata.py

@@ -23,10 +23,24 @@
 # SOFTWARE.
 #
 ###############################################################################
+import os
+
+from nodescraper.connection.inband.inband import TextFileArtifact
 from nodescraper.models import DataModel
 
 
 class SyslogData(DataModel):
     """Data model for in band syslog logs"""
 
-    syslog_logs: list[str] = []
+    syslog_logs: list[TextFileArtifact] = []
+
+    def log_model(self, log_path: str):
+        """Log data model to a file
+
+        Args:
+            log_path (str): log path
+        """
+        for artifact in self.syslog_logs:
+            log_name = os.path.join(log_path, artifact.filename)
+            with open(log_name, "w", encoding="utf-8") as log_file:
+                log_file.write(artifact.contents)

test/unit/plugin/test_syslog_collector.py

@@ -91,20 +91,10 @@ def run_map(cmd, **kwargs):
     c = get_collector(monkeypatch, run_map, system_info, conn_mock)
 
     n = c._collect_syslog_rotations()
-    assert n == [
-        "rotated_syslog.log",
-        "rotated_syslog.1.log",
-        "rotated_syslog.2.gz.log",
-        "rotated_syslog.10.gz.log",
-    ]
-
-    names = {a.filename for a in c.result.artifacts}
-    assert names == {
-        "rotated_syslog.log",
-        "rotated_syslog.1.log",
-        "rotated_syslog.2.gz.log",
-        "rotated_syslog.10.gz.log",
-    }
+    assert n[0].filename == "rotated_syslog.log"
+    assert n[1].filename == "rotated_syslog.1.log"
+    assert n[2].filename == "rotated_syslog.2.gz.log"
+    assert n[3].filename == "rotated_syslog.10.gz.log"
 
     descs = [e["description"] for e in c._events]
     assert "Collected syslog rotated files" in descs
@@ -167,5 +157,5 @@ def run_map(cmd, **kwargs):
 
     result, data = c.collect_data()
     assert isinstance(data, SyslogData)
-    assert data.syslog_logs == ["rotated_syslog.log"]
+    assert data.syslog_logs[0].filename == "rotated_syslog.log"
     assert c.result.message == "Syslog data collected"