RediSearch / rust-tests-guidelines
Install for your project team
Run this command in your project directory to install the skill for your entire team:
mkdir -p .claude/skills/rust-tests-guidelines && curl -L -o skill.zip "https://fastmcp.me/Skills/Download/1061" && unzip -o skill.zip -d .claude/skills/rust-tests-guidelines && rm skill.zipProject Skills
This skill will be saved in .claude/skills/rust-tests-guidelines/ and checked into git. All team members will have access to it automatically.
Important: Please verify the skill by reviewing its instructions before using it.
Guidelines for writing Rust tests.
0 views
0 installs
Skill Content
--- name: rust-tests-guidelines description: Guidelines for writing Rust tests. Use this when you want to write Rust tests. --- # Guidelines for Writing Rust Tests Guidelines for writing new tests for Rust code. ## Guidelines 1. Test against the public API of the code under test. 2. Test private APIs if and only if the private component is highly complex and difficult to test through the public API. 3. Use `insta` whenever you are testing output that is difficult to predict or compare. 4. Where appropriate, use `proptest` to add property-based tests for key invariants. 5. Testing code should be written with the same care reserved to production code. Avoid unnecessary duplication, introduce helpers to reduce boilerplate and ensure readability. The intent of a test should be obvious or, if not possible, clearly documented. 6. Do not reference exact line numbers in comments, as they may change over time. ## Code organization 1. Put tests under the `tests` directory of the relevant crate if they don't rely on private APIs. 2. The `tests` directory should be organized as a crate, with a `main.rs` file and all tests in modules. Refer to the `trie_rs/tests` directory as an example. 3. If the test *must* rely on private APIs, co-locate them with the code they test, using a `#[cfg(test)]` module. ## Dealing with extern C symbols Check out [CONTRIBUTING.md](../../src/redisearch_rs/CONTRIBUTING.md) for instructions on how to deal with undefined C symbols in Rust tests.