envoyproxy/envoy

add memory filesystem for making tests faster, more hermetic, and more robust

Open

#11 121 ouverte le 8 mai 2020

Voir sur GitHub
 (9 commentaires) (1 réaction) (1 assigné)C++ (5 373 forks)batch import
beginnerhelp wanted

Métriques du dépôt

Stars
 (27 997 stars)
Métriques de merge PR
 (Merge moyen 8j) (378 PRs mergées en 30 j)

Description

Currently real files are used for file i/o during tests. An alternative I've used in the past is to have an in-memory representation of a file-system: https://github.com/apache/incubator-pagespeed-mod/blob/master/pagespeed/kernel/base/mem_file_system.h

This has these advantages:

  • completely hermetic, with a clean slate between tests
  • very fast (no I/O), speeding up the running of massive numbers of tests
  • you can inject notifiers etc, so you can for example get a callback or condvar wakeup or similar when a file is written

Envoy already has a filesystem abstraction (yay!) and a way to squirrel that into code that needs to read/write files (Api::Api) just no in-memory impl for it.

I think this would be a good intern project. The example I gave above would not exactly meet Envoy's needs but it could be a reference point.

Guide contributeur

Direction de recherche
Examinez l'abstraction de système de fichiers existante dans Envoy (probablement sous source/common/filesystem/), en vous concentrant sur l'interface Api::Api qui fournit l'implémentation actuelle du système de fichiers. Consultez le fichier Apache mem file system.h référencé pour les modèles de conception. Concevez une implémentation minimale en mémoire qui prend en charge les opérations d'E/S de fichiers (lecture, écriture, stat, etc.) et s'intègre au framework de test d'Envoy. Vérifiez les commentaires de l'issue pour toute contrainte supplémentaire ou indication des mainteneurs.
Stack technique
cpp
Domaine
backend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C++Envoy filesystem abstraction
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60