AgilElephant Tekijä: Petri Kalsi Omistaja: ElectricSeven Dokumentti:.doc Päiväys: 15.03.2005 Aihe: Sivu 1 of 6
Dokumenttihistoria Muutoshistoria Revision Revision Yhteenveto muutoksista Revision tekijä Numero Päiväys 1.0 11.03.05 Ensimmäinen versio Petri Kalsi Hyväksyjät Tämä dokumentti vaatii seuraavien henkilöiden hyväksymiset Nimi Juha Kaarlas Tehtävä Projektipäällikkö Dokumentti:.doc Päiväys: 15.03.2005 Aihe: Sivu 2 of 6
Sisällysluettelo 1. Esittely...4 1.1 Tarkoitus...4 2. Eclipse...5 2.1 Projektin luominen...5 2.2 Kirjastot...5 3. Ant...6 3.1 Antin konfigurointi...6 3.2 Ant-taskit...6 Dokumentti:.doc Päiväys: 15.03.2005 Aihe: Sivu 3 of 6
1. Esittely 1.1 Tarkoitus Tämän dokumentin tarkoitus on lyhyesti kuvata, miten AgilElephantin kehitystyökalut, kuten Eclipse ja Ant, otetaan käyttöön. Dokumentti ei pyri olemaan täydellinen käyttöohje. Dokumentissa keskitytään tuomaan esille joitakin ryhmämme havaitsemia kompastuskiviä kehitystyökalujen käyttöön liittyen. Dokumentti:.doc Päiväys: 15.03.2005 Aihe: Sivu 4 of 6
2. Eclipse Eclipse on open source IDE, joka on suunnattu erityisesti Javalla tehtävää ohjelmistokehitystä varten. 2.1 Projektin luominen Projektin luomiseen on käytännössä kaksi vaihtoehtoa: valmiin asennuspaketista puretun hakemistopuun pohjalta, tai CVS:stä lataamalla. Ensimmäisessä tapauksessa luodaan uusi Java-projekti, ja valitaan Create project at external location. Kyseiseen tekstikenttään kirjoitetaan projektin juurihakemisto, esim. C:\java\agil\., jonka alta löytyvät mm. hakemistot code, sql ja docs. CVS:stä projektia luotaessa syötetään CVS-repositoryn tiedot, ja Eclipse lataa projektin tiedostot valittuun workspacen sijaintiin levyllä. Synkronointi repositoryn kanssa tapahtuu right-click-menun Team-valikon alta. CVS:stä luomisen haittapuolena on se, että projekti ei tällöin ole Java-tyyppiä, ja Eclipsen monet ominaisuudet jäävät käyttämättä. Havaitsin, että kätevin tapa luoda projekti on ensin ladata jollain toisella ohjelmalla (esim. WinCVS) projektin tiedostot CVS:stä levylle, ja luoda uusi Java-projekti kyseisen hakemiston pohjalta. Eclipse osaa supistaa pitkät pakettien polunnimet, mikäli projekti on Java-tyyppiä. Tällä tavalla luvussa 2.2 mainitut kirjastot tuntuvat myös asentuvan automaattisesti oikein. Eclipse myös tunnistaa valmiit hakemistossa olevat CVS-tiedot. Käyttämämme CVS-repository löytyy seuraavalla tunnisteella: :extssh:username@qa.soberit.hut.fi:/home/agilelephant/ Palvelin vaatii käyttäjätunnuksen ja salasanan. 2.2 Kirjastot Eclipsen useiden toimintojen toimimisen kannalta on tärkeää, että projektin käyttämät kirjastot asetetaan kohdalleen. J2EE ja JBossin kirjastot tulee tarvittaessa lisätä valikon Project Properties Java Build Path Libraries alle. Monet virheilmoitukset kuten EJBObject cannot be resolved liittyvät usein vaillinaisiin library-määrityksiin. Dokumentti:.doc Päiväys: 15.03.2005 Aihe: Sivu 5 of 6
3. Ant Projektin kääntämiseen käytetään Ant-työkalua. Antin asentamiseen löytyy ohjeita sivulta http://ant.apache.org/. PATH-ympäristömuuttujaan tulee lisätä hakemisto \ant\bin\, ja Java SDK:n binhakemisto. J2SE SDK riittää, sillä JBoss sisältää tarvittavat osat J2EE:stä. 3.1 Antin konfigurointi Ennen Antin käyttöönottoa täytyy tiedostoon build.xml tehdä muutoksia. Tiedoston alussa on määritelty eri ohjelmien asennushakemistot, lähdekoodin sijainti ym. hakemistoja, ja MySQL:n tunnukset ja salasanat. Nämä tiedot ovat usein erilaiset jokaisella kehittäjällä. Muita muutoksia tiedostoon ei pitäisi tarvita. 3.2 Ant-taskit Yleisimmin tarvittava ant-task on deploy. Tämä task kääntää kaikki ohjelmiston lähdekoodit, ja paketoi agile.ear-nimisen paketin JBossin käytettäväksi. Paketti siirretään JBossin deploy-hakemistoon. Mikäli JBoss on jo käynnissä, se huomaa paketin muuttuneen, ja lataa uuden paketin käyttöön. JBossin uudelleenkäynnistystä ei siis vaadita. Muita kääntämiseen liittyviä taskeja ovat clean, compile ja clean-compile. Yksikkötestit voi ajaa taskilla test-all. Testien ajaminen vaatii, että JBoss on käynnissä. MySQL-tietokannan voi nollata ja alustaa testidatalla taskilla recreate-db. Kannan alustuksessa käytettävät sql-insertit sijaitsevat hakemistossa agil\sql\. Dokumentti:.doc Päiväys: 15.03.2005 Aihe: Sivu 6 of 6