meilisearch/MeiliSearch

Find a way to test our CLI

Open

#3,239 opened on Dec 13, 2022

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Rust (20,887 stars) (733 forks)batch import
help wantedmaintenanceOLD

Description

Currently, our CLI is barely tested. We've already encountered a bunch of bugs in the past, and we just discovered two new bugs after the huge refacto of the v0.30.

It's a shame that we don't have a whole test suite targeting our CLI, but I understand it's hard, and it wasn't prioritized.

I would like to gather some resources on how we could do it to start working on it after the v1.0. I think that's the only way we can ensure we don't break anything after a refacto. The config file and the env variables aren't tested either :pensive:

Contributor guide

Tech stack
rust
Domain
clitesting
Issue type
research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
RustCLI testing conceptsFamiliarity with MeiliSearch codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate how to integrate CLI testing into the MeiliSearch Rust codebase. Look at existing test infrastructure in the repository, possibly in the `cli` module. Consider using tools like `assert cmd` or `clap` for testing. Discuss with maintainers to define scope and acceptance criteria. Since the issue mentions two new bugs, focus on reproducing those bugs in tests.
Find a way to test our CLI · meilisearch/MeiliSearch#3239 | Good First Issue