Indhold

Introduktion

Formål

Formålet med dette dokument er at beskrive, hvordan et udviklingsmiljø til videreudvikling af LAR servicen, kan sættes op, samt hvordan koden bygges, deployes og testes.

...

Kodestrukturen, kodemæssige afhængigheder til tredjeparts moduler og de forskellige servicemodulers ansvar og design beskrives sidst i dette dokument sammen med testdesign.

Læsevejledning

Læser forventes at have kendskab til Java softwareudvikling med anvendelse af Maven og WildFly.

Dokument historik

Definitioner og referencer

Introduktion til LAR servicen

LAR servicen udstiller en SOAP service med to SOAP actions. En action til at læse data og en action til at hente data. Snitfladen er defineret i en WSDL fil og en række XSD filer. 

...

Design og arkitektur er beskrevet: LAR - Design- og Arkitekturbeskrivelse

Opsætning af udviklingsmiljø

I det følgende antages at koden er hentet ned fra SVN: https://svn.nspop.dk/svn/kvalitetsit/lar/ og MSB-util fra https://svn.nspop.dk/svn/kvalitetsit/msbutil/.

Krav til software

Krav til applikationsserveren og operativsystemet er de samme som til produktionsmiljøet. De specifikke krav kan ses i https://www.nspop.dk/display/public/web/Husregler+for+udvikling+til+NSP

...

Maven 3.0.3 eller højere anvendes.

Byg af MSB-util

LAR servicen anvender hjælpe pakken MSB-util. MSB-Util sørger for at kalde MinLog, BehandlerRelation og samtykke. MSB-Util bygges med nedenstående kommando. Resultatet er en jar fil i target folderen under hvert maven modul. 

$ mvn clean install

Bygge WAR filen

Man skal bruge Apache Maven til at bygge CAVE servicen, hvilket gøres ved at køre kommandoen
$ mvn clean install

...

/cave-war/target/cave.war

Deployment på Wildfly

Der henvises til installationsvejledningen LAR - Driftsvejledning for nærmere instrukser.

Udviklers workstation

Når man udvikler kan det være praktisk at foretage deploy til en lokal Wildfly.

Beskrivelse af systemdesign

Systemdesign er beskrevet i LAR - Design- og Arkitekturbeskrivelse

Beskrivelse af kildekodens strukturering og design

Kode strukturering for MSB-Util

Kildekoden bygges vha Apache Maven, og kildekoden er struktureret som Maven moduler, som vist nedenfor:

...

msb-util-interface indeholder interface definitioner samt input og output definitioner til de forskellige services. Dette giver en afkopling mellem interface og implementering for dem der skal anvende MSB-util. 

Kode strukturering for LAR

Kildekoden bygges vha Apache Maven, og kildekoden er struktureret som Maven moduler, som vist nedenfor:

...

larservice-war står for selve pakketeringen som WAR fil. Herunder JBoss specifikke deployment descriptor samt eksempel konfiguration (WildFly Modul).

Logningsstrategi

Logning i applikationsloggen gøres efter følgende regler:

• Fejl logges med værdier når relevant
  • Dette kan f.eks. være valideringsfejl
  • Det må ikke være personhenførbar information
• Der logges med følgende niveauer:
  • DEBUG: anvendes til at kunne følge en given logik. Mellemregninger.
  • INFO: anvendes til at informere om et givet resultat, f.eks. hvad værdien er, når der opstår en valideringsfejl
  • ERROR: anvendes i fejlsituationer, hvor driften skal adviseres, f.eks. når MinLog ikke svarer
  • TRACE: anvendes typisk i ind og udgange af metoder

Beskrivelse af testsetup

Unittests (JUnit)

JUnit anvendes til implementering af unit tests. Der er kontinuert gennemført unit tests på alle komponenter i projektet.

Unit tests kan afvikles ved at køre:

mvn test

Integrationstests

Integrationstests kan afvikles ved at køre:

...

Bemærk at dette forudsætter, at LAR Service er deployeret på JBoss-serveren, da integrationstestene afvikles imod kørende service(s).

Performance test

Se afsnit 7 Udvikling af performance test

Udvikling af performance test

Performance testen foregår vha. et test framework udviklet af Arosii.

...

Hvis ikke nedenstående fremgangsmåder fungerer umiddelbart, kan der hentes hjælp i filen readme, der ligger i folderen jmeter-docker i projektet. Denne indeholder information om software og OS platform.

Kildekode struktur

Kilde koden er udleveret af Arosii og eftefølgende tilrettet til LAR service projektet. Kildekoden indeholder også performance test til andre services. Om disse er opdateret til kørende version af disse services er ikke sikkert, men kan tjene til inspiration til fremtidig udvikling af performance test.

...

tests: indeholder de generede test filer og eventuelle hjælpe filer. For LAR servicens vedkommende indeholder folderen udover test filer et database dump med 50.000 allergier og den tilhørenede liste af cpr numre.

Versionskontrol

Ændringer til cave-performance skal tagges i SVN med samme release, som den lar version rettelsen gælder. 

Udvikling af test

LAR servicens performance test består af tre java sourcer, hvoraf der reelt er logik i to af dem, og som skal vedligeholdes ved LAR snitflade ændringer.

...

Ved at anvende profilen "dockerbuild" bliver der samtidig oprettet et docker image, som anvendes, når man starter JMeter op (se næste afsnit)

Generering af test filer 

Når man har bygget test projektet, som angivet i forrige afsnit, startes JMeter op med

...