Organizace souborů a složek při práci s Robot Frameworkem

Otázkou organizace souborů a složek v jakémkoliv projektu spojeným s programováním se zabýval snad každý z nás. Tato problematika nabírá důležitosti zejména při práci na větším projektu, který může obsahovat i desítky různých souborů a složek. Dalším velkým aspektem ovlivňující tuto problematiku je jednoznačně práce v týmu, kde každý je zvyklý na jinou organizaci svých souborů, a proto je nutné vytvořit strukturu souborů a složek tak, aby byla přehledná pro každého člena týmu.

Základní rozdělení složek

Nejdůležitější částí celé struktury by mělo být základní rozdělení na složky obsahující zdrojové soubory (Resources), testovací sady (TestSuite), samotné testy (TestCases) a složku pro soubory z průběhu testování, kterými můžou být například screenshoty nebo logy. Jednotlivé soubory budou poté obsažené v příslušné složce a propojené mezi sebou. V neposlední řadě bude celá struktura obsahovat i dokumenty automaticky vygenerované pomocí Robot Frameworku.

Složka TestCases

Složka TestCases bude obsahovat všechny testy ze všech testovacích sad. Testy můžeme poté spouštět v různých testovacích sadách. Pokud by bylo zapotřebí vytvořit více souborů s testy pro jednu testovací sadu, je vhodné je všechny zabalit do jedné společné podsložky . Tímto si udržíme přehlednost naší složky s testy a nebudeme v tom mít potom zmatek.

Složka Resources

Nejvíce složitou strukturu rozhodně obsahuje složka Resources, ve které jsou obsažená všechna klíčová slova (Keywords), proměnné (Variables) a pomocné soubory. Aby soubory v této složce nebyly moc nepřehledné, je rozhodně vhodnější k soborům Keywords a Variables vytvořit stejnojmenné složky , které budou obsahovat stromovou strukturu složek a souborů všech klíčových slov a proměnných. V případě potřeby je ještě možné vytvořit speciální složku pro všechna výstupní data, kterými mohou být například screenshoty, ale i různé textové dokumenty obsahující logování z průběhu testování.

Složka TestSuite

Organizace této složky je nejjednodušší ze všech složek, protože obsahuje pouze testovací sady, které spouští jednotlivé testy.

Přidělování souborů ke složkám

S velkým počtem souborů se pojí další nepříjemnost, a to propojení velkého množství souborů s klíčovými slovy a proměnnými. Proto můžeme použít hlavní soubory Keywords a Variables jako takové, které připojí všechny příslušné doplňující soubory a v souborech pro testovací případy následně importujeme pouze tyto dva hlavní soubory. Tímto způsobem si udržíme čitelnost ve všech souborech ve složce TestCases.

Pojmenování robot souborů

Společně s vhodnou organizací souborů a složek je důležité taky správně pojmenovat jednotlivé soubory. Tento krok je samozřejmě na každém týmu, ale mně osobně se osvědčilo následující pojmenovávání souborů: Soubory testovacích případů pojmenovávám stylem , <číslo příslušného TestSuite>, a vše propojím podtržítky. Výsledek vypadá například následovně: TC_001_001.robot.

U souborů testovacích sad to je jednodušší. Zde využívám pouze zkratku TestSuite a číslo daného souboru, kde obě hodnoty spojím zase podtržítkem, takže asi nějak takto: TS_001.robot. I přes složitou strukturu složky Resources máme velmi volnou ruku při pojmenovávání jednotlivých souborů. Stále ale platí, že je dobré mít v pojmenování svůj systém. Já sám to dělám následovně: Hlavní soubor i složku pro klíčová slova pojmenuji Keywords a ostatní soubory vnořené do této složky už pojmenovávám podle potřeby. Úplně stejné to mám v případě hlavního souboru a složky pro proměnné, kde tyto dva soubory pojmenuji Variables a ostatní zase podle potřeby.