Overblik

Dette dokument beskriver projektstrukturen i Organdonorregister-servicen og har derudover til formål at gøre det muligt for andre end den oprindelige leverandør at overtage videreudvikling af projektet. Dokumentet bygger videre på informationen beskrevet i de andre dokumenter tilhørende projektet.

Projektet er opbygget som et Maven multi-module project, hvor nogle moduler kompilerer til jar-filer og andre til war-filer. De nævnes her i den rækkefølge de kompileres:

• odr-parent

  • odr-schemas
    JAX-WS-artifakt generator genererer Java-klasser ud fra projektets WSDL-filer.

  • odr-service
    Selve servicens funktionalitet.

  • odr-service-wildfly
    Wildfly-specifik funktionalitet.

  • odr-migration
    Migreringskomponent.

  • odr-datagenerator
    Datageneratorkomponent til brug ifm. migrering.

  • odr-test-data-creator
    Datageneratorkomponent til brug ifm. performancetesting.

For at kunne fungere med DGWS og IDWS forudsættes at DGWS/IDWS Proxy Service også er installeret.  Der henvises til guide for udviklere for proxy'en for nærmere beskrivelse af denne.

Ændringslog

Afvikling af unit-tests

For at afvikle unit-tests skal en MariaDB-database være tilgængelig.

I udviklingssammenhæng kan man oprette de nødvendige database-schemas vha. scriptet compose/database/db/create_db.sql. I application.properties-filen i projektet er datasources som default sat til at anvende root-user med tomt password. Database-strukturen bliver automatisk oprettet vha. Flyway SQL-scripter, når unit-testene afvikles.

Datasourcen i testafviklingen auto-konfigureres vha. Spring Boot som anvender database-credentials fra ltr-btr-service/src/test/resources/application.properties.

Projektet skal være fuldt bygget for at lokale dependencies er på plads, og dernæst kan unit tests afvikles med følgende Maven kommando:

mvn clean test

Der genereres desuden en testrapport.

Databasevedligehold

Servicen benytter i udviklingssammenhæng Flyway, hvilket gør at databasen i udviklingsmiljøet automatisk opdateres til gældende version.

XSD-vedligehold

XSDerne der eksporteres og benyttes i servicen ligger i modulet organdonor-schema. Der genereres JAXB-klasser som defineret i modulets pom.xml

Adgange

Der er behov for adgange til følgende systemer:

• NSP SVN-repository
• Dependencies trækkes fra NSP's Nexus-repository: https://nexus.nspop.dk

Opsætning af udviklingsmiljø

Al kode findes i NSP SVN.

Efter at projektet er checket ud vil man typisk gøre følgende:

• Opsætte udviklingsmiljø (her antages IntelliJ)

• Bygge war-filen med Maven og køre tests

Bygge WAR filer

Følgende software er nødvendigt for at bygge projektet

• En Subversion-klient

• Java 8

• Maven

• MariaDB

Gennemfør følgende steps for at bygge WAR filer:

1. Installér og start MariaDB

2. Klon projektet fra SVN

3. Opret database via førnævnte SQL-script

4. For at bygge projektet, foretage unittests samt at bygge war-filer foretages kommandoen: mvn clean install

Deployment med Docker

Når man udvikler kan det være praktisk at deploye applikationen lokalt. Dette kan gøres vha. Docker Compose-filen under compose/development/docker-compose.yml.

docker-compose up -d --build