fix(mark2confluence): Skip files beginning with Space header when injecting default parents

mark2confluence/main.py

@@ -100,15 +100,18 @@ def publish(path: str)-> tuple:
   return True, None
 
 
-def has_mark_headers(path: str) -> bool:
-  space_re = re.compile("<!--.?(space|parent|title):.*-->", re.IGNORECASE)
+def begins_with_mark_headers(path: str, headers: List[str] = ["Space", "Parent", "Title"]) -> bool:
   with open(path, 'r+') as f:
-    data = f.read().split("\n")
-    for line in data:
-      if space_re.match(line):
+    first_row = f.readline()
+    for header in headers:
+      regex = re.compile(f"^<!--.?{header}:.*-->", re.IGNORECASE)
+      if regex.match(first_row):
         return True
   return False
 
+def begins_with_mark_space_header(path: str):
+  return begins_with_mark_headers(path, ["Space"])
+
 class MultilineCommentIsOpenException(Exception):
     pass
 
@@ -240,7 +243,7 @@ def get_default_parents(parents_string: str) -> List[ParentCfg]:
 def inject_default_parents(path: str, default_parents_cfg: List[ParentCfg]):
   file_dir = f"{os.path.dirname(os.path.abspath(path))}"
   for parent_cfg in default_parents_cfg:
-    if parent_cfg.is_directory_included(file_dir):
+    if parent_cfg.is_directory_included(file_dir) and not begins_with_mark_space_header(path):
       header = parent_cfg.get_header()
       with open(path, 'r') as f:
         file_content = f.read()
@@ -270,7 +273,7 @@ def main()->int:
   default_parents = get_default_parents(cfg.inputs.DEFAULT_PARENTS)
   status = {}
   for path in files:
-    if path[-3:] == '.md' and has_mark_headers(path):
+    if path[-3:] == '.md' and begins_with_mark_headers(path):
       logger.info(f"Processing file {path}")
       inject_default_parents(path, default_parents)
 

tests/resources/markdown/test_begins_with_mark_headers/with_mark_headers_in_the_content.md

@@ -0,0 +1,5 @@
+# I HAVE MARK HEADERS IN THE CONTENT
+
+```markdown
+<!-- Space: Content -->
+```

tests/resources/markdown/test_inject_default_parents/0-input.md

@@ -1 +1,2 @@
 <!-- Parent: BAZ -->
+<!-- Title: BIM -->

tests/resources/markdown/test_inject_default_parents/0-output.md

@@ -1,3 +1,4 @@
 <!-- Space: FOO -->
 <!-- Parent: BAR -->
 <!-- Parent: BAZ -->
+<!-- Title: BIM -->

tests/resources/markdown/test_inject_default_parents/1-input.md

@@ -0,0 +1,3 @@
+<!-- Space: BAR -->
+<!-- Parent: BARED -->
+<!-- Title: BORED -->

tests/resources/markdown/test_inject_default_parents/1-output.md

@@ -0,0 +1,3 @@
+<!-- Space: BAR -->
+<!-- Parent: BARED -->
+<!-- Title: BORED -->

tests/test_main.py

@@ -32,12 +32,13 @@ def test_load_env_prefixes():
     assert main.cfg.actions["FOO"] == "foo"
     assert main.cfg.runner["FOO"] == "foo"
 
-def test_has_mark_headers():
-    resource_directory = f"{RESOURCE_DIR}/markdown/test_has_mark_headers"
-    assert main.has_mark_headers(f"{resource_directory}/with_mark_space_header.md")
-    assert main.has_mark_headers(f"{resource_directory}/with_mark_parent_header.md")
-    assert main.has_mark_headers(f"{resource_directory}/with_mark_title_header.md")
-    assert not main.has_mark_headers(f"{resource_directory}/without_mark_headers.md")
+def test_begins_with_mark_headers():
+    resource_directory = f"{RESOURCE_DIR}/markdown/test_begins_with_mark_headers"
+    assert main.begins_with_mark_headers(f"{resource_directory}/with_mark_space_header.md")
+    assert main.begins_with_mark_headers(f"{resource_directory}/with_mark_parent_header.md")
+    assert main.begins_with_mark_headers(f"{resource_directory}/with_mark_title_header.md")
+    assert not main.begins_with_mark_headers(f"{resource_directory}/without_mark_headers.md")
+    assert not main.begins_with_mark_headers(f"{resource_directory}/with_mark_headers_in_the_content.md")
 
 def test_check_header_template():
     assert main.check_header_template("Valid Jinja2 {{ var }}")
@@ -126,14 +127,22 @@ def test_get_default_parents(string, expected_parents_count):
 def test_ParentCfg_get_header(cfg: main.ParentCfg, expected_header):
     assert cfg.get_header() == expected_header
 
-def test_inject_default_parents(monkeypatch):
+@pytest.mark.parametrize(
+  ids=("skip file with space mark header", "properly inject default headers"),
+  argnames="tested_file_name, expected_file_name",
+  argvalues=[
+      ("0-input.md", "0-output.md"),
+      ("1-input.md", "1-output.md"),
+  ],
+)
+def test_inject_default_parents(monkeypatch, tested_file_name, expected_file_name):
     monkeypatch.setattr('mark2confluence.main.cfg', dot.dotify({"github": {"WORKSPACE": WORKSPACE}}))
 
     base_dir = f"{RESOURCE_DIR}/markdown/test_inject_default_parents"
-    source_file_path = f"{base_dir}/0-input.md"
-    expected_file_path = f"{base_dir}/0-output.md"
-    parsed_file_dir = f"{WORKSPACE}/tests/foo"
-    parsed_file_path = f"{parsed_file_dir}/parsed_file.md"
+    source_file_path = os.path.join(base_dir, tested_file_name)
+    expected_file_path = os.path.join(base_dir, expected_file_name)
+    parsed_file_dir = os.path.join(WORKSPACE, "tests", "foo")
+    parsed_file_path = os.path.join(parsed_file_dir, "parsed_file.md")
     cfgs = [
         main.ParentCfg(directory="tests/foo/bar", space="FOO", parents=["BAZ"]),
         main.ParentCfg(directory="tests/foo/*", space="FOO", parents=["BAR"]),