test: cover remaining contributor paths

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

Author: Copilot

README.md

@@ -2,7 +2,8 @@
 
 [![Python package](https://github.com/github/contributors/actions/workflows/python-ci.yml/badge.svg)](https://github.com/github/contributors/actions/workflows/python-ci.yml)
 [![Docker Image CI](https://github.com/github/contributors/actions/workflows/docker-ci.yml/badge.svg)](https://github.com/github/contributors/actions/workflows/docker-ci.yml)
-[![CodeQL](https://github.com/github/contributors/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/github/contributors/actions/workflows/github-code-scanning/codeql)[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/github/contributors/badge)](https://scorecard.dev/viewer/?uri=github.com/github/contributors)
+[![CodeQL](https://github.com/github/contributors/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/github/contributors/actions/workflows/github-code-scanning/codeql)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/github/contributors/badge)](https://scorecard.dev/viewer/?uri=github.com/github/contributors)
 
 This is a GitHub Action that given an organization or specified repositories, produces information about the [contributors](https://chaoss.community/kb/metric-contributors/) over the specified time period.
 

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

@@ -45,6 +45,18 @@ def test_init(self):
             "commit_url5",
         )
 
+    def test_repr(self):
+        """Test the __repr__ method includes key fields."""
+        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.assertEqual(repr(self.contributor), expected)
+
     def test_merge_contributors(self):
         """
         Test the merge_contributors function.
@@ -214,6 +226,28 @@ def test_fetch_sponsor_info(self, mock_post):
             timeout=60,
         )
 
+    @patch("requests.post")
+    def test_fetch_sponsor_info_raises_on_error(self, mock_post):
+        """Test get_sponsor_information raises when the API response is invalid."""
+        mock_response = MagicMock()
+        mock_response.status_code = 500
+        mock_response.json.return_value = {"errors": [{"message": "fail"}]}
+        mock_post.return_value = mock_response
+
+        contributors = [
+            ContributorStats(
+                username="user1",
+                new_contributor=False,
+                avatar_url="https://avatars.githubusercontent.com/u/",
+                contribution_count="100",
+                commit_url="url1",
+                sponsor_info="",
+            ),
+        ]
+
+        with self.assertRaises(ValueError):
+            get_sponsor_information(contributors, token="token", ghe="")
+
 
 if __name__ == "__main__":
     unittest.main()

test_contributors.py

@@ -1,10 +1,11 @@
 """This module contains the tests for the contributors.py module"""
 
+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):
@@ -25,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",
@@ -58,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(
@@ -97,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
         )
 
@@ -133,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,
@@ -163,13 +172,13 @@ def test_get_contributors_skip_bot(self, mock_contributor_stats):
 
         mock_repo.contributors.return_value = [mock_user]
         mock_repo.full_name = "owner/repo"
-        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_repo.commits.assert_not_called()
+        mock_contributor_stats.assert_not_called()
 
     @patch("contributors.contributor_stats.ContributorStats")
     def test_get_contributors_no_commit_end_date(self, mock_contributor_stats):
@@ -187,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(
@@ -199,6 +208,143 @@ def test_get_contributors_no_commit_end_date(self, mock_contributor_stats):
             "",
         )
 
+    def test_get_contributors_skips_when_no_commits_in_range(self):
+        """Test get_contributors skips users with no commits in the date range."""
+        mock_repo = MagicMock()
+        mock_user = MagicMock()
+        mock_user.login = "user"
+        mock_user.avatar_url = "https://avatars.githubusercontent.com/u/12345678?v=4"
+        mock_user.contributions_count = 100
+        mock_repo.contributors.return_value = [mock_user]
+        mock_repo.full_name = "owner/repo"
+        mock_repo.commits.return_value = iter([])
+
+        result = contributors_module.get_contributors(
+            mock_repo, "2022-01-01", "2022-12-31", ""
+        )
+
+        self.assertEqual(result, [])
+
+    def test_get_contributors_handles_exception(self):
+        """Test get_contributors returns None when an exception is raised."""
+
+        class BoomIterable:  # pylint: disable=too-few-public-methods
+            """Iterable that raises an exception when iterated over."""
+
+            def __iter__(self):
+                raise RuntimeError("boom")
+
+        mock_repo = MagicMock()
+        mock_repo.full_name = "owner/repo"
+        mock_repo.contributors.return_value = BoomIterable()
+
+        with patch("builtins.print") as mock_print:
+            result = contributors_module.get_contributors(
+                mock_repo, "2022-01-01", "2022-12-31", ""
+            )
+
+        self.assertIsNone(result)
+        mock_print.assert_any_call(
+            "Error getting contributors for repository: owner/repo"
+        )
+
+    def test_main_runs_under_main_guard(self):
+        """Test running contributors as a script executes main."""
+        mock_env = MagicMock()
+        mock_env.get_env_vars.return_value = (
+            "org",
+            [],
+            123,
+            456,
+            b"key",
+            False,
+            "",
+            "",
+            "2022-01-01",
+            "2022-12-31",
+            "true",
+            False,
+        )
+
+        mock_auth = MagicMock()
+        mock_github = MagicMock()
+        mock_org = MagicMock()
+        mock_org.repositories.return_value = []
+        mock_github.organization.return_value = mock_org
+        mock_auth.auth_to_github.return_value = mock_github
+        mock_auth.get_github_app_installation_token.return_value = "token"
+
+        mock_markdown = MagicMock()
+        mock_json_writer = MagicMock()
+
+        with patch.dict(
+            "sys.modules",
+            {
+                "env": mock_env,
+                "auth": mock_auth,
+                "markdown": mock_markdown,
+                "json_writer": mock_json_writer,
+            },
+            clear=False,
+        ):
+            runpy.run_module("contributors", run_name="__main__")
+
+        mock_env.get_env_vars.assert_called_once()
+        mock_auth.auth_to_github.assert_called_once()
+        mock_auth.get_github_app_installation_token.assert_called_once_with(
+            "", 123, b"key", 456
+        )
+        mock_markdown.write_to_markdown.assert_called_once()
+        mock_json_writer.write_to_json.assert_called_once()
+
+    def test_main_sets_new_contributor_flag(self):
+        """Test main sets new_contributor when start/end dates are provided."""
+        contributor = ContributorStats(
+            "user1",
+            False,
+            "https://avatars.githubusercontent.com/u/1",
+            10,
+            "commit_url",
+            "",
+        )
+
+        with patch.object(
+            contributors_module.env, "get_env_vars"
+        ) as mock_get_env_vars, patch.object(
+            contributors_module.auth, "auth_to_github"
+        ) as mock_auth_to_github, patch.object(
+            contributors_module, "get_all_contributors"
+        ) as mock_get_all_contributors, patch.object(
+            contributors_module.contributor_stats,
+            "is_new_contributor",
+            return_value=True,
+        ) as mock_is_new, patch.object(
+            contributors_module.markdown, "write_to_markdown"
+        ), patch.object(
+            contributors_module.json_writer, "write_to_json"
+        ):
+            mock_get_env_vars.return_value = (
+                "org",
+                [],
+                None,
+                None,
+                b"",
+                False,
+                "token",
+                "",
+                "2022-01-01",
+                "2022-12-31",
+                False,
+                False,
+            )
+            mock_auth_to_github.return_value = MagicMock()
+            mock_get_all_contributors.side_effect = [[contributor], []]
+
+            contributors_module.main()
+
+        mock_is_new.assert_called_once_with("user1", [])
+        self.assertTrue(contributor.new_contributor)
+
 
 if __name__ == "__main__":
     unittest.main()

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()