Merge pull request #480 from jakeatoms/479/use-output-file-in-issue-metrics-script

Author: zkoppert

Diff for: issue_metrics.py

@@ -16,6 +16,7 @@
 """
 
 import shutil
+from pathlib import Path
 from typing import List, Union
 
 import github3
@@ -166,6 +167,24 @@ def get_per_issue_metrics(
     return issues_with_metrics, num_issues_open, num_issues_closed
 
 
+def evaluate_markdown_file_size(output_file: str) -> None:
+    """
+    Evaluate the size of the markdown file and split it, if it is too large.
+    """
+    file_name_without_extension = Path(output_file).stem
+    max_char_count = 65535
+    if markdown_too_large_for_issue_body(output_file, max_char_count):
+        split_markdown_file(output_file, max_char_count)
+        shutil.move(output_file, f"{file_name_without_extension}_full.md")
+        shutil.move(f"{file_name_without_extension}_0.md", output_file)
+        print(
+            f"Issue metrics markdown file is too large for GitHub issue body and has been \
+split into multiple files. ie. {output_file}, {file_name_without_extension}_1.md, etc. \
+The full file is saved as {file_name_without_extension}_full.md\n\
+See https://github.com/github/issue-metrics/blob/main/docs/dealing-with-large-issue-metrics.md"
+        )
+
+
 def main():  # pragma: no cover
     """Run the issue-metrics script.
 
@@ -350,17 +369,7 @@ def main():  # pragma: no cover
         output_file=output_file,
     )
 
-    max_char_count = 65535
-    if markdown_too_large_for_issue_body("issue_metrics.md", max_char_count):
-        split_markdown_file("issue_metrics.md", max_char_count)
-        shutil.move("issue_metrics.md", "issue_metrics_full.md")
-        shutil.move("issue_metrics_0.md", "issue_metrics.md")
-        print(
-            "Issue metrics markdown file is too large for GitHub issue body and has been \
-split into multiple files. ie. issue_metrics.md, issue_metrics_1.md, etc. \
-The full file is saved as issue_metrics_full.md\n\
-See https://github.com/github/issue-metrics/blob/main/docs/dealing-with-large-issue-metrics.md"
-        )
+    evaluate_markdown_file_size(output_file)
 
 
 if __name__ == "__main__":

Diff for: markdown_writer.py

@@ -225,7 +225,7 @@ def write_to_markdown(
         if search_query:
             file.write(f"Search query used to find these items: `{search_query}`\n")
 
-    print("Wrote issue metrics to issue_metrics.md")
+    print(f"Wrote issue metrics to {output_file_name}")
 
 
 def write_overall_metrics_tables(

Diff for: test_issue_metrics.py

@@ -8,16 +8,17 @@
     TestSearchIssues: A class to test the search_issues function.
     TestGetPerIssueMetrics: A class to test the get_per_issue_metrics function.
     TestGetEnvVars: A class to test the get_env_vars function.
-
+    TestEvaluateMarkdownFileSize: A class to test the evaluate_markdown_file_size function.
 """
 
 import os
 import unittest
 from datetime import datetime, timedelta
-from unittest.mock import MagicMock, patch
+from unittest.mock import MagicMock, call, patch
 
 from issue_metrics import (
     IssueWithMetrics,
+    evaluate_markdown_file_size,
     get_env_vars,
     get_per_issue_metrics,
     measure_time_to_close,
@@ -478,5 +479,49 @@ def test_get_per_issue_metrics_with_discussion_with_hide_envs(self):
         self.assertEqual(metrics[0][1].time_to_first_response, None)
 
 
+class TestEvaluateMarkdownFileSize(unittest.TestCase):
+    """Test suite for the evaluate_markdown_file_size function."""
+
+    @patch("issue_metrics.markdown_too_large_for_issue_body")
+    def test_markdown_too_large_for_issue_body_called_with_output_file(
+        self, mock_evaluate
+    ):
+        """
+        Test that the function uses the output_file.
+        """
+        mock_evaluate.return_value = False
+        evaluate_markdown_file_size("test_issue_metrics.md")
+
+        mock_evaluate.assert_called_with("test_issue_metrics.md", 65535)
+
+    @patch("issue_metrics.print")
+    @patch("shutil.move")
+    @patch("issue_metrics.split_markdown_file")
+    @patch("issue_metrics.markdown_too_large_for_issue_body")
+    def test_split_markdown_file_when_file_size_too_large(
+        self, mock_evaluate, mock_split, mock_move, mock_print
+    ):
+        """
+        Test that the function is called with the output_file
+        environment variable.
+        """
+        mock_evaluate.return_value = True
+        evaluate_markdown_file_size("test_issue_metrics.md")
+
+        mock_split.assert_called_with("test_issue_metrics.md", 65535)
+        mock_move.assert_has_calls(
+            [
+                call("test_issue_metrics.md", "test_issue_metrics_full.md"),
+                call("test_issue_metrics_0.md", "test_issue_metrics.md"),
+            ]
+        )
+        mock_print.assert_called_with(
+            "Issue metrics markdown file is too large for GitHub issue body and has been \
+split into multiple files. ie. test_issue_metrics.md, test_issue_metrics_1.md, etc. \
+The full file is saved as test_issue_metrics_full.md\n\
+See https://github.com/github/issue-metrics/blob/main/docs/dealing-with-large-issue-metrics.md"
+        )
+
+
 if __name__ == "__main__":
     unittest.main()