maurane/logwatcher
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📝docs(docs): add documentation for README.md

Browse Source 
add documentation in README.md, usage.md, architecture.md, update python version based on the version used in development
This commit is contained in:
maurane glaude
2026-09-02 11:52:27 +02:00
parent a43afb9df7
commit bfa5fa600b
6 changed files with 340 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/test_reporter.py
+9 -9
View File
@@ -128,7 +128,7 @@ def test_render_target_report_relevant(
relevant = get_only_relevant_log_entries[0]
target_report = _render_target_report(relevant, N2_SUPPORT_TEMPLATE)
assert "ERREURS SUPPORT N2" in target_report
assert target_report.find("Nombre d'erreurs\t : " + str(len(relevant))) != -1
assert target_report.find("Nombre d'erreur(s)\t : " + str(len(relevant))) != -1
assert _render_entries(relevant) in target_report
@@ -139,7 +139,7 @@ def test_render_target_report_irrelevant(
irrelevant = get_only_irrelevant_log_entries[1]
target_report = _render_target_report(irrelevant, OTHER_TEMPLATE)
assert "AUTRES ERREURS" in target_report
assert target_report.find("Nombre d'erreurs\t : " + str(len(irrelevant))) != -1
assert target_report.find("Nombre d'erreur(s)\t : " + str(len(irrelevant))) != -1
assert _render_entries(irrelevant) in target_report
@@ -165,10 +165,10 @@ def test_build_reports(
assert "all" in reports and "n2" in reports and "other" in reports
assert reports["all"].find(f"Période\t : {start_date} -> {end_date}") != -1
assert reports["all"].find(f"Fichiers lu\t : {nb_files}") != -1
assert reports["all"].find(f"Fichier(s) lu(s)\t : {nb_files}") != -1
assert (
reports["all"].find(
f"Nombre total d'erreurs\t: {len(get_all_log_entries[0] + get_all_log_entries[1])}"
f"Nombre total d'erreur(s)\t: {len(get_all_log_entries[0] + get_all_log_entries[1])}"
)
!= -1
)
@@ -181,12 +181,12 @@ def test_build_reports(
and "AUTRES ERREURS" in reports["other"]
)
assert (
reports["n2"].find(f"Nombre total d'erreurs\t: {len(get_all_log_entries[0])}")
reports["n2"].find(f"Nombre total d'erreur(s)\t: {len(get_all_log_entries[0])}")
!= -1
)
assert (
reports["other"].find(
f"Nombre total d'erreurs\t: {len(get_all_log_entries[1])}"
f"Nombre total d'erreur(s)\t: {len(get_all_log_entries[1])}"
)
!= -1
)
@@ -224,21 +224,21 @@ def _test_write_log_report(
assert reports["all"] == all_file.read_text(encoding="windows-1252")
assert (
all_file.read_text(encoding="windows-1252").find(
f"Nombre total d'erreurs\t: {nb_errors['all']}"
f"Nombre total d'erreur(s)\t: {nb_errors['all']}"
)
!= -1
)
assert reports["n2"] == n2_file.read_text(encoding="windows-1252")
assert (
n2_file.read_text(encoding="windows-1252").find(
f"Nombre total d'erreurs\t: {nb_errors['n2']}"
f"Nombre total d'erreur(s)\t: {nb_errors['n2']}"
)
!= -1
)
assert reports["other"] == other_file.read_text(encoding="windows-1252")
assert (
other_file.read_text(encoding="windows-1252").find(
f"Nombre total d'erreurs\t: {nb_errors['other']}"
f"Nombre total d'erreur(s)\t: {nb_errors['other']}"
)
!= -1
)