Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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 sidst4 (Generelt design af DDS Registry og Repository).

Sammenhæng med øvrige dokumenter

...

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

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

...

Alias

Beskrivelse

Oversigt

Dokumentdelingsservice (DDS)

DGWS

Den Gode WebService 1.0.1

Design

DDS - Design- og Arkitekturbeskrivelse

Installationsvejledning

DDS - Installationsvejledning

Min-log

MinLog2 - Design og Arkitektur beskrivelse

SAM

MinSpærring - Arkitektur og Design

SAM-guide

MinSpærring - Guide til Udviklere

Minlog-guide

MinLog2 - Min Log Registrering - Guide til udviklere

...

Introduktion til DDS Registry og Repository

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

Webservicene tillader anvender systemer at

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

  • foretage udtræk af patient specifikke dokumenter fra XDS dokument kildesystemer. Den filtrerer dokumenterne DDS filtrerer under visse omstændigheder dokumentindholdet baseret på borgerens samtykker.

...

Opsætning af udviklingsmiljø

I det følgende antages at koden er hentet ned fra softwarebørsen el.lign.DDS source koden ligger i SVN på følgende URL: https://svn.nspop.dk/svn/components/dds/

Krav til software

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

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

  • Maven

...

  • 3.0.3 eller højere

...

  • .

Krav til Docker

...

  • Docker 18.x eller højere.
  • docker-compose version 1.23.x eller højere

...

  • .

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)

...

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:

...

Aktuel code coverage beregnes også af Jenkins. Se https://jenkins.nspop.dk/.

Afvikle komponenten

Efter byg kan DDS afvikles vha docker-compose. Til dette formål findes compose-setup i mappen compose.

For at starte DDS afvikles følgende kommando (build parameteren sikrer, at DDSens Docker images bygges):

cd compose/development

docker-compose

...

up

...

--build

Vent på at setuppet kommer op (loggen falder til ro).

Integrationstest

For at køre integrationstesten gøres følgende. DDS komponenten afvikles i docker-compose som beskrevet ovenfor.

Dernæst kan integrationstestene startes med følgende kommandoer:

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

DDS består af to overordnede applikationer: DDS Registry og DDS Repository, der kan bygges (som war-filer og senere som Docker images) og afvikles uafhængig af hinanden.

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

...

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

Servicen er implementeret sikret ved brug af Den Gode Webservice [DGWS], hvor Seal.Java er anvendt anvendelse af NSP Security API til at håndtere sikkerhed og DGWS headers(i praksis DGWS og IDWS).

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.

Beskrivelse af kildekodens struktur og design

Koden er bygge op som et hierarki af maven moduler. De enkelte moduler er beskrevet nedenfor:

  • types: modul der indeholder wsdl’er og xml-skemafiler i SOAP 1.2 version. Anvendes til at kommunikere med DDS backend XDS Repositories og XDS Registries.
  • minspaerring-client: modul til kommunikation med MinSpærring (tjek af spærringer)
  • brs-client: modul til kommunikation med BRS
  • stamdata-lookup-client: modul til kommunikation med stamdata-lookup (personinformation)
  • common: diverse fællesmoduler, der anvends både af DDS Repository og DDS Registry
  • ddsregistry:
    • application: DDS Registry specifikke klasser og funktionalitet
    • war: pakker DDS Registry som en web applikation
  • ddsrepository:
    • application: DDS Repository specifikke klasser og funktionalitet
    • war: pakker DDS Repository som en web applikation
  • testreport: samler de enkelte coverage reports op for de forskellige moduler til en samlet rapport
  • integrationstest
    • nsp-service-clients: modul til oprettelse af testdata i eksterne services (MinSpærring)
    • dds-xds-testclient: modul med fælles testfunktionalitet (ikke afhængig af sikkerhedsprotokol)
    • dds-dgws-testclient: DGWS integrationstests
    • dds-oioidws-testclient: IDWS integrationstests