Generátor dokumentace pro testy používající knihovnu BeakerLib
Loading...
Date
Authors
ORCID
Advisor
Referee
Mark
A
Journal Title
Journal ISSN
Volume Title
Publisher
Vysoké učení technické v Brně. Fakulta informačních technologií
Abstract
Cílem této práce řešené ve spolupráci se společností Red Hat Czech je navrhnout, implementovat a ověřit generátor dokumentace pro testy používající knihovnu BeakerLib, který efektivně vytváří dokumentaci z neokomentovaných BeakerLib testů. V prvním kroku generátor extrahuje data z BeakerLib příkazů. Následně jsou data přetvořena do informací v přirozeném jazyce. Na závěr jsou tyto informace vloženy do šablony dokumentace. Při tvorbě generátoru dokumentace byl použit modul argparse pro hledání dat z BeakerLib příkazů. Ve srovnání s existujícími nástroji navržený generátor přináší nový způsob vytváření dokumentací bez použití dokumentačních komentářů. Díky této vlastnosti lze generovat dokumentace, které jsou vytvořeny na základě automatizovaného porozumění zdrojového kódu testu. Testování, po celou dobu vývoje generátoru, probíhalo na třech zvolených BekerLib testech. Na závěr byl generátor otestován na deseti náhodně zvolených BeakerLib testech.
The aim of this work in cooperation with Red Hat Czech company is to design, implement and verify documentation generator for test written using BeakerLib library, which effectively creates documentation from BeakerLib tests without any documentation markup. In the first step generator parses data from every BeakerLib command in the test. Subsequently data are transformed as a natural language information. At the end generator transforms this information into documentation template. In this case an argparse method was used to find possible data from BeakerLib commands. In contrast to existing documentation generators this generator brings a new way of documentary creation from tests without any documentation markup. Thanks to this point of view we can generate documentation, which is created on base of automated understanding of test source code. Through documentation generator development time the generator was tested on three BeakerLib tests. In the end the documentation generator was tested on ten BeakerLib tests which were randomly selected.
The aim of this work in cooperation with Red Hat Czech company is to design, implement and verify documentation generator for test written using BeakerLib library, which effectively creates documentation from BeakerLib tests without any documentation markup. In the first step generator parses data from every BeakerLib command in the test. Subsequently data are transformed as a natural language information. At the end generator transforms this information into documentation template. In this case an argparse method was used to find possible data from BeakerLib commands. In contrast to existing documentation generators this generator brings a new way of documentary creation from tests without any documentation markup. Thanks to this point of view we can generate documentation, which is created on base of automated understanding of test source code. Through documentation generator development time the generator was tested on three BeakerLib tests. In the end the documentation generator was tested on ten BeakerLib tests which were randomly selected.
Description
Citation
KULDA, J. Generátor dokumentace pro testy používající knihovnu BeakerLib [online]. Brno: Vysoké učení technické v Brně. Fakulta informačních technologií. 2015.
Document type
Document version
Date of access to the full text
Language of document
cs
Study field
Informační technologie
Comittee
doc. RNDr. Jitka Kreslíková, CSc. (předseda)
doc. Dr. Ing. Jan Černocký (místopředseda)
doc. Mgr. Lukáš Holík, Ph.D. (člen)
doc. Ing. Jiří Jaroš, Ph.D. (člen)
Ing. Radek Kočí, Ph.D. (člen)
Date of acceptance
2015-06-18
Defence
Student nejprve prezentoval výsledky, kterých dosáhl v rámci své práce. Komise se poté seznámila s hodnocením vedoucího a posudkem oponenta práce. Student následně odpověděl na otázky oponenta a na další otázky přítomných. Komise se na základě posudku oponenta, hodnocení vedoucího, přednesené prezentace a odpovědí studenta na položené otázky rozhodla práci hodnotit stupněm A. Otázky u obhajoby: Výsledná dokumentace nemá návaznost na původní programové lokace ve skriptu testů. Co by obnášelo a jak náročné by bylo rozšíření vašeho řešení, aby výsledné větné formy obsahovaly (např. formou komentářů nebo anotací) odkazy na původní zdrojové věty?
Result of defence
práce byla úspěšně obhájena
Document licence
Standardní licenční smlouva - přístup k plnému textu bez omezení