Przejdź do treści

Strona może być nieaktualna

Nikt jej nie zmieniał od 32 miesięcy (ostatni commit: 2024-03-08, Dariusz). Jeśli opisuje stan, którego już nie ma, zgłoś ją jako nieaktualną.

Mikroserwis do parsowania plików xml do jsona

Wymagania

  • IntelliJ Ultimate — używamy Kotlin, więc potrzebujemy pełnej wersji IntelliJ;
  • JDK 17 — może być z https://adoptopenjdk.net/, choć IntelliJ powinien ją sam pobrać, jeśli nie znajdzie odpowiedniej;
  • PostgreSQL — powinna zadziałać dowolna aktywna wersja, ale polecamy wyższą niż 10;
  • Git;
  • RabbitMQ

Odpalenie projektu

Zakładając, że używamy IntelliJ, kroki do uruchomienia aplikacji są następujące.

  1. Pobieramy projekt z BitBucket.
  2. Tworzymy pustą bazę danych.
  3. Kopiujemy application.default.yml do application.external.yml i ustawiamy dostępy oraz potrzebne nam parametry.
  4. Uruchamiamy aplikację w IntelliJ.

Docker

Całą aplikacje można uruchomić za pomocą docker-compose. Aby to zrobić: 1. Stwórz application.external.yml na podstawie pliku application.default.docker.yml 2. Stwórz plik .env na podstawie pliku .env.example 2. W głównym folderze aplikacji wykonaj komendę docker compose --profile dev up 3. Aplikacja uruchomi się i będzie wystawiona na porcie 8888. Możesz korzystać z panelu rabbit'a pod portem 15666. Baza danych postgresql dostępna jest na porcie 5444

Przygotowanie bazy danych pod dockera

  • zakładamy, że używamy domyślnego użytkownika euroglas ($FTP_USER=euroglas) 1. Przechodzimy do kontenera z postgresem - docker exec -it microservice-parser-db 2. Wchodzimy do bazy - psql -U postgres -d microservice-parser 3. Zmieniamy konfigurację w tabelkach principal_config oraz sftp_config:
    UPDATE principal_config SET enabled = true WHERE alias = EUROGLAS;
    UPDATE sftp_config SET remote_base_dir = '/$FTP_USER' WHERE username = $FTP_USER;
    

Docker | Jak dodawać pliki do "ftp" użytkownika

Jeśli sftp mikroserwisu skonfigurujemy jako 'localhost' (czyli sftp z poziomu kontenera), to mamy kilka sposobów na dodanie nowym plików xml:

docker cp

Używamy docker cp - docker cp ./local-file.xml microservice-parser:/home/<SFTP_USERNAME>/sap_to_lp

wysyłamy plik po ssh

  1. Sprawdzamy IP kontenera microservice-parser komendą docker inspect microservice-parser | grep "IPAddress"
  2. Wysyłamy plik komendą scp ./local-file.xml euroglas@<IP_ADDRESS>:/home/<SFTP_USERNAME>/sap_to_lp

logujemy się za pomocą klienta FTP

  1. Sprawdzamy IP kontenera (lub serwera jeśli mamy forwarding) microservice-parser komendą docker inspect microservice-parser | grep "IPAddress"
  2. Uruchamiamy klienta FTP np. Filezilla
  3. Host ustawiamy jako ip z punktu 1., port 22 (lub CONTAINER_SFTP_PORT przy forwardowaniu portów)

Mkdocs

Instalacja

Instalacja mkdocs:

pip install mkdocs

Instalacja ciemnego motywu:

pip install mkdocs-dracula-theme

Jak zbudować dokumentację?

Budowanie dokumentacji (Windows):

python -m mkdocs build

Wystawienie dokumentacji:

python -m mkdocs serve

Ostatnia zmiana: 2024-03-08 · Dariusz
Zbudowano: 2026-11-20 10:32 UTC · wersja 1.0.0 · rewizja: 19fcdc12e