meilisearch/MeiliSearch

Find a way to test our CLI

Open

#3,239 opened on Dec 13, 2022

View on GitHubContributor guide
 (1 comment) (1 reaction) (0 assignees)Rust (2,542 forks)batch import
help wantedmaintenanceOLD

Repository metrics

Stars
 (57,572 stars)
PR merge metrics
 (Avg merge 11d 20h) (41 merged PRs in 30d)

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

Research direction
Research CLI testing frameworks and strategies in Rust, such as assert cmd and rexpect, and propose a plan for Meilisearch's CLI. Focus on regression testing to prevent bugs after refactoring.
Tech stack
rust
Domain
cli
Issue type
Test
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70