Detailed design and unit level (SWE.3): decide the element model, add unit checks and a design report

Aperta
  • Qualcosa non va?
#371 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript, rust, yaml
Ambito
testing, tooling

Direzione di ricerca

Start by reading the related issues #363 and #272, then inspect the existing PartDef, ActionDef, implementedBy, and test model described in this issue. Compare the three options and the recommendation before implementation. Done means the chosen design is documented; for the recommended option, tests report missing code links, unit tests, or satisfied requirements, and a small unit report shows interface, behaviour, code symbol, tests, and verdicts.

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

Descrizione

Part of #363 (item 9). Needs a decision before implementation.

Question

ASPICE SWE.3 asks for a detailed design of software units, traceable to the architecture and to unit tests. There is no unit-level element kind; today a unit is a PartDef (software) with implementedBy: and tests that verifies: requirements. Is a new element kind needed, or is a level on the existing ones enough?

Options

  1. Level on existing elements. level: component | unit on software PartDef/ActionDef, with checks: a unit has implementedBy (A) with a symbol, at least one unit-level test (testLevel: L1), a requirement it satisfies, and an owning component. Cheapest; reuses traces and coverage.
  2. A SoftwareUnit element with fields for interface (operations), algorithm description, data (typed, with ranges), resources (E), error handling and the unit tests, rendered as the SWE.3 detailed design document section. More structure; one more type to maintain.
  3. Document generation only. Keep the model as is and generate the SWE.3 work product from PartDef + ActionDef + implementedBy + tests.

Recommendation

Option 1 plus 3: add level: and its checks, and a design-report that lays out a unit's interface, behaviour, data, resources, code link and tests as the SWE.3 work product. Revisit option 2 if the checks need fields that do not fit existing types.

Acceptance (tests first, for option 1)

  • A software unit without a code link, a unit test, or a satisfied requirement is reported (opt-in by level: unit).
  • The unit report for a small example lists interface, behaviour, code symbol, tests and verdicts.

Part of #272 (executable MBSE / software design).

Generated by Claude Code

Lingua principale
Rust
Stelle
8
Fork
1
Merge medio
3h 35m
PR unite (30g)
69

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 sjames/syscribe

Tutte le issue di sjames/syscribe

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.