|
Formålet med dette dokument er at beskrive, hvordan et udviklingsmiljø til videreudvikling af NXRG 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.
Dette dokument er en del af den samlede dokumentation for NXRG.
Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for NXRG.
Læser forventes at have kendskab til Java softwareudvikling med anvendelse af Maven og WildFly. Derudover forventes kendskab til Docker samt docker-compose.
Hvor der i teksten er angivet <component base> refereres til topniveaufolderen for kildekoden for komponenten.
5/5 2021 | Nils Asbjørn Joensen/KIT | Udarbejdet ved etableringen af NXRG |
Alle NXRG services udstiller en SOAP service. Snitfladen er defineret i en WSDL fil og en række XSD filer.
Alle NXRG services er Java baserede komponenter, der baserer sig på Java 8 og Spring frameworket.
Design og arkitektur er beskrevet: NXRG - Design- og arkitekturbeskrivelse.
I det følgende antages at koden er hentet fra SVN: https://svn.nspop.dk/svn/components/nxrg.
NXRG 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:
Man skal bruge Maven til at bygge NXRG, hvilket gøres ved at køre kommandoen
|
Efter byg kan WAR filer findes her:
|
Der henvises til installationsvejledningen for nærmere instrukser.
Når man udvikler kan det være praktisk at foretage lokal deployment.
Dette kan gøres vha. docker-compose:
|
Når NXRG er startet er, svarer den på:
Systemdesign er beskrevet i NXRG - Design- og arkitekturbeskrivelse.
Kildekoden bygges vha Maven, og kildekoden er struktureret som Maven moduler. NXRG består af følgende moduler:
nxrg-xds | Sætter dependencies op i forhold til openehealth framework (en række exclusions er tilrådelige for at anvende dette framework på NSP). Derudover indeholder modulet statiske koder (f.eks. OID for CPR registeret og SOR), der anvendes rundt om i NXRG. |
nxrg-testutilities | Hjælpeklasser, der både skal bruges af unit tests samt af integrationstests for NXRG ligger her. |
nxrg-common | NXRG service- og forretningsfunktionalitet som anvendes af flere af de andre moduler (typisk app og field-migration) er samlet her. |
nxrg-app | NXRG service- og forretningsfunktionalitet. Se NXRG - Design- og arkitekturbeskrivelse for en grundigere beskrivelse af strukturen i dette modul. |
nxrg-war | Modul, der er ansvarlig for at pakke NXRG som en NSP service - herunder angivelse af modulafhængigheder i deploymentdescriptor. Indeholder også Dockerfile til selve byg af Docker image. |
nxrg-integrations | Modul, hvor integration til eksterne services er samlet. |
nxrg-field-migration | Service og forretningslogik, som håndterer migrering af søgbare felter. |
nxrg-field-migration-war | Modul, der er ansvarlig for at pakke felt migrerings som en NSP service - herunder angivelse af modulafhængigheder i deploymentdescriptor. Indeholder også Dockerfile til selve byg af Docker image. |
nxrg-qa | Integrationstest for NXRG |
nxrg-testreport | Modul til at samle jacoco test reports og beregne samlet test coverage. |
Datoer og tidspunkter anvendes på følgende måde i NXRG:
Databasemodellen styres ved hjælp af Liquibase. Det betyder at når der skal laves ændringer til databasemodellen, så må man ikke rette i de eksisterende skemafiler. I stedet skal der laves nye filer der beskriver ændringerne.
Skal der tilføjes f.eks. en ny kolonne eller en ny tabel skal nedenstående gøres.
Opstår der en situation hvor der skal tilføjes yderlige testdata for at integrationstesten kan afvikles skal nedenstående udføres.
Kildekoden, som håndterede migreringen fra OpenText registyr, samt dets hjælpe værktøjer til kontrol af migreringen (også benævnt: Migreringstool, Migreringsverifikationstool, Replaytool og Datareperationstool), er taget ud af svn i revision r10379.
NXRG har sin egen service til migrering af eksisterende metadata til søgbare felter. Detaljerne er beskrevet i "NXRG - driftvejledning til felt migrering" om, hvordan dette køres.
Source koden består af 3 klasser, med følgende formål:
Skal denne funktionalitet udvides med nye felter, gøres det på følgende måde:
Samtidig med at ovenstående laves, skal også håndtering i selve NXRG laves. Sådan at nye registreringer af dokumenter, selv gemmer feltet som søgbart felt. Drejer det sig om et felt til documentEntry rettes følgende klasser:
Reel anvendels af det nye felt, må først ske i en senere version af NXRG, sådan at data grundlaget i de kørende systemer er blevet migreret og data tilgængelig.
JUnit anvendes til implementering af unit tests. Der er kontinuert gennemført unit tests på alle komponenter i projektet.
Unit tests afvikling under byg vha jacoco plugin for Maven, men kan separat afvikles ved at køre:
|
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
Integrationstests
Integrationstests ligger i modulet nxrg-qa og kan afvikles med:
|
Dette forudsætter at alle services er startet som angivet i docker-compose setuppet.
Hvis man ønsker af afvikle testen op mod en andet miljø f.eks. test1 eller test2 henvises til NXRG - Testvejledning.
Integrationstesten sender een notifiation til NAS. Denne kan findes via DRG. På Test1 kan det gøres med getMessages vha. pull point: http://test1.ekstern-test.nspop.dk:8080/nas2/pullpoint/service/080d09f8-48af-405c-b55f-f821a773c9c1
Performance testen foregår vha. et test framework udviklet af Arosii.
Performance testen består af 2 dele:
Udvikling og opsæt er beskrevet i nærværende dokument, mens den faktiske udførsel af testen er beskrevet i NXRG Testvejledning.
Performance testen skal passe til NXRGs snitflader. Ændres disse 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/components/performance/trunk/ samt at man har docker installeret i sit udviklingsmiljø. JMeter skal også være tilgængelig.
Kildekoden indeholder også performance test til andre services, men i nedestående er NXRG vigtigste dele trukket frem.
|
modules: indeholder kildekoden til de forskellige test
tests: indeholder de generede test filer
Test versionen styres vha. af revision i trunk. I dokumentet "testvejledning" afsnit performance test angives, hvilken version af performance testen der anvendes med en given version af NXRG.
NXRGs performance test består af ovennævnte java sourcer. Disse vedligeholdes i takt med at NXRG snitflader ændres/udvides og skal performance testes.
Lokal test kan gøres ved at bygge projektet og starte JMeter op.
Når man har udviklet og bygget test projektet, startes JMeter. Herefter kan en eksisterende performance test åbnes og køres herfra. Eller en ny kan laves.
Det følgende skærmbillede viser den skærm, som er udviklet i ITI61SamplerGUI med data hentet fra en gemt test:
Når man starter testen (den grønne pil) aktiveres et kald mod den service, der er konfigureret under 'Host configuration' og hermed aktiveres koden fra ITI61Sampler.
Resultatet kan ses under 'View Result Tree', hvor både kald og svar kan ses.
Den endelige kørsel af performance testen skal bruge en test plan (skabes når ovenstående test gemmes) samt en distribution, der indeholder 'Distribution' delen af ovenstående. De gemmes henholdsvis i tests/<modul>/src/test/jmeter/templates/testplans og tests/<modul>/src/test/jmeter/templates/distributions. Hvor <modul> kan være ihe eller aftaler.