test: harden repr assertions

Signed-off-by: Venu Vardhan Reddy Tekula <venuvrtekula@gmail.com>

Author: vchrombie

contributor_stats.py

@@ -59,7 +59,8 @@ def __repr__(self) -> str:
             f"contributor_stats(username={self.username}, "
             f"new_contributor={self.new_contributor}, "
             f"avatar_url={self.avatar_url}, "
-            f"contribution_count={self.contribution_count}, commit_url={self.commit_url})"
+            f"contribution_count={self.contribution_count}, "
+            f"commit_url={self.commit_url}, "
             f"sponsor_info={self.sponsor_info})"
         )
 

test_contributor_stats.py

@@ -47,14 +47,15 @@ def test_init(self):
 
     def test_repr(self):
         """Test the __repr__ method includes key fields."""
-        representation = repr(self.contributor)
-        self.assertIn("contributor_stats(username=zkoppert", representation)
-        self.assertIn("new_contributor=False", representation)
-        self.assertIn(
-            "avatar_url=https://avatars.githubusercontent.com/u/29484535?v=4",
-            representation,
+        expected = (
+            "contributor_stats(username=zkoppert, "
+            "new_contributor=False, "
+            "avatar_url=https://avatars.githubusercontent.com/u/29484535?v=4, "
+            "contribution_count=1261, "
+            "commit_url=commit_url5, "
+            "sponsor_info=)"
         )
-        self.assertIn("contribution_count=1261", representation)
+        self.assertEqual(repr(self.contributor), expected)
 
     def test_merge_contributors(self):
         """

test_contributors.py

@@ -2,11 +2,10 @@
 
 import runpy
 import unittest
-from unittest.mock import MagicMock, patch
+from unittest.mock import MagicMock, call, patch
 
 import contributors as contributors_module
 from contributor_stats import ContributorStats
-from contributors import get_all_contributors, get_contributors
 
 
 class TestContributors(unittest.TestCase):
@@ -27,7 +26,7 @@ def test_get_contributors(self, mock_contributor_stats):
         mock_repo.contributors.return_value = [mock_user]
         mock_repo.full_name = "owner/repo"
 
-        get_contributors(mock_repo, "2022-01-01", "2022-12-31", "")
+        contributors_module.get_contributors(mock_repo, "2022-01-01", "2022-12-31", "")
 
         mock_contributor_stats.assert_called_once_with(
             "user",
@@ -60,8 +59,8 @@ def test_get_all_contributors_with_organization(self, mock_get_contributors):
         ]
         ghe = ""
 
-        result = get_all_contributors(
-            "org", "", "2022-01-01", "2022-12-31", mock_github_connection, ghe
+        result = contributors_module.get_all_contributors(
+            "org", [], "2022-01-01", "2022-12-31", mock_github_connection, ghe
         )
 
         self.assertEqual(
@@ -99,7 +98,7 @@ def test_get_all_contributors_with_repository(self, mock_get_contributors):
         ]
         ghe = ""
 
-        result = get_all_contributors(
+        result = contributors_module.get_all_contributors(
             "", ["owner/repo"], "2022-01-01", "2022-12-31", mock_github_connection, ghe
         )
 
@@ -135,14 +134,22 @@ def test_get_contributors_skip_users_with_no_commits(self, mock_contributor_stat
         mock_user2.avatar_url = "https://avatars.githubusercontent.com/u/12345679?v=4"
         mock_user2.contributions_count = 102
 
-        mock_repo.contributors.return_value = [mock_user]
+        mock_repo.contributors.return_value = [mock_user, mock_user2]
         mock_repo.full_name = "owner/repo"
-        mock_repo.get_commits.side_effect = StopIteration
+        mock_repo.commits.side_effect = [
+            iter([object()]),  # user has commits in range
+            iter([]),  # user2 has no commits in range and should be skipped
+        ]
         ghe = ""
 
-        get_contributors(mock_repo, "2022-01-01", "2022-12-31", ghe)
+        contributors_module.get_contributors(mock_repo, "2022-01-01", "2022-12-31", ghe)
 
-        # Note that only user is returned and user2 is not returned here because there were no commits in the date range
+        mock_repo.commits.assert_has_calls(
+            [
+                call(author="user", since="2022-01-01", until="2022-12-31"),
+                call(author="user2", since="2022-01-01", until="2022-12-31"),
+            ]
+        )
         mock_contributor_stats.assert_called_once_with(
             "user",
             False,
@@ -168,10 +175,10 @@ def test_get_contributors_skip_bot(self, mock_contributor_stats):
         mock_repo.get_commits.side_effect = StopIteration
         ghe = ""
 
-        get_contributors(mock_repo, "2022-01-01", "2022-12-31", ghe)
+        contributors_module.get_contributors(mock_repo, "2022-01-01", "2022-12-31", ghe)
 
-        # Note that only user is returned and user2 is not returned here because there were no commits in the date range
-        mock_contributor_stats.isEmpty()
+        # Ensure that the bot user is skipped and ContributorStats is never instantiated
+        mock_contributor_stats.assert_not_called()
 
     @patch("contributors.contributor_stats.ContributorStats")
     def test_get_contributors_no_commit_end_date(self, mock_contributor_stats):
@@ -189,7 +196,7 @@ def test_get_contributors_no_commit_end_date(self, mock_contributor_stats):
         mock_repo.get_commits.side_effect = StopIteration
         ghe = ""
 
-        get_contributors(mock_repo, "2022-01-01", "", ghe)
+        contributors_module.get_contributors(mock_repo, "2022-01-01", "", ghe)
 
         # Note that only user is returned and user2 is not returned here because there were no commits in the date range
         mock_contributor_stats.assert_called_once_with(
@@ -212,7 +219,9 @@ def test_get_contributors_skips_when_no_commits_in_range(self):
         mock_repo.full_name = "owner/repo"
         mock_repo.commits.return_value = iter([])
 
-        result = get_contributors(mock_repo, "2022-01-01", "2022-12-31", "")
+        result = contributors_module.get_contributors(
+            mock_repo, "2022-01-01", "2022-12-31", ""
+        )
 
         self.assertEqual(result, [])
 
@@ -230,7 +239,9 @@ def __iter__(self):
         mock_repo.contributors.return_value = BoomIterable()
 
         with patch("builtins.print") as mock_print:
-            result = get_contributors(mock_repo, "2022-01-01", "2022-12-31", "")
+            result = contributors_module.get_contributors(
+                mock_repo, "2022-01-01", "2022-12-31", ""
+            )
 
         self.assertIsNone(result)
         mock_print.assert_any_call(

test_env.py

@@ -294,6 +294,21 @@ def test_get_env_vars_valid_date_range(self):
         self.assertEqual(start_date, "2024-01-01")
         self.assertEqual(end_date, "2025-01-01")
 
+    @patch.dict(os.environ, {"TEST_INT": "12.34"}, clear=True)
+    def test_get_int_env_var_returns_none_for_invalid_int(self):
+        """Test that invalid integer env values return None."""
+        self.assertIsNone(env.get_int_env_var("TEST_INT"))
+
+    def test_validate_date_range_invalid_date_format_raises(self):
+        """Test that invalid date formats raise a ValueError."""
+        with self.assertRaises(ValueError) as cm:
+            env.validate_date_range("2024/01/01", "2024-02-01")
+        the_exception = cm.exception
+        self.assertEqual(
+            str(the_exception),
+            "start_date and end_date must be in the format YYYY-MM-DD",
+        )
+
 
 if __name__ == "__main__":
     unittest.main()