tests/e2e: brownfield, every command in the server-in-use guide runs as written (tests #125)

Aperta
#152 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
42/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
bash, shell
Ambito
devops, testing

Direzione di ricerca

Start by reading docs/server-in-use.md, tests/exit-status.sh, and the brownfield profile’s existing scenario runner; the issue does not name that runner’s file. Check how guide commands and expected output are represented, then run the lint and brownfield scenario. Done means guide options are checked against --help, each marked command passes on the VM with its expected output, and the final audit has 0 FAIL with only the documented WARNs.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

area: ci area: docs claude enhancement priority: high size: S

Epic #121 · Tests #125 (epic #109) · Milestone Phase 5: Servers already in use · Priority high · Size S · Depends on #125, #124


Why

#125 writes docs/server-in-use.md, and its "How to verify" asks for a read-through on the brownfield VM where every command runs as written. Doing that by hand once is not enough: the guide drifts when the scripts change.

What to do

  • Mark the runnable blocks in the guide with <!-- e2e: run --> just before the fenced bash block, and an expected-output hint where the guide states one (<!-- e2e: expect <regex> -->).
  • Scenario guide in the brownfield profile: extract the marked blocks in order, replace the example values (web-01, 203.0.113.10, the config path) with the VM's, and run them as the operator (sudo through as_root, the admin over SSH).
  • Assert each block exits 0 and its expected regex matches.
  • The final audit shows 0 FAIL, and the normal WARNs the guide lists are the only WARNs.
  • Lint, no VM: every server-prep.sh / server-audit.sh option used in the guide appears in --help (in tests/exit-status.sh).

Acceptance criteria

  • Renaming an option the guide uses turns the lint red. A command in the guide that fails on the VM turns the scenario red.
Lingua principale
Shell
Stelle
2
Fork
3
Merge medio
2g 14m
PR unite (30g)
47

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di exceev-consulting/server-prep

Tutte le issue di exceev-consulting/server-prep

Issue simili

Altre issue su Shell/Bash

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.