Page History
Navitabs | ||||
---|---|---|---|---|
| ||||
Table of Contents |
---|
Introduktion
Formål
Formålet med dette dokument er at beskrive hvordan et udviklingsmiljø, til videreudvikling af NAP platform services, skal sættes op, kodens struktur, samt hvordan koden bygges, deployes og testes.
Forudsætninger
Krav til software:
Software | Version |
---|---|
Java | 8 |
Docker Engine | 18.02.0+ |
node | 10+ |
Generelt om udviklingsmiljø for projekterne
Det lokale udviklingsmiljø på projekterne er opsat med docker-compose.
For at kunne køre de compose filer, der bliver beskrevet nedenfor, kræves et docker netværk kaldet nap_net. Hvis dette ikke allerede er lavet kør "docker network create nap_net".
I hvert projekt ligger der en compose mappe, hvori der findes forskellige compose filer til udvikling, test og release.
Udvikling
Vær opmærksom på kun at køre en service af samme navn, fx kun køre en nap-test-web. Hvis der skiftes setup, stop altid servicen og kør "docker-compose down".
Der udstilles ingen porte på docker-hosten, og alt trafik routes således igennem en lokal reverse proxy (NAP Compose), som også er på Docker netværket nap_net og eksponeret på port 8080 på localhost.
For at starte reverse proxyen, hentes NAP Compose fra SVN, hvorefter docker-compose filen ligger i httpd mappen, som startes med "docker-compose up".
Ved hhv nap-lobby-web og nap-test-web, bliver ./src folderen "volume-mappet", hvilket betyder, at ændringer i kildekoden bliver kompileret og deployet med det samme.
Hvis dependencies ændres skal containeren bygges igen, ellers er det fremover nok at køre `docker-compose up` når services skal startes.
Test
Jenkins bygger og deployer i snapshot versioner af NSPs wildfly container. Dette byg kan testes ved at køre at `docker-compose up` i compose/test.
Applikationen kan nåes på samme url som ovenfor.
Release
Bruges udelukkende i produktions øjemed.
Generelt om release-procedure for projekterne
De to typer udviklingsprojekter tagges på forskellig vis inden release.
Såfremt det er nødvendigt at producere en release-kandidat, der skal på et test-miljø, gør en begrænsning i driftsleverandørens automatiserede håndtering, at release-navnet kun må indeholde én bindestreg, dvs. navnet bør være på formen
komponentnavn-1.0.2rc3
eller
release-1.0.2rc3
.
Facade-projekter
Java-projekterne gøres klar til release med mvn release:prepare
Web-projekter
Typescript-projekterne gøres klar til release ved at
- rette versions-nummeret i packages.json
- køre npm install
- kopiere trunk til tags-mappen, fx
svn cp -m "
<fantastisk commit-kommentar>" https://svn.nspop.dk/svn/components/nap/nap-administration/trunk https://svn.nspop.dk/svn/components/nap/nap-administration/tags/release-1.0.0rc8
nap-lobby-web
Indeholder et angular projekt, der har til formål at vise projekter som det givne LPS system har rettigheder til. Projektet bruger standard strukturen for et Angular projekt, dvs. alt koden ligger inde i src/ mappen.
Nap-lobby-web gør brug af nap-administration backenden, til at hente de projekter der er til rådighed.
Funktionalitet
Projektet har tre faner "Projekter", "Administrrer" og "hjælp".
Projekter viser alle de projekter, som der er rettigheder til. Hvert projekt har titel, samt et versions nummer. Hvert projekt kan foldes ud ved at trykke på "mere", som så viser den tilknyttet web-app. Web-app'en viser titel, beskrivelse, version, udgivelses dato, url den ligger på, samt hvilke versioner af event kataloget den understøtter.
Administrer viser alle projekterne og giver mulighed for at oprette nye eller redigere i eksisterende projekter.
Hjælp beskriver, hvad applikations formål, samt et link til at oprette en support sag.
Udviklingsmiljø
Installer afhængigheder
Installer dependencies ved at køre "npm install --registry https://nexus.nspop.dk/nexus/repository/nsp-npm/"
Udviklingserver
For at starte en web pack dev server i docker køres "docker-compose build && docker-compose up" fra compose/development mappen.
Applikationen kan nu nåes http://localhost:8080/nap/lobby/web/, hvis nap-compose reverse proxy er opsat som i 1.3.1 - Udvikling, ellers på http://localhost:4200.
nap-lobby-web bruger nap-administration som backend til at vise projekterne. nap-administration skal derfor startes som beskrevet i 5 - nap-administration.
Hvis man ikke vil gøre brug af rigtige data, kan den "mockes" væk, således der vises dummy projekter. Dette kunne være for at se, hvordan det vil se ud hvis der var mange projekter tilføjet. Dette kan gøres ved at køre "npm run start:mock" hvis det køres lokalt, ellers kan der i compose/development ændres i docker-compose.yml "Command" parameter, hvor der tilføjes "--configuration=mock"
CI
Jenkins filen beskriver jenkins pipelinen.
NapLobbyWeb-build - bygger nap-lobby-web
NapAdmin-build - bygger nap-admin. I denne pibeline kan det vælges at bygge nap-lobby-web, hvis dette ønskes inkluderet.
NapAdmin- push snapshot - bygger nap-lobby-web og lægger bygget ind i roden af nap-admin samt pusher til NSP's docker registry.
Byg
Kør "npm run build" for at bygge projektet. Dette giver et output i dist/ folderen. Brug "npm run build-prod" for et produktionsbyg.
Linting
Kør "npm run lint" for linting, output kommer i konsollen
Test
Kør "npm run test" for at afvikle unit tests - output vil ligge I coverage/ mappen.
Dokumentation
For at generere dokumentation til koden, kør "npm run doc". Dokumentation ligger i docs/ mappen.
nap-test-web
Indeholder et angular projekt, der har til formål at være test-platform for værtssystemsudvikler.
Funktionalitet
Projektet har til hensigt at teste der kan sendes og modtages beskender igennem NAP sdk'erne.
Den implementere det fulde eventkatalog fra NAP SDK - Guide til anvendere.
Der er separate tests cases, som kan køres enkeltvis eller samlet.
Udviklingsmiljø
Installer afhængigheder
Installer dependencies ved at køre "npm install --registry https://nexus.nspop.dk/nexus/repository/nsp-npm/"
Udviklingserver
For at starte en web pack dev server i docker køres "docker-compose build && docker-compose up" fra compose/development mappen.
Applikationen kan nu nåes http://localhost:8080/nap/test/web/, hvis nap-compose reverse proxy er opsat som beskrevet tidligere, ellers på http://Localhost:4500.
CI
Jenkins filen beskriver jenkins pipelinen.
NapTestWeb - build - bygger nap-test-web
NapTestWeb - push release candidate - pusher en release kandidat til NSP's docker registry
NapTestWeb - push snapshot - pusher en snapshot til NSP's docker registry
NapTestWeb - push release - pusher et release til NSP's docker registry
Byg
Kør "npm run build" for at bygge projektet. Dette giver et output i dist/ folderen. Brug "npm run build-prod" for et produktionsbyg.
Linting
Kør "npm run lint" for linting.
Dokumentation
For at generere dokumentation til koden, kør "npm run doc". Dokumentation ligger i docs/ mappen.
nap-administration
nap-administration fungerer som den administrative service for NAP projekter og webapplikationer.
Funktionalitet
nap-administration indeholder 3 REST services for projekter, webapplikationer og session.
Desuden håndteres i denne app de enkelte vært-/ LPSsystemers projektrettigheder.
Udviklingsmiljø
Installer afhængigheder
Installer dependencies ved at "mvn install".
Udviklingserver
For at starte en wildfly server til udvikling køres "docker-compose build && docker-compose up" fra compose/development mappen.
Applikationen kan nu nåes internt i docker på netværket nap_net på http://napadmin:8080/, og http://localhost:8080/nap/admin/services/main, hvis nap-compose reverse proxy er opsat som i 1.3.1 - Udvikling.
CI
Jenkins filen beskriver jenkins pipelinen.
Nap-administration bygges på NSP's Jenkins server via følgende jobs.
NapLobbyWeb-build - bygger nap-lobby-web
NapAdmin-build - bygger nap-admin. I denne pibeline kan det vælges at bygge nap-lobby-web, hvis dette ønskes inkluderet.
NapAdmin- push snapshot - bygger nap-lobby-web og lægger bygget ind i roden af nap-admin samt pusher til NSP's docker registry.
NapAdmin - push release - laver et release af nap-admin og pusher til NSP's docker registry.
Test
JUnit anvendes til implementering af unit tests. Der er løbende gennemført unit tests på alle komponenter i projektet.
Unit tests kan afvikles ved at køre: `mvn test` og Coverage rapport generes med maven-surefire og publiceres med jacoco.
Dokumentation
For at generere dokumentation til koden, kør "npm run doc". Dokumentation ligger i docs/ mappen.
Debugger
Debugging er slået til som default, en JVM debugger kan attaches med `-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8787`
Konfiguration
Alt konfiguration foregår ved at loade filer fra wildfly modulet dk.sds.nsp.nap.reference.facade.
De følgende konfigurationsfiler skal således volume mappes ind i modulet "dk/sds/nsp/nap/admin/main/" på applikations serveren (/pack/wildfly8/modules/ i docker).
Konfigurationsfiler | |
---|---|
Filnavn | Indhold |
nap-lobby-ds.xml | Datasource beskrivelse. Vigtigt med jndi navn "java:jboss/datasources/nap-lobby-facade" da dette skal matche konfiguration i persistence.xml |
log4j-napadmin.xml | Log4j opsætninger der følger gængs standard på NSP. |
Disse filer bliver loadet ind på classpath wildfly når applikationen deployes.
Ved konfigurationsændringer skal wildfly serveren genstartes.
Konfiguration af oiosaml sker i filerne "compose/configuration/oiosaml".
Der findes en konfiguration til develop / test-develop / og test-1 (test1 miljøet).
De forskellige konfigurationer adskiller sig primært for singleLogoutService i SPMetadata og iDpMetadata samt og service provider url i oiosaml-sp.properties.
Oiosaml konfigurationerne skal ligeledes være tilgængelig i oiosaml.home under deployment (oiosaml.home sættes med JAVA_OPTS i compose filerne og er sat til /pack/oiosaml).
Konfigurationsfiler | |
---|---|
oiosaml-sp.log4j.xml | lndeholder Log4j opsætninger der følger gængs standard på NSP. |
oiosaml-sp.properties | # Properties used by oiosaml-j oiosaml-sp.certificate.location=
|
funktionscertifikat | JKS fil indeholdende Sundhedsdatastyrelsen reference funktionscertifikat certifikat. Skal være samme navn som oiosaml-sp.certificate.location i oiosaml-sp.properties |
metadata/idP/IdPMetadata.xml | OIOSAML identity provider metadata til konfiguration af OIOSAML filteret |
metadata/SP/SPMetadata.xml | OIOSAML service provider metadata til konfiguration af OIOSAML filteret |
Persistence
Persitence.xml placeret i meta-inf definerer hibernate konfigurationen. Hvis der tilføjes nye tables, skal denne opdateres
Database
Datamodellen kan ses her i Data.
nap-host-java
nap-host-java er en tyk java klient. Den fungerer som et eksempel på et værtssystem, egnet som test-platform for gæstesystemudviklere, samt som et implementations eksempel for værtsystems- / LPSudviklere
Funktionalitet
For beskrivelse af funktionaliteten i nap-host-java, findes der mere information beskrevet i Guide til anvendere
For at nap-host-java kan vise projekterne, er det vigtigt at nap-lobby-web er sat op til at køre som beskrevet i 3. Nap Lobby Web.
Udviklingsmiljø
Installer afhængigheder
Installer dependencies ved at "mvn install".
Udviklingserver
For at starte applikationen køres main fra Launcher klassen.
CI
Jenkins filen beskriver jenkins pipelinen.
Der kan laves snapshots og release-candidates fra jenkins.
Test
JUnit anvendes til implementering af unit tests. Der er løbende gennemført unit tests på alle komponenter i projektet.
Unit tests kan afvikles ved at køre: `mvn test` og Coverage rapport generes med maven-surefire og publiceres med jacoco.
Konfiguration
Nap-host-java konfigureres i nap-java-host.properties som pakkes med i classpath.