Introduktion

Formål

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

Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for projektet LAR Service.

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 LAR servicen

LAR servicen udstiller en SOAP service med to SOAP actions. En action til at læse data og en action til at hente data. Snitfladen er defineret i en WSDL fil og en række XSD filer. 

LAR  servicen er en Java baseret komponent, der baserer sig på Java 8 og Spring Boot frameworket. Den udstiller SOAP snitfladen ved hjælp af Apache CXF.

Design og arkitektur er beskrevet: LAR Design og Arkitekturbeskrivelse

Opsætning af udviklingsmiljø

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

Krav til software

Krav til applikationsserveren og operativsystemet er de samme som til produktionsmiljøet. De specifikke krav kan ses i ????

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

Maven 3.0.3 eller højere anvendes.

Bygge WAR filen

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

Efter by kan den installerbare WAR fil findes her:

/cave-war/target/cave.war

Deployment på Wildfly

Der henvises til installationsvejledningen LAR Driftsvejledning for nærmere instrukser.

Udviklers workstation

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

Beskrivelse af systemdesign

Systemdesign er beskrevet i LAR 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.

larservice-app modulet indeholder forretningslokken logikken. 

larservice-cave modulet indeholder funktionalitet til at kalde CAVE servicen og konvertering af data fra det FHIR format CAVE servicen returnerer og det LAR snitfladen definerer. 

larservice-dgws modulet indeholder funktionalitet til at validere DGWS headeren og opbygge en request context.

larservice-types modulet indeholder WSDL og XSD'er samt de genererede typer til snitfladen. 

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

Logningsstrategi

Logning i applikationsloggen gøres efter følgende regler:

• Fejl logges med værdier når relevant
  • Dette kan f.eks. være valideringsfejl
  • Det må ikke være personhenførbar information
• Der logges med følgende niveauer:
  • DEBUG: anvendes til at kunne følge en given logik. Mellemregninger.
  • INFO: anvendes til at informere om et givet resultat, f.eks. hvad værdien er, når der opstår en valideringsfejl
  • ERROR: anvendes i fejlsituationer, hvor driften skal adviseres, f.eks. når MinLog ikke svarer
  • TRACE: anvendes typisk i ind og udgange af metoder

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-test   -Dconsentadministration.endpoint=http://test1-cnsp.ekstern-test.nspop.dk:8080/consent-administration/service -Dlarservice.wsdl=http://localhost:8065/larservice/MedicationAllergyService?wsdl

(samme 2 parametre skal angives ved kørsel i IDE, f.eks. for Eclipse i VM arguments i en run configuration)

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

Performance test

Se næste afsnit

Udvikling af performance test

Performance testen foregår vha. at test frameworket udviklet af Arosii.

Performance testen består af 2 dele:

1. Udvikling af selve testen. Dette foregår i JMeter og kræver både java udvikling og efterfølgende opsætning i JMeter.
2. Udførsel af testen. Dette foregår vha. en række shell scripts på en master og flere slave maskiner. 

Udvikling og opsæt er beskrevet i nærværende dokument, mens den faktiske udførsel af testen er beskrevet i LAR Testvejledning.

Performance testen skal passe til LAR servicens snitflade. Ændres denne er det også nødvendigt at ændre performance testen.

I det følgende antages at koden er hentet ned fra SVN: https://svn.nspop.dk/svn/kvalitetsit/cave-performance/

Kildekode struktur

Kilde koden er udleveret af Arosii og eftefølgende tilrettet til LAR service projektet. Kildekoden indeholder også performance test til andre services. Om disse er opdateret til kørende version af disse services er ikke sikkert, men kan tjene til inspiration til fremtidig udvikling af performance test.

doc: indeholder Arosiis vejledning til brug af frameworket

environment: 

jmeter-docker: indeholder det som muliggør at køre JMeter i en docker container

kit-vagrant: 

modules: indeholder kildekoden til de forskellige test, herunder larservice

tests: indeholder de generede test filer (

Versionskontrol

Ændringer til cave-performance skal tagges i SVN med samme release som den lar version rettelsen gælder.