- Updated tests to use new contexts

Author: coordt

test/conftest.py

@@ -66,32 +66,39 @@ class FakeCommit:
     trailers: Optional[dict] = None
 
 
-def commit_factory():
+def commit_factory(
+    committer_name: Optional[str] = None,
+    committer_email: Optional[str] = None,
+    summary: Optional[str] = None,
+    body: Optional[str] = None,
+    trailers: Optional[dict] = None,
+):
     """Generate commits."""
-    committer = FakeCommitter(name=fake.name(), email=fake.ascii_email())
-    summary = fake.sentence(nb_words=8, variable_nb_words=True)
-    body = (
+    committer = FakeCommitter(name=committer_name or fake.name(), email=committer_email or fake.ascii_email())
+    summary = summary or fake.sentence(nb_words=8, variable_nb_words=True)
+    body = body or "\n".join(
         [summary, fake.text(max_nb_chars=160), ""]
         + [f"* {line}" for line in fake.sentences(nb=fake.random_int(max=5))]
         + [
             "",
         ]
     )
+    body_list = [body]
     trailer_tokens = fake.random_elements(elements=trailer_weighting, length=fake.random_int(max=3))
-    trailers = collections.defaultdict(list)
-    for token in trailer_tokens:
-        trailers[token].append((fake.name(), fake.ascii_email()))
+    if trailers is None:
+        trailers = collections.defaultdict(list)
+        for token in trailer_tokens:
+            trailers[token].append((fake.name(), fake.ascii_email()))
 
     for token, items in trailers.items():
-        for name, email in items:
-            body.append(f"{token}: {name} <{email}>")
+        body_list.extend(f"{token}: {name} <{email}>" for name, email in items)
 
     return FakeCommit(
         hexsha=fake.sha1(),
         committed_datetime=fake.past_datetime(tzinfo=fake.pytimezone()),
         committer=committer,
         summary=summary,
-        message="\n".join(body),
+        message="\n".join(body_list),
         trailers=trailers,
     )
 

test/fixtures/rendered_default_repo.md

@@ -6,7 +6,6 @@
 
 - Chg: modified ``b`` XXX.
 
-
 ## 0.0.3 (2022-01-05)
 
 ### New
@@ -30,10 +29,8 @@
   **subject:** This is a fake subject spanning to several lines
 as you can see
 
-
 - New: add file ``c``.
 
-
 ## 0.0.2 (2022-01-02)
 
 ### New
@@ -42,7 +39,6 @@ as you can see
 
   **change-id:** Ic8aaa0728a43936cd4c6e1ed590e01ba8f0fbf5b
 
-
 ## 0.0.1 (2022-01-01)
 
 ### New

test/test_log_linearity.py

@@ -80,14 +80,14 @@ def test_tags_on_multiple_branches(bare_git_repo, capsys):
     ver003 = context[2]
     ver002 = context[3]
     ver001 = context[4]
-    assert len(unreleased.sections) == 0
-    assert len(ver004.sections[0].commits) == 3
-    assert ver004.sections[0].commits[0].summary == "Commit 5 on master."
-    assert ver004.sections[0].commits[1].summary == "Commit 3 on develop."
-    assert ver004.sections[0].commits[2].summary == "Commit 2 on develop."
-    assert len(ver003.sections[0].commits) == 1
-    assert ver003.sections[0].commits[0].summary == "Commit 4 on master."
-    assert len(ver002.sections[0].commits) == 1
-    assert ver002.sections[0].commits[0].summary == "Commit 2 on develop."
-    assert len(ver001.sections[0].commits) == 1
-    assert ver001.sections[0].commits[0].summary == "Commit 1 on master."
+    assert len(unreleased.grouped_commits) == 0
+    assert len(ver004.grouped_commits[0].commits) == 3
+    assert ver004.grouped_commits[0].commits[0].summary == "Commit 5 on master."
+    assert ver004.grouped_commits[0].commits[1].summary == "Commit 3 on develop."
+    assert ver004.grouped_commits[0].commits[2].summary == "Commit 2 on develop."
+    assert len(ver003.grouped_commits[0].commits) == 1
+    assert ver003.grouped_commits[0].commits[0].summary == "Commit 4 on master."
+    assert len(ver002.grouped_commits[0].commits) == 1
+    assert ver002.grouped_commits[0].commits[0].summary == "Commit 2 on develop."
+    assert len(ver001.grouped_commits[0].commits) == 1
+    assert ver001.grouped_commits[0].commits[0].summary == "Commit 1 on master."

test/test_templating.py

@@ -5,11 +5,12 @@
 from test import conftest
 
 import pytest
+from conftest import commit_factory
 from faker import Faker
 from pytest import param
 
 from generate_changelog import configuration, templating
-from generate_changelog.configuration import DEFAULT_SECTION_PATTERNS, get_config
+from generate_changelog.configuration import DEFAULT_COMMIT_CLASSIFIERS, get_config
 from generate_changelog.context import CommitContext
 
 FIXTURES_DIR = Path(__file__).parent / "fixtures"
@@ -19,22 +20,22 @@
 @pytest.mark.parametrize(
     ["string", "expected"],
     (
-        param("Newly added something", "New"),
-        param("added something new", "New"),
-        param("changed something new", "Updates"),
-        param("Updates something old", "Updates"),
-        param("renamed something I didn't like.", "Updates"),
-        param("Removed something old", "Updates"),
-        param("deletes something old", "Updates"),
-        param("improved something old", "Updates"),
-        param("refactored something old", "Updates"),
-        param("fixed an error or something", "Fixes"),
-        param("I don't know what this does", "Other"),
+        param(commit_factory(summary="Newly added something"), "New"),
+        param(commit_factory(summary="added something new"), "New"),
+        param(commit_factory(summary="changed something new"), "Updates"),
+        param(commit_factory(summary="Updates something old"), "Updates"),
+        param(commit_factory(summary="renamed something I didn't like."), "Updates"),
+        param(commit_factory(summary="Removed something old"), "Updates"),
+        param(commit_factory(summary="deletes something old"), "Updates"),
+        param(commit_factory(summary="improved something old"), "Updates"),
+        param(commit_factory(summary="refactored something old"), "Updates"),
+        param(commit_factory(summary="fixed an error or something"), "Fixes"),
+        param(commit_factory(summary="I don't know what this does"), "Other"),
     ),
 )
 def test_first_matching(string, expected):
     """The first matching function should properly categorize a string."""
-    assert templating.first_matching(DEFAULT_SECTION_PATTERNS, string) == expected
+    assert templating.first_matching(DEFAULT_COMMIT_CLASSIFIERS, string) == expected
 
 
 def test_commit_context():
@@ -45,6 +46,7 @@ def test_commit_context():
         commit_datetime=commit.committed_datetime,
         committer=f"{commit.committer.name} <{commit.committer.email}>",
         summary=commit.summary,
+        grouping=("a", "b"),
         body="\n".join(commit.message.splitlines()[1:]),
     )
     assert commit.hexsha[:7] == context.short_sha
@@ -62,6 +64,7 @@ def test_commit_with_no_email():
         commit_datetime=commit.committed_datetime,
         committer=f"{commit.committer.name} <{commit.committer.email}>",
         summary=commit.summary,
+        grouping=(None,),
         body="\n".join(commit.message.splitlines()[1:]),
         metadata={"trailers": {"co-authored-by": [name_only]}},
     )
@@ -77,10 +80,10 @@ def test_get_context_from_tags(default_repo):
     v = context[0]
     assert v.label == get_config().unreleased_label
     assert v.date_time.date() == datetime.date(2022, 1, 6)
-    assert len(v.sections) == 1
-    assert v.sections[0].label == "Updates"
-    assert len(v.sections[0].commits) == 1
-    assert v.sections[0].commits[0].metadata["trailers"]["co-committed-by"] == [
+    assert len(v.grouped_commits) == 1
+    assert v.grouped_commits[0].grouping == ("Updates",)
+    assert len(v.grouped_commits[0].commits) == 1
+    assert v.grouped_commits[0].commits[0].metadata["trailers"]["co-committed-by"] == [
         "Juliet <juliet@example.com>",
         "Charly <charly@example.com>",
     ]
@@ -89,11 +92,11 @@ def test_get_context_from_tags(default_repo):
     assert v.label == "0.0.3"
     assert v.previous_tag == "0.0.2"
     assert v.date_time.date() == datetime.date(2022, 1, 5)
-    assert len(v.sections) == 1
-    assert v.sections[0].label == "New"
-    assert len(v.sections[0].commits) == 2
-    assert len(v.sections[0].commits[0].metadata["trailers"]) == 5
-    assert len(v.sections[0].commits[1].metadata["trailers"]) == 0
+    assert len(v.grouped_commits) == 1
+    assert v.grouped_commits[0].grouping == ("New",)
+    assert len(v.grouped_commits[0].commits) == 2
+    assert len(v.grouped_commits[0].commits[0].metadata["trailers"]) == 5
+    assert len(v.grouped_commits[0].commits[1].metadata["trailers"]) == 0
 
 
 def test_render(default_repo, capsys):