Crochets Vedro

Vedro offre une extensibilité puissante grâce à son système de plugins, vous permettant de créer des solutions robustes et réutilisables qui peuvent être partagées entre différents projets et équipes. Mais que se passe-t-il si vous expérimentez simplement votre base de code, prototypez un concept ou ajoutez une petite modification ? Écrire un plugin complet peut sembler excessif. C'est là qu'interviennent les crochets vedro.

vedro-hooks est une bibliothèque légère qui vous permet d'attacher des hooks personnalisés à divers événements Vedro. Que vous démarriez un serveur fictif avant l'exécution des tests, que vous lanciez un navigateur pour des tests de bout en bout ou que vous configuriez une journalisation personnalisée, les vedro-hooks vous permettent d'injecter des fonctionnalités avec un minimum de passe-partout.

Un exemple pratique

Supposons que vous souhaitiez identifier les tests lents dans votre suite : définissons « lent » comme tout test dont l'exécution prend plus d'une seconde. Traditionnellement, vous devez créer un plugin personnalisé pour cela. Voici à quoi cela pourrait ressembler :

from vedro.core import Dispatcher, Plugin, PluginConfig
from vedro.events import ScenarioFailedEvent, ScenarioPassedEvent

class SlowTestPlugin(Plugin):
    def subscribe(self, dispatcher: Dispatcher):
        dispatcher.listen(ScenarioPassedEvent, self.on_scenario_end)
        dispatcher.listen(ScenarioFailedEvent, self.on_scenario_end)

    def on_scenario_end(self, event: ScenarioPassedEvent | ScenarioFailedEvent):
        elapsed = event.scenario_result.elapsed
        if elapsed > 1.0:
            event.scenario_result.add_extra_details("⚠️ Slow test!")

class SlowTestPluginConfig(PluginConfig):
    plugin = SlowTestPlugin

Cette approche fonctionne, mais la création d'un plugin à part entière implique plus de configuration et un passe-partout supplémentaire. C'est idéal pour les solutions réutilisables, mais peut sembler encombrant pour une expérimentation rapide.

Simplifier avec des crochets

Avec vedro-hooks, vous pouvez obtenir la même fonctionnalité avec seulement quelques lignes de code :

from vedro_hooks import on_scenario_passed, on_scenario_failed

@on_scenario_passed
@on_scenario_failed
def highlight_slow_tests(event):
    elapsed = event.scenario_result.elapsed
    if elapsed > 1.0:
        event.scenario_result.add_extra_details("⚠️ Slow test!")

Ce code utilise des décorateurs pour enregistrer une fonction qui sera appelée lorsqu'un scénario réussit ou échoue. Il vérifie le temps écoulé et ajoute des détails supplémentaires si le scénario a duré plus d'une seconde.

Scenarios
*
 ✔ retrieve user info (0.52s)
 ✔ retrieve user repos (1.02s)
   |> ⚠️ Slow test!

# 2 scenarios, 2 passed, 0 failed, 0 skipped (1.54s)

Gérer les hooks : inconvénients et solutions

L'un des inconvénients de l'utilisation des hooks de cette manière est qu'ils peuvent être enregistrés depuis n'importe où dans votre projet, ce qui pourrait les rendre plus difficiles à retrouver plus tard. En revanche, les plugins de Vedro sont enregistrés dans le fichier vedro.cfg.py, fournissant un emplacement centralisé pour toutes vos configurations de plugins.

Pour aider à atténuer les inconvénients des hooks enregistrés dans votre base de code, vedro-hooks fournit l'argument de ligne de commande --hooks-show. Lorsqu'il est activé, une fois le processus de test terminé, un résumé de tous les hooks enregistrés ainsi que leurs emplacements sources sera affiché. Ceci est utile pour déboguer et vérifier quels hooks sont actifs.

Scenarios
*
 ✔ retrieve user repos

# [vedro-hooks] Hooks:
#  - 'highlight_slow_tests' (ScenarioFailedEvent) vedro.cfg.py:26
#  - 'highlight_slow_tests' (ScenarioPassedEvent) vedro.cfg.py:26
# 1 scenario, 1 passed, 0 failed, 0 skipped (0.55s)

Bien que --hooks-show soit utile, vous devez vous rappeler de l'utiliser pendant le débogage. Il est toujours recommandé d'enregistrer vos hooks dans un emplacement central comme vedro.cfg.py pour maintenir la clarté et la cohérence avec les configurations des plugins.

Conclusion

vedro-hooks est un outil fantastique pour améliorer vos tests Vedro sans avoir à créer un plugin personnalisé. Il brille lorsque vous avez besoin d’une solution rapide et ciblée pour étendre les fonctionnalités. En l'utilisant judicieusement et en gardant votre configuration organisée, vous pouvez profiter du meilleur des deux mondes : simplicité et maintenabilité.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!