Formålet med dette dokument er at beskrive, hvordan et udviklingsmiljø, til videreudvikling af NAP ref-implementation, skal sættes op, samt hvordan koden deployes og testes.
Dette dokument er en del af den samlede dokumentation for NAP Ref.impl.
Dokumentet er udformet, så det i videst muligt omfang opfylder sit formål uafhængigt af de øvrige dokumenter.
Ønskes mere information omkring arkitektur og design findes dette på NAP Ref.Impl. - Design og Arkitektur beskrivelse.
Hvis der er behov for yderligere dokumentation omkring hele NAP platformen, henvises til NAP Platform - Guide til anvendere.
Software requirements:
| Software | Version |
|---|---|
| Java | 8 |
| Docker Engine | 18.02.0+ |
| node | 10+ |
Det lokale udviklingsmiljø er opsat med docker-compose.
nap-reference-web og nap-reference-facade ligger som repositories på svn.nspop.dk. Disse skal hentes for anvende de foreslåede compose-setup.
Derudover kræves et docker netværk kaldet nap_net. Hvis dette ikke allerede er lavet kør `docker network create nap_net`.
Trafik på localhost:8080 skal routes igennem en lokal reverse-proxy https://svn.nspop.dk/svn/components/nap/nap-compose/, som er på også docket netværket nap_net og eksponeret på port 8080 på localhost.
Således bliver nap-ref-web tilgængelig på http://localhost:8080/nap/reference/web/.
Det meste funktionalitet af Nap-Ref-web kræver, at den er framet i en værtsapplikation. For at gøre dette, skal opsætning for nap-java-host, nap-lobby-web, nap-admin køres parallelt (NAP Platform - Guide til anvendere).
Nap-ref-web skal illustrere brugen af nap-typescript-sdk og nap-angular-sdk, anvendelse af samtlige versioner af eventkataloget, og demonstrer et projekt, der lever op til NSP husregler for webløsninger.
Installer dependencies med `npm install` i rodfolderen.
Under compose folderen findes forskellige composefiler til udvikling, test og release.
Vær opmærksom på kun at køre en service ved navn naprefweb. Stop derfor altid servicen og kør `docker-compose down`, når der skal skiftes setup.
For at starte en webpack dev server i docker køres `docker-compose build && docker-compose up` fra compose/develop. Developper setuppet volume mapper ./src folderen og konfigurationsfiler fra compose/configuration, hvilket betyder, at ændringer i kildekoden bliver compilet 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. Mere information om konfigurering kan læses på NAP Ref.Impl. - Installationsvejledning.
Applikationen kan nu nåes http://localhost:8080/nap/reference/web/, hvis nap-compose (https://svn.nspop.dk/svn/components/nap/nap-compose/) reverse proxy, står foran som nævnt ovenfor, og ellers på http://Localhost:4600.
compose/release konfigurationen bruges udelukkende i produktions øjemed.
Servicen benytter sig af nap-angular-sdk og nap-typescript-sdk og er udviklet til at være indlejret i et værtssytem (eksempelvis nap-java-host), hvor den får alt sin kontekst.
Det meste funktionalitet er bundet op på denne kontekst.
configurations.json indeholder de konfigurerbare parametre af apllikatione
Key | Value |
|---|---|
| AppointmentsEndpoint | Aftale endpoint |
| ServerUrl | Relative path til nap-reference-facade |
Konfigurationen bliver volume mappet af docker-compose og kan ændres runtime, men skal matche loadbalancer indstillingerne.
Det kan være en fordel at køre uden om nap-ref-facade, da den har en afhængighed til dokumentdelingsservicen på test1.
For at køre serverless skal `--configuration=mock` tilføjes startkommandoen i compose filen i compose/development/. Alle kald bliver resulterer nu i en indlæsning af ressourcer fra assets/.
Hvis nap-reference-web køres i serverless mode, kan den med fordel åbnes i chrome/firefox og debugges som vanligvis derfra.
Hvis den åbnes i nap-java-host, er den eneste debugging mulighed. consol.logs(). Disse statements printes til konsole vinduet af hosten, som kan toggles i toppen.
For at bygge projektet kan køres `npm run build`. For at køre et produktionsbyg køres `npm run build:prod`.
Jenkinsfilen beskriver en pipeline med install, test og build, der køres i NSPs node-chrome image, for at kunne afvikle test i en headless chromium browser.
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.
For at køre unit-tests med Karma kør `npm run test`. Det kører alle unit tests i en headless chromium browser.
Istanbul generer en coverage rapport kommer i /coverage.
Eventuelle fejl printes til STOUT.
Der kan køres linting med eslint med `npm run lint`.
Eventuelle fejl printes til STOUT.
Der kan generes dokumentation tsdoc med kommandon `npm run doc`
Installer dependencies med `mvn install` i rodfolderen.
Under compose folderen findes forskellige composefiler til udvikling, test og release.
Vær opmærksom på kun at køre en service ved navn napreffacade. Stop derfor altid servicen og kør `docker-compose down`, når der skal skiftes setup eller deployes nye kodeændringer.
For at starte en wildfly server til udvikling køres `docker-compose build --no-cache && docker-compose up´ fra compose/develop. Denne kommando skal køres hver gang der ønskes et nyt deploy med kode ændringer.
Developper setuppet sørger for at kopier target/nap-ref-facade.war og konfigurationerne fra compose/configuration over i et image NSPS wildfly image. Mere information om konfigurering kan læses på NAP Ref.Impl. - Installationsvejledning.
Applikationen kan nu nåes internt i docker på netværket nap_net på http://napreffacade:8080 og på nap-ref-facade på http://localhost:8080/nap/reference/web/services/main hvis nap-compose reverse proxy, står foran som nævnt ovenfor.
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.
Aplikationen kan nåes på samme url som ovenfor.
compose/release konfigurationen bruges udelukkende i produktions øjemed.
Der kan attaches en Jvm debugger på localhost:8878 med `-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8788`
For at bygge projektet kan køres `mvn compile`.
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` og Coverage rapport generes med maven-surefire og publiceres med jacoco.
Eventuelle fejl printes til STOUT.
Jenkinsfilen beskriver en pipeline med install og tests, der køres i NSPs java image. Jenkins bygger og deployer i snapshot versioner af NSPs wildfly container.