Comment tester et déboguer les messages et services protobuf en C++ ?

Généré par l’IA et la communauté LinkedIn

Protobuf, abréviation de protocol buffers, est un format binaire pour la sérialisation et la désérialisation de données structurées. Il est largement utilisé pour la communication inter-processus, le stockage de données et les protocoles réseau. Dans cet article, vous apprendrez à tester et à déboguer des messages et des services protobuf en C++, à l’aide d’outils et de techniques courants.

Des experts chevronnés contribuent à cet article

Sélectionnés par la communauté pour 3 contributions. En savoir plus

1 Générer et compiler du code

La première étape consiste à générer du code C++ à partir de votre schéma protobuf, qui définit la structure et les types de vos messages et services. Vous pouvez utiliser le compilateur protoc pour ce faire, avec le --cpp_out et --grpc_options de sortie. Cela créera des fichiers .h et .cc que vous pourrez inclure et lier dans votre projet C++. Vous devez également installer les bibliothèques et les en-têtes protobuf et gRPC, et vous assurer qu’ils sont compatibles avec votre version protoc.

Ajoutez votre point de vue

2 Écrire et exécuter des tests unitaires

La deuxième étape consiste à écrire et à exécuter des tests unitaires pour vos messages et services protobuf. Vous pouvez utiliser n’importe quelle infrastructure de test prenant en charge C++, telle que Google Test, Catch2 ou Boost.Test. Vous devez tester les fonctionnalités de base de vos messages, telles que la sérialisation, la désérialisation, l’égalité et la validation. Vous devez également tester le comportement de vos services, tels que l’envoi et la réception de demandes et de réponses, la gestion des erreurs et la vérification des résultats.

Ajoutez votre point de vue

Dmitry Illichev 🇺🇦

Software Engineer and Architect
Signaler la contribution
The whole idea of testing the protobuf messages makes little sense. Serialization, deserialization, equality, and validation are provided by protobuf compiler/runtime, hence they supposedly should be covered by it's tests. Except in https://github.com/protocolbuffers/protobuf/tree/main/src/google/protobuf/testing they seemingly are not. But that's something one should have considered as one of the many concerns to consider when choosing the 3rd party tool. Testing the 3rd party libraries that you pull in, would be extremely counter-productive. Because there's nothing you can fix when your tests start failing.

Texte traduit

J’aime

3 Utiliser la journalisation et le suivi

La troisième étape consiste à utiliser la journalisation et le suivi pour surveiller et déboguer vos messages et services protobuf. Vous pouvez utiliser les fonctionnalités de journalisation intégrées de protobuf et gRPC, ou utiliser une bibliothèque tierce, telle que spdlog, glog ou opentelemetry. Vous devez configurer le niveau de journalisation, le format et la destination, et utiliser des messages cohérents et informatifs. Vous devez également utiliser le suivi pour suivre le flux et les performances de vos demandes et réponses, et identifier les goulots d’étranglement et les erreurs.

Ajoutez votre point de vue

4 Utiliser des outils de débogage

La quatrième étape consiste à utiliser des outils de débogage pour inspecter et manipuler vos messages et services protobuf. Vous pouvez utiliser un débogueur, tel que gdb ou lldb, pour définir des points d’arrêt, examiner des variables et parcourir le code pas à pas. Vous pouvez également utiliser un outil, tel que protoc-gen-inspect ou protoc-gen-debug, pour générer une sortie lisible par l’homme à partir de vos messages binaires. Vous pouvez également utiliser un outil, tel que grpcurl ou grpc_CLI, pour interagir avec vos services à partir de la ligne de commande.

Ajoutez votre point de vue

5 Utiliser des outils de test

La cinquième étape consiste à utiliser des outils de test pour simuler et vérifier vos messages et services protobuf. Vous pouvez utiliser un outil, tel que protoc-gen-mock ou grpc-mock, pour générer des objets fictifs qui imitent le comportement de vos services. Vous pouvez également utiliser un outil, tel que grpcui ou bloomrpc, pour créer et envoyer des requêtes et des réponses à partir d’une interface graphique. Vous pouvez également utiliser un outil, tel que grpc-dump ou wireshark, pour capturer et analyser le trafic réseau.

Ajoutez votre point de vue

6 Utiliser les meilleures pratiques

La sixième étape consiste à utiliser les meilleures pratiques pour améliorer la qualité et la maintenabilité de vos messages et services protobuf. Vous devez suivre le guide de style et les conventions de nommage pour protobuf et gRPC. Vous devez également documenter votre schéma, vos messages et vos services, à l’aide de commentaires et d’annotations. Vous devez également utiliser des stratégies de contrôle de version et de compatibilité, telles que la compatibilité ascendante et ascendante, pour gérer les modifications apportées à votre schéma.

Ajoutez votre point de vue

Jim Row

Highly accomplished Engineer, Innovator, overtime working Principal Software Engineer at OCEUS Networks
Signaler la contribution
Having a plan for when a Protobuf message or gRPC method needs to be expanded (ex: the next version) is very wise. A little planning ahead of time and defining what is concerned a "contract" and what is only considered only a "pipe" (to push anything) and the team following this rule, is key to maintaining support for older versions and helping slipstream in new releases with existing products in the field using the older/prior designs. - Just 2 cents.

Texte traduit

J’aime

7 Voici ce qu’il faut prendre en compte

Il s’agit d’un espace pour partager des exemples, des histoires ou des idées qui ne correspondent à aucune des sections précédentes. Que voudriez-vous ajouter d’autre?

Ajoutez votre point de vue

Paulo Zëmek

Software Engineer - I used talk to computers and they understood me even without AI, we just spoke the same language... now that they got smarter we are so in-sync that sometimes it feels we talk to each-other mentally!
Signaler la contribution
This article lacks some fundamental stuff. For example, what exactly are you going to test in protobuf messages? The messages don't have any behavior. They just hold information and, as they are generated by a tool, we should just assume the messages will just work. So, to test a protobuf message we should actually be checking if they are fulfilling their purpose. That is, do they contain the needed information to perform an action? But, then... this means we should be testing the action, not the protobuf message.

Texte traduit

J’aime

Programmation orientée objet

+ Suivre

Notez cet article

Nous avons créé cet article à l’aide de l’intelligence artificielle. Qu’en pensez-vous ?

Il est très bien Ça pourrait être mieux

Signaler cet article

Tout voir

Comment tester et déboguer les messages et services protobuf en C++ ?

1

2

3

4

5

6

7

1 Générer et compiler du code

2 Écrire et exécuter des tests unitaires

3 Utiliser la journalisation et le suivi

4 Utiliser des outils de débogage

5 Utiliser des outils de test

6 Utiliser les meilleures pratiques

7 Voici ce qu’il faut prendre en compte

Programmation orientée objet

Notez cet article

Nous vous remercions de votre feedback

Plus d’articles sur Programmation orientée objet

Lecture plus pertinente