Page History
- Introduktion
- Opsætning af udviklingsmiljø
- Deployment på Wildfly
- Beskrivelse af kildekodens strukturering og design
Introduktion
Formål
Formålet med dette dokument er at beskrive hvordan et udviklingsmiljø, til videreudvikling af CAVE, 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.
Sammenhæng med øvrige dokumenter
Dette dokument er en del af den samlede dokumentation for CAVE.
Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for projektet FSK Registry Adapter.
Læsevejledning
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.
Definitioner og referencer
Definition | Beskrivelse |
NSP | Den nationale service platform (inden for sundheds-IT) |
LAR service | Den service der kalder CAVE servicen. |
Introduktion til CAVE servicen
CAVE servicen udstiller en standard FHIR REST snitflade.
CAVE servicen er en Java baseret komponent, der baserer sig på Java 8 og Spring Boot frameworket.
Design og arkitektur er beskrevet: FSK Registry 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/fskregistry
Krav til software
Krav til applikationsserveren og operativsystemet er de samme som til produktionsmiljøet. De specifikke krav kan ses i Installationsvejledning for FSK Registry Adapter
Derudover er der en række krav til de anvendte udviklingsværktøjer:
Maven 3.0.3 eller højere anvendes.
Bygge WAR filen
Man skal bruge Apache Maven til at bygge FSK Registry, hvilket gøres ved at køre kommandoen
$ mvn clean install
Efter by kan den installerbare WAR fil findes her:
/fskregistry-war/target/fskregistry.war
Deployment på Wildfly
Der henvises til installationsvejledningen Installationsvejledning for FSK Registry Adapter 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 FSK Registry Design og Arkitekturbeskrivelse
Beskrivelse af kildekodens strukturering og design
Kode strukturering
Kildekoden bygges vha Apache Maven, og kildekoden er struktureret som Maven moduler, som vist
nedenfor.
|
fskregistry-xds modulet indeholder koden til selve ITI-18 servicen.
fskregistry-app indeholder applikationslogikken - f.eks. den konkrete validering af patient id, beregning af DocumentEntry samt SQL kaldene mod databasen
fskregistry-war står for selve pakketeringen som WAR fil. Herunder JBoss specifikke deployment descriptor samt eksempel konfiguration (WildFly Modul).
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-tests -Dintegrationtestpropdir=src/test/integrationstest-localhost
Bemærk at dette forudsætter, at FSK Registry er deployeret på JBoss-serveren, da integrationstestene afvikles imod kørende service(s).