Flask Test-CLI-Runner-API

FlaskCliRunner basiert auf Clicks CliRunner und wird zum Testen von Flask CLI-Befehlen verwendet.

Durchapp.test_cli_runner()Instanz erstellen.


Erstellungsmethode

Methode Beschreibung
app.test_cli_runner(**kwargs) Erstellt einen CLI-Test-Runner. kwargs werden an den CliRunner-Konstruktor übergeben.

Kernmethoden

Methoden Beschreibung
invoke(cli=None, args=None, **kwargs) Ruft den CLI-Befehl auf. Standardmäßig wird app.cli verwendet. Gibt ein click.testing.Result-Objekt zurück.

Attribute des Result-Objekts

Eigenschaft Beschreibung
exit_code Exit-Code des Befehls. 0 bedeutet Erfolg
output Inhalt der Standardausgabe des Befehls (str)
Ausnahme Wenn der Befehl eine Ausnahme auslöst, enthält dies das Ausnahmeobjekt.

Codebeispiele

Beispiel

from app import create_app

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

# Eingebaute Befehle testen
result = runner.invoke(args=["routes"])
assert result.exit_code == 0
assert "/api/posts" in result.output

# Benutzerdefinierte Befehle testen
result = runner.invoke(args=["init-db"])
assert result.exit_code == 0

# Befehle mit Argumenten testen
result = runner.invoke(args=["greet", "--name", "BEISPIEL"])
assert "EXAMPLE" in result.output

# Verwende invoke direkt, um die CLI-Gruppe der Anwendung zu testen
result = runner.invoke(app.cli, ["run", "--help"])
assert result.exit_code == 0
Weitere Erweiterungen