T Software Project Group: Tetrastone Subject: RosettaNET. Personal Software Engineering Assignment: Tetrastone

Transkriptio

1 Personal Software Engineering Assignment: Tetrastone Name of the group (Tetrastone) Subject: PSEA

2 Document history Version Date Author Description Henry Niveri Initial version of this report

3 Sisällys 1 Johdanto Järjestelyt Tulokset Kokemukset Lyhenteet Liite 1. Inspection Data Summary... 6 Inspection issue Log... 9 Inspection issue Log...10

4 1 Johdanto Henkiloökohtainen menetelmäharjoitukseni aiheena oli koodin staattinen analysointi. Harjoituksen tavoitteena oli löytää virheitä ryhmämme koodista ja näin parantaa tuotteen laatua. Lisäksi harjoituksen etuna oli se, että tarkastettavan koodin toiminta tuli selkeäksi kaikille muillekkin, paitsi itse ohjelmoijalle. 2 Järjestelyt Koska koodin staattinen analysointi on aikaavievää ja ryhmämme aikaresurssit oli rajoitetut, päätettiin käyttää menetelmää vain kerran. Lisäksi tarkastajia kehoitettiin tutkimaan koodia ad hoc tyyliin eli käyttämään koodin tuntemustaan hyväksi ja etsimään virheitä paikoista, joissa tarkastaja uskoi niitä olevan. Tarkastettava koodi oli yksi luokka, ManagePIPProcess.aspx, joka käsittää PIP:n luonnin ja muokkauksen sysadmin tasolla. Luokka oli n.500 riviä pitkä. Koodia lukiessa tarkastajia kehoitettiin käyttämään tarkastuslistaa, josta löytyi mahdollisia virheiden paikkoja. Koodintarkastuskokous(code inspection) pidettiin Teknillisen korkeakoulun tietotekniikka talolla. Kokoukseen osallistui kaikki ryhmän jäsenet. Kaikki kokoukseen osallistuneet olivat valmistautuneet tarkastamalla koodia riittävällä tarkkuudella. Koodi käytiin läpi selaamalla sitä videotykin avustuksella. Kun selatessa tultiin kohtaan, josta tarkastaja oli havainnut virheen, merkittiin virhe ylös. Tämä helpotti kokouksen jälkeistä työtäni, koska tiesin tarkasti, mitä virhettä tarkastaja oli tarkoittanut. 3 Tulokset Virheitä löytyi 36 kappaletta, joista todellisia virheitä oli 24 kappaletta. Menetelmä olis siis hyvinkin tehokas löytämään virheitä. Löytyneistä virheistä 2 oli major-luokan virheitä, 7 oli minor-luokan virheitä ja loput 27 olivat parannusehdotuksia. Jälkitarkastelussa nostin yhden minor virheistä major luokkaan ja koska monet tarkastajat olivat löytäneet samoja virheitä jäi todellisten parannusehdotusten määräksi vain 15. Kokonaisuudessa aikaa tarkastuksen suunnitteluun, virheiden etsimiseen ja virheiden kirjaamiseen kului 10h. Virheiden löytymisajaksi tuli siis 2,4 virhettä/tunti. Luku on aika hyvä mutta ryhmämme rajallisten resurssien vuoksi emme voineet käyttää menetelmää useammin kuin kerran. Tarkemmat tiedot tarkastuksen tunnusluvuista ja metriikoista löytyvät liitteestä 1. 4 Kokemukset Kuten aluksi epäilin, staattinen koodin analysointi on liian raskas menetelmä näin pieneen projektiin. Aikaa kului yli 10 tuntia, joka on melkein 1% koko käytettävästä ajasta. Tuossa ajassa saimme tarkistettua koko projektin koodista ehkä n. 5%. Koko koodin tarkastaminen pienemmälläkin tarkastusryhmällä olisi vienyt aivan liikaa aikaa. Löytyneiden virheiden määrä yllätti kuitenkin minut positiivisesti. Ennen tarkastusta suhtauduin menetelmään hyvin epäilevästi ja uskoin tulosten jäävän pieniksi. Virheitä löytyi kuitenkin paljon ja uskon että riittävillä resursseilla ja osaavilla tarkastajilla projektin alkuvaiheessa staattinen koodin analysointi on tehokkaampi menetelmä kuin perinteinen mustalaatikkotestaus.

5 Myös muiden dokumenttien staattiset tarkastukset olisivat olleet mielenkiintoisia. Valitettavasti emme ehtineet tekemään niitä. 5 Lyhenteet Lyhenne Kuvaus PIP RosettaNet Partner Interface Processes (PIPs ) define business processes between trading partners. Taulu 4: Lyhenteet

6 6 Liite 1. Inspection Data Summary Date _ Inspection ID tetrainsp1 Inspection leader Henry Niveri Product Document reference ManagePIPProcess.aspx.cs _ Total LOC _n.500 Planning time _3h (work-hours) Individual checking results (to be reported during the entry process of the logging meeting) Inspector 1 Anssi Rajaniemi 2 Kimmo Toivola 3 Hanna Koivu 4 Mikko Savolainen 5 Kjell Holmberg 6 Mikael Riska Hours check LOC studi ed issue s issue s Improv m. Questio ns Check rate LOC/hou r 0, /h 0, /h 0, /h 0, /h /h 0, /h Totals 3, Totals for all inspectors: Checking time 3,5h_ (work-hours) Average checking rate 917 (LOC/hour)

7 Logging No of people 7 Logging duration (hrs) 0,5 Logging time 3,5 (wkhrs) issues logged issues logged Improvement suggestions s of intent New items found in the meeting Logging rate _0,17_ (items/min) Detection-time _7h (wk-hrs) Logging-meeting rate _1000(LOC/h) Editing, follow-up and Exit No of major defects 3 No of minor defects _6 No of improvements 15 Efficiency of finding real bugs (defects/wk-hrs) 2,4

8 Inspection issue Log Item No Line No/ Location Type (circle) Check list/ Rule tag Desc-ription No of occurrence s Editor notes Turhat määrittelyt 2 26,36,4 3,45,56-59,63-65 Huono muuttujan nimi Static muuttujat Puuttuu tarkistus session olemassaolosta Voisi siirtää parempaan paikkaan, esim. DrawGUI Siirrettävä seuraavan ehdon perään, jolloin pip on varmasti validi. 122 rivillä on tarkistus eli sen jälkeen Tarkistus puuttuu Turha tarkistus ehdossa. Mikä pip on? pip_id, pip vai mikä? Eli huono nimi pip Siirrä parempaan paikkaan, esim. DrawGUI Subtotals: issues logged 2 issues logged 2 Improvement suggestions logged 6 s of intent logged

9 Inspection issue Log Item No Doc page Line No/ Location Type (circle) Check list/ Rule tag Desc-ription No of occurrences Editor notes Switch case olisi parempi rakenne Buttonit pitäisi disabloida Funktion nimi ei kuvaava Pitäisi validoida, että kentässä on varmasti jotain Turhia adopted_name on huono nimi, koska namea ei ole vielä tässä vaiheessa adoptoitu eli muutettu Stepit saatava dropdown listaan kannasta. Dropdown listat siirrettävä DrawGUIhin Turha else if Käytä valmista funktiota eikä byte taulukkoon lukemista. Tämä poistaa ongelman joka syntyy erilaisista merkistöistä. Subtotals: issues logged 1 issues logged 2 Improvement suggestions logged 7 s of intent logged

10 Inspection issue Log Document reference tag (version): ManagePIPProcess.aspx.cs Item No Doc page Line No/ Location Type (circle) Check list/ Rule tag Desc-ription No of occurrences Editor notes Turhia Response.Redirect server.transfer Try catch puuttuu 24 Koko koodi Kommentteja puuttuu ja tyhjät funktiot pois Subtotals: issues logged issues logged 2 Improvement suggestions logged 2 s of intent logged