Formålet med dette dokument er at beskrive hvordan et udviklingsmiljø, til videreudvikling af NAS services, 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.
Dette dokument er en del af den samlede dokumentation for NAS.
Dokumentets relation til de øvrige dokumenter er beskrevet i dokumentationsoversigten for projektet NAS Service.
Læser forventes at have kendskab til Java softwareudvikling med anvendelse af Maven og WildFly. Derudover forventes kendskab til docker-compose.
Hvor der i teksten er angivet <component base> refereres til topniveaufolderen for kildekoden for komponenten.
Alle NAS services udstiller en SOAP service. Snitfladen er defineret i en WSDL fil og en række XSD filer.
Alle NAS services er Java baserede komponenter, der baserer sig på Java 8 og Spring frameworket. Derudover anvendes NSP Kafka klienten. Den udstillede SOAP snitflader er implementeret direkte oven på Java Servlets.
Design og arkitektur er beskrevet: NAS Design og Arkitekturbeskrivelse.
I det følgende antages at koden er hentet fra SVN: https://svn.nspop.dk/svn/components/nas.
Alle NAS services 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:
Man skal bruge Apache Maven til at bygge NAS, hvilket gøres ved at køre kommandoen
mvn package |
Efter byg kan WAR filer findes her:
./services/subscriptionmanager/target/subscriptionmanager.war ./services/notificationbroker/target/notificationbroker.war ./services/pullpoint/target/pullpoint.war ./services/idlist/target/idlist.war ./services/pullpointfactory/target/pullpointfactory.war ./services/cleanup/target/cleanup.war |
Der henvises til installationsvejledningen NAS Driftsvejledning for nærmere instrukser.
Når man udvikler kan det være praktisk at foretage deploy. Dette kan gøres vha. docker-compose:
docker-compose -f compose/development/docker-compose.yml up --bulid |
Individuelle services kan også startes hvormed kun deres afhængigheder starter. Til udvikling vil der blive startet en mariadb container samt kafka og zookeeper containere, når der er behov herfor.
Når alle services er startet er de at finde på følgende port:
| Service | port |
|---|---|
pullpointfactory | 8080 |
pullpoint | 8081 |
idlist | 8082 |
subscriptionmanager | 8083 |
notificationbroker | 8084 |
| cleanup | 8085 |
Deres endpoints findes på følgende måde: http://<navn>:<port>/<navn>. Alternativt kan alle services tilgås via en HTTP reverse proxy på port 8090. En service kan så tilgås via adressen http://<navn>:8090/<navn>.
Systemdesign er beskrevet i NAS Design og Arkitekturbeskrivelse
Kildekoden bygges vha Apache Maven, og kildekoden er struktureret som Maven moduler. Følgende moduler er support moduler, som inkluderes efter behov:
| Modul | Beskrivelse |
|---|---|
config | Hjælpekode til håndtering af konfiguration. |
database | Her ligger modellering og adgang mod databasen. |
kafka | Alt adgang til Kafka findes her. De primære interfaces er Publisher og Streamer. |
log | Opsætning af generel log findes her samt hjælpekode til SLA logning. |
security | Heri ligger kode til håndtering af DGWS. |
testutilities | Hjælpekode til testafvikling. |
| util | Enkelte klasser der anvendes på tværs af flere moduler og som ikke har været komplexe nok til at retfærdiggøre et selvstændigt modul. |
Derudover findes alle services som moduler under services.
For at sikre en ensartet navngivning af tabeller, kolonner osv. er nedenstående navnekonvention indført i forhold til databasen.
JUnit anvendes til implementering af unit tests. Der er kontinuert gennemført unit tests på alle komponenter i projektet.
Unit tests afvikling under byg, men kan separat afvikles ved at køre:
mvn test |
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 kan afvikles ved at køre følgende under integration-test modulet:
mvn test |
Dette afvikles op mod indlejrede udgaver af alle NAS services. Hvis man derimod ønsker at afvikle testen op mod det kørende udviklingsmiljø (docker-compose setup), så kan man bruge development profilen:
mvn -Pdevelopment test |
Dette forudsætter at alle services er startet som angivet i udviklet docker-compose setuppet. Hvis man ønsker af afvikle testen op mod en andet miljø, skal en række projekt variable defineres (se pom.xml-filen herom)
Løsningen er udviklet i Java og de udstillede WebServices er implementeret som Servlet 3 og anvender JAXB til serialisering og de-serialisering af beskeder.
Til håndtering af dependency injection, database transaktioner og databaser anvendes Spring.
Nedenstående liste er en liste af 3. parts moduler vi direkte afhænger af. Det vil sige dem der er listet i POM filerne. Udover det anvendes der også en række biblioteker der stilles til rådighed af platformen. Disse er ikke listet her.
commons-pool:commons-pool:jar:1.6
com.sun.xml.bind:jaxb-core:jar:2.2.11
com.sun.xml.bind:jaxb-impl:jar:2.2.11
dk.sdsd.nsp:nsp-util:jar:1.0.11
org.springframework:spring-context:jar:5.1.5.RELEASE
rg.springframework:spring-core:jar:5.1.5.RELEASE
org.springframework:spring-jdbc:jar:5.1.5.RELEASE
org.springframework:spring-web:jar:5.1.5.RELEASE
log4j:log4j:jar:1.2.17
Nedenstående er en liste over de biblioteker der anvendes i forbindelse med test. Det vil sige dem der er angivet i POM filerne med scope test.
org.apache.kafka:kafka_2.11:jar:1.1.0:test
org.apache.kafka:kafka_2.11:jar:test:1.1.0:test
org.apache.kafka:kafka-clients:jar:1.1.0:test
org.glassfish:javax.json:jar:1.0.3:test
org.jboss.resteasy:resteasy-client:jar:3.0.19.Final:test
org.mockito:mockito-all:jar:1.9.5:test
org.springframework.kafka:spring-kafka:jar:2.1.12.RELEASE:test
org.springframework.kafka:spring-kafka-test:jar:2.1.12.RELEASE:test
org.springframework:spring-test:jar:5.1.5.RELEASE:test
dk.sds.nsp.kafka:kafka-clients:jar:1.1.0:test
dk.sosi.seal:seal:jar:2.4.5:test
io.undertow:undertow-core:jar:1.4.26.Final:test
io.undertow:undertow-servlet:jar:1.4.26.Final:test
javax:javaee-api:jar:7.0:test
javax.servlet:javax.servlet-api:jar:3.1.0:test
junit:junit:jar:4.12:test
com.h2database:h2:jar:1.4.197:test