1. Introduktion

1.1. Formål

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

Først beskrives de softwaremæssige krav, der er til udviklingsmiljøet, herunder hvordan kode hentes og bygges. Dernæst beskrives deploymentmiljøet.

1.2. Læsevejledning

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

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

2. Opsætning af udviklingsmiljø

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

2.1. Krav til software

AO XDS Adaptere 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 (16+)
  • docker-compose version 3.4 eller højere.

3. Kildekodens struktur og design

3.1. Modulopbygning

Kildekoden bygges vha Apache Maven, og kildekoden er struktureret som Maven moduler. Følgende moduler findes i AO XDS Adaptere:

ModulBeskrivelse
AO Appointments Provider StubStub til at emulere en bookplan backend. Pakkes som en Wildfly applikation (WAR)
AO Appointment Stub Integration TestIntegrationstests til AO Appointments Provider Stub
AO Provider CommonFælleskode, der benyttes både af AO Document Metadata Provider og AO Document Provider
AO Provider CacheKode til at gemme/hente/slette AO XDS Adapters aftaledokumenter i database
AO Document Metadata Provider

Modul til implementation af dokumentsøgning (ITI-18) - dvs "registry-delen" af AO XDS Adaptere samt forretningslogik.

Modulet har til ansvar at fremfinde dokumentmetadata og reagerer på søgeparametre givet ved forespørgsel på dokumentmetadata.

Modulet har yderligere til opgave at danne de konkrete dokumenter svarende til de fremsøgte metadata og gemmer disse dokumenter i AO Provider Cache.

AO Document Metadata Provider WarPakker AO Document Providere som en Wildfly applikation (WAR)
AO Document Metadata Provider Integration TestIntegrationstests til AO Document Metadata Provider. Modulet har til ansvar at fremfinde dokumenter i AO Provider Cache og reagerer på søgeparametre givet ved forespørgsel på dokumenter.
AO Document Provider

Modul til implementation af dokumenthentning (ITI-43) - dvs "repository-delen" af AO XDS Adaptere samt forretningslogik.

Modulet har til opgave at udsøge de forespurgte dokumenter i AO Provider Cache.

AO Document Provider WarPakker AO Document Provider som en Wildfly applikation (WAR)
AO Document Provider Integration TestIntegrationstests til AO Document Provider
AO Document Sharing Integration TestIntegrationstests for RN og RM udgaver af AO XDS Adaptere. Tester fremsøgning af dokumentreferencer (ITI-18) samt afhentning af dokumenter (ITI-43)

3.2. Services

Ovenstående modulliste opsumerer kodens struktur.

Tre af modulerne producerer installerbare services (WAR filer).

Det drejer sig om følgende:

  • AO Appointments Provider Stub: Denne service anvendes kun til udvikling og emulerer en bookplan backend til levering af aftaledata.
  • AO Document Metadata Provider War: Denne service implementerer "registry-delen" af AO XDS Adaptere. Dette er et generelt modul, der kan konfigureres til hhv. Region Nord (RN) og Region Midt (RM) ved hjælp af konfigurationsfiler.
  • AO Document Provider War: Denne service implementerer "repository-delen" af AO XDS Adaptere. Dette er et generelt modul, der kan konfigureres til hhv. Region Nord (RN) og Region Midt (RM) ved hjælp af konfigurationsfiler.

JAX-WS er anvendt på baggrund af artefakter fra DDS skabt ved kodegenerering ud fra WSDL-filer og XSD-filer.

3.3. Byg af AO XDS Adaptere

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

mvn package


Efter byg kan WAR filer findes her:

./appointmentsstub/appointmentsstub/target/appointmentsstub.war

./xdswrappers/documentmetadataprovider/documentmetadataprovider-war/target/ao-documentmetadataprovider.war

./xdswrappers/documentprovider/documentprovider-war/target/ao-documentprovider.war

Disse tre WAR filer svarer til de beskrevne services i forgående afsnit.

3.4. Deployering af AO XDS Adaptere

Efter byg kan det være nyttigt at lave en deployering af de genererede services (WAR).

Til udviklingsformål er der udarbejdet en mængde docker-compose setups. Disse ligger i

./compose/development/docker-compose.<conf>.<apd-version>.yml

conf angiver, hviklen konfiguration man ønsker at starte (rn = Region Nord, rm = Region Midt).

apd-version angiver, hvilken version af Medcoms profilering af aftaledokumenter (se), der skal anvendes (v11 = version 1.1, v20 = version 2.0).

Det relevante docker-compose setup startes med følgende kommando:

./compose/development/docker-compose -f docker-compose.<conf>.<apd-version>.yml up --build

Docker-compose setup'et startere både AO XDS Adapter services samt bagvedliggende database service og mock Bookplan service. Når alle services er startet kan WSDL for de deployede AO XDS Adapter services nåes på følgende URL'er:

3.5. Test af AO XDS Adaptere

Der er udviklet både unit tests og integrationstests til AO XDS Adaptere. Struktur og afvikling af  disse beskrives i det følgende.

3.5.1. Unit tests

Der er udviklet en række unit tests til de forskellige moduler i AO XDS Adaptere.

Maven sørger for afvikling af unit tests som en del af byg af AO XDS Adaptere.


Unit tests kan også køres efter et byg med kommandoen:

mvn test


Hvis man ønsker at få opsamlet testresultaterne (og beregnede test coverage) i en samlet rapport vha Maven plugin'et jacoco, kan følgende kommando anvendes:

mvn verify

Denne kommando afvikler unit tests og opsamler test coverage rapporten i følgende directory:

./testreport/target/site/jacoco-aggregate/

Rapporten kan med fordel åbnes i en browser, da den er genereret i både xml og html format.

3.5.2. Integrations tests

Der er udviklet en række integrationstests til AO XDS Adapter.

Disse kan være nyttige at afvikle på udviklermaskinen.

Afviklingen forudsætter, at AO XDS Adaptere er bygget og deployeret (ved opstart af docker-compose setup i konfigurationen docker-compose.main.v20.yml) som beskrevet ovenfor.

Denne kommando afvikler integrationstests fra rodfolderen i AO projektet:

mvn verify -Pexternal-test -Dtestclient-property-file=../../../integrationtest/src/test/resources/testclient.properties

Bemærk, at det er en bestemt konfiguration, der skal startes (main+APD version 2.0), for at integrationstestene fungerer.

3.5.3. Test coverage

Til beregning af testcoverage anvendes Jacoco. Se beskrivelsen ovenfor.


  • No labels