From 54ad86a56463bb2f990680bb79f9523baef6b6d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Svein=20Elgst=C3=B8en?= <189128153+navelgen@users.noreply.github.com> Date: Fri, 17 Jan 2025 16:08:08 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Autoformatter=20og=20korriger=20?= =?UTF-8?q?link=20til=20LocalApp.kt=20i=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Christian Skovborg Gule --- README.md | 46 +++++++++++++++++++++++++++++++++++----------- 1 file changed, 35 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0c8d9fe5e..8b23eabf7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # Spesialist + ![Bygg og deploy](https://github.com/navikt/helse-spesialist/workflows/Bygg%20og%20deploy/badge.svg) ## Beskrivelse + Backend for saksbehandling av sykepengesøknader ## Moduler @@ -39,7 +41,8 @@ Modulene er: #### Ktlint -Vi bruker [Ktlint](https://github.com/pinterest/ktlint) for linting av koden, for å sette dette opp må man kjøre følgende kommando: +Vi bruker [Ktlint](https://github.com/pinterest/ktlint) for linting av koden, for å sette dette opp må man kjøre +følgende kommando: ```shell ./gradlew addKtlintFormatGitPreCommitHook @@ -48,20 +51,25 @@ Vi bruker [Ktlint](https://github.com/pinterest/ktlint) for linting av koden, fo Det holder å kjøre kommandoen en gang, så er commithooken satt opp for fremtidige commits. #### Credentials + For å kunne kjøre gradle må du legge til `githubUser` og `githubPassword` i `~/.gradle/gradle.properties` filen. ```properties - githubUser=x-access-token - githubPassword= +githubUser=x-access-token +githubPassword= ``` ### Docker -For å kjøre tester trenger du docker. Du kan enten installere klienten fra [docker](https://www.docker.com/) eller bruke colima. + +For å kjøre tester trenger du docker. Du kan enten installere klienten fra [docker](https://www.docker.com/) eller bruke +colima. #### Colima + ```shell brew install colima docker ``` + For at colima skal virke må disse env variablene settes opp i `~/.zshrc`: ```shell @@ -74,41 +82,57 @@ colima start ``` ## Oppdatere GraphQL schema mot spleis + - Kjør tasken `graphqlIntrospectSchema` i spesialist-api, enten i IntelliJ eller fra kommandolinja - - Fra kommandolinja: `./gradlew :spesialist-api:graphqlIntrospectSchema` + - Fra kommandolinja: `./gradlew :spesialist-api:graphqlIntrospectSchema` - Gjør eventuelt endringer i hva som skal hentes fra spleis i filen `hentSnapshot.graphql` - Kjør tasken `graphqlGenerateClient` for å få generert klassene > ℹ️ `graphqlGenerateClient` vil også kjøres som en del av et vanlig bygg, i motsetning til `graphqlIntrospectSchema`. ## Oppdatere GraphQL schema for tester -Hvis du nylig har gjort endringer i GraphQL-typer, -mutations, -queries eller -subscriptions og ønsker å teste disse endringene, er det lurt å først oppdatere lokalt testskjema, slik at du får syntax highlighting, code completion og et bedre liv. Da gjør du følgende: -- Kjør opp [LocalApp.kt](spesialist-selve/src/test/kotlin/no/nav/helse/LocalApp.kt) sin main-metode, det starter en lokal GraphQL-server. -- Finn filen [graphql.config.yml](spesialist-api/src/test/graphql.config.yml) og kjør `spesialist-local`, som vil oppdatere [schema_til_bruk_fra_tester.grapqhl](spesialist-api/src/test/schema_til_bruk_fra_tester.graphql). + +Hvis du nylig har gjort endringer i GraphQL-typer, -mutations, -queries eller -subscriptions og ønsker å teste disse +endringene, er det lurt å først oppdatere lokalt testskjema, slik at du får syntax highlighting, code completion og et +bedre liv. Da gjør du følgende: + +- Kjør opp [LocalApp.kt](spesialist-bootstrap/src/test/kotlin/no/nav/helse/LocalApp.kt) sin main-metode, det starter en + lokal GraphQL-server. +- Finn filen [graphql.config.yml](spesialist-api/src/test/graphql.config.yml) og kjør `spesialist-local`, som vil + oppdatere [schema_til_bruk_fra_tester.grapqhl](spesialist-api/src/test/schema_til_bruk_fra_tester.graphql). - Eller trykk på oppdater-ikonet i `schema_til_bruk_fra_tester.grapqhl`, ser ut til å gjøre det samme. - Commit endringene i `schema_til_bruk_fra_tester.graphql`. ## Kjøre lokal GraphQL Playground + - kjør main-funksjonen i LocalApp.kt - gå til http://localhost:4321/graphql/playground i en nettleser -- TODO: finn ut hvordan man veksler inn tokenet som skrives ut under oppstart av LocalApp til et bearer token, og sett det som header i playgrounden +- TODO: finn ut hvordan man veksler inn tokenet som skrives ut under oppstart av LocalApp til et bearer token, og sett + det som header i playgrounden ## Kjøre tester raskere + - Finn filen .testcontainers.properties, ligger ofte på hjemmeområdet ditt, eksempelvis `~/.testcontainers.properties` - Legg til denne verdien: `testcontainers.reuse.enable=true` ## Oppgradering av gradle wrapper + - Finn nyeste versjon av gradle her: https://gradle.org/releases/ -- Kjør `./gradlew wrapper --gradle-version $gradleVersjon` to ganger, ref. [dokumentasjonen til Gradle](https://docs.gradle.org/current/userguide/gradle_wrapper.html#sec:upgrading_wrapper). +- Kjør `./gradlew wrapper --gradle-version $gradleVersjon` to ganger, + ref. [dokumentasjonen til Gradle](https://docs.gradle.org/current/userguide/gradle_wrapper.html#sec:upgrading_wrapper). - Oppdater gradle-versjon i build.gradle.kts-filen: `gradleVersion = "$gradleVersjon"` ## Spesialist-opprydding-dev + En selvstendig app for å slette testpersoner, kjører kun i dev. Spleis-testdata fyrer av et kafka-event som spesialist-opprydding-dev lytter på og sletter testpersoner. ## Henvendelser + Spørsmål knyttet til koden eller prosjektet kan stilles som issues her på GitHub. ### For NAV-ansatte -Interne henvendelser kan sendes via Slack i kanalen [#team-bømlo-værsågod](https://nav-it.slack.com/archives/C019637N90X). + +Interne henvendelser kan sendes via Slack i +kanalen [#team-bømlo-værsågod](https://nav-it.slack.com/archives/C019637N90X).