[fix] Releaser: Fixed insertion of backported bugfix entries in ReST changelog #532

Fix the unreleased block regex to include content under the header
(e.g., 'Work in progress.') when inserting backported bugfix changelog entries.

Added a test to assert that unreleased content remains above the newly inserted block.

Fixes #532

(cherry picked from commit 761112c)

Author: Eeshu-Yadav

openwisp_utils/releaser/changelog.py

@@ -257,7 +257,7 @@ def update_changelog_file(changelog_path, new_block, is_port=False):
     unreleased_block_regex_str = (
         r"^(##\s+(?:Version\s+)?\S+\s+\[Unreleased\](?:.|\n)*?)(?=\n##\s+(?:Version\s+)?|\Z)"
         if is_md
-        else r"^((?:Version\s+)?\S+\s+\[Unreleased\]\n-+(?:.|\n)*?)(?=\n^(?:Version\s+)?\S|\Z)"
+        else r"^((?:Version\s+)?\S+\s+\[Unreleased\]\n-+(?:.|\n)*?)(?=\n(?:Version\s+)?\d+\.\d+\.\d+\s+\[|\Z)"
     )
     unreleased_block_regex = re.compile(
         unreleased_block_regex_str, re.IGNORECASE | re.MULTILINE

openwisp_utils/releaser/tests/test_changelog.py

@@ -280,6 +280,10 @@ def test_update_changelog_bugfix_port_flow(mock_file):
         "Version 1.2.0 [Unreleased]"
     )
     assert written_content.find("Version 1.1.3") < written_content.find("Version 1.1.2")
+    # "Work in progress." text below unreleased header should come before new bugfix block
+    assert written_content.find("Work in progress.") < written_content.find(
+        "Version 1.1.3"
+    )
 
 
 @patch("builtins.open", new_callable=mock_open, read_data=SAMPLE_CHANGELOG)