envoyproxy/envoy

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

Open

#11.121 geöffnet am 8. Mai 2020

Auf GitHub ansehen
 (9 Kommentare) (1 Reaktion) (1 zugewiesene Person)C++ (5.373 Forks)batch import
beginnerhelp wanted

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuchen Sie die bestehende Dateisystemabstraktion in Envoy (wahrscheinlich unter source/common/filesystem/), mit Fokus auf die Api::Api Schnittstelle, die die aktuelle Dateisystemimplementierung bereitstellt. Überprüfen Sie die referenzierte Apache mem file system.h auf Entwurfsmuster. Entwerfen Sie eine minimale In Memory Implementierung, die Datei I/O Operationen (Lesen, Schreiben, Stat usw.) unterstützt und in das Testframework von Envoy integriert wird. Prüfen Sie die Issue Kommentare auf zusätzliche Einschränkungen oder Hinweise der Maintainer.
Tech Stack
cpp
Domain
backend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C++Envoy filesystem abstraction
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60