smart-doc est un outil pour générer automatiquement API Java Documentation. Il crée de la documentation en analysant les interfaces et les commentaires dans le code source et prend en charge une variété de formats de sortie de documents, notamment Markdown , HTML5 , OpenAPI 3.0 , etc. L'objectif de conception de smart-doc est de simplifier le processus de rédaction de documents, d'améliorer l'efficacité du développement et de garantir l'exactitude et l'actualité de la documentation.

Dans le cycle de vie du développement logiciel, la génération automatique de la documentation API et les tests de performances des interfaces sont des étapes clés pour améliorer l'efficacité du développement et garantir la qualité des produits. Avec l'ajout de la possibilité de générer JMeter Test de performance scripts dans smart-doc version 3.0.1 , les développeurs peuvent accomplir plus facilement ces deux tâches.

Cet article explique comment utiliser smart-doc et JMeter pour des tests de performances efficaces.

Générer des scripts JMeter

Utiliser smart-doc pour générer JMètre Les scripts de tests de performances peuvent réduire considérablement le temps nécessaire à l'écriture des scripts de tests de performances, améliorant ainsi l'efficacité des tests. Les scripts JMeter générés automatiquement par smart-doc peuvent être exécutés directement dans JMeter sans nécessiter de configuration ni de débogage complexes, ce qui rend les tests de performances beaucoup plus simples et plus rapides.

Tout d’abord, assurez-vous que le smart-doc-maven-plugin a été ajouté à votre projet. Ensuite, configurez les paramètres pertinents du plugin smart-doc dans le fichier pom.xml du projet, par exemple :

 <plugin> <groupId>com.ly.smart-doc</groupId> <artifactId>smart-doc-maven-plugin</artifactId> <version>[latest version]</version> <configuration> <configFile>./src/main/resources/smart-doc.json</configFile> <projectName>${project.description}</projectName> </configuration> </plugin>

Exécutez la commande mvn -Dfile.encoding=UTF-8 smart-doc:jmeter . Smart-doc analysera le code source du projet, extraira les informations d'annotation et générera automatiquement les scripts de test de performances JMeter correspondants.

Ceux qui ne savent pas comment l'utiliser peuvent se référer au responsable documentation smart-doc .

Importer dans JMeter

Ouvrez JMeter, cliquez sur " Fichier " -> " Ouvrir ", sélectionnez le fichier de script JMeter généré lors de la première étape et cliquez sur le bouton " Démarrer ". JMeter commencera alors à effectuer des tests de performances selon le script.

Configurer Prometheus

Prométhée est un outil open source de surveillance et d'alerte pour gérer les données de séries chronologiques. Nous pouvons l'utiliser pour effectuer une surveillance en temps réel pendant le processus de test de résistance JMeter, améliorant ainsi l'observabilité des tests de performance.

Étape 1 : Installez le plugin JMeter Prometheus

Tout d’abord, vous devez installer le plugin Prometheus dans le répertoire lib/ext de JMeter. Vous pouvez télécharger le plugin depuis le gestionnaire de plugins JMeter ou le site officiel . Il peut également être téléchargé à partir de GitHub . Pour cette instance, téléchargez la dernière version 0.7.1 depuis GitHub.

• Remarque : l'adresse IP d'écoute par défaut de JMeter est 127.0.0.1 , ce qui, par défaut, empêchera Prometheus de se connecter au port d'écoute de JMeter Prometheus. Par conséquent, il est nécessaire d'ajouter prometheus.ip=0.0.0.0 dans jmeter.properties .

Étape 2 : ajouter un écouteur Prometheus

Ouvrez JMeter et ajoutez le Prometheus Listener à votre plan de test. Cela peut être fait en cliquant avec le bouton droit sur Test Plan -> Add -> Listener -> Prometheus Listener .

La configuration de l'écouteur peut faire référence aux paramètres officiels, avec référence comme suit ( smart-doc 3.0.4 prend en charge la configuration et l'ajout de la génération Prometheus Listener) :

Étape 3 : Configurer Prometheus Scrape

Dans le fichier de configuration de Prometheus ( prometheus.yml ), ajoutez un nouveau scrape_config pour récupérer les données du plugin JMeter Prometheus. Par exemple:

 scrape_configs: - job_name: 'jmeter' scrape_interval: 15s static_configs: - targets: ['<Your JMeter machine IP>:9270']

Ici, <Your JMeter machine IP> est l'adresse IP de la machine exécutant le test JMeter, et 9270 est le port d'écoute par défaut pour le plugin JMeter Prometheus.

Étape 4 : Exécuter le plan de test

Dans le but de faciliter la vérification dans cet article, le groupe de threads est défini sur « boucle infinie » lors des tests de contrainte, qui peut être ajusté en fonction des besoins réels.

Après un démarrage réussi, JMeter Prometheus créera, par défaut, un service sur le port local 9270 .

Accéder à l'URL http://localhost:9270/metrics , et si vous voyez le contenu suivant, cela signifie que l'opération a réussi.

Étape 5 : Démarrez Prometheus

Après avoir démarré Prometheus , il commencera à récupérer les données du plugin JMeter Prometheus. Comme le montre la configuration suivante, une fois démarré avec succès, vous pouvez voir les cibles définies dans Prometheus .

Étape 6 : Configurer Grafana

Sur le site officiel Grafana , retrouvez le panneau de surveillance prometheus-jmeter fourni par le site officiel. Ici, nous sélectionnons le modèle avec l'ID 14927 à importer dans Grafana.

Après avoir cliqué sur Charger , sélectionnez la source de données Prometheus .

• Remarque : Lors des tests, il a été constaté que le modèle d'origine 14927 comportait des erreurs. Ceux-ci ont été corrigés lors du processus de rédaction de cet article. Importez le modèle corrigé téléchargé depuis GitHub .

Une fois le modèle importé avec succès, nous pourrons voir l'intégralité des données de surveillance des tests de performances dans Grafana .

Pour faciliter une expérience rapide de l'ensemble du processus de test de performances, la communauté smart-doc a organisé et fourni un modèle qui peut être lancé avec une seule commande à l'aide docker-compose . Pour ceux qui souhaitent en faire l'expérience via le déploiement Kubernetes , des outils d'IA peuvent être utilisés pour convertir directement le modèle docker-compose en un modèle de déploiement Kubernetes .

Le projet de l'expérience comprend également des instructions d'utilisation.

L'exemple de code pour cet article peut être trouvé ici .

L'assistance de Smart-Doc dans les tests de performances JMeter

La combinaison de smart-doc et de JMeter pour les tests de résistance aux performances offre plusieurs avantages :

• Automatisation : smart-doc peut extraire automatiquement les informations API du code source et générer des scripts de test de performances JMeter sans avoir besoin d'une écriture manuelle, améliorant ainsi considérablement l'efficacité.

• Précision : les scripts de test de performances JMeter générés par smart-doc sont totalement cohérents avec les définitions de l'API dans le code source, évitant ainsi les erreurs pouvant survenir lors de l'écriture manuelle des scripts.

• Flexibilité : smart-doc prend en charge une variété d'options de configuration, permettant aux scripts JMeter générés d'être personnalisés en fonction des exigences de test.

smart-doc continuera également à améliorer et à optimiser la prise en charge de JMeter. S'il vous plaît restez à l'écoute pour le développement en cours du projet open source smart-doc .

Conclusion

En combinant smart-doc et JMeter, nous pouvons non seulement automatiser la génération de documentation API, mais également créer rapidement des scripts de tests de performances et effectuer des tests de résistance. Cet outil d'automatisation améliore considérablement l'efficacité du développement et des tests tout en aidant les équipes à maintenir et à optimiser plus facilement les performances des systèmes logiciels.

Nous espérons que cet article vous a fourni des références pratiques pour appliquer ces outils plus efficacement dans votre travail quotidien.

Nous invitons également tout le monde à continuer à suivre et à soutenir la communauté open source smart-doc. À l’avenir, nous étudions la prise en charge de langages supplémentaires pour aider davantage de développeurs.