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.
Dette dokument er en del af den samlede dokumentation for LAR.
Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for projektet LAR Service.
Læser forventes at have kendskab til Java softwareudvikling med anvendelse af Maven og WildFly.
Hvor der i teksten er angivet <component base> refereres til topniveaufolderen for kildekoden for komponenten.
Definition | 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 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.
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/kvalitetsit/lar/
Krav til applikationsserveren og operativsystemet er de samme som til produktionsmiljøet. De specifikke krav kan ses i ????
Derudover er der en række krav til de anvendte udviklingsværktøjer:
Maven 3.0.3 eller højere anvendes.
Man skal bruge Apache Maven til at bygge CAVE servicen, hvilket gøres ved at køre kommandoen
$ mvn clean install
Efter by 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.
Systemdesign er beskrevet i LAR Design og Arkitekturbeskrivelse
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-dgws modulet indeholder funktionalitet til at validere DGWS headeren og opbygge en request context.
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).
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:8065/larservice/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).