Digiroad2

Ympäristön pystytys

1. Kloonaa digiroad2-repo omalle koneellesi

git clone https://github.com/finnishtransportagency/digi-road-2.git

1. Asenna node.js (samalla asentuu npm)
2. Asenna bower

npm install -g bower

1. Hae ja asenna projektin tarvitsemat riippuvuudet hakemistoon, johon projekti on kloonattu

npm install && bower install

1. Asenna grunt

npm install -g grunt-cli

Tietolähteet käyttäjä- sekä tie- ja kohdetiedoille

Digiroad2 käsittelee ja käyttää tie- ja kohdetietoja joihin pääsy on toteutettu AssetProvider - rajapinnan kautta. Pääsy käyttäjätietoihin toteutetaan UserProvider - rajapinnan kautta.

Projekti tarjoaa Oraclen tietokantaan integroituvat toteutukset digiroad2-oracle moduulissa.

Tuki vaihtoehtoisille käyttäjä- sekä tie- ja kohdetietokannoille on saavutettavissa toteuttamalla AssetProvider ja UserProvider - rajapinnat.

digiroad2-oracle

digiroad2-oracle moduuli toteuttaa oracle-spesifisen tuen digiroad2:n AssetProvider ja UserProvider - rajapinnoista. Moduuli tuottaa kirjaston, joka lisätään ajonaikaisesti digiroad2-sovelluksen polkuun.

Build edellyttää, että paikallinen tietokantaymäristö on alustettu ja konfiguroitu:

Luo digiroad2/digiroad2-oracle/conf/dev/bonecp.properties ja lisää sinne tietokantayhteyden tiedot:

bonecp.jdbcUrl=jdbc:oracle:thin:@<tietokannan_osoite>:<portti>/<skeeman_nimi>
bonecp.username=<käyttäjätunnus>
bonecp.password=<salasana>

Tietokantayhteyden voi määrittää myös ulkoisessa properties tiedostossa joka noudattaa yllä olevaa muotoa.

Tällöin digiroad2/digiroad2-oracle/conf/dev/bonecp.properties tiedosto viittaa ulkoiseen tiedostoon:

digiroad2-oracle.externalBoneCPPropertiesFile=/etc/digiroad2/bonecp.properties

Tietokanta ja skeema voidaan alustaa käyttäen fixture-reset.sh skriptiä.

Ajaminen

Buildin rakentaminen:

grunt

Testien ajaminen:

grunt test

Kehitysserverin pystytys:

grunt server

Kehitysserveri ajaa automaattisesti testit, kääntää lessit ja toimii watch -tilassa.

Kehityspalvelin ohjaa API-kutsut API-palvelimelle. Jotta järjestelmä toimii tulee myös API-palvelimen olla käynnissä.

API-palvelin

API-palvelimen buildia käsitellään sbt:llä, käyttäen projektin juuressa olevaa launcher-skriptiä sbt. Esim.

./sbt test

API-palvelimen saa käyntiin kehitysmoodiin seuraavalla sbt komennolla:

./sbt '~;container:start; container:reload /'

Esim CI-ympäristössä Oracle-tietokanta ei ole käytettävissä, jolloin buildille pitää välittää system property "digiroad2.nodatabase" arvolla "true". Vastaavasti buildille voi välittää kohteena oleva ympäristö propertyllä "digiroad2.env" (arvot "dev", "test", "prod" tai "ci"). Esim.

./sbt -Ddigiroad2.nodatabase=true -Ddigiroad2.env=dev test

"digiroad2.env":n arvo määrittää sen, minkä ympäristön konfiguraatiotiedostot otetaan käyttöön (hakemistosta conf/(env)/)

Windowsissa toimii komento:

run fi.liikennevirasto.digiroad2.ProductionServer

Käyttäjien lisääminen ja päivittäminen CSV-tiedostosta

Palvelun käyttäjien tietoja voi päivittää ja uusia käyttäjiä voi lisätä CSV - tiedostosta, jossa on määritelty uusien ja päivitettävien käyttäjien käyttäjänimet sekä kuntatunnukset joihin näillä käyttäjillä tulisi olla oikeudet.

Alla esimerkki CSV-tiedostosta:

kuntakäyttäjä; ;105, 258, 248, 245;
olemassaolevatunnus; ;410, 411, 412, 413;
elykäyttäjä;0,1,2,3,4,5,6,7,8,9;

Käyttäjiä voi päivittää ja lisätä käyttäen import-users-from-csv.sh skriptiä:

./import-users-from-csv.sh <digiroad2-palvelin:portti> <ylläpitäjän-tunnus> <polku-csv-tiedostoon>

Pysäkkitietojen vienti Vallu-järjestelmään

Järjestelmä tukee pysäkkitietojen vientiä Vallu-järjestelmään. Pysäkkitiedot toimitetaan .csv-tiedostona FTP-palvelimelle. Vienti käynnistetään ajamalla vallu_import.sh skripti. Skripti hakee pysäkkitiedot kannasta käyttäen projektille määriteltyä kohdetieto-tietolähdettä.

FTP-yhteys ja kohdekansio tulee määritellä ftp.conf-tiedostossa joka on tallennettu samaan polkuun vallu_import.sh skriptin kanssa. ftp.conf-tiedostossa yhteys ja kohdekansio määritellään seuraavalla tavalla:

<käyttäjänimi> <salasana> <palvelin ja kohdehakemisto>

Esimerkiksi:

username password localhost/valluexport

Vienti luo FTP-palvelimelle pysäkkitiedot zip-pakattuna .csv-tiedostona nimellä digiroad_stops.zip sekä flag.txt-tiedoston joka sisältää Vallu-viennin aikaleiman muodossa vuosi (4 merkkiä), kuukausi (2 merkkiä), päivä (2 merkkiä), tunti (2 merkkiä), minuutti (2 merkkiä), sekunti (2 merkkiä). Esimerkiksi 20140417133227.

Pysäkit jotka palvelevat ainoastaan raitiovaunuliikennettä poistetaan valluviennistä.

Käyttöönotto kopioi ympäristökohtaisen ftp.conf-tiedoston käyttöönottoympäristön deployment-hakemistosta release-hakemistoon osana käyttöönottoa. Näin ympäristökohtaista ftp.conf-tiedostoa joka sisältää kirjautumistietoja voidaan ylläpitää tietoturvallisesti käyttöönottopalvelimella. Katso deploy.rb-tiedosto.

Käyttöönotto ja version päivitys