Hangyász Hibakövető Rendszer fejlesztői dokumentáció Kovács Zsolt Rugina Szabolcs Szatmári Renáta Szilágyi Szabolcs Szőke Zoltán 2011. Kolozsvár
Tartalomjegyzék Tartalomjegyzék... 2 1 Célkitűzés... 3 2 Követelmények... 4 2.1 Fogalomtár... 4 2.2 Használati esetek (funkcionális követelmények)... 5 2.3 Nem funkcionális követelmények... 13 3 Programterv... 14 3.1 Az adatbázis tábláinak megfelelő osztályok... 14 3.2 Az adatbázis dokumentációja... 17 3.2.1 Adatbázis típusa... 17 3.2.2 Adatbázis fejlesztése során felhasznált eszközök:... 18 3.2.3 Adatbázis táblák leírása és szerepe:... 18 4 Tesztelői dokumentáció... 25 4.1 Dokumentum célja... 25 4.2 Minőségi kapu meghatározása... 25 4.2.1 Súlyosságok meghatározása... 25 4.2.2 Minőségi kapu... 25 4.2.3 Minimális tesztelésre fordított idő... 26 4.3 Használat... 26 4.4 Test Casek részletes leírása... 26 5 Továbbfejlesztési tervek... 33 2
1 Célkitűzés Egy hibakövető rendszer (Bug Reporting Tool) megvalósítása, amely lehetővé teszi egyének vagy fejlesztőcsoportok számára, hogy a szoftverfejlesztés, -tesztelés során felmerülő kijavítandó hibákat és a kérelmezett funkciókat, illetve a velük kapcsolatos javítási, megvalósítási tevékenységeket, folyamatokat nyilvántartsák. Az egyes jelentett hibákhoz és javítási, fejlesztési javaslatokhoz továbbiakban: bug-ok (hibák) vagy issue-k (feladatok) egy-egy azonosító számot rendelnek hozzá, ami aztán elkíséri a bejelentést a teljes feldolgozási eljárás alatt. A hibákat figyelő, azokkal valamilyen kapcsolatban levő felhasználók e-mailértesítést kapnak a bejelentett hibákról, javítási javaslatokról, intézkedésekről, hozzáfűzött megjegyzésekről. A bugok szoftverfejlesztési projektek szerint rendeződnek, azaz egy új bugot csak egy létező projekthez csatoltan lehet létrehozni, és ezt csak ezen a bizonyos projekten dolgozó felhasználó (projektvezető, fejlesztő, tesztelő) érheti el. 3
2 Követelmények 2.1 Fogalomtár Magyar Angol Jelentés Hiba Bug Használatos még a feladat (issue) elnevezés is. Olyan még el nem végzett feladatok, amikre a fejlesztés során derül fény. Továbbá lehet a tesztelés folyamata alatt talált hiba is. Egy hibakövető rendszer segítségével ezeknek a bugoknak az evoluálását lehet megszervezni, nyomon követni a létrehozás pillanatától a lezárásig. Hibaállapot Bugstatus A buglétrehozás és -lezárás köztes stádiumait az áttekinthetőség miatt címkékkel (státuszok) látjuk el. Ezek száma és neve alkalmazástól alkalmazásig különbözhet. A leggyakoribbak: új, hozzárendelt, visszajelzés, javított (megoldott), tesztelhető, lezárt. Az esetek többségében ezekhez az állapotokhoz jelölőszín is hozzárendelhető, ami által egy tapasztaltabb felhasználó hatékonyabban képes kezelni egy bugot. Felhasználó User Egy alkalmazás használója, alkalmazója. Jelen esetben olyan, egy adott projekten dolgozó személy, aki részt vesz a hibakövető folyamatok feltárásában, elhárításában is. (A projekten dolgozó többi csapattaggal együtt használója, alkalmazója egy hibakövető rendszernek.) Projekten belüli feladatköre és jogai függvényében lehet fejlesztő, tesztelő, projektvezető, a hibakövető rendszer szempontjából pedig nomál user vagy szuperuser. Rendszerfelügyelő Superuser A szuperuser kizárólagos hatáskörébe tartozik új felhasználók felvétele, felhasználói jogok adása illetve megvonása, bugstátusokhoz rendelt színek módosítása és egyéb portálpreferenciák beállítása. Projekt Project Jelen esetben egy számítógépes alkalmazás elkészítéséhez szükséges tevékenységek, feladatok, folyamatok összessége a projekt. 4
2.2 Használati esetek (funkcionális követelmények) A felhasználóknak két típusa van: user és szuperuser. A használati eseteket logikailag csoportosítottuk: Hangyász Hibakövető Rendszer használati eset diagramja Ezeket az eseteket a következő ábrák mutatják be: 5
6 F E J L E S Z T Ő I D O K U M E N T Á C I Ó
7 F E J L E S Z T Ő I D O K U M E N T Á C I Ó
8 F E J L E S Z T Ő I D O K U M E N T Á C I Ó
9 F E J L E S Z T Ő I D O K U M E N T Á C I Ó
10 F E J L E S Z T Ő I D O K U M E N T Á C I Ó
11 F E J L E S Z T Ő I D O K U M E N T Á C I Ó
12 F E J L E S Z T Ő I D O K U M E N T Á C I Ó
2.3 Nem funkcionális követelmények A webalkalmazás működjön minden böngészőben. A használata legyen egyszerű. Módszertanok: UML Fejlesztési környezet: Windows vagy Linux operációs rendszer Eclipse Helios Futtatási környezet: Tetszőleges operációs rendszer Tetszőleges böngésző 13
3 Programterv 3.1 Az adatbázis tábláinak megfelelő osztályok ábra 1. Leírás: A BugFile osztály tartalmazza az adott bugokhoz hozzárendelt információs fájlok elérési útvonalát, nevét, a feltöltés időpontját, a feltöltő felhasználó nevét és, hogy melyik bughoz tartozik. 14
ábra 2. Leírás: A BugHistory osztály a bugok nyomkövetésére szolgál. ábra 3. A Note osztály a bugokhoz tartozó megjegyzéseket tartalmazza, az adott felhasználóval és létrehozásának időpontjával. ábra 4. Leírás: A PortalPrefereces 15 osztály az alkalmazás beállításait tartalmazza.
ábra 6. A SentMail osztály az elküldött üzenetek témáját, szövegét, a címzett emailcímét és a küldés időpontját tartalmazza. ábra 5. A UserPreference osztály az adott projektekhez tartozó felhasználók jogát tartalmazza. 16
ábra 7. A UserProjectPreference osztály minden felhasználó számára tartalmazza a email küldéséhez tartozó beállításait. 3.2 Az adatbázis dokumentációja 3.2.1 Adatbázis típusa Az alkalmazásunk relációs adatbázison alapszik, amelyet MySQL adatbáziskezelőben fejlesztettünk. 17
3.2.2 Adatbázis fejlesztése során felhasznált eszközök: Az alkalmazásunk adatbázisának fejlesztése során a MySQL 5.0-t illetve a MySQL Workbench programokat használtuk. 3.2.3 Adatbázis táblák leírása és szerepe: 1. Táblanév: BUG Leírás: A BUG tábla tartalmazza a bugok tulajdonságait (a projekt, amelyikhez tartozik, állapotát, a létrehozó, a hozzárendeltje, a hiba kiváltásának lépései, egy rövidebb és egy bővebb leírást, a létrehozásnak és az utolsó változtatásnak az időpontja, az alárendeltségi illetve fölérendeltségi viszonyok) Oszlopnév id project status reporter belongs_to reproducibility short_description description submitted last_update parent duplicate Típus text archar(255) varchar(45) datetime datetime 18
2. Táblanév: BUG_FILE Leírás: A BUG_FILE tábla tartalmazza az adott bugokhoz hozzárendelt információs fájlok elérési útvonalát, nevét, a feltöltés időpontját, a feltöltő felhasználó nevét és hogy melyik bughoz tartozik. Oszlopnév id name local_file_name bug created user O Típus ' ' varchar(255) ' varchar(45) ' ' datetime ' ' ' ' ' ' ' 3. Táblanév: BUG_HISTORY Leírás: A BUG_HISTORY tábla a bugok nyomkövetésére szolgál. Oszlopnév id user bug date type Típus datetime 4. Táblanév: BUG_HISTORY_TYPE Leírás: A BUG_HISTORY_TYPE tábla tartalmazza a Bug létrehozása óta történt státuszváltozásokat. Például: Created Assigned Resolved Closed Oszlopnév id name description user Típus varchar(45) varchar(255) 19
5. Táblanév: BUG_STATUS Leírás: A BUG_STATUS tábla a bugok lehetséges állapotát tartalmazza. Oszlopnév id description Típus varchar(255) 6. Táblanév: CATEGORY Leírás: A CATEGORY tábla tartalmazza az adott projektek kategóriájának nevét és leírását. Oszlopnév id name description Típus varchar(45) varchar(255) 7. Táblanév: NOTE Leírás: A NOTE tábla a bugokhoz tartozó megjegyzéseket tartalmazza, az adott felhasználóval és létrehozásának időpontjával. Oszlopnév id bug user text created Típus longtext datetime 20
8. Táblanév: PORTAL_PREFERENCES Leírás: A PORTAL_PREFERENCES tábla az alkalmazás beállításait tartalmazza. Oszlopnév id name value added_by submitted Típus varchar(45) varchar(255) datetime 9. Táblanév: PROJECT Leírás: A PROJECT tábla tartalmazza a projektek attribútumait: nevét, leírását, kategóriáját. Oszlopnév id name description category storage_folder Típus varchar(255) rchar(45) varchar(255) 10. Táblanév: PROJECT_USER_RIGHT Leírás: A PROJECT_USER_RIGHT tábla a projekthez rendelt felhasználók jogait tárolja. Oszlopnév id name description Típus varchar(45) varchar(255) 21
11. Táblanév: SENT_MAIL Leírás: A SENT_MAIL tábla az elküldött üzenetek témáját, szövegét, a címzett e-mailcímét és a küldés időpontját tartalmazza. Oszlopnév id subject body email created Típus varchar(255) longtext varchar(255) datetime 12. Táblanév: USER Leírás: A USER tábla tartalmazza a felhasználók nevét, e-mailcímét, jelszavát, jogait és utolsó bejelentkezésének időpontját. Oszlopnév id name email password enabled last_login super_user Típus varchar(45) varchar(45) varchar(32) tinyint(1) datetime tinyint(1) 13. Táblanév: USER_PREFERENCE Leírás: A USER_PREFERENCE tábla az adott projektekhez tartozó felhasználók jogát tartalmazza. Oszlopnév id name value user Típus varchar(45) varchar(255) 22
14. Táblanév: USER_PROJECT_PREFERENCE Leírás: A USER_PROJECT_PREFERENCE tábla minden felhasználó számára tartalmazza az e-mailküldési beállításait. Oszlopnév id user project send_email_when_assigned send_email_when_feedback send_email_when_resolved send_email_when_closed user_right Típus tinyint(1) tinyint(1) tinyint(1) tinyint(1) 23
A táblák közötti relációkat a következő diagram mutatja: F E J L E S Z T Ő I D O K U M E N T Á C I Ó 24
4 Tesztelői dokumentáció 4.1 Dokumentum célja Lehetőséget ad az alkalmazást tesztelő személy számára, hogy egyszerűen a program teljes ismerete nélkül képes legyen a tesztek futtatásával az alkalmazás minőségének felmérésére. Ez a dokumentum a fejlesztői dokumentum része, viszont kérésre egyes felhasználók számára rendelkezésre bocsátható. 4.2 Minőségi kapu meghatározása 4.2.1 Súlyosságok meghatározása 1- A hiba ember illetve hardwerépséget veszélyeztet 2- Az alkalmazás normál használat mellett leáll 3- Az alkalmazás negatív teszt esetén leáll 4- Kisebb funkcionális hibák 5- Az alkalmazás kezelőfelületének kisebb hibái. 4.2.2 Minőségi kapu Nincs 1-es súlyosságú hiba 25
2-es súlyosságú hibák száma kisebb, mint a 3 3-as súlyosságú hibák száma kisebb, mint 10 4-es súlyosságú hibák száma kisebb, mint 15 5-os súlyosságú hibák száma kisebb, mint 40 4.2.3 Minimális tesztelésre fordított idő A szoftver nem adható ki 80 órányi tesztelés előtt. 4.3 Használat Létező test case esetén: Test case futtatása után töltsd ki az illetve Utolsó futtatás dátuma értékeket! Új feladat esetén: A dokumentum végére másold be a következő táblázatot, majd töltsd ki az értékeket! Test Case száma / Tesztelő Elvárt Működés Utolsó Futtatás Ideje 4.4 Test Casek részletes leírása Test Case száma/tesztelő 1/Szőke Zoltán Login tesztelése Email cim kitöltése, jelszó kitöltése Sikeres bejelentkezés a főoldalra Futtatás ideje Datum 03/19/11 17:23:33 Hiba, sikertelen kapcsolódás az adatbázishoz 26
Test Case száma/tesztelő 2/Rugina Szabolcs Login tesztelése Email cim kitöltése, jelszó kitöltése Sikeres bejelentkezés a főoldalra Futtatás ideje Datum 03/19/11 17:25:38 Test Case száma/tesztelő 3/Szőke Zoltán Új feladat Kategoria combo onchange helyes működése a Projekt comboval összekötve Kiválasztunk egy elemet a Kategoria comboból Projekt comboban csak a kiválasztott kategoria szerinti Projektek szerepelnek Futtatás ideje Datum 03/19/11 18:12:21 Test Case száma/tesztelő 4/Szőke Zoltán Új feladat Rövid leiras mezőjének helyes működése Beirjuk a kivánt szöveget és a Létrehozás gombra kattintunk Belekerül az adatbázisba Futtatás ideje Datum 03/19/11 18:15:16 Test Case száma/tesztelő 5/Szőke Zoltán Új feladat Leiras mezőjének helyes működése Beirjuk a kivánt szöveget és a Létrehozás gombra kattintunk Belekerül az adatbázisba Futtatás ideje Datum 03/19/11 18:16:45 Test Case száma/tesztelő 6/Szőke Zoltán Új feladat előidézéséhez mezőjének helyes működése Beirjuk a kivánt szöveget és a Létrehozás gombra kattintunk Belekerül az adatbázisba Futtatás ideje Datum 03/19/11 18:17:42 27
Test Case száma/tesztelő F E J L E S Z T Ő I D O K U M E N T Á C I Ó 7/Szőke Zoltán Új feladat Állomány keresése opció helyes működésének tesztelése Rákattintunk a Tallózás gombra majd kiválasztjuk a kivánt fájlt és utána a Létrehozás gombra Az adott fájl sikeresen bemásolódik az adott könyvtárba és az elérési útvonala belekerül az adatbázisba Futtatás ideje Datum 03/19/11 18:21:11 Hibás, nem másolja bele a fájlt a kivánt könyvtárba Test Case száma/tesztelő Futtatás ideje Datum 03/19/11 18:23:31 Test Case száma/tesztelő 8/Szőke Zoltán Új feladat Állomány keresése opció helyes működésének tesztelése Rákattintunk a Tallózás gombra majd kiválasztjuk a kivánt fájlt és utána a Létrehozás gombra Az adott fájl sikeresen bemásolódik az adott könyvtárba és az elérési útvonala belekerül az adatbázisba 9/Szőke Zoltán Új feladat hozzárendelt felhasználó combo feltöltése Rákattintunk a Válassz felhasználót opcióra Feltölti a combot az adatbázisban levő felhasználókkal Futtatás ideje Datum 03/19/11 18:24:55 Test Case száma/tesztelő 10/Szőke Zoltán Új feladat hozzárendelt felhasználó combol kiválasztott felhasználó feltöltése az adatbázisba Kiválasztjuk a felhasználót a comboból és rákattintunk a Létrehoz gombra A kiválasztott felhasználó bekerül az adatbázisba Futtatás ideje Datum 03/19/11 18:25:45 Test Case száma/tesztelő 11/Szőke Zoltán Új feladat ürlap hiányos adatokra való tesztelés Néhány kötelező adatot nem töltünk ki és úgy próbáljuk létrehozni az új feladatot Az alkalmazás hibaüzenettel tér vissza jelezve a hiányosságot/hiányosságokat Futtatás ideje Datum 03/19/11 18:40:14 Hibás, a rövid leirás kitöltésének kihagyásával nem jelez az alkalmazás 28
Test Case száma/tesztelő F E J L E S Z T Ő I D O K U M E N T Á C I Ó 12/Szőke Zoltán Új feladat ürlap hiányos adatokra való tesztelés Néhány kötelező adatot nem töltünk ki és úgy próbáljuk létrehozni az új feladatot Az alkalmazás hibaüzenettel tér vissza jelezve a hiányosságot/hiányosságokat Futtatás ideje Datum 03/19/11 18:43:50 Test Case száma/tesztelő 13/Szőke Zoltán Saját profil jelszócseréjének tesztelése Beirjuk az új jelszavat és a megerősitésnél újra Ha a két jelszó talál akkor kicséréli a régi jelszavat az új jelszóval Futtatás ideje Datum 03/19/11 18:44:32 Test Case száma/tesztelő 14/Szőke Zoltán Saját profil jelszócseréjének tesztelése Beirjuk az új jelszavat és a megerősitésnél újra Ha a két jelszó nem talál akkor hibaüzenetet ir ki az alkalmazás Futtatás ideje Datum 03/19/11 18:46:31 Test Case száma/tesztelő 15/Szőke Zoltán Saját profil felhasználónézcsere tesztelése Módositjuk a felhasználónevet Kicseréli a felhasználónevet a módositottra Futtatás ideje Datum 03/19/11 19:11:42 Test Case száma/tesztelő 16/Szőke Zoltán Saját profil E-mail beállitások tesztelése Kipipáljuk mind a négy checkboxot: 1. Email hozzárendeléskor 2. Email visszajelzéskor 3. Email teljesítéskor 4. Email lezáráskor Mind a négy checkbox beállításának mentése helyes Futtatás ideje Datum 04/01/11 16:31:54 29
Test Case száma/tesztelő F E J L E S Z T Ő I D O K U M E N T Á C I Ó 17/Szőke Zoltán Saját profil E-mail beállítások Válassz projektet combo feltöltése Feltöltjük az adatbázisban levő projektek nevével Feltölti azokkal a projektnevekkel amelyekben benne vagyunk Futtatás ideje Datum 04/01/11 16:33:41 Test Case száma/tesztelő 18/Szőke Zoltán Saját profil E-mail beállítások Válassz projektet combobol kiválasztunk egy projektnevet és rákattintunk a submit gombra testz Kiválasztunk egy projektnevet és rákattintunk a submit gombra A kiválasztott projekt beállitásai bekerülnek az adatbázisba Futtatás ideje Datum 04/01/11 16:37:12 Test Case száma/tesztelő 19/Szőke Zoltán Nyelvválasztás tesztelése Rákattintunk a főmenüben levő zászlók egyikére Átvált az adott nyelvre Futtatás ideje Datum 04/01/11 16:39:12 Test Case száma / Tesztelő Elvárt Működés Utolsó Futtatás Ideje 05/04/2011 21:36 Test Case száma / Tesztelő Elvárt Működés Utolsó Futtatás Ideje 05/04/2011 21:36 20/ Kovács Zsolt Filterezés Combok segitsegevel A feladatok oldalon keres ra egy adott Feladatra status szerint Megjelenek az adott statuszu feladatok. 21/ Szatmári Renáta Filterezés ID szerint A feladatok oldalon keres ra egy adott Feladatra (letezo) ID szerint. Mutatja az adott ID-ju feladatot. 30
Test Case száma / Tesztelő Elvárt Működés Utolsó Futtatás Ideje 01/04/2011 09:36 Test Case száma / Tesztelő Elvárt Működés Utolsó Futtatás Ideje 01/04/2011 09:40 Test Case száma / Tesztelő Elvárt Működés Utolsó Futtatás Ideje 01/04/2011 09:45 Test Case száma / Tesztelő Elvárt Működés Utolsó Futtatás Ideje 01/04/2011 10:12 Test Case száma / Tesztelő Elvárt Működés Utolsó Futtatás Ideje 01/04/2011 10:15 F E J L E S Z T Ő I D O K U M E N T Á C I Ó 22/ Kovács Zsolt Megjegyzes hozzaadasa Egy Feladat reszletei oldalon adj megjegyzest a feladathoz. Lepj ki az alkalmazasbol. Lepj be az alkalmazasba ellenorizd hogy a Feladat tartalmazza az elobbiekben hozzaadott megjegyzest Tartalmazza 23/ Rugina Szabolcs Egy Problema megtekintese Lepj be az alkalmazasba keres ra egy Bug-ra ID szerint. Kattinst a Bug ID-jara. Csatlakoz az adatbazishoz MySql workbench segitsegevel. Vesd ossze a felhasznaloi feluleten megjeleno ertekeket az adatbazisban talalhato adatokal. A Bug tulajdonsagai egy uj lapon megjelenek. Azonosak az adatbazisban szereplo ertekekel. 24/ Szatmári Renáta Filefeltoltes tesztelese Egy Feladat reszletei oldalon tolts fel egy file-t. Lepj ki az alkalmazasbol. Lepj be az alkalmazasba ellenorizd hogy a Feladat tartalmaz csatolt file-t. Mutatja az adatbazisbol feltoltott combo 25/ Szilágyi Szabolcs Belepes Olyan felhasznaloval lepj be akinek van regiszralt felhasznaloneve viszont rosz jelszot irjal be Belepes Sikertele 26/ Szilágyi Szabolcs Belepes Olyan felhasznaloval lepj be akinek nincs regiszralt felhasznaloneve Belepes sikertelen 31
Test Case száma / Tesztelő Elvárt Működés Utolsó Futtatás Ideje 06/04/2011 06:15 Test Case száma / Tesztelő Elvárt Működés Utolsó Futtatás Ideje 06/04/2011 06:29 Test Case száma / Tesztelő Elvárt Működés Utolsó Futtatás Ideje 06/04/2011 06:30 F E J L E S Z T Ő I D O K U M E N T Á C I Ó 27/ Kovács Zsolt E-mail küldés tesztelése Lépj be az alkalmazásba. Ellenörizd a felhasznaloi feluleten, hogy a bejelentkezett felhasznalo e-mail cime valos. Ellenorizd hogy milyen esemenyek valtjak ki az e-mail kuldest. Egy NEM esemeny kozul valasz ki egyet es idezd elo. Peldaul Bug Statuszanak megvaltoztatasa e-mail kuldeshez vezet ha ez NEM konfiguralt. E-mail nem kerul elkuldesre. 28/ Rugina Szabolcs Fooldal mukodesenek tesztelese Lepj be az alkalmazasba A fooldalon a specifikacionak megfelelo adatok jelenek meg. A gombok illetve kezeloi controlok hely es meret szempontjabol az eredeti designal oszhangban vannak. Lasd Felhasznaloi dokumentacio 29/ Kovács Zsolt E-mail küldés tesztelése Lépj be az alkalmazásba. Ellenörizd a felhasznaloi feluleten, hogy a bejelentkezett felhasznalo e-mail cime valos. Ellenorizd hogy milyen esemenyek valtjak ki az e-mail kuldest. Egy valos esemeny kozul valasz ki egyet es idezd elo. Peldaul Bug Statuszanak megvaltoztatasa e-mail kuldeshez vezet ha ez konfiguralt. E-mail belathato idon belul. 15perc megerkezik a megadott postafiokba. 32
5 Továbbfejlesztési tervek Az applikáció optimalizálása mobil környezetre. Például: OperaMini Oracle adatbázis supportálása A multilanguage support kiterjesztése 33