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.

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

✅ Added Click test cases #35

Merged
merged 1 commit into from
Sep 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ elasticsearch==8.9.0
Faker==19.6.2
loguru==0.7.2
pytest==7.4.2
pytest-click==1.1.0
pytest-cov==4.1.0
pytest-emoji==0.2.0
pytest-loguru==0.2.0
Expand Down
60 changes: 60 additions & 0 deletions test/click/cli_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
"""Click CLI test cases."""
import inspect
from pathlib import Path
from test.esxport._export_test import TestExport
from unittest.mock import patch

from click.testing import CliRunner
from typing_extensions import Self

from src.esxport import EsXport
from src.esxport_cli import cli

args = {
"q": '{"query":{"match_all":{}}}',
"o": "output.csv",
"i": "index1",
}
usage_error_code = 2


# noinspection PyTypeChecker
class TestCli:
"""Cli Test cases."""

def test_query_is_mandatory(self: Self, cli_runner: CliRunner) -> None:
"""Test Query param is mandatory."""
query_missing = "Error: Missing option '-q' / '--query'."
result = cli_runner.invoke(cli, [], catch_exceptions=False)
assert query_missing in result.output
assert result.exit_code == usage_error_code

def test_output_file_is_mandatory(self: Self, cli_runner: CliRunner) -> None:
"""Test Query param is mandatory."""
query_missing = "Error: Missing option '-o' / '--output-file'."
result = cli_runner.invoke(cli, ["-q", args["q"]], catch_exceptions=False)
assert query_missing in result.output
assert result.exit_code == usage_error_code

def test_index_is_mandatory(self: Self, cli_runner: CliRunner) -> None:
"""Test Index param is mandatory."""
query_missing = "Error: Missing option '-i' / '--index-prefixes'."
result = cli_runner.invoke(cli, ["-q", args["q"], "-o", args["o"]], input="secret\n", catch_exceptions=False)
assert query_missing in result.output
assert result.exit_code == usage_error_code

def test_mandatory(self: Self, cli_runner: CliRunner, esxport_obj_with_data: EsXport) -> None:
"""Test Index param is mandatory."""
esxport_obj_with_data.opts.output_file = f"{inspect.stack()[0].function}.csv"
with patch("src.esxport.EsXport", return_value=esxport_obj_with_data):
result = cli_runner.invoke(
cli,
["-q", args["q"], "-o", args["o"], "-i", args["i"]],
input="password\n",
catch_exceptions=False,
)
assert result.exit_code == 0
with Path(esxport_obj_with_data.opts.output_file).open("r") as fp:
lines = len(fp.readlines())
assert lines == esxport_obj_with_data.es_client.search()["hits"]["total"]["value"] + 1 # 1 for header
TestExport.rm_csv_export_file(esxport_obj_with_data.opts.output_file)