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.
Dette dokument er en del af den samlede dokumentation for CAVE.
Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for projektet CAVE 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) |
LAR service | Den service der kalder CAVE servicen. |
| HAPI | |
| FHIR | Fast Health Interoperability Resources |
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. Den udstillede FHIR snitflade sker ved anvendelse af HAPI FHIR frameworket.
Design og arkitektur er beskrevet: CAVE Design og Arkitekturbeskrivelse
I det følgende antages at koden er hentet ned fra SVN: https://svn.nspop.dk/svn/kvalitetsit/cave/
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 CAVE 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 CAVE Design og Arkitekturbeskrivelse
Kildekoden bygges vha Apache Maven, og kildekoden er struktureret som Maven moduler, som vist
nedenfor.
|
cave-service modulet indeholderapplikations logikken. Herunder validering, persistering via HAPI framework etc.
cave-war står for selve pakketeringen som WAR fil. Herunder JBoss specifikke deployment descriptor samt eksempel konfiguration (WildFly Modul).
cave-web er udenlukkende til brug i forbindelse med udvikling og test. Ved at eksekvere dette modul i Eclipse startes der en komplet CAVE service op inkl. en tom database. Databasen kører i en docker container ved hjælp af testcontainers.org. Dette modul pakkes IKKE med i WAR filen der laves i cave-war.
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 på to måder. De kan enten afvikles mod en vilkårlig JBOSS instans eller mod en installation i docker på den lokale maskine. Sidst nævnte metode sørger selv for at starte containere med database og applikationsserver. Det sker ved hjælpe af tescontainers.org.
Integrationstest mod vilkårliginstallaiton. Bemærk at denne metode kræver at CAVE servicen er installeret på en Wildfly applikationsserver.
mvn test -Pintegration-test -Dintegrationtestpropdir=src/test/integrationstest-localhost
Integrationstest mod docker containere.
DOCKER_RUN=true mvn -P integration-test clean install