API du lanceur de tests CLI Flask
FlaskCliRunner est basé sur CliRunner de Click, utilisé pour tester les commandes CLI de Flask.
Viaapp.test_cli_runner()Créer une instance.
Méthode de création
| Méthode | Description |
|---|---|
| app.test_cli_runner(**kwargs) | Créer un exécuteur de test CLI. Les kwargs sont transmis au constructeur CliRunner |
Méthodes principales
| Méthodes | Description |
|---|---|
| invoke(cli=None, args=None, **kwargs) | Invoquez la commande CLI. Par défaut, utilisez app.cli. Retourne un objet click.testing.Result. |
Attributs de l'objet Result
| Propriété | Description |
|---|---|
| exit_code | Code de sortie de la commande. 0 indique le succès |
| output | Contenu de la sortie standard de la commande (str) |
| exception | Si la commande lève une exception, ceci contient l'objet exception. |
Exemples de code
Exemple
from app import create_app
app = create_app()
runner = app.test_cli_runner()
# Test des commandes intégrées
result = runner.invoke(args=["routes"])
assert result.exit_code == 0
assert "/api/posts" in result.output
# Test des commandes personnalisées
result = runner.invoke(args=["init-db"])
assert result.exit_code == 0
# Test des commandes avec arguments
result = runner.invoke(args=["greet", "--name", "EXAMPLE"])
assert "EXAMPLE" in result.output
# Utiliser directement invoke pour tester le groupe CLI de l'application
result = runner.invoke(app.cli, ["run", "--help"])
assert result.exit_code == 0
app = create_app()
runner = app.test_cli_runner()
# Test des commandes intégrées
result = runner.invoke(args=["routes"])
assert result.exit_code == 0
assert "/api/posts" in result.output
# Test des commandes personnalisées
result = runner.invoke(args=["init-db"])
assert result.exit_code == 0
# Test des commandes avec arguments
result = runner.invoke(args=["greet", "--name", "EXAMPLE"])
assert "EXAMPLE" in result.output
# Utiliser directement invoke pour tester le groupe CLI de l'application
result = runner.invoke(app.cli, ["run", "--help"])
assert result.exit_code == 0