...

Version 0.8, 2017-03-14

1Formål3
2Introduktion til projektet4
2.1Specielle bemærkninger4
1.1.1Wildfly4
1.1.2Databasevedligehold5
1.1.3XSD-vedligehold5
1.1.4MySQL versionsproblematikker5
3Opsætning af udviklingsmiljø6
3.1Bygge WAR filer6
3.2Opsætning af Eclipse6
4Deployment på Wildfly 8.2.08
5Beskrivelse af systemdesign9
6Beskrivelse af kildekodens struktur10
6.1Generelt design af webservices10
6.2Generelt design af Replikeringsjobbet10
6.3Generelt design af Opfølgningsjobbet (Backoffice)10
6.4Generelt design af behandlingsrelationsbiblioteket11
7Beskrivelse af test-setup12
7.1Unittests (Junit)12
7.2Integrationstests12
8Release af BRS13
9Ændringslog14

Anchor
__RefHeading___Toc13002_485590894 __RefHeading___Toc13002_485590894

Anchor
_Toc40578283 _Toc40578283

Anchor
_Toc477259155 _Toc477259155

Formål

Der skal udarbejdes dokumentation, som gør det muligt for andre end den oprindelige leverandør, at overtage videreudvikling af komponenten. Dokumentationen skal være rettet mod udviklere og IT-arkitekter, som ikke på forhånd har kendskab til komponenten, og som ikke har adgang til komponentens oprindelige udviklere.
Guiden kan f.eks. indeholde:

• Beskrivelse af opsætning og installation af udviklingsmiljø
• Beskrivelse af hvordan man bygger og tester komponenten, herunder krav til tredjepartskomponenter mv.
• Beskrivelse af systemdesign (evt. med henvisning til designdokument, hvis dette skønnes tilstrækkeligt)
• Beskrivelse af kildekodens strukturering.Hvilke grupperinger/biblioteker findes, hvad deres formål er og hvad de indeholder.
• Beskrivelse af test-setup, herunder krav til data, tilgængelige platforme og evt. eksterne komponenter/services.

...

Hvis man har adgang til FMKs Splunk-installation, kan man benytte følgende queries (mod test1) for at se FMKs afsendelse af registreringer og hentning af notifikationer:
Registreringer:
index=fmktest host="test1" source="*fmk-auditlog-modul.log" dk.nsi.fmk.auditlog.service.behandlingsrelation.registration Processing
Notifikationer:
index=fmktest host="*test1.recept.netic.dk" source="/pack/fmk_auditlog_modul/fmk-auditlog-modul.log" dk.nsi.fmk.auditlog.service.behandlingsrelation.notification.job NOT Executing

Anchor
__RefHeading___Toc13012_485590894 __RefHeading___Toc13012_485590894

MySQL versionsforskelle

...

Følgende software er nødvendigt for at bygge projektet

• En SVN klient (min. version 1.6.0)
• Java 8
• Maven (min. version 3.0.2)

Gennemfør følgende steps for at bygge WAR filer.

1. Check projektet ud fra NSP operatørens SVN

svn co https://svn.nspop.dk/svn/trifork/brs/trunk/ BehandlingsRelation

1. For opsætning af Maven, da byggeprocessen er tung, anbefales følgende indstillinger:

MAVEN_OPTS='-Xms128m -Xmx2048m -XX:MaxPermSize=1024m'

1. For at bygge projektet, foretage unittests samt at bygge war-filer foretages kommandoen

...

Det antages at Eclipse er installeret med et SVN og et Maven plugin. Til SVN anbefales Subclipse ({+}http://subclipse.tigris.org/+). Der findes et maven plugin på Eclipses marketplace. Derefter kan følgende step-by-step guide bruges til at klargøre Eclipse som udviklingsmiljø.

1. Start Eclipse, og vælg "Import -> SVN -> Checkout Projeckts from SVN"
2. Peg på følgende repository

{+}https://svn.nspop.dk/svn/trifork/brs/trunk/+

1. Vælg roden af SVN strukturen (burde ramme trunk) og checkout
2. Vælg "Next"
3. Vælg "Finish"
4. Vælg wizard'en "Java Project" og tryk "Next"
5. Giv projektet et passende navn og vælg "Finish". Vælg "Ok" i dialogen.
6. Højreklik på projektet og vælg "Maven" -> "Enable Dependency Management"
7. Vælg "Import -> Maven -> Existing Maven Projects"
8. Sæt flueben I alle projekterne og vælg "Finish"
9. Højreklik på projektet "common" og vælg "Maven -> Update Project Configuration"

...

Projektet er opdelt i følgende moduler:

• common – modul der indeholder de dele af koden der er fælles for komponenterne, herunder kode generet på baggrund af wsdl- og xsd-filer, databasehåndtering samt valideringsbiblioteket.
• brs-frontend – indeholder webservice til behandlingsrelations, webservice til notifikationsopslag, samt replicationjob, der periodisk overfører opsamlingsforespørgsler til backend-delen af systemet.
• brs-backend – indeholder webservice til modtagelse af opfølgninger fra frontend til backend-delen af systemet, followupjob til opfølgning og oprettelse af notifikationer, samt samt cleanupjob til sletning af notifikationer der er for gamle.
• integration – setup til integrationtest og stresstest. Bemærk at projektet er selvstændigt, og ikke er defineret som modul i stil med common, frontend og backend.
• performance – indeholder JMeter/Chronos tests, herunder maven mål til genering af test-data. Bemærk at dette modul ikke er ajourført, og pt. kun tjener som inspiration til hvordan en fremtidig struktureret performancetest kan udføres.
• dataload-maven-plugin – maven modul der benyttes af performance-test til oprettelsen af test-data.
• production – Hjælpe-klasser til udførelse af kald til et deployet system for at undersøge om det er fungerende.

...

Der er i projektet etableret unittests, som afvikles i forbindelse med Maven-byg af projektet og der er opnået høj code coverage. En rapport over code coverage generes automatisk af maven-jacoco-plugin i forbindelse med byg af projektet.

Anchor
_Toc477259168 _Toc477259168

Anchor
__RefHeading___Toc13038_485590894 __RefHeading___Toc13038_485590894

Integrationstests

...

Der kan også testes mod andre miljøer end localhost, men så vil man manuelt skulle lægge datagrundlaget ind i miljøet først.
Der henvises til filen README.txt, som beskriver hvordan testen afvikles i praksis, herunder hvordan testdata indlæses.

Anchor
__RefHeading___Toc13042_485590894 __RefHeading___Toc13042_485590894

Release af BRS

...

Kilden til dette dokument kan findes på:
{+}https://svn.nspop.dk/svn/trifork/brs/trunk/doc/+