Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

More Unittest for CLI #192

Merged
merged 3 commits into from
Aug 30, 2024
Merged

More Unittest for CLI #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f987083
more tests
mhmohona Aug 28, 2024
2d68f21
Merge branch 'unittest' of https://github.com/mhmohona/Scribe-Data in…
mhmohona Aug 28, 2024
7c8c5ea
Format CLI testing code
andrewtavis Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 36 additions & 35 deletions src/scribe_data/cli/cli_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,44 +81,45 @@ def print_formatted_data(data: Union[dict, list], data_type: str) -> None:
print(f"No data available for data type '{data_type}'.")
return

max_key_length = max((len(key) for key in data.keys()), default=0)

if data_type == "autosuggestions":
for key, value in data.items():
print(f"{key:<{max_key_length}} : {', '.join(value)}")

elif data_type == "emoji_keywords":
for key, value in data.items():
emojis = [item["emoji"] for item in value]
print(f"{key:<{max_key_length}} : {' '.join(emojis)}")

elif data_type in {"prepositions", "translations"}:
for key, value in data.items():
print(f"{key:<{max_key_length}} : {value}")

elif isinstance(data, dict):
for key, value in data.items():
if isinstance(value, dict):
print(f"{key:<{max_key_length}} : ")
max_sub_key_length = max(
(len(sub_key) for sub_key in value.keys()), default=0
)
for sub_key, sub_value in value.items():
print(f" {sub_key:<{max_sub_key_length}} : {sub_value}")

elif isinstance(value, list):
print(f"{key:<{max_key_length}} : ")
for item in value:
if isinstance(item, dict):
for sub_key, sub_value in item.items():
print(f" {sub_key:<{max_key_length}} : {sub_value}")

else:
print(f" {item}")
if isinstance(data, dict):
max_key_length = max((len(key) for key in data.keys()), default=0)

else:
if data_type == "autosuggestions":
for key, value in data.items():
print(f"{key:<{max_key_length}} : {', '.join(value)}")

elif data_type == "emoji_keywords":
for key, value in data.items():
emojis = [item["emoji"] for item in value]
print(f"{key:<{max_key_length}} : {' '.join(emojis)}")

elif data_type in {"prepositions", "translations"}:
for key, value in data.items():
print(f"{key:<{max_key_length}} : {value}")

else:
for key, value in data.items():
if isinstance(value, dict):
print(f"{key:<{max_key_length}} : ")
max_sub_key_length = max(
(len(sub_key) for sub_key in value.keys()), default=0
)
for sub_key, sub_value in value.items():
print(f" {sub_key:<{max_sub_key_length}} : {sub_value}")

elif isinstance(value, list):
print(f"{key:<{max_key_length}} : ")
for item in value:
if isinstance(item, dict):
for sub_key, sub_value in item.items():
print(f" {sub_key:<{max_key_length}} : {sub_value}")

else:
print(f" {item}")

else:
print(f"{key:<{max_key_length}} : {value}")

elif isinstance(data, list):
for item in data:
if isinstance(item, dict):
Expand Down
46 changes: 24 additions & 22 deletions tests/cli/test_convert.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,52 +21,54 @@
"""

import unittest
from unittest.mock import patch
from pathlib import Path
from scribe_data.cli.convert import export_json, convert_to_sqlite
from unittest.mock import patch

from scribe_data.cli.convert import convert_to_sqlite, export_json

class TestConvert(unittest.TestCase):

@patch('scribe_data.cli.convert.Path')
@patch('scribe_data.cli.convert.data_to_sqlite')
@patch('shutil.copy')
class TestConvert(unittest.TestCase):
@patch("scribe_data.cli.convert.Path")
@patch("scribe_data.cli.convert.data_to_sqlite")
@patch("shutil.copy")
def test_convert_to_sqlite(self, mock_shutil_copy, mock_data_to_sqlite, mock_path):
mock_path.return_value.exists.return_value = True

convert_to_sqlite('english', 'nouns', '/output', True)
convert_to_sqlite("english", "nouns", "/output", True)

mock_data_to_sqlite.assert_called_with(['english'], ['nouns'])
mock_data_to_sqlite.assert_called_with(["english"], ["nouns"])
mock_shutil_copy.assert_called()

@patch('scribe_data.cli.convert.Path')
@patch('scribe_data.cli.convert.data_to_sqlite')
@patch("scribe_data.cli.convert.Path")
@patch("scribe_data.cli.convert.data_to_sqlite")
def test_convert_to_sqlite_no_output_dir(self, mock_data_to_sqlite, mock_path):
convert_to_sqlite('english', 'nouns', None, True)
convert_to_sqlite("english", "nouns", None, True)

mock_data_to_sqlite.assert_called_with(['english'], ['nouns'])
mock_data_to_sqlite.assert_called_with(["english"], ["nouns"])
mock_path.assert_not_called()

@patch('scribe_data.cli.convert.Path')
@patch('scribe_data.cli.convert.data_to_sqlite')
@patch('scribe_data.cli.convert.get_language_iso')
@patch('shutil.copy')
def test_convert_to_sqlite_with_language_iso(self, mock_copy, mock_get_language_iso, mock_data_to_sqlite, mock_path):
@patch("scribe_data.cli.convert.Path")
@patch("scribe_data.cli.convert.data_to_sqlite")
@patch("scribe_data.cli.convert.get_language_iso")
@patch("shutil.copy")
def test_convert_to_sqlite_with_language_iso(
self, mock_copy, mock_get_language_iso, mock_data_to_sqlite, mock_path
):
mock_get_language_iso.return_value = "en"
mock_path.return_value.exists.return_value = True

convert_to_sqlite("English", "data_type", "/output", True)

mock_data_to_sqlite.assert_called_with(["English"], ["data_type"])
mock_copy.assert_called()

@patch('scribe_data.cli.convert.language_map')
@patch("scribe_data.cli.convert.language_map")
def test_export_json_invalid_language(self, mock_language_map):
mock_language_map.get.return_value = None

with self.assertRaises(ValueError):
export_json("invalid", "data_type", Path("/output"), True)


def test_convert_to_sqlite_no_language(self):
with self.assertRaises(ValueError):
convert_to_sqlite(None, "data_type", "/output", True)
36 changes: 25 additions & 11 deletions tests/cli/test_get.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,38 @@
"""

import unittest
from unittest.mock import patch, call
from unittest.mock import call, patch

from scribe_data.cli.get import get_data


class TestCLIGetCommand(unittest.TestCase):
@patch('scribe_data.cli.get.query_data')
@patch('scribe_data.cli.get.export_json')
@patch('scribe_data.cli.get.convert_to_csv_or_tsv')
@patch('os.system')
def test_get_command(self, mock_system, mock_convert, mock_export_json, mock_query_data):
@patch("scribe_data.cli.get.query_data")
@patch("scribe_data.cli.get.export_json")
@patch("scribe_data.cli.get.convert_to_csv_or_tsv")
@patch("os.system")
def test_get_command(
self, mock_system, mock_convert, mock_export_json, mock_query_data
):
expected_calls = [
call(['English'], ['nouns']),
call(['English'], ['nouns']),
call()
call(["English"], ["nouns"]),
call(["English"], ["nouns"]),
call(),
]

# Execute the test
get_data(language='English', data_type='nouns', output_dir='outputs', output_type='json')
get_data(language='English', data_type='nouns', output_dir='outputs', output_type='csv')
get_data(
language="English",
data_type="nouns",
output_dir="outputs",
output_type="json",
)
get_data(
language="English",
data_type="nouns",
output_dir="outputs",
output_type="csv",
)
get_data(all=True)

# Validate the calls
Expand Down
110 changes: 58 additions & 52 deletions tests/cli/test_list.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,33 +21,35 @@
"""

import unittest
from unittest.mock import patch, call
from unittest.mock import call, patch

from scribe_data.cli.list import (
list_languages,
list_data_types,
list_all,
list_data_types,
list_languages,
list_languages_for_data_type,
list_wrapper,
)
from scribe_data.cli.main import main


class TestListFunctions(unittest.TestCase):
@patch("builtins.print")
def test_list_languages(self, mock_print):
list_languages()
expected_calls = [
call(),
call('Language ISO QID '),
call('-----------------------'),
call('English en Q1860 '),
call('French fr Q150 '),
call('German de Q188 '),
call('Italian it Q652 '),
call('Portuguese pt Q5146 '),
call('Russian ru Q7737 '),
call('Spanish es Q1321 '),
call('Swedish sv Q9027 '),
call('-----------------------'),
call("Language ISO QID "),
call("-----------------------"),
call("English en Q1860 "),
call("French fr Q150 "),
call("German de Q188 "),
call("Italian it Q652 "),
call("Portuguese pt Q5146 "),
call("Russian ru Q7737 "),
call("Spanish es Q1321 "),
call("Swedish sv Q9027 "),
call("-----------------------"),
call(),
]
mock_print.assert_has_calls(expected_calls)
Expand All @@ -57,14 +59,14 @@ def test_list_data_types_all_languages(self, mock_print):
list_data_types()
expected_calls = [
call(),
call('Available data types: All languages'),
call('-----------------------------------'),
call('emoji-keywords'),
call('nouns'),
call('prepositions'),
call('translations'),
call('verbs'),
call('-----------------------------------'),
call("Available data types: All languages"),
call("-----------------------------------"),
call("emoji-keywords"),
call("nouns"),
call("prepositions"),
call("translations"),
call("verbs"),
call("-----------------------------------"),
call(),
]
mock_print.assert_has_calls(expected_calls)
Expand All @@ -74,13 +76,13 @@ def test_list_data_types_specific_language(self, mock_print):
list_data_types("English")
expected_calls = [
call(),
call('Available data types: English'),
call('-----------------------------'),
call('emoji-keywords'),
call('nouns'),
call('translations'),
call('verbs'),
call('-----------------------------'),
call("Available data types: English"),
call("-----------------------------"),
call("emoji-keywords"),
call("nouns"),
call("translations"),
call("verbs"),
call("-----------------------------"),
call(),
]
mock_print.assert_has_calls(expected_calls)
Expand All @@ -91,7 +93,7 @@ def test_list_data_types_invalid_language(self):

def test_list_data_types_no_data_types(self):
with self.assertRaises(ValueError):
list_data_types("Klingon")
list_data_types("Klingon")

@patch("scribe_data.cli.list.list_languages")
@patch("scribe_data.cli.list.list_data_types")
Expand All @@ -118,10 +120,14 @@ def test_list_wrapper_data_types(self, mock_list_data_types):
@patch("builtins.print")
def test_list_wrapper_language_and_data_type(self, mock_print):
list_wrapper(language=True, data_type=True)
mock_print.assert_called_with("Please specify either a language or a data type.")
mock_print.assert_called_with(
"Please specify either a language or a data type."
)

@patch("scribe_data.cli.list.list_languages_for_data_type")
def test_list_wrapper_languages_for_data_type(self, mock_list_languages_for_data_type):
def test_list_wrapper_languages_for_data_type(
self, mock_list_languages_for_data_type
):
list_wrapper(language=True, data_type="example_data_type")
mock_list_languages_for_data_type.assert_called_with("example_data_type")

Expand All @@ -135,38 +141,38 @@ def test_list_languages_for_data_type_valid(self, mock_print):
list_languages_for_data_type("nouns")
expected_calls = [
call(),
call('Available languages: nouns'),
call('--------------------------'),
call('English'),
call('French'),
call('German'),
call('Italian'),
call('Portuguese'),
call('Russian'),
call('Spanish'),
call('Swedish'),
call('--------------------------'),
call("Available languages: nouns"),
call("--------------------------"),
call("English"),
call("French"),
call("German"),
call("Italian"),
call("Portuguese"),
call("Russian"),
call("Spanish"),
call("Swedish"),
call("--------------------------"),
call(),
]
mock_print.assert_has_calls(expected_calls)

@patch('scribe_data.cli.list.list_languages')
@patch("scribe_data.cli.list.list_languages")
def test_list_languages_command(self, mock_list_languages):
test_args = ['main.py', 'list', '--language']
with patch('sys.argv', test_args):
test_args = ["main.py", "list", "--language"]
with patch("sys.argv", test_args):
main()
mock_list_languages.assert_called_once()

@patch('scribe_data.cli.list.list_data_types')
@patch("scribe_data.cli.list.list_data_types")
def test_list_data_types_command(self, mock_list_data_types):
test_args = ['main.py', 'list', '--data-type']
with patch('sys.argv', test_args):
test_args = ["main.py", "list", "--data-type"]
with patch("sys.argv", test_args):
main()
mock_list_data_types.assert_called_once()

@patch('scribe_data.cli.list.list_all')
@patch("scribe_data.cli.list.list_all")
def test_list_all_command(self, mock_list_all):
test_args = ['main.py', 'list', '--all']
with patch('sys.argv', test_args):
test_args = ["main.py", "list", "--all"]
with patch("sys.argv", test_args):
main()
mock_list_all.assert_called_once()
Loading
Loading