meilisearch/MeiliSearch

Split the unit-tests from the source code

Open

#5116 opened on Dec 3, 2024

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Rust (20,887 stars) (733 forks)batch import
good first issuemaintenance

Description

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

Contributor guide

Tech stack
rust
Domain
testingdeveloper experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Rust knowledgeFamiliarity with Meilisearch codebaseUnderstanding of Rust module system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Identify the largest source files in the `src` directory that contain many `#[cfg(test)]` modules or inline tests at the end. For each such file (e.g., `index.rs`), create a new file `index tests.rs` in the same directory, move all test related code to it, and add `mod index tests;` in the corresponding `lib.rs` or `mod.rs`. Ensure that all tests still pass after the split. Start with one file per pull request as instructed. See the issue for an example.