1. Indhold

2. Introduktion

2.1. Formål

Formålet 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.

Der forefindes også en beskrivelse af de forskellige modulers ansvar samt hvordan unit og integrationstest afvikles.  .

2.2. Læsevejledning

Læser forventes at have kendskab til Java softwareudvikling med anvendelse af Maven og WildFly. Derudover forventes kendskab til docker-compose.

2.3. Dokument historik

Dato

Ansvarlig

Beskrivelse

5/2-2018KvalitetsITInitiel version
07/04-2021KvalitetsITJusteringer i forhold til docker-compose anvendelse

2.4. Definitioner og referencer

Reference

Beskrivelse

NSP

Den nationale service platform (inden for sundheds-IT)

LAR service

Den service der kalder CAVE servicen.

HAPI

HAPI FHIR Framework

FHIRFast Health Interoperability Resources

2.5. 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. Den udstillede FHIR snitflade sker ved anvendelse af HAPI FHIR frameworket.  

Design og arkitektur er beskrevet: CAVE - Design- og Arkitekturbeskrivelse

3. Opsætning af udviklingsmiljø

I det følgende antages at koden er hentet ned fra SVN: https://svn.nspop.dk/svn/components/cave/

3.1. Krav til software

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:

  • Maven 3.0.3 eller højere anvendes.
  • docker-compose version 3.4 eller højere

3.2. 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 byg kan den installerbare WAR fil findes her:

/cave-war/target/cave.war

4. Deployment på Wildfly

Der henvises til installationsvejledningen CAVE - Driftsvejledning for nærmere instrukser.

4.1. 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:

docker-compose -f compose/development/docker-compose.yml up --build

Efter start af docker-compose kan CAVE servicen tilgåes på localhost port 8080 (http://localhost:8080/cave/fhir). 

4.2. Beskrivelse af systemdesign

Systemdesign er beskrevet i CAVE - Design- og Arkitekturbeskrivelse

5. Beskrivelse af kildekodens strukturering og design

5.1. Kode strukturering

Kildekoden bygges vha Apache Maven, og kildekoden er struktureret som Maven moduler, som vist nedenfor.

.

├── cave-service

├── cave-web

├── cave-testclient

├── cave-war
    └── src
        ├── main
        │   ├── java
        │   ├── resources
        │   └── webapp
        │       └── WEB-INF
        │           ├── jboss-deployment-structure.xml
        │           └── web.xml
        └── test
            ├── conf
            │   ├── cave.properties
            │   ├── log4j-nspslalog-cave.properties
            │   ├── log4j.properties
            │   ├── module.xml
            │   └── nspslalog-cave.properties
            ├── installation
                └── cave-ds.xml

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 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. 

5.2. 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

6. Beskrivelse af testsetup

6.1. 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


6.2. 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.

Integrationstest mod vilkårlig installation
mvn test -Pintegration-test -Dintegrationtestpropdir=src/test/integrationstest-localhost

Bemærk at denne metode kræver at CAVE servicen er installeret på en Wildfly applikationsserver. Se flere detaljer i test vejledning under integrationstest for at køre mod lokal Wildfly.


Integrationstest mod docker containere
DOCKER_RUN=true mvn -P integration-test clean install




  • No labels