Tests: cover every subcommand in the help test

Open Beginner friendly
  • Is something wrong?
#222 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
85/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
testing

Research direction

Start with tests/cli_help.rs and its COMMANDS list, which currently has 10 entries. Add the missing subcommands (sign, verify, factor, check, integrate, context) and put serve in a separate list behind #[cfg(feature = "api")]. Done when cargo test --locked --test cli_help and cargo test --locked --no-default-features --test cli_help both pass and the file stays under 400 lines.

Written by the indexing model from the issue text.

Description

area:cli good first issue priority:P2 type:maintenance

English

Goal: The help test should cover every subcommand.

tests/cli_help.rs checks that each command's --help exists in German and English and contains an example, a usage heading and the exit codes. The list COMMANDS only has 10 entries; newer commands are missing: sign, verify, factor, check, integrate, serve (only with the default feature api) and context.

Tasks

  • Add the missing commands to COMMANDS (mind that serve only exists with the api feature – e.g. a separate list behind #[cfg(feature = "api")]).
  • Run cargo test --locked --test cli_help and cargo test --locked --no-default-features --test cli_help.

Acceptance criteria

  • All subcommands are checked in both languages; the test passes with and without default features.
  • The file stays under 400 lines.

Hints: All these commands already have examples today, so this is a pure test change. Start: cargo test --locked --test cli_help.

Deutsch

Ziel: Der Hilfetest soll alle Unterbefehle abdecken.

tests/cli_help.rs prüft, dass --help jedes Befehls auf Deutsch und Englisch existiert und ein Beispiel, die Überschrift „Verwendung“ und die Exit-Codes enthält. Die Liste COMMANDS hat nur 10 Einträge; es fehlen neuere Befehle: sign, verify, factor, check, integrate, serve (nur mit dem Standard-Feature api) und context.

Aufgaben

  • Fehlende Befehle in COMMANDS ergänzen (serve gibt es nur mit dem Feature api – z. B. eigene Liste hinter #[cfg(feature = "api")]).
  • cargo test --locked --test cli_help und cargo test --locked --no-default-features --test cli_help ausführen.

Akzeptanzkriterien

  • Alle Unterbefehle werden in beiden Sprachen geprüft; der Test läuft mit und ohne Standard-Features.
  • Die Datei bleibt unter 400 Zeilen.

Hinweise: Alle diese Befehle haben heute schon Beispiele – reine Teständerung.

Dominant language
Rust
Stars
0
Forks
0
Avg merge
1h 22m
Merged PRs (30d)
72

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SpecterAoD/pqkeep

All issues in SpecterAoD/pqkeep

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.