Page History
...
| root | XDSCleanup |
|---|---|
| includeroot | true |
Table of Contents
1 Introduktion
Introduktion
...
Formål
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.
...
Sammenhæng med øvrige dokumenter
Dette dokument er en del af den samlede dokumentation for NXRG.
Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for NXRG.
Læsevejledning
Læser forventes at have kendskab til Java softwareudvikling med anvendelse af Maven
...
1.4 Dokumenthistorik
...
Version
...
Dato
...
Ansvarlig
...
Beskrivelse
...
0.8
...
2 Introduktion til RegJob
...
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.
Dokument Historik
| 5/5 2021 | Nils Asbjørn Joensen/KIT | Udarbejdet ved etableringen af NXRG |
Introduktion til 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:
...
...
...
Opsætning af udviklingsmiljø
I det følgende antages at koden er hentet
...
3.1 Krav til software
fra SVN: https://svn.nspop.dk/svn/components/nxrg.
Krav til software
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:
...
- Maven 3.0.3 eller højere anvendes.
- docker-compose version 3.
...
- 4 eller højere
Bygge WAR filer
Man skal bruge
...
Maven til at bygge
...
NXRG, hvilket gøres ved at køre kommandoen
...
|
...
|
Efter byg kan WAR filer findes her:
|
Afvikling
Der henvises til installationsvejledningen for nærmere instrukser.
Udviklers workstation
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å:
- HelbredsURL: Se NXRG - Driftsvejledning
- Services: Se NXRG - Guide til anvendere
registrydeletionjob-0.0.1-SNAPSHOT.jar
...
Beskrivelse af systemdesign
Systemdesign er beskrevet i
...
...
...
Beskrivelse af kildekodens strukturering og design
...
Kode strukturering
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-app | NXRG service- og forretningsfunktionalitet er samlet her. 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-qa | Integrationstest for NXRG |
| nxrg-testreport | Modul til at samle jacoco test reports og beregne samlet test coverage. |
Dato og tidshåndtering
Datoer og tidspunkter anvendes på følgende måde i NXRG:
- RIM formattet er en streng, og requst og response forventes at være i UTC tid.
- IHE frameworket anvender joda time (DateTime) og klasser, der interagerer med dette framework anvender derfor joda time.
- Ved "indgang" til servicene tjekkes at tidspunkterne i IHE modellen er UTC tid (UtcDateTimeTransformer og UtcDateTimeQueryTransformer)
- Tidspunkter fra metadata, som gemmes i databasen er UTC tid
- Øvrig håndtering af tid foregår vha java.time.Instant og foregår i UTC tid
- Klassen DateTimeUtils anvendes som utility til at håndtere dato og tid
Databaseændringer
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.
Skemaændringer
Skal der tilføjes f.eks. en ny kolonne eller en ny tabel skal nedenstående gøres.
- Der oprettes en ny fil i folderen compose/configuration/database/ddl. Filen skal navngives liquibase-changelog-x.y.z.xml hvor x, y og z er det versionsnummer du forventer at release komponenten som. Filen skal beskrive ændringen der skal laves. Hvis man anvender liquibase SQL syntaxen får man typisk automatisk "rollback" med. Man kan også referere til rå SQL filer.
- Filen fra punkt 1 tilføjes compose/database/liquibase-changelog-master.xml.
- Done
Testdata
Opstår der en situation hvor der skal tilføjes yderlige testdata for at integrationstesten kan afvikles skal nedenstående udføres.
- Der oprettes en ny fil i folderen compose/configuration/database/test. Filen skal navngives liquibase-changelog-test-x.y.z.xml hvor x, y og z er det versionsnummer du forventer at release komponenten som. Filen skal beskrive ændringen der skal laves. Hvis man avender liquibase SQL syntaxen får man typisk automatisk "rollback" med. Man kan også referere til rå SQL filer.
- Filen fra punk 1 tilføjes compose/database/liquibase-changelog-test.xml
- Done
Migrerede data
I development-setuppet bliver der ved opstart indlæst et dump af opentext-registry'et fra test1. Dette indlæses i en database for sig selv. Man kan tilgå denne database med følgende kommando (i mariadb-containeren):
mysql -uopentext -popentext opentextMigrering
Beskrivelse af hvordan man afvikler migreringen fra det gamle Opentext-registry til NXRG findes i Design- og Arkitekturbeskrivelsen og driftvejledningen.
Beskrivelse af testsetup
”dependencies" indeholder her "xhive.jar", som indeholder API til at kommunikere med XDB.
"config" indeholder en eksempel-opsætning på en property fil, som skal være på classpath ved kørsel af den færdigbyggede jar-fil.
6.2 Generelt design af RegJob
RegJob består af følgende centrale klasser:
- XHiveService: Henter liste af uuid på de dokumenter der skal slettes v.h.a. XQuery på XDB.
- AppointmentXdsRequestService : Håndterer kommunikation med ITI-snitfladerne:
- ITI-18: GetAssocationsQuery - For at hente associationer til dokument, disse er krævet input til ITI-62
- ITI-18: GetDocumentsQuery - For at hente metadata om dokument (uniqueID og repositortID), disse skal bruges for at slette dokument fra repository
- ITI-62: RemoveObjectsRequest - For at slette dokumentet
- Application: Mainklasse der først foretager opslag vha. XHiveService, derefter sletter dokumenter vha. AppointmentXdsRequestService, og til sidst outputter slettede dokumenter i en fil
7 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 afvikling under byg vha jacoco plugin for Maven, men kan separat afvikles ved at køre:
|
7.2 Integrationstests (Failsafe)
Maven Failsafe plugin anvendes til gennemførelse af integrationstests af samtykkewebservices.
Integrationstestene af samtykkeadministration er afhængige af at Min-log-registreringsservicen er deployet.
Det nødvendige testdata læses automatisk på af maven-scriptet, inden integrationstestene afvikles.
Integrationstests kan 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.
| Navitabs | ||||
|---|---|---|---|---|
|
...