Indhold

Introduktion

Formål

Formålet med mked 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 Der forefindes også en beskrivelse af de forskellige servicemodulers modulers 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 CAVE Servicesamt hvordan unit og integrationstest afvikles.  .

Læsevejledning

Læser forventes at have kendskab til Java softwareudvikling med anvendelse af Maven og WildFly. Derudover forventes kendskab til docker-compose.Hvor der i teksten er angivet <component base> refereres til topniveaufolderen for kildekoden for komponenten.

Dokument historik

Definitioner og referencer

Introduktion til CAVE servicen

CAVE servicen udstiller en standard FHIR REST snitflade. 

...

Design og arkitektur er beskrevet: CAVE - 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/cave/

Krav til software

Krav til applikationsserveren og operativsystemet er de samme som til produktionsmiljøet. De specifikke krav kan ses i ????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.
• 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

Efter by byg kan den installerbare WAR fil findes her:

/cave-war/target/cave.war

Deployment på Wildfly

Der henvises til installationsvejledningen CAVE - 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 CAVE servicen tilgåes på localhost port 8080 (http://localhost:8080/cave/fhir). 

Beskrivelse af systemdesign

Systemdesign er beskrevet i CAVE - 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.

...

cave-war står for selve pakketeringen som WAR fil. Herunder JBoss specifikke deployment descriptor samt eksempel konfiguration (WildFly Modul).

cave-web er udenlukkende udelukkende 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.

cave-testclient er konfiguration af en web test client. Den kan bruges til at læse cave oplysninger i forbindelse med test og udvikling. 

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 der ikke kan skrives til SLA loggen
  • 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 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.

mvn test -Pintegration-test -Dintegrationtestpropdir=src/test/integrationstest-localhost

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 Se flere detaljer i test vejledning under integrationstest for at køre mod lokal Wildfly.

...

DOCKER_RUN=true mvn -P integration-test clean install