TIM-tulostuksen järjestelmätestaussuunnitelma

Yleistä

Projektiryhmä:

• Marja Similä, projektipäällikkö, marja.j.k.simila@student.jyu.fi
• Topi Latva-Salo, varaprojektipäällikkö, topi.h.latva-salo@student.jyu.fi
• Miika Kujala, miika.m.kujala@student.jyu.fi
• Tuomas Porvali, thetupo26@gmail.com

Tekijöiden lisäksi muita projektiorganisaation henkilöitä:

• Jukka-Pekka Santanen, vastaava ohjaaja
• Mika Lehtinen, tekninen ohjaaja
• Vesa Lappalainen, tilaajan edustaja

Avainsanat: Sovellusprojekti, TIM, The Interactive Material, CSS, TeX, Testaussuunnitelma, Järjestelmätestaus.

Sähköpostilistat: timantti@korppi.jyu.fi

Tiivistelmä

Timantti-projektin järjestelmätestaussuunnitelmassa kuvataan projektissa kehitetyn tulostussovelluksien testitapaukset ja testausympäristö. Järjestelmätestauksella varmistetaan, että TIMiin toteutetut TeX-tulostus ja CSS-tulostus toimivat vaatimusten mukaisesti. Testauskerrat suoritetaan dokumentissa kuvattujen testitapausten mukaisesti.

Muutoshistoria

1 Testattava sovellus

Timantti-projekti on Jyväskylän yliopiston informaatioteknologian tiedekunnalle suoritettava sovellusprojekti. Projektin tavoitteena on jatkokehittää TIM-oppimisympäristöä (The Interactive Material) lisäämällä siihen TIM-dokumentin tulostaminen. Projektissa kehitettäviä tulostustapoja on kahdenlaisia: TeX-tulostus ja CSS-tulostus. Kolmas tulostustapa ns. Advanced CSS on sovittu projektin jälkeiseen jatkokehitykseen. Koska tätä tulostustapaa ei toteuteta Timantti-projektissa, sen testitapauksia ei ole sisälletty dokumenttiin.

1.1 TeX-tulostus

TeX-tulostuksessa TIM-dokumentin markdown-muoto käännetään LaTeX- ja edelleen PDF-muotoon. Tulostustavassa hyödynnetään Pandoc-nimistä ohjelmaa, joka kääntää dokumentin toiselle merkintäkielelle. Tulostussovellus saa pyynnön käyttäjältä, jolloin ensin tarkistetaan, onko käännetty dokumentti jo palvelimella ja tarvittaessa käännetään TIM-dokumentti haluttuun muotoon pandocilla.

1.2 CSS-tulostus

CSS-tulostuksessa hyödynnetään selaimen omaa tulostustoimintoa. Tulostustapaa on kuvattu niin sanotuksi halpatulostamiseksi, koska se ei hyödynnä mitään resursseja TIM-palvelimella ja sen laadun ei tarvitse olla painokelpoista. CSS-tulostukseen on kirjoitettu uusi tulostamista varten tehty CSS-tyyliohje, joka sisältää korjauksia ja parannuksia olemassa olevaan pohjaan. CSS-tulostukseen on kehitetty uusia toimintoja parantamaan tulostuksen laatua.

1.3 Termit ja lyhenteet

Termit lyhenteet löytyvät projektisuunnitelmasta

(https://tim.jyu.fi/view/kurssit/tie/proj/2017/timantti/dokumentit/projektisuunnitelma).

2 Testauksen suorittaminen

Projektin aikainen testaus on jatkuvaa yksilötestausta, jossa kukin projektin jäsen varmistaa oman työnsä minimitoiminnallisuuden. Yksilötestaus ei korvaa tässä dokumentissa kuvattuja järjestelmätestauksen testitapauksia. Järjestelmätestauskseen osallistuvat projektin ryhmän jäsenet.

2.1 Testattavat ominaisuudet

Testaus rajataan TeX- ja CSS- tulostustapoihin kehitettyihin ominaisuuksiin.

TeX-tulostuksen yhteydessä testataan kehitetty käyttöliittymä, jossa käyttäjä voi valita TeX-pohjan. TIM-järjestelmässä on TeX-pohjatiedostoja, mutta käyttäjä voi tehdä oman TeX-pohjan tai valita muun aikaisemman tehdyn TeX-pohjan.

CSS-tulostustapaan on kehitetty muutamia ominaisuuksia. CSS-asetuksista testataan kommenttien piilottaminen ja kappeleiden sovitus sivulle. CSS-tulostusta on syytä testata usealla verkkoselaimella, koska CSS-tyyliohjeet ei välttämättä näytä tismalleen samanlaiselta kaikilla verkkoselaimilla. TeX-tulostuksessa ei ole tätä ongelmaa, koska TeX on suunniteltu alustariippumattomaksi.

2.2 Järjestelmätestaus

Järjestelmätestauksessa tulostusta testataan loppukäyttäjän näkökulmasta. Testauksella varmistetaan vaatimusten mukainen tulostustoiminta ja virheettömyys.

2.3 Testausympäristö

Testauskerrat suoritetaan yliopiston tarjoamilla resursseilla. Kaikki testitapaukset ajetaan testauspalvelimella. osoiteessa http://timg.it.jyu.fi/.

Projektiryhmän tietokoneisiin on asennettu Windows 10 käyttöjärjestelmä, sekä viisi yleisintä verkkoselainta: Chrome 58, Opera 45, FireFox 53, Internet Explorer 11 ja Microsoft Edge 38. Applen Safari-verkkoselainta testataan Mac-tietokoneelta. Apple on lakkauttanut Safari-tuen vanhoille Mac-koneille ja muille käyttöjärjestelmille, eikä edes enää tarjoa vanhaa versiota Safarista.

2.4 Testattavat dokumentit

Testauksessa hyödennetään allaolevia dokumentteja, jotka kattavat kaikki testitapaukset.

2.5 Testitapauksien johtopäätökset

Kunkin testitapaukseen kirjoitettaan allaolevilla johtopäätöksillä:

• Ok: Ei puutteita tai virheitä havaittu. Eikä tehty huomioita.
• Huomautus: Testitapausksen läpikäynti onnistui, mutta havaintoja kirjattiin.
• Virhe: Testitapauksen läpikäynti ei onnistunut virheiden tai puutteiden takia.

3 CSS-testitapaukset

CSS-tulostuksen testitapaukset käydään läpi usealla verkkoselaimella.

3.1 Kommentit tulosteeseen

Kuvaus: Avatussa TIM-dokumentissa on kommentteja tai käyttäjä on lisännyt niitä. Hän haluaa kommentit tulosteeseen.

Läpikäynti:

• Avataan customize TIM.
• Asetuksista valitaan CSSprint_eiKommentteja -valintalaatikko.
• Palataan dokumenttiin.
• Avataan TIM-dokumentti verkkoselaimen tulostusesikatselunäkymään.

Lopputila: Tulostettava dokumentti sisältää kommentteja.

Huomautus: Jos tulostettavaan dokumenttiin palataan selaimen paluu painikkeella, niin on TIM-dokumentti päivitettävä painamalla näppäintä F5.

3.2 Kappaleen sovitus sivulle

Kuvaus: Käyttäjä haluaa, että kappaleet ovat samalla sivulla.

Läpikäynti:

• Avataan customize TIM.
• Asetuksista valitaan CSSprint_sovitus -valintalaatikko.
• Palataan dokumenttiin.
• Avataan TIM-dokumentti verkkoselaimen tulostusesikatselunäkymään.

Lopputila: Tulostettavassa dokumentissa halki menevät kappaleet ovat sovitettu seuraavalle sivulle.

Huomautukset: Jos tulostettavaan dokumenttiin palataan selaimen paluu painikkeella, niin on TIM-dokumentti päivitettävä painamalla näppäintä F5.

3.3 Oletustyyliasetusten lataaminen ja muokkaaminen

Kuvaus: Käyttäjä haluaa muokata tulostustyyliasetuksia.

Läpikäynti:

• Avataan customize TIM.
• Klikataan Add Print Settings -painiketta. Tekstikenttään ilmestyy asetuksia, joita voi muokata.
• Muutetaan asetuksia esimerkiksi otsikon kokoa ja kappaletekstin fonttia.
• Klikataan Save custom CSS -painiketta.
• Palataan dokumenttiin.
• Avataan TIM-dokumentti verkkoselaimen tulostusesikatselunäkymään.

Lopputila: Uudet asetukset toimivat, ja niiden vaikutus näkyy vain tulosteessa.

Huomautukset:

• Jos TIM-dokumenttiin palataan selaimen paluu-painikkeella, niin on TIM-dokumentti päivitettävä painamalla näppäintä F5.
• Uuden CSS-koodin kirjoittaminen ei kuulu testitapaukseen.

3.4 Automaattisen sivunvaihdon muutokset

Kuvaus: Automaattinen sivunvaihto toimii itsenäisesti, eikä vaadi käyttäjältä toimenpiteitä. Sen pääasiallinen tehtävä on estää otsikoiden esiintyminen ennen sivun vaihtoa. Toiminto aktivoituu, kun verkkoselain valmistautuu tulostamaan. Ennen esitulostusnäkymän avautumista se tekee muutoksia TIM-dokumentin dokumenttioliomalliin. Kun dokumentti on lähetetty tulostimelle tai käyttäjä peruttaa tulostuksen, niin tehdyt muutokset otetaan pois.

Läpikäynti:

• Avataan TIM-dokumentti verkkoselaimen tulostusnäkymään.
• Perutaan tai hyväksytään tulostus. Valinnalla ei ole väliä.
• Hyödynnetään verkkoselaimen Inspect-työkalua. Inspect Käynnistään painamalla näppäintä F12.
• Varmista, oettä kaikki par-luokan oliot eivät ole noBreak-luokan sisällä.

Lopputila: TIM-dokumentin dokumenttioliomalli on ei ole muuttunut tulostamisen takia.

Huomautukset: Testitapauksen suorittaminen vaatii verkkoselaimen Inspect-työkalun käyttöä.

3.5 Automaattinen otsikoiden sijoitus seuraavalle sivulle

Kuvaus: Automaattinen sivunvaihto toimii itsenäisesti, eikä vaadi käyttäjältä toiminpiteitä. Sen pääasiallinen tehtävä on estää otsikoiden esiintyminen ennen sivun vaihtoa. Toiminto aktivoituu, kun verkkoselain valmistautuu tulostamaan. Ennen esitulostusnäkymän avautumista se tekee muutoksia TIM-dokumentin dokumenttioliomalliin. Kun dokumentti on lähetetty tulostimelle tai käyttäjä peruttaa tulostuksen, niin tehdyt muutokset otetaan pois.

Läpikäynti:

• Avataan TIM-dokumentti verkkoselaimen tulostusnäkymään.
• Tarkistetaan, että otsikot eivät ole yksin tulostetun sivun lopussa.

Lopputila: Tulostetussa dokumentissa otsikot eivät ole sivun lopussa yksin.

3.6 Sivunvaihdon asettaminen

Kuvaus: TIMin editorilla voi sijoittaa dokumenttiin pakollisia sivunvaihtoja käsin.

Läpikäynti:

• Avataan tekstikappale TIMin editoriin tai luodaan uusi tekstikappale.
• Editorista valitaan Insert-välilehti ja klikataan Page Break-painiketta.
• Tallennetaan muutokset.
• Avataan TIM-dokumentti verkkoselaimen tulostusesikatselunäkymään.

Lopputila: TIM-dokumentiin on asetettu sivunvaihto.

3.7 Ei tyhjää etusivua

Kuvaus: Tulostettavan dokumentin ensimmäinen sivu ei ole tyhjä.

Läpikäynti: TIM-dokumentti avataan verkkoselaimen tulostuksen esikatselunäkymään.

Lopputila: Tulostetussa dokumentissa ensimmäinen sivu ei ole tyhjä. Yksinään olevat tason 1 otsikot ja kappaleet ovat hyväksyttäviä.

3.8 Usean sivun mittaiset koodiliitännäiset

Kuvaus: TIM-dokumentissa on usean sivun mittaisia koodiliitännäisiä.

Läpikäynti:

• Lisätään dokumentin asetuksiin asetus.
• Avataan usean sivun mittaisia koodiliitännäisiä sisältävä TIM-dokumentti verkkoselaimen tulostusesikatselunäkymään.

Lopputila: Tulostetussa dokumentissa liitännäisen sisältö ei katoa sivunvaihdossa.

Huomautus: Alla olevalla asetuksella muutetaan editorit pre-elementiksi tulostamisen helpottamiseksi.

global_plugin_attrs:
    all:
     cssPrint: true

3.9 Hyperlinkki tulostuu vain kerran.

Kuvaus: TIM-dokumentissa on hypelinkkejä. Ne tulostuvat vain kerran.

Läpikäynti: Avataan hyperlinkkejä sisältävä TIM-dokumentti verkkoselaimen tulostusesikatselunäkymään.

Lopputila: Tulostetussa dokumentissa hypelinkit tulostuvat vain kerran

4 TeX-testitapaukset

Testitapaukset käydään läpi vain yhdellä verkkoselaimella. Mikä ei ole tarpeen suorittaa verkkoselaimella, koska TeX-tulostustoiminta tapahtuu TIM-palvelimella.

4.1 TIM-dokumentin kääntäminen PDF:ksi

Alkutila: TIMiin on jo kirjauduttu, ja tulostettava dokumentti on avattu verkkoselaimeen.

Kuvaus: TIM-dokumentti käännetään PDF:ksi käyttäen oletuspohjaa.

Läpikäynti:

• Asetukset-välilehdestä käyttäjä klikkaa Print Document-painiketta.
• Avautuvasta ikkunasta valitaan runko-vaihtoehto.
• Valitaan PDF.
• Klikataan Create-painiketta.
• Käyttöliittymään ilmestyy linkki PDF-dokumentiin.

Poikkeukset: Käännösvirheistä tulee virheilmoitus.

Lopputila: TIM-dokumentista on muodostettu PDF-dokumentti.

Huomautus: Dialogi muistaa käyttäjän valinnan.

4.2 TIM-dokumentin kääntäminen LaTeX:ksi

Alkutila: TIMiin on jo kirjauduttu, ja tulostettava dokumentti on avattu verkkoselaimeen.

Kuvaus: TIM-dokumentti käännetään LaTeXiksi.

Läpikäynti:

• Asetukset-välilehdestä käyttäjä klikkaa Print Document-painiketta.
• Valitaan LaTeX.
• Klikataan Create-painiketta.
• Käyttöliittymään ilmestyy linkki LaTeX-dokumentiin.

Lopputila: TIM-dokumentista on muodostettu LaTeX-dokumentti.

4.3 Toipuminen yhteyden katkosta

Alkutila: TIMiin on jo kirjauduttu, ja tulostettava dokumentti on avattu verkkoselaimeen. Dokumentista ei ole luotu PDF-tiedostoa aikaisemmin.

Kuvaus: Tarkoituksena on testata toipuminen yhteyden katkoksesta, mitä loppukäyttäjän työasemalla tapahtuu ja miten palvelin reagoi.

Läpikäynti:

• Asetukset-välilehdestä käyttäjä klikkaa Print Document-painiketta.
• Avautuvasta ikkunasta valitaan runko-vaihtoehto.
• Valitaan PDF.
• Klikataan Create-painiketta ja samantien verkkokaapeli irrotetaan koneesta.
• Yhteys palaa noin 10 sekunnin kuluttua takaisin.

Lopputila: TIM-dokumentista on muodostettu PDF-dokumentti, joka avautuu käyttäjälle. Ilmoitus yhteyden katkeamisesta näytetään käyttäjälle.

4.4 Liitännäinen palauttaa oletustulostusmuodon markdownissa

Alkutila: Tulostettavassa TIM-dokumentissa on liitännäisiä.

Kuvaus: Kaikki liitännäiset antavat itsestään oletustulostusmuodon markdownissa. Tulosteessa ei pitäisi näkyä liitännäisiä tai niistä on virheilmoitusdokumentissa. Tämä ei koske koodiliitännäisiä tai monivalintakysymysliitännäisiä.

Läpikäynti:

• Asetukset-välilehdestä klikataan Print Document-painiketta.
• Avautuvasta ikkunasta valitaan runko-vaihtoehto.
• Valitaan PDF.
• Klikataan Create-painiketta.
• Käyttöliittymään ilmestyy linkki PDF-dokumentiin.

Lopputila: Suurimman osan liitännäisien kohdalla ei pitäisi näkyä mitään. Tämä ei koske koodiliittännäistä.

Huomautukset: Liitännäisten oletustulostusmuotojen kehittäminen ei kuulu projektiryhmän tehtäviin.

4.5 Koodiliitännäinen palauttaa oletustulostusmuodon markdownissa

Alkutila: Tulostettavassa TIM-dokumentissa on koodiliitännäinen.

Kuvaus: Koodiliitännäisestä luodaan markdown-muoto, kun TIM-dokumentti käännetään Pandocilla PDF-muotoon.

Läpikäynti:

• Asetukset-välilehdestä klikataan Print Document-painiketta.
• Avautuvasta ikkunasta valitaan runko-vaihtoehto.
• Valitaan PDF.
• Klikataan Create-painiketta.
• Käyttöliittymään ilmestyy linkki.

Lopputila: Koodiliitännäinen on dokumentissa oikein.

Huomautukset: Liitännäisen oletustulostusmuoto ulkoasu löytyy tästä dokumentista: https://tim.jyu.fi/view/kurssit/tie/proj/2017/timantti/pluginien-ulkoasu.

4.6 Käännösvirheistä ilmoittaminen

Alkutila: Tulostettavassa TIM-dokumentissa on virheitä.

Kuvaus: TIM-dokumentissa sisältävistä ongelmista ilmoitetaan.

Läpikäynti:

• Asetukset-välilehdestä käyttäjä klikkaa Print Document-painiketta.
• Avautuvasta ikkunasta valitaan runko-vaihtoehto.
• Klikataan PDF-painiketta.
• Virheistä ilmoitetaan.

Lopputila: Kääntämisestä ilmenneistä virheistä on ilmoitettu käyttäjälle.

4.7 Kääntäminen epäonnistuu täysin

Kuvaus: TIM-dokumentin kääntämisen epäonnistumisesta ilmoitetaan.

Läpikäynti:

• Asetukset-välilehdestä käyttäjä klikkaa Print Document-painiketta.
• Avautuvasta ikkunasta valitaan runko-vaihtoehto.
• Klikataan PDF-painiketta.
• Ikkunaan tulee ilmoitus dokumentin kääntämisen epäonnistumista.

Lopputila: Kääntämisen epäonnistumisesta on ilmoitettu käyttäjälle.

4.8 Uuden tulostuspohjan luominen

Alkutila: TIMiin on kirjauduttu.

Kuvaus: Luodaan uusi tulostuspohja TeX-tulostustukseen.

Läpikäynti: Käyttöohjeen mukaisesti: Tulostuksen käyttöohje: 1.2.4 Templaten eli tulostuspohjan luominen

Lopputila: Uusi pohja on luotu.

4.9 Käyttäjän syötteen käyttäminen liitännäisissä

Kuvaus: TIM-dokumentissa on liitännäisiä, joihon käyttäjä on kirjoittanut omaa sisältöä ja haluaa ne tulosteeseen.

Läpikäynti:

• Asetukset-välilehdestä käyttäjä klikkaa Print Document-painiketta.
• Avautuvasta ikkunasta valitaan default-vaihtoehto.
• Valitaan Show user answers in plugins.
• Valitaan PDF ja klikataan Create -painiketta.

Lopputila: Käännetyssä dokumentissa koodilohkoissa on käyttäjän syöte.

5. Testauskertojen raportointi ja -tuloksien koostaminen

Testitapaukset ajetaan testipalvelimella timg.it.jyu.fi

Verkkoselaimista käytetään seuraavia lyhenteitä:

• C: Chrome 58
• MZ: Mozilla Firefox 53
• IE: Internet Explorer 11
• ME: Microsoft Edge 38
• O: Opera 45
• S: Safari 10

5.1 TIM CSS-tulostuksen ominaisuuksien testaus

5.2 Testauskerran raportointi

Testauskerroista kirjoitettaan raportti, joka sisältää testaajan nimen, päivämäärän, versionumero käytetystä testaussuunnitelmasta.

Suoritetuista testitapauksista kirjoitetaan taulu. Ensimmäiseen sarakkeeseen kirjoitetaan testitapaukset ja niiden vastaaville riveille testauksen tulokset ja havainnot.

All on esimerkki taulu CSS:n testitapauksista.

7. Yhteenveto

Testauksessa tullaan löytämään mahdollisia häiriöitä ja puutteita ja varmistamaan, että asetetut vaatimukset täyttyvät, sekä CSS-tulostus ja TeX-tulostus toimivat. Testaus suoritetaanmustalaatikko järjestelmätestauksena.