Gebruikershandleiding Avans Hogeschool Academie voor Industrie & Informatica augustus 2006, versie 1.00 (met dank aan Erol Demircan & Hakan Yildirim)
Inhoudsopgave 1. Inleiding... 3 2. Nieuw account aanmaken... 4 3. Beheer door een manager van het project... 5 3.1 Projectleden toevoegen... 5 3.2 Categorieën aanmaken... 5 4. Bugs invoeren... 7 4.1 Een bug invoeren... 7 4.2 Status van een bug wijzigen... 9 (Met dank aan Erol Demircan & Hakan Yildirim) pag. 2
1. Inleiding Mantis is een Open Source Bug Tracking System (BTS), dat sinds augustus 2006 op het programmeernetwerk van de Academie voor Industrie & Informatica draait ter ondersteuning aan projectgroepen binnen de Informatica-opleiding die software ontwikkelen. Mantis is gebaseerd op PHP en MySQL. Mantis is bereikbaar via de URL http://practicum.aii.avans.nl/mantis/. In deze (korte) handleiding wordt beschreven hoe studenten (en docenten) toegang kunnen krijgen tot Mantis, wat er minimaal aan beheerswerkzaamheden door een projectgroep gedaan moet worden om tot bug tracking te kunnen overgaan, en tenslotte wordt kort iets verteld over het invoeren en opvolgen van bugs. De informatie is tamelijk summier, maar zou voldoende moeten zijn om een start te kunnen maken met bug tracking op basis van Mantis. Voor meer informatie wordt verwezen naar de online documentatie (kies voor Docs->User Documentation als je een maal ingelogd bent) of kijk op http://manual.mantisbt.org/. Het beheer en onderhoud van Mantis wordt verzorgd door het systeembeheer van AI&I (B207). Mocht je op- of aanmerkingen hebben, dan stellen we het op prijs als je die doorgeeft aan B207. (Met dank aan Erol Demircan & Hakan Yildirim) pag. 3
2. Nieuw account aanmaken Een gebruiker moet zich registreren om gebruik te kunnen maken van Mantis. Voor de registratie moet de gebruiker zijn email account van het programmeernetwerk gebruiken. Deze ziet eruit als jjansen@aii.avans.nl. De emails afkomstig van Mantis worden verstuurd naar de Exchange Server op het programmeernetwerk (en dus niet naar het Avans studentenmail-account). De URL van de Exchange Server is http://student.aii.avans.nl/exchange/, en inloggen daarop doe je met je gegevens van het programmeernetwerk. Klik op Sign up for a new account om een nieuw account aan te maken in het inlogscherm. Typ je gebruikersnaam van programmeernetwerk in bij het veld username en je emailadres van de Exchange Server (jjansen@aii.avans.nl) bij Email. Gebruik s.v.p. geen andere accounts of email-adressen, want deze kunnen zonder berichtgeving worden opgeruimd, en bovendien kun je daar geen mail mee ontvangen vanuit de Exchange Server van het programmeernetwerk. Klik op Signup. Nadat je op Signup hebt geklikt, wordt er een mail verstuurd naar het opgegeven emaladres met daarin een link om je account te activeren. Vervolgens kun je een wachtwoord kiezen waarmee je in kunt loggen in Mantis. Het is handig om hiervoor hetzelfde wachtwoord te gebruiken als voor het programmeernetwerk. (Met dank aan Erol Demircan & Hakan Yildirim) pag. 4
3. Beheer door een manager van het project Als je als projectgroep software ontwikkelt waarbij je gebruik wilt maken van bug tracking m.b.v. Mantis, moet je aan systeembeheer (B207) melden om welke projectgroep het gaat en moet 1 van de groepsleden opgegeven worden als manager van het project. Systeembeheer zal een bijbehorend Mantis-project aanmaken en het opgegeven groepslid, dat volgens de stappen in paragraaf 1 al een Mantis-account aangemaakt moet hebben, als beheerder markeren voor dit project. Deze beheerder dient vervolgens een aantal acties uit te voeren om ervoor te zorgen dat ook de andere groepsleden toegang krijgen tot het Mantis-project en hij/zij dient het Mantis-project verder in te richten. PS: Voorafgaand aan de acties in deze paragraaf dienen alle projectgroepleden die toegang tot het Mantis-project moeten krijgen, volgens de stappen van paragraaf 1 een Mantis-account aangemaakt te hebben, voor zover zij daar nog niet over beschikten. 3.1 Projectleden toevoegen Om een gebruiker toe te voegen aan het project moet de beheerder, manager of administrator de volgende stappen uitvoeren: Klik op Manage in de menubar. Klik op het betreffende project. Selecteer bij Username de gebruikersnaam die u wilt toevoegen aan het project. Selecteer bij Access Level het toegangsrecht die de gebruiker mag hebben. Hier is het aan te raden om Developer te kiezen voor de projectleden. Als Developer heeft een projectlid voldoende rechten om de benodigde taken uit te kunnen voeren. Klik vervolgens op Add User om de gebruiker toe te voegen. 3.2 Categorieën aanmaken Om een bug toe te voegen heb niet per sé een categorie nodig, maar het is wel handig. Door bugs in categorieën te verdelen maak je de bugs overzichtelijker voor de gebruikers. Je kunt b.v. de modules die binnen het software-project een rol spelen als categorieën opvoeren. Klik op Manage in de menubar. Klik op het betreffende project. (Met dank aan Erol Demircan & Hakan Yildirim) pag. 5
Typ een naam voor de betreffende categorie. De categorienaam moet duidelijk maken met welk onderdeel van het project de betreffende categorie overeenkomt. Klik op Add Category om de categorie toe te voegen. (Met dank aan Erol Demircan & Hakan Yildirim) pag. 6
4. Bugs invoeren Nadat je ingelogd bent kom je automatisch in de My View pagina. Op deze pagina zie je een overzicht van het project met o.a. recent veranderde items. 4.1 Een bug invoeren Om een bug in te voeren kies je uit het hoofdmenu de optie Report Issue. Je krijgt dan het volgende scherm te zien. Je dient het het betreffende project op te geven (evt. kiezen als je toegang tot meerdere projecten hebt), en je hebt ook nog de mogelijkheid om de gewenste project als standaard project in te stellen. Wanneer je een project als standaard hebt opgegeven, zie je in het vervolg dit scherm niet meer wanneer je op Report Issue klikt. Nadat je op Select Project geklikt hebt zie je het volgende scherm (tenzij je geen standaard project hebt aangegeven): (Met dank aan Erol Demircan & Hakan Yildirim) pag. 7
De velden die verplicht ingevuld moeten worden zijn aangegeven met een rode ster ervoor. Het gaat om de velden: Summary en Description. De velden hebben de volgende betekenis: Category (categorie): kies de categorie waar de bug onder valt. Hier kun je kiezen uit de categorieën die in stap 2.2. zijn aangemaakt. Reproducibility (reproduceerbaarheid): Hoe vaak gebeurt het? Hoe makkelijk is de fout na te botsen. Je kunt kiezen uit de volgende opties: o always: is op vaste manier te reproduceren o sometimes: treedt soms op o random: lijkt op willekeurige momenen op te treden o have not tried: nog niet geprobeerd o not able to reproduce: kan niet gereproduceerd worden o N/A: niet van toepassing (not applicable) Severity (ernst): de ernst van een probleem. Je kunt kiezen uit de volgende opties, die in ernst toenemen o feature: beschrijft eigenlijk geen probleem maar een feature van de software o trivial: onbelangrijk o text: tekst is niet correct o tweak: minder belangrijk o minor: niet onbelangrijk, maar er is een alternatieve actie o major: belangrijk, er is geen alternatieve actie o crash: het product crasht o block: verhindert het uitleveren van de software Priority (prioriteit): de voorkeur/snelheid waarmee een bug moet worden opgelost. De keuzes lopen in prioriteit op van none (niet) tot immediate (direct). Summary (samenvatting): een korte omschrijving (1 regel) van het probleem (Met dank aan Erol Demircan & Hakan Yildirim) pag. 8
Description (omschrijving): een langere omschrijving van het probleem. Probeer zo duidelijk mogelijk te zijn in de formulering, maar probeer het tegelijkrtijd ook kort & krachtig te houden. Additional Information (extra info): extra informatie m.b.t. het probleem. Denk b.v. aan een omschrijving van de stappen (menuopties, input, knoppen) die nodig zijn om de bug te reproduceren. (Daar is eigenlijk ook een apart veld voor, maar daar moet je de Advanced Report view voor inschakelen). Upload file: biedt de mogelijkheid om een file (b.v. een screendump, een errorlog of een configuratie-file) dat bij de bug hoort, te uploaden. De laatste twee velden View Status en Report Stay zijn wat minder belangrijke velden. We verwijzen je naar het Mantis documentatie mocht je er meer over willen weten. Door op Submit Report te klikken wordt de bug in het systeem vastgelegd. Je krijgt dan een scherm te zien dat het invoeren is geluk, en na enkele seconden wordt je doorgelinkt naar het View Issues scherm. In het View Issues scherm worden alle bugs getoond binnen het project die nog niet gesloten zijn. 4.2 Status van een bug wijzigen Het stadium waarin een bug verkeert, wordt vastgelegd in een status-veld. In de loop van de tijd zal de status dan ook regelmatig gewijzigd worden. De verschillende statussen worden door middel van verschillende kleuren aangegeven door Mantis. Een legenda van deze kleuren wordt steeds onderaan de getoonde pagina weergegeven. Mantis gebruikt 6 statussen, waarvan de volgende 5 de belangrijkste zijn: New: een nieuw aangemelde bug waarmee nog niets is gedaan. Feedback: feedback vragen aan iemand. De feedback kan worden toegvoegd als een Note. Assigned: de bug is toegewezen aan een projectlid. Resolved: de bug is opgelost. Hierbij moet in het veld Resolution de status gekozen worden. (Met dank aan Erol Demircan & Hakan Yildirim) pag. 9
Closed: een bug is volledig afgehandeld. Hierbij moet in het veld Resolution de status gekozen worden. Mocht later blijken dat het afsluiten van de bug onterecht was, dan moet de bug heropend worden. De andere 2 statussen zijn acknowledged en confirmed, maar deze zullen i.h.a. wat minder gebruikt worden. Als je meer informatie over deze statussen wilt krijgen, raadpleeg dan de de documentatie van Mantis. (Met dank aan Erol Demircan & Hakan Yildirim) pag. 10