#162 - Introduce presence of Release Notes to Issues (#163)

- Add issue type attribute.

Author: miroslavpojer

DEVELOPER.md

@@ -135,7 +135,8 @@ This will execute all tests located in the tests directory.
 Code coverage is collected using the pytest-cov coverage tool. To run the tests and collect coverage information, use the following command:
 
 ```shell
-pytest --cov=. -v tests/ --cov-fail-under=80
+pytest --cov=. -v tests/ --cov-fail-under=80                      # Check coverage threshold
+pytest --cov=. -v tests/ --cov-fail-under=80 --cov-report=html    # Generate HTML report
 ```
 
 This will execute all tests in the tests directory and generate a code coverage report.

release_notes_generator/model/issue_record.py

@@ -27,6 +27,11 @@ def __init__(self, issue: Issue, skip: bool = False):
         super().__init__(skip=skip)
 
         self._issue: Issue = issue
+        self._issue_type: Optional[str] = None
+
+        if issue is not None and issue.type is not None:
+            self._issue_type = issue.type.name
+
         self._labels = {label.name for label in self._issue.get_labels()}
 
         self._pull_requests: dict[int, PullRequest] = {}
@@ -62,6 +67,15 @@ def issue(self) -> Issue:
         """
         return self._issue
 
+    @property
+    def issue_type(self) -> Optional[str]:
+        """
+        Gets the type of the issue.
+        Returns:
+            str: The type of the issue.
+        """
+        return self._issue_type
+
     # methods - override Record methods
 
     def to_chapter_row(self) -> str:

tests/release_notes/model/test_issue_record.py

@@ -0,0 +1,55 @@
+#
+# Copyright 2023 ABSA Group Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from datetime import datetime
+
+from github.Issue import Issue
+from github.IssueType import IssueType
+
+from release_notes_generator.model.issue_record import IssueRecord
+
+
+def _make_issue(mocker, type_name=None) -> Issue:
+
+    if type_name:
+        mock_issue_type = mocker.Mock(spec=IssueType)
+        mock_issue_type.name = type_name
+    else:
+        mock_issue_type = None
+
+    mock_issue = mocker.Mock(spec=Issue)
+    mock_issue.id = 1
+    mock_issue.number = 123
+    mock_issue.title = "Issue 1"
+    mock_issue.body = "Body of issue 1"
+    mock_issue.state = "open"
+    mock_issue.created_at = datetime.now()
+    mock_issue.get_labels.return_value = []
+    mock_issue.type = mock_issue_type
+
+    return mock_issue
+
+
+def test_issue_record_init_with_type_none(mocker):
+    issue: Issue = _make_issue(mocker, type_name=None)
+    record = IssueRecord(issue)
+    assert record.issue_type is None
+
+
+def test_issue_record_init_with_type_value(mocker):
+    issue: Issue = _make_issue(mocker, type_name="enhancement")
+    record = IssueRecord(issue)
+    assert record.issue_type == "enhancement"

tests/release_notes/model/test_pull_request_record.py

@@ -0,0 +1,57 @@
+#
+# Copyright 2023 ABSA Group Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+import re
+import pytest
+from github.PullRequest import PullRequest
+
+from release_notes_generator.model.pull_request_record import PullRequestRecord
+
+# get_rls_notes
+
+def test_get_rls_notes_coderabbit_ignores_groups(mocker):
+    pr = mocker.Mock(spec=PullRequest)
+    pr.state = PullRequestRecord.PR_STATE_CLOSED
+    pr.number = 42
+    pr.title = "PR with CR summary"
+    pr.get_labels.return_value = []
+    pr.body = (
+        "Summary by CodeRabbit\n"
+        "- **Improvements**\n"
+        "  - Speed up\n"
+        "- **Fixes**\n"
+        "  - Crash fix\n"
+        "  + Minor patch\n"
+        "Other text"
+    )
+
+    rec = PullRequestRecord(pr)
+
+    mocker.patch("release_notes_generator.action_inputs.ActionInputs.get_release_notes_title", return_value=r"^Release Notes:$")
+    mocker.patch("release_notes_generator.action_inputs.ActionInputs.is_coderabbit_support_active", return_value=True)
+    mocker.patch("release_notes_generator.action_inputs.ActionInputs.get_coderabbit_release_notes_title", return_value="Summary by CodeRabbit")
+    mocker.patch("release_notes_generator.action_inputs.ActionInputs.get_coderabbit_summary_ignore_groups", return_value=["Improvements"])
+
+    notes = rec.get_rls_notes()
+    assert notes == "  - Crash fix\n  + Minor patch"
+
+# get_commit
+
+def test_get_commit_found_and_missing(pull_request_record_merged):
+    found = pull_request_record_merged.get_commit("merge_commit_sha")
+    missing = pull_request_record_merged.get_commit("nonexistent")
+    assert found is not None and getattr(found, "sha", None) == "merge_commit_sha"
+    assert missing is None

tests/release_notes/test_record_factory.py

@@ -29,7 +29,6 @@
 from release_notes_generator.model.mined_data import MinedData
 from release_notes_generator.model.pull_request_record import PullRequestRecord
 from release_notes_generator.record.record_factory import RecordFactory
-from tests.conftest import MockLabel
 
 
 def setup_no_issues_pulls_commits(mocker):