gavindiaz/mt5cli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix mt5cli issues #92-#95 and #97 (#102)

Browse Source 
* feat: add MT5 order metadata, coverage report, and env-backed CLI config

* fix: align review-driven trading and history contracts

* Bump pdmt5 to 1.1.0

* test: stabilize history gaps CLI assertion

* fix: address review follow-ups for gaps and filling mode
This commit is contained in:
Daichi Narushima
2026-07-04 14:19:56 +09:00
committed by GitHub
parent c2cf0656dd
commit 74e3754a80
15 changed files with 1372 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/test_cli.py
+289 -10
View File
@@ -21,7 +21,9 @@ if TYPE_CHECKING:
from mt5cli.cli import (
_execute_export, # type: ignore[reportPrivateUsage]
_ExportContext, # type: ignore[reportPrivateUsage]
_infer_gap_table_granularity_seconds, # type: ignore[reportPrivateUsage]
_sdk_client, # type: ignore[reportPrivateUsage]
_timeframe_interval_seconds, # type: ignore[reportPrivateUsage]
app,
main,
)
@@ -631,8 +633,8 @@ class TestClosePositions:
"""Patch create_trading_client and return a mock trading client."""
client = _build_mock_trading_client()
client.positions_get_as_df.return_value = pd.DataFrame([
{"ticket": 1, "symbol": "JP225", "type": 0, "volume": 1.0},
{"ticket": 2, "symbol": "EURUSD", "type": 1, "volume": 0.5},
{"ticket": 1, "symbol": "JP225", "type": 0, "volume": 1.0, "magic": 7},
{"ticket": 2, "symbol": "EURUSD", "type": 1, "volume": 0.5, "magic": 9},
])
client.symbol_info_tick_as_dict.return_value = {"ask": 1.2, "bid": 1.1}
mocker.patch("mt5cli.cli.create_trading_client", return_value=client)
@@ -762,6 +764,40 @@ class TestClosePositions:
assert data[0]["dry_run"] is True
assert data[0]["order_side"] == "SELL"
def test_close_positions_dry_run_forwards_request_fields(
self,
tmp_path: Path,
trading_client: MagicMock,
) -> None:
"""Dry-run close export preserves deviation/comment/magic passthrough."""
output = tmp_path / "close.json"
result = runner.invoke(
app,
[
"-o",
str(output),
"close-positions",
"--symbol",
"JP225",
"--deviation",
"7",
"--comment",
"close-me",
"--magic",
"7",
"--dry-run",
],
)
assert result.exit_code == 0, result.output
trading_client.order_send.assert_not_called()
data = json.loads(output.read_text())
assert len(data) == 1
assert data[0]["symbol"] == "JP225"
request = json.loads(data[0]["request"])
assert request["deviation"] == 7
assert request["comment"] == "close-me"
assert request["magic"] == 7
def test_order_send_unchanged(
self,
tmp_path: Path,
@@ -847,11 +883,10 @@ class TestCallback:
"""Test that connection arguments reach Mt5Config."""
mock_client = MagicMock()
mock_client.account_info_as_df.return_value = pd.DataFrame({"a": [1]})
mocker.patch(
mt5_client = mocker.patch(
"mt5cli.sdk.Mt5DataClient",
return_value=mock_client,
)
mock_config = mocker.patch("mt5cli.cli.Mt5Config")
output = tmp_path / "out.csv"
result = runner.invoke(
app,
@@ -868,13 +903,132 @@ class TestCallback:
],
)
assert result.exit_code == 0, result.output
mock_config.assert_called_once_with(
path=None,
login=123,
password="pw",
server="srv",
timeout=None,
config = mt5_client.call_args.kwargs["config"]
assert config.path is None
assert config.login == 123
assert config.password is not None
assert config.password.get_secret_value() == "pw"
assert config.server == "srv"
assert config.timeout is None
@pytest.mark.parametrize(
("env", "extra_args", "expected"),
[
pytest.param(
{
"MT5_LOGIN": "456",
"MT5_PASSWORD": "env-pass",
"MT5_SERVER": "Env-Server",
},
[],
{"login": 456, "password": "env-pass", "server": "Env-Server"},
id="env-defaults",
),
pytest.param(
{
"MT5_LOGIN": "456",
"MT5_PASSWORD": "env-pass",
"MT5_SERVER": "Env-Server",
},
["--login", "123", "--password", "cli-pass", "--server", "Cli-Server"],
{"login": 123, "password": "cli-pass", "server": "Cli-Server"},
id="cli-overrides-env",
),
],
)
def test_connection_args_resolve_env_and_precedence(
self,
tmp_path: Path,
mocker: MockerFixture,
monkeypatch: pytest.MonkeyPatch,
env: dict[str, str],
extra_args: list[str],
expected: dict[str, object],
) -> None:
"""CLI args fall back to env vars and preserve explicit precedence."""
for name, value in env.items():
monkeypatch.setenv(name, value)
mock_client = MagicMock()
mock_client.account_info_as_df.return_value = pd.DataFrame({"a": [1]})
mt5_client = mocker.patch(
"mt5cli.sdk.Mt5DataClient",
return_value=mock_client,
)
output = tmp_path / "out.csv"
result = runner.invoke(app, [*extra_args, "-o", str(output), "account-info"])
assert result.exit_code == 0, result.output
config = mt5_client.call_args.kwargs["config"]
assert config.login == expected["login"]
assert config.password is not None
assert config.password.get_secret_value() == expected["password"]
assert config.server == expected["server"]
def test_help_documents_mt5_env_vars(self) -> None:
"""Top-level help output should expose the supported MT5 env vars."""
result = runner.invoke(app, ["--help"])
assert result.exit_code == 0, result.output
normalized = normalize_cli_output(result.output)
for env_name in ("MT5_LOGIN", "MT5_PASSWORD", "MT5_SERVER", "MT5_PATH"):
assert env_name in normalized
def test_gap_granularity_helpers_cover_unknown_cases(self) -> None:
"""Gap-table granularity helpers should fail cleanly for unknown inputs."""
assert _timeframe_interval_seconds(49153) is None
assert _infer_gap_table_granularity_seconds("custom_rates") is None
@pytest.mark.parametrize(
("args", "env", "exit_code", "match"),
[
pytest.param(
["--login", "${CLI_MT5_LOGIN}", "--server", "${CLI_MT5_SERVER}"],
{"CLI_MT5_LOGIN": "789", "CLI_MT5_SERVER": "Placeholder-Server"},
0,
None,
id="placeholder-expansion",
),
pytest.param(
["--password", "${CLI_MT5_MISSING}"],
{},
2,
"Environment variable 'CLI_MT5_MISSING' is not set.",
id="missing-placeholder",
),
],
)
def test_cli_placeholder_resolution(
self,
tmp_path: Path,
mocker: MockerFixture,
monkeypatch: pytest.MonkeyPatch,
args: list[str],
env: dict[str, str],
exit_code: int,
match: str | None,
) -> None:
"""CLI config fields support SDK-style ${ENV_VAR} placeholders."""
for name, value in env.items():
monkeypatch.setenv(name, value)
mock_client = MagicMock()
mock_client.account_info_as_df.return_value = pd.DataFrame({"a": [1]})
mt5_client = mocker.patch(
"mt5cli.sdk.Mt5DataClient",
return_value=mock_client,
)
output = tmp_path / "out.csv"
result = runner.invoke(app, [*args, "-o", str(output), "account-info"])
assert result.exit_code == exit_code, result.output
if exit_code == 0:
config = mt5_client.call_args.kwargs["config"]
assert config.login == 789
assert config.server == "Placeholder-Server"
else:
assert match is not None
assert match in normalize_cli_output(result.output)
def test_explicit_format(
self,
@@ -1526,6 +1680,131 @@ class TestCollectHistory:
)
class TestHistoryGapsCommand:
"""Tests for the history-gaps CLI command."""
@pytest.mark.parametrize(
("extra_args", "expected_tables", "expected_rows"),
[
pytest.param([], {"rate_EURUSD__M1_1", "rate_GBPUSD__M1_1"}, 2, id="all"),
pytest.param(
["--table", "rate_EURUSD__M1_1"],
{"rate_EURUSD__M1_1"},
1,
id="explicit-table",
),
],
)
def test_history_gaps_exports_sqlite_report_without_mt5(
self,
tmp_path: Path,
mock_client: MagicMock,
extra_args: list[str],
expected_tables: set[str],
expected_rows: int,
) -> None:
"""history-gaps reads SQLite only and exports one row per gap."""
database = tmp_path / "history.db"
output = tmp_path / "gaps.json"
with sqlite3.connect(database) as conn:
conn.execute(
"CREATE TABLE rates("
"symbol TEXT, timeframe INTEGER, time TEXT, close REAL"
")",
)
conn.executemany(
"INSERT INTO rates(symbol, timeframe, time, close) VALUES (?, ?, ?, ?)",
[
("EURUSD", 1, "2024-01-01T00:00:00+00:00", 1.0),
("EURUSD", 1, "2024-01-01T00:02:00+00:00", 1.1),
("GBPUSD", 1, "2024-01-01T00:00:00+00:00", 1.2),
("GBPUSD", 1, "2024-01-01T00:02:00+00:00", 1.3),
],
)
conn.execute(
'CREATE VIEW "rate_EURUSD__M1_1" AS '
"SELECT time, close FROM rates "
"WHERE symbol = 'EURUSD' AND timeframe = 1",
)
conn.execute(
'CREATE VIEW "rate_GBPUSD__M1_1" AS '
"SELECT time, close FROM rates "
"WHERE symbol = 'GBPUSD' AND timeframe = 1",
)
result = runner.invoke(
app,
[
"-o",
str(output),
"history-gaps",
"--sqlite3",
str(database),
*extra_args,
],
)
assert result.exit_code == 0, result.output
data = json.loads(output.read_text())
assert len(data) == expected_rows
assert {row["table"] for row in data} == expected_tables
mock_client.initialize_and_login_mt5.assert_not_called()
def test_history_gaps_requires_compatible_default_views(
self,
tmp_path: Path,
) -> None:
"""Without --table, history-gaps should reject DBs with no managed views."""
database = tmp_path / "empty.db"
output = tmp_path / "gaps.json"
with sqlite3.connect(database):
pass
result = runner.invoke(
app,
["-o", str(output), "history-gaps", "--sqlite3", str(database)],
)
assert result.exit_code != 0
assert "No managed rate compatibility views found" in result.output
def test_history_gaps_requires_granularity_for_custom_tables(
self,
tmp_path: Path,
) -> None:
"""Custom tables need an explicit granularity when no view naming exists."""
database = tmp_path / "custom.db"
output = tmp_path / "gaps.json"
with sqlite3.connect(database) as conn:
conn.execute("CREATE TABLE custom_rates(time TEXT, close REAL)")
conn.executemany(
"INSERT INTO custom_rates(time, close) VALUES (?, ?)",
[
("2024-01-01T00:00:00+00:00", 1.0),
("2024-01-01T00:02:00+00:00", 1.1),
],
)
result = runner.invoke(
app,
[
"-o",
str(output),
"history-gaps",
"--sqlite3",
str(database),
"--table",
"custom_rates",
],
)
assert result.exit_code != 0
output = normalize_cli_output(result.output)
assert "Could not infer granularity" in output
assert "'custom_rates'" in output
assert re.search(r"--granularity-\s*seconds", output) is not None
class TestGrafanaSchemaCommand:
"""Tests for the grafana-schema CLI command."""