Merge pull request #3 from Opetushallitus/OK-756-swagger

Ok 756 swagger

README.md

@@ -1 +1,46 @@
-# ovara-virkailija
+## Ovara-virkailija - Opiskelijavalinnan raportoinnin virkailijakäyttöliittymä
+
+Ovara koostuu kahdesta sovelluksesta: Spring bootilla ja Scalalla toteutetusta backendistä,
+jonka tarjoamien HTTP-rajapintojen kautta Next.js:llä toteutettu käyttöliittymä noutaa virkailijoiden tarvitsemia raportteja.
+Käyttöliittymässä käyttäjä täyttää lomakkeen avulla kyselyn, jonka perusteella backend noutaa tiedot Ovaran omasta tietokannasta ja
+muodostaa excel-tiedoston, joka ladataan käyttäjän selaimeen.
+
+# Ovara-backendin
+
+Backend käyttää Java Corretton versiota 21.
+
+Backendiä ajetaan IDEA:ssa. Kehitysympäristön konfiguraatio määritellään `application-dev.properties`-nimisessä tiedostossa
+````
+spring.datasource.url=jdbc:postgresql://localhost:5432/ovara
+spring.datasource.username=app
+spring.datasource.password=app
+
+opintopolku.virkailija.domain=https://virkailija.hahtuvaopintopolku.fi
+cas.url=${opintopolku.virkailija.domain}/cas
+ovara.ui.url=https://localhost:3405
+ovara.backend.url=http://localhost:8080/ovara-backend
+ovara-backend.cas.password=<CAS-SALASANA>
+
+#logging.level.org.springframework.cache=TRACE
+````
+
+Backendiä voi ajaa sekä lokaalia dockeriin käynnistettävää postgresia että testiympäristön tietokantaa vasten.
+(Kirjoitushetkellä ovaran tietokanta on olemassa pelkästään QA:lla.) `justfile`:stä
+löytyvät komennot tietokannan pystyttämiseen tai tietokantayhteyden avaamiseen. [just](https://github.com/casey/just) on
+komentorivityökalu komentojen dokumentoimiseen ja ajamiseen. Esimerkiksi `just ssh-to-remote-db-in-pallero` avaa tietokantayhteyden
+QA:n ovara-tietokantaan. Lokaalin tietokannan käyttäminen vaatii tietokantadumpin lataamisen omalle koneelle,
+ja sen voi tehdä komennolla `just dump-remote-db`. `just`:in asentaminen ei ole välttämätöntä backendin ajamiseksi,
+vaan voit katsoa tarvittavat komennot `justfile`:stä ja ajaa ne sellaisinaan komentoriviltä.
+
+Ovara-backendin rajapinta on dokumentoitu Swaggeriä käyttäen ja se löytyy osoitteesta: `http://localhost:8080/ovara-backend/swagger-ui/index.html`.
+Rajapintojen kutsuminen edellyttää kirjautumista. Kehitysympäristössä tämä tapahtuu helpoiten siten, että myös ovara-ui on
+lokaalisti käynnissä ja kirjaudut sen kautta sisään ennen swaggerin rajapintojen käyttämistä.
+
+
+
+
+# Ovara-ui
+
+Ovara-ui on toteutettu Next.js:llä.
+
+Käyttöliittymän saa käynnistettyä komennolla `npm run dev`. Käyttöliittymä avautuu osoitteeseen: `https://localhost:3405`.

ovara-backend/.scalafmt.conf

@@ -0,0 +1,5 @@
+version = 2.7.5
+maxColumn = 120
+assumeStandardLibraryStripMargin = true
+align.preset = more
+includeCurlyBraceInSelectChains = false

ovara-backend/justfile

@@ -3,15 +3,21 @@ remote-ip := "10.20.89.144"
 _default:
     just --list --unsorted
 
-mfa-pallero-bastion:
-    ssh pallero-bastion
+ssh-to-remote-db-in-pallero:
+    ssh -N -L 5433:rds-privatelink.ovara.testiopintopolku.fi:5432 pallero-bastion
+
+
 
 connect-to-remote-db:
     sshuttle -l 0.0.0.0 -r pallero-bastion {{remote-ip}}/32
 
+# DB DUMP FOR LOCAL POSTGRES
 dump-remote-db:
     docker run --rm -it -v "$(pwd)":/work -w /work postgres pg_dump -h {{remote-ip}} -p 5432 -U app -Fc ovara -n pub -n int -f ovara.dump
 
+watch-dump-progress:
+    watch -n 1 du -h ovara.dump
+
 start-postgresql:
     docker compose up
 

ovara-backend/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>3.3.3</version>
+        <version>3.3.5</version>
         <relativePath/> <!-- lookup parent from repository -->
     </parent>
     <groupId>fi.oph.ovara</groupId>
@@ -28,8 +28,8 @@
     </scm>
     <properties>
         <scala.version>3.5.0</scala.version>
-        <spring.boot.version>3.3.3</spring.boot.version>
         <java.cas.version>1.2.1-SNAPSHOT</java.cas.version>
+        <scalatest.version>3.2.19</scalatest.version>
     </properties>
     <dependencies>
         <dependency>
@@ -54,7 +54,6 @@
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-jpa</artifactId>
-            <version>3.3.2</version>
         </dependency>
         <dependency>
             <groupId>org.postgresql</groupId>
@@ -66,11 +65,6 @@
             <artifactId>spring-boot-starter-test</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>io.swagger.core.v3</groupId>
-            <artifactId>swagger-annotations-jakarta</artifactId>
-            <version>2.2.19</version>
-        </dependency>
         <dependency>
             <groupId>org.springdoc</groupId>
             <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
@@ -85,10 +79,6 @@
             <artifactId>slick_3</artifactId>
             <version>3.5.0-M5</version>
         </dependency>
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-api</artifactId>
-        </dependency>
         <dependency>
             <groupId>com.zaxxer</groupId>
             <artifactId>HikariCP</artifactId>
@@ -117,6 +107,50 @@
             <groupId>org.springframework.security</groupId>
             <artifactId>spring-security-cas</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-cache</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-context-support</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.github.ben-manes.caffeine</groupId>
+            <artifactId>caffeine</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.module</groupId>
+            <artifactId>jackson-module-scala_3</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.scalatest</groupId>
+            <artifactId>scalatest_3</artifactId>
+            <version>${scalatest.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.scalactic</groupId>
+            <artifactId>scalactic_3</artifactId>
+            <version>${scalatest.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.json4s</groupId>
+            <artifactId>json4s-jackson_3</artifactId>
+            <version>4.1.0-M7</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.poi</groupId>
+            <artifactId>poi-ooxml</artifactId>
+            <version>5.3.0</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
     </dependencies>
     <build>
         <plugins>

ovara-backend/src/main/resources/application.properties

@@ -14,3 +14,7 @@ ovara.ui.url=${opintopolku.virkailija.domain}
 cas.url=${opintopolku.virkailija.domain}/cas
 ovara-backend.cas.username=ovara_backend
 ovara-backend.cas.password=<password>
+
+#swagger-ui config
+springdoc.swagger-ui.path=/swagger-ui
+springdoc.swagger-ui.operationsSorter=alpha

ovara-backend/src/main/scala/fi/oph/ovara/backend/OvaraBackendApplication.scala

@@ -1,28 +1,27 @@
 package fi.oph.ovara.backend;
 
-import fi.oph.ovara.backend.repository.OvaraDatabase
-import org.springframework.beans.factory.annotation.Autowired
+import org.slf4j.{Logger, LoggerFactory}
 import org.springframework.boot.autoconfigure.SpringBootApplication
 import org.springframework.boot.{ApplicationArguments, ApplicationRunner, SpringApplication}
 import org.springframework.context.annotation.{Bean, Profile}
 import org.springframework.web.servlet.config.annotation.{CorsRegistry, WebMvcConfigurer}
 
 object OvaraBackendApplication {
-    def main(args: Array[String]): Unit = {
-      SpringApplication.run(classOf[OvaraBackendApplication], args*)
-    }
+  val CALLER_ID = "1.2.246.562.10.00000000001.ovara-virkailija"
+
+  def main(args: Array[String]): Unit = {
+    SpringApplication.run(classOf[OvaraBackendApplication], args *)
+  }
 }
 
 @SpringBootApplication
 class OvaraBackendApplication {
-  @Autowired
-  val db: OvaraDatabase = null
+
+  val LOG: Logger = LoggerFactory.getLogger(classOf[OvaraBackendApplication])
 
   @Bean
   def applicationRunner(): ApplicationRunner =
-    new ApplicationRunner:
-      override def run(args: ApplicationArguments): Unit =
-        println("STARTED OVARA APPLICATION RUNNER")
+    (args: ApplicationArguments) => LOG.info("STARTED OVARA APPLICATION RUNNER")
 
   @Profile(Array("dev"))
   @Bean
@@ -31,4 +30,4 @@ class OvaraBackendApplication {
       registry.addMapping("/**").allowedOrigins("https://localhost:3405")
     }
   }
-}
+}

ovara-backend/src/main/scala/fi/oph/ovara/backend/domain/Enum.scala

@@ -0,0 +1,16 @@
+package fi.oph.ovara.backend.domain
+
+trait EnumType {
+  def name: String
+
+  override def toString: String = name
+}
+
+trait Enum[T <: EnumType] {
+  def name: String
+
+  def values: List[T]
+
+  def withName(n: String): T = values.find(_.name.equals(n))
+    .getOrElse(throw new IllegalArgumentException(s"Unknown ${name} '${n}'"))
+}

ovara-backend/src/main/scala/fi/oph/ovara/backend/domain/Haku.scala

@@ -0,0 +1,4 @@
+package fi.oph.ovara.backend.domain
+
+case class Haku(haku_oid: String,
+                haku_nimi: Kielistetty)

ovara-backend/src/main/scala/fi/oph/ovara/backend/domain/Kieli.scala

@@ -0,0 +1,13 @@
+package fi.oph.ovara.backend.domain
+
+sealed trait Kieli extends EnumType with Product with Serializable
+
+object Kieli extends Enum[Kieli] {
+  override def name: String = "kieli"
+  def values = List(Fi, Sv, En)
+}
+
+case object Fi extends Kieli { val name = "fi" }
+case object Sv extends Kieli { val name = "sv" }
+case object En extends Kieli { val name = "en" }
+

ovara-backend/src/main/scala/fi/oph/ovara/backend/domain/KoulutuksetToteutuksetHakukohteetResult.scala

@@ -0,0 +1,13 @@
+package fi.oph.ovara.backend.domain
+
+case class KoulutuksetToteutuksetHakukohteetResult(
+    hakukohdeNimi: Kielistetty,
+    hakukohdeOid: String,
+    koulutuksenTila: Option[String] = None,
+    toteutuksenTila: Option[String] = None,
+    hakukohteenTila: Option[String] = None,
+    aloituspaikat: Option[Int] = None,
+    onValintakoe: Option[Boolean] = None,
+    voiSuorittaaKaksoistutkinnon: Option[Boolean] = None,
+    jarjestaaUrheilijanAmmKoulutusta: Option[Boolean] = None
+)

ovara-backend/src/main/scala/fi/oph/ovara/backend/domain/UserResponse.scala

@@ -2,5 +2,8 @@ package fi.oph.ovara.backend.domain
 
 import scala.beans.BeanProperty
 
-case class UserResponseUser(@BeanProperty userOid: String)
-case class UserResponse(@BeanProperty user: UserResponseUser)
+case class User(@BeanProperty userOid: String,
+                @BeanProperty authorities: List[String],
+                @BeanProperty asiointikieli: Option[String] = None)
+
+case class UserResponse(@BeanProperty user: User)

ovara-backend/src/main/scala/fi/oph/ovara/backend/domain/package.scala

@@ -0,0 +1,16 @@
+package fi.oph.ovara.backend
+
+package object domain {
+  type Kielistetty = Map[Kieli, String]
+
+  val ammatillisetHakukohdekoodit = List(
+    "10", // Aikuiskoulutus
+    "19", // Aikuisten perusopetus
+    "15", // Ammatillinen peruskoulutus erityisopetuksena
+    "11", // Perusopetuksen jälkeisen koulutuksen yhteishaku
+    "20", // Erityisopetuksena järjestettävä ammatillinen koulutus
+    "23", // Ammatillinen koulutus
+    "24", // Lukiokoulutus
+    "21", // Yhteishaun ulkopuolinen lukiokoulutus
+  )
+}