meilisearch/MeiliSearch

Split the unit-tests from the source code

Open

#5,116 opened on 2024年12月3日

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

説明

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

コントリビューターガイド

技術スタック
rust
領域
testingdeveloper experience
Issue 種別
refactor
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Basic Rust knowledgeFamiliarity with Meilisearch codebaseUnderstanding of Rust module system
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85
調査方針
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.