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.
Først beskrives de softwaremæssige krav, der er til miljøet, samt hvordan kode hentes og bygges. Dernæst beskrives deploymentmiljøet.
Kodestrukturen, kodemæssige afhængigheder til tredjeparts moduler og de forskellige servicemodulers ansvar og design beskrives sidst i dette dokument sammen med testdesign.
Læser forventes at have kendskab til Java softwareudvikling med anvendelse af Maven og WildFly. Derudover forventes kendskab til docker-compose.
Dato | Ansvarlig | Beskrivelse |
---|---|---|
26/2-2018 | KvalitetsIT | Initiel version |
07/04-2021 | KvalitetsIT | Justeringer i forhold til docker-compose anvendelse |
Reference | Beskrivelse |
NSP | Den nationale service platform (inden for sundheds-IT) |
FHIR | Fast Health Interoperability Resources |
DGWS | Den Gode Web Service |
LAR servicen udstiller en SOAP service med tre SOAP actions. En action til at læse data, en til at oprette data og en til at opdatere data. Snitfladen er defineret i en WSDL fil og en række XSD filer.
LAR servicen er en Java baseret komponent, der baserer sig på Java 8 og Spring Boot frameworket. Den udstiller SOAP snitfladen ved hjælp af Apache CXF.
Design og arkitektur er beskrevet: LAR - Design- og Arkitekturbeskrivelse
I det følgende antages at koden er hentet ned fra SVN: https://svn.nspop.dk/svn/components/lar/ og MSB-util fra https://svn.nspop.dk/svn/kvalitetsit/msbutil/.
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:
Man skal bruge Apache Maven til at bygge CAVE servicen, hvilket gøres ved at køre kommandoen
$ mvn clean install
Efter byg kan den installerbare WAR fil findes her:
/cave-war/target/cave.war
Der henvises til installationsvejledningen LAR - Driftsvejledning for nærmere instrukser.
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
Systemdesign er beskrevet i LAR - Design- og Arkitekturbeskrivelse
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.
Kildekoden bygges vha Apache Maven, og kildekoden er struktureret som Maven moduler, som vist nedenfor:
|
larservice-app modulet indeholder forretningslokken logikken.
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).
Logning i applikationsloggen gøres efter følgende regler:
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 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:8082/lar/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. Det forudsættes også at CAVE servicen er tilgængelig. Se flere detaljer i test vejledning under integrationstest.
Se afsnit 7 Udvikling af performance test
Performance testen foregår vha. et test framework udviklet af Arosii.
Performance testen består af 2 dele:
Udvikling og opsæt er beskrevet i nærværende dokument, mens den faktiske udførsel af testen er beskrevet i LAR Testvejledning.
Performance testen skal passe til LAR servicens snitflade. Ændres denne er det også nødvendigt at ændre performance testen.
I det følgende antages at koden er hentet ned fra SVN: https://svn.nspop.dk/svn/components/performance/trunk/ samt at man har docker installeret i sit udviklingsmiljø. JMeter skal også være tilgængelig.
Kildekoden indeholder også performance test til andre services, men i nedestående er Lar servicens dele trukket frem.
.
|
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 (planer og distributioner) .
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.
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.
Når man har udviklet og bygget test projektet, startes JMeter. Herefter kan en eksisterende performance test åbnes og køres herfra. Eller en ny kan laves.
Det følgende skærmbillede viser den skærm, som er udviklet i ListAllergyRequestSamplerGui med data hentet fra en gemt test:
Når man starter testen (den grønne pil) aktiveres et kald mod den service, der er konfigureret under 'Host configuration' og hermed aktiveres koden fra ListAllergyRequestSampler.
Resultatet kan ses under 'View Result Tree', hvor både kald og svar kan ses.
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/lar/src/test/jmeter/templates/testplans og tests/lar/src/test/jmeter/templates/distributions