Suunnittelu. Sahara-ryhmä. Helsinki Ohjelmistotuotantoprojekti HELSINGIN YLIOPISTO Tietojenkäsittelytieteen laitos

Transkriptio

1 Suunnittelu Sahararyhmä Helsinki Ohjelmistotuotantoprojekti HELSINGIN YLIOPISTO Tietojenkäsittelytieteen laitos

2 Kurssi Ohjelmistotuotantoprojekti (6 ov) Projektiryhmä Sanna Keskioja Sampo Lehtinen Hanna Liedenpohja Seppo Syrjänen Asiakas Joni Salmi Johtoryhmä Juha Taina Kimmo Simola Kotisivu Versiohistoria Versio Päiväys Tehdyt muutokset Ensimmäinen versio. Dokumenttipohja. SS Järjestelmän yleiskuvauksen luonnos. XMLRPC mainitaan jo. SS Prototyypitluvun luonnostelu.ss Kattava sisällysluettelo: ensimmäinen versio/ss. Luokkia ja rajapintoja/hl Johdantoa ja arkkitehtuuria Arkkitehtuuri ja standardilukuja. Sovelluksen RPCkuvausta./SS Tietokantataulujen kuvausta./ss Tekstin editointia ja siivousta /SK

3 Sisältö i 1 Johdanto Dokumentin rakenne Termit Järjestelmän yleiskuvaus Laiteympäristö Ympäröivä järjestelmä Arkkitehtuuri Asiakasohjelma Sovelluspalvelin Tietokantapalvelin Algoritmit Yksilötapaaminen Ryhmätapaaminen Sopimukset ja standardit [?] Koodausperiaatteet Standardit Käytettävät pakkaukset Prototyypit Käyttäjäsovellus Käyttöliittymä Sovelluspalvelimen toteutus XMLRPCrajapinta Tietokannan toteutus Taulut Kirjastometodit 12 9 Luokkakuvaukset Kayttaja

4 ii haekayttaja() tarkistasahkoposti() tarkistasalasana() Kayttaja() poista() setetunimi() getetunimi() setsukunimi() getsukunimi() setsahkoposti() getsahkoposti() setsalasana() getsalasana() lisaaryhma() getryhmat() getsopivuudet() Ryhma Ryhma() poista() setnimi() getnimi() lisaaosallistuja() poistaosallistuja() getosallistujat() getosallistujienlkm() lisaaaikataulu() getaikataulut() Aikataulu Aikataulu() poista() setnimi() getnimi() settyyppi()

5 iii gettyyppi() setalkupvm() getalkupvm() setloppupvm() getloppupvm() settapaamisenkesto() gettapaamisenkesto() setviikonpaivat() getviikonpaivat() lisaatarjottuaika() gettarjotutajat() gettarjottujenaikojenlkm() laskeaikataulu() TarjottuAika TarjottuAika() poista() setalkuaika() getalkuaika() setloppuaika() getloppuaika() getsopivuudet() setosallistuja() getosallistuja() Sopivuus Sopivuus() poista() setsopivuusarvo() getsopivuusarvo() Tieto/luokkaluonnoksia Sekvenssikaaviot eri käyttötapauksista Testaussuunnitelma T

6 iv 11.1 Testauksen tavoitteet Testauksessa käytettävät apuvälineet Testivaiheet Yksikkötestaus/Luokkatestaus (ohtu) Integrointitestaus Järjestelmätestaus Hyväksymistestaus

7 1 Johdanto 1 Tanjajärjestelmän suunnitteludokumentti kuvaa yksityiskohtaisesti sekä täsmällisellä teknisellä tasolla miten järjestelmä toimii ja miten se toteutetaan vaatimusmäärittelydokumentin pohjalta. 1.1 Dokumentin rakenne Suunnitteludokumentin toisessa luvussa kuvataan Tanjajärjestelmän laiteympäristö sekä ympäröivä järjestelmä. Kolmannessa luvussa selostetaan ohjelmiston asiakasohjelmaan, sovelluspalvelimeen ja tietokantapalvelimeent perustuva kolmitasoarkkitehtuuri. Lisäksi kuvataan ohjelman toiminnan kannalta oleelliset algoritmit. Neljännessä luvussa käsitellään työssä käytettäviin työkalujen ja ohjelmointikieliin liittyvät sopimukset ja standardit sekä tässä työssä noudatettavat periaatteet niiden noudattamiseksi. Viidennessä luvussa kuvataan toteutettava käyttöliittymä ja kuudennessa luvussa sovelluspalvelimen toteutus. Seitsemännessä luvussa puolestaan käsitellään tietokannan toteutusta ja kahdeksannessa luvussa luetellaan käytettävät kirjastomenetelmät. Toteutettavassa ohjelmistossa käytettävien luokkien kuvaukset ovat yhdeksännessä luvussa ja sekvenssikaavit eri käyttötapauksista kymmenennessä luvussa. Lopuksi yhdennessätoista luvussa ovat ohjeet toteutuksen testauksen eri vaiheita varten. 1.2 Termit Suunnitteludokumentissa käytetyt termit. Uudet termit on ilmaistu +merkillä. CSV, Comma Separated Values, pilkkuerotetut arvot Tiedonsiirtomuoto, jota käytetään osallistujen tietojen tuontiin leikepöydän kautta esim. Kurkijärjestelmästä. Ehdotettu aikataulu Järjestelmän muodostama aikataulu, joka perustuu kutsujan kutsujan määrittelemiin aikataulun ominaisuuksiin ja osallistujien antamiin sopivuustietoihin. +Järjestelmä Tanjan ohjelmiston (asiakas ja sovelluspalvelin) sekä tietokannan muodostama toiminnallinen kokonaisuus. Kurkijärjestelmä Laitoksen kurssikirjanpitojärjestelmä. Kutsuja Henkilö, joka haluaa tavata muita henkilöitä eli osallistujia itselleen sopivina ajankohtina. Käyttäjä Kutsuja tai osallistuja, joka käyttää järjestelmää jollain käyttöliittymällä. Lopullinen aikataulu Kutsujan hyväksymä aikataulu, joko järjestelmän alun perin ehdottama aikataulu tai kutsujan itse muokkaama aikataulu.

8 Muokattu aikataulu Ehdotettu aikataulu, johon kutsuja on tehnyt haluamiaan muutoksia. +Ohjelmisto Tanjajärjestelmän sovellukset: asiakas ja sovelluspalvelin. Osallistuja Henkilö, jonka kutsuja haluaa tavata. Osallistujan sopivuudet kutsujan määritteleminä aikoina syötetään järjestelmään. +RPC (Remote Procedure Call) Sovellusteknikka, jossa sovelluksen eri osat suoritetaan verkon kautta saavutettavissa toisissa koneissa. Ryhmä Kutsujan määrittelemä kokonaisuus, joka sisältää osallistujat sekä yhden tai useampia aikatauluja. Ryhmätapaaminen Ryhmän yhteinen tapaaminen, johon mahdollisimman moni ryhmän osallistujista osallistuu. Sopivuus Osallistujan tapaamisajoille annettu sopivuusarvo, "prioriteetti". Arvot ovat "Sopii hyvin", "Sopii kohtalaisesti"ja "Ei sovi". Järjestelmä käyttää myös arvoa "Ei tietoa"kuvaamaan sitä, että tietyltä osallistujalta ei ole tiedossa sopivuutta kyseiselle ajankohdalle. +Sovellus Tanjajärjestelmän asiakas tai palvelinohjelma. Tapaaminen Osallistujalle tai ryhmätapaamiselle valittu aika. Tapaamisen kesto Kutsujan valitsema yhden tapaamisen kesto. Vaihtoehdot ovat 10, 20, 15, 30, 45, 60 tai 120 minuuttia. Tapaamisen tyyppi Yhteen aikatauluun kuuluvien tapaamisten tyyppi. Aikataulu voi olla tyypiltään ryhmätapaaminen tai yksilötapaaminen. Tarjottu aika Kutsujan määrittelemä yksittäinen ajankohta (aloitus ja lopetusaika), jolloin hän haluaa tavata ryhmänsä osallistujia. Tarjottu aika sijoittuu tiettyihin viikonpäiviin tiettynä aikataulun määrittelemänä viikkojaksona. Vanhentunut aikataulu Aikataulu, jonka viikkojakso on jo päättynyt, mutta jota ei vielä ole poistettu järjestelmästä. Viikkojakso Kutsujan kalenterista valitsemat viikot, joiden aikana ryhmän tietty aikataulu on voimassa. Yksilötapaaminen Tapaaminen, jossa kutsuja tapaa henkilökohtaisesti yhden osallistujan. +XML (extensible Markup Language) Metakieli rakenteellisen tiedon kuvaamiseen. +XMLRPC Hajautettuissa verkkosovelluksissa käytetty RPCtoteutus (Remote Procedure Call), jossa metodikutsut toteutetaan HTTPprotokollan avulla vaihdettavilla XMLdokumenteilla. Ks. 2

9 2 Järjestelmän yleiskuvaus 3 Järjestelmää kehitetään ensisijaisesti Helsingin yliopiston tietojenkäsittelytieteen laitoksen käyttöön asennettavaksi. Vaikka ohjelmointikielenä käytetään sinäällään järjestelmäriippumatonta Javaa, ei testausta suoriteta kuin varsinaisissa kohdejärjestelmissä (kts. arkkitehtuuri). 2.1 Laiteympäristö Käyttöliittymä kehitetään yhtäaikaisesti kolmelle laiteympäristölle. Windows, Linux ja OS X järjestelmille toteutetaan yksi kaikille yhteinen sovellus. Käyttöliittymäsovelluksen laiteympäristönä voi olla lähes mikä tahansa tietokone. Palvelinsovellus kehitetään ja testataan db.cs.helsinki.fi nimiseen koneeseen asennettua Linuxjärjestelmää käyttäen. Tämä ei tarkoita, etteikö sovellus voisi toimia muissa ympäristöissä, mutta muita laiteympäristöjä ei pidetä varsinaisina kehityksen kohteina. 2.2 Ympäröivä järjestelmä Käyttöliittymäsovellus tarvitsee toimiakseen Java Runtime Environment (versio 5.0 tai uudempi). Sovellus käynnistetään käyttäen Java Web Start tekniikkaa. Palvelinsovellus tarvitsee toimiakseen tietokannan (PostgreSQL), wwwpalvelimen (Apache/tomcat) ja Javan ajonaikaisen ympäristön (Java Runtime Environment versio 5.0 tai uudempi).

10 3 Arkkitehtuuri 4 Tanja koostuu kolmesta pääosasta: asiakasohjelmasta, sovelluspalvelimesta sekä tietokannasta. Asiakasohjelma keskustelee sovelluspalvelimen kanssa verkon yli. Asiakasohjelman ja sovelluspalvelimen välinen keskustelu tapahtuu XMLRPCrajapinnan mukaisilla viesteillä. Sovelluspalvelin tallettaa pysyvää talletusta kaipaavat tiedot tietokantaan. Sovelluksen logiikka (aikataulujen laskenta) sijaitsee sovelluspalvelimessa. Asiakasohjelma on pääasiassa käyttöliittymä sovelluspalvelimen tarjoamille palveluille. Asiakasohjelma osaa käsitellä käyttäjän antamaa CSVmuotoista tietoa osallistujien tietojen syöttämisessä. Sovelluspalvelin lähettää sähköpostia. Muita ulkosia yhteyksiä ei ohjelmistolla ole. Kuva 1: Tanjajärjestelmän arkkitehtuuri. paikasta; voidaan vaihtaa resurssi toiseen; kaikki kyselyt yhdessä paikassa 3.1 Asiakasohjelma Tanjan asiakasohjelma (jatkossa asiakas) on graafisella käyttöliittymällä varustettu Javaohjelma (sovelma tai Web Start sovellus), joka käynnistetään WWWselaimella. Sovellus voidaan ohjata haluttuun tilaan WWWosoitteen (+URI) perusteella. Asiakas keskustelee XMLRPCviesteillä verkon yli sovelluspalvelimen kanssa esimerkiksi käyttäjä ja aikataulutietojen pysyväistalletusta varten. Asiakas pitää yllä yhteyttä sovelluspalvelimeen keepaliveviesteillä, joiden avulla sovelluspalvelin voi myös tiedottaa asiakkaalle mahdollisista virhetilanteista. Käyttäjien (kutsuja ja kutsuttava) tunnistus suoran URI:n perusteella ja siirtyminen haluttuun tilaan toteutetaan asiakkaan käynnistämän WWWsivun avustuksella avulla (esim. JavaScript). 3.2 Sovelluspalvelin Sovelluspalvelimen tehtävä on toimia sovelluksen ytimenä sekä huolehtia asiakasohjelmien ja tietokannan välisen liikenteen välittämisestä. Se vastaanottaa ja validoi asiakkailta tulevat palvelupyynnöt sekä toteuttaa ne.

11 Sovelluspalvelimen muodostaminen tapaamisaikataulujen muodostaminen annettujen sopivuuksien perusteella on koko järjestelmän tarkoitus. Aikataulut talletetaan tietokantaan. Sovelluspalvelin pitää kirjaa järjestelmään kirjautuneista kutsujakäyttäjistä ja katkaisee edellisen yhteyden jos sama käyttäjä kirjautuu sisälle toiseen kertaan. Sovelluspalvelimena toimii db.cs.helsinki.fi ja se toteutetaan Javatekniikalla Tietokantapalvelin Tietokantapalvelimeksi kelpaa mikä tahansa nykyaikainen SQLpalvelin. Talletettavat tietomäärät eivät ole suuria eikä tehokkaiden hakujen toteuttaminen tuota ongelmia. Tanjaohjelmisto käyttää PostgreSQLtietokantaa. 3.4 Algoritmit Tässä kappaleessa kuvataan aikataulujen muodostamisessa käytettävät algorimit Yksilötapaaminen MWMB: Yksilöaikataulu lasketaan kaksijakoisen verkon painotetulla sovituksella (Maximum Weighted Matching in Bipartite Graphs). Algoritmista on valmiita toteutuksia myös Javakielellä, mutta ne vaatinevat jonkin verran muokkausta soveltuakseen Tanjan käyttöön Ryhmätapaaminen Triviaali: Ryhmäaikataulussa valitaan aika, joka sopii mahdollisimman monelle osallistujalle edes tasolla Sopii kohtalaisesti. Riittää siis laskea mikä aika on mainittu useimpien osallistujien sopivuuksissa. Jos useampi aika sopii osallistujille yhtä hyvin, valitaan ajoista ensimmäinen.

12 4 Sopimukset ja standardit [?] 6 Tässä osassa kuvataan sovelluksen toteutuksessa noudatettavat standardit ja käytännöt. 4.1 Koodausperiaatteet Koodauksessa noudatetaan seuraavia käytäntöjä: Koodin ja kommentien kieli on suomi seuraavin poikkeuksin: 1) käytettään vain kirjanmerkkejä az, 2) aksessorimetodit alkavat sanoilla get ja set. Kommentointi javadoctyylin mukaan. Luokkien nimet kirjoitetaan isolla alkukirjaimella, metodien ja muuttujien nimet pienellä alkukirjaimella. Sanat aloitetaan isolla kirjaimella. Muuttujat nimetään tietokannan attribuuttien mukaan. 4.2 Standardit SQLrelaatiotietokantojen määrittelystandardi kvkielikoodit maakoodit merkistöt XML? HTML? PHP? JavaScript/ ECMA script Javadoc SMPT??? Nyt en muista jäikö asiakkaan haluamiin vaatimuksiin mitään meilin lähetystä

13 7 4.3 Käytettävät pakkaukset Ohjelmistossa käytetään seuraavia pakkauksia: Kuvaus Nimi ja versio Pakkaus PostgreSQLtietokantayhteys JDBC pg74jdbc3.jar Asiakassovelluspalvelin yhteys (XMLRPC) Apache XmlRpc 2.0 xmlrpc2.0.jar Sähköpostin lähetys JavaMail x.x.x mail.jar Yksikkötestaustyökalu JUnit x.x.x junit.jar 4.4 Prototyypit Sovellus rakennetaan ja testataan vaiheittain eritasoisilla prototyypeillä. Aikataulunmuodostusalgoritmit: irrallinen Javasovellus, joka hakee syöttötietonsa tekstitiedostosta. Sovelluspalvelin: Perl/PHPproto, jolla sovellus pääsee keskustelemaan tietokannan kanssa. Tarjoaa mahdollisesti tietokannan selailun WWWselaimella. Korvataan Javaversiolla, joka huolehtii (osan) sovelluslogiikasta. Asiakasohjelma: graafinen ohjelma, jossa suunnilleen oikeat välilehdet, mutta jossa arvot annetaan hiirellä valitsemisen/merkkaamisen sijasta esim. tekstisyöttökentillä ja pudotusvalikoilla. Käyttöliittymä: irrallinen sovellus, jolla tutkitaan graafisen käyttöliittymän rakentamista ja tarvittavien komponenttien (kalenteritaulukot, hiirellä valitseminen jne.) toteutusta.

14 5 Käyttäjäsovellus 8 miten käyttäjälle näkyvä osa sovelluksesta (appletti, Web Start sovellus, webisivu) toimii sisäänkirjautumislinkin toteutus virhetilanteet 5.1 Käyttöliittymä Käyttöliittymän elementit on määritelty niin, että niistä voidaan tehdä uudempia ja/tai hienompia versioita ilman, että niiden rajapinta muun sovelluksen suuntaan muuttuu [ks. protoluku]. Kuva 2: Tanjajärjestelmän yleisrakenne. Kuva 3: Tanjajärjestelmään perustettavien ryhmien perustietosivu Kuva 4: Järjestelmään tallennettujen ryhmien osallistujien tietojen syöttö ja hallinnointi. käyttöliittymän rakenne virhetilanteet

15 9 Kuva 5: Järjestelmän laskeman aikataulun esitys ja muokkaussivu. 6 Sovelluspalvelimen toteutus Tanjaohjelmiston sovelluspalvelin (jatkossa palvelin) muodostaa tapaamisaikatauluja tietokantaan talletettujen tarjottujen aikojen ja niihin liittyvien sopivuustietojen perusteella. login/logout miten sovelluspalvelin kommunikoi käyttäjäsovelluksen ja tietokannan kanssa virhetilanteet 6.1 XMLRPCrajapinta Asiakkaan ja palvelimen välinen tiedonsiirto tapahtuu sovelluksen kannalta läpinäkyvästi XMLRPCprotokollalla siten, että osa asiakkaan metodikutsuista päätyy käytännössä lähettämään RPCpyynnön sovelluspalvelimelle. Asiakkaan metodia vastaa yksi yhteen palvelimen vastaava varsinaisen sovelluslogiikan tekevä metodi. Asiakas koodaa metodin parametrit, suorittaa metodikutsun ja jää odottamaan paluuarvoa ja purkaa sen sen saatuaan. Palvelin vastaanottaa kutsun, purkaa parametrit, toteuttaa pyynnön, paketoi paluuarvon ja lähettää vastauksen. määritellään vaihdettavat XMLRPCviestit sekä niiden sisällöt. tai todetaan mitkä rajapinnat/metodit toteutetaan XMLRPC:llä. Välitettävät viestit voivat kuvata sovelluksen eri abstraktiotasoja: Sisältö Selitys Sovelluslogiikka SQLlauseet Sovelluspalvelin on vain yhdyskäytävä tietokantaan. Mahdollinen Asiakasohjelmassa. protototeutus. Sovellus Sovellusluokkien get/setmetodit: ryhmät, aikataulut, osallistujat. Palvelimessa. Käyttöliittymä Käyttöliittymäluokkien get/setmetodit: välilehdet, luettelot, näytöt, tekstikentät. Palvelimessa. Tanjajärjestelmä toteutetaan käyttöliittymätason RPCkutsuilla eli itse sovelluslogiikka sijaitsee sovelluspalvelimessa. Toteutettavien luokkien/metodien yhteydessä mainitaan onko kyseessä RPCrajapinnan asiakas vai palvelintoteutus. virhetilanteet

16 7 Tietokannan toteutus 10 tietokantakaaviot 7.1 Taulut Taulut on nimetty yksikkömuotoon (KAYTTAJA, RYHMA). [HUOM: Pidetäänkö kenttänimet kokonaan yksikäsitteisinä vai onko jokaisen idkenttä nimeltään id ]. Merkintä =tbl:f tarkoittaa eheystarkistusta taulun tbl kentän f kanssa eli että tämä kenttä voi saada vain arvoja, jotka esiintyvät taulun tbl kentässä f. Toteutetaan CONSTRAINTmääreellä kentän luontivaiheessa: kid int constraint ryhma_kayttaja_id_check references kayttaja(kid) Aikaleimojen Datetyyppi toteutetaan PostgreSQL:n timestamp with time zone tyypillä. Taulu KAYTTAJA Käyttäjien tiedot kid serial Tietokannan generoima juokseva yksikäsitteinen tunniste. Asetetaan halutuksi näin: select setval( kayttaja_kid_seq,372). etunimi varchar sukunimi varchar sposoite varchar Sähköpostiosoite. salasana varchar uusisalasana varchar Asetettu, jos salasanaa ollaan vaihtamassa, muuten NULL. viimkaytto date Viimeisin käyttöaika. Päivitetään kun [tarvitaan tarkka lista!] käyttäjä loggaa sisälle, käyttäjän tiedot muuttuvat tai kun käyttäjälle määritellään sopivuuksia. Taulu RYHMA Ryhmien tiedot rid serial Juokseva tunniste. rnimi varchar Ryhmän nimi. kid =kayttaja:kid Ryhmän kutsuja. viimkaytto date Viimeisin käyttöaika. Päivitetään kun ryhmän aikatauluja päivitetään? Taulu OSALLISTUMINEN Ryhmiin osallistuminen kid =kayttaja:kid Käyttäjä kid osallistuu ryhmään rid. rid =ryhma:rid viimkaytto date Viimeisin käyttöaika. TARVITAANKO? Voidaanko edes päivittää?

17 Taulu AIKATAULU Aikataulujen tiedot aid serial Juokseva tunniste. rid =ryhma:rid Ryhmä, johon aikataulu liittyy. viikonpaivat varchar Koodataan viikonpäivälista merkkijonoksi: alkupvm date Viikkojakson alku. loppupvm date Viikkojakson loppu. tap_pituus int Minuutteja. tap_tyyppi int 1=Yksilötapaaminen, 2=Ryhmätapaaminen. viimkaytto date Viimeinen käyttöaika. Päivitetään kun aikatauluja lasketaan. Taulu TARJOTTU Tarjotut ajat aid =aikataulu:aid Aikataulu, johon tarjotut ajat kuuluvat. kid =kayttaja:kid Aika varattu ko. käyttäjälle, NULL (tai 0) jos vapaa. Eheystarkistus ei ehkä onnistu koska NULL on sallittava. alkuaika date Tarjotun ajan alku. loppuaika date Tarjotun ajan loppu. Näiden erotus on tapaamisen pituus. viimkaytto date Päivitetään milloin? Taulu SOPIVUUS Sopivuudet aid =aikataulu:aid Aikataulu, jonka sopivuuksia käyttäjälle kid kerrotaan. kid =kayttaja:kid alkuaika date Sopivuus alkaa tähän aikaan. loppuaika date Sopivuus loppuu tähän aikaan. Näiden väliin jää aikaväli, joka jaketaan aikataulusta saatavan tap_pituuskentän mukaisiksi paloiksi, joille muodostetaan aikataulu. sopivuus int Sopivuusarvo 03. viimkaytto date Viimeisin käyttöaika. Päivitetään milloin? Taulu POHJA Viestipohjat aid =aikataulu:aid Aikataulu, jonka viestipohjia muokataan. tyyppi int Arvot: 1=kutsu, 2=kutsuotsikko, 3=ilmoitus, 4=ilmoitusotsikko. teksti varchar(1000) Pohjateksti. viimkaytto date Viimeisin käyttöaika. Miten päivitetään? Taulu TILA Ohjelman tila kid =kayttaja:kid Käyttäjän kid edellinen näkymä sovelluksessa. tila int Käyttöliittymän näytön tunnusnumero. Taulu YHTEYS Käyttäjän yhteys sovellukseen kid =kayttaja:kid Käyttäjän kid istunnon aktiivisuus. login date Milloin istunto on alkanut. Jos sisääntullessa löydetään uudempi kuin [MÄÄRITELTÄVÄ] X istunto, heitetään edellinen ulos. 11

18 8 Kirjastometodit 12 tämä ehkä tulee muualta 9 Luokkakuvaukset Tässä luvussa esitellään luokat ja niiden tarjoamat palvelut. [LISÄÄ TEKSTIÄ TÄHÄN esim nimeämisestä] Palvelut on kuvattu seuraavassa muodossa: palvelunnimi() Kuvaus palvelun toiminnasta. nimi tyyppi arvojoukko Tyyppi (paluuarvon kuvaus) Palveluun liittyvät poikkeustilanteet 9.1 Kayttaja Käyttäjä voi olla kutsuja tai osallistuja. [LISÄÄ KUVAUSTEKSTIÄ] haekayttaja() Staattinen metodi, joka hakee tietyn Kayttajaolion parametrinä annetun sähköpostiosoitteen perusteella. sahkoposti String määritelty vaatimuksissa Kayttaja (haettu Kayttajaolio, jos ei löydy niin Null) sähköpostiosoitteella ei löydy käyttäjää tarkistasahkoposti() Staattinen metodi, joka tarkistaa, että annettu sähköpostiosoite on oikean muotoinen. sahkoposti String määritelty vaatimuksissa

19 13 boolean (true, jos osoite oikean muotoinen, muuten false) tarkistasalasana() Staattinen metodi, joka tarkistaa, että annettu salasana on oikean muotoinen. salasana String määritelty vaatimuksissa boolean (true, jos osoite oikean muotoinen, muuten false) Kayttaja() Konstruktori, joka luo uuden Kayttajaolion. öntä konstruktoria ei ole, koska kaikki parametrinä annettavat attribuutit ovat pakollisia. Metodi tarkistaa ensin, että sähköpostiosoite ei ole vielä käytössä. etunimi String sukunimi String sahkoposti String määritelty vaatimuksissa salasana String määritelty vaatimuksissa Kayttaja (uusi Kayttajaolio tai Null, jos olion luominen ei onnistu) Sähköpostiosoite on jo käytössä eivät oikean muotoisia poista() Poistaa Kayttajaolion. boolean (true, jos poisto onnistui, muuten false)

20 setetunimi() Asettaa tai vaihtaa käyttäjän etunimen. etunimi String void getetunimi() Hakee käyttäjän etunimen. String (käyttäjän etunimi) setsukunimi() Asettaa tai vaihtaa käyttäjän sukunimen sukunimi String void getsukunimi() Hakee käyttäjän sukunimen String (käyttäjän sukunimi)

21 setsahkoposti() Asettaa tai vaihtaa käyttäjän sähköpostiosoitteen. Sähjöpostiosoitteen kelvollisuus tarkistetaan metodilla tarkistasahkoposti(). [HUOM Miten toimitaan sähköpostiosoitteen kuittausviestin kanssa salasanan vaihdossa?] sahkoposti String määritelty vaatimuksissa void getsahkoposti() Hakee käyttäjän sähköpostiosoitteen. String (käyttäjän sähköposti) setsalasana() Asettaa tai vaihtaa käyttäjän salasanan. Salasanan kelvollisuus tarkistetaan metodilla tarkistasalasana(). salasana String määritelty vaatimuksissa void getsalasana() Hakee käyttäjän salasanan. String (käyttäjän salasana)

22 lisaaryhma() Lisää käyttäjälle (kutsuja) uuden ryhmän. [HUOM nimellä tai ilman] nimi String Ryhma (uusi ryhmä) ei voi lisätä ryhmiä jos käyttäjä ei kutsuja getryhmat() Hakee käyttäjän ryhmät. Collection [? TARKISTA] (kokoelma Ryhmaolioita) ei ryhmiä jos käyttäjä vain osallistuja? tai palauttaa tyhjän kokoelman? tehdäänkö eri metodit kutsujan ja osallistujien ryhmien hakuun? getsopivuudet() Hakee käyttäjän sopivuudet tietyssä aikataulussa. aikataulu Aikataulu Collection [? TARKISTA] (kokoelma Sopivuusolioita) 9.2 Ryhma Ryhmien ylläpitotoimet yms [LISÄÄ KUVAUSTEKSTIÄ]

23 Ryhma() Konstruktori, joka luo uuden Ryhmaolion. [HUOM Kuormitetaan? Tehdään sekä tyhjä konstruktori sekä konstruktori, jossa annetaan ryhmän nimi parametrinä, koska nimi ei ole pakollinen attribuutti ryhmän luonnissa.] nimi String Ryhma (uusi Ryhmaolio) voidaan luoda myös nimetön ryhmä poista() Poistaa Ryhmaolion ja siihen kuuluvat Aikatauluoliot. boolean (true, jos poisto onnistui, muuten false) setnimi() Asettaa tai vaihtaa ryhmän nimen. nimi String void getnimi() Palauttaa ryhmän nimen. String (ryhmän nimi)

24 lisaaosallistuja() Lisää osallistujan ryhmään. Ennen osallistujan lisäämistä metodi tarkistaa, löytyykö sähköpostiosoitteella jo Kayttajaolio Tanjajärjestelmästä ja jos ei löydy, luo osallistujaa varten uuden Kayttajaolion. etunimi String sukunimi String sahkoposti String määritelty vaatimuksissa Kayttaja (lisätty osallistuja) osallistuja on jo ryhmässä [HUOM ei tehdä mitään?] kutsuja lisää itsensä ryhmään [HUOM ok?] poistaosallistuja() Poistaa osallistujan ryhmästä. Samalla poistetaan osallistujan sopivuudet ryhmän aikatauluissa. osallistuja Käyttäjä boolean (true, jos poisto onnistui, muuten false) getosallistujat() Hakee ryhmän osallistujat. Collection [? TARKISTA] (kokoelma Kayttajaolioita)

25 getosallistujienlkm() Hakee ryhmän osallistujien lukumäärän. int (osallistujien lukumäärä) lisaaaikataulu() Lisää ryhmälle aikataulun. [HUOM Kuormitetaanko: nimi tai ilman nimeä] nimi String Aikataulu (uusi aikataulu) getaikataulut() Hakee ryhmän aikataulut. paluuarvo Collection [? TARKISTA] (kokoelma Aikatauluolioita) 9.3 Aikataulu Aikataulun ylläpito ja käsittely, laskenta yms [LISÄÄ KUVAUSTEKSTIÄ] Aikataulu() Konstruktori, joka luo uuden Aikatauluolion.[HUOM Kuormitetaan? Tehdään sekä tyhjä konstruktori sekä konstruktori, jossa annetaan aikataulun nimi parametrinä, koska nimi ei ole pakollinen attribuutti aikataulun luonnissa.] nimi String

26 20 Aikataulu (uusi Aikatauluolio) voidaan luoda myös nimetön aikataulu poista() Poistaa Aikatauluolion ja siihen liittyvät TarjottuAika ja Sopivuusoliot. boolean (true, jos poisto onnistui, muuten false) setnimi() Asettaa tai vaihtaa aikataulun nimen. nimi String Palauttaa true/false? getnimi() Palauttaa aikataulun nimen. String (aikataulun nimi) settyyppi() Asettaa tai vaihtaa aikataulun tyypin (yksilö tai ryhmätapaaminen).

27 21 tyyppi int 1 tai 2 tms [HUOM tarkista] Palauttaa true/false? ei voi vaihtaa kun aikataululla on olemassa sopivuuksia gettyyppi() Palauttaa aikataulun tyypin. String (aikataulun tyyppi) setalkupvm() Asettaa tai vaihtaa aikataulun viikkojakson alkupäivän. alkupvm Date alkupvm >= tänään AND alkupvm <=loppupvm boolean (true jos muutos onnistui, muuten false) ei voi vaihtaa kun aikataululla on olemassa sopivuuksia getalkupvm() Palauttaa aikataulun viikkojakson alkupäivän. Date (viikkojakson alkupäivä)

28 setloppupvm() Asettaa tai vaihtaa aikataulun viikkojakson loppupäivän. loppupvm Date alkupvm >= tänään AND alkupvm <=loppupvm boolean (true jos muutos onnistui, muuten false) ei voi vaihtaa kun aikataululla on olemassa sopivuuksia getloppupvm() Palauttaa aikataulun viikkojakson loppupäivän. Date (viikkojakson loppupäivä) settapaamisenkesto() Asettaa tai vaihtaa aikataulun tapaamisten keston. kesto int määritelty vaatimuksissa void ei voi vaihtaa kun aikataululla on olemassa sopivuuksia gettapaamisenkesto() Palauttaa aikataulun tapaamisten keston. int (tapaamisen kesto)

29 setviikonpaivat() Asettaa tai vaihtaa aikataulun viikonpäivät. viikonpaivat int [MÄÄRITELTÄVÄ] void ei voi vaihtaa kun aikataululla on olemassa sopivuuksia getviikonpaivat() Palauttaa aikataulun viikonpäivät. int (viikonpäivät) lisaatarjottuaika() Lisää aikatauluun kutsujalle sopivan tarjotun ajan. alkuaika Date [MÄÄRITELTÄVÄ miten osuu oikealle aikavälille?] loppuaika Date [MÄÄRITELTÄVÄ] TarjottuAika (uusi tarjottu aika) gettarjotutajat() Hakee kaikki aikataulun tarjotut ajat Collection (kokoelma TarjottuAikaolioita)

30 gettarjottujenaikojenlkm() Hakee tarjottujen aikojen lukumäärän, jotta sitä voidaan käyttöliittymässä verrata ryhmän osallistujamäärään. int (tarjottujen aikojen lukumäärä) laskeaikataulu() Laskee osallistujien sopivuusarvojen perusteella optimaalisen aikataulun. (HUOM Yhdistää tarjotun ajan tietyyn osallistujaan?] Collection (kokoelma TarjottuAikaolioita, joihin on lisätty viite johonkin osallistujaan) 9.4 TarjottuAika Tarjotun ajan ylläpito ja käsittely. [HUOM miten tarjottu aika määritellään, koska se on joka viikko samaan aikaan? ei voi käyttää päivämääriä?] TarjottuAika() Konstruktori, joka luo uuden TarjottuAikaolion. alkuaika Date loppuaika Date TarjottuAika (uusi TarjottuAikaolio) jos tarjottu aika ei sisälly kalenterin viikkojaksoon?

31 poista() Poistaa TarjottuAikaolion ja siihen liittyvät Sopivuusoliot. boolean (true, jos poisto onnistui, muuten false) setalkuaika() Asettaa tai vaihtaa tarjotun ajan alkuajan. alkuaika Date [TARKISTA] void getalkuaika() Palauttaa tarjotun ajan alkuajan. Date (tarjotun ajan alkuaika) setloppuaika() Asettaa tai vaihtaa tarjotun ajan loppuajan. loppuaika Date [TARKISTA] void

32 getloppuaika() Palauttaa tarjotun ajan loppuajan. Date (tarjotun ajan loppuaika) getsopivuudet() Palauttaa tiettyyn tarjottuun aikaan annetut sopivuudet. Collection [? TARKISTA] (kokoelma Sopivuusolioita) setosallistuja() Liittää tarjottuun aikaan osallistujan, jolloin tarjotusta ajasta tulee tapaaminen. osallistuja Kayttaja joku Käyttäjäolio, joka on ryhmän osallistuja void getosallistuja() Palauttaa tiettyyn tarjottuun aikaan liitetyn osallistujan. Kayttaja (tarjottuun aikaan liitetty osallistuja)

33 Sopivuus Sopivuuden ylläpito ja käsittely Sopivuus() Konstruktori, joka luo uuden Sopivuusolion. sopivuusarvo int määritelty vaatimuksissa Sopivuus (uusi Sopivuusolio) poista() Poistaa Sopivuusolion. boolean (true, jos poisto onnistui, muuten false) setsopivuusarvo() Asettaa tai vaihtaa sopivuuden sopivuusarvon. sopivuusarvo int boolean (true, jos onnistui, muuten false) getsopivuusarvo() Palauttaa sopivuuden sopivuusarvon nimen.

34 28 int (sopivuusarvo) 9.6 Tieto/luokkaluonnoksia käyttäjänhallinta login login.uri register ryhmät add delete properties osallistujat add delete properties csvimport line separator sopivuus add delete aikataulut add delete invite. properties calculate display edit sort notify. näytön tila getstate setstate

35 10 Sekvenssikaaviot eri käyttötapauksista 29 Kuvataanko käyttötapaukset sekvenssikaavioina?

36 11 Testaussuunnitelma 30 Tanjaohjelmisto testataan tässä dokumentissa kuvatulla tavalla. Kuinka testataan, mitä välineitä käytetään, testausstrategia (yksikkö, integraatio, järjestelmä, hyväksymistestaus). Kuvataan testitapaukset, henkilöstö, laitteisto ja menettelytavat. Mitä testataan, osaalueisiin jako Mikä on hyväksyttävä testitulos Vastuuhenkilö, kuka hyväksyy Selkeä maininta mitä ei testata Jokaisessa testitapauksessa: syöte ja odotettu tulos Miten ja kenelle virheistä raportoidaan T estitapausluokka < testitapaus (= pienin testattava osa, yksittäinen testi) Testitapausten luokittelu esim. tärkeysjärjestyksessä (1,2,3...), vakavuusluokittain (A,B,C...) tai tyypeittäin (esim. a palvelinvirhe, b tietokantavirhe, c clientvirhe) Luokittelu myös esim: toiminnalliset, eitoiminnalliset, oletetut tavanomaiset käyttötapaukset, virhetilanteet, rajaarvotilanteet Avuksi tilasiirtymäkaavio tai sekvenssikaavio. Myös näyttökartta Testauksen tavoitteet Testauksen tavoitteena on varmistua siitä, että valmistuva ohjelmisto toimii virheettömästi ja toteuttaa sille asetetut vaatimukset (kuvattu vaatimusdokumentissa). Menettelytavat: Jako: mitä tapahtuu missäkin + käyttäjäryhmittäin Käytetään samaa numerointia kuin vaatimusdokumentissa (jatka samaa numerointia myös testausraportissa!) Testaussuunnitelmaan numero + testitapauksen nimi Testausraportissa testin numero ja testitapaus Virheanalyysi: Milloin virhe tehtiin Mitä tehtiin väärin Miten virhe olisi voitu estää Miksei virhettä havaittu aiemmin Miten virhe olisi voitu havaita aiemmin

37 31 Miten virhe havaittiin => Tavoitteena ymmärtää miten tuotantoprosessia tulee muuttaa jottei virhettä toistettaisi. Testausraportin muoto riippuu testaussuunnitelmasta esim. kynällä täytettävä, wwwlomake jne.(esimerkki: Testauksessa käytettävät apuvälineet Eclipse JUnit RITA? 11.3 Testivaiheet Testataan toiminnalliset vaatimukset (määrittelydokumentista) Muut (eitoiminnalliset vaatimukset) Mitä ohjelma ei saa tehdä Yksikkötestaus/Luokkatestaus (ohtu) Matalimman tason testausta. Siinä testataan yksittäisiä luokkia tai ryppäitä (clusters). Luokka testataan lähettämällä luokan metodeille yksi kerrallaan viestejä (kutsumalla niitä). Luokka testataan metodiensa kautta. Pelkkä yksittäisten metodien kutsuminen ei riitä kun luokan metodeilla on keskinäisiä riippuvuuksia. (Kokeiltava eri tiloja vaihtelemalla metodien kutsujärjestystä). Yliluokat: Luokka on kokoelma sille määriteltyjä ja sen yliluokilta perimiä metodeja ja attribuutteja > pelkkä aliluokan metodien käyttö testauksessa ei välttämättä riitä (koska aliluokan metodit voivat muuttaa perittyjen yliluokan metodien toimintaa muuttamalla olioiden tiloja.) Mahd. ratkaisu: litistetään luokka eli otetaan testattavaksi luokaksi yhdistelmä aliluokasta ja sen perimistä kaikista yliluokista => Voi olla kallista jos syvä perintähierarkia! Milloin luokkaa voi testata:1) Kun se on kirjoitettu valmiiksi ja siihen on integroitu metodit. 2) Luokassa ei ole testausta estäviä isoja virheitä. Luokan valmistelu testausta varten: 1) Yksinkertaiset luokat: kootaan metodit yhteen (Small Pop kokoaminen) 2) Monimutkaiset ja ehkä isoja virheitä sisältävät luokat Alfa Omega syklillä. AlfaOmega sykli: Jokaiselle oliolle voidaan määritellä 2 virtuaalitilaa (alfa ja omega) Alfa: olion tila juuri ennen sen luontia Omega: olion tilaa heti sen tuhoamisen jälkeen.

38 AOsyklissä suoritetaan savutesti suorittamalla jokainen sen metodi ainakin kerran. Jos sykli menee läpi, olion katsotaan olevan testauskelpoisessa kunnossa. whitebox: kukin koodirivi vähintään kerran kaikki haaraumat testataan silmukat: ei kertaakaan, kerran, normaali, maksimi, kerran yli maksimin Integrointitestaus usein sulautuu joko yksikkötestaukseen tai järjestelmätestaukseen. blackbox: rajapinnat Järjestelmätestaus käyttöliittymän kautta Hyväksymistestaus Asiakkaan kanssa vaatimusdokumentin opastamana.