Automated Test Documentation Generator for BeakerLib Tests
Generátor dokumentace pro testy používající knihovnu BeakerLib

Description in English

  1. Get familiar with the BeakerLib integration testing library, and the basics of static and dynamic code analysis techniques.
  2. Analyse and describe common test structure, command semantics and metadata available for tests written in BeakerLib-
  3. Manually create an “ideal” documentation of three BeakerLib tests, serving as a goal for the tool.
  4. Design and implement a automated documentation generator for BeakerLib tests, The tool should use only test code, its structure and semantics. The tool should not need any documentation markup to work.
  5. Test the tool on a set of BeakerLib tests consisting of three original tests, and ten additional tests. Collect and process the feedback from authors and users of the tests.
  6. Assess the quality of the generated documentation and discuss the usefulness of the implemented generator. Propose further improvements and development ideas for the tool.

Description in Czech

  1. Seznamte se s knihovnou pro tvorbu integračních testů BeakerLib a se základními technikami statické a dynamické analýzy kódu.
  2. Proveďte důkladnou analýzu obecné struktury testů, sémantiky příkazů,
    a dostupných metadat pro testy používající knihovnu BeakerLib.
  3. Ručně vytvořte vzorovou dokumentaci tří testů. Tato dokumentace
    slouží jako vzor cíle práce.
  4. Navrhněte a implementujte nástroj pro automatizovanou tvorbu
    dokumentace pro testy používající knihovnu BeakerLib, který ke své
    funkčnosti bude používat pouze strukturu a sémantiku kódu testu, bez
    dodaných dokumentačních anotací.
  5. Nástroj otestujte na původních třech testech a porovnejte jeho
    výsledky se vzorovou dokumentací. Nástroj otestujte na sadě deseti
    dalších testů, na kterých zatím nebyl nástroj použitý. Shromážděte a
    vyhodnoťte zpětnou vazbu od autorů a uživatelů testů.
  6. Vyhodnoťte přínos nástroje a kvalitu generované dokumentace.
    Navrhněte možná rozšíření a směry dalšího vývoje nástroje.
Tags:
analysis, documentation, tests

Comments

There are no comments for this article.