1. Indholdsfortegnelse
2. Introduktion
2.1. Formål
Formålet med dette dokument er at beskrive hvordan et udviklingsmiljø, til videreudvikling af GM-Facade, 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 deployment-miljøet.
Kodestrukturen, kodemæssige afhængigheder til tredjeparts moduler og de forskellige servicemodulers ansvar og design beskrives sidst i dette dokument sammen med testdesign.
2.2. Sammenhæng med øvrige dokumenter
Dette dokument er en del af den samlede dokumentation for GM-Facade.
Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for GM-Facade.
2.3. Læsevejledning
Læser forventes at have kendskab til Java, Maven, Wildfly, Spring og NSP Access Handler.
2.4. Introduktion til GM-Facade
GM-Facade Snitfladen er defineret i GM-Facade - Guide til anvendere - Intern#Adgang%2Cbrugogsnitflader
GM-Facade er en Java-baseret komponent, der baserer sig på Java 21, WildFly 34.0.0 som applikationsserver, og anvender Jakarta Web Services (Jakarta WS) til eksponering af webservice-endpoints.
Design og arkitektur er beskrevet i GM-Facade - Design- og arkitekturbeskrivelse
3. Opsætning af udviklingsmiljø
I det følgende antages at koden er hentet fra git: https://git.nspop.dk/scm/com/graviditetsmappens-app-facade.git
3.1. Krav til software
GM-Facade deployeres til Docker vha. docker compose
Derudover er der krav til de anvendte udviklingsværktøjer:
- Maven 3.6.3 eller højere anvendes.
3.2. Bygge komponenten
Man skal bruge Maven til at bygge GM-Facade, hvilket gøres ved at køre kommandoen
|
mvn package |
Efter byg kan WAR filer findes her:
|
./service/target/gmaf.war |
4. Afvikling
Efter byg kan GM-Facade afvikles vha. Docker.
For at starte GM-Facade afvikles følgende kommando:
|
./docker-compose -f compose/development/docker-compose.yml build --pull ./docker-compose -f compose/development/docker-compose.yml up -d |
Bemærk, der findes også en docker compose opsætning i folderen "internal", som kan bruges til deploy mod docker setup som ikke tillader afvikling som root.
4.1. Beskrivelse af systemdesign
Systemdesign er beskrevet i GM-Facade - Design- og arkitekturbeskrivelse.
5. Beskrivelse af kildekodens strukturering og design
5.1. Kode strukturering
Kildekoden bygges vha Maven, og kildekoden er struktureret som Maven moduler. GM-Facade består af følgende moduler:
| cda-parser | Indeholder kode til at parse indholdet af cda-dokumenter til HL7 |
| fhir-generator | Indeholder kode til at oversætte hl7 til Fhir |
| service | Indeholder kode til udstilling endpoints |
| integration-test | Indeholder test der kræver en kørende instans |
5.2. Beskrivelse af testsetup
5.3. Unittests
JUnit anvendes til implementering af unit tests og kan afvikles som følger:
|
|
5.4. Integrationstests
Integrationstests afvikles med:
| mvn verify -P integration-tests -Dtest.url=http://localhost:8083 |
Dette forudsætter at alle services er startet som angivet i Afvikling
Hvis man ønsker af afvikle testen op mod en andet miljø f.eks. test1 eller test2, kan man angive det ved at ændre test url
6. Dokument Historik
| 3/4 2025 | Martin Henriksen/SDS | Etablering af dokumentation |
| 26/6 2025 | Thomas Glæsner | Udfyldt |