Introduktion

Formål

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

Sammenhæng med øvrige dokumenter

Dette dokument er en del af den samlede dokumentation for FSK Registry.

Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for projektet FSK Registry Adapter.

Læsevejledning

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

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

Definitioner og referencer

Introduktion til FSK Registry

FSK Registry udstiller netop een web service - ITI-18 Registry Stored Query.

FSK Registry er en Java baseret komponent, der baserer sig på Java 8 og Spring frameworket. Der anvendes Spring Boot som konfiguration og konventionsværktøj omkring Spring Frameworket.

Design og arkitektur er beskrevet: FSK Registry Adapter - Design og Arkitekturbeskrivelse

Opsætning af udviklingsmiljø

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

Krav til software

Krav til applikationsserveren og operativsystemet er de samme som til produktionsmiljøet. De specifikke krav kan ses i FSK Registry Adapter - Installationsvejledning

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

Maven 3.0.3 eller højere anvendes.

Docker 18.09.6 eller højere anvendes.

Docker Compose 1.23.2 eller højere anvendes.

Bygge WAR filen

Man skal bruge Apache Maven til at bygge FSK Registry, hvilket gøres ved at køre kommandoen
$ mvn clean install

Efter byg kan den installerbare WAR fil findes her:

/fskregistry-war/target/fskregistry.war

Deployment på Wildfly

Der henvises til installationsvejledningen FSK Registry Adapter - Installationsvejledning for nærmere instrukser.

Udviklers workstation

Når man udvikler kan det være praktisk at foretage deploy til lokal applikationsserver.

Da vi bruger docker og docker-compose, så gøre dette ved at kalde:
docker-compose -f compose/development/docker-compose.yml up --build

Beskrivelse af systemdesign

Systemdesign er beskrevet i FSK Registry Adapter - Design og Arkitekturbeskrivelse

Beskrivelse af kildekodens strukturering og design

Kode strukturering

Kildekoden bygges vha Apache Maven, og kildekoden er struktureret som Maven moduler, som vist
nedenfor.

.
├── compose
    └── configuration
    │   ├── fskreg.properties
    │   ├── log4j-fskregistry-ws.xml
    │   ├── log4j-nspslalog-fskreg.properties 
    │   ├── log4j.properties
    │   ├── module.xml
    │   ├── fsk-ds.xml
    │   └── nspslalog-fskreg.properties
    └── database
    └── development
    │   └── nspslalog-fskreg.properties
    └── test
    │   └── docker-compose.yml
    └── release
        └── docker-compose.yml
├── fskregistry-qa
├── fskregistry-xds
├── fskregistry-app
├── fskregistry-war
    └── src
        ├── main
        │   ├── java
        │   ├── resources
        │   └── webapp
        │       └── WEB-INF
        │           ├── jboss-deployment-structure.xml
        │           └── web.xml
        └── test
            ├── conf
            │   ├── fskreg.properties
            │   ├── fskreg.properties_old
            │   ├── fskreg.properties_tilrettet
            │   ├── log4j-fskregistry-ws.xml
            │   ├── log4j-nspslalog-fskreg.properties 
            │   ├── log4j.properties
            │   ├── module.xml
            │   └── nspslalog-fskreg.properties
            ├── installation
                └── fsk-ds.xml

compose indeholder alle filer som skal bruges til at starte FSK Registry vha. docker-compose. Eneste undtagelser er fskregistry-war/Dockerfile og fskregistry-war/target/fskregistry.war

fskregistry-qa modulet indeholder en code coverage rapport.

fskregistry-xds modulet indeholder koden til selve ITI-18 servicen.

fskregistry-app indeholder applikationslogikken - f.eks. den konkrete validering af patient id, beregning af DocumentEntry samt SQL kaldene mod databasen

fskregistry-war står for selve pakketeringen som WAR fil. Herunder JBoss specifikke deployment descriptor samt eksempel konfiguration (WildFly Modul). 

Beskrivelse af testsetup

Unittests (JUnit)

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

Unit tests kan afvikles ved at køre:

mvn test

Integrationstests

Integrationstests kan afvikles ved at køre:

mvn test -Pintegration-tests -Dintegrationtestpropdir=src/test/integrationstest-localhost

Bemærk at dette forudsætter, at FSK Registry er deployeret på JBoss-serveren, da integrationstestene afvikles imod kørende service(s).