Versions Compared

Old Version 25

changes.mady.by.user Unknown User (tim.hallgren@capgeminisogeti.dk)

Saved on

compared with

New Version Current

changes.mady.by.user Lene Andersen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Navitabs
rootLaboratoriesvarservice (SXA) - Leverancebeskrivelse
includeroottrue

...

Dokumentet henvender sig til udviklere og testere. Læseren forventes at have kendskab til Java software udvikling, herunder unittesting, med anvendelse af Maven og Wildfly applikationsserver.

...

Version

Dato

Ansvarlig

Beskrivelse

1.0

20.09.2016

Systematic

Initiel udgave

...

Definition

Beskrivelse

DDS

Dokumentdelingsservice

NSI

National Sundheds-IT

NSP

Den nationale service platform (inden for sundheds-IT)

XDS

Cross-Enterprise Document Sharing

...

Alias

...

Beskrivelse


Indhold

Table of Contents

Introduktion

Formål

Formålet med nærværende dokument er at beskrive de tests, som er udviklet og afviklet forud for release af Svareksponeringsservice XDS-adaptere. Desuden beskrives generering af code coverage-rapporter.

Læsevejledning

Dokumentet henvender sig til udviklere og testere. Læseren forventes at have kendskab til Java software udvikling, herunder unittesting, med anvendelse af Maven og Wildfly applikationsserver.

Dokumenthistorik

Version

Dato

Ansvarlig

Beskrivelse

1.0

20.09.2016

Systematic

Initiel udgave

Definitioner og referencer

Definition

Beskrivelse

DDS

Dokumentdelingsservice

NSI

National Sundheds-IT

NSP

Den nationale service platform (inden for sundheds-IT)

XDS

Cross-Enterprise Document Sharing

Alias

Beskrivelse

Anchor
ref_UdviklerGuide
ref_UdviklerGuide
Udviklerguide

Guide til udviklere - Svareksponeringsservice XDS-adaptere, (SSE/11734/PHB/0045)

Anchor
ref_Testrapport
ref_Testrapport
Testrapport

Testrapport Svareksponeringsservice XDS-adaptere, (SSE/11734/TRP/0108)

Anchor
ref_Konfiguration
ref_Konfiguration
Konfiguration

Konfiguration af Svareksponeringsservice XDS-adaptere, (SSE/11734/NOT/0056)

Overblik over tests

Følgende beskriver de forskellige

...

Guide til udviklere - Svareksponeringsservice XDS-adaptere, (SSE/11734/PHB/0045)

...

Testrapport Svareksponeringsservice XDS-adaptere, (SSE/11734/TRP/0108)

...

Konfiguration af Svareksponeringsservice XDS-adaptere, (SSE/11734/NOT/0056)

...

Følgende beskriver de forskellige tests og hvorvidt de er forberedt og gennemført ved release af Svareksponeringsservice XDS-adaptere.

...

af Svareksponeringsservice XDS-adaptere.

Unittest

Automatiserede unittests, der verificerer funktionalitet på klasse- eller komponentniveau, er tilgængelige jævnt over kodebasen og udføres, medmindre eksplicit frabedt, ved hvert byg af softwaren.

...

...

Integrationstest (til verifikation af funktionalitet)

Automatiserede integrationstests, der verificerer både adfærd og brug af snitflader i setup, hvor Svareksponeringsservice XDS-adaptere er integreret med andre services, er tilgængelige. Integrationstestene kræver øvrige services for at kunne afvikles, hvilket er beskrevet i efterfølgende afsnit tillige med testdata og afvikling.

...

Performancetests

Performancetests verificerer at servicen performer med hensyn til svartider og/eller er stabil under et specifikt load, som i nogle tilfælde kan anvendes med samme mål som integrationstests.
Der er ikke forberedt eller kørt performancetest for Svareksponeringsservice XDS-adaptere.

...

performancetest for Svareksponeringsservice XDS-adaptere.

Endurance-tests

Endurance-tests verificerer at servicen fungerer under længerevarende belastning og ikke lider under f.eks. memory leaks.
Der er ikke forberedt eller gennemført endurance-test for Svareksponeringsservice XDS-adaptere.

...

...

Afviklede tests

Følgende tests er afviklet som en del af komponentudviklingen og i forbindelse med release. Der henvises til \[Testrapport\] for fastholdelse af resultaterne fra gennemførte tests ifm. release.

...

...


...

Unittest

Unittests ligger i:

  • *\src\test\java*

under de forskellige maven-artefakter, der indgår i Svareksponeringsservice XDS-adaptere. Resultatet af kørte tests opsummeres ved byg, beskrevet i \[Udviklerguide\].

...


...

Integrationstest til verifikation af funktionalitet

Integrationstestene til Svareksponeringsservice XDS-adaptere verificerer, at der kan laves opslag af metadata og indhentning af dokument, når komponenterne i Svareksponeringsservice XDS-adaptere er integreret med Dokumentdelingsservicen og det backend-system, der leverer information om patienters prøvesvar.
Integrationstestene er baseret på en test-klient til Dokumentdelingsservicen skabt som automatiserede junit-tests, der anvender DDS-anvenderbiblioteket, der er en samling maven-artefakter skabt i regi af Dokumentdelingsservicen.
Følgende integrationstest demonstrerer adfærd ved timeout og utilgængelighed, hvilket kræver omkonfiguration inden kørsel (se herunder):

  • integrationtest\src\test\java\dk\nsi\dds\projects\sxa\integrationtest\SxaConfigurationChangeIT.java

...

Forberedelse

Der skal på Wildfly være deployeret:

...

I stamdata skal testbruger være defineret som testperson med autorisationsnr.
Testbrugeren skal være whitelistet til at anvende dokumentdelingsservicen, se afsnit 3.2.3.
Der skal være etableret forbindelse til backend-systemet, hvilket potentielt indebærer oprettelse af laboratoriesvar i Laboratoriedatabanken.
Dokumentdelingsservicen skal være konfigureret til at anvende Svareksponeringsservice XDS-adaptere, som beskrevet i \[Konfiguration\].

...

].


Setup

I Figur 1 er vist et setup til integrationstests baseret på en stub for Svareksponerneringsservicen.
Bemærk, at test-klientens tests fungerer uafhængigt af, hvordan de forskellige services er deployeret, hvorfor en vanlig opsætning af Dokumentdelingsservicen i NSP test1-miljø el. lign. kan anvendes.

Anchor_Ref449697811_Ref449697811
Figur 1 Setup af services for afvikling af integrationstests for Svareksponeringsservice XDS-adaptere med lokalt deployerede adaptere og stub for Svareksponeringsservicen.
Under forudsætning af, at der findes testdata for testpatienter som beskrevet i afsnit 3.2.3, kan der alternativt køres integrationstests mod Svareksponeringsservice XDS Adaptere deployeret ved brug af Svareksponeringsservice hos Laboratoriedatabanken. Dette setup er vist i Figur 2.

anchor
_Ref449014767_Ref449014767Figur 2 Setup af services for afvikling af integrationstests for Svareksponeringsservice XDS-adaptere mod Svareksponeringsservice hos Laboratoriedatabanken.

...

...

Testdata

Testklienten benytter et test-medarbejdercertifikat (MOCES) hentet fra et maven-artefakt etableret i regi af NSI, hvor organisationen bag er whitelistet til at benytte Dokumentdelingsservicen.
I testklienten er med property-fil konfigureret brug af følgende test-bruger, der er oprettet som testperson med autorisationsnummer i testmiljøets stamdata, f.eks. på NSP-miljø test1:
Læge Karl Hoffmann Svendsen, aut.reg.nr. NS362.
I testklienten er hardcoded anvendelse af følgende testpatienter:

...

Tabel 1 Id for testpatienter, der benyttes af tests.

...

...

Testdesign

Integrationstests, der verificerer Svareksponeringsservice XDS-adaptere ved at kalde Dokumentdelingsservicens snitflader, findes i filer under folderen integrationtest\src\test\java\dk\nsi\dds\projects\sxa\integrationtest.
Disse verificerer følgende (for detaljer henvises til filer under nævnte folder) ved positive tests:

...

  • At der ikke returneres dokumentmetadata for laboratoriesvarsdokument, når opslag på testpatient på Dokumentdelingsservicen sker uden anvendelse af søgeparametre specifikke for laboratoriesvarsdokument.

...

  • anvendelse af søgeparametre specifikke for laboratoriesvarsdokument.

Gennemførelse af integrationstests

Inden kørsel af integrationstests skal etableres en property-fil, der beskriver endpoints for eksterne systemer mm. Som skabelon anvendes property-filen:

...


Er argumentet ikke anført benytter Maven-scripts den oprindelige property-fil.
Integrationstests gennemføres ved at udføre maven-kommando fra integrationtest-directory:

Code Block
cd integrationtest
mvn verify –Pexternal-test \
-Dtestclient-property-file=<sti til tilpasset testclient.properties>til tilpasset testclient.properties>


Eksempel:

Code Block
cd integrationtest
mvn verify -Pexternal-test -Dtestclient-property-file=./src/test/resources/testclient.properties



Integrationstestene understøttes kun ved brug af Svareksponeringsservice stubben "labreportservicestub".
Bemærk, at visse integrationstests kræver konfigurationsændringer og derfor er sat til ignored. Disse kan, efter konfigurationsændring som beskrevet i deres javadoc, køres selvstændigt ved at udkommentere ignore og tilføje argument –Dit.test=<testklasse-navn> til ovenstående maven-kommando.

...

til ignored. Disse kan, efter konfigurationsændring som beskrevet i deres javadoc, køres selvstændigt ved at udkommentere ignore og tilføje argument –Dit.test=<testklasse-navn> til ovenstående maven-kommando.

Generering af code coverage-rapporter


Manuel test af alarm endpoints på lokal service

Det følgende beskriver, hvordan man manuelt aftester (aktivere fejlen i)  alarmen, der findes på alarm endpointet for svareksponeringsservice XDS Registry Adapter.


Alarm endpoint: curl -v http://localhost:8081/sxa-documentprovider/alarm



DocumentProviderServiceHealthIndicator

Start compose

docker stop development-sxa-labreportservicestub-1

Kald alarm endpoint

Resultat: Servicen har fejlet 6 gange. Den må ikke fejle mere end 5 gange i en given periode.






































Wiki Markup
Code coverage kontrolleres ved brug af Cobertura, som foreslået af NSP Husregler (for leverandører). Code coverage-rapporter fra et release er fastholdt i tilhørende \[Testrapport\].






































Anchor
_Toc462245136
_Toc462245136
Code coverage for unittests

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

Anchor
_Toc417550117
_Toc417550117
Anchor
_Toc434997540
_Toc434997540
Anchor
_Toc435777515
_Toc435777515
Anchor
_Toc449964616
_Toc449964616
Anchor
_Toc462245137
_Toc462245137
Code coverage for unittests

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

...

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

Anchor
_Toc417550118
_Toc417550118
Anchor
_Toc434997541
_Toc434997541
Anchor
_Toc435777516
_Toc435777516
Anchor
_Toc449964617
_Toc449964617
Anchor
_Toc462245138
_Toc462245138
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:

...

  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. I Ant's lib folder bør følgende jars være tilgængelige

      Jar

      Fremskaffelse

      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:

      Code Block
      <?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>

    3. 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:

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

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

      Metode

      Installation og brug

      coberturaFlush.war servicen


      1. 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:

        Code Block
        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
      1. Cobertura skriver automatisk coverage fil ved genstart af WildFly
      2. Denne mulighed kræver følgende ændring i <wildfly folder>/bin/standalone.conf med tilføjelse af:
      Code Block
       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.

    5. 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:

...