1. Introduktion

1.1. Formål

Formålet med dette dokument er at beskrive hvordan et udviklingsmiljø, til videreudvikling af DROS, 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.

1.2. Sammenhæng med øvrige dokumenter

Dette dokument er en del af den samlede dokumentation for DROS.

Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for DROS.

1.3. Læsevejledning

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

Hvor der i teksten er angivet <component base> refereres til topniveaufolderen for kildekoden for komponenten.

1.4. Dokument Historik

1/3 2021Eva Troels/KITUdarbejdet ved etableringen af DROS

1.5. Introduktion til DROS

Alle DROS services udstiller en SOAP service. Snitfladen er defineret i en WSDL fil og en række XSD filer. 

Alle DROS services er Java baserede komponenter, der baserer sig på Java 8 og Spring frameworket.

Design og arkitektur er beskrevet: DROS - Design- og arkitekturbeskrivelse.

2. Opsætning af udviklingsmiljø

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

2.1. Krav til software

DROS deployeres vha. docker, hvorfor de alle baserer sig på NSP platformens base image, hvori der findes nødvendigt software til afvikling.

Derudover er der krav til de anvendte udviklingsværktøjer:

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

2.2. Bygge WAR filer

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

mvn package


Efter byg kan WAR filer findes her:

./dros-war/target/dros.war

3. Afvikling

Der henvises til installationsvejledningen for nærmere instrukser.

3.1. Udviklers workstation

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

Dette kan gøres vha. docker-compose:

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

Når DROS er startet er, svarer den på:

NB! I udviklingssetup'et peges der på det på NSP TEST1 installerede OpenText registry. Dette gøres for, at svarene for DROS bliver korrekte, også i development setup. Integrationstestene kan derfor køres mod development. Det er nødvendigt, at docker-compose setup (og integrationstesten) afvikles på en maskine, der er whitelistet til at tilgå NSP TEST1 XDS registry.

I docker-compose setup i development er tilknytningen til NSP TEST1 XDS registry lavet på følgende måde:

  1. OpenXDS repository (openxds-server) peger på registry url http://registryproxy:80/registry/services/xds-iti42 gennem opsætning af følgende ENV variable: XDS_REGISTRY_HOST, XDS_REGISTRY_PORT og DS_REGISTRY_URL
  2. I docker-compose filen for development er registryproxy en opsætning af nginx. Konfigurationen af denne findes i filen compose/configuration/nginx.conf
  3. I denne konfigurationsfil (nginx.conf) er https://test1-cnsp.ekstern-test.nspop.dk:8443 defineret som målet for requests.

Ovenstående setup blev indført, da der var problemer med at få OpenXds til at tale direkte med XDS registry på TEST1 pga issues med HTTPS.

3.2. Beskrivelse af systemdesign

Systemdesign er beskrevet i DROS - Design- og arkitekturbeskrivelse.

4. Beskrivelse af kildekodens strukturering og design

4.1. Kode strukturering

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

dros-xds

Sætter dependencies op i forhold til openehealth framework (en række exclusions er tilrådelige for at anvende dette framework på NSP).

Modulet indeholder også konfigurationsklasse til konfiguration af ITI-backends. Dette anvendes både af internt af DROS (til NSP XDS backends) samt til integrationstestene for DROS.

Derudover inderholder modulet statiske koder (f.eks. OID for CPR registeret og SOR), der anvendes rundt om i DROS.

dros-testutilitiesHjælpeklasser, der både skal bruges af unit tests samt af integrationstests for DROS ligger her.
dros-appDROS service- og forretningsfunktionalitet er samlet her. Se DROS - Design- og arkitekturbeskrivelse for en grundigere beskrivelse af strukturen i dette modul.
dros-war

Modul, der er ansvarlig for at pakke DROS som en NSP service - herunder angivelse af modulafhængigheder i deploymentdescriptor.

Indeholder også Dockerfile til selve byg af Docker image.

dros-qa

Integrationstest for DROS

dros-testreportModul til at samle jacoco test reports og beregne samlet test coverage.

4.2. Beskrivelse af testsetup

4.3. Unittests (JUnit)

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

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

mvn test

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

4.4. Integrationstests

Integrationstests ligger i modulet dros-qa og kan afvikles med:

mvn verify -Pintegration-test

Dette forudsætter at alle services er startet som angivet i docker-compose setuppet.

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

  • No labels