5. Experior - rich test editor for FitNesse -
5.1. Forord Denne brukerveiledningen gir en oversikt over Experiors funksjonalitet og hvordan denne kan benyttes. Den kan gjerne leses i sammenheng med produktdokumentasjonen. Her er det beskrevet grunnleggende hva FitNesse er og hvordan det kan benyttes. Det forutsettes at leseren har grunnleggende kjennskap til dette, da det primært kun er Experiors funksjonalitet som beskrives i denne brukerveiledningen. Det forutsettes at brukeren er kjent med bruk av PC som verktøy. For å få utnyttet alt av Experiors funksjonalitet må nettleseren Mozilla Firefox benyttes. På FitNesse med Experior installert ligger på vedlagte CD. Det henvises til denne flere ganger i denne veiledningen, slik at denne CD-en vil være nyttig for å prøve ut Experiors funksjonalitet i praksis. Det henvises til installasjonsveiledningen for en beskrivelse av hvordan denne kan tas i bruk. 2
5.2. Innhold 5.1. Forord... 2 5.2. Innhold... 3 5.3. Funksjonalitet... 4 5.3.1.Åpning av test... 4 5.3.2.Lagring av test... 5 5.3.3.Redigering... 5 5.3.3.1. Angi klasse det skal testes mot... 5 5.3.3.2. Highlighting av metodenavn... 5 5.3.3.3. Oversikt over metoder... 6 5.3.3.4. Innsetting av metoder... 6 5.3.3.5. Utkommentering... 7 5.3.3.6. Nøkkelord... 8 5.3.3.7. Aligning av piper... 8 5.3.3.8. Automatisk oppdatering ved ny fixture-klasse... 10 5.4. Bruk av FitNesses eksisterende editor og Experior... 10 3
5.3. Funksjonalitet 5.3.1. Åpning av test Vinduet vist i figur 1 er standard for å vise innholdet i en test. Experior er tilgjengelig via menyen til venstre i FitNesse. Dersom du ønsker å redigere denne testen trykk på knappen som er markert med rødt rektangel for å åpne testen AddisjonTest i Experior. Figur 1: Trykk på knappen for å åpne testen i Experior Figur 2: Test åpnet i Experior 4
5.3.2. Lagring av test Du har to alternativer for å lagre en test. Figur 3: To alternativer for lagring av en test Ved trykk på knappen Save & exit vil testen lagres og du vil videresendes til vinduet vist i figur 1. Dersom du trykker på knappen Save vil Experior fortsatt være åpen, men testen vil lagres. 5.3.3. Redigering Du kan lime inn tekst skrevet utenfor Experior ved bruk av Ctrl+V. Tilsvarende kan du kopiere og klippe ut fra Experior med henholdsvis Ctrl+C og Ctrl+X. 5.3.3.1. Angi klasse det skal testes mot Experior tolker det som står på øverste linje som et klassenavn, navnet på fixture-klassen det skal testes mot. Du må skrive! eller! -, etterfulgt av klassenavnet, før linjen avsluttes med I produktdokumentasjonen er det beskrevet hvordan en slik fixture-klasse kan bygges opp. For enkelhets skyld er det vedlagt 3 slike ferdige klasser, slik at du kan prøve ut Experiors funksjonalitet. Navnet på disse er: no.bekk.boss.experior.testapp.fitnesse.fixtures.maindofixture2 no.bekk.boss.experior.testapp.fitnesse.fixtures.maindofixture no.bekk.boss.experior.testapp.fitnesse.fixtures.enkeldofixture 5.3.3.2. Highlighting av metodenavn Experior vil automatisk skrive alle metodenavn som finnes i klassen som står på øverste linje med blå farge og fet font, dersom disse er skrevet i testen. Dette skjer underveis mens du skriver, men kun dersom du trykker mellomromstasten eller enter. 5
Du må skrive hele metodenavnet ferdig før det vil få ny farge. Hvis du skriver kun tallene, og metoden heter tallene plus skal bli, vil ikke tallene bli fargelagt før du har skrevet hele navnet. Følgende måte å skrive metodenavn på vil aksepteres: tallene plus skal bli (med alle typer tegn før og etter) tallene <et tall eller tegn> plus <et tall eller tegn> skal bli <et tall eller tegn>, i ulike kombinasjoner. 5.3.3.3. Oversikt over metoder Til venstre i Experior vises en liste over tilgjengelige metoder i klassen det testes mot. Dette forutsetter at det på øverste linje er angitt et gyldig klassenavn (det vil si på den formen som er brukt i eksemplet), at klassen eksisterer, og at den inneholder en eller flere metoder. Figur 4: Oversikt over tilgjengengelige metoder Ved å føre musen over denne listen vil den utvides slik at hele metodenavnet kommer til syne på de metodene med lange navn. 5.3.3.4. Innsetting av metoder Dersom du ønsker å gjøre bruk av metoder fra denne listen, kan dette gjøres uten at du må skrive metodenavnet inn selv. Plasser markøren der du vil at 6
metodenavnet skal settes inn og trykk med musen på ønsket metodenavn. Det vil da settes inn der markøren står. Det vil skrives med! foran og etter navnet, som da betyr at dette er starten på en ny tabell. I tillegg vil det automatisk bli gitt korrekt farge. 5.3.3.5. Utkommentering Du kan kommentere ut hele eller deler av en linje, og flere linjer samtidig. Disse vil da ikke tas med dersom du velger å kjøre testen. For å kommentere ut en enkelt linje brukes tegnet #. Se figur 5. Figur 5: Utkommentering av linjer For å kommentere ut flere linjer samtidig brukes tegnene {{{ og }}}. Se figur 6. Figur 6: Flere linjer kommentert ut samtidig Kommentarer markeres med grønn farge. Som for metodenavnene vil de ikke skifte farge før du har trykket mellomromstasten eller enter. 7
5.3.3.6. Nøkkelord Hvis du skriver ett eller flere av FitNesses nøkkelord reject, show og check, vil disse skrives med fet font og burgunder farge. Som for metodenavn og kommentarer vil di ikke skifte farge før du har trykket mellomromstasten eller enter. 5.3.3.7. Aligning av piper Som nevnt i produktdokumentasjonen bygges tabeller opp ved hjelp av piper, d.v.s. tegnet. Eksempel på en tabell (dataene har ingen betydning de er kun med for illustrasjonens skyld):! formidlet postering oppdragsdato postert belop produktkode produktelement 11.03.2008 3900 682 34 11.03.2008 350 682 34 12.03.2008 50000 730 34 Experior tilbyr her støtte i form av automatisk aligning av disse pipene. Dette gjøres etter følgende mønster/regler: Første linje er metoden som testes, og i dette tilfellet tabelloverskriften siden linjen starter med!. Pipene på denne linjen påvirkes ikke av posisjonene til pipene på linjene under i samme tabell. Experior sørger for at pipene fra linje to og nedover i hver tabell plasseres under hverandre ved åpning av en test. Eksempel: Tabellen ser opprinnelig slik ut i FitNesses egen editor:! formidlet postering oppdragsdato postert belop produktkode produktelement 11.03.2008 3900 682564757676757 34 Ved åpning i Experior vil den se slik ut:! formidlet postering oppdragsdato postert belop produktkode produktelement 11.03.2008 3900 682564757676757 34 Legg spesielt merke til kolonnen produktkode, hvor verdien tar større plass enn kolonneoverskriften. Aligningen skjer korrekt også her. 8
Ved et trykk på knappen Align (se figur 7) vil Experior automatisk sette alle piper i testen på korrekt sted. Dette gjøres etter samme mønster som ved åpning av testen. Figur 7: Bruk av knappen Align Hver tabell alignes individuelt. Følgende tolkes som starten på en ny tabell: - En eller flere linjers mellomrom. Eksempel: Figur 8: Ny tabell ved en eller flere linjers mellomrom - Tabellen starter med!. Eksempel: Figur 9: Ny tabell med! Dersom du skriver en pipe på tastaturet vil denne automatisk plasseres på riktig sted. Eksempel: Du har skrevet følgende tabell:! formidlet postering oppdragsdato postert belop produktkode produktelement 11.03.2008 Markøren står nå plassert etter 8-tallet på line tre, og du skal skrive en pipe. Denne vil nå automatisk plasseres korrekt: oppdragsdato postert belop produktkode produktelement 11.03.2008 9
Markøren flytter seg nå til etter den nye pipen. Dersom forrige linje ikke inneholder piper, eller markøren befinner seg på første linje vil pipen plasseres der hvor markøren står. Dette vil også skje dersom du skriver en pipe på slutten av linjen, dersom antallet piper på forrige linje er mindre enn på nåværende linje. Eksempel:! formidlet postering oppdragsdato postert belop produktkode produktelement 11.03.2008 3900 682564757676757 34 5.3.3.8. Automatisk oppdatering ved ny fixture-klasse Experior vil automatisk detektere om det blir gjort endringer på øverste linje i testen, d.v.s. dersom det angis ny fixture-klasse som det skal testes mot. Endringene vil først bli registrert når du flytter markøren bort fra øverste linje. Når Experior registrerer at det har skjedd en endring vil oversikten over metoder på venstre side og highlightingen av metodenavn oppdateres for å stemme overens med metodene i den nye klassen. Dersom det som står på øverste linje ikke er et gyldig klassenavn, eller denne klassen ikke eksisterer vil highlighting av metodenavn fjernes og oversikten tømmes. Prøv det ut i fra eksemplet på vedlagte CD. Bytt mellom klassene no.bekk.boss.experior.testapp.fitnesse.fixtures.maindofixture2, no.bekk.boss.experior.testapp.fitnesse.fixtures.maindofixture og no.bekk.boss.experior.testapp.fitnesse.fixtures.enkeldofixture for å se hva som skjer i praksis. 5.4. Bruk av FitNesses eksisterende editor og Experior Tester som er skrevet i FitNesses eksisterende editor vil vises på tilsvarende måte i Experior som om testen var blitt skrevet der opprinnelig. På samme måte vil tester som er skrevet i Experior kunne vises redigeres på vanlig tradisjonell måte i FitNesses eksisterende editor. Dermed kan du gjøre bruk av Experiors funksjonalitet også i dine eksisterende tester. en gir en introduksjon til hvordan man kan utnytte Experiors funksjonalitet. Prøv det ut i praksis! 10
11