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. Derudover forventes kendskab til docker-compose.

Dokument historik

Definitioner og referencer

Introduktion til LAR servicen

LAR servicen udstiller en SOAP service med to tre SOAP actions. En action til at læse data, en til at oprette data og en action til at hente opdatere 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/kvalitetsitcomponents/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

Derudover er der en række krav til de anvendte udviklingsværktøjer:

...

• 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. 

• docker-compose version 3.4 eller højere

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. Dette kan gøres vha. docker-compose:

Efter start af docker-compose kan larservicen tilgåes på localhost port 8082. Servicens wsdl kan f.eks. tilgåes på http://localhost:8082/lar/MedicationAllergyService?wsdl

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:

brs-client modulter indeholder forretningslogikken til at kalde behandler relation servicen.

common modulet indeholder delt funktionalitet mellem de andre moduler. 

consent-client modulet indeholder forretningslogikken til at kalde samtykke servicen. 

minlog-reg-client modulet indeholder forretningslogikken til at kalde min log. 

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-cave modulet indeholder funktionalitet til at kalde CAVE servicen og konvertering af data fra det FHIR format CAVE servicen returnerer og det LAR snitfladen definerer. 

larservice-consent modulet indeholder funktionalitet til at kalde MinSpærring. 

larservice-dgws modulet indeholder funktionalitet til at validere DGWS headeren og opbygge en request context.

larservice-health modulet indeholder funktionalitet til at udstille information om servicens health.  

larservice-treatmentrelation modulet indeholder funktionalitet til at kalde BRS.  

larservice-types modulet indeholder WSDL og XSD'er samt de genererede typer til snitfladen. 

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:

mvn test -Pintegration-test   -Dconsentadministration.endpoint=http://test1-cnsp.ekstern-test.nspop.dk:8080/consent-administration/service -Dlarservice.wsdl=http://localhost:80658082/larservicelar/MedicationAllergyService?wsdl

(samme 2 parametre skal angives ved kørsel i IDE, f.eks. for Eclipse i VM arguments i en run configuration)

Bemærk at dette forudsætter, at LAR Service er deployeret på JBoss-serveren, da integrationstestene afvikles imod kørende service(s). Det forudsættes også at CAVE servicen er tilgængelig. Se flere detaljer i test vejledning under integrationstest.

Performance test

Se næste afsnit 7 Udvikling af performance test

Udvikling af performance test

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

...

I det følgende antages at koden er hentet ned fra SVN: https://svn.nspop.dk/svn/kvalitetsitcomponents/cave-performance/trunk/  samt at man har docker installeret i sit udviklingsmiljø. Lokal JMeter installation er ikke nødvendig.Hvis ikke nedenstående fremgangsmåder fungerer umiddelbart, kan der hentes hjælp i filen README, der ligger i roden i projektet. Denne indeholder information om software og OS platformJMeter skal også være tilgængelig.

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, men i nedestående er Lar servicens dele trukket frem.

doc: indeholder Arosiis vejledning til brug af frameworket

environment: 

jmeter-docker: indeholder det, som muliggør at køre JMeter i en docker container

kit-vagrant:

modules: indeholder kildekoden til de forskellige test, herunder LAR servicen. Der findes også 2 lister over cpr numre. cpr.txt indeholder få, for hurtigt test af testen. cprSample indeholder den fulde liste af 50.000 cprnumre, der passer med performance test data.

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

(planer og distributioner) .

Versionskontrol

Test versionen styres vha. af revision i trunk. i dokumentet "testvejledning" afsnit performance test angives, hvilken version af performance testen der anvendes med en given version af LAR servicen.Æ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.

• ListAllergyRequestSamplerGui: indeholder skærmbillede logik til at kunne angive input parametrene til LAR servicen
• ListAllergyRequestSampler: indholder logik til at lave det faktisk web service kald med de angivne input værdier

Ved ændringer hvor der typisk sættes nye felter på i  ListAllergyRequestSamplerGui og disse anvendes herefter i ListAllergyRequestSampler. Derefter bygges med 

...

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 udviklet og bygget test projektet, som angivet i forrige afsnit, startes JMeter op med

docker run -it --net=host -e DISPLAY=$DISPLAY -v ${PWD}/tests/:/tests/ -v /tmp/.X11-unix:/tmp/.X11-unix -v ~/.Xauthority:/root/.Xauthority:ro kvalitetsit/cave-performance

Herefter . Herefter kan en eksisterende performance test åbnes og køres herfra. Eller en ny kan laves. Filerne kan gemmes lokalt udenfor docker containeren. 

Det følgende skærmbillede viser den skærm, som er udviklet i ListAllergyRequestSamplerGui med data hentet fra en gemt test:

...

Den endelige kørsel af performance testen skal bruge en test plan (skabes når ovenstående test gemmes) samt en distribution, der indeholder 'Distribution' delen af ovenstående. De gemmes henholdsvis i tests/larservicelar/src/test/jmeter/templates/testplans og tests/larservicelar/src/test/jmeter/templates/distributions

...