Introduktion

Formål

Formålet med dette dokument er at beskrive hvordan et udviklingsmiljø, til videreudvikling af DDS registry og Repository, kan sættes op, samt hvordan koden bygges, deployes og testes.

I afsnit 3 (Opsætning af udviklingsmiljø) beskrives de softwaremæssige krav der er til miljøet samt hvordan kode bygges.

I afsnit 4 (Beskrivelse af systemdesign) beskrives deployment-miljøet.

Kodestrukturen, kodemæssige afhængigheder til tredjeparts moduler og de forskellige servicemodulers ansvar og design beskrives i afsnit 6.

Testdesign findes i afsnit 7.

TODO: få styr på afsnit og overskifter til sidst

Sammenhæng med øvrige dokumenter

Dette dokument er en del af den samlede dokumentation for DDS projektet.

Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for projektet: Dokumentdelingsservice (DDS).

Læsevejledning

Læser forventes at have kendskab til Java softwareudvikling med anvendelse af Maven, WildFly applikationsserver og MySQL.

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

Dokumenthistorik

Dokumentet er oprettet med udgangspunkt i 2 separate Guide til udviklere for registry henholdsvis repository. Den videre redigeringshistorik efter dette tidspunkt fremgår af confluence "Page History".

Definitioner og referencer

TODO: tjek om alias bliver brugt

Introduktion til DDS Registry og Repository

Realisering af DDS registry og repository består af en Java-baseret webservices.

Webservicene tillader anvender systemer at

• lave forespørgsler til dokumentdelingsservice og få metadata om patientinformationer, der er gemt deri, retur. Den filtrerer resultatet baseret på borgerens samtykker.

• foretage udtræk af patient specifikke dokumenter fra XDS dokument kildesystemer. Den filtrerer dokumenterne baseret på borgerens samtykker.

Servicene validerer brugerens rettigheder, kalder behandlingsrelationsservicen og gemmer eventuelle relevante oplysninger i borgerens Min-log.

For en dybere introduktion til servicen og baggrunden bag, se "DDS - Guide til anvendere" og "DDS - Design- og Arkitekturbeskrivelse".

Opsætning af udviklingsmiljø

I det følgende antages at koden er hentet ned fra softwarebørsen el.lign.

Krav til software

Krav til applikationsserveren, operativsystemet og databasen er de samme som til produktionsmiljøet. De specifikke krav kan ses i [Installationsvejledning] afsnit 2.

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

Krav til Maven

Maven 3.0.3 eller højere anvendes.

Krav til Docker

Docker 18.x eller højere anvendes.

Bygge komponenten

Udfør følgende kommando for at bygge komponenten:

mvn clean install

Det tager lidt tid, da der skal genereres kode ud fra et større antal wsdl-filer.

Unit test (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:

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

Integrationstest

For at køre integrationstesten gøres følgende:

Byg DDS, som beskrevet ovenfor

Udfør følgende kommandoer:

cd compose/development
docker-compose up --build

Vent på at setuppet kommer op.

cd integrationstest

mvn verify -Plocal,integration-tests

Det er muligt at ramme andre miljøer end det lokale ved at udskifte local med test1 eller test2.

TODO

...

: hvor meget skal med fra gl repository guide i afsnit "Beskrivelse af kildekodens struktur og design" og hvor opdateret er den?

TODO: Og hvad med Cobertura til code coverage. Source koden har referncer her til. Evt. flyttes til test vejledningen?

Generelt design af DDS Registry og Repository

Servicene består af en række Maven-moduler, der findes under dds/ddsregistry og dds/ddsrepository

• application: Indeholder webservice og forretningslogik

• war: Bygger war-filen der skal deployes

• integrationtest: Indeholder integrationstests af webservicene

Derudover er der en række generelle designvalg for servicen:

Servicen er implementeret ved brug af Den Gode Webservice [DGWS], hvor Seal.Java er anvendt til at håndtere sikkerhed og DGWS headers.

JAX-WS er anvendt til kodegenerering ud fra WSDL-filer og JAXB er anvendt til kodegenerering ud fra XSD-filer.

Servicen er implementeret som en Java-webservice.