Západočeská univerzita v Plzni Fakulta aplikovaných věd Katedra informatiky a výpočetní techniky. a konfigurace domén validačního serveru

Za´padoˇceska´ univerzita v Plzni Fakulta aplikovanyćh vˇed Katedra informatiky a vy´poˇcetn´ı techniky

Bakal´ aˇ rsk´ a pr´ ace Z´ asuvn´ e moduly a konfigurace dom´ en validaˇ cn´ıho serveru

Plzeˇ n 2012

Hung Duong Manh

Prohl´ aˇ sen´ı Prohlaˇsuji, ˇze jsem bakaláˇrskou práci vypracoval samostatnˇe a v´ yhradnˇe s pouˇzit´ım citovan´ ych pramen˚ u. V Plzni dne 6. kvˇetna 2012 Hung Duong Manh

Abstrakt Tato práce popisuje, jak vytváˇret zásuvné moduly a validaˇcn´ı domény na validaˇcn´ı server pouˇz´ıvan´ ym Západoˇceskou univerzitou v Plzni. V prvn´ı ˇca´sti je struˇcnˇe popsán validaˇcn´ı server, jeho webové rozhran´ı, studentské u ´lohy KIV/OOP a jak lze vytváˇret pravidla do PMD. Druhá ˇcást se zab´ yvá samotn´ ym vytváˇren´ım extern´ıch modul˚ u a posledn´ı ˇcást popisuje, jak jsou nakonfigurovány validaˇcn´ı domény KIV/OOP ve webovém rozhran´ı.

Abstract This thesis describes how to create plugins and validation domains for the validation server used by University of West Bohemia. The first part briefly addresses the validation server, its web interface, student assignments for the course KIV/OOP and how to write a new PMD rule. The second part is a guide on how to create validation server plugins and the last part describes how KIV/OOP validation domains are configured in the web interface.

Podˇ ekov´ an´ı Rád bych podˇekoval doc. Ing. Pavlu Heroutovi, Ph.D. za smˇerován´ı mé ˇcinnosti a Ing. Lukáˇsovi Valentovi a Bc. Veronice Dudové za ochotu mi s ˇc´ımkoliv pomoci a poradit.

Obsah ´ 1 Uvod

1

2 Teoretick´ yu ´ vod 2.1 Validaˇcn´ı server . . . . . . . . . . . . . . . . . . . . . . . . 2.1.1 Pˇr´ıstup na validaˇcn´ı server . . . . . . . . . . . . . . 2.1.2 Adresáˇrová struktura validaˇcn´ıho serveru . . . . . . 2.1.3 Restartován´ı validaˇcn´ıho serveru . . . . . . . . . . . 2.2 Webové rozhran´ı validaˇcn´ı serveru . . . . . . . . . . . . . . 2.2.1 Adresáˇrová struktura webového rozhran´ı . . . . . . 2.2.2 Restartován´ı webového rozhran´ı . . . . . . . . . . . 2.3 Testovac´ı kopie validaˇcn´ıho serveru s webov´ ym rozhran´ım . 2.4 KIV/OOP – Pˇredmˇet objektovˇe orientované programován´ı 2.4.1 JUnit testy . . . . . . . . . . . . . . . . . . . . . . 2.4.2 Porovnáván´ı obrázk˚ u . . . . . . . . . . . . . . . . . 2.4.3 Kontrola UML diagramu tˇr´ıd . . . . . . . . . . . . 2.5 PMD – statická anal´ yza kódu . . . . . . . . . . . . . . . . 2.5.1 Vytvoˇren´ı pravidla Java tˇr´ıdou . . . . . . . . . . . 2.5.2 Vytvoˇren´ı pravidla pomoc´ı XPath . . . . . . . . . . 3 Z´ asuvn´ e moduly pro valid´ ator 3.1 Custom validace . . . . . . . . . . . . . . . . 3.1.1 Vytvoˇren´ı custom validace v Eclipse 3.1.2 Zprovoznˇen´ı custom validace . . . . . 3.2 Extern´ı vlastn´ı akce . . . . . . . . . . . . . . 3.2.1 Vytvoˇren´ı extern´ı vlastn´ı akce . . . . 3.2.2 Zprovoznˇen´ı extern´ı vlastn´ı akce . . . 3.3 Zásuvné moduly pro KIV/OOP . . . . . . . 3.3.1 Porovnán´ı dvou obrázk˚ u . . . . . . . 3.3.2 Pouˇzit´ı custom validace . . . . . . . 3.4 Knihovna pro kontrolu UML diagram˚ u . . .

. . . . . . . . . .

. . . . . . . . . .

. . . . . . . . . .

. . . . . . . . . .

. . . . . . . . . .

. . . . . . . . . .

. . . . . . . . . .

. . . . . . . . . .

. . . . . . . . . . . . . . .

2 . 2 . 3 . 3 . 4 . 5 . 5 . 6 . 6 . 7 . 8 . 8 . 9 . 11 . 12 . 15

. . . . . . . . . .

17 17 18 20 23 23 26 28 28 30 31

. . . . . . . . . .

4 Validaˇ cn´ı dom´ eny pro 4.1 Kl´ıˇcové u ´lohy . . . ´ 4.2 Ulohy s kolekcemi . 4.3 JUnit u ´loha . . . .

KIV/OOP 35 . . . . . . . . . . . . . . . . . . . . . . . . 35 . . . . . . . . . . . . . . . . . . . . . . . . 38 . . . . . . . . . . . . . . . . . . . . . . . . 39

5 Z´ avˇ er

40

Literatura

42

Webov´ e zdroje

43

A Uk´ azka custom validace

44

B Uk´ azka extern´ı vlastn´ı akce

47

C CD Readme

52

´ 1 Uvod Na Katedˇre informatiky a v´ ypoˇcetn´ı techniky Fakulty aplikovan´ ych vˇed Západoˇceské univerzity byl vytvoˇren komplexn´ı systém umoˇzn ˇuj´ıc´ı automatizované, ˇci poloautomatizované vyhodnocován´ı studentsk´ ych samostatn´ ych prac´ı. ˇ kontroluje tzv. vaPrincipem je, ˇze práce odevzdané pˇres Portál ZCU lidaˇcn´ı server. Tento validaˇcn´ı server postupuje podle naprogramovan´ ych krok˚ u a pokud odevzdan´ y soubor neprojde validac´ı, nen´ı studentská práce pˇrijata. Doposud si validaˇcn´ı server vystaˇcil s jednoduchou metodou kontroly – porovnán´ım v´ ystupu programu se vzorov´ ym textov´ ym souborem. Avˇsak s ohledem na moˇznosti validaˇcn´ıho serveru a moˇzn´ ym budouc´ım vyuˇzit´ım je tˇreba ˇreˇsit i dalˇs´ı metody kontroly. Takové kontroly mohou napˇr´ıklad zahrnovat spouˇstˇen´ı jednotkov´ ych test˚ u, porovnáván´ı grafického v´ ystupu ˇci kontrolu UML diagram˚ u, pˇr´ıpadnˇe obecnˇe jakoukoliv programovatelnou uˇcitelskou kontrolu. Pro validaˇcn´ı server bylo také novˇe vytvoˇreno webové uˇzivatelské rozhran´ı, ˇ adn´ které mˇelo za u ´kol zjednoduˇsit práci s konfigurac´ı validátoru. Z´ y aktivn´ı pˇredmˇet vˇsak dosud nemˇel svoj´ı validaˇcn´ı doménu vytvoˇrenou v tomto webovém rozhran´ı. C´ılem práce je vytvoˇren´ı validaˇcn´ıch domén pro pˇredmˇet OOP ve webovém rozhran´ı, coˇz bude bráno jako pilotn´ı projekt pro budouc´ı vyuˇzit´ı konfigurace validaˇcn´ıho serveru v dalˇs´ıch pˇredmˇetech. Práce dále pˇredpokládá vytvoˇren´ı nˇekolika nov´ ych zásuvn´ ych modul˚ u pˇr´ımo pouˇziteln´ ych pro kontrolu v´ ystup˚ u studentsk´ ych prac´ı. K tomu je tˇreba vyuˇz´ıt vˇsech jiˇz existuj´ıc´ıch moˇznost´ı validaˇcn´ıho serveru.

1

2 Teoretický u´vod 2.1

Validaˇ cn´ı server

Jak´ ykoliv studijn´ı pˇredmˇet, ve kterém je tˇreba odevzdat samostatnou práci ˇ Tento zp˚ elektronicky, m˚ uˇze vyuˇz´ıt moˇznost odevzdáván´ı pˇres Portál ZCU. usob odevzdáván´ı samostatn´ ych prac´ı má mnoho v´ yhod, nás vˇsak hlavnˇe zaj´ımá moˇznost kontrolovat odevzdávané soubory pˇres validaˇcn´ı server. T´ım, ˇze se soubory kontroluj´ı validaˇcn´ım serverem, se zajist´ı témˇeˇr okamˇzitá odpovˇed’ studentovi, zda jeho práce vyhovuje poˇzadavk˚ um ˇci nikoliv. Student nemus´ı ˇcekat na v´ ysledky s t´ım, ˇze jeho práce nen´ı správnˇe a mus´ı jeˇstˇe nˇeco opravit. Vyuˇcuj´ıc´ı naopak nemus´ı podrobnˇe kontrolovat kaˇzdou práci a to, zda práce vyhovuje ˇci nikoliv, je stanoveno dle objektivn´ıho kritéria, které je pro vˇsechny práce stejné. Validaˇcn´ı server funguje jako volitelná nadstavba odevzdávac´ıho portletu, viz [11]. Portlet obdrˇz´ı odevzdan´ y soubor a ten pˇrepoˇsle validaˇcn´ımu serveru. Validaˇcn´ı server nejprve provede u ´vodn´ı doménové kontroly – napˇr. maximáln´ı moˇzná velikost souboru, povolené pˇr´ıpony atd. – a pokud soubor projde, spust´ı se samotn´ y validaˇcn´ı proces. Pro kaˇzd´ y validaˇcn´ı proces je vytvoˇren v´ ystup, do kterého m˚ uˇze autor validaˇcn´ıho procesu generovat informativn´ı, varovné ˇci chybové zprávy. Pokud dojde k pˇridán´ı chybové zprávy do v´ ystupu, neprojde soubor validac´ı jako takovou. Po dokonˇcen´ı validace je pak jej´ı v´ ystup pˇreveden do HTML stránky a studentovi je na ni poskytnut odkaz. V´ ystup nemus´ı b´ yt ale pˇreveden jen do HTML stránky pro studenta, dalˇs´ı formy v´ ystupu mohou b´ yt napˇr´ıklad uloˇzen´ı do databáze nebo XML souboru. HTML v´ ystupy se generuj´ı na adresu: http://vs.kiv.zcu.cz/validator/ Pˇresná cesta je urˇcena v souboru domain.xml a podle n´ı se vytvoˇr´ı adresáˇrová struktura pro HTML v´ ystupy. Podrobnˇejˇs´ı informace o validaˇcn´ım serveru viz [2], [10].

2

Teoretický u ´vod

2.1.1

Validaˇcn´ı server

Pˇ r´ıstup na validaˇ cn´ı server

Adresa validaˇcn´ıho serveru je: validator.kiv.zcu.cz Pokud se na tuto adresu pˇripoj´ıme pomoc´ı protokolu HTTPS, dostaneme se na webové rozhran´ı validaˇcn´ıho serveru (viz 2.2). Pokud se na tuto adresu pˇripoj´ıme pomoc´ı protokolu SSH pˇres port 22, dostaneme se na samotn´ y souborov´ y systém validaˇcn´ıho serveru. SVN repozitáˇr se zdrojov´ ymi kódy se nacház´ı na adrese: svn+ssh://forge.kiv.zcu.cz/home/svn/validator/ValidacniServer/trunk ´ Udaje pro pˇr´ıstup na validaˇcn´ı server a na SVN repozitáˇr poskytuje a spravuje Ing. Lukáˇs Valenta ([email protected]).

2.1.2

Adres´ aˇ rov´ a struktura validaˇ cn´ıho serveru

/home/validator/validator | | VS.jar | restart | start | stop | [lib] | [data] | | [domains] | | | [common] | | | [ppa1] | | | | ... | | | | domain.xml | | | | run.policy | | | [ssp07] | | | ... | | [html] | | | vs.css | | [log] | | | vs.log | | [store] | | [workdir]

Uk´ azka 2.1: Adresáˇrová struktura validaˇcn´ıho serveru 3


Validaˇcn´ı server

Pro uˇcely vytváˇren´ı zásuvn´ ych modul˚ u je tˇreba seznámit se s adresáˇrovou strukturou a d˚ uleˇzit´ ymi soubory validaˇcn´ıho serveru. Ukázka 2.1 je pˇrevzata z [10]. Protoˇze u ´ˇcty pro pˇr´ıstup na validaˇcn´ı server mohou m´ıt jinak nastaveny domovské adresáˇre po pˇrihláˇsen´ı, je v ukázce 2.1 na prvn´ı ˇrádce uvedena absolutn´ı cesta k ostrému validaˇcn´ımu serveru v rámci souborového systému. N´ azev VS.jar

Pouˇ zit´ı hlavn´ı spustiteln´ y JAR serveru

restart

skript na restartován´ı validátoru

lib

sloˇzka pro pomocné knihovny

domain.xml

nastaven´ı validaˇcn´ı domény

run.policy

nastaven´ı práv ve validaˇcn´ı doménˇe

workDir

doˇcasné pracovn´ı sloˇzky validac´ı, d˚ uleˇzité zejména pro ladˇen´ı

Tabulka 2.1: Popis d˚ uleˇzit´ ych ˇca´st´ı validaˇcn´ıho serveru

2.1.3

Restartov´ an´ı validaˇ cn´ıho serveru

Obˇcas je po proveden´ı nˇejak´ ych zmˇen nutno validaˇcn´ı server restartovat, aby se zmˇeny projevily. Restart trvá pˇribliˇznˇe dvˇe a p˚ ul sekundy, tud´ıˇz studenti by nemˇeli ani postˇrehnout, ˇze server nebˇeˇz´ı. Pˇresto je ale vhodnˇejˇs´ı provádˇet restart v dobˇe, kdy se neoˇcekává, ˇze by studenti odevzdávali své práce. M˚ uˇze se totiˇz stát, ˇze zmˇeny, které jsme provedli, budou vykonávat jinou ˇcinnost, neˇz jakou jsme poˇzadovali, a server budeme muset restartovat v´ıcekrát. Pˇri rozsáhlejˇs´ıch zmˇenách je vhodné pouˇz´ıt nejdˇr´ıve testovac´ı server (viz 2.3) a na nˇem u ´pravy odladit. Restart validaˇcn´ıho serveru se provád´ı tak, ˇze se pomoc´ı programu Putty pˇripoj´ıme na validaˇcn´ı server pˇres protokol SSH: validator.kiv.zcu.cz:22 a tam, v koˇrenové sloˇzce validátoru, spust´ıme skript restart (viz 2.1.2). ./restart

4


2.2

Webové rozhran´ı validaˇcn´ı serveru

Webov´ e rozhran´ı validaˇ cn´ı serveru

V p˚ uvodn´ım validaˇcn´ım serveru bez webového uˇzivatelského rozhran´ı byl cel´ y pr˚ ubˇeh validace ˇr´ızen skriptem process.xml, kter´ y obsahoval kombinaci XML element˚ u s JavaScriptov´ ym programem (Princip fungován´ı validaˇcn´ıho serveru – [10]). Pokud vyuˇcuj´ıc´ı nebyl detailnˇe seznámen s moˇznostmi konfigurace, bylo vytváˇren´ı validaˇcn´ıch domén obt´ıˇzné. Z tohoto d˚ uvodu vzniklo webové uˇzivatelské rozhran´ı. Uˇzivatelské rozhran´ı poskytuje srozumitelnˇejˇs´ı zp˚ usob, jak nastavit validaˇcn´ı domény. Je vytvoˇreno pomoc´ı servlet˚ u a JSP stránek a vyuˇz´ıvá webov´ y sever Tomcat [2]. Samotn´ y validaˇcn´ı proces je rozdˇelen do posloupnosti krok˚ u, které maj´ı jednoznaˇcnou funkci, a podm´ınku, za jaké se spust´ı. Autor validace m˚ uˇze nav´ıc vytváˇret JavaScriptové promˇenné, které jsou viditelné ze vˇsech krok˚ u. Pomoc´ı tˇechto promˇenn´ ych tak m˚ uˇze pˇredávat data z jednoho krok˚ u do dalˇs´ıch.

Obr´ azek 2.1: Ukázka krok˚ u validaˇcn´ı domény

2.2.1

Adres´ aˇ rov´ a struktura webov´ eho rozhran´ı

/home/validator/tomcat/webapps/ROOT | | domenaNastaveni.jsp | domenaSmaz.jsp | ... | [css] | [imgs] | [js] | [META−INF] | [WEB−INF] | | [classes] | | [data] | | [libg

Uk´ azka 2.2: Adresáˇrová struktura webového rozhran´ı 5


Testovac´ı kopie validaˇcn´ıho serveru s webovým rozhran´ım

N´ azev data

Pouˇ zit´ı jsou zde uloˇzeny jednotlivé kroky námi vytvoˇren´ ych domén

lib

sloˇzka pro knihovny

Tabulka 2.2: Popis d˚ uleˇzit´ ych ˇca´st´ı webového rozhran´ı Nˇekdy potˇrebujeme pˇrekop´ırovat urˇcité kroky z jedné domény do druhé nebo potˇrebujeme vytvoˇrit vˇetˇs´ı poˇcet krok˚ u najednou. V takovém pˇr´ıpadˇe ˇ sen´ım je modifikovat náˇs by bylo klikán´ı pˇres webové rozhran´ı pracné. Reˇ soubor s kroky ve sloˇzce WEB-INF/data. Tento soubor, kter´ y je pojmenovan´ y podle naˇseho Orion loginu, obsahuje vˇsechny domény a jejich kroky, které jsme v rámci webového rozhran´ı vytvoˇrili. Pro projeven´ı zmˇen v souboru staˇc´ı restartovat webové rozhran´ı, samotn´ y validaˇcn´ı server se restartovat nemus´ı.

2.2.2

Restartov´ an´ı webov´ eho rozhran´ı

Abychom restartovali webové rozhran´ı, mus´ıme restartovat webov´ y server Tomcat. To se provede podobn´ ym zp˚ usobem jako restartován´ı validaˇcn´ıho serveru (viz 2.1.3). Skripty na spuˇstˇen´ı a vypnut´ı Tomcatu jsou ale v: /home/validator/tomcat/bin

Samostatn´ y skript pro restart tu nen´ı, mus´ıme Tomcat vypnout a znovu zapnout skripty shutdown.sh a startup.sh. ./shutdown.sh ./startup.sh

2.3

Testovac´ı kopie validaˇ cn´ıho serveru s webov´ ym rozhran´ım

Pro u ´ˇcely testován´ı a ladˇen´ı validaˇcn´ıch domén a extern´ıch modul˚ u byl vytvoˇren testovac´ı validaˇcn´ı server, kter´ y je témˇeˇr identick´ y s ostr´ ym, pouze 6

Teoretický u ´vod KIV/OOP – Pˇredmˇet objektovˇe orientované programován´ı

má jiné cesty. Autoˇri validaˇcn´ıch domén zde mohou testovat své konfigurace, aniˇz by pˇri tom naruˇsovali bˇeh ostrého serveru. Protoˇze se testovac´ı validaˇcn´ı server pouˇz´ıvá pro v´ yvoj a ozkouˇsen´ı extern´ıch modul˚ u, poskytuje funkce, které ostr´ y server dosud nevyuˇz´ıvá. Do ostrého serveru se pak tyto moduly zavedou aˇz bude nutné. Adresa webového rozhran´ı testovac´ıho validátoru je: https://validator.kiv.zcu.cz/val-test/ Pro pˇr´ıstup k souborovému systému testovac´ıho validátoru je adresa stejná jako pro ostr´ y, viz 2.1.1. Samotn´ y testovac´ı validátor je pak um´ıstˇen ve sloˇzce: \home\valtest\val−test

2.4

KIV/OOP – Pˇ redmˇ et objektovˇ e orientovan´ e programov´ an´ı

Pˇredmˇet si klade za c´ıl nauˇcit studenty objektovˇe orientovan´ y styl programován´ı spolu s dobr´ ymi programátorsk´ ymi návyky. Studenti pˇritom mimo jiné pracuj´ı s JUnit testy, UML diagramy ˇci statickou kontrolou zdrojov´ ych kód˚ u.[3] Samostatné projekty jsou vytvoˇreny tak, aby byly jednoduˇse strojovˇe ovˇeˇritelné. Tento pˇredmˇet je tedy velmi vhodn´ y pro kontrolu u ´loh pomoc´ı validátoru. Studenti v rámci pˇredmˇetu pracuj´ı na celkem aˇz jedenácti samostatn´ ych u ´lohách. Prvn´ıch osm u ´loh je kl´ıˇcov´ ych (tj. povinn´ ych) a t´ ykaj´ı se objektovˇe orientovaného designu, psan´ı JavaDoc dokumentace a vytváˇren´ı UML diagram˚ u. Dalˇs´ı dvˇe u ´lohy jsou na téma kolekce v Javˇe a posledn´ı u ´loha se zaob´ırá vytváˇren´ım JUnit test˚ u. Jedn´ım z poˇzadavk˚ u této práce bylo vytvoˇrit validaˇcn´ı domény pro pˇredmˇet KIV/OOP. Validaˇcn´ı domény jako takové uˇz byly pˇredt´ım vytvoˇrené, pouze bylo tˇreba je pˇrevést do formátu webového rozhran´ı. Nˇekteré domény byly následnˇe doplnˇené o dalˇs´ı kroky, aby byla kontrola pˇr´ısnˇejˇs´ı, jiné bylo nutno kompletnˇe pˇredˇelat a vytvoˇrit k nim zásuvné moduly, aby je bylo moˇzno spustit z webového rozhran´ı. 7


2.4.1

JUnit testy

Prvn´ıch osm u ´loh se kontroluje pomoc´ı JUnit test˚ u. JUnit je open source nástroj na psan´ı a spouˇstˇen´ı jednotkov´ ych test˚ u pro programovac´ı jazyk Java [7]. Jednotkové testy funguj´ı tak, ˇze si programátor nap´ıˇse urˇcitou sadu test˚ u, které porovnávaj´ı oˇcekávanou a skuteˇcnou návratovou hodnotu metod, a pokud testy probˇehnou v poˇra´dku, lze pˇredpokládat, ˇze metody pracuj´ı správnˇe. Jednou z v´ yhod jednotkov´ ych test˚ u je, ˇze po jejich vytvoˇren´ı m˚ uˇze prob´ıhat testován´ı zcela automaticky. S jednotkov´ ymi testy se také poj´ı programovac´ı pˇr´ıstup, kdy nejdˇr´ıve se nap´ıˇsou jednotkové testy a aˇz potom se nap´ıˇse vlastn´ı kód. Tomuto pˇr´ıstupu se ˇr´ıká programován´ı ˇr´ızené testy“.[1] V samostatn´ ych u ´lohách pˇredmˇetu ” KIV/OOP si studenti zkouˇsej´ı oba zp˚ usoby práce s jednotkov´ ymi testy, tedy jak situaci, kdy maj´ı k dispozici pouze jednotkové testy a musej´ı vytvoˇrit tˇr´ıdy a metody, tak situaci, kdy maj´ı ovˇeˇrit funkˇcnost tˇr´ıdy pomoc´ı test˚ u. Studenti kaˇzdou samostatnou kl´ıˇcovou u ´lohu odevzdávaj´ı jako cel´ y projekt se zdrojov´ ymi soubory, v pracovn´ı sloˇzce na validaˇcn´ım serveru se pak vybrané soubory projektu pˇrep´ıˇsou vzorov´ ymi a cel´ y projekt se zkompiluje. Po zkompilován´ı se spust´ı JUnit testy a pokud testy neohlás´ı chybu, je projekt pˇrijat. Spoleˇcnˇe s testy se také poˇr´ıd´ı sn´ımek obrazovky (studenti pracuj´ı s vykreslovac´ım plátnem).

2.4.2

Porovn´ av´ an´ı obr´ azk˚ u

Na rozd´ıl od zbyl´ ych sedmi kl´ıˇcov´ ych u ´loh odevzdávaj´ı studenti v prvn´ı u ´loze pouze jeden soubor s testy a pˇr´ıpravkem (sada objekt˚ u, s nimiˇz budou testy pracovat). Studenti maj´ı na zaˇca´tku k dispozici pouze jednotkové testy a jejich u ´kolem je vykreslit na plátno pomoc´ı geometrick´ ych objekt˚ u jednoznaˇcnˇe definovan´ y obrázek. Jak uˇz bylo ˇreˇceno, validace pro kl´ıˇcové projekty pˇredmˇetu KIV/OOP spoléhá v´ yhradnˇe na pr˚ ubˇeh JUnit test˚ u. Bylo by proto moˇzné, aby si studenti napsali sv˚ uj pˇr´ıpravek a testy si pozmˇenili, aby vyhovovaly jejich pˇr´ıpravku. To mˇelo za následek, ˇze by testy na stranˇe serveru proˇsly, aˇckoliv by správné nebyly. Vzhledem k tomu, ˇze studenti odevzdávaj´ı pouze jeden soubor, nen´ı jednoduˇse moˇzné jej pˇrepsat vzorov´ ymi testy. Vyvstala tedy nutnost naj´ıt jin´ y zp˚ usob, jak ovˇeˇrit správnost odevzdané práce. 8


Ze zm´ınˇeného d˚ uvodu se do procesu validace zaˇclenilo i poˇrizován´ı sn´ımku obrazovky, protoˇze obrázek lze porovnat v˚ uˇci vzoru. Samotné porovnáván´ı dvou obrázk˚ u ale v˚ ubec nen´ı triviáln´ı záleˇzitost. Pˇredpokládejme, ˇze bychom porovnávali dva obrázky ve formátu JPEG. Vlivem komprese by obrázky nemusely b´ yt binárnˇe totoˇzné, i kdyby byly vygenerovány stejn´ ym programem a se stejn´ ym nastaven´ım. Naˇstˇest´ı lze poˇrizovat sn´ımek plátna do bezztrátového formátu PNG. Dále máme jistotu, ˇze vˇsechny poˇr´ızené sn´ımky budou m´ıt stejné rozliˇsen´ı, protoˇze studenti pracuj´ı se stejn´ ym frameworkem. Porovnáván´ı obrázk˚ u se nám tud´ıˇz zjednoduˇsilo na problém, kdy staˇc´ı pouze porovnávat pixel po pixelu prvn´ı obrázek s druh´ ym.

2.4.3

Kontrola UML diagramu tˇ r´ıd

Od páté kl´ıˇcové u ´lohy pˇredmˇetu KIV/OOP aˇz do osmé odevzdávaj´ı studenti kromˇe samotn´ ych zdrojov´ ych kód˚ u také UML digramy tˇr´ıd.[5] Tyto UML diagramy tˇr´ıd vytváˇrej´ı v jednoduchém programu zvaném UMLet, kter´ y um´ı diagramy exportovat do formátu PNG. Doposud se tyto diagramy tˇr´ıd musely kontrolovat ruˇcnˇe jako obrázky. Pro zautomatizován´ı kontroly se zdánlivˇe nab´ız´ı moˇznost kontrolovat diagramy stejnˇe jako v 2.4.2. Tento pˇr´ıstup je ale nepouˇziteln´ y, protoˇze aˇckoliv studenti pouˇzij´ı stejné tˇr´ıdy jako ve vzorovém obrázku, kaˇzd´ y obrázek bude m´ıt jiné rozloˇzen´ı. Naˇstˇest´ı vˇsak UMLet dovoluje ukládat diagramy jako XML soubory, tud´ıˇz lze snadno programovˇe z´ıskat strukturu diagramu. Ukázka diagramu s dvˇema tˇr´ıdami a jednou relac´ı:

9


10 <element> com.umlet.element.Class <x>20 20 <w>100 30 <panel attributes>Osoba <element> com.umlet.element.Class <x>250 20 <w>100 30 <panel attributes>Muz <element> com.umlet.element.Relation <x>90 0 <w>180 50 <panel attributes>lt=<<− 30;30;160;30

Uk´ azka 2.3: Diagram uloˇzen´ y v UMLet

Obr´ azek 2.2: V´ ysledek ukázky 2.3 Za zm´ınku stoj´ı dvˇe skuteˇcnosti. Element type se uˇz nijak dále nedˇel´ı a to jak pro tˇr´ıdy, tak i pro relace. Kdyˇz chceme u tˇr´ıdy specifikovat, ˇze se jedná napˇr´ıklad o rozhran´ı, tak to lze provést pouze tak, ˇze se nap´ıˇse typ tˇr´ıdy jako text do obdéln´ıku (element panel_attributes) a je jenom na autorovi diagramu, aby pouˇz´ıval konzistentn´ı znaˇcen´ı pro dan´ y typ tˇr´ıdy (v tomto pˇr´ıpadˇe <>). 10


PMD – statická analýza kódu

Smˇer relace se urˇcuje pomoc´ı hodnot v elementu additional_attributes. Hodnoty jsou vˇzdy po dvojic´ıch a plat´ı, ˇze prvn´ı dvojice zprava se vztahuje na poˇca´teˇcn´ı bod relace a posledn´ı dvojice nalevo na koncov´ y bod relace. Dvojice jsou ve tvaru X, Y, kdy po pˇriˇcten´ı tˇechto hodnot k souˇradnic´ım X, Y relace z´ıskáme v´ ysledné souˇradnice bodu. V naˇs´ı ukázce je to (relace vede od Muz k Osoba): poˇca´teˇcn´ı bod:

◦ X = 90 + 160 = 250 ◦ Y = 0 + 30 = 30 koneˇcn´ y bod:

◦ X = 90 + 30 = 120 ◦ Y = 0 + 30 = 30 Pro zpracován´ı XML souboru s diagramem bylo moˇzné pouˇz´ıt technologii Simple API for XML (SAX) nebo Document Object Model (DOM). V podstatˇe bylo jedno jakou technologii zvol´ım, protoˇze na UMLet souborech by se neprojevila ˇza´dná z v´ yhod jednotliv´ ych technologi´ı. DOM vytvoˇr´ı strom uzl˚ u, kter´ y je po celou dobu v pamˇeti a ve kterém lze pˇristupovat k jakémukoliv uzlu. Jenˇze vzhledem k tomu, ˇze jednotlivé prvky diagramu budu stejnˇe muset pˇrevést na Java objekty, tak si t´ım nijak nepom˚ uˇzu. Nakonec jsem se rozhodl pro SAX, protoˇze i kdyˇz je zpracován´ı pouze sekvenˇcn´ı, tak je rychlejˇs´ı a ménˇe nároˇcné na pamˇet’ neˇz u DOM [4], [9].

2.5

PMD – statick´ a anal´ yza k´ odu

PMD [8] je opensource nástroj, kter´ y slouˇz´ı k anal´ yze zdrojov´ ych soubor˚ u napsan´ ych v jazyce Java. V pˇredmˇetech KIV/PPA1, KIV/PT ˇci KIV/JXT se pouˇz´ıvá pˇredevˇs´ım pro v´ yuku správn´ ych programovac´ıch praktik, ale je moˇzno ho pouˇz´ıt i pro jiné u ´ˇcely, napˇr. odhalován´ı bug˚ u (prázdné try/catch pˇr´ıkazy) nebo hledán´ı duplicitn´ıho kódu. Chyby odhalené pomoc´ı PMD nejsou chyby v pravém slova smyslu (tj. funkˇcnosti), ale sp´ıˇse chyby v kvalitˇe zdrojového kódu. Pouˇz´ıván´ı PMD je ve v´ yˇse uveden´ ych pˇredmˇetech volitelné. Pro pˇredmˇet KIV/OOP by se ale PMD mohlo stát pˇrirozenou souˇca´st´ı validaˇcn´ıho 11



procesu. V minulosti uˇz byly pokusy zaˇclenit PMD do validaˇcn´ıho serveru, bohuˇzel ale nebyly dotaˇzeny do zdárného konce. Nav´ıc v té dobˇe nebylo k dispozici ani webové rozhran´ı. Spouˇstˇen´ı PMD se provád´ı pomoc´ı JAR souboru, kterému pˇredáme jako parametry soubory, které chceme zkontrolovat, typ v´ ystupu a pravidla, která chceme pouˇz´ıt. Rozhodnˇe by tedy nebyl problém vytvoˇrit extern´ı modul do validátoru, kter´ y by spouˇstˇel PMD nad odevzdan´ ymi soubory, a v´ ysledek kontroly by pˇresmˇeroval do celkového v´ ysledku validace. V pˇr´ıpadˇe, ˇze by se nepouˇzilo pˇr´ıliˇs mnoho sloˇzit´ ych pravidel, by PMD mohlo b´ yt pro studenty uˇziteˇcné. M´ıru sloˇzitosti stanov´ı snadno vyuˇcuj´ıc´ı. Nová pravidla do PMD lze vytváˇret jako Java tˇr´ıdy nebo jako XPath v´ yrazy.

2.5.1

Vytvoˇ ren´ı pravidla Java tˇ r´ıdou

PMD nezpracovává samotné zdrojové soubory, pouze z nich parsuje Abstract Syntax Tree (AST) a s t´ımto stromem v´ yraz˚ u pak dále pracuje. public class Trida { int a; }

Uk´ azka 2.4: Jednoduchá tˇr´ıda

TypeDeclaration ClassOrInterfaceDeclaration:Trida ClassOrInterfaceBody ClassOrInterfaceBodyDeclaration FieldDeclaration Type PrimitiveType:int VariableDeclarator VariableDeclaratorId:a

Uk´ azka 2.5: Odpov´ıdaj´ıc´ı AST Pravidla se p´ıˇs´ı tak, ˇze reagujeme na v´ yskyt, ˇci nev´ yskyt urˇcitého uzlu. Chceme-li vytvoˇrit nové pravidlo, mus´ıme jako prvn´ı vˇedˇet, na jak´ y uzel reagujeme. To zjist´ıme tak, ˇze pouˇzijeme program designer.bat, kter´ y je souˇcást´ı distribuce PMD. T´ımto programem zpracujeme zdrojov´ y kód v Javˇe a dostaneme vygenerovan´ y AST. 12



Dejme tomu, ˇze bychom chtˇeli vyvolat poruˇsen´ı pravidla pˇri jednoznakovém pojmenován´ı instanˇcn´ı promˇenné typu int. Bude nás tedy zaj´ımat uzel VariableDeclaratorId. Kdyˇz uˇz v´ıme, na jak´ y uzel budeme reagovat, tak si m˚ uˇzeme vytvoˇrit Java tˇr´ıdu: import net.sourceforge.pmd.*; import net.sourceforge.pmd.ast.*;

// Z knihovny ”pmd−(cisloVerze).jar”

public class OurRule extends AbstractJavaRule { public Object visit(ASTFieldDeclaration node, Object data) { Node type = node.jjtGetChild(0); Node varDeclarator = node.jjtGetChild(1); if (isInt(type)) { if (isOneCharLong(varDeclarator)) { addViolation(data, node); } } return super.visit(node,data); } private boolean isInt(Node type) { SimpleNode primitiveType = (SimpleNode)type.jjtGetChild(0); return (primitiveType instanceof ASTPrimitiveType && primitiveType.getImage().equals(”int”)); } private boolean isOneCharLong(Node varDeclarator) { SimpleNode varDeclaratorId = (SimpleNode)varDeclarator.jjtGetChild(0); return (varDeclaratorId instanceof ASTVariableDeclaratorId && varDeclaratorId.getImage().length() == 1); } }

Uk´ azka 2.6: Poruˇsen´ı pravidla pˇri jednoznakové instanˇcn´ı promˇenné typu int V metodˇe visit() mus´ıme jako prvn´ı argument uvést pˇr´ımo nadˇrazen´ y uzel pro VariableDeclaratorId. Kdybychom chtˇeli, aby pravidlo platilo pro vˇsechny názvy promˇenn´ ych, tak bychom si vystaˇcili s VariableDeclarator. My ale chceme konkrétnˇe pouze instanˇcn´ı promˇenné typu int, a proto mus´ıme vybrat FieldDeclaration (ASTFieldDeclaration). Metodou jjtGetChild() z´ıskáme potomky uzlu FieldDeclaration, v naˇsem pˇr´ıpadˇe to jsou Type a VariableDeclarator. V konkrétn´ıch podm´ınkách spojen´ ych s nˇejak´ ym uzlem bychom se vˇzdy mˇeli pˇresvˇedˇcit, ˇze se jedná o poˇzadovan´ y typ uzlu operátorem instanceof. 13



Kdyby nám totiˇz chybˇela tato podm´ınka v metodˇe isInt(), tak by nám vznikla chyba pˇri promˇenné typu String. Uzel pro String nen´ı ASTPrimitiveType a tud´ıˇz nemá ˇza´dn´ y parametr int. Jeˇstˇe je tˇreba vytvoˇrit tzv. ruleset neboli sadu pravidel, kter´ y vyuˇzije naˇsi vytvoˇrenou tˇr´ıdu. Vytvoˇr´ıme si libovolnˇe pojmenovan´ y XML soubor (napˇr´ıklad mycustomrules.xml), ve kterém bude následuj´ıc´ı: <description> Ukazka noveho pravidla <description> Instancni promenne typu int nesmi mit jeden znak! <example>

Uk´ azka 2.7: Ruleset V PMD pak pouˇzijeme tento ruleset napˇr´ıklad takto: java −cp 1;2;3;4 net.sourceforge.pmd.PMD analyzovanySoubor.java text mycustomrules.xml 1: cesta k souboru jaxen−(verze).jar // ve slozce lib 2: cesta k souboru asm−(verze).jar // stazeneho distribucniho 3: cesta k souboru pmd−(verze).jar // baliku 4: slozka s class souborem nasi Java tridy text: textovy vystup

14


2.5.2


Vytvoˇ ren´ı pravidla pomoc´ı XPath

XPath je jazyk urˇcen´ y pro navigován´ı nad XML dokumenty a protoˇze PMD pracuje se strukturou zdrojového kódu jako se stromem, lze XPath pouˇz´ıt i zde. Kromˇe samotného v´ ybˇeru uzl˚ u a atribut˚ u umoˇzn ˇuje XPath také jednoduché v´ ypoˇcty (viz [6]). Vytvoˇren´ı nového pravidla pomoc´ı XPath zaˇc´ıná stejn´ ym zp˚ usobem jako u Java tˇr´ıdy – identifikujeme potˇrebn´ y uzel. Mˇejme tutéˇz tˇr´ıdu jako v ukázce 2.4 v sekci 2.5.1. Nástroj designer.bat um´ı kromˇe generován´ı AST také vyhodnocovat XPath v´ yrazy nad dan´ ym AST. Napˇr´ıklad v´ yraz, kter´ y od koˇrene hledá vˇsechny deklarované promˇenné s názvem a“: ” //VariableDeclaratorId[@Image=”a”]

by nám vypsal: ASTVariableDeclaratorId at line 2 column 5

Tentokrát budeme cht´ıt vytvoˇrit pravidlo, aby název jakékoliv promˇenné nebyl kratˇs´ı neˇz stanovené minimum (v ukázce je minimum 3). Pravidlo se bude psát pˇr´ımo do rulesetu, napˇr´ıklad mycustomrules2.xml, do elementu value. <description> Detects when a field, formal or local variable is declared with a short name. <priority>3 <properties> <property name=”minimum” description=”The variable length reporting threshold” value=”3”/> <property name=”xpath” pluginname=”true”>

15



<example>

Pouˇzit´ı rulesetu je podobné jako v 2.5.1, pouze nen´ı tˇreba pˇridávat do classpath sloˇzku s class souborem.

16

3 Zásuvné moduly pro validátor S nasazen´ım webového uˇzivatelského rozhran´ı je k dispozici mnohem intuitivnˇejˇs´ı zp˚ usob ovládán´ı. Celá validace z˚ ustala pod validaˇcn´ı doménou a pomoc´ı webového rozhran´ı jsou nyn´ı jasnˇe patrné kroky, které se maj´ı provést. Webové rozhran´ı toho ale samo o sobˇe moc neum´ı, pouze poskytuje pˇrehlednˇejˇs´ı prostˇred´ı. Funkˇcnost z´ıskává aˇz pomoc´ı zásuvn´ ych modul˚ u. Zásuvné moduly se pouˇz´ıvaj´ı jako akce v jednotliv´ ych kroc´ıch. Lze je tedy oznaˇcovat jako vlastn´ı akce“. V textu budou dále oba tyto term´ıny za” mˇen ˇovány. Tyto vlastn´ı akce by se mˇely programovat co moˇzná nejv´ıc modulárnˇe. V dobˇe psan´ı tohoto textu je na ostrém serveru k dispozici jen nˇekolik základn´ıch vlastn´ıch akc´ı jako jsou Rozbalen´ı archivu, Najdi soubory ˇci Kontrola programu (akce zejména urˇcené pro pˇredmˇet PPA1). Na testovac´ım validaˇcn´ım serveru jsou vˇsak k dispozici dalˇs´ı vlastn´ı akce, z nichˇz jedna je pro dále popisované postupy podmiˇ nuj´ıc´ı. Jedná se o vlastn´ı akci Spuˇstˇen´ı custom validace. Oˇcekává se, ˇze ostr´ y validaˇcn´ı server bude jeˇstˇe tento rok (2012) aktualizován na verzi, kde bude i tato vlastn´ı akce. Zásuvné moduly pro validaˇcn´ı server lze vytvoˇrit dvˇema zp˚ usoby: jako custom validaci (název vycház´ı ze jména hlavn´ıho rozhran´ı), nebo jako extern´ı vlastn´ı akci do webového rozhran´ı. Vˇsechny dále uvedené postupy jsou uvedeny pro operaˇcn´ı systém Windows 7 a popsány podrobnˇeji, aby podle nich bylo moˇzné v budoucnu validace pˇripravovat.

3.1

Custom validace

Poˇ zadavky: Java SE SDK 6u30, Eclipse SDK (Indigo SR2), WinSCP, pˇr´ıstup k validaˇcn´ımu serveru.

17

Zásuvné moduly pro validátor

Custom validace

Custom validace je starˇs´ı zp˚ usob vytváˇren´ı zásuvn´ ych modul˚ u. V porovnán´ı s druh´ ym zp˚ usobem nepodporuje JavaScriptové promˇenné webového rozhran´ı a pokud potˇrebujeme mˇenit parametry akce, je to obt´ıˇznˇejˇs´ı (do domain.xml se dop´ıˇse vlastnost a ta se pak v kódu z´ıskává). V´ yhodou je vˇsak snadnˇejˇs´ı zprovoznˇen´ı novˇe vytvoˇrené akce a ladˇen´ı. Z toho vˇseho vypl´ yvá, ˇze custom validace se sp´ıˇse hod´ı pro specializované a jednorázové akce nebo pokud potˇrebujeme rychle nˇeco vyzkouˇset.

3.1.1

Vytvoˇ ren´ı custom validace v Eclipse

Pro vytvoˇren´ı custom validace je tˇreba m´ıt knihovnu VS-API.jar, která je souˇcást´ı distribuce validátoru (k dispozici také na pˇriloˇzeném CD). 1. Vytvoˇ ren´ı nov´ eho projektu File → New → Java Project

Obr´ azek 3.1: Vytvoˇren´ı nového projektu 2. Pojmenov´ an´ı projektu a nastaven´ı verze prostˇ red´ı V dalˇs´ım oknˇe zadáme název projektu a nastav´ıme verzi prostˇred´ı. Validaˇcn´ı server jeˇstˇe nepodporuje Javu 1.7, proto vybereme verzi 1.6. Nakonec klikneme na tlaˇc´ıtko Finish 3. Pˇ rid´ an´ı knihovny VS-API.jar do projektu Knihovnu VS-API.jar nakop´ırujeme do libovolné sloˇzky (napˇr. do sloˇzky projektu). V Eclipse v oknˇe Package Explorer klikneme na náˇs projekt prav´ ym tlaˇc´ıtkem a zvol´ıme Properties. Najdeme vlastnost Java Build Path a poté zvol´ıme záloˇzku Libraries. Zde klikneme na tlaˇc´ıtko Add External JARs... a zadáme m´ısto, kam jsme nakop´ırovali knihovnu VS-API.jar. Po vybrán´ı knihovny by se nám mˇela zobrazit v seznamu knihoven. Nic dalˇs´ıho zde uˇz nepotˇrebujeme, proto dáme OK. 18


Custom validace

Obr´ azek 3.2: Zadán´ı názvu projektu a verze prostˇred´ı

Obr´ azek 3.3: Pˇridán´ı knihovny VS-API.jar do projektu 4. Vytvoˇ ren´ı tˇ r´ıdy s metodou validate() Vytvoˇr´ıme v Eclipse v naˇsem projektu novou tˇr´ıdu (nemus´ı m´ıt bal´ıˇcek). V této tˇr´ıdˇe staˇc´ı uˇz jen implementovat rozhran´ı CustomValidation dostupné d´ıky knihovnˇe VS-API.jar, vytvoˇrit metodu validate() a m˚ uˇzeme zaˇc´ıt psát samotn´ y kód validace. Celou hlaviˇcku metody validate() z´ıskáme bud’ v Eclipse, kdy najedeme myˇs´ı na podtrˇzen´ y název tˇr´ıdy a vybereme Add unimplemented methods, nebo z JavaDoc dokumentace validátoru.

19


Custom validace

Obr´ azek 3.4: Doplnˇen´ı metody validate() pomoc´ı funkce quick fix Vˇse, co se má bˇehem validace provést, se p´ıˇse do metody validate(). Metoda validate() má dva parametry a to ValidationInfo a FullValidationResult. ValidationInfo obsahuje data, které nám pˇredá validaˇcn´ı server napˇr. serverem pˇrijat´ y soubor, atributy domény, absolutn´ı cestu k doˇcasnému pracovn´ımu adresáˇri apod. Do FullValidationResult se naopak generuj´ı informace, varován´ı a chyby, které se následnˇe vyp´ıˇs´ı do v´ ystupn´ı HTML stránky. Dostupné metody tˇechto pˇredan´ ych objekt˚ u lze opˇet z´ıskat pomoc´ı doplˇ nován´ı kódu v Eclipse nebo v JavaDoc dokumentaci validátoru.

public class ValidationOOP11 implements CustomValidation { @Override public void validate(ValidationInfo validationInfo, FullValidationResult fullValidationResult) { String filename = validationInfo.getInputFile().getName(); if (! filename.equals(”SpravnyNazev.java”)) { fullValidationResult.addError(”Odevzdavany soubor se nejmenuje ' SpravnyNazev.java'!”); } } }

Uk´ azka 3.1: Pˇr´ıklad custom validace

3.1.2

Zprovoznˇ en´ı custom validace

Po naprogramován´ı tˇr´ıdy s metodou validate() je tˇreba tuto tˇr´ıdu (a dalˇs´ı tˇr´ıdy, pokud byly vytvoˇreny) um´ıstit jako JAR soubor na validaˇcn´ı server a 20


Custom validace

pˇr´ısluˇsnˇe upravit validaˇcn´ı doménu. V pˇr´ıpadˇe, ˇze jeˇstˇe nemáme validaˇcn´ı doménu, lze ji vytvoˇrit ve webovém rozhran´ı. 1. Exportov´ an´ı projektu do JAR souboru V Eclipse v oknˇe Package Manager klikneme na náˇs projekt prav´ ym tlaˇc´ıtkem a vybereme Export. Ze skupiny Java zvol´ıme JAR file a klikneme na Next. Ve v´ ysledném JAR souboru jsou nutné pouze class soubory tˇr´ıd, proto m˚ uˇzeme soubory jako .classpath a .project odˇskrtnout. D˚ uleˇzité je, aby byla zaˇskrtnutá moˇznost Export generated class files and resources. Tlaˇc´ıtkem Browse vybereme, kam chceme JAR soubor uloˇzit a klikneme na tlaˇc´ıtko Finish.

Obr´ azek 3.5: Volby pˇri exportován´ı do JAR souboru 2. Zkop´ırov´ an´ı vyexportovan´ eho souboru na validaˇ cn´ı server Pomoc´ı programu WinSCP se pˇripoj´ıme na validaˇcn´ı server. Ve sloˇzce data/domains (viz 2.1.2, strana 3) najdeme název domény, ve které budeme cht´ıt vytvoˇrenou custom validaci pouˇz´ıt, a do této domény nakop´ırujeme vyexportovan´ y JAR soubor. ´ 3. Uprava souboru domain.xml Do souboru domain.xml ve sloˇzce domény dopln´ıme název zkop´ırova21


Custom validace

ného JAR souboru jako hodnotu záznamu domain.classpath. Záznam tedy bude vypadat pˇribliˇznˇe takto: <entry key=”domain.classpath”>Ukazka.jar

Pokud pouˇz´ıváme v´ıce knihoven, oddˇel´ıme je stˇredn´ıkem: <entry key=”domain.classpath”>Foo.jar; Bar.jar

´ 4. Uprava souboru run.policy Provád´ıme-li bˇehem custom validace zápis, mus´ıme nastavit práva pro doˇcasnou pracovn´ı sloˇzku (v doˇcasné pracovn´ı sloˇzce bychom mˇeli provádˇet veˇskeré operace spojené se soubory). Pod povolen´ı ˇc´ıst ze sloˇzky domény si proto pˇridáme povolen´ı zapisovat v pracovn´ı sloˇzce: permission java.io.FilePermission ”\${validator.domaindir}/−”, ”read”; permission java.io.FilePermission ”\${validator.workdir}/−”, ”write”;

5. Vytvoˇ ren´ı kroku ve webov´ em rozhran´ı Pˇrihlás´ıme se do webového rozhran´ı na adrese: https://validator.kiv.zcu.cz a u vybrané domény klikneme na Uprav. Poté v sekci Kroky validace zvol´ıme nový krok. Zadáme název kroku a jako typ akce vybereme Vlastn´ı akce → Spuˇstˇen´ı custom validace. Do pole Název validace nap´ıˇseme cel´ y název tˇr´ıdy (tj. název i s bal´ıˇcky), na konci nesm´ı b´ yt ˇzádná pˇr´ıpona. Upozorˇ nuji, ˇze název tˇr´ıdy a název JAR souboru jsou rozd´ılné vˇeci.

Obr´ azek 3.6: Krok s custom validac´ı

22


3.2

Extern´ı vlastn´ı akce


Poˇ zadavky: Java SE SDK 6u30, Eclipse SDK (Indigo SR2), WinSCP, Putty, pˇr´ıstup na validaˇcn´ı server, pˇr´ıstup na SVN se zdrojov´ ymi kódy validaˇcn´ıho serveru nebo samotné zdrojové kódy validaˇcn´ıho serveru

Extern´ı vlastn´ı akce podporuj´ı JavaScriptové promˇenné a umoˇzn ˇuj´ı napsat nápovˇedu, která se uˇzivateli zobraz´ı ve webovém rozhran´ı. Dále nab´ızej´ı snadnˇejˇs´ı zp˚ usob, jak mˇenit dynamické parametry validace. Vˇsechny vlastn´ı akce, které jsou dostupné, se pak zobrazuj´ı ve webovém rozhran´ı pˇri u ´pravˇe kroku pod volbou Vlastn´ı akce. Nev´ yhodou vlastn´ıch akc´ı je fakt, ˇze pˇri jejich zprovozˇ nován´ı je tˇreba rekompilovat validaˇcn´ı server (VS.jar) a následnˇe pak novou verzi nahrát na server. Z mého pohledu jsou extern´ı vlastn´ı akce sp´ıˇse vhodnˇejˇs´ı pro obecnˇejˇs´ı ˇcinnosti, které budou potencionálnˇe vyuˇz´ıvány i jin´ ymi uˇzivateli.

3.2.1

Vytvoˇ ren´ı extern´ı vlastn´ı akce

Pro vytvoˇren´ı extern´ı vlastn´ı akce je tˇreba m´ıt knihovny externi.jar a js.jar (na pˇriloˇzeném CD). Knihovna externi.jar obsahuje tˇr´ıdy z validaˇcn´ıho serveru potˇrebné pro naprogramován´ı validace a knihovna js.jar slouˇz´ı pro práci se vstupn´ımi parametry Context a Scriptable [2]. 1. Vytvoˇ ren´ı nov´ eho projektu Viz krok ˇc´ıslo 1 v sekci 3.1.1 na stranˇe 18. 2. Pojmenov´ an´ı projektu a nastaven´ı verze prostˇ red´ı Viz krok ˇc´ıslo 2 v sekci 3.1.1 na stranˇe 18. 23



3. Pˇ rid´ an´ı knihoven externi.jar a js.jar do projektu Analogick´ y postup jako v kroku ˇc´ıslo 3 v sekci 3.1.1 na stranˇe 18. 4. Vytvoˇ ren´ı tˇ r´ıdy implementuj´ıc´ı rozhran´ı VlastniAkce public class Trida2 implements VlastniAkce {}

5. Implementace nutn´ ych metod Metody, které je nutné implementovat, nám vytvoˇr´ı sám Eclipse po najet´ı kurzoru myˇsi na název tˇr´ıdy a kliknut´ı volby Add unimplemented methods (podobnˇe jako na obrázku 3.4 na stránce 20). Jsou to metody: public String getHelp() public String getId() public String getKategorii() public String getNazev() public List<ParametrAkce> getParametry() public String getPopis() public void execute(ValidationInfo arg0, FullValidationResult arg1, Scriptable arg2, Context arg3, Collection<Parametr> arg4)

Metoda getHelp() vrac´ı ˇretˇezec s nápovˇedou. Veˇsker´ y text nápovˇedy mus´ı b´ yt v tomto jediném ˇretˇezci, pˇriˇcemˇz text mus´ı b´ yt napsán pomoc´ı HTML znaˇcek. public String getHelp() { String help = ”
Nadpis
”; help += ”
Text napovedy
”; return help; }

Uk´ azka 3.2: Metoda getHelp() Metoda getId() vrac´ı identifikátor, podle kterého se vlastn´ı akce odliˇs´ı od ostatn´ıch. Staˇc´ı zadat jméno tˇr´ıdy. public String getId() { return ”Trida2”; }

Uk´ azka 3.3: Metoda getId() Metoda getKategorii() vrac´ı kategorii, do které vlastn´ı akce spadá.

24


public String getId() { return KAT_SOUBOR; }


// Prace se soubory

Uk´ azka 3.4: Metoda getKategorii() Kromˇe v´ yˇse uvedené kategorie existuje jeˇstˇe kategorie KAT_PROGRAM pro práci s programy a KAT_DOC pro práci s dokumenty. Metoda getNazev() vrac´ı název, kter´ y se bude zobrazovat se seznamu vlastn´ıch akc´ı. public String getNazev() { return ”Trida 2 − ukazkova akce”; }

Uk´ azka 3.5: Metoda getNazev() Metoda getParametry() vrac´ı seznam parametr˚ u. Parametrem je myˇsleno napˇr´ıklad tlaˇc´ıtko na nahrán´ı dat na server nebo r˚ uzné pˇrep´ınaˇce (viz obr. 3.7) V následuj´ıc´ım pˇr´ıkladu je ˇreˇseno pˇridán´ı dvou parametr˚ u: název souboru a ovládac´ı prvek pro nahrán´ı dat na server. Pˇri vytvoˇren´ı objektu ParametrAkce se zadávaj´ı ˇctyˇri argumenty – id, název, popis a typ. Id se definuje jako tˇr´ıdn´ı konstanta. Název a popis jsou informace pro zobrazen´ı ve webovém rozhran´ı a typ se udává jenom ve speciáln´ıch pˇr´ıpadech.

Obr´ azek 3.7: Pˇr´ıklad parametr˚ u vlastn´ı akce

25



public class Trida2 implements VlastniAkce { public static final String PARAM_NAZEV_SOUBORU = ”Nazev souboru”; ... public List<ParametrAkce> getParametry() { ArrayList<ParametrAkce> list = new ArrayList<ParametrAkce>(); list.add(new ParametrAkce(PARAM_NAZEV_SOUBORU, ”Nazev souboru”, ”JavaScriptova promenna pro ulozeni nazvu souboru”, ””)); list.add(new ParametrAkce(”kontrola−programu/nahraj”, ”Nahrat testovaci data”, ”Nahrajte testovaci data vytvorena podle navodu”, ”anchor”)); return list; }

Uk´ azka 3.6: Metoda getParametry() Metoda getPopis() vrac´ı ˇretˇezec s popisem vlastn´ı akce. public String getPopis() { return ”Akce slouzi jako ukazka externi vlastni akce.”; }

Uk´ azka 3.7: Metoda getPopis() Metoda execute() vykonává samotnou validaci. Z parametr˚ u metody jsou pro nás nejd˚ uleˇzitˇejˇs´ı ValidationInfo (informace o validaci), FullValidationResult (v´ ysledek validace) a Scriptable (JavaScriptové promˇenné). Pˇr´ıklad n´ıˇze vyp´ıˇse do v´ ysledku validace absolutn´ı cestu k odevzdanému souboru. public void execute(ValidationInfo info, FullValidationResult result, Scriptable scope, Context jsContext, Collection<Parametr> param) { String path = info.getInputFile().getAbsolutePath(); result.addInfo(path); }

Uk´ azka 3.8: Metoda execute()

3.2.2

Zprovoznˇ en´ı extern´ı vlastn´ı akce

Zprovoznˇen´ı bude tentokrát vyˇzadovat znovusestaven´ı a restart validátoru. 1. Exportov´ an´ı projektu do JAR souboru Viz krok ˇc´ıslo 1 v sekci 3.1.2 na stranˇe 21 26



´ 2. Uprava souboru MANIFEST.MF Ve sloˇzce, kam jsme vygenerovali JAR soubor, si vytvoˇr´ıme textov´ y soubor (napˇr. manifest.txt). Tento textov´ y soubor bude obsahovat pouze jednu ˇrádku: AKCE: nazevVlastniAkce

kde název mus´ı b´ yt jedineˇcn´ y pˇres vˇsechny akce. M˚ uˇze se napˇr´ıklad pouˇz´ıt název tˇr´ıdy implementuj´ıc´ı rozhran´ı VlastniAkce. V té samé sloˇzce si otevˇreme pˇr´ıkazovou ˇrádku a zadáme: jar umf manifest.txt nazevJARSouboru.jar

Tento pˇr´ıkaz zajist´ı, ˇze se do MANIFEST.MF dopln´ı ˇrádka ze souboru manifest.txt. Alternativnˇe lze téˇz pouˇz´ıt archivovac´ı program, otevˇr´ıt náˇs JAR soubor a MANIFEST.FM upravit ruˇcnˇe. 3. Zkop´ırov´ an´ı vyexportovan´ eho souboru na validaˇ cn´ı server Postupujeme jako v kroku ˇc´ıslo 2 v sekci 3.1.2 na stranˇe 21. Tentokrát vˇsak budeme kop´ırovat do jin´ ych sloˇzek. JAR soubor mus´ıme zkop´ırovat do sloˇzkek: lib tomcat/webapps/ROOT/WEB-INF/lib

Pˇriˇcemˇz tyto cesty plat´ı pro ostr´ y validaˇcn´ı server. ´ 4. Uprava souboru build.properties Soubor build.properties se nacház´ı v SVN repozitáˇri se zdrojov´ ymi kódy validaˇcn´ıho serveru. Tento soubor je tˇreba upravit tak, aby ˇra´dky libraries a libraries.spaced obsahovaly cestu k JAR souboru, kter´ y jsme zkop´ırovali do sloˇzky lib. libraries libraries.spaced

= lib/commons−vfs−1.1.jar;...;lib/Ukazka2.jar = lib/commons−vfs−1.1.jar ... lib/Ukazka2.jar

5. Spuˇ stˇ en´ı build.xml (ant) Provedeme sestaven´ı pomoc´ı souboru build.xml, kter´ y se nacház´ı v SVN repozitáˇri. Do sloˇzky out/JARs by se nám mˇel vygenerovat soubor VS.jar.

27


Zásuvné moduly pro KIV/OOP

6. Nahr´ an´ı nov´ e verze VS.jar na server Pˇres WinSCP nahrajeme VS.jar do koˇrenového adresáˇre validaˇcn´ıho serveru a pˇrep´ıˇseme starou verzi. 7. Restartov´ an´ı validaˇ cn´ıho serveru Viz sekce 2.1.3 na stranˇe 4. 8. Restartov´ an´ı webov´ eho rozhran´ı Viz sekce 2.2.2 na stranˇe 6.

3.3 3.3.1

Z´ asuvn´ e moduly pro KIV/OOP Porovn´ an´ı dvou obr´ azk˚ u

Pro vytvoˇren´ı tohoto modulu staˇcila jediná tˇr´ıda. Modul navazuje na vlastn´ı akci Kontrola programu OOP, která pro kaˇzd´ y soubor (z odevzdávaného JAR souboru), jehoˇz název konˇc´ı slovem Test, spouˇst´ı JUnit testy a generuje pˇri tom sn´ımek obrazovky. Tento sn´ımek pojmenovan´ y screenshot.png ukládá do pracovn´ı sloˇzky validace. Metoda validate() naˇcte vygenerovan´ y obrázek screenshot.png a vzorov´ y obrázek vzor.png, kter´ y mus´ıme nahrát spoleˇcnˇe s testovac´ımi daty. Oba tyto obrázky jsou pak pˇrevedeny na pole pixel˚ u. public class PorovnatPNG implements VlastniAkce { public void execute(ValidationInfo info, FullValidationResult result, Scriptable scope, Context jsContext, Collection<Parametr> parametry) { ... // Kontrola existence potrebnych souboru String sampleImage = info.getDomain().getDomainProperties().getProperty( ”image.sample name”); // Vlastnost, ktera se musi dopsat do domain.xml // rika, jak se ma jmenovat vzorovy soubor File validationImage = new File(workDir, sampleImage); ... // Nacteni obrazku sample = ImageIO.read(validationImage); ... // Prevedeni obrazku na pixely PixelGrabber grab1 = new PixelGrabber(sample, 0, 0, −1, −1, false); ... // Vytvoreni pole s pixely

28



int [] data1 = null; ... int width = grab1.getWidth(); int height = grab1.getHeight(); data1 = new int[width * height]; data1 = (int[])grab1.getPixels();

Pixely jsou uloˇzené jako int hodnota ve tvaru 0xAARRGGBB, kde AA je alpha sloˇzka barvy a zbytek jsou RGB sloˇzky. Pokud jsou pole totoˇzná, nemus´ı se nic ˇreˇsit a pˇridáme pouze informativn´ı zprávu, ˇze je v´ ystup v poˇra´dku. Pro porovnáván´ı jsem pouˇzil metodu Arrays.equals(), která vrac´ı true, pokud jsou obˇe pole stejnˇe velká a kaˇzd´ y prvek prvn´ıho pole je stejn´ y jako odpov´ıdaj´ıc´ı prvek druhého pole. V pˇr´ıpadˇe, ˇze pole stejná nejsou, mus´ı se cyklem proj´ıt vˇsechny prvky. Aby bylo moˇzné studentovi ukázat, kde pˇresnˇe se jeho obrázek liˇs´ı od vzorového, je nutné vytvoˇrit jak´ ysi rozd´ılov´ y obrázek. Rozd´ılov´ y obrázek se vytvoˇr´ı zesvˇetlen´ım pixel˚ u, které jsou stejné v obou pol´ıch, a pixelem s ˇcervenou barvou v m´ıstˇe, kde se vytvoˇren´ y obrázek liˇs´ı od vzorového. if (data1[i + j*width] == data2[i + j*width]) { pixel = data1[i + j*width]; diffData[i + j*width] = brighten(pixel); } else { diffData[i + j*width] = markDifference(); }

Zesvˇetlen´ı RGB hodnoty se ukázalo b´ yt m´ırnˇe obt´ıˇznˇejˇs´ı, protoˇze RGB model se zesvˇetlován´ım nebo ztmavován´ım bez zmˇeny barevného odst´ınu nepoˇc´ıtá. Z RGB modelu proto mus´ıme vytvoˇrit HSB (Hue, Saturation, Brightness) model a zmˇenit poˇzadované sloˇzky. float [] hsbVals = Color.RGBtoHSB(red, green, blue, null); // Zmena saturace a svetlosti Color brighter = Color.getHSBColor(hsbVals[0], 0.2f * hsbVals[1], 0.5f

*

(1f + hsbVals[2]));

Po vygenerován´ı rozd´ılového obrázku jej uloˇz´ıme a pˇrekop´ırujeme z pracovn´ı sloˇzky na server s v´ ysledky validac´ı (vs.kiv.zcu.cz/validator). Pˇri kop´ırován´ı mus´ıme dbát na to, aby sn´ımek obrazovky i rozd´ılov´ y obrázek mˇely unikátn´ı název, protoˇze vˇsechny obrázky se ukládaj´ı do jedné sloˇzky pro celou validaˇcn´ı doménu. K tomu pouˇzijeme metodu System.currentTimeMillis().

29



String destinationPath = info.getDomain().getDomainProperties().getProperty( ”image.destination path”); // Musi se dopsat do domain.xml String diffImage = String.valueOf(”Diff ” +System.currentTimeMillis()) + ”.png”; ImageIO.write(bufferedImage, ”png”, new File(destinationPath + File.separator + diffImage));

Nakonec jeˇstˇe vloˇz´ıme odkaz na obrázek do v´ ystupu validace. result.addInfo(”Rozdily oproti spravnemu obrazku .”);

Cel´ y zdrojov´ y kód je v pˇr´ıloze B.

3.3.2

Pouˇ zit´ı custom validace

V jedné z u ´loh studenti maj´ı za u ´kol pˇripravit sadu testovac´ıch pˇr´ıpad˚ u, které odhal´ı problémy v jim poskytnuté knihovnˇe, konkrétnˇe v souboru Osoba.java. Odevzdává se jedin´ y soubor OsobaTest.java. Dále následujou okomentované ˇcásti zdrojového kódu custom validace. Cel´ y zdrojov´ y kód je pˇr´ıloze A. public class ValidationOOP11 implements CustomValidation { final String JUNIT_JAR = ”/home/valtest/val−test/lib/junit−4.8.2.jar”; // final String JUNIT JAR = ”/home/validator/validator/lib/junit−4.8.2.jar”;

Cesta k JUnit knihovnˇe je dána napevno v kódu, protoˇze jsem nepˇriˇsel na to, jak zjistit tuto cestu nezávisle na struktuˇre serveru. Pˇri pouˇzit´ı na ostrém serveru bude proto tˇreba pˇrehodit cesty. Abychom mohli testy spustit, mus´ıme nejdˇr´ıve OsobaTest.java zkompilovat, abychom z´ıskali OsobaTest.class. Pokud se podaˇr´ı soubor zkompilovat, pˇresuneme jej do podsloˇzky testy. Tato podsloˇzka je nutná z d˚ uvodu pouˇzit´ı bal´ıˇcku. Do classpath pak pˇridáme celou pracovn´ı sloˇzku. JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); compilationResult = compiler.run(null, null, errorOutput, ”−classpath”, JUNIT_JAR +”:” + osobaPath, ”−encoding”, ”UTF−8”, inputFile.getAbsolutePath()); ... File classFile = new File(testyDir.getAbsolutePath() + File.separator + ”OsobaTest.class”); File oldClassFile = new File(inputFile.getAbsolutePath().replace(”java”, ”class”)); oldClassFile.renameTo(classFile);

30


Knihovna pro kontrolu UML diagram˚ u

Spust´ı se JUnit testy z OsobaTest a vˇsechny by mˇely odhalit konkrétn´ı chyby. Chyby (respektive jejich popis) mus´ı b´ yt identické se vzorov´ ymi, které studenti maj´ı v zadán´ı. for (Failure fail: result.getFailures()) { String chyba = fail.getDescription().getMethodName() + ”: ” + fail.getMessage(); if (mnozinaHlaseni.remove(chyba) == true) { fullValidationResult.addInfo(”Nalezeno: ” +chyba); }

Aby byl tedy odevzdan´ y soubor OsobaTest.java povaˇzován za správn´ y, mus´ı b´ yt nalezeny vˇsechny chyby.

3.4


Tuto knihovnu jsem vytvoˇril pro pouˇzit´ı v custom validaci. Celá knihovna se ˇ ri tˇr´ıdy jsou v bal´ıˇcku data, kter´ skládá z celkem dev´ıti tˇr´ıd. Ctyˇ y zajiˇst’uje vytvoˇren´ı objekt˚ u z XML souboru, a zbyl´ ych pˇet tˇr´ıd je v bal´ıˇcku logic, kter´ y pracuje s vytvoˇren´ ymi objekty v pamˇeti. [data] Handler IUMLReader UMLElement UMLReaderSax [logic] UMLClass UMLDiagram UMLRelation UMLRelationType UMLUtils

Tˇr´ıda UMLReaderSax implementuje rozhran´ı IUMLReader a slouˇz´ı k naˇcten´ı vˇsech prvk˚ u UMLet souboru (pˇr´ıpona uxf) do pamˇeti. Jak uˇz z názvu vypl´ yvá, je pouˇzita technologie SAX (viz 2.4.3). UMLReaderSax vyuˇz´ıvá pro samotné parsován´ı tˇr´ıdu Handler, která pˇresnˇe ˇr´ıká, jak´ ym zp˚ usobem se maj´ı z´ıskat hodnoty z XML souboru. Pro kaˇzd´ y zpracovan´ y prvek element se vytvoˇr´ı nov´ y objekt v Javˇe typu UMLElement, coˇz je v podstatˇe reprezentace prvku element v pamˇeti. Seznam vˇsech UMLElement objekt˚ u se pak pˇredává dál metodou getAllElements(). 31



Nejpodstatnˇejˇs´ı tˇr´ıdou je tˇr´ıda UMLDiagram, která z objekt˚ u UMLElement vytváˇr´ı objekty diagramu a poskytuje nad nimi dotazy. Pˇri vytváˇren´ı objekt˚ u UMLClass a UMLRelation se mus´ı z UMLElement nˇejak´ ym zp˚ usobem z´ıskat, o jak´ y typ tˇr´ıdy nebo relace se jedná. Pot´ıˇz je v tom, ˇze klasifikace je pouze textová a vytváˇr´ı ji autor diagramu. Zjiˇst’ován´ı typu tˇr´ıdy (tˇr´ıda, rozhran´ı, abstraktn´ı tˇr´ıda atd., pˇr´ıpadnˇe návrhové vzory) je tedy napevno podle v´ yskytu nˇejakého znaku nebo ˇrádky. Z ukázkového UML diagramu, kter´ y jsem mˇel k dispozici, jsem vypozoroval ˇctyˇri moˇznosti, jak m˚ uˇze b´ yt tˇr´ıda popsána. pouze n´ azev tˇr´ıdy, n´ azev tˇr´ıdy, barva obdéln´ıku, typ tˇr´ıdy uvnitˇr znak˚ u <<“ a >>“, název tˇr´ıdy, ” ” typ tˇr´ıdy uvnitˇr znak˚ u <<“ a >>“, název tˇr´ıdy, barva obdéln´ıku. ” ” <panel_attributes><<singleton>> Seznamka bg=red

Uk´ azka 3.9: Tˇr´ıda typu singleton; názvem Seznamka a ˇcervenou barvou Samotná klasifikace prob´ıhá tak, ˇze kontroluji, zda se v popisu vyskytuje ˇretˇezec >>“ nebo znak pro novou ˇrádku. Tato metoda je silnˇe závislá na ” tom, ˇze studenti budou m´ıt jasnˇe stanovené stejné znaˇcen´ı a budou se ho drˇzet. Dále je nutné si uvˇedomit, ˇze i typ tˇr´ıdy nen´ı omezen a m˚ uˇze b´ yt jak´ ykoliv. Relace jsou na tom podobnˇe. Tvar ˇsipek se autoˇri UMLet rozhodli ukládat jako prvn´ı ˇrádku v popisu elementu. Viz ukázka 2.2 na stranˇe 10. Pro urˇcen´ı typu relace mus´ı b´ yt typ spojen´ y s tvarem ˇsipky. Komplikace ale opˇet nastávaj´ı, pokud se autor diagramu rozhodne dát popis relace nad/pod ˇsipku a na tvar ˇsipky nebude dbát. Tyto situace neˇreˇs´ım, protoˇze by to bylo zbyteˇcnˇe komplikované. Klasifikace relac´ı je tedy pouze na základˇe tvaru ˇsipky (viz tabulka 3.1). Zda je relace mezi konkrétn´ımi dvˇema tˇr´ıdami, se stanov´ı prohledán´ım vˇsech tˇr´ıd a kontrolou, zda poˇca´teˇcn´ı a koncov´ y bod relace leˇz´ı uvnitˇr obdéln´ıku nˇekteré z tˇr´ıd. Vˇsechny objekty typu UMLRelation proto maj´ı atributy 32



Znaˇ cen´ı <- nebo -

Typ asociace

<.

závislost

<<-

dˇedˇen´ı

<<.

implementace rozhran´ı

<<<-

agregace

<<<<-

kompozice

Podoba

Tabulka 3.1: Druhy relac´ı v UMLet from a to typu UMLClass. Pokud je nˇejaká relace obousmˇerná, pak se mus´ı vytvoˇrit dvˇe relace, které budou m´ıt prohozené from a to. V momentáln´ı podobˇe se dotazy vykonávaj´ı nad dvˇema seznamy – seznam s UMLClass a UMLRelation. Seznamy nejsou nijak logicky propojené, protoˇze mˇe nenapadl pˇr´ıpad, kde by to bylo potˇrebné. Vzhledem k tomu, ˇze modul jeˇstˇe nebyl vyzkouˇsen pro vytvoˇren´ı validace a nen´ı k dispozici ˇza´dná zpˇetná vazba, lze oˇcekávat, ˇze modul se bude v budoucnu jeˇstˇe upravovat. K dispozici jsou nyn´ı tyto dotazy: public public public public public public

boolean noteExists() boolean classExists(String name) boolean interfaceExists(String name) int checkNumberOfRelationsOf(String name) boolean checkRelationFromTo(String from, String to) boolean checkRelationTypeFromTo(UMLRelationType type, String from, String to)

Pouˇzit´ı je pak takové, ˇze v tˇr´ıdˇe pro custom validaci se vytvoˇr´ı objekt UMLDiagram, kterému se jako parametr pˇredá cesta k odevzdávanému diagramu a objekt typu FullValidationResult. Aby autor validace nemusel stále psát podm´ınky pro porovnáván´ı oˇcekávané a navrácené hodnoty, vytvoˇril jsem v tˇr´ıdˇe UMLUtils statickou metodu assertEquals(), která porovnává pˇredané 33



hodnoty a v pˇr´ıpadˇe nerovnosti pˇridá do v´ ysledku validace chybu s textem errorMessage: public static void assertEquals(String errorMessage, boolean expected, boolean returned)

Pro pˇr´ıklad 2.3 ze strany 10 mohou testy vypadat takto: import java.io.File; import logic.UMLDiagram; import logic.UMLRelationType; import logic.UMLUtils; import cz.zcu.validationserver.CustomValidation; import cz.zcu.validationserver.validation.FullValidationResult; import cz.zcu.validationserver.validation.ValidationInfo;

public class Test implements CustomValidation { @Override public void validate(ValidationInfo validationInfo, FullValidationResult fullValidationResult) { File inputFile = validationInfo.getInputFile(); UMLDiagram diagram = new UMLDiagram(inputFile.getAbsolutePath(), fullValidationResult); UMLUtils.assertEquals(”Trida 'Osoba' neexistuje.”, true, diagram.classExists(”Osoba”)); UMLUtils.assertEquals(”Trida 'Muz' neexistuje.”, true, diagram.classExists(”Muz”)); UMLUtils.assertEquals(”Mezi tridou 'Muz' a 'Osoba' neni dedicnost”, true, diagram.checkRelationTypeFromTo(UMLRelationType.INHERITANCE, ”Muz”, ”Osoba”)); } }

Uk´ azka 3.10: Pouˇzit´ı assertEquals()

34

4 Validaˇcn´ı domény pro KIV/OOP Vˇsechny vytvoˇrené domény byly u ´spˇeˇsnˇe otestovány na odevzdan´ ych u ´lohách z let 2011/2012 a 2010/2011.

4.1

Kl´ıˇ cov´ eu ´ lohy

Validaˇcn´ı domény pro kl´ıˇcové u ´lohy maj´ı témˇeˇr stejn´ y obsah. Na zaˇca´tku je vˇzdy akce Rozbal ZIP. U této akce mus´ı b´ yt jeˇstˇe vyplnˇen´ y parametr C´ılový adresáˇr, kter´ y bude pouˇzit v dalˇs´ı fázi pˇri kontrole existence konkrétn´ıch soubor˚ u (obr. 4.2).

Obr´ azek 4.1: Kroky pro validaˇcn´ı doménu u ´lohy 04

Obr´ azek 4.2: Detail kroku rozbaleni Následuje kontrola existence povinn´ ych soubor˚ u a sloˇzek. Kaˇzdá kl´ıˇcová u ´loha má jiné povinné soubory a typicky soubor˚ u s ˇc´ıslem u ´lohy pˇrib´ yvá. Nevytváˇrel jsem kontrolu existence pro u ´plnˇe vˇsechny soubory, pouze ty nejd˚ uleˇzitˇejˇs´ı, protoˇze mi pˇriˇslo nepˇrehledné m´ıt ve validaˇcn´ı doménˇe des´ıtky 35

Validaˇcn´ı domény pro KIV/OOP

Kl´ıˇcové u ´lohy

krok˚ u (jsou to soubory, které maj´ı studenti jednoznaˇcnˇe uvedené v zadán´ı). Pro vyhledáván´ı soubor˚ u je pouˇzita akce Najdi soubory (obr. 4.3), u které je tˇreba uvést v jaké sloˇzce se má hledat (v´ yˇse zmiˇ novan´ y C´ılový adresáˇr ), co se má hledat (regulárn´ı v´ yraz) a JavaScriptovou promˇennou, do které bude uloˇzen poˇcet nalezen´ ych soubor˚ u/sloˇzek. Pokud akce ˇza´dn´ y vyhovuj´ıc´ı soubor nenajde, bude tato JavaScriptová promˇenná rovna nule.

Obr´ azek 4.3: Detail kroku hledej_rozmer Dalˇs´ı krok je vloˇzen´ı chyby do v´ ysledku validace, pokud nebude soubor ˇci sloˇzka nalezena (obr. 4.4). Tyto dva kroky, hledán´ı souboru a pˇr´ıpadné vloˇzen´ı chyby pˇri nenalezen´ı, se opakuj´ı pro vˇsechny povinné soubory/sloˇzky.

Obr´ azek 4.4: Detail kroku nenalezeno_rozmer 36


Kl´ıˇcové u ´lohy

Na konci fáze hledán´ı povinn´ ych soubor˚ u/sloˇzek je pak krok, kter´ y ukonˇc´ı validaci, v pˇr´ıpadˇe, ˇze se ve v´ ysledku validace jiˇz vyskytuje chyba (obr. 4.5).

Obr´ azek 4.5: Detail kroku konec_chyba Posledn´ım krokem je akce Kontrola programu OOP. Zde je nutné vysvˇetlit, jak se nahrávaj´ı testovac´ı data. Testovac´ı data m˚ uˇzeme nahrát bud’ pˇres webové rozhran´ı tlaˇc´ıtkem Nahrát testovac´ı data nebo pˇres WinSCP. Pˇres webové rozhran´ı se testovac´ı data vˇzdy nahrávaj´ı jako zip archiv (koncovka mus´ı b´ yt mal´ ymi p´ısmeny). Archiv se rozbal´ı do sloˇzky validation_data v dané doménˇe na serveru a pokud nebude archiv obsahovat sloˇzky, rozbal´ı se do validation_data rovnou. Akce Kontrola programu OOP byla p˚ uvodnˇe vytvoˇrena tak, ˇze se poˇc´ıtalo s jednou validaˇcn´ı doménou pro vˇsechny u ´lohy a nahrán´ım vˇsech testovac´ıch dat najednou, neboli ˇze sloˇzka validation_data obsahovala podsloˇzky pojmenované ˇc´ıslem u ´lohy. Kdyˇz tedy chceme m´ıt pro kaˇzdou u ´lohu vlastn´ı validaˇcn´ı doménu, mus´ıme m´ıt ve sloˇzce validation_data podsloˇzku s ˇc´ıslem u ´lohy a aˇz v n´ı testovac´ı data pro danou doménu. Pˇri nahrán´ı archivu, kter´ y obsahuje zabalenou sloˇzku, bychom ale zjistili, ˇze se do validation_data rozbalily pouze soubory a sloˇzka se nevytvoˇrila. Je proto zapotˇreb´ı zabalit do archivu sloˇzku dvakrát vnoˇrenˇe. 01.zip [01] [01] Barva.java Elipsa.java ...

Pouˇzijeme-li WinSCP, tento problém nemus´ıme ˇresit. Pˇripoj´ıme se na validaˇcn´ı server, vytvoˇr´ıme sloˇzku validation_data, v n´ı vytvoˇr´ıme sloˇzku s ˇc´ıslem u ´lohy a pˇrekop´ırujeme do n´ı testovac´ı data.

37

´ Ulohy s kolekcemi


U prvn´ı u ´lohy je nav´ıc krok s porovnáván´ım vygenerovaného sn´ımku obrazovky se vzorov´ ym sn´ımkem. Akce nemá ˇzádné parametry, ale je tˇreba poˇc´ıtat s t´ım, ˇze vzorov´ y obrázek mus´ı b´ yt ve sloˇzce validation_data a do domain.xml se mus´ı dopsat název vzorového obrázku: <entry key=”image.sample name”>vzor.png

Prvn´ı u ´loha má jeˇstˇe jednu zvláˇstnost. I kdyˇz se neodevzdává archiv ale soubor OsobaTest.java, pˇresto je prvn´ım krokem rozbalen´ı. Je to z d˚ uvodu, aby bylo moˇzno pouˇz´ıt akci Najdi soubory, která vyˇzaduje uvést adresáˇr, ve kterém se má hledat. To má za následek, ˇze se pˇri odevzdáván´ı vyp´ıˇse, ˇze se nejedná o archiv a celá validace skonˇc´ı. Aby validace pokraˇcovala, mus´ı se pouˇz´ıt trik. Do souboru nl/text.properties ve sloˇzce domény se dop´ıˇse vlastnost file.is_not_archive a jej´ı hodnota se ponechá prázdná. file.is_not_archive =

Kl´ıˇcové u ´lohy pouˇz´ıvaj´ı sv˚ uj run.policy, ve kterém jsou práva pro knihovny a pro vytváˇren´ı sn´ımk˚ u (jsou k dispozici na pˇriloˇzeném CD). V implicitn´ım domain.xml, kter´ y se vytvoˇr´ı s novou doménou, se vˇetˇsinou akorát mus´ı zmˇenit poloˇzky html_output_dir, html_output_url a accept_extensions, popˇr´ıpadˇe jeˇstˇe domain.classpath. Poloˇzky html_output_dir a html_output_url urˇcuj´ı, kam se budou generovat v´ ystupn´ı HTML soubory. <entry key=”html output url”>/var/www/validator/val−test/oop01 <entry key=”html output dir”>/var/www/validator/val−test/oop01

Pokud bychom se chtˇeli pˇres webov´ y prohl´ıˇzeˇc kouknout do sloˇzky, kam se generuj´ı HTML soubory, staˇc´ı nahradit /var/www/ za vs.kiv.zcu.cz/.

4.2

´ Ulohy s kolekcemi

´ Ulohy s kolekcemi maji podobné kroky jako kl´ıˇcové u ´lohy, pouze m´ısto posledn´ı akce Kontrola programu OOP maj´ı Kontrola programu s parametry (obr. 4.6). Studenti odevzdávaj´ı JAR soubor, kter´ y jde spustit a kter´ y potˇre38


JUnit u ´loha

buje zadat argumenty. Do pole Argumenty této akce se zapisuj´ı argumenty, které bychom beˇznˇe zadávali do pˇr´ıkazové ˇradky pˇri spuˇstˇen´ı. Pouze pˇred argument, kter´ y oznaˇcuje v´ ystupn´ı soubor, se mus´ı napsat -o, aby se tento v´ ystupn´ı soubor dal vytvoˇrit.

Obr´ azek 4.6: Vlastn´ı akce Kontrola programu s parametry Testovac´ı data pro tuto akci mus´ı m´ıt ve validation_data dvˇe sloˇzky: input_data a vysledky. Do input_data se dávaj´ı soubory, které budeme potˇrebovat jako vstup, a do vysledky se dá vzorov´ y textov´ y soubor, v˚ uˇci kterému budeme porovnávat v´ ystup studentovy u ´lohy. Porovnán´ı se provede metodou compareFiles() tˇr´ıdy StreamComparator. Dojde-li k nˇejaké chybˇe pˇri spouˇstˇen´ı programu, m˚ uˇze se stát, ˇze ve v´ ysledku validace bude chyba, ale nebudou uvedeny ˇza´dné dalˇs´ı podrobnosti. V této situaci je vhodné pod´ıvat se do doˇcasného pracovn´ıho adresáˇre, kam vlastn´ı akce Kontrola programu s parametry vygenerovává chybov´ y textov´ y soubor.

4.3

JUnit u ´ loha

Jedenáctá u ´loha má pouze jeden krok. V tomto kroku se pouˇzije akce Spuˇstˇen´ı custom validace pro spuˇstˇen´ı ValidationOOP11. Viz sekce 3.3.2 na stranˇe 30.

39

5 Závˇer Celá práce mˇela dva hlavn´ı c´ıle. Prvn´ım z nich bylo vyuˇzit´ı jiˇz existuj´ıc´ıho webového rozhran´ı pro uˇzivatelsky pˇr´ıjemnou konfiguraci validaˇcn´ıch domén (jeden pˇredmˇet typicky obsahuje nˇekolik validaˇcn´ıch domén). Popisovan´ yu ´kol byl proveden na 11 doménách pro pˇredmˇet KIV/OOP. Toto lze povaˇzovat za u ´spˇeˇsn´ y pilotn´ı projekt reálného nasazen´ı webového konfigurátoru. Cel´ y postup konfigurace domén byl d˚ uslednˇe popsán, takˇze se podle nˇej budou moci v budoucnu pˇr´ısluˇsn´ı vyuˇcuj´ıc´ı jin´ ych pˇredmˇet˚ u ˇr´ıdit. Protoˇze existuje konfigurace 11 domén, lze tento u ´kol povaˇzovat za splnˇen´ y. Druh´ y hlavn´ı u ´kol pˇredstavoval vytvoˇren´ı tˇr´ı kompletnˇe nov´ ych zásuvn´ ych modul˚ u. Tyto moduly umoˇzn ˇuj´ı principiálnˇe zcela odliˇsné zp˚ usoby validace studentsk´ ych u ´loh. Dˇr´ıve bylo moˇzné porovnávat jen textov´ y v´ ystup, v souˇcasné dobˇe mnou vytvoˇrené moduly umoˇzn ˇuj´ı porovnávat grafick´ y v´ ystup a téˇz kontrolu UML diagram˚ u. Nav´ıc byl splnˇen poˇzadavek na ovˇeˇren´ı moˇznosti libovolné programátorské kontroly, coˇz bylo tˇret´ım zm´ınˇen´ ym modulem splnˇeno. Vˇsechny tˇri zásuvné moduly jsou zcela funkˇcn´ı a jejich zdrojov´ y kód odpov´ıdá souˇcasn´ ym poˇzadavk˚ um (dokumentace apod.). Vˇsechny tˇri zm´ınˇené moduly jsou jiˇz souˇca´st´ı konfigurace v´ yˇse uveden´ ych validaˇcn´ıch domén. V dokumentu je také nav´ıc popsáno, jak rozˇs´ıˇrit pravidla pro statickou kontrolu zdrojového kódu pomoc´ı PMD. Kontrola pomoc´ı PMD se tak bude moci stát volitelnou souˇcást´ı validaˇcn´ıho procesu. Vˇsechny body zadán´ı byly splnˇeny a validaˇcn´ı domény jsou pˇripraveny k nasazen´ı. Celou práci na této problematice vˇsak nepovaˇzuji za dokonˇcenou. Hodlám zde v dalˇs´ım obdob´ı dále spolupracovat a to v rámci prob´ıhaj´ıc´ıho rozvojového projektu, na jehoˇz ˇreˇsen´ı se pod´ıl´ım. Lze totiˇz pˇredpokládat, ˇze v budoucnu – pˇri nasazen´ı v ostrém provozu – vzniknou poˇzadavky na dalˇs´ı rozˇsiˇrován´ı funkˇcnosti jak zásuvn´ ych modul˚ u, tak i samotn´ ych validaˇcn´ıch domén.

40

Seznam zkratek AST

Abstract Syntax Tree - stromová reprezentace syntaktické struktury zdrojového kódu

DOM

Document Object Model - multiplatformn´ı a jazykovˇe nezávislé rozhran´ı pro navigaci v XML dokumentech

HTML

Hypertext Markup Language - znaˇckovac´ı jazyk webov´ ych stránek

HTTP

Hypertext Transfer Protocol - internetov´ y protokol

JPEG

Joint Photographic Experts Group - formát pro ukládán´ı bitmapov´ ych obrázk˚ u ztrátovou kompres´ı

PNG

Portable Network Graphics - formát pro bitmapov´ ych obrázku bezztrátovou kompres´ı

SAX

Simple API for XML - jednoduché rozhran´ı pro parsován´ı XML dokument˚ u

SSH

Secure Shell - bezpeˇcn´ y s´ıt’ov´ y protokol

SVN

Apache Subversion - systém pro správu a verzován´ı zdrojov´ ych kód˚ u

UML

Unified Modeling Languange - standardizovan´ y jazyk pro modelován´ı programov´ ych systém˚ u

XML

Extensible Markup Language - znaˇckovac´ı jazyk

41

ukládán´ı

Literatura [1] BECK, K.: Test Driven Development: By Example. Addison-Wesley Professional, 2003, ISBN 0321146530. ´ V.: Webová konfigurace validaˇcn´ıho serveru. Bakaláˇrská práce, [2] DUDOVA, Západoˇceská univerzita v Plzni, Fakulta aplikovan´ ych vˇed, 2010. [3] HYNAR, M.: Java nástroje. Neocortex s.r.o., 2004, ISBN 08-86330-16-8. [4] MCLAUGHLIN, B.: Java & XML. O’Reilly, 2001, ISBN 0-596-00197-5. [5] SCHMULLER, J.: Mysl´ıme v jazyku UML. Grada publishing, 2001, ISBN 80-247-0029-8.

42

Webov´ e zdroje [6] XML Path Language (XPath) 2.0 (Second Edition) [Online]. Posledn´ı aktualizace v lednu 2011 [cit. 6. kvˇetna 2012], dostupné z: http://www.w3.org/TR/xpath20/. [7] CLARK, M.: JUnit FAQ [Online]. Posledn´ı aktualizace v u ńoru 2006 [cit. 6. kvˇetna 2012], dostupné z: http://junit.sourceforge.net/doc/faq/faq.htm. [8] JENSEN, J.: PMD - Welcome to PMD [Online]. Posledn´ı aktualizace v lednu 2012 [cit. 6. kvˇetna 2012], dostupné z: http://pmd.sourceforge.net/. [9] MEGGINSON, D.: Megginson Technologies: Simple API for XML [Online]. ©2012 [cit. 6. kvˇetna 2012], dostupné z: http://www.megginson.com/downloads/SAX/. [10] VALENTA, L.: Validaˇcn´ı server [Online]. Publikováno v záˇr´ı 2007 [cit. 6. kvˇetna 2012], dostupné z: http://vs.kiv.zcu.cz/doc/index.html. [11] VALENTA, L.: Podpora výuky - Uˇzivatelská pˇr´ıruˇcka [Online]. Posledn´ı aktualizace v ˇcervnu 2008 [cit. 6. kvˇetna 2012], dostupné z: http://portal.zcu.cz/zdroje/podporavyuky/help/.

43

A Ukázka custom validace import import import import import import import import import import

java.io.File; java.io.FileNotFoundException; java.io.FileOutputStream; java.io.OutputStream; java.net.MalformedURLException; java.net.URL; java.net.URLClassLoader; java.util.Arrays; java.util.HashSet; java.util.Set;

import javax.tools.JavaCompiler; import javax.tools.ToolProvider; import org.junit.runner.Result; import org.junit.runner.notification.Failure; import import import import

cz.zcu.validationserver.CustomValidation; cz.zcu.validationserver.ValidationResult; cz.zcu.validationserver.validation.FullValidationResult; cz.zcu.validationserver.validation.ValidationInfo;

/** * Trida pro kontrolu 11.ulohy z OOP pomoci CustomValidation. *

@author Duong Manh Hung, [email protected] / public class ValidationOOP11 implements CustomValidation { * *

// NUTNO ZMENIT na ostrem validatoru !!! final String JUNIT_JAR = ”/home/validator/validator/lib/junit−4.8.2.jar”; // final String JUNIT JAR = ”/home/valtest/val−test/lib/junit−4.8.2.jar”; static String[] hlaseni = { ”testSetJmeno: Chybne jmeno: expected: but was:”, ”testSetVyskaDolniRozsah: Chybna vyska: expected:<50> but was:<51>”, ”testSetVyskaHorniRozsah: Chybna vyska: expected:<250> but was:<251>”, ”testSetVahaVyjimka: Unexpected exception, expected<java.lang.IllegalArgumentException> but was<java.lang.IllegalAccessError>”, ”testSetVahaDolu: Chybna vaha: expected:<91.0> but was:<92.0>” }; @Override public void validate(ValidationInfo validationInfo, FullValidationResult fullValidationResult) { String osobaPath = validationInfo.getDomain().getDomainDir().getAbsolutePath() + File. separator + ”Osoba.jar”; File errorFile = new java.io.File(validationInfo.getWorkDir(), ”error.txt”); File inputFile = validationInfo.getInputFile(); OutputStream errorOutput = null; try { errorOutput = new FileOutputStream(errorFile); } catch (FileNotFoundException e1) { // TODO Auto−generated catch block

44

Ukázka custom validace

e1.printStackTrace(); } if (! ”OsobaTest.java”.equals(inputFile.getName())) { // vlozeni chyby do vysledku fullValidationResult.addError(”Soubor se nejmenuje OsobaTest.java!”, ValidationResult.VR_INVALID_INPUT); return; } if (inputFile.length() == 0) { // vlozim varovani do vysledku fullValidationResult.addWarning(”Odevzdany soubor je prazdny!”); return; } JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); // Zkompilovani poslaneho souboru // od 4.argumentu metody run jsou argumenty pro zkompilovani int compilationResult = −1; if (errorOutput != null) { compilationResult = compiler.run( null, null, errorOutput, ”−classpath”, JUNIT_JAR +”:” +osobaPath, ”−encoding”, ”UTF−8”, inputFile.getAbsolutePath()); } else { compilationResult = compiler.run( null, null, null, ”−classpath”, JUNIT_JAR +”:” +osobaPath, ”−encoding”, ”UTF−8”, inputFile.getAbsolutePath()); } if (compilationResult != 0) { fullValidationResult.addError(”Chyba pri kompilaci souboru OsobaTest.java”); } // Vsechny cinnosti se souborem jsou na serveru provadeny v tmp slozce ve workDir String workDirPath = inputFile.getAbsolutePath().replace(inputFile.getName(), ””); File testyDir = new File(workDirPath + ”testy”); testyDir.mkdir(); // Presunuti zkompilovaneho .class souboru do adresare testy ( kvuli classpath testy .OsobaTest) File classFile = new File(testyDir.getAbsolutePath() + File.separator + ”OsobaTest.class”); File oldClassFile = new File(inputFile.getAbsolutePath().replace(”java”, ”class”)); oldClassFile.renameTo(classFile); // Nahrani .class souboru do classpath File workDir = new File(workDirPath); File osobaJar = new File(osobaPath); URL url1 = null; URL url2 = null; try { url1 = workDir.toURI().toURL(); url2 = osobaJar.toURI().toURL(); } catch (MalformedURLException e) { // TODO Auto−generated catch block e.printStackTrace(); return; } URL [] urls = new URL[]{url1, url2}; ClassLoader cl = new URLClassLoader(urls);

45

Ukázka custom validace

Class cls = null; try { cls = cl.loadClass(”testy.OsobaTest”); } catch (ClassNotFoundException e) { fullValidationResult.addError(”Trida nebyla nalezena”); e.printStackTrace(); return; } Set<String> mnozinaHlaseni = new HashSet<String>(Arrays.asList(hlaseni)); // Spusteni tridy pod JUnit Result result = org.junit.runner.JUnitCore.runClasses(cls); fullValidationResult.addInfo(”Probehlo celkem: ” +result.getRunCount() +” testu.”); for (Failure fail: result.getFailures()) { String chyba = fail.getDescription().getMethodName() + ”: ” + fail.getMessage(); String tmp = chyba.replace(”<”, ”<”); tmp = tmp.replace(”>”, ”>”); if (mnozinaHlaseni.remove(chyba) == true) { fullValidationResult.addInfo(”Nalezeno: ” +tmp); } } int pocet = hlaseni.length − mnozinaHlaseni.size(); if (pocet < hlaseni.length) { fullValidationResult.addError(”Odhaleno pouze ” + pocet + ” chyb z ” + hlaseni.length +”. Zbyvaji chyby:”); System.out.println(); for (String hlaseni : mnozinaHlaseni) { // Nahrazeni <> entitami pro zobrazeni v HTML String resultMessage = hlaseni.replace(”<”, ”<”); resultMessage = resultMessage.replace(”>”, ”>”); fullValidationResult.addError(resultMessage); } } else { fullValidationResult.addInfo(”Odhaleny vsechny chyby.”); return; } } }

46

B Ukázka extern´ı vlastn´ı akce import import import import import import import import import import import import import

java.awt.Color; java.awt.Graphics2D; java.awt.Image; java.awt.Toolkit; java.awt.image.BufferedImage; java.awt.image.MemoryImageSource; java.awt.image.PixelGrabber; java.io.File; java.io.IOException; java.util.ArrayList; java.util.Arrays; java.util.Collection; java.util.List;

import javax.imageio.ImageIO; import org.mozilla.javascript.Context; import org.mozilla.javascript.Scriptable; import import import import import

cz.zcu.validationserver.gui.actions.ParametrAkce; cz.zcu.validationserver.gui.actions.VlastniAkce; cz.zcu.validationserver.gui.data.Parametr; cz.zcu.validationserver.validation.FullValidationResult; cz.zcu.validationserver.validation.ValidationInfo;

/** * Vlastni akce do weboveho rozhrani validatoru * Porovnava zdrojovy PNG obrazek (nahrany v domene) s prvnim PNG obrazkem * v pracovnim adresari momentalni validace. * (Pokud se odevzdava .jar, predpoklada se, ze se v drivejsim kroku rozbali ) * Vytvoreno pro predmet KIV/OOP *

@author Duong Manh Hung, [email protected] / public class PorovnatPNG implements VlastniAkce { * *

public void execute(ValidationInfo info, FullValidationResult result, Scriptable scope, Context jsContext, Collection<Parametr> parametry) { File workDir = info.getWorkDir(); String sampleImage = info.getDomain().getDomainProperties().getProperty(”image.sample name” ); if (sampleImage.isEmpty()) { result.addError(”Neni definovana vlastnost image.sample name.”); } // Existuje vzorovy obrazek? File validationImage = new File(workDir, sampleImage); if (! validationImage.exists()) { // vzorovy obrazek neexistuje ! result.addError(”Vzorovy ´ aobrzek pro validaci nebyl nalezen.”); return; }

47

Ukázka extern´ı vlastn´ı akce

File screenshot = new File(workDir, ”screenshot.png”); if (! screenshot.exists()) { // png obrazek neni v odevzdavanem jaru result.addError(”Nebyl nalezen vygenerovay screenshot.”); return; } Image sample = null; try { sample = ImageIO.read(validationImage); } catch (IOException e) { result.addError(”Pri nacitani vzoroveho obrazku nastala chyba.”); return; } Image comparedImage = null; try { comparedImage = ImageIO.read(screenshot); } catch (IOException e) { result.addError(”Pri nacitani odevzdavaneho obrazku nastala chyba.”); return; } PixelGrabber grab1 = new PixelGrabber(sample, 0, 0, −1, −1, false); PixelGrabber grab2 = new PixelGrabber(comparedImage, 0, 0, −1, −1, false); // Prevod obrazku na pole pixelu int [] data1 = null; int [] data2 = null; try { if (grab1.grabPixels()) { int width = grab1.getWidth(); int height = grab1.getHeight(); data1 = new int[width * height]; data1 = (int[])grab1.getPixels(); } } catch (InterruptedException e) { e.printStackTrace(); return; } try { if (grab2.grabPixels()) { int width = grab2.getWidth(); int height = grab2.getHeight(); data2 = new int[width * height]; data2 = (int[])grab2.getPixels(); } } catch (InterruptedException e) { e.printStackTrace(); return; } if (Arrays.equals(data1, data2)) { result.addInfo(”Graficky vystup je v poradku.”); } else { result.addError(”Graficky vystup neodpovida zadani.”);

48


int width = grab1.getWidth(); int height = grab1.getHeight(); int i = 0, j = 0; int [] diffData = new int[width int pixel;

*

height];

for (j = 0; j < height; j++) { for (i = 0; i < width; i++) { if (data1[i + j*width] == data2[i + j*width]) { pixel = data1[i + j*width]; diffData[i + j*width] = brighten(pixel); } else { diffData[i + j*width] = markDifference(); } } } MemoryImageSource mis = new MemoryImageSource(width, height, diffData, 0, width); Toolkit tk = Toolkit.getDefaultToolkit(); Image img = tk.createImage(mis); BufferedImage bufferedImage = new BufferedImage(img.getWidth(null), img.getHeight(null), BufferedImage.TYPE_INT_ARGB); Graphics2D g2 = bufferedImage.createGraphics(); g2.drawImage(img, null, null); String destinationPath = info.getDomain().getDomainProperties().getProperty(” html output dir”); destinationPath += ”/screenshots”; File imagesFolder = new File(destinationPath); imagesFolder.mkdir(); String diffImage = String.valueOf(”Diff ” +System.currentTimeMillis()) + ”.png”; try { ImageIO.write(bufferedImage, ”png”, new File(destinationPath + File.separator + diffImage)); } catch (IOException e) { result.addError(”Obrazek s rozdily se nepodarilo ulozit . ”) ; return; } String imageUrl = destinationPath.replace(”/var/www”, ”http://vs.kiv.zcu.cz”); result.addInfo(”Rozdily oproti spravnemu obrazku.”); } }

/** * Urcuje jak bude zvyrazneny odlisny pixel . *

@return ARGB hodnoty zvyraznovaci barvy. / private static int markDifference() { int pixel = 0xff000000; int red = 244; int green = 34; int blue = 58; * *

49


red = red << 16; green = green << 8; pixel = pixel | red | green | blue; return pixel; } /** * Zesvetleni pixelu . *

@param pixel Momentalne zpracovavany pixel. @return ARGB hodnoty zesvetlenyho pixelu. */ static int brighten(int pixel) { int red = (pixel >> 16) & 0xff; int green = (pixel >> 8) & 0xff; int blue = (pixel) & 0xff; * *

float [] hsbVals = Color.RGBtoHSB(red, green, blue, null); // Zmena saturace a svetlosti Color brighter = Color.getHSBColor(hsbVals[0], 0.2f * hsbVals[1], 0.5f

*

(1f + hsbVals[2]));

int redModified = brighter.getRed(); int greenModified = brighter.getGreen(); int blueModified = brighter.getBlue(); redModified = redModified << 16; greenModified = greenModified << 8; int pixelModified = pixel & 0xff000000; pixelModified = pixelModified | redModified | blueModified | greenModified; return pixelModified; } public String getNazev() { return ”Porovnat PNG (KIV/OOP)”; } public List<ParametrAkce> getParametry() { ArrayList<ParametrAkce> list = new ArrayList<ParametrAkce>(); return list; } public String getPopis() { return ”Akce a ´´ aporovnv y ´vygenerovan screenshot se y ´vzorovm ´ aobrzkem.”; } public String getHelp() { String help = ”
Kontextova napoveda: Vlastni akce \”Porovnat PNG (KIV/OOP)\”
”; help += ”
Akce slouzi k porovani studentova obrazku se vzorovym.
”; help += ”
Pokud se odevzdava JAR soubor, musi byt nejdrive rozbalen pomoci \”Rozbal ZIP \”.
”; help += ”
Aby tato akce fungovala, je treba do \”domain.xml\” teto domeny dopsat vlastnost ( pres WinSCP):
”; help += ”
<entry key=\”image.sample name\”>, kde hodnota je nazev vzoroveho obrazku i s priponou. ”; help += ”Napr. vzor.png
”; help += ”
Vzorovy obrazek se nahraje pres \”Nahrat vzorovy obrazek\”. (Na server se nahrava .zip soubor, kde je slozka,”; help += ”ve ktere je samotny vzorovy obrazek.)
”;

50


return help; } public String getId() { return ”PorovnatPNG”; } public String getKategorii() { return KAT_SOUBOR; }

}

51

C CD Readme [Dokumentace] Sloˇzka obsahuje pdf verzi bakal´ aˇrské práce a zdrojové tex soubory.

[Dom´ eny KIV-OOP] Obsahuje jednotlivé konfigurace validaˇcn´ıch domén KIV-OOP. V této sloˇzce jsou také odevzdané u ´lohy student˚ u z let 2011/2012 a 2010/2011, které slouˇzily jako testovac´ı data. Pro nasazen´ı na ostr´ y server staˇc´ı pˇrekop´ırovat domény ze souboru Uzivatel.xml do souboru webového rozhran´ı s naˇsimi jednotliv´ ymi doménami /home/validator/tomcat/webapps/ROOT/WEB−INF/data/nasOrionLogin.xml

a pˇrekop´ırovat domény z CD na server /home/validator/validator/data/domains

V domain.xml je pak jeˇstˇe nutno zmˇenit poloˇzky: <entry key=”html output dir”> <entry key=”html output url”>

aby odpov´ıdaly cestám na ostr´ y validaˇcn´ı serveru. [Moduly] Ve sloˇzce jsou potˇrebné knihovny pro vytvoˇren´ı modul˚ u a mnou vytvoˇrené moduly vˇcetnˇe jejich zdrojov´ ych kód˚ u.

[Ostatn´ı n´ astroje] Putty, WinSCP, PMD, UMLet

52

Západočeská univerzita v Plzni Fakulta aplikovaných věd Katedra informatiky a výpočetní techniky. a konfigurace domén validačního serveru

Recommend Documents

Nadpis

Kontextova napoveda: Vlastni akce \”Porovnat PNG (KIV/OOP)\”