test: add unit tests case (#38)

* test(commit_commands): add unit tests for commit handling and parser setup

* refactor(tests): update test structure and enable pytest for testing framework

* refactor(tests): remove redundant assertion in commit command tests

* refactor(tests): remove unnecessary mock assertions in commit command tests

* test(web_config): add tests for LLM and Jira web server configuration

* fix(config_commands): improve error handling for LLM config file reading

* refactor(config_commands): move import of recursive_search_git_folder to utils module

* fix(tests): update patch path for recursive_search_git_folder in config_commands tests

* test(doc_commands): add unit tests for document generation commands and error handling

Author: sumansaurabh

.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestEnabled": false,
+    "python.testing.nosetestsEnabled": false,
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
+    "python.testing.autoTestDiscoverOnSaveEnabled": true,
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./tests",
+        "-p",
+        "test_*.py"
+    ]
+}

penify_hook/commands/config_commands.py

@@ -8,6 +8,7 @@
 from pathlib import Path
 from threading import Thread
 import logging
+from penify_hook.utils import recursive_search_git_folder
 
 
 def get_penify_config() -> Path:
@@ -16,8 +17,6 @@ def get_penify_config() -> Path:
     This function searches for the .penify file in the current directory
     and its parent directories until it finds it or reaches the home directory.
     """
-    from penify_hook.utils import recursive_search_git_folder
-
     current_dir = os.getcwd()
     home_dir = recursive_search_git_folder(current_dir)
 
@@ -55,8 +54,9 @@ def save_llm_config(model, api_base, api_key):
         try:
             with open(penify_file, 'r') as f:
                 config = json.load(f)
-        except json.JSONDecodeError:
-            pass
+        except (json.JSONDecodeError, IOError, OSError) as e:
+            print(f"Error reading configuration file: {str(e)}")
+            # Continue with empty config
 
     # Update or add LLM configuration
     config['llm'] = {

pytest.ini

@@ -0,0 +1,5 @@
+[pytest]
+python_files = test_*.py
+python_classes = Test*
+python_functions = test_*
+testpaths = tests

tests/__init__.py

@@ -0,0 +1 @@
+# Empty file to make tests directory a proper Python package

tests/conftest.py

@@ -0,0 +1,8 @@
+import pytest
+import os
+import sys
+
+# Add project root to sys.path for imports to work
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+
+# Common fixtures can be added here

tests/test_commit_commands.py

@@ -0,0 +1,254 @@
+import os
+import sys
+import pytest
+from unittest.mock import patch, MagicMock, call
+
+from penify_hook.commands.commit_commands import commit_code, setup_commit_parser, handle_commit
+
+class TestCommitCommands:
+
+    @pytest.fixture
+    def mock_api_client(self):
+        with patch('penify_hook.api_client.APIClient', create=True) as mock:
+            api_client_instance = MagicMock()
+            mock.return_value = api_client_instance
+            yield mock, api_client_instance
+
+    @pytest.fixture
+    def mock_llm_client(self):
+        with patch('penify_hook.llm_client.LLMClient', create=True) as mock:
+            llm_client_instance = MagicMock()
+            mock.return_value = llm_client_instance
+            yield mock, llm_client_instance
+
+    @pytest.fixture
+    def mock_jira_client(self):
+        with patch('penify_hook.jira_client.JiraClient', create=True) as mock:
+            jira_instance = MagicMock()
+            jira_instance.is_connected.return_value = True
+            mock.return_value = jira_instance
+            yield mock, jira_instance
+
+    @pytest.fixture
+    def mock_commit_doc_gen(self):
+        with patch('penify_hook.commit_analyzer.CommitDocGenHook', create=True) as mock:
+            doc_gen_instance = MagicMock()
+            mock.return_value = doc_gen_instance
+            yield mock, doc_gen_instance
+
+    @pytest.fixture
+    def mock_git_folder_search(self):
+        with patch('penify_hook.utils.recursive_search_git_folder', create=True) as mock:
+            mock.return_value = '/mock/git/folder'
+            yield mock
+            
+    @pytest.fixture
+    def mock_print_functions(self):
+        with patch('penify_hook.ui_utils.print_info', create=True) as mock_info, \
+             patch('penify_hook.ui_utils.print_warning', create=True) as mock_warning, \
+             patch('penify_hook.ui_utils.print_error', create=True) as mock_error:
+            yield mock_info, mock_warning, mock_error
+
+    @patch('penify_hook.api_client.APIClient', create=True)
+    @patch('penify_hook.llm_client.LLMClient', create=True)
+    @patch('penify_hook.commit_analyzer.CommitDocGenHook', create=True)
+    @patch('penify_hook.utils.recursive_search_git_folder', create=True)
+    @patch('penify_hook.ui_utils.print_info', create=True)
+    @patch('penify_hook.ui_utils.print_warning', create=True)
+    @patch('penify_hook.ui_utils.print_error', create=True)
+    def test_commit_code_with_llm_client(self, mock_error, mock_warning, mock_info, 
+                                        mock_git_folder_search, mock_doc_gen, 
+                                        mock_llm_client, mock_api_client):
+        # Setup mocks
+        api_instance = MagicMock()
+        mock_api_client.return_value = api_instance
+        
+        llm_instance = MagicMock()
+        mock_llm_client.return_value = llm_instance
+        
+        doc_gen_instance = MagicMock()
+        mock_doc_gen.return_value = doc_gen_instance
+        
+        mock_git_folder_search.return_value = '/mock/git/folder'
+        
+        # Call function with LLM parameters
+        commit_code(
+            api_url="http://api.example.com",
+            token="api-token",
+            message="test commit",
+            open_terminal=False,
+            generate_description=True,
+            llm_model="gpt-4",
+            llm_api_base="http://llm-api.example.com",
+            llm_api_key="llm-api-key"
+        )
+        
+        # Verify calls
+        mock_api_client.assert_called_once_with("http://api.example.com", "api-token")
+        mock_llm_client.assert_called_once_with(
+            model="gpt-4",
+            api_base="http://llm-api.example.com",
+            api_key="llm-api-key"
+        )
+        mock_doc_gen.assert_called_once_with('/mock/git/folder', api_instance, llm_instance, None)
+        doc_gen_instance.run.assert_called_once_with("test commit", False, True)
+
+    @patch('penify_hook.api_client.APIClient', create=True)
+    @patch('penify_hook.llm_client.LLMClient', create=True)
+    @patch('penify_hook.jira_client.JiraClient', create=True)
+    @patch('penify_hook.commit_analyzer.CommitDocGenHook', create=True)
+    @patch('penify_hook.utils.recursive_search_git_folder', create=True)
+    @patch('penify_hook.ui_utils.print_info', create=True)
+    @patch('penify_hook.ui_utils.print_warning', create=True)
+    @patch('penify_hook.ui_utils.print_error', create=True)
+    def test_commit_code_with_jira_client(self, mock_error, mock_warning, mock_info,
+                                         mock_git_folder_search, mock_doc_gen, 
+                                         mock_jira_client, mock_llm_client, mock_api_client):
+        # Setup mocks
+        api_instance = MagicMock()
+        mock_api_client.return_value = api_instance
+        
+        llm_instance = MagicMock()
+        mock_llm_client.return_value = llm_instance
+        
+        jira_instance = MagicMock()
+        jira_instance.is_connected.return_value = True
+        mock_jira_client.return_value = jira_instance
+        
+        doc_gen_instance = MagicMock()
+        mock_doc_gen.return_value = doc_gen_instance
+        
+        mock_git_folder_search.return_value = '/mock/git/folder'
+        
+        # Call function with JIRA parameters
+        commit_code(
+            api_url="http://api.example.com",
+            token="api-token",
+            message="test commit",
+            open_terminal=False,
+            generate_description=True,
+            llm_model="gpt-4",
+            llm_api_base="http://llm-api.example.com",
+            llm_api_key="llm-api-key",
+            jira_url="https://jira.example.com",
+            jira_user="jira-user",
+            jira_api_token="jira-token"
+        )
+        
+        # Verify calls
+        mock_jira_client.assert_called_once_with(
+            jira_url="https://jira.example.com",
+            jira_user="jira-user",
+            jira_api_token="jira-token"
+        )
+        mock_doc_gen.assert_called_once_with('/mock/git/folder', api_instance, llm_instance, jira_instance)
+
+    @patch('penify_hook.api_client.APIClient', create=True)
+    @patch('penify_hook.jira_client.JiraClient', create=True)
+    @patch('penify_hook.commit_analyzer.CommitDocGenHook', create=True)
+    @patch('penify_hook.utils.recursive_search_git_folder', create=True)
+    @patch('penify_hook.ui_utils.print_info', create=True)
+    @patch('penify_hook.ui_utils.print_warning', create=True)
+    @patch('penify_hook.ui_utils.print_error', create=True)
+    def test_commit_code_with_jira_connection_failure(self, mock_error, mock_warning, mock_info,
+                                                     mock_git_folder_search, mock_doc_gen,
+                                                     mock_jira_client, mock_api_client):
+        # Setup mocks
+        api_instance = MagicMock()
+        mock_api_client.return_value = api_instance
+        
+        jira_instance = MagicMock()
+        jira_instance.is_connected.return_value = False
+        mock_jira_client.return_value = jira_instance
+        
+        doc_gen_instance = MagicMock()
+        mock_doc_gen.return_value = doc_gen_instance
+        
+        mock_git_folder_search.return_value = '/mock/git/folder'
+        
+        # Call function
+        commit_code(
+            api_url="http://api.example.com",
+            token="api-token",
+            message="test commit",
+            open_terminal=False,
+            generate_description=True,
+            llm_model=None,
+            jira_url="https://jira.example.com",
+            jira_user="jira-user",
+            jira_api_token="jira-token"
+        )
+        
+        # Verify JIRA warning
+        mock_doc_gen.assert_called_once_with('/mock/git/folder', api_instance, None, None)
+
+    @patch('penify_hook.api_client.APIClient', create=True)
+    @patch('penify_hook.commit_analyzer.CommitDocGenHook', create=True)
+    @patch('penify_hook.utils.recursive_search_git_folder', create=True)
+    @patch('sys.exit')
+    @patch('builtins.print')
+    def test_commit_code_error_handling(self, mock_print, mock_exit, 
+                                       mock_git_folder_search, mock_doc_gen, mock_api_client):
+        # Setup mocks
+        mock_doc_gen.side_effect = Exception("Test error")
+        mock_git_folder_search.return_value = '/mock/git/folder'
+        
+        # Call function
+        commit_code(
+            api_url="http://api.example.com",
+            token="api-token",
+            message="test commit",
+            open_terminal=False,
+            generate_description=True
+        )
+        
+        mock_print.assert_called_once_with("Error: Test error")
+        mock_exit.assert_called_once_with(1)
+
+    def test_setup_commit_parser(self):
+        parser = MagicMock()
+        setup_commit_parser(parser)
+        
+        # Verify parser configuration
+        assert parser.add_argument.call_count == 3
+        parser.add_argument.assert_any_call("-m", "--message", required=False, help="Commit with contextual commit message.", default="N/A")
+        parser.add_argument.assert_any_call("-e", "--terminal", action="store_true", help="Open edit terminal before committing.")
+        parser.add_argument.assert_any_call("-d", "--description", action="store_false", help="It will generate commit message with title and description.", default=False)
+
+    @patch('penify_hook.commands.commit_commands.get_token')
+    @patch('penify_hook.commands.commit_commands.get_jira_config')
+    @patch('penify_hook.commands.commit_commands.get_llm_config')
+    @patch('penify_hook.commands.commit_commands.commit_code')
+    @patch('penify_hook.commands.commit_commands.print_info')
+    @patch('penify_hook.constants.API_URL', "http://api.example.com")
+    def test_handle_commit(self, mock_print_info, mock_commit_code, mock_get_token, 
+                         mock_get_llm_config, mock_get_jira_config):
+        # Setup mocks
+        mock_get_llm_config.return_value = {
+            'model': 'test-model',
+            'api_base': 'http://llm-api.example.com',
+            'api_key': 'llm-key'
+        }
+        mock_get_token.return_value = 'api-token'
+        mock_get_jira_config.return_value = {
+            'url': 'https://jira.example.com',
+            'username': 'jira-user',
+            'api_token': 'jira-token'
+        }
+        
+        # Create args
+        args = MagicMock()
+        args.message = "test commit"
+        args.terminal = True
+        args.description = True
+        
+        # Call function
+        handle_commit(args)
+        
+        # Verify
+        mock_print_info.assert_called_with("Generate Commit Description: True")
+        mock_commit_code.assert_called_once_with(
+            "http://api.example.com", 'api-token', "test commit", True, True,
+            'test-model', 'http://llm-api.example.com', 'llm-key',
+            'https://jira.example.com', 'jira-user', 'jira-token'
+        )