1. Anchor
   _Toc327542696 _Toc327542696

Anchor
_Ref327298774 _Ref327298774

Anchor
_Toc327543151 _Toc327543151

Anchor
_Toc462245082 _Toc462245082

Introduktion

Anchor
_Toc462245083 _Toc462245083

Formål

Formålet med dette dokument er at beskrive opsætning og anvendelse af et udviklingsmiljø til videreudvikling af Svareksponeringsservice XDS-adapterne. Herunder hvordan koden bygges, deployeres og testes.

Anchor
_Toc317839916 _Toc317839916

Anchor
_Toc327543154 _Toc327543154

Anchor
_Toc44403516 _Toc44403516

Anchor
_Toc239132517 _Toc239132517

Anchor
_Toc243720169 _Toc243720169

Anchor
_Toc316542422 _Toc316542422

Anchor
_Toc462245084 _Toc462245084

Læsevejledning

Læser forventes at have kendskab til Java softwareudvikling med anvendelse af Maven og WildFly applikationsserver.
Hvor der i teksten er angivet <component base> refereres til topniveaufolderen for kildekoden for komponenten.
I afsnit 2 beskrives de softwaremæssige krav, der er til miljøet, samt hvordan kode bygges. I afsnit 3 beskrives deployment-miljøet, mens beskrivelse af design fremgår af afsnit 4.
Kodestrukturen, kodemæssige afhængigheder til tredjepartsmoduler og de forskellige servicemodulers ansvar og design beskrives i afsnit 5.
Testdesign findes i afsnit 6.

Anchor
_Toc317831244 _Toc317831244

Anchor
_Toc317839917 _Toc317839917

Anchor
_Toc327543155 _Toc327543155

Anchor
_Toc462245085 _Toc462245085

Dokumenthistorik

Anchor
_Toc327543156 _Toc327543156

Anchor
_Toc462245086 _Toc462245086

Definitioner og referencer

Anchor
_Toc305606312 _Toc305606312

Anchor
_Ref327298659 _Ref327298659

Anchor
_Toc327543158 _Toc327543158

Anchor
_Toc462245087 _Toc462245087

Opsætning af udviklingsmiljø

I det følgende antages at koden er hentet ned fra softwarebørsen el.lign.

Anchor
_Toc327543159 _Toc327543159

Anchor
_Toc462245088 _Toc462245088

Krav til software

Krav til applikationsserveren og operativsystemet 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:

• Maven 3.0.3 eller højere anvendes.

• Wiki Markup
  WildFly (se \[Installationsvejledning\])

Anchor
_Toc305606313 _Toc305606313

Anchor
_Toc327543160 _Toc327543160

Anchor
_Toc462245089 _Toc462245089

Tilpasning af miljø

Ved deployering vha. Maven-scripts og kørsel af integrationstests beskrevet i det efterfølgende gøres brug af property-filer, der beskriver placering af WildFly og endpoints for eksterne systemer mm.
Disse property-filer ligger i:

• <component base>/environment.properties
• <component base>/integrationtest/src/test/resources/testclient.properties

Disse kan kopieres og tilpasses til aktuelt miljø. Efterfølgende Maven-kommandoer gør brug af de tilpassede property-filer gennem argumenterne:
-Denvironment-property-file=<sti til tilpasset environment.properties>
-Dtestclient-property-file=<sti til tilpasset testclient.properties>
Er disse argumenter ikke anført benytter Maven-scripts de oprindelige property-filer.

Anchor
_Toc462245090 _Toc462245090

Bygge War filen

Gennemfør følgende steps for at bygge komponenterne til Svareksponeringsservice XDS-adaptere.

1. For at bygge projektet uden deployering til WildFly eller kørsel af integrationstest foretages følgende kommando fra <component base>:

mvn clean install \
-Denvironment-property-file=<sti til tilpasset environment.properties>

Anchor
_Toc462245091 _Toc462245091

Deployering til WildFly

For at etablere og deployere properties til WildFly foretages følgende kommando fra <component base>:
mvn install –Pdeploy-ds-appserver \
-Denvironment-property-file=<sti til tilpasset environment.properties>
Bemærk, at dette afstedkommer deployering til WildFly, herunder at:

1. Property-filer deployeres til WildFly (hvilket kræver skriverettighed i default/conf)

For at deployere war og ear filer til WildFly foretages følgende kommando fra <component base>:
mvn install –Pdeploy-to-appserver \
-Denvironment-property-file=<sti til tilpasset environment.properties>
Bemærk, at dette afstedkommer deployering til WildFly, herunder at:

1. Service-filer deployeres til WildFly (hvilket kræver skriverettighed i Wildfly/standalone/deployments)

Anchor
_Toc462245092 _Toc462245092

Afvikling af integrationstests mod WildFly

For at afvikle integrationstests mod den deployerede instans på WildFly udføres kommandoen:
mvn verify –Pexternal-test \
-Dtestclient-property-file={_}<sti til tilpasset testclient.properties>_
<ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="c775b123-2ddc-47bd-a869-357f1f05cea1"><ac:parameter ac:name="">_Toc305606314</ac:parameter></ac:structured-macro>Bemærk, at afvikling af integrationstests kræver, at Dokumentdelingsservicen er deployeret (med sine afhængigheder) og konfigureret til at anvende Svareksponeringsservice XDS-adapterne, som beskrevet i \[Konfiguration\].

Anchor
_Toc462245093 _Toc462245093

Samtidig deployering og afvikling af integrationstests

For at lette afvikling af integrationstests ifm. udvikling, kan deployering af war/ears til WildFly og afvikling af integrationstests udføres med kommandoen:
mvn install -Ddev \
-Denvironment-property-file=<sti til tilpasset environment.properties> -Dtestclient-property-file=<sti til tilpasset testclient.properties>

Anchor
_Toc305606315 _Toc305606315

Anchor
_Ref327298694 _Ref327298694

Anchor
_Toc327543162 _Toc327543162

Anchor
_Toc462245094 _Toc462245094

Deployment på WildFly

Der henvises til installationsvejledningen \[Installationsvejledning\] for nærmere instrukser. 

Anchor
_Toc327543163 _Toc327543163

Anchor
_Toc462245095 _Toc462245095

Udviklers workstation

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

Anchor
_Toc305606316 _Toc305606316

Anchor
_Toc327543165 _Toc327543165

Anchor
_Ref416360341 _Ref416360341

Anchor
_Toc462245096 _Toc462245096

Beskrivelse af systemdesign

<ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="aeda00bf-034c-401d-b0aa-34e1c03c42ec"><ac:parameter ac:name="">_Toc305606317</ac:parameter></ac:structured-macro>Det overordnede design for Svareksponeringsservice XDS-adapterne er beskrevet i \[Design og Arkitektur\].

Anchor
_Ref327298792 _Ref327298792

Anchor
_Toc327543166 _Toc327543166

Anchor
_Toc462245097 _Toc462245097

Beskrivelse af kildekodens strukturering og design

Anchor
_Toc327543167 _Toc327543167

Anchor
_Toc462245098 _Toc462245098

Kode-strukturering

Koden for Svareksponeringsservice XDS-adapterne er samlet i et Maven-projekt kaldet SXA.

• xdswrappers/documentmetadataprovider – modul der indeholder de java-komponenter, der fremfinder dokumentmetadata og reagerer på søgeparametre givet ved forespørgsel på dokumentmetadata.
• xdswrapper/documentmetadataprovider-war – modul der står for indpakingen af documentmetadataprovider i en war fil.
• xdswrapper/documentprovider – modul der indeholder de java-komponenter, der fremfinder dokumenter og reagerer på søgeparametre givet ved forespørgsel på dokumenter.
• xdswrapper/documentprovider-war – modul der står for indpakingen af documentprovider i en war fil.

Der er afhængigheder til forskellige Maven-artefakter, hvoraf følgende er skabt i regi af NSI:

• documentsharing/* – moduler der indeholder abstraktioner over IHE XDS dokumentmetadata, forespørgsel og indhentning af dokumenter.
• hsuid/ - modul der indeholder implementering af OIO attributter til identifikation af sundhedsfaglige personer, der er fælles for webservicekomponenter, der anvender DGWS
• dgws/consumer - modul der indeholder implementering af DGWS consumer funktionalitet, der anvendes af komponenter der anvender DGWS i rollen som web service consumer.
• dds/client-types – moduler der indeholder IHE wsdl og xsd filer for "Registry Stored Query Transaction", samt JAXB-generede typer fra disse filer.

Anchor
_Toc327543168 _Toc327543168

Anchor
_Toc462245099 _Toc462245099

Generelt design af Svareksponeringsservice XDS-adaptere

De to Java-webservices Svareksponeringsservice XDS Registry Adapter og Svareksponeringsservice XDS Repository Adapter er implementeret ved brug af komponenter fra documentsharing og Dokumentdelingsservices.
JAX-WS er anvendt på baggrund af artefakter fra DDS skabt ved kodegenerering ud fra WSDL-filer og XSD-filer.

Anchor
_Toc462245100 _Toc462245100

Svareksponeringsservice XDS Registry Adapter

Servicen består af en række Maven-moduler, der findes under xdswrappers/:

• documentmetadataprovider: Indeholder forretningslogik
• documentmetadataprovider-war: Konfigurerer webservicen og bygger war-filen, der skal deployeres
• documentmetadataprovider-integrationtest: Indeholder integrationstests af webservicen

Anchor
_Toc462245101 _Toc462245101

Svareksponeringsservice XDS Repository Adapter

Servicen består af en række Maven-moduler, der findes under xdswrappers/:

• documentprovider: Indeholder forretningslogik
• documentprovider-war: Konfigurerer webservicen og bygger war-filen, der skal deployeres
• documentprovider-integrationtest: Indeholder integrationstests af webservicen

Anchor
_Toc305606325 _Toc305606325

Anchor
_Ref327298808 _Ref327298808

Anchor
_Toc327543169 _Toc327543169

Anchor
_Ref417548762 _Ref417548762

Anchor
_Toc462245102 _Toc462245102

Beskrivelse af test-setup

Anchor
_Toc305606326 _Toc305606326

Anchor
_Toc327543170 _Toc327543170

Anchor
_Toc462245103 _Toc462245103

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

Anchor
_Ref327342192 _Ref327342192

Anchor
_Toc327543171 _Toc327543171

Anchor
_Toc462245104 _Toc462245104

Integrationstests (Failsafe)

Maven Failsafe plugin anvendes til gennemførelse af integrationstests i projektet.

Anchor
_Toc462245105 _Toc462245105

Krævet test setup

Integrationstests forudsætter at Dokumentdelingsservicen (DDS) og dennes afhængigheder er deployeret til WildFly. Desuden kræves at DDS'en er konfigureret til at kende både Svareksponeringsservice XDS Registry Adapter og Svareksponeringsservice XDS Repository Adapter, samt at disses konfigurationer er i overensstemmelse (fx skal samme repositoryUniqueId være anvendt i deres konfigurationer).

Anchor
_Toc462245106 _Toc462245106

Afvikling af integrationstests

Integrationstests kan afvikles ved at køre:
mvn verify –Pexternal-test

Anchor
_Toc434997539 _Toc434997539

Anchor
_Toc435777514 _Toc435777514

Anchor
_Toc327543172 _Toc327543172

Anchor
_Toc333227802 _Toc333227802

Anchor
_Toc462245107 _Toc462245107

Code coverage

Code coverage analyse er foretaget i projektet med anvendelse af Maven Cobertura plugin.

Anchor
_Toc417550117 _Toc417550117

Anchor
_Toc434997540 _Toc434997540

Anchor
_Toc435777515 _Toc435777515

Anchor
_Toc462245108 _Toc462245108

Code coverage for unittests

Code coverage-rapport omfattende alene unittests genereres ved at gennemføre følgende trin:

1. I kommandoprompt i SXA hovedfolder (folderen med parent pom) udføres:

mvn clean site cobertura:cobertura

1. Genereret code coverage-rapport kan nu læses i folderen target/site/cobertura

Anchor
_Toc417550118 _Toc417550118

Anchor
_Toc434997541 _Toc434997541

Anchor
_Toc435777516 _Toc435777516

Anchor
_Toc462245109 _Toc462245109

Code coverage for unittests og integrationstests

En samlet code coverage-rapport omfattende både unittests og integrationstests kan genereres ved forberedelse og gennemførsel af trin beskrevet i det efterfølgende.

Anchor
_Toc417550119 _Toc417550119

Forberedelse

Cobertura skal installeres på WildFly og Ant installeres mhp. anvendelse ved fletning af code coverage-rapporter fra unittest og integrationstests.
De anvendte versioner er:

• Cobertura 2.1.1
• Ant 1.9.4

Trin:

1. Cobertura etableres, ved enten:
   1. Download fra fx sourceforge (https://sourceforge.net/projects/cobertura/) og udpakning
   2. Kildekode hentes fra https://github.com/cobertura/cobertura/releases og bygges
2. Ant installeres
   1. Download fra http://archive.apache.org/dist/ant/binaries/apache-ant-1.9.4-bin.tar.gz

   2. Kopier følgende afhængigheder til Ant's lib folder

      Jar	Kilde
      asm-5.0.1.jar	Indeholdende i Cobertura-2.1.1-bin-tar
      asm-analysis-5.0.1.jar	Indeholdende i Cobertura-2.1.1-bin-tar
      asm-commons-5.0.1.jar	Indeholdende i Cobertura-2.1.1-bin-tar
      asm-tree-5.0.1.jar	Indeholdende i Cobertura-2.1.1-bin-tar
      asm-util-5.0.1.jar	Indeholdende i Cobertura-2.1.1-bin-tar
      cobertura-2.1.1.jar	Indeholdende i Cobertura-2.1.1-bin-tar
      commons-lang3-3.3.2.jar	Indeholdende i Cobertura-2.1.1-bin-tar
      oro-2.0.8.jar	Indeholdende i Cobertura-2.1.1-bin-tar
      slf4j-api-1.7.5.jar	Indeholdende i Cobertura-2.1.1-bin-tar
      slf4j-log4j12-1.6.4.jar	Bør være i lokal m2 folder
      log4j-1.2.16.jar	Bør være i lokal m2 folder

3. Installation af Cobertura modul på WildFly:

   1. Følgende Cobertura afhængigheder kopieres fra cobertura-2.1.1-bin.tar.gz til <wildfly folder>/modules/net/sourceforge/cobertura/main

      Jar	Destination
      <arkiv>/cobertura-2.1.1.jar	<modul-main>/
      <arkiv>/lib/asm-tree-5.0.1.jar	<modul-main>/lib/
      <arkiv>/lib/asm-commons-5.0.1.jar	<modul-main>/lib/
      <arkiv>/lib/asm-util-5.0.1.jar	<modul-main>/lib/
      <arkiv>/lib/asm-analysis-5.0.1.jar	<modul-main>/lib/
      <arkiv>/lib/oro-2.0.8.jar	<modul-main>/lib/

   2. En module.xml fil skabes i samme main mappe med følgende indhold:

<?xml version="1.0" encoding="UTF-8"?>
<module xmlns="urn:jboss:module:1.1" name="net.sourceforge.cobertura">
<resources>
<resource-root path="."/>
<resource-root path="cobertura-2.1.1.jar"/>
<resource-root path="lib/asm-tree-5.0.1.jar"/>
<resource-root path="lib/asm-commons-5.0.1.jar"/>
<resource-root path="lib/asm-util-5.0.1.jar"/>
<resource-root path="lib/asm-analysis-5.0.1.jar"/>
<resource-root path="lib/oro-2.0.8.jar"/>
</resources>
<dependencies>
<module name="asm.asm" />
<module name="javax.servlet.api" />
<module name="org.slf4j" />
</dependencies>
</module>

1. 1. Default udskrives coveragefilen (cobertura.ser) i <wildfly folder>/bin mappen. Ønskes filen udskrevet til en anden mappe skabes filen cobertura.properties i main mappen med indeholdet:

net.sourceforge.cobertura.datafile=<sti>/cobertura.ser

1. 1. For at få Cobertura til at skrive coverage af integrationstests, er der to muligheder:

      Metode	Installation og brug
      coberturaFlush.war servicen	coberturaFlush.war er at finde i Cobertura-2.1.1-bin-tar

2. Før kopiering til <WildFly>/standalone/deployments skal følgende linje tilføjes til coberturaFlush.war/META-INF/MANIFEST.MF:
   
   Dependencies: net.sourceforge.cobertura

3. Efter ændring deployeres coberturaFlush.war og servicen udstiller "<host>/coberturaFlush/flushCobertura". Kald til denne service ved f.eks. Curl får Cobertura til at skrive coverage filen. (Se trin 3.3).|

   Genstart af WildFly

   Cobertura skriver automatisk coverage fil ved genstart af WildFly

4. Denne mulighed kræver følgende ændring i <wildfly folder>/bin/standalone.conf med tilføjelse af:
   JAVA_OPTS="$JAVA_OPTS -Djboss.shutdown.forceHalt=false"|
   Bemærk at når WildFly startes med instrumenteret kode, da startes "optagelse" af code coverage. Ved kald til coberturaFlush servicen skabes et billede af hvordan coverage ser ud nu. Dette billede skrives til <wildfly>/bin/cobertura.ser, hvor filen bliver additivt opdateret, hvis filen findes i forvejen, eller skabes, hvis den ikke findes. "Optagelse" af code coverage bliver først reset ved genstart af WildFly og fjernelse af <wildfly>/bin/cobertura.ser.
   1. Genstart af WildFly

Anchor
_Toc417550120 _Toc417550120

Gennemførelse

Code coverage-rapport omfattende både unittests og integrationstests genereres ved at gennemføre følgende trin:

1. Kontroller, at wildfly bruger-account kan skrive cobertura.ser filen i output folderen (Standard <wildfly>/bin/cobertura.ser eller bestemmes i cobertura.properties)
2. Kontroller, at stien til cobertura.ser er korrekt i filen cobertura/src/main/coberturaScripts/cobertura.properties under SXA-projektets hovedfolder.
3. Coberturas instrumentering af koden sker ved udførsel af følgende i kommandoprompt i SXA-projektets hovedfolder (folderen med parent pom):

mvn clean install -Dcobertura-build \
-Pdeploy-to-appserver \
-Denvironment-property-file=<sti til tilpasset environment.properties>
Bemærk, at argumentet –Pdeploy-to-appserver aktiverer en Maven-profil, der kopierer ear/war-filer til WildFly deployment folder vha. properties. Som alternativ til dette argument kan ear/war-filer deployeres manuelt.

1. Gen-deployer SXA-projektets services på WildFly
2. I samme folder udføres integrationstestene ved:

mvn verify –Pexternal-test __
-Denvironment-property-file=<sti til tilpasset environment.properties> \
-Dtestclient-property-file=<sti til tilpasset testclient.properties>

1. Afslutning af coberturas optagelse gennemføres ved enten:
   1. Shutdown af WildFly, eller
   2. At åbne siden http://<host:port>/coberturaFlush/flushCobertura (fx via curl eller i browser. Bemærk at dette forudsætter at filen coberturaFlush.war blev kopieret og deployeret)
2. Flet code coverage-rapporter ved i kommandoprompt i SXA hovedfolder at udføre:

cd cobertura/target/coberturaReporting-coberturaReporting
ant –f cobertura.xml create-report

1. Genereret code coverage-rapport kan nu læses i folderen cobertura/target/coberturaReporting-coberturaReporting/report