Original title: Generátor dokumentace pro testy používající knihovnu BeakerLib
Translated title: Automated Test Documentation Generator for BeakerLib Tests
Authors: Kulda, Jiří ; Smrčka, Aleš (referee) ; Vojnar, Tomáš (advisor)
Document type: Bachelor's theses
Year: 2015
Language: cze
Publisher: Vysoké učení technické v Brně. Fakulta informačních technologií
Abstract: [cze] [eng]
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.
Keywords: argparse; BeakerLib; documentation generator; knapsack problem; python; shell tests; shlex; argparse; BeakerLib; generátor dokumentace; problém batohu; python; shellové testy; shlex

Institution: Brno University of Technology (web)
Document availability information: Fulltext is available in the Brno University of Technology Digital Library.
Original record: http://hdl.handle.net/11012/52359

Permalink: http://www.nusl.cz/ntk/nusl-599085


The record appears in these collections:
Universities and colleges > Public universities > Brno University of Technology
Academic theses (ETDs) > Bachelor's theses