Indholdsfortegnelse

Introduktion

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.

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.

Læsevejledning

Læser forventes at have kendskab til Java, Maven og Spring.

Introduktion til GM-Facade

GM-Facade Snitfladen er defineret i GM-Facade - Guide til anvendere#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

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

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.

Bygge komponenten

Man skal bruge Maven til at bygge GM-Facade, hvilket gøres ved at køre kommandoen

Efter byg kan WAR filer findes her:

Afvikling

Efter byg kan GM-Facade afvikles vha. Docker.

For at starte GM-Facade afvikles følgende kommando:

Udviklers workstation

Når man udvikler kan det være praktisk at foretage lokal deployment.

Dette kan gøres vha. ....:

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

Når GM-Facade er startet, svarer den på:

• Services: Se ...

Beskrivelse af systemdesign

Systemdesign er beskrevet i GM-Facade - Design- og arkitekturbeskrivelse.

Beskrivelse af kildekodens strukturering og design

Kode strukturering

Kildekoden bygges vha Maven, og kildekoden er struktureret som Maven moduler. GM-Facade består af følgende moduler:

Beskrivelse af testsetup

Unittests

??? anvendes til implementering af unit tests. Der er kontinuert gennemført unit tests på alle komponenter i projektet.

Unit tests afvikling under byg vha ??? plugin for Maven, men kan separat afvikles ved at køre:

Hvis der derimod laves en verify, så vil der også blive genereret code coverage, hvor fremkommende rapport kan ses i testreport/target/site/jacoco-aggregate/index.html

Integrationstests

Integrationstests ligger i modulet ??? og kan afvikles med:

Dette forudsætter at alle services er startet som angivet i ??? setuppet

Hvis man ønsker af afvikle testen op mod en andet miljø f.eks. test1 eller test2 henvises til GM-Facade - Testvejledning.

Dokument Historik