Merge branch 'reporting-with-newlines' into format-analyzer

"merge conflict"

src/alogamous/analyzer.py

@@ -17,4 +17,5 @@ def analyze_log_stream(analyzers, in_stream, out_stream):
             analyzer.read_log_line(line.rstrip())
     for analyzer in analyzers:
         analyzer.report(out_stream)
-        out_stream.write("\n>>>>>>>>>> a report has been reported <<<<<<<<<<\n")
+        out_stream.write("\n\n")
+    out_stream.write(">>>>>>>>>> a report has been reported <<<<<<<<<<\n\n")

src/alogamous/flag_duplicate_log_messages.py

@@ -16,7 +16,6 @@ def read_log_line(self, line):
     def report(self, out_stream):
         if len(self.duplicateMessages) > 0:
             out_stream.write("Duplicate Log Messages:\n")
-            for message in self.duplicateMessages:
-                out_stream.write(f"{message}\n")
+            out_stream.write("\n".join(self.duplicateMessages))
         else:
-            out_stream.write("No duplicate log messages\n")
+            out_stream.write("No duplicate log messages")

src/alogamous/format_analyzer.py

@@ -25,7 +25,7 @@ def read_log_line(self, line):
 
     def report(self, out_stream):
         if self.un_formated_lines:
-            out_stream.write("\nLines that do not conform to log format:\n- ")
+            out_stream.write("Lines that do not conform to log format:\n- ")
             out_stream.write("\n- ".join(self.un_formated_lines))
         else:
             out_stream.write("All lines conform to log line format")

src/alogamous/startup_header_analyzer.py

@@ -18,5 +18,5 @@ def read_log_line(self, line):
                 self.startup_block = False
 
     def report(self, out_stream):
-        out_stream.write("\nLines that are part of the startup header(s):\n- ")
+        out_stream.write("Lines that are part of the startup header(s):\n- ")
         out_stream.write("\n- ".join(self.startup_lines))

src/alogamous/warning_analyzer.py

@@ -13,8 +13,8 @@ def read_log_line(self, line):
 
     def report(self, out_stream):
         if self.count == 0:
-            out_stream.write("\n" + "No Warnings were detected.")
+            out_stream.write("No Warnings were detected.")
         elif self.count == 1:
-            out_stream.write("\n" + "1 Warning was detected.")
+            out_stream.write("1 Warning was detected.")
         else:
-            out_stream.write("\n" + str(self.count) + " Warnings were detected.")
+            out_stream.write(str(self.count) + " Warnings were detected.")

tests/analyze_log_stream_test.py

@@ -26,7 +26,4 @@ def test_analyze_log_stream():
     out_stream = io.StringIO()
 
     analyzer.analyze_log_stream([TestAnalyzer1(), TestAnalyzer2()], in_stream, out_stream)
-    assert (
-        out_stream.getvalue()
-        == "\n>>>>>>>>>> a report has been reported <<<<<<<<<<\n\n>>>>>>>>>> a report has been reported <<<<<<<<<<\n"
-    )
+    assert out_stream.getvalue() == "\n\n\n\n>>>>>>>>>> a report has been reported <<<<<<<<<<\n\n"

tests/flag_duplicate_log_messages_test.py

@@ -12,7 +12,7 @@ def test_flag_duplicate_log_messages():
     for line in in_stream:
         flagger.read_log_line(line)
     flagger.report(out_stream)
-    assert out_stream.getvalue() == """Duplicate Log Messages:\nlog message 1\n"""
+    assert out_stream.getvalue() == """Duplicate Log Messages:\nlog message 1"""
 
 
 def test_flag_duplicate_log_messages_no_duplicates():
@@ -24,4 +24,4 @@ def test_flag_duplicate_log_messages_no_duplicates():
     for line in in_stream:
         flagger.read_log_line(line)
     flagger.report(out_stream)
-    assert out_stream.getvalue() == """No duplicate log messages\n"""
+    assert out_stream.getvalue() == """No duplicate log messages"""

tests/format_analyzer_test.py

@@ -26,8 +26,7 @@ def test_format_analyzer_with_bad_lines():
     format_checker.report(out_stream)
     assert (
         out_stream.getvalue()
-        == """
-Lines that do not conform to log format:
+        == """Lines that do not conform to log format:
 - Hello I am a bad log line
 - Hello I am a bad log line"""
     )

tests/startup_header_analyzer_test.py

@@ -23,8 +23,7 @@ def test_report():
     startup_analyzer.report(out_stream)
     assert (
         out_stream.getvalue()
-        == """
-Lines that are part of the startup header(s):
+        == """Lines that are part of the startup header(s):
 - STARTING Tracking service
 -     Start time: 2024-06-20 09:00:00.001550+00:00
 -     Version: 2729a

tests/warning_analyzer_test.py

@@ -17,4 +17,4 @@ def test_warning_count():
     for line in in_stream:
         counter.read_log_line(line)
     counter.report(out_stream)
-    assert out_stream.getvalue() == "\n2 Warnings were detected."
+    assert out_stream.getvalue() == "2 Warnings were detected."