test code added

CONTRIBUTING.md updated for testing instruction

Author: gitdevjin

CONTRIBUTING.md

@@ -1,4 +1,6 @@
-## To set up automated Ruff linting and formatting with VS Code, Follow the instructions:
+# Formatter and Linter
+
+To set up automated Ruff linting and formatting with VS Code, Follow the instructions:
 
 ### 1. Python Extension for VS Code (if not already installed):
 
@@ -22,3 +24,41 @@ poetry run ruff format .
 ```bash
 poetry run ruff check .
 ```
+
+# Testing
+
+For testing, we use `pytest`.
+
+### install `pytest` if not installed yet.
+```bash
+poetry add --dev pytest
+```
+
+### Running `pytest`
+This command will run files named `test_*.py` or `*_test.py`
+```bash
+poetry run pytest
+```
+
+
+For more detailed test result, you can use `-v` option
+```bash
+poetry run pytest -v
+```
+
+for more detailed test information
+```bash
+poetry run pytest -vv
+```
+
+### Writing TestCode
+You should name your test class and method as follows:
+
+#### Class name starts with `Test`
+
+#### Method name starts with `test_`
+
+```python
+class TestMyFeature: # class name
+    def test_feature_functionality: # method name
+```

code_mage/api.py

@@ -9,9 +9,7 @@ def __init__(self, model, config):
 		self.model = model if model is not None else "openrouter"
 
 		if self.model not in self.supported_model:
-			sys.exit(
-				f"{self.model} api model is not suppored. Model Supported: {self.supported_model}"
-			)
+			sys.exit(f"{self.model} is not suppored. Model Supported: {self.supported_model}")
 
 		# default api_url and api_model
 		self.api_url = "https://openrouter.ai/api/v1"

code_mage/argsParser.py

@@ -0,0 +1,52 @@
+import argparse
+
+
+def arg_parser(config):
+	VERSION = "release 0.1"
+
+	parser = argparse.ArgumentParser(
+		description="This Tool translates a source file into another programming language."
+	)
+
+	# Arguments
+	parser.add_argument("source_files", nargs="*", help="The path to the source file to translate.")
+
+	# Options
+	parser.add_argument(
+		"--language",
+		"-l",
+		help="The language to translate the source files into",
+		default=config.get("language"),
+	)
+	parser.add_argument(
+		"--output",
+		"-o",
+		help="Specify the output file name(without extension)",
+		default=config.get("output"),
+	)
+	parser.add_argument(
+		"--version",
+		"-v",
+		action="version",
+		version=f"CodeMage {VERSION}",
+		help="Show program's version number and exit",
+	)
+	parser.add_argument(
+		"--token-usage",
+		"-t",
+		action="store_true",
+		help="Get information about token usage for the prompt and response",
+		default=config.get("token_usage", False),
+	)
+	parser.add_argument(
+		"--model", "-m", help="Specify the LLM API model name", default=config.get("model")
+	)
+	parser.add_argument(
+		"--stream",
+		"-s",
+		action="store_true",
+		help="Stream out the output into stdout",
+		default=config.get("stream", False),
+	)
+
+	return parser.parse_args()

code_mage/codeMage.py

@@ -1,63 +1,16 @@
 #!/usr/bin/env python3
 
-import argparse
 import sys
 from .translator import Translator
 from .loadConfig import load_config
+from .argsParser import arg_parser
 
 
 def main():
-	VERSION = "release 0.1"
-
 	# Load config file
 	config = load_config()
 
-	parser = argparse.ArgumentParser(
-		description="This Tool translates a source file into another programming language."
-	)
-
-	# Arguments
-	parser.add_argument("source_files", nargs="*", help="The path to the source file to translate.")
-
-	# Options
-	parser.add_argument(
-		"--language",
-		"-l",
-		help="The language to translate the source files into",
-		default=config.get("language"),
-	)
-	parser.add_argument(
-		"--output",
-		"-o",
-		help="Specify the output file name(without extension)",
-		default=config.get("output"),
-	)
-	parser.add_argument(
-		"--version",
-		"-v",
-		action="version",
-		version=f"CodeMage {VERSION}",
-		help="Show program's version number and exit",
-	)
-	parser.add_argument(
-		"--token-usage",
-		"-t",
-		action="store_true",
-		help="Get information about token usage for the prompt and response",
-		default=config.get("token_usage", False),
-	)
-	parser.add_argument(
-		"--model", "-m", help="Specify the LLM API model name", default=config.get("model")
-	)
-	parser.add_argument(
-		"--stream",
-		"-s",
-		action="store_true",
-		help="Stream out the output into stdout",
-		default=config.get("stream", False),
-	)
-
-	args = parser.parse_args()
+	args = arg_parser(config)
 
 	if not args.source_files:
 		sys.exit(
@@ -67,6 +20,7 @@ def main():
 	translator = Translator(args, config)
 
 	for index, file in enumerate(args.source_files):
+		print(file)
 		translator.translate(file, index + 1)
 
 

code_mage/translator.py

@@ -85,16 +85,17 @@ def __get_output_filename(self, origin_file_name, file_number):
 		return output_file_name
 
 	def __get_source_lang(self, extension):
+		src_lang = "none"
 		if extension == ".js":
-			self.src_lang = "javascript"
+			src_lang = "javascript"
 		elif extension == ".py":
-			self.src_lang = "python"
+			src_lang = "python"
 		elif extension == ".cpp":
-			self.src_lang = "c++"
+			src_lang = "c++"
 		elif extension == ".java":
-			self.src_lang = "java"
+			src_lang = "java"
 
-		return self.src_lang
+		return src_lang
 
 	def __get_output_ext(self, language):
 		# Decide output file extension.

pyproject.toml

@@ -13,11 +13,12 @@ toml = "^0.10.2"
 
 [tool.poetry.group.dev.dependencies]
 ruff = "^0.7.1"
+pytest = "^8.3.3"
+pytest-mock = "^3.14.0"
 
 [tool.ruff]
 line-length = 100
-exclude = [
-    "tests/*",          
+exclude = [         
     "docs/*",           
     "*.pyc",            
     "migrations/*",     

tests/test_api.py

@@ -0,0 +1,137 @@
+import pytest
+from unittest.mock import patch, MagicMock
+import os
+from code_mage.api import Api
+
+
+class TestApiConstructor:
+	@pytest.fixture
+	def mock_config(self):
+		return {"OPENROUTER_API_KEY": "fake_api_key_from_toml"}
+
+	def test_constructor_with_openrouter_and_config(self, mock_config, monkeypatch):
+		# This overwirtes only the specified key-value pair.
+		monkeypatch.setenv("OPENROUTER_API_KEY", "")
+
+		api = Api(model="openrouter", config=mock_config)
+
+		assert api.model == "openrouter"
+		assert api.api_model == "sao10k/l3-euryale-70b"
+		assert api.api_url == "https://openrouter.ai/api/v1"
+		assert api.api_key == "fake_api_key_from_toml"
+		assert api.supported_model == ["groq", "openrouter"]
+
+	def test_constructor_with_groq_and_env(self, mock_config, monkeypatch):
+		# Mock the environment variable for OPENROUTER_API_KEY
+		monkeypatch.setenv("GROQ_API_KEY", "fake_api_key_from_env")
+
+		api = Api(model="groq", config=mock_config)
+
+		assert api.model == "groq"
+		assert api.api_model == "llama3-8b-8192"
+		assert api.api_url == "https://api.groq.com/openai/v1"
+		assert api.api_key == "fake_api_key_from_env"
+		assert api.supported_model == ["groq", "openrouter"]
+
+	def test_constructor_with_unsupported_model(self, mock_config, monkeypatch):
+		monkeypatch.setenv("GROQ_API_KEY", "fake_api_key_from_env")
+
+		with pytest.raises(SystemExit) as exc_info:
+			api = Api(model="unsupported_model", config=mock_config)  # noqa
+
+		assert (
+			str(exc_info.value)
+			== "unsupported_model is not suppored. Model Supported: ['groq', 'openrouter']"
+		)
+
+
+class TestApiWithEnv:
+	@pytest.fixture
+	def mock_config(self):
+		return {
+			"OPENROUTER_API_KEY": "fake_openrouter_api_key_from_toml",
+			"GROQ_API_KEY": "fake_groq_api_key",
+		}
+
+	# Mock OpenAI response
+	def mock_api_call(self, *args, **kwargs):
+		# Return a mock response object with a `choices` attribute
+		mock_response = MagicMock()
+		mock_response.choices = [{"message": {"content": "Translated code"}}]
+		return mock_response
+
+	# Test when model is supported
+	@patch.dict(
+		os.environ,
+		{
+			"OPENROUTER_API_KEY": "fake_api_key_from_env",
+			"GROQ_API_KEY": "fake_groq_api_key_from_env",
+		},
+	)
+	@patch("code_mage.api.OpenAI")
+	def test_api_with_openrouter(self, mock_openai_class):
+		# Mock the OpenAI client and its methods
+		mock_client = MagicMock()
+
+		# When the code create OpenAI class inside call_api(), it's replaced by mock_openai_class
+		mock_openai_class.return_value = mock_client
+		mock_client.chat.completions.create = MagicMock(return_value=self.mock_api_call())
+
+		# Create an instance of the Api with a supported model
+		api = Api(model="openrouter", config={})
+
+		# Simulate an API call
+		response = api.call_api(target_lang="python", code="some_code")
+
+		# Check if the API call was made with the expected arguments
+		mock_client.chat.completions.create.assert_called_once_with(
+			extra_headers={},
+			model="sao10k/l3-euryale-70b",
+			messages=[
+				{"role": "system", "content": "only display the code without any explanation"},
+				{"role": "user", "content": "translate this to python language: some_code"},
+			],
+			stream=False,
+		)
+
+		# Assert the response content
+		assert response.choices[0]["message"]["content"] == "Translated code"
+
+	@patch.dict(
+		os.environ,
+		{
+			"OPENROUTER_API_KEY": "fake_api_key_from_env",
+			"GROQ_API_KEY": "fake_groq_api_key_from_env",
+		},
+	)
+	@patch("code_mage.api.OpenAI")
+	def test_api_with_groq(self, mock_openai_class):
+		# Mock the OpenAI client and its methods
+		mock_client = MagicMock()
+
+		# When the code create OpenAI class inside call_api(), it's replaced by mock_openai_class
+		mock_openai_class.return_value = mock_client
+		mock_client.chat.completions.create = MagicMock(return_value=self.mock_api_call())
+
+		# Create an instance of the Api with a supported model
+		api = Api(model="groq", config={})
+
+		# Simulate an API call
+		response = api.call_api(target_lang="python", code="some_code")
+
+		# Check if the API call was made with the expected arguments
+		mock_client.chat.completions.create.assert_called_once_with(
+			extra_headers={},
+			model="llama3-8b-8192",
+			messages=[
+				{"role": "system", "content": "only display the code without any explanation"},
+				{"role": "user", "content": "translate this to python language: some_code"},
+			],
+			stream=False,
+		)
+
+		assert api.api_url == "https://api.groq.com/openai/v1"
+		assert api.api_key == "fake_groq_api_key_from_env"
+
+		# Assert the response content
+		assert response.choices[0]["message"]["content"] == "Translated code"