/pagopa-api-config

Api per configurare la piattaforma pagoPa

Primary LanguageJavaMIT LicenseMIT

pagoPa Api Config

Quality Gate Status

Spring Application exposes Api to manage configuration for EC/PSP on the Nodo dei Pagamenti.

Api Documentation 📖

See the Swagger 2 here.

See the OpenApi 3 here.

Technology Stack

  • Java 11
  • Spring Boot
  • Spring Web
  • Hibernate
  • JPA

Start Project Locally 🚀

Prerequisites

  • docker
  • account on dockerhub

👀 The docker account is needed to be able to pull the image oracle-db-ee and for which accept the Terms of Service via web. Open this link and click on "Proceed to Checkout" button.

Remember to login to the local docker with docker login command

Run docker container

docker-compose up --build

🔴 Don't worry about connection error messages like this The Network Adapter could not establish the connection, read the whole paragraph

If all right, eventually you'll see something like that:

oracle-db-12c | /u01/app/oracle/diag/rdbms/orclcdb/ORCLCDB/trace/ORCLCDB_vktm_29.trc
flyway        | Flyway Community Edition 7.15.0 by Redgate
flyway        | Database: jdbc:oracle:thin:@oracle-db-12c:1521:ORCLCDB (Oracle 12.2)
flyway        | Successfully validated 3 migrations (execution time 00:00.103s)
flyway        | Current version of schema "NODO4_CFG": 2
flyway        | Schema "NODO4_CFG" is up to date. No migration necessary.
flyway exited with code 0
spring-api-config | 2021-09-14 10:54:29.485  INFO 1 --- [           main] i.p.p.a.config.RetryableDataSource       : try getting connection...
spring-api-config | 2021-09-14 10:54:29.485  INFO 1 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Starting...
spring-api-config | 2021-09-14 10:54:29.814  INFO 1 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Start completed.
spring-api-config | 2021-09-14 10:54:29.868  INFO 1 --- [           main] org.hibernate.dialect.Dialect            : HHH000400: Using dialect: org.hibernate.dialect.Oracle12cDialect
spring-api-config | 2021-09-14 10:55:01.768  INFO 1 --- [           main] i.p.p.a.config.RetryableDataSource       : try getting connection...
spring-api-config | 2021-09-14 10:55:02.065  INFO 1 --- [           main] i.p.p.a.config.RetryableDataSource       : try getting connection...
spring-api-config | 2021-09-14 10:55:02.125  INFO 1 --- [           main] o.h.e.t.j.p.i.JtaPlatformInitiator       : HHH000490: Using JtaPlatform implementation: [org.hibernate.engine.transaction.jta.platform.internal.NoJtaPlatform]
spring-api-config | 2021-09-14 10:55:02.159  INFO 1 --- [           main] j.LocalContainerEntityManagerFactoryBean : Initialized JPA EntityManagerFactory for persistence unit 'default'
spring-api-config | 2021-09-14 10:55:02.858  WARN 1 --- [           main] JpaBaseConfiguration$JpaWebConfiguration : spring.jpa.open-in-view is enabled by default. Therefore, database queries may be performed during view rendering. Explicitly configure spring.jpa.open-in-view to disable this warning
spring-api-config | 2021-09-14 10:55:03.454  INFO 1 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path '/apiconfig'
spring-api-config | 2021-09-14 10:55:03.468  INFO 1 --- [           main] it.pagopa.pagopa.apiconfig.ApiConfig     : Started ApiConfig in 99.198 seconds (JVM running for 100.391)

NOTE : you can connect to local instance of NODO4_CFG db, for example via sqlplus typing sqlplus NODO4_CFG/NODO4_CFG@localhost:1521/ORCLCDB.localdomain on a terminal

The docker-compose command create 3 containers:

  • pagopa-api-config spring application,
  • Oracle DB with NODO_CFG instance
  • and Flyway to manage db versioning.

The DB container map /database/volume directory to store persistent data. Then flyway updates the DB using the script in /database/script directory and the configuration in /database/conf/flyway.conf.

Because Oracle container can take a long time to start up, the Spring application tries several times to connect using the annotation @Retryable waiting with an increasing delay. According to Control startup and shutdown order in Compose best practice. To details see RetryableDataSource.java and RetryableDatabasePostProcessor.java classes

⚠️ NB: for this reason you can see some connection error in the application log. After 10 failed attempts the application stops with an error.

Develop Locally 💻

Prerequisites

  • git
  • maven
  • jdk-11
  • docker

Run the project

The easiest way to develop locally is start only oracle and flyway containers.

/usr/local/bin/docker-compose up -d oracle
/usr/local/bin/docker-compose up -d flyway

Then start the springboot application with this command:

mvn spring-boot:run -Dspring-boot.run.profiles=local

Using the spring profile local, the Spring application connects to the docker DB.

Spring Profiles

  • azure-d: used in Azure develop environment
  • azure-u: used in Azure uat environment
  • azure-p: used in Azure production environment
  • azure-t: to run with H2 for testing purposing
  • local: to develop locally using the docker DB.
  • h2: to develop locally using the H2 DB.
  • docker: profile used by the app inside the container (see: /.env file)

Oracle Docker Container

Connection info of DB from other docker containers:

url = jdbc:oracle:thin:@oracle-db-12c:1521:ORCLCDB
user = NODO4_CFG
password = NODO4_CFG

⚠️ Attention!

If you want to connect to DB from your local PC replace oracle-db-12c with localhost

local url = jdbc:oracle:thin:@localhost:1521:ORCLCDB

Testing 🧪

Unit testing

by junit typing mvn clean verify

Integration testing

by newman & postman collection 🚀

  • automatically via Azure pipeline ( see .devops folder )
  • manual typing bash api-test/setup_env_api_test.sh <YOUR_STAGE> int example for localhost, where YOUR_STAGE shoud be one of {l,d,i,p}
bash api-test/setup_env_api_test.sh l int

Load testing

by k6 & postman collection 🚀

  • automatically via Azure pipeline ( see .devops folder )
  • manual typing bash api-test/setup_env_api_test.sh <YOUR_STAGE> load example for localhost, where YOUR_STAGE shoud be one of {l,d,i,p}
bash api-test/setup_env_api_test.sh l load

Contributors 👥

Made with ❤️ by PagoPa S.p.A.

Mainteiners

See CODEOWNERS file