SOSI STS Dokumentationsoverblik

Transkript

1 SOSI STS Dokumentationsoverblik - for Sammenhængende Digital Sundhed i Danmark Date: 19. August, 2009 Version: 0.3 Author: Arosii A/S

2 Indholdsfortegnelse 1 Introduktion Dokumentationselementer Dokumentationsoverblik Kravspecifikation Designdokument Guide til arkitekturkomponent-anvendere Brugergrænseflade-dokumentation Installationsvejledning(er) Driftsvejledning Beskrivelse af test Arkitekturbeslutninger Referencer...8 Arosii A/S, 2009 Page 2 of 8

3 1 Introduktion I dokumentet Note om teknisk dokumentation for arkitekturkomponenter Operatørvurdering og prioritering [1], beskrives et oplæg til basisdokumentation på tværs af komponenter, som indgår i Digital Sundhed regi. Retningslinierne i dokumentet er vejledende og skal ses i sammenhæng med de forhold der gør sig gældende for de konkrete komponenter. I dette dokument gennemgåes dokumentationselementerne i kontekst af STS, med henblik på en konkret afklaring af hvilke tiltag der skal igangsættes for at bringe dokumentationsniveauet på det ønskede niveau. Arosii A/S, 2009 Page 3 of 8

4 2 Dokumentationselementer Dokumentationselementerne er gennemgåes her enkeltvis, hvor hvert enkelt element er opsplittet i delelementer med relevans for STS. Hvert delement er beskrevet med prioritet (som i [1]), status og en kort beskrivelse, hvor status er: OK: Der er ikke væsentlige kendte udeståender Opdateres: Informationen findes, men skal aktualiseres Delvis: Informationen findes men er ikke fuldstændig. Mangler: Findes ikke, eller findes kun fragmenteret N/A: Ikke relevant i STS sammenhæng 2.1 Dokumentationsoverblik STS kildekode 1 OK Subversion repository findes på Softwarebørsen: STS testmiljø 1 OK Test STS instans afvikles på Eksterne dokumenter 1 Se reference afsnittet 2.2 Kravspecifikation Kravspecifikation 3 OK Den oprindelige kravspecifikation for STS findes i [0] Kravbesvarelse 3 OK TDC's kravbesvarelse af kravspecifikationen findes i [2] 2.3 Designdokument Arkitekturoverblik 1 Delvis/Opd ateres Kravsbesvarelsen [2] illustrerer systemets kontekst og interaktionen mellem komponenter på overordnet niveau. Beskrivelsen i [2] er lavet med afsæt i forudsætninger og kendt viden på besvarelses tidspunktet. Logisk arkitektur 1 Mangler Findes delvist i kravsbesvarelsen [2], men ikke tilstrækkelig for denne sammenhæng. Fysisk datamodel 1 Mangler Datamodellen for STS er simpel og beskrevet via SQL script Arosii A/S, 2009 Page 4 of 8

5 til oprettelse af tabeller. Ikke tilstrækkelig for denne sammenhæng. Teknologiarkitektur 1 Delvis STS'ens forventninger til omgivelser i test- og produktionsmiljø er primært beskrevet i kontekst af installationen (se installationsvejledningen [6]). Konkrete beskrivelser af de faktiske driftssituationer forventes beskrevet andetsteds Væsentlige brugsscenarier 2 OK SOSI Programmers Guide [3] og SOSI STS teknisk beskrivelse [4] beskriver forskellige brugsscenarier 2.4 Guide til arkitekturkomponent-anvendere STS anvendelse fra Seal 1 OK SOSI Programmers Guide [3] sektion 4.3 ( Use case 1: How to authenticate an ID-card ) beskriver hvordan STS anvendere med Seal kan udstede ID-kort via STS'en. STS anvendelse uden Seal 1 Opdateres/ Delvis STS anvender Seal til håndtering af ID-kort forespørgsler og svar, dvs. inklusiv parsing og validering, og dermed følger STS snitfladen fra Seal. SOSI STS teknisk beskrivelse [4] beskriver snitflade og opførsel STS'ens web service, inkl. scenarier der skal kunne håndteres af en STS klient. WSDL'en for STS'en er dikteret af Seal's validering, og skal derfor være opdateret med Seal. STS videreudvikling 2 Mangler Projektet bruger velkendte tredjepartsværktøjer og -komponenter, som Eclipse, JBoss, MySQL, Maven etc. Der findes ikke nogen beskrivelse af hvordan det sættes op, og hvordan værktøjerne anvendes. 2.5 Brugergrænseflade-dokumentation Administrationsinterface 1 Mangler STS har et simpelt webinterface til begrænset monitorering, download af log. Her konfigureres også white og black listing af certifikater, hvor bl.a. det krævede format bør beskrives. Burgerinterface 1 N/A STS udstiller en web service, og har ikke noget GUI for almindelige brugere. Arosii A/S, 2009 Page 5 of 8

6 2.6 Installationsvejledning(er) Installations- og konfigurationsvejledning 1 OK SOSI STS Installationsbeskrivelse [6]: Vejledningen er lavet i samarbejde med og specifikt til TDC (DanID) drift, og skal muligvis tilpasses et mere generisk setup. Dækker installation, konfiguration og deploy af STS. Hardware dimensionering 3 Mangler Hardware til test og produktionsmiljø blev bestemt i forbindelse med kravbesvarelsen [2] (beskrivelsen herfra: 2 x Sun Solaris V210 m. ekstra ram og ekstra discs ). 2.7 Driftsvejledning Beskrivelse af logning 1 Delvis Opsætning af log er delvist beskrevet i installationsvejledningen [6], men forudsætter kendskab til det anvendte logging framework (log4j). Beskrivelse af log muligheder (applikation, timing og audit) og tilhørende introduktion/læsevejledning findes ikke. Fejldiagnosticering 1 Mangler Dokument med administrator/driftsfolk som målgruppe, der beskriver diagnosticering af STS problemer findes ikke. I SOSI STS teknisk beskrivelse [4] beskrives fejlsituationer, som i sammenhæng med log filerne kan anvendes ved diagnosticering. Direkte afhængigheder 1 Delvis Installation af afhængigheder som OS, database og applikationsserver (JBoss) forudsættes i installationsvejledningen. Netværksadgang til krævede services indirekte beskrevet. 2.8 Beskrivelse af test Unit test 2 Delvis Der laves ikke løbende unit test rapport til publicering. Unit testen omfatter pt 146 tests. Der er overlap med funktionstesten. En samlet testrapport for STS'en bør inkludere resultatet fra funktions testen (se nedenfor). Funktions test 2 OK En væsentlig del af STS funktionaliteten testes gennem SOSI seal test tools, der tilgår en deployet STS instans. Se SOSI Arosii A/S, 2009 Page 6 of 8

7 STS Testscenarier [5]. Performance test 2 Mangler Der foreligger ikke performance test fra test- eller produktionsmiljø. Hvorvidt performance test i testmiljøet kan ekstrapoleres til produktion er ukendt. Coverage 2 Mangler Under udvikling anvendes coverage værktøj (Eclemma fra Eclipse) til ad-hoc afvikling af unit test. En væsentlig del af STS funktionaliteten testes gennem SOSI seal test tools, der tilgår en deployet STS instans. Der laves ikke løbende coverage rapport på STS, dvs. omfattende unit og funktions test, som beskrevet ovenfor. Ad-hoc coverage test på en deployet STS er foretaget (med Cobertura), med sidst kendte coverage resultat på ~70%. Deploy test 2 OK STS konfigurationen testes efter endt deploy, med et smoke test script. Det er pga. problemstillingerne omkring adgang til produktionscertifikater ikke mulig at lave komplet end-toend udstedelse af ID-kort uden at involvere en person med et gyldigt certifikat. 2.9 Arkitekturbeslutninger Beslutningslog 3 Mangler Er ikke formelt opsamlet. Beslutninger er truffet af forskellige interessenter, men findes (desværre) ikke samlet et sted. Arosii A/S, 2009 Page 7 of 8

8 3 Referencer [0] Kravspecifikation Identitetsservice (version 1.3, 20. April 2006), [1] Note om teknisk dokumentation for arkitekturkomponenter Operatørvurdering og prioritering (version 0.1), Henrik Gørup Rasmussen [2] Kontrakt mellem Ribe Amt og TDC Totalløsninger A/S om udvikling og drift af Identitetsservice (IdP) til SOSIprojektet (18. August 2006), TDC [3] The SOSI Library Programmers Guide, (version 1.5.3), Lakeside [4] SOSI STS Teknisk Beskrivelse (version 1.0, 18. December 2006), Arosii [5] SOSI STS Testscenarier (version 1.0.1, 24. Januar 2007), Arosii [6] SOSI STS Installationsbeskrivelse (version 0.3, 21. Juni 2007 ), Arosii Arosii A/S, 2009 Page 8 of 8