Flask Test CLI Runner API

FlaskCliRunner は Click ベースの CliRunner で、Flask CLI コマンドをテストするために使用します。

経由でapp.test_cli_runner()インスタンスを作成します。


作成方法

方式 説明
app.test_cli_runner(**kwargs) CLI テストランナーを作成します。kwargs は CliRunner コンストラクターに渡されます。

コアメソッド

メソッド 説明
invoke(cli=None, args=None, **kwargs) CLI コマンドを呼び出します。デフォルトでは app.cli を使用します。click.testing.Result オブジェクトを返します。

Result オブジェクトの属性

属性 説明
exit_code コマンドの終了コード。0 は成功を意味します。
output コマンドの標準出力内容(str)
exception コマンドが例外をスローした場合、この中に例外オブジェクトが含まれます。

コード例

例

from app import create_app

app = create_app()
runner = app.test_cli_runner()

# 組み込みコマンドをテスト
result = runner.invoke(args=["routes"])
assert result.exit_code == 0
assert "/api/posts" in result.output

# カスタムコマンドをテスト
result = runner.invoke(args=["init-db"])
assert result.exit_code == 0

# 引数付きコマンドをテスト
result = runner.invoke(args=["greet", "--name", "サンプル"])
assert "サンプル" in result.output

# アプリの CLI グループを invoke で直接テスト
result = runner.invoke(app.cli, ["run", "--help"])
assert result.exit_code == 0
その他の拡張