Implementace a rozšíření frameworku pro testování technické dokumentace
Loading...
Date
Authors
ORCID
Advisor
Referee
Mark
D
Journal Title
Journal ISSN
Volume Title
Publisher
Vysoké učení technické v Brně. Fakulta elektrotechniky a komunikačních technologií
Abstract
Práca sa zaoberá automatizáciou testovania technickej dokumentácie napísanej v značkovacom jazyku AsciiDoc pomocou open-source frameworku testovania technickej dokumentácie Emender implementovaného na CI/CD platforme. Framework bol rozšírený o webovú aplikáciu emenderwebservice s REST API, ktorá poskytuje užívateľské grafické rozhranie s výsledkami testov a mechanizmom na odrieknutie falošne pozitívnych výsledkov testov. Webová aplikácia bola vytvorená pomocou WSGI frameworku na tvorbu webových aplikácií Flask s databázou ktorá umožňuje agregáciu výsledkov testov a ich unikátnu identifikáciu. Aplikácia uľahčuje prístup ku výsledkom testov vygenerovaných frameworkom Emender v CI/CD systémoch a poskytuje technical writer-om ucelené užívateľské prostredie.
The thesis discusses automated testing of technical documentation written in AsciiDoc markup language using open-source documentation testing framework Emender implemented in CI/CD. The framework was extended with a RESTful web application emenderwebservice, providing a graphical user interface with test results and a mechanism to waive false positive test results. Web application was implemented with Flask WSGI web application framework along with a database enabling aggregation and unique test identification. The application simplifies access to test results generated by Emender in CI/CD and provides a concise graphical user interface for technical writers.
The thesis discusses automated testing of technical documentation written in AsciiDoc markup language using open-source documentation testing framework Emender implemented in CI/CD. The framework was extended with a RESTful web application emenderwebservice, providing a graphical user interface with test results and a mechanism to waive false positive test results. Web application was implemented with Flask WSGI web application framework along with a database enabling aggregation and unique test identification. The application simplifies access to test results generated by Emender in CI/CD and provides a concise graphical user interface for technical writers.
Description
Keywords
Automatizácia testovania technickej dokumentácie, framework na testovanie technickej dokumentácie Emender, AsciiDoc, Jenkins, CI/CD, falošne pozitívne výsledky pri testovaní technickej dokumentácie, Flask, Automated testing of technical documentation, documentation testing framework Emender, AsciiDoc, Jenkins, CI/CD, False positive results in technical documentation testing, Flask
Citation
MACKO, P. Implementace a rozšíření frameworku pro testování technické dokumentace [online]. Brno: Vysoké učení technické v Brně. Fakulta elektrotechniky a komunikačních technologií. 2020.
Document type
Document version
Date of access to the full text
Language of document
en
Study field
Telekomunikační a informační technika
Comittee
prof. Ing. Dan Komosný, Ph.D. (předseda)
doc. Ing. Petr Mlýnek, Ph.D. (místopředseda)
Ing. et Ing. Petr Musil (člen)
doc. Ing. Petr Sysel, Ph.D. (člen)
Ing. Pavel Záviška (člen)
Date of acceptance
2020-06-16
Defence
Student prezentoval výsledky své práce a komise byla seznámena s posudky.
Student obhájil diplomovou práci s výhradami a odpověděl na otázky členů komise a oponenta.
Jak probíhá detekce false positives? - student dostatečně vysvětlil otázku.
Jakým způsobem jste testoval úspěšnost Vaší implementace? - student dostatečně vysvětlil otázku.
Result of defence
práce byla úspěšně obhájena
Document licence
Standardní licenční smlouva - přístup k plnému textu bez omezení