Formålet med dette dokument er at beskrive hvordan et udviklingsmiljø, til videreudvikling af DDS registry, kan sættes op, samt hvordan koden bygges, deployes og testes.
I afsnit 3 beskrives de softwaremæssige krav der er til miljøet samt hvordan kode bygges.
I afsnit 4 beskrives deployment-miljøet.
Kodestrukturen, kodemæssige afhængigheder til tredjeparts moduler og de forskellige servicemodulers ansvar og design beskrives i afsnit 6.
Testdesign findes i afsnit 7.
Dette dokument er en del af den samlede dokumentation for DDS projektet.
Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for projektet: Dokumentdelingsservice (DDS).
Læser forventes at have kendskab til Java softwareudvikling med anvendelse af Maven, WildFly applikationsserver og MySQL.
Hvor der i teksten er angivet <component base> refereres til topniveaufolderen for kildekoden for komponenten.
Version | Dato | Ansvarlig | Beskrivelse |
1.0 | 29.06.2012 | Systematic | Initiel udgave |
1.1 | 21.08.2012 | Systematic | Ændring i afsnit 3.2, 3.3, 4.2 og 7.2 grundet opdateret bygge- og testprocedure. |
1.1a | 19.04.2012 | Systematic | Mindre ændringer grundet både registrering og opslag via NSP (Release kandidat) |
1.2 | 19.06.2013 | Systematic | Kvalitetssikret |
1.3 | 23.05.2014 | Systematic | Rettelser som konsekvens af opsplitning af tidl. NPI-mavenprojekt i selvstændige komponenter. |
1.4 | 28.11.2014 | Systematic | Referencer til Nationalt Patientindeks (NPI) fjernet |
1.5 | 14.01.2015 | Systematic | Nye kommandoer til maven og ændring af npi og npiservices til dds |
1.6 | 30.03.2015 | Systematic | Opdatering af afhængigheder i 6.1 Tilføjet afsnit 3.3. Beskrivelse af afhængigheden til eksterne database scripts og datasources |
1.7 | 02.02.2016 | Systematic | Kodereferencer er opdaterede pga. navneskifte fra NPI til DDS Opgradering til WildFly Forbedret codecoverage beskrivelse |
1.8 | 25.11.2016 | Systematic | BRS stub nu påkrævet (3.3) Cobertura modul nævn i 6.1 Performancetest fjernet da disse er beskrevet i separat dokument |
1.9 | 16.12.2016 | Systematic | Opdateret afhængigheder i afsnit 3.3 Fjernet beskrivelse af code-coverage for unittest i afsnit 7.3. |
1.10 | 13.06.2018 | Systematic | Migreret til NSPOP SVN |
1.11 | 14.11.2018 | KvalitetsIT | Dokumentation lagt ind i Confluence |
Definition | Beskrivelse |
NSI | National Sundheds-IT |
NSP | Den nationale service platform (inden for sundheds-IT) |
SHAK | Sygehusafdelingsklassifikation |
SOR | Sundhedsvæsenets organisationsregister |
STS | Security Token Service |
BRS | Behandlingsrelationsservicen |
HS | Healthshare Document Registry |
Alias | Beskrivelse |
Oversigt | |
DGWS | Den Gode WebService 1.0.1 |
Design | |
Installationsvejledning | |
Min-log | Design og Arkitektur Min-log Service (SSE/11734/SDD/0002) |
SAM | Design og Arkitektur Samtykke Service (SSE/11734/SDD/0003) |
SAM-guide | Guide til udviklere Samtykke Service (SSE/11734/PHB/0007) |
Minlog-guide | Guide til udviklere Min Log Service (SSE/11734/PHB/0004) |
Realisering af DDS registry består af en Java-baseret webservice.
Webservicen tillader dels
kildesystemer at registrere metadata om patientinformationer i dokumentdelingsservice og dels
anvendersystemer at lave forespørgsler til dokumentdelingsservice og få metadata om patientinformationer, der er gemt deri, retur
Servicen filtrerer returnerede metadata baseret på borgerens samtykker, validerer brugerens rettigheder, kalder behandlingsrelationsservicen og gemmer eventuelle relevante oplysninger i borgerens Min-log.
For en dybere introduktion til servicen og baggrunden bag, se DDS Registry System Arkitektur.
det følgende antages at koden er hentet ned fra softwarebørsen el.lign.
Krav til applikationsserveren, operativsystemet og databasen er de samme som til produktionsmiljøet. De specifikke krav kan ses i [Installationsvejledning] afsnit 2.
Derudover er der en række krav til de anvendte udviklingsværktøjer:
Krav til Maven
Maven 3.0.3 eller højere anvendes.
Følgende software er nødvendig for at bygge projektet
Maven (min. version 3.0.3)
WildFly (se Installationsvejledning DDS Registry)
MySQL (se Installationsvejledning DDS Registry)
Gennemfør følgende steps for at bygge webservicen.
Trin 1:
For at etablere databaser og initielt indhold, køres følgende fra <component base>/dds:
mvn package –Pschema-setup
Bemærk, at dette trin kun er nødvendigt ved første byg samt ved ændring i databaseskemaer eller initielt indhold.
Trin 2:
Se Installationsvejledning DDS Registry for nødvendige trin til at registrere datasources på WildFly
Trin 3:
DDSRegistry modulet med default properties sættes op ved kørsel af:
mvn package –Pdeploy-ds-appserver
Whitelist og Stamdata datasources hentes fra eksterne afhængigheder beskrevet i 6.1
Trin 4:
Kørsel af integrationstests forberedes ved at tilrette properties-filer. Der eksisterer følgende filer, der kan benyttes som skabelon for tilpasning:
<component base>/dds/environment.properties
<component base>/dds/testclient.properties
Trin 5:
For at bygge projektet, foretage unit- og integrationstest samt pakke og deploye war-filen foretages følgende kommando fra <component base>/dds:
mvn clean install –Ddev -Denvironment-property-file=<sti til tilpasset environment.properties>
Bemærk, at dette afstedkommer deployering til WildFly, herunder at: Service(s) deployeres til WildFly (hvilket kræver skriverettighed i standalone/deployments)
Ønskes byg af projektet gennemført uden deployering til WildFly, kan der, i stedet for bygge-kommandoen ovenfor, køres følgende kommando:
mvn clean install
Ud over kald til eksterne registries, afhænger DDS Registry også af følgende services:
Service | Kræves ved integrationstests |
Samtykkeverifikationsservice | X |
Behandlingsrelationsservice | X |
MinlogRegistration-service | X |
Af disse services kræves tilgængelighed til STS, Samtykkeverifikationsservice og minlog-registration, hvor STS er en ekstern service og Samtykkeverifikationsservice og MinlogRegistration-service er projekter i NSI suiten.
For at udføre integrationstests kræves derfor et deployeret byg af Samtykkeverifikationsservice og MinlogRegistration-service på samme WildFly instans, hvor DDS Registry deployeres og testes.
Byg og test af samtykkeverifikationsservice og MinlogRegistration-service kan ses i [SAM-guide] og [minlog-guide].
Kørsel af integrationstests forberedes ved at tilrette properties-filer. Der eksisterer følgende filer, der kan benyttes som skabelon for tilpasning:
<component base>/dds/environment.properties
<component base>/dds/testclient.properties
Følgende to muligheder kører integrationstestene:
Når et byg er deployeret til WildFly (enten manuelt eller ved byggekommandoer fra afsnit 3.2), da kan integrationstests gennemføres uden deployering til WildFly ved følgende kommando:
mvn verify –Pexternal-test -Denvironment-property-file=<sti til tilpasset environment.properties> -Dtestclient-property-file=<sti til tilpasset testclient.properties>
For at bygge projektet, foretage unit- og integrationstest samt pakke og deploye war-filen foretages følgende kommando fra <component base>/dds:
mvn clean install -Ddev -Denvironment-property-file=<sti til tilpasset environment.properties> -Dtestclient-property-file=<sti til tilpasset testclient.properties>
Bemærk, at dette afstedkommer deployering til WildFly, herunder at: Service(s) deployeres til WildFly (hvilket kræver skriverettighed i standalone/deployments)
Der er udviklet to teststubbe til at hjælpe i udviklingen og test af denne service. De to stubbe erstatter de to eksterne afhængigheder, som servicen har; BRS og HS. For begge stubbe gælder, at for at benytte stubben skal wsdl.location for den tilsvarende service rettes i DDSRegistry.properties, så den peger på lokationen, hvor stubben er deployet.
BRS-stubben er placeret i et separat modul under folderen dds/brs-stub. Fra denne folder bygges og deployeres til WildFly med standard Maven-kommandoen:
mvn clean install
BRS-stubben logger kaldet, men foretager sig intet derudover.
HS-stubben er tilsvarende placeret i et separat modul, blot under folderen dds/hs-stub. Fra denne folder bygges og deployeres til WildFly med standard Maven-kommandoen:
mvn clean install
HS-stub returnerer de data, der er nødvendige for at afvikle integrationstestene.
Der henvises til installationsvejledningen Installationsvejledning DDS Registry for nærmere instrukser.
Når man udvikler kan det være praktisk at foretage deploy til en lokal WildFly.
Det anbefales at benytte NSP-in-a-box (NIAB) til, da denne indeholder en WildFly der er konfigureret på samme måde som den fundet ved operatøren, samt at NIAB anvender et Linux operativsystem.
I forbindelse med anvendelse af NIAB til gennemførelse af integrationstests for DDS, skal følgende konfigureres:
Ved upload af kildekode til NIAB anbefales Winscp, som sikrer korrekt håndtering af Windows CR/LF <-> Unix LF håndtering
Properties fil under dds/ med navn environment.properties kopieres fra eksisterende og opdateres med rigtige data (NSP filer indeholder NIAB specifikke data)
Properties fil for testclient.properties tilrettes evt. med URL
Properties fil under dgws/provider/src/main/resources med navn providertest.nspadmin.properties tilrettes
Se afsnit 3.2 for at opsætte, bygge og udføre tests.