envoyproxy/envoy

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

Open

#11.121 aberto em 8 de mai. de 2020

Ver no GitHub
 (9 comments) (1 reaction) (1 assignee)C++ (5.373 forks)batch import
beginnerhelp wanted

Métricas do repositório

Stars
 (27.997 stars)
Métricas de merge de PR
 (Mesclagem média 8d) (378 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Examine a abstração de sistema de arquivos existente no Envoy (provavelmente em source/common/filesystem/), focando na interface Api::Api que fornece a implementação atual do sistema de arquivos. Revise o Apache mem file system.h mencionado para padrões de design. Projete uma implementação mínima em memória que suporte operações de I/O de arquivo (leitura, escrita, stat, etc.) e se integre ao framework de testes do Envoy. Verifique os comentários da issue para quaisquer restrições adicionais ou dicas dos mantenedores.
Pilha de tecnologia
cpp
Domain
backend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
C++Envoy filesystem abstraction
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60