Add test cases for list commands

* Added majority of tests for list commands. Should handle most
  cases and bring the coverage up to 90+% now.

* Fixed some small instances in the git commit per year function
  where some values might not be legit thanks to the test cases.

Author: tomice

git_py_stats/list_cmds.py

@@ -646,15 +646,26 @@ def git_commits_per_year(config: Dict[str, Union[str, int]]) -> None:
     output = run_git_command(cmd)
     if output:
         print("Git commits by year:\n")
+
         # Split the output into individual years
+        # Handle cases in case there are no commits found
         years = output.split("\n")
-        counter = collections.Counter(years)
+        years = [year for year in years if year.strip()]
+        if not years:
+            print("No valid years found in commits.")
+            return
 
-        # Determine the range of years
-        # TODO: This will need to be adjustable later
+        # Count the frequency of each year
+        # Handle cases in case years weren't valid
+        counter = collections.Counter(years)
         all_years = sorted(counter.keys())
-        start_year = int(all_years[0])
-        end_year = int(all_years[-1])
+        try:
+            start_year = int(all_years[0])
+            end_year = int(all_years[-1])
+        except (ValueError, IndexError):
+            # In case the conversion fails
+            print("No valid years found in commits.")
+            return
 
         # Initialize commit counts for all years in range
         commit_counts = {year: 0 for year in range(start_year, end_year + 1)}

git_py_stats/tests/test_list_cmds.py

@@ -5,7 +5,7 @@
 
 class TestListCmds(unittest.TestCase):
     """
-    Unit test class for testing list_cmds.
+    Unit test class for testing list_cmds functions.
     """
 
     def setUp(self):
@@ -24,26 +24,231 @@ def setUp(self):
     @patch("git_py_stats.list_cmds.print")
     def test_branch_tree(self, mock_print, mock_run_git_command) -> None:
         """
-        Test case for the branch_tree function in the list_cmds module.
-
-        Checks if `branch_tree` executes without errors and returns `None`.
-        The print function is mocked to prevent actual output during testing.
-
-        The test verifies that the function runs without raising any exceptions and
-        calls the print function at least once, indicating that some output was generated.
+        Test case for the branch_tree function.
         """
-        # Mock git command output to provide a sample branch tree
         mock_run_git_command.return_value = (
             "* 12345 Commit message\n"
             "| * 67890 Another commit message\n"
             "| * abcde Yet another commit message\n"
         )
 
-        # Call function with mock configuration
         list_cmds.branch_tree(self.mock_config)
 
-        # Assert that print was called at least once
         mock_print.assert_called()
+        mock_run_git_command.assert_called_once()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_branch_tree_no_data(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for branch_tree with no data.
+        """
+        mock_run_git_command.return_value = ""
+        list_cmds.branch_tree(self.mock_config)
+
+        mock_print.assert_called_with("No data available.")
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_branches_by_date(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for branches_by_date function.
+        """
+        mock_run_git_command.return_value = (
+            "[2021-01-01] Author1 branch1\n" "[2021-01-02] Author2 branch2\n"
+        )
+        list_cmds.branches_by_date()
+
+        mock_print.assert_called()
+        mock_run_git_command.assert_called_once()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_branches_by_date_no_data(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for branches_by_date with no data.
+        """
+        mock_run_git_command.return_value = ""
+        list_cmds.branches_by_date()
+
+        mock_print.assert_called_with("No commits found.")
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_contributors(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for the contributors function.
+        """
+        mock_run_git_command.return_value = "Author1\nAuthor2\nAuthor3\n"
+        list_cmds.contributors(self.mock_config)
+
+        mock_print.assert_called()
+        mock_run_git_command.assert_called_once()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_contributors_no_data(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for contributors with no data.
+        """
+        mock_run_git_command.return_value = ""
+        list_cmds.contributors(self.mock_config)
+
+        mock_print.assert_called_with("No contributors found.")
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_new_contributors(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for new_contributors function.
+        """
+        mock_run_git_command.return_value = "author1@example.com|1577836800\n"
+        list_cmds.new_contributors(self.mock_config, "2020-01-01")
+
+        mock_print.assert_called()
+        mock_run_git_command.assert_called_once()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_new_contributors_invalid_date(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for new_contributors with invalid date.
+        """
+        list_cmds.new_contributors(self.mock_config, "invalid-date")
+
+        mock_print.assert_called_with("Invalid date format. Please use YYYY-MM-DD.")
+        mock_run_git_command.assert_not_called()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_git_commits_per_author(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for git_commits_per_author function.
+        """
+        mock_run_git_command.return_value = "Author:Author1 <author1@example.com>\n"
+        list_cmds.git_commits_per_author(self.mock_config)
+
+        mock_print.assert_called()
+        mock_run_git_command.assert_called_once()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_git_commits_per_author_no_data(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for git_commits_per_author with no data.
+        """
+        mock_run_git_command.return_value = ""
+        list_cmds.git_commits_per_author(self.mock_config)
+
+        mock_print.assert_called_with("No commits found.")
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_git_commits_per_date(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for git_commits_per_date function.
+        """
+        mock_run_git_command.return_value = "2021-01-01\n2021-01-01\n2021-01-02\n"
+        list_cmds.git_commits_per_date(self.mock_config)
+
+        mock_print.assert_called()
+        mock_run_git_command.assert_called_once()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_git_commits_per_date_no_data(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for git_commits_per_date with no data.
+        """
+        mock_run_git_command.return_value = ""
+        list_cmds.git_commits_per_date(self.mock_config)
+
+        mock_print.assert_called_with("No commits found.")
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_git_commits_per_month(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for git_commits_per_month function.
+        """
+        mock_run_git_command.return_value = "Jan\nJan\nFeb\n"
+        list_cmds.git_commits_per_month(self.mock_config)
+
+        mock_print.assert_called()
+        mock_run_git_command.assert_called_once()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_git_commits_per_year(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for git_commits_per_year function.
+        """
+        mock_run_git_command.return_value = "2020\n2021\n2021\n2022\n"
+        list_cmds.git_commits_per_year(self.mock_config)
+
+        mock_print.assert_any_call("Git commits by year:\n")
+        self.assertGreater(mock_print.call_count, 1)
+        mock_run_git_command.assert_called_once()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_git_commits_per_year_empty(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for git_commits_per_year with empty data.
+        """
+        mock_run_git_command.return_value = ""  # No output
+        list_cmds.git_commits_per_year(self.mock_config)
+
+        mock_print.assert_called_with("No commits found.")
+        mock_run_git_command.assert_called_once()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_git_commits_per_year_invalid_data(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for git_commits_per_year with invalid data.
+        """
+        mock_run_git_command.return_value = "\n\n\n"  # Invalid output, just new lines
+        list_cmds.git_commits_per_year(self.mock_config)
+
+        mock_print.assert_called_with("No valid years found in commits.")
+        mock_run_git_command.assert_called_once()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_git_commits_per_weekday(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for git_commits_per_weekday function.
+        """
+        mock_run_git_command.return_value = "Mon\nTue\nWed\n"
+        list_cmds.git_commits_per_weekday(self.mock_config)
+
+        mock_print.assert_called()
+        mock_run_git_command.assert_called_once()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_git_commits_per_hour(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for git_commits_per_hour function.
+        """
+        mock_run_git_command.return_value = "10\n11\n12\n"
+        list_cmds.git_commits_per_hour(self.mock_config)
+
+        mock_print.assert_called()
+        mock_run_git_command.assert_called_once()
+
+    @patch("git_py_stats.list_cmds.run_git_command")
+    @patch("git_py_stats.list_cmds.print")
+    def test_git_commits_per_timezone(self, mock_print, mock_run_git_command) -> None:
+        """
+        Test case for git_commits_per_timezone function.
+        """
+        mock_run_git_command.return_value = "+0200\n-0500\n+0200\n"
+        list_cmds.git_commits_per_timezone(self.mock_config)
+
+        mock_print.assert_called()
+        mock_run_git_command.assert_called_once()
 
 
 if __name__ == "__main__":

setup.py

@@ -1,29 +1,28 @@
 from setuptools import setup, find_packages
 
 setup(
-    name='git-py-stats',
-    version='0.1',
+    name="git-py-stats",
+    version="0.1",
     packages=find_packages(
         exclude=["*.tests", "*.tests.*", "tests.*", "tests"]
     ),  # Exclude test packages
     entry_points={
-        'console_scripts': [
-            'git-py-stats=git_py_stats.main:main',
+        "console_scripts": [
+            "git-py-stats=git_py_stats.main:main",
         ],
     },
     install_requires=[
         # Nothing
     ],
     data_files=[
         # Manpages
-        ('share/man/man1', ['man/git-py-stats.1']),
+        ("share/man/man1", ["man/git-py-stats.1"]),
     ],
-    description='A Python Implementation of git-quick-stats',
-    long_description=open('README.md').read(),
-    long_description_content_type='text/markdown',
-    author='Tom Ice',
-    license='MIT',
-    url='https://github.com/tomice/git-py-stats',
-    python_requires='>=3.6',
+    description="A Python Implementation of git-quick-stats",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    author="Tom Ice",
+    license="MIT",
+    url="https://github.com/tomice/git-py-stats",
+    python_requires=">=3.6",
 )
-