meilisearch/MeiliSearch

Split the unit-tests from the source code

Open

#5116 aperta il 3 dic 2024

Vedi su GitHub
 (2 commenti) (2 reazioni) (0 assegnatari)Rust (733 fork)batch import
good first issuemaintenance

Metriche repository

Star
 (20.887 star)
Metriche merge PR
 (Merge medio 4g 3h) (37 PR mergiate in 30 g)

Descrizione

Currently, there is a lot of files containing a lot of codes, and then literally thousands of lines of tests at the end of the tests. That's becoming an issue because it slows down rust analyzer and makes development harder.

We should look at the biggest files in the repository. If they contain many tests at the end, create a new file with the same name postfixed by _tests and import it in the lib.rs/mod.rs. So for example if we have this structure:

src
├── index.rs
└── lib.rs

And the index.rs contains a lot of tests, then you should update the structure like that and move the tests to index_tests.rs:

src
├── index.rs
├── index_tests.rs
└── lib.rs

[!IMPORTANT] Please open PR per files to ease the reviewer work

Guida contributor

Direzione di ricerca
Identifica i file sorgente più grandi nella directory `src` che contengono molti moduli `#[cfg(test)]` o test inline alla fine. Per ogni file di questo tipo (ad esempio `index.rs`), crea un nuovo file `index tests.rs` nella stessa directory, sposta tutto il codice relativo ai test al suo interno e aggiungi `mod index tests;` nel corrispondente `lib.rs` o `mod.rs`. Assicurati che tutti i test passino ancora dopo la separazione. Inizia con un file per pull request come indicato. Vedi l'issue per un esempio.
Tech stack
rust
Dominio
testingdeveloper experience
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Basic Rust knowledgeFamiliarity with Meilisearch codebaseUnderstanding of Rust module system
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85