mirror of
https://github.com/dat515-2025/Group-8.git
synced 2026-03-22 15:12:08 +01:00
Compare commits
80 Commits
merge/emai
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
16f660ea5b | ||
| 7a0d7dc4af | |||
| fabdff3bef | |||
| 1c1130b9b0 | |||
| 7d7698450d | |||
|
|
db9092b78f | ||
| 3557b3ea13 | |||
| 4a1a9f03a1 | |||
| b1be15f559 | |||
|
|
515106b238 | ||
|
|
b5290119e9 | ||
| 0beb889f5e | |||
|
|
0a96c32c93 | ||
|
|
f1034f6ed5 | ||
| 0f729d28d1 | |||
| c689caea88 | |||
| 8c20deb690 | |||
| 39979b51ee | |||
| da0c77101d | |||
| a5a83e5d07 | |||
| 3749aa4525 | |||
| 94aa64addc | |||
| ba1677b2d3 | |||
|
|
8ea1ef9eea | ||
|
|
4b614902b2 | ||
| a152ecbe4d | |||
| 7d7dd98d0f | |||
| 5aca071ac2 | |||
|
|
80991c7390 | ||
|
|
1403e0029b | ||
| aa63e51e6a | |||
|
|
4aaaba3956 | ||
|
|
f0c28ba9e1 | ||
|
|
b560c07d62 | ||
|
|
f0b1452e30 | ||
| 6effb2793a | |||
|
|
ba7798259c | ||
| deb67f421e | |||
| 74557eeea8 | |||
| 2e0619d03f | |||
| 31add42d6d | |||
| 4de79169a2 | |||
| 59d53967b0 | |||
| f3086f8c73 | |||
|
|
fd437b1caf | ||
| 96ebc27001 | |||
|
|
922651fdbf | ||
|
|
e164b185e0 | ||
|
|
186b4fd09a | ||
|
|
280d495335 | ||
|
|
e73233c90a | ||
|
|
aade78bf3f | ||
|
|
50e489a8e0 | ||
|
|
1679abb71f | ||
| 573404dead | |||
| d57dd82a64 | |||
| 50f37c1161 | |||
| ae22d2ee5f | |||
| 509608f8c9 | |||
| ed723d1d13 | |||
| b0dee5e289 | |||
| 640da2ee04 | |||
| ab9aefd140 | |||
|
|
4eaf46e77e | ||
|
|
a30ae4d010 | ||
|
|
ef26e88713 | ||
|
|
2e1dddb4f8 | ||
|
|
25e587cea8 | ||
|
|
3cdefc33fc | ||
|
|
5954e56956 | ||
|
|
8575ef8ff5 | ||
| c53e314b2a | |||
| c0bc44622f | |||
| 3d31ff4631 | |||
|
|
8b92b9bd18 | ||
|
|
3d26ed6a62 | ||
|
|
67b44539f2 | ||
|
|
ff9cc712db | ||
| dc7ce9e6a1 | |||
|
|
1da927dc07 |
4
.github/workflows/build-image.yaml
vendored
4
.github/workflows/build-image.yaml
vendored
@@ -15,7 +15,7 @@ on:
|
||||
context:
|
||||
description: "Docker build context path"
|
||||
required: false
|
||||
default: "7project/backend"
|
||||
default: "7project/src/backend"
|
||||
type: string
|
||||
pr_number:
|
||||
description: "PR number (required when mode=pr)"
|
||||
@@ -94,7 +94,7 @@ jobs:
|
||||
tags: |
|
||||
${{ env.IMAGE_REPO }}:${{ env.TAG1 }}
|
||||
${{ env.IMAGE_REPO }}:${{ env.TAG2 }}
|
||||
platforms: linux/amd64
|
||||
platforms: linux/arm64,linux/amd64
|
||||
|
||||
- name: Set outputs
|
||||
id: set
|
||||
|
||||
14
.github/workflows/deploy-pr.yaml
vendored
14
.github/workflows/deploy-pr.yaml
vendored
@@ -21,7 +21,7 @@ jobs:
|
||||
with:
|
||||
mode: pr
|
||||
image_repo: lukastrkan/cc-app-demo
|
||||
context: 7project/backend
|
||||
context: 7project/src/backend
|
||||
pr_number: ${{ github.event.pull_request.number }}
|
||||
secrets: inherit
|
||||
|
||||
@@ -33,7 +33,7 @@ jobs:
|
||||
runner: vhs
|
||||
mode: pr
|
||||
pr_number: ${{ github.event.pull_request.number }}
|
||||
base_domain: ${{ vars.DEV_BASE_DOMAIN }}
|
||||
base_domain: ${{ vars.PROD_DOMAIN }}
|
||||
secrets: inherit
|
||||
|
||||
frontend:
|
||||
@@ -77,7 +77,7 @@ jobs:
|
||||
|
||||
- name: Helm upgrade/install PR preview
|
||||
env:
|
||||
DEV_BASE_DOMAIN: ${{ secrets.BASE_DOMAIN }}
|
||||
DEV_BASE_DOMAIN: ${{ vars.BASE_DOMAIN }}
|
||||
RABBITMQ_PASSWORD: ${{ secrets.PROD_RABBITMQ_PASSWORD }}
|
||||
DB_PASSWORD: ${{ secrets.PROD_DB_PASSWORD }}
|
||||
DIGEST: ${{ needs.build.outputs.digest }}
|
||||
@@ -85,13 +85,14 @@ jobs:
|
||||
DOMAIN_SCHEME: "${{ needs.get_urls.outputs.backend_url_scheme }}"
|
||||
FRONTEND_DOMAIN: "${{ needs.get_urls.outputs.frontend_url }}"
|
||||
FRONTEND_DOMAIN_SCHEME: "${{ needs.get_urls.outputs.frontend_url_scheme }}"
|
||||
UNIRATE_API_KEY: ${{ secrets.UNIRATE_API_KEY }}
|
||||
run: |
|
||||
PR=${{ github.event.pull_request.number }}
|
||||
RELEASE=myapp-pr-$PR
|
||||
NAMESPACE=pr-$PR
|
||||
helm upgrade --install "$RELEASE" ./7project/charts/myapp-chart \
|
||||
helm upgrade --install "$RELEASE" ./7project/src/charts/myapp-chart \
|
||||
-n "$NAMESPACE" --create-namespace \
|
||||
-f 7project/charts/myapp-chart/values-dev.yaml \
|
||||
-f 7project/src/charts/myapp-chart/values-dev.yaml \
|
||||
--set prNumber="$PR" \
|
||||
--set deployment="pr-$PR" \
|
||||
--set domain="$DOMAIN" \
|
||||
@@ -102,7 +103,8 @@ jobs:
|
||||
--set-string rabbitmq.password="$RABBITMQ_PASSWORD" \
|
||||
--set-string database.password="$DB_PASSWORD" \
|
||||
--set-string database.encryptionSecret="$PR" \
|
||||
--set-string app.name="finance-tracker-pr-$PR"
|
||||
--set-string app.name="finance-tracker-pr-$PR" \
|
||||
--set-string unirate.key="$UNIRATE_API_KEY"
|
||||
|
||||
- name: Post preview URLs as PR comment
|
||||
uses: actions/github-script@v7
|
||||
|
||||
18
.github/workflows/deploy-prod.yaml
vendored
18
.github/workflows/deploy-prod.yaml
vendored
@@ -4,9 +4,9 @@ on:
|
||||
push:
|
||||
branches: [ "main" ]
|
||||
paths:
|
||||
- 7project/backend/**
|
||||
- 7project/frontend/**
|
||||
- 7project/charts/myapp-chart/**
|
||||
- ../../7project/src/backend/**
|
||||
- ../../7project/src/frontend/**
|
||||
- ../../7project/src/charts/myapp-chart/**
|
||||
- .github/workflows/deploy-prod.yaml
|
||||
- .github/workflows/build-image.yaml
|
||||
- .github/workflows/frontend-pages.yml
|
||||
@@ -27,15 +27,17 @@ jobs:
|
||||
|
||||
build:
|
||||
name: Build and push image (reusable)
|
||||
needs: [test]
|
||||
uses: ./.github/workflows/build-image.yaml
|
||||
with:
|
||||
mode: prod
|
||||
image_repo: lukastrkan/cc-app-demo
|
||||
context: 7project/backend
|
||||
context: 7project/src/backend
|
||||
secrets: inherit
|
||||
|
||||
get_urls:
|
||||
name: Generate Production URLs
|
||||
needs: [test]
|
||||
uses: ./.github/workflows/url_generator.yml
|
||||
with:
|
||||
mode: prod
|
||||
@@ -99,10 +101,11 @@ jobs:
|
||||
SMTP_USE_TLS: ${{ secrets.SMTP_USE_TLS }}
|
||||
SMTP_USE_SSL: ${{ secrets.SMTP_USE_SSL }}
|
||||
SMTP_FROM: ${{ secrets.SMTP_FROM }}
|
||||
UNIRATE_API_KEY: ${{ secrets.UNIRATE_API_KEY }}
|
||||
run: |
|
||||
helm upgrade --install myapp ./7project/charts/myapp-chart \
|
||||
helm upgrade --install myapp ./7project/src/charts/myapp-chart \
|
||||
-n prod --create-namespace \
|
||||
-f 7project/charts/myapp-chart/values-prod.yaml \
|
||||
-f 7project/src/charts/myapp-chart/values-prod.yaml \
|
||||
--set deployment="prod" \
|
||||
--set domain="$DOMAIN" \
|
||||
--set domain_scheme="$DOMAIN_SCHEME" \
|
||||
@@ -125,4 +128,5 @@ jobs:
|
||||
--set-string smtp.password="$SMTP_PASSWORD" \
|
||||
--set-string smtp.tls="$SMTP_USE_TLS" \
|
||||
--set-string smtp.ssl="$SMTP_USE_SSL" \
|
||||
--set-string smtp.from="$SMTP_FROM"
|
||||
--set-string smtp.from="$SMTP_FROM" \
|
||||
--set-string unirate.key="$UNIRATE_API_KEY"
|
||||
6
.github/workflows/frontend-pages.yml
vendored
6
.github/workflows/frontend-pages.yml
vendored
@@ -35,7 +35,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: 7project/frontend
|
||||
working-directory: 7project/src/frontend
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
@@ -45,7 +45,7 @@ jobs:
|
||||
with:
|
||||
node-version: '20'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: 7project/frontend/package-lock.json
|
||||
cache-dependency-path: 7project/src/frontend/package-lock.json
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
@@ -61,7 +61,7 @@ jobs:
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: frontend-dist
|
||||
path: 7project/frontend/dist
|
||||
path: 7project/src/frontend/dist
|
||||
|
||||
deploy:
|
||||
name: Deploy to Cloudflare Pages
|
||||
|
||||
15
.github/workflows/run-tests.yml
vendored
15
.github/workflows/run-tests.yml
vendored
@@ -31,6 +31,9 @@ jobs:
|
||||
MARIADB_DB: group_project
|
||||
MARIADB_USER: appuser
|
||||
MARIADB_PASSWORD: apppass
|
||||
# Ensure the application uses MariaDB (async) during tests
|
||||
DATABASE_URL: mysql+asyncmy://appuser:apppass@127.0.0.1:3306/group_project
|
||||
DISABLE_METRICS: "1"
|
||||
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
@@ -43,19 +46,21 @@ jobs:
|
||||
|
||||
- name: Add test dependencies to requirements
|
||||
run: |
|
||||
echo "pytest==8.4.2" >> ./7project/backend/requirements.txt
|
||||
echo "pytest-asyncio==1.2.0" >> ./7project/backend/requirements.txt
|
||||
echo "pytest==8.4.2" >> ./7project/src/backend/requirements.txt
|
||||
echo "pytest-asyncio==1.2.0" >> ./7project/src/backend/requirements.txt
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install -r ./7project/backend/requirements.txt
|
||||
pip install -r ./7project/src/backend/requirements.txt
|
||||
|
||||
- name: Run Alembic migrations
|
||||
run: |
|
||||
alembic upgrade head
|
||||
working-directory: ./7project/backend
|
||||
working-directory: ./7project/src/backend
|
||||
|
||||
- name: Run tests with pytest
|
||||
env:
|
||||
PYTEST_RUN_CONFIG: "True"
|
||||
run: pytest
|
||||
working-directory: ./7project/backend
|
||||
working-directory: ./7project/src/backend
|
||||
8
.idea/.gitignore
generated
vendored
Normal file
8
.idea/.gitignore
generated
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
# Default ignored files
|
||||
/shelf/
|
||||
/workspace.xml
|
||||
# Editor-based HTTP Client requests
|
||||
/httpRequests/
|
||||
# Datasource local storage ignored files
|
||||
/dataSources/
|
||||
/dataSources.local.xml
|
||||
16
7project/.gitignore
vendored
16
7project/.gitignore
vendored
@@ -1,8 +1,8 @@
|
||||
/tofu/controlplane.yaml
|
||||
/tofu/kubeconfig
|
||||
/tofu/talosconfig
|
||||
/tofu/terraform.tfstate
|
||||
/tofu/terraform.tfstate.backup
|
||||
/tofu/worker.yaml
|
||||
/tofu/.terraform.lock.hcl
|
||||
/tofu/.terraform/
|
||||
/src/tofu/controlplane.yaml
|
||||
/src/tofu/kubeconfig
|
||||
/src/tofu/talosconfig
|
||||
/src/tofu/terraform.tfstate
|
||||
/src/tofu/terraform.tfstate.backup
|
||||
/src/tofu/worker.yaml
|
||||
/src/tofu/.terraform.lock.hcl
|
||||
/src/tofu/.terraform/
|
||||
|
||||
8
7project/.idea/.gitignore
generated
vendored
Normal file
8
7project/.idea/.gitignore
generated
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
# Default ignored files
|
||||
/shelf/
|
||||
/workspace.xml
|
||||
# Editor-based HTTP Client requests
|
||||
/httpRequests/
|
||||
# Datasource local storage ignored files
|
||||
/dataSources/
|
||||
/dataSources.local.xml
|
||||
@@ -1,43 +1,6 @@
|
||||
# Lab 6: Design Document for Course Project
|
||||
|
||||
| Lab 6: | Design Document for Course Project |
|
||||
| ----------- | ---------------------------------- |
|
||||
| Subject: | DAT515 Cloud Computing |
|
||||
| Deadline: | **September 19, 2025 23:59** |
|
||||
| Grading: | No Grade |
|
||||
| Submission: | Group |
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [1. Design Document (design.md)](#1-design-document-designmd)
|
||||
|
||||
The design document is the first deliverable for your project.
|
||||
We separated this out as a separate deliverable, with its own deadline, to ensure that you have a clear plan before you start coding.
|
||||
This part only needs a cursory review by the teaching staff to ensure it is sufficiently comprehensive, while still realistic.
|
||||
The teaching staff will assign you to a project mentor who will provide guidance and support throughout the development process.
|
||||
|
||||
## 1. Design Document (design.md)
|
||||
|
||||
You are required to prepare a design document for your application.
|
||||
The design doc should be brief, well-organized and easy to understand.
|
||||
The design doc should be prepared in markdown format and named `design.md` and submitted in the project group's repository.
|
||||
Remember that you can use [mermaid diagrams](https://github.com/mermaid-js/mermaid#readme) in markdown files.
|
||||
|
||||
The design doc **should include** the following sections:
|
||||
|
||||
- **Overview**: A brief description of the application and its purpose.
|
||||
- **Architecture**: The high-level architecture of the application, including components, interactions, and data flow.
|
||||
- **Technologies**: The cloud computing technologies or services used in the application.
|
||||
- **Deployment**: The deployment strategy for the application, including any infrastructure requirements.
|
||||
|
||||
The design document should be updated throughout the development process and reflect the final implementation of your project.
|
||||
|
||||
Optional sections may include:
|
||||
|
||||
- Security: The security measures implemented in the application to protect data and resources.
|
||||
- Scalability: The scalability considerations for the application, including load balancing and auto-scaling.
|
||||
- Monitoring: The monitoring and logging strategy for the application to track performance and detect issues.
|
||||
- Disaster Recovery: The disaster recovery plan for the application to ensure business continuity in case of failures.
|
||||
- Cost Analysis: The cost analysis of running the application on the cloud, including pricing models and cost-saving strategies.
|
||||
- References: Any external sources or references used in the design document.
|
||||
# Personal Finance Tracker
|
||||
## Folder Structure
|
||||
- meetings: Contains note from meetings
|
||||
- scr: Source code for the project
|
||||
- checklist: Project checklist and self assessment tracking
|
||||
- report.md: Detailed report of the project
|
||||
@@ -1,8 +0,0 @@
|
||||
FROM python:3.11-slim
|
||||
|
||||
WORKDIR /app
|
||||
COPY requirements.txt .
|
||||
RUN pip install --no-cache-dir -r requirements.txt
|
||||
COPY . .
|
||||
EXPOSE 8000
|
||||
CMD alembic upgrade head && uvicorn app.app:fastApi --host 0.0.0.0 --port 8000
|
||||
@@ -1,6 +0,0 @@
|
||||
import app.celery_app # noqa: F401
|
||||
from app.workers.celery_tasks import send_email
|
||||
|
||||
|
||||
def enqueue_email(to: str, subject: str, body: str) -> None:
|
||||
send_email.delay(to, subject, body)
|
||||
@@ -1,147 +0,0 @@
|
||||
import logging
|
||||
import asyncio
|
||||
import os
|
||||
import smtplib
|
||||
from email.message import EmailMessage
|
||||
|
||||
from celery import shared_task
|
||||
|
||||
import app.services.bank_scraper
|
||||
|
||||
logger = logging.getLogger("celery_tasks")
|
||||
if not logger.handlers:
|
||||
_h = logging.StreamHandler()
|
||||
logger.addHandler(_h)
|
||||
logger.setLevel(logging.INFO)
|
||||
|
||||
|
||||
def run_coro(coro) -> None:
|
||||
"""Run an async coroutine in a fresh event loop without using run_until_complete.
|
||||
Primary strategy runs in a new loop in the current thread. If that fails due to
|
||||
debugger patches (e.g., Bad file descriptor from pydevd_nest_asyncio), fall back
|
||||
to running in a dedicated thread with its own event loop.
|
||||
"""
|
||||
import threading
|
||||
|
||||
def _cleanup_loop(loop):
|
||||
try:
|
||||
pending = [t for t in asyncio.all_tasks(loop) if not t.done()]
|
||||
for t in pending:
|
||||
t.cancel()
|
||||
if pending:
|
||||
loop.run_until_complete(asyncio.gather(*pending, return_exceptions=True))
|
||||
except Exception:
|
||||
pass
|
||||
finally:
|
||||
try:
|
||||
loop.close()
|
||||
finally:
|
||||
asyncio.set_event_loop(None)
|
||||
|
||||
# First attempt: Run in current thread with a fresh event loop
|
||||
try:
|
||||
loop = asyncio.get_event_loop_policy().new_event_loop()
|
||||
try:
|
||||
asyncio.set_event_loop(loop)
|
||||
task = loop.create_task(coro)
|
||||
task.add_done_callback(lambda _t: loop.stop())
|
||||
loop.run_forever()
|
||||
exc = task.exception()
|
||||
if exc:
|
||||
raise exc
|
||||
return
|
||||
finally:
|
||||
_cleanup_loop(loop)
|
||||
except OSError as e:
|
||||
logger.warning("run_coro primary strategy failed (%s). Falling back to thread runner.", e)
|
||||
except Exception:
|
||||
# For any other unexpected errors, try thread fallback as well
|
||||
logger.exception("run_coro primary strategy raised; attempting thread fallback")
|
||||
|
||||
# Fallback: Run in a dedicated thread with its own event loop
|
||||
error = {"exc": None}
|
||||
|
||||
def _thread_target():
|
||||
loop = asyncio.new_event_loop()
|
||||
try:
|
||||
asyncio.set_event_loop(loop)
|
||||
task = loop.create_task(coro)
|
||||
task.add_done_callback(lambda _t: loop.stop())
|
||||
loop.run_forever()
|
||||
exc = task.exception()
|
||||
if exc:
|
||||
error["exc"] = exc
|
||||
finally:
|
||||
_cleanup_loop(loop)
|
||||
|
||||
th = threading.Thread(target=_thread_target, name="celery-async-runner", daemon=True)
|
||||
th.start()
|
||||
th.join()
|
||||
if error["exc"] is not None:
|
||||
raise error["exc"]
|
||||
|
||||
|
||||
@shared_task(name="workers.send_email")
|
||||
def send_email(to: str, subject: str, body: str) -> None:
|
||||
if not (to and subject and body):
|
||||
logger.error("Email task missing fields. to=%r subject=%r body_len=%r", to, subject, len(body) if body else 0)
|
||||
return
|
||||
|
||||
host = os.getenv("SMTP_HOST")
|
||||
if not host:
|
||||
logger.error("SMTP_HOST is not configured; cannot send email")
|
||||
return
|
||||
|
||||
# Configuration
|
||||
port = int(os.getenv("SMTP_PORT", "25"))
|
||||
username = os.getenv("SMTP_USERNAME")
|
||||
password = os.getenv("SMTP_PASSWORD")
|
||||
use_tls = os.getenv("SMTP_USE_TLS", "0").lower() in {"1", "true", "yes"}
|
||||
use_ssl = os.getenv("SMTP_USE_SSL", "0").lower() in {"1", "true", "yes"}
|
||||
timeout = int(os.getenv("SMTP_TIMEOUT", "10"))
|
||||
mail_from = os.getenv("SMTP_FROM") or username or "noreply@localhost"
|
||||
|
||||
# Build message
|
||||
msg = EmailMessage()
|
||||
msg["To"] = to
|
||||
msg["From"] = mail_from
|
||||
msg["Subject"] = subject
|
||||
msg.set_content(body)
|
||||
|
||||
try:
|
||||
if use_ssl:
|
||||
with smtplib.SMTP_SSL(host=host, port=port, timeout=timeout) as smtp:
|
||||
if username and password:
|
||||
smtp.login(username, password)
|
||||
smtp.send_message(msg)
|
||||
else:
|
||||
with smtplib.SMTP(host=host, port=port, timeout=timeout) as smtp:
|
||||
# STARTTLS if requested
|
||||
if use_tls:
|
||||
smtp.starttls()
|
||||
if username and password:
|
||||
smtp.login(username, password)
|
||||
smtp.send_message(msg)
|
||||
logger.info("[Celery] Email sent | to=%s | subject=%s | body_len=%d", to, subject, len(body))
|
||||
except Exception:
|
||||
logger.exception("Failed to send email via SMTP to=%s subject=%s host=%s port=%s tls=%s ssl=%s", to, subject,
|
||||
host, port, use_tls, use_ssl)
|
||||
|
||||
|
||||
@shared_task(name="workers.load_transactions")
|
||||
def load_transactions(user_id: str) -> None:
|
||||
if not user_id:
|
||||
logger.error("Load transactions task missing user_id.")
|
||||
return
|
||||
|
||||
run_coro(app.services.bank_scraper.aload_ceska_sporitelna_transactions(user_id))
|
||||
|
||||
# Placeholder for real transaction loading logic
|
||||
logger.info("[Celery] Transactions loaded for user_id=%s", user_id)
|
||||
|
||||
|
||||
@shared_task(name="workers.load_all_transactions")
|
||||
def load_all_transactions() -> None:
|
||||
logger.info("[Celery] Starting load_all_transactions")
|
||||
run_coro(app.services.bank_scraper.aload_all_ceska_sporitelna_transactions())
|
||||
logger.info("[Celery] Finished load_all_transactions")
|
||||
@@ -1,4 +0,0 @@
|
||||
import uvicorn
|
||||
|
||||
if __name__ == "__main__":
|
||||
uvicorn.run("app.app:app", host="0.0.0.0", log_level="info")
|
||||
@@ -7,64 +7,65 @@ Focus on areas that align with your project goals and interests.
|
||||
The core deliverables are required.
|
||||
This means that you must get at least 2 points for each item in this category.
|
||||
|
||||
| **Category** | **Item** | **Max Points** | **Points** |
|
||||
|----------------------------------| --------------------------------------- | -------------- |-------------------------------------------------|
|
||||
| **Core Deliverables (Required)** | | | |
|
||||
| Codebase & Organization | Well-organized project structure | 5 | 5 |
|
||||
| | Clean, readable code | 5 | 4 |
|
||||
| | Use planning tool (e.g., GitHub issues) | 5 | 4 |
|
||||
| | Proper version control usage | 5 | 5 |
|
||||
| 23 | Complete source code | 5 | 5 |
|
||||
| Documentation | Comprehensive reproducibility report | 10 | 4-5 |
|
||||
| | Updated design document | 5 | 2 |
|
||||
| | Clear build/deployment instructions | 5 | 2 |
|
||||
| | Troubleshooting guide | 5 | 1 |
|
||||
| | Completed self-assessment table | 5 | 2 |
|
||||
| 14 | Hour sheets for all members | 5 | 3 |
|
||||
| Presentation Video | Project demonstration | 5 | 0 |
|
||||
| | Code walk-through | 5 | 0 |
|
||||
| 0 | Deployment showcase | 5 | 0 |
|
||||
| **Technical Implementation** | | | |
|
||||
| Application Functionality | Basic functionality works | 10 | 8 |
|
||||
| | Advanced features implemented | 10 | 0 |
|
||||
| | Error handling & robustness | 10 | 4 |
|
||||
| 16 | User-friendly interface | 5 | 4 |
|
||||
| Backend & Architecture | Stateless web server | 5 | 5 |
|
||||
| | Stateful application | 10 | ? WHAT DOES THIS MEAN |
|
||||
| | Database integration | 10 | 10 |
|
||||
| | API design | 5 | 5 |
|
||||
| 20 | Microservices architecture | 10 | 0 |
|
||||
| Cloud Integration | Basic cloud deployment | 10 | 10 |
|
||||
| | Cloud APIs usage | 10 | ? WHAT DOES THIS MEAN |
|
||||
| | Serverless components | 10 | 0 |
|
||||
| 10 | Advanced cloud services | 5 | 0 |
|
||||
| **DevOps & Deployment** | | | |
|
||||
| Containerization | Basic Dockerfile | 5 | 5 |
|
||||
| | Optimized Dockerfile | 5 | 0 |
|
||||
| | Docker Compose | 5 | 5 - dev only |
|
||||
| 15 | Persistent storage | 5 | 5 |
|
||||
| Deployment & Scaling | Manual deployment | 5 | 5 |
|
||||
| | Automated deployment | 5 | 5 |
|
||||
| | Multiple replicas | 5 | 5 |
|
||||
| 20 | Kubernetes deployment | 10 | 10 |
|
||||
| **Quality Assurance** | | | |
|
||||
| Testing | Unit tests | 5 | 2 |
|
||||
| | Integration tests | 5 | 2 |
|
||||
| | End-to-end tests | 5 | 5 |
|
||||
| 9 | Performance testing | 5 | 0 |
|
||||
| Monitoring & Operations | Health checks | 5 | 5 |
|
||||
| | Logging | 5 | 2 - only to terminal add logstash |
|
||||
| 9 | Metrics/Monitoring | 5 | 2 - only DB, need to create Prometheus endpoint |
|
||||
| Security | HTTPS/TLS | 5 | 5 |
|
||||
| | Authentication | 5 | 5 |
|
||||
| 15 | Authorization | 5 | 5 |
|
||||
| **Innovation & Excellence** | | | |
|
||||
| Advanced Features and | AI/ML Integration | 10 | 0 |
|
||||
| Technical Excellence | Real-time features | 10 | 0 |
|
||||
| | Creative problem solving | 10 | ? |
|
||||
| | Performance optimization | 5 | 2 |
|
||||
| 2 | Exceptional user experience | 5 | 0 |
|
||||
| **Total** | | **255** | **153** |
|
||||
| **Category** | **Item** | **Max Points** | **Points** | **Comment** |
|
||||
|:---------------------------------|:----------------------------------------|:---------------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **Core Deliverables (Required)** | | | | |
|
||||
| Codebase & Organization | Well-organized project structure | 5 | 5 | Project is well-organized, each part is separated (backend, frontend, IaC) and these parts are separated even mode (modules, packages...) |
|
||||
| | Clean, readable code | 5 | 4 | Should be readable(function names should help), but readability can always be improved |
|
||||
| | Use planning tool (e.g., GitHub issues) | 5 | 4 | We used Github issues |
|
||||
| | Proper version control usage | 5 | 5 | We used branches for development, pull request reviews |
|
||||
| 23 | Complete source code | 5 | 5 | The code is complete - entire codebase is in this repository |
|
||||
| Documentation | Comprehensive reproducibility report | 10 | 10 | Our report is precise, anybody should be able to reproduce our deployment by following provided instructions |
|
||||
| | Updated design document | 5 | 4 | Our design document was updated and merged into the report |
|
||||
| | Clear build/deployment instructions | 5 | 5 | Should be clear |
|
||||
| | Troubleshooting guide | 5 | 3 | When it comes to troubleshooting, there is never enough documentation |
|
||||
| | Completed self-assessment table | 5 | 5 | Completed. |
|
||||
| 32 | Hour sheets for all members | 5 | 5 | Filled. |
|
||||
| Presentation Video | Project demonstration | 5 | 5 | Yes |
|
||||
| | Code walk-through | 5 | 3 | There was not enough time to go through all of our code, so we just mentioned some parts of it. |
|
||||
| 13 | Deployment showcase | 5 | 5 | Yes |
|
||||
| **Technical Implementation** | | | | |
|
||||
| Application Functionality | Basic functionality works | 10 | 10 | The app works as intended |
|
||||
| | Advanced features implemented | 10 | 5 | OAuth, BankAPI connection (not only mock bank) |
|
||||
| | Error handling & robustness | 10 | 5 | App notifies user about errors, errors in code are also logged by sentry and we get notified |
|
||||
| 24 | User-friendly interface | 5 | 4 | Responsive interface with dark mode support, should by user friendly enough |
|
||||
| Backend & Architecture | Stateless web server | 5 | 5 | Yes, the web server is stateless - authentication uses JWT, not sessions. |
|
||||
| | Stateful application | 10 | 10 | Yes, the app is stateful - data are persistently stored in database |
|
||||
| | Database integration | 10 | 10 | We have deployed 3 MariaDB nodes with replication, MaxScale proxy and periodic backups. Connection app with this setup is same as with standalone db. |
|
||||
| | API design | 5 | 5 | Backend APIs are implemented with public Swagger docs |
|
||||
| 33 | Microservices architecture | 10 | 3 | We have separated API deployment and worker deployment. Worker process slow tasks - emails, payment scraping. There is no need for another service in current state but adding it is easy. |
|
||||
| Cloud Integration | Basic cloud deployment | 10 | 10 | Yes (In private cluster), using GH Actions and self-hosted runner. |
|
||||
| | Cloud APIs usage | 10 | 8 | GH Actions deploys frontend to Cloudflare Pages, deployment creates CF tunnel record automatically |
|
||||
| | Serverless components | 10 | 10 | We are using CF pages for frontend deployment |
|
||||
| 33 | Advanced cloud services | 5 | 5 | Using CF provides us with DDOS protection, access rules, it hides our IP |
|
||||
| **DevOps & Deployment** | | | | |
|
||||
| Containerization | Basic Dockerfile | 5 | 5 | Yes |
|
||||
| | Optimized Dockerfile | 5 | 5 | Rootless Dockerfile |
|
||||
| | Docker Compose | 5 | 5 | For development environment |
|
||||
| 20 | Persistent storage | 5 | 5 | Yes, using Longhorn. |
|
||||
| Deployment & Scaling | Manual deployment | 5 | 5 | Yes, possible by using Helm manually |
|
||||
| | Automated deployment | 5 | 5 | Yes, with Github actions |
|
||||
| | Multiple replicas | 5 | 5 | Yes, 3 pods with API, 3 pods with workers, 3 database pods |
|
||||
| 25 | Kubernetes deployment | 10 | 10 | Yes |
|
||||
| **Quality Assurance** | | | | |
|
||||
| Testing | Unit tests | 5 | 4 | All workflows are covered by tests |
|
||||
| | Integration tests | 5 | 5 | Yes |
|
||||
| | End-to-end tests | 5 | 5 | Yes |
|
||||
| 14 | Performance testing | 5 | 0 | No |
|
||||
| Monitoring & Operations | Health checks | 5 | 5 | Yes |
|
||||
| | Logging | 5 | 4 | Logs can be accessed easily using Grafana |
|
||||
| | Metrics/Monitoring | 2 | 2 | Yes, visualised in Grafana |
|
||||
| 14 | Custom Metrics for your project | 3 | 3 | Yes, API has /metrics endpoint providing information about FastAPI itself and custom information such as number of users or transactions. |
|
||||
| Security | HTTPS/TLS | 5 | 5 | Yes |
|
||||
| | Authentication | 5 | 5 | Yes |
|
||||
| 15 | Authorization | 5 | 5 | Yes |
|
||||
| **Innovation & Excellence** | | | | |
|
||||
| Advanced Features and | AI/ML Integration | 10 | 0 | No |
|
||||
| Technical Excellence | Real-time features | 10 | 0 | No |
|
||||
| | Creative problem solving | 10 | 4 | Cron jobs for bank scraping |
|
||||
| | Performance optimization | 5 | 4 | Delegating emails and scraping to workers, hosting frontend on CF |
|
||||
| 11 | Exceptional user experience | 5 | 3 | |
|
||||
| **Total** | | **255** | **257** | |
|
||||
|
||||
## Grading Scale
|
||||
|
||||
@@ -72,7 +73,7 @@ This means that you must get at least 2 points for each item in this category.
|
||||
- **Maximum: 200+ points**
|
||||
|
||||
| Grade | Points |
|
||||
| ----- | -------- |
|
||||
|-------|----------|
|
||||
| A | 180-200+ |
|
||||
| B | 160-179 |
|
||||
| C | 140-159 |
|
||||
|
||||
@@ -1,73 +0,0 @@
|
||||
# React + TypeScript + Vite
|
||||
|
||||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
|
||||
|
||||
Currently, two official plugins are available:
|
||||
|
||||
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
|
||||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
|
||||
|
||||
## React Compiler
|
||||
|
||||
The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
|
||||
|
||||
## Expanding the ESLint configuration
|
||||
|
||||
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
|
||||
|
||||
```js
|
||||
export default defineConfig([
|
||||
globalIgnores(['dist']),
|
||||
{
|
||||
files: ['**/*.{ts,tsx}'],
|
||||
extends: [
|
||||
// Other configs...
|
||||
|
||||
// Remove tseslint.configs.recommended and replace with this
|
||||
tseslint.configs.recommendedTypeChecked,
|
||||
// Alternatively, use this for stricter rules
|
||||
tseslint.configs.strictTypeChecked,
|
||||
// Optionally, add this for stylistic rules
|
||||
tseslint.configs.stylisticTypeChecked,
|
||||
|
||||
// Other configs...
|
||||
],
|
||||
languageOptions: {
|
||||
parserOptions: {
|
||||
project: ['./tsconfig.node.json', './tsconfig.app.json'],
|
||||
tsconfigRootDir: import.meta.dirname,
|
||||
},
|
||||
// other options...
|
||||
},
|
||||
},
|
||||
])
|
||||
```
|
||||
|
||||
You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
|
||||
|
||||
```js
|
||||
// eslint.config.js
|
||||
import reactX from 'eslint-plugin-react-x'
|
||||
import reactDom from 'eslint-plugin-react-dom'
|
||||
|
||||
export default defineConfig([
|
||||
globalIgnores(['dist']),
|
||||
{
|
||||
files: ['**/*.{ts,tsx}'],
|
||||
extends: [
|
||||
// Other configs...
|
||||
// Enable lint rules for React
|
||||
reactX.configs['recommended-typescript'],
|
||||
// Enable lint rules for React DOM
|
||||
reactDom.configs.recommended,
|
||||
],
|
||||
languageOptions: {
|
||||
parserOptions: {
|
||||
project: ['./tsconfig.node.json', './tsconfig.app.json'],
|
||||
tsconfigRootDir: import.meta.dirname,
|
||||
},
|
||||
// other options...
|
||||
},
|
||||
},
|
||||
])
|
||||
```
|
||||
@@ -1,5 +0,0 @@
|
||||
export const BACKEND_URL: string =
|
||||
import.meta.env.VITE_BACKEND_URL ?? '';
|
||||
|
||||
export const VITE_UNIRATE_API_KEY: string =
|
||||
import.meta.env.VITE_UNIRATE_API_KEY ?? 'wYXMiA0bz8AVRHtiS9hbKIr4VP3k5Qff8XnQdKQM45YM3IwFWP6y73r3KMkv1590';
|
||||
@@ -1,283 +1,535 @@
|
||||
# Personal finance tracker
|
||||
|
||||
> **Instructions**:
|
||||
<!--- **Instructions**:
|
||||
> This template provides the structure for your project report.
|
||||
> Replace the placeholder text with your actual content.
|
||||
> Remove instructions that are not relevant for your project, but leave the headings along with a (NA) label.
|
||||
> Remove instructions that are not relevant for your project, but leave the headings along with a (NA) label. -->
|
||||
|
||||
## Project Overview
|
||||
|
||||
**Project Name**: Personal Finance Tracker
|
||||
|
||||
**Deployment URL**: https://finance.ltrk.cz/
|
||||
|
||||
**Group Members**:
|
||||
|
||||
- 289229, Lukáš Trkan, lukastrkan
|
||||
- 289258, Dejan Ribarovski, derib2613, ribardej
|
||||
- 289258, Dejan Ribarovski, ribardej (derib2613)
|
||||
|
||||
**Brief Description**:
|
||||
Our application is a finance tracker, so a person can easily track his cash flow
|
||||
through multiple bank accounts. Person can label transactions with custom categories
|
||||
and later filter by them.
|
||||
Our application allows users to easily track their cash flow
|
||||
through multiple bank accounts. Users can label their transactions with custom categories that can be later used for
|
||||
filtering and visualization. New transactions are automatically fetched in the background.
|
||||
|
||||
## Architecture Overview
|
||||
Our system is a full‑stack web application composed of a React frontend, a FastAPI backend, a PostgreSQL database, and asynchronous background workers powered by Celery with RabbitMQ. Redis is available for caching/kv and may be used by Celery as a result backend. The backend exposes REST endpoints for authentication (email/password and OAuth), users, categories, and transactions. A thin controller layer (FastAPI routers) lives under app/api. Infrastructure for Kubernetes is provided via OpenTofu (Terraform‑compatible) modules and the application is packaged via a Helm chart.
|
||||
|
||||
Our system is a full‑stack web application composed of a React frontend, a FastAPI backend,
|
||||
a asynchronousMariaDB database with Maxscale, and background workers powered by Celery with RabbitMQ.
|
||||
The backend exposes REST endpoints for authentication (email/password and OAuth), users, categories,
|
||||
transactions, exchange rates and bank APIs. Infrastructure for Kubernetes is managed via Terraform/OpenTofu and
|
||||
the application is packaged via a Helm chart. This all is deployed on private TalosOS cluster running on Proxmox VE with
|
||||
CI/CD and with public access over Cloudflare tunnels. Static files for frontend are served via Cloudflare pages.
|
||||
Other services deployed in the cluster includes Longhorn for persistent storage, Prometheus with Grafana for monitoring.
|
||||
|
||||
### High-Level Architecture
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
proc_queue[Message Queue] --> proc_queue_worker[Worker Service]
|
||||
proc_queue_worker --> ext_mail[(Email Service)]
|
||||
proc_cron[Task planner] --> proc_queue
|
||||
proc_queue_worker --> ext_bank[(Bank API)]
|
||||
proc_queue_worker --> db
|
||||
client[Client/Frontend] <--> svc[Backend API]
|
||||
flowchart TB
|
||||
n3(("User")) <--> client["Frontend"]
|
||||
proc_queue["Message Queue"] --> proc_queue_worker["Worker Service"]
|
||||
proc_queue_worker -- SMTP --> ext_mail[("Email Service")]
|
||||
proc_queue_worker <-- HTTP request/response --> ext_bank[("Bank API")]
|
||||
proc_queue_worker <--> db[("Database")]
|
||||
proc_cron["Cron"] <-- HTTP request/response --> svc["Backend API"]
|
||||
svc --> proc_queue
|
||||
svc <--> db[(Database)]
|
||||
n2["Cloudflare tunnel"] <-- HTTP request/response --> svc
|
||||
svc <--> db
|
||||
svc <-- HTTP request/response --> api[("UniRate API")]
|
||||
client <-- HTTP request/response --> n2
|
||||
```
|
||||
|
||||
The workflow works in the following way:
|
||||
- Client connects to the frontend. After login, frontend automatically fetches the stored transactions from
|
||||
the database via the backend API
|
||||
- When the client opts for fetching new transactions via the Bank API, the backend delegates the task
|
||||
to a background worker service via the Message queue.
|
||||
|
||||
- Client connects to the frontend. After login, frontend automatically fetches the stored transactions from
|
||||
the database via the backend API and currency rates from UniRate API.
|
||||
- When the client opts for fetching new transactions via the Bank API, cron will trigger periodic fetching
|
||||
using background worker.
|
||||
- After successful load, these transactions are stored to the database and displayed to the client
|
||||
- There is also a Task planner, that executes periodic tasks, like fetching new transactions automatically from the Bank API
|
||||
|
||||
### Database Schema
|
||||
|
||||
```mermaid
|
||||
classDiagram
|
||||
direction BT
|
||||
class alembic_version {
|
||||
varchar(32) version_num
|
||||
}
|
||||
class categories {
|
||||
varchar(100) name
|
||||
varchar(255) description
|
||||
char(36) user_id
|
||||
int(11) id
|
||||
}
|
||||
class category_transaction {
|
||||
int(11) category_id
|
||||
int(11) transaction_id
|
||||
}
|
||||
class oauth_account {
|
||||
char(36) user_id
|
||||
varchar(100) oauth_name
|
||||
varchar(4096) access_token
|
||||
int(11) expires_at
|
||||
varchar(1024) refresh_token
|
||||
varchar(320) account_id
|
||||
varchar(320) account_email
|
||||
char(36) id
|
||||
}
|
||||
class transaction {
|
||||
blob amount
|
||||
blob description
|
||||
char(36) user_id
|
||||
date date
|
||||
int(11) id
|
||||
}
|
||||
class user {
|
||||
varchar(100) first_name
|
||||
varchar(100) last_name
|
||||
varchar(320) email
|
||||
varchar(1024) hashed_password
|
||||
tinyint(1) is_active
|
||||
tinyint(1) is_superuser
|
||||
tinyint(1) is_verified
|
||||
longtext config
|
||||
char(36) id
|
||||
}
|
||||
|
||||
categories --> user: user_id -> id
|
||||
category_transaction --> categories: category_id -> id
|
||||
category_transaction --> transaction: transaction_id -> id
|
||||
oauth_account --> user: user_id -> id
|
||||
transaction --> user: user_id -> id
|
||||
```
|
||||
|
||||
### Features
|
||||
|
||||
- The stored transactions are encrypted in the DB for security reasons.
|
||||
- For every pull request the full APP is deployed on a separate URL and the tests are run by github CI/CD
|
||||
- On every push to main, the production app is automatically updated
|
||||
- UI is responsive for mobile devices
|
||||
- Slow operations (emails, transactions fetching) are handled
|
||||
in the background by Celery workers.
|
||||
- App is monitored using prometheus metrics endpoint and metrics are shown in Grafana dashboard.
|
||||
|
||||
### Components
|
||||
|
||||
- Frontend (frontend/): React + TypeScript app built with Vite. Talks to the backend via REST, handles login/registration, shows latest transactions, filtering, and allows adding transactions.
|
||||
- Backend API (backend/app): FastAPI app with routers under app/api for auth, categories, and transactions. Uses FastAPI Users for auth (JWT + OAuth), SQLAlchemy ORM, and Pydantic v2 schemas.
|
||||
- Worker service (backend/app/workers): Celery worker handling asynchronous tasks (e.g., sending verification emails, future background processing).
|
||||
- Database (PostgreSQL): Persists users, categories, transactions; schema managed by Alembic migrations.
|
||||
- Message Queue (RabbitMQ): Transports background jobs from the API to the worker.
|
||||
- Cache/Result Store (Redis): Available for caching or Celery result backend.
|
||||
- Infrastructure as Code (tofu/): OpenTofu modules provisioning cluster services (RabbitMQ, Redis, Argo CD, cert-manager, Cloudflare tunnel, etc.).
|
||||
- Frontend (frontend/): React + TypeScript app built with Vite. Talks to the backend via REST, handles
|
||||
login/registration, shows latest transactions, filtering, and allows adding transactions.
|
||||
- Backend API (backend/app): FastAPI app with routers under app/api for auth, users, categories, transactions, exchange
|
||||
rates and bankAPI. Uses FastAPI Users for auth (JWT + OAuth), SQLAlchemy ORM, and Pydantic v2 schemas.
|
||||
- Worker service (backend/app/workers): Celery worker handling background tasks (emails, transactions fetching).
|
||||
- Database (MariaDB with Maxscale): Persists users, categories, transactions; schema managed by Alembic migrations.
|
||||
- Message Queue (RabbitMQ): Queues background tasks for Celery workers.
|
||||
- Infrastructure as Code (tofu/): OpenTofu modules provisioning cluster services (RabbitMQ, Redis, Cloudflare tunnel,
|
||||
etc.).
|
||||
- Deployment Chart (charts/myapp-chart/): Helm chart to deploy the application to Kubernetes.
|
||||
|
||||
### Other services deployed in the cluster
|
||||
|
||||
- Longhorn: distributed storage system providing persistent volumes for the database and other services
|
||||
- Prometheus + Grafana: monitoring stack collecting metrics from the app and cluster, visualized in Grafana dashboards
|
||||
- MariaDB operator: manages the MariaDB cluster based on Custom resources, creates Databases, users, handles backups
|
||||
- RabbitMQ operator: manages RabbitMQ cluster based on Custom resources
|
||||
- Cloudflare Tunnel: allows public access to backend API running in the private cluster, providing HTTPS
|
||||
|
||||
### Technologies Used
|
||||
|
||||
- Backend: Python, FastAPI, FastAPI Users, SQLAlchemy, Pydantic, Alembic, Celery
|
||||
- Frontend: React, TypeScript, Vite
|
||||
- Database: MariaDB (Maxscale)
|
||||
- Database: MariaDB with Maxscale
|
||||
- Background jobs: RabbitMQ, Celery
|
||||
- Containerization/Orchestration: Docker, Docker Compose (dev), Kubernetes, Helm
|
||||
- IaC/Platform: Proxmox, Talos, Cloudflare pages, OpenTofu (Terraform), cert-manager, MetalLB, Cloudflare Tunnel, Prometheus, Loki
|
||||
- IaC/Platform: Proxmox, Talos, Cloudflare pages, OpenTofu (Terraform), cert-manager, MetalLB, Cloudflare Tunnel,
|
||||
Prometheus, Loki
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Here are software and hardware prerequisites for the development and production environments. This section also
|
||||
describes
|
||||
necessary environment variables and key dependencies used in the project.
|
||||
|
||||
### System Requirements
|
||||
|
||||
- Operating System (dev): Linux, macOS, or Windows with Docker support
|
||||
- Operating System (prod): Linux with kubernetes
|
||||
- Minimum RAM: 4 GB (8 GB recommended for running backend, frontend, and database together)
|
||||
- Storage: 4 GB free (Docker images may require additional space)
|
||||
#### Development
|
||||
|
||||
- OS: Tested on MacOS, Linux and Windows should work as well
|
||||
- Minimum RAM: 8 GB
|
||||
- Storage: 10 GB+ free
|
||||
|
||||
#### Production
|
||||
|
||||
- 1 + 4 nodes
|
||||
- CPU: 4 cores
|
||||
- RAM: 8 GB
|
||||
- Storage: 200 GB
|
||||
|
||||
### Required Software
|
||||
|
||||
- Docker Desktop or Docker Engine
|
||||
- Docker Compose
|
||||
#### Development
|
||||
|
||||
- Docker
|
||||
- Docker Compose
|
||||
- Node.js and npm
|
||||
- Python 3.12+
|
||||
- Python 3.12
|
||||
- MariaDB 11
|
||||
- Helm 3.12+ and kubectl 1.29+
|
||||
|
||||
#### Production
|
||||
|
||||
##### Minimal:
|
||||
|
||||
- domain name with Cloudflare`s nameservers - tunnel, pages
|
||||
- Kubernetes cluster
|
||||
- kubectl
|
||||
- Helm
|
||||
- OpenTofu
|
||||
|
||||
### Environment Variables (common)
|
||||
##### Our setup specifics:
|
||||
|
||||
# TODO: UPDATE
|
||||
- Backend: SECRET, FRONTEND_URL, BACKEND_URL, DATABASE_URL, RABBITMQ_URL, REDIS_URL
|
||||
- Proxmox VE
|
||||
- TalosOS cluster
|
||||
- talosctl
|
||||
- GitHub self-hosted runner with access to the cluster
|
||||
- TailScale for remote access to cluster
|
||||
|
||||
- OAuth vars (Backend): MOJEID_CLIENT_ID/SECRET, BANKID_CLIENT_ID/SECRET (optional)
|
||||
- Frontend: VITE_BACKEND_URL
|
||||
### Environment Variables
|
||||
|
||||
#### Backend
|
||||
|
||||
- `MOJEID_CLIENT_ID`, `MOJEID_CLIENT_SECRET` \- OAuth client ID and secret for
|
||||
[MojeID](https://www.mojeid.cz/en/provider/)
|
||||
- `BANKID_CLIENT_ID`, `BANKID_CLIENT_SECRET` \- OAuth client ID and secret for [BankID](https://developer.bankid.cz/)
|
||||
- `CSAS_CLIENT_ID`, `CSAS_CLIENT_SECRET` \- OAuth client ID and secret for [Česká
|
||||
spořitelna](https://developers.erstegroup.com/docs/apis/bank.csas)
|
||||
- `DATABASE_URL`(or `MARIADB_HOST`, `MARIADB_PORT`, `MARIADB_DB`, `MARIADB_USER`, `MARIADB_PASSWORD`) \- MariaDB
|
||||
connection details
|
||||
- `RABBITMQ_USERNAME`, `RABBITMQ_PASSWORD` \- credentials for RabbitMQ
|
||||
- `SENTRY_DSN` \- Sentry DSN for error reporting
|
||||
- `DB_ENCRYPTION_KEY` \- symmetric key for encrypting sensitive data in the database
|
||||
- `SMTP_HOST`, `SMTP_PORT`, `SMTP_USERNAME`, `SMTP_PASSWORD`, `SMTP_USE_TLS`, `SMTP_USE_SSL`, `SMTP_FROM` \- SMTP
|
||||
configuration (host, port, auth credentials, TLS/SSL options, sender).
|
||||
- `UNIRATE_API_KEY` \- API key for UniRate.
|
||||
|
||||
#### Frontend
|
||||
|
||||
- `VITE_BACKEND_URL` \- URL of the backend API
|
||||
|
||||
### Dependencies (key libraries)
|
||||
Backend: FastAPI, fastapi-users, SQLAlchemy, pydantic v2, Alembic, Celery, uvicorn
|
||||
|
||||
Backend: FastAPI, fastapi-users, SQLAlchemy, pydantic v2, Alembic, Celery, uvicorn, pytest
|
||||
Frontend: React, TypeScript, Vite
|
||||
|
||||
## Local development
|
||||
|
||||
You can run the project with Docker Compose and Python virtual environment for testing and dev purposes
|
||||
You can run the project with Docker Compose and Python virtual environment for testing and development purposes
|
||||
|
||||
### 1) Clone the Repository
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dat515-2025/Group-8.git
|
||||
cd 7project
|
||||
cd Group-8/7project/src
|
||||
```
|
||||
|
||||
### 2) Install dependencies
|
||||
|
||||
Backend
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
Frontend
|
||||
|
||||
### 3) Run Docker containers
|
||||
|
||||
```bash
|
||||
# In 7project/frontend
|
||||
npm install
|
||||
cd ..
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### 3) Manual Local Run
|
||||
### 4) Prepare the database
|
||||
|
||||
Backend
|
||||
```bash
|
||||
# From the 7project/ directory
|
||||
docker compose up --build
|
||||
# This starts: MariaDB, RabbitMQ
|
||||
|
||||
# Set environment variables (or create .env file)
|
||||
# TODO: fix
|
||||
export SECRET=CHANGE_ME_SECRET
|
||||
export FRONTEND_DOMAIN_SCHEME=http://localhost:5173
|
||||
export BANKID_CLIENT_ID=CHANGE_ME
|
||||
export BANKID_CLIENT_SECRET=CHANGE_ME
|
||||
export CSAS_CLIENT_ID=CHANGE_ME
|
||||
export CSAS_CLIENT_SECRET=CHANGE_ME
|
||||
export MOJEID_CLIENT_ID=CHANGE_ME
|
||||
export MOJEID_CLIENT_SECRET=CHANGE_ME
|
||||
# Apply DB migrations (Alembic)
|
||||
# From 7project
|
||||
bash upgrade_database.sh
|
||||
```
|
||||
|
||||
# Run API
|
||||
### 5) Run backend
|
||||
|
||||
Before running the backend, make sure to set the necessary environment variables. Either by setting them in your shell
|
||||
or by setting them in run configuration in your IDE.
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
uvicorn app.app:fastApi --reload --host 0.0.0.0 --port 8000
|
||||
```
|
||||
|
||||
### 6) Run Celery worker (optional, in another terminal)
|
||||
|
||||
```bash
|
||||
cd Group-8/7project/src/backend
|
||||
source .venv/bin/activate
|
||||
celery -A app.celery_app.celery_app worker -l info
|
||||
```
|
||||
|
||||
Frontend
|
||||
### 7) Install frontend dependencies and run
|
||||
|
||||
```bash
|
||||
# Configure backend URL for dev
|
||||
echo 'VITE_BACKEND_URL=http://127.0.0.1:8000' > .env
|
||||
cd ../frontend
|
||||
npm i
|
||||
npm run dev
|
||||
# Open http://localhost:5173
|
||||
```
|
||||
|
||||
- Backend default: http://127.0.0.1:8000 (OpenAPI at /docs)
|
||||
- Frontend default: http://localhost:5173
|
||||
- Backend available at: http://127.0.0.1:8000 (OpenAPI at /docs)
|
||||
- Frontend available at: http://localhost:5173
|
||||
|
||||
## Build Instructions
|
||||
|
||||
### Backend
|
||||
|
||||
App is separated into backend and frontend so it also needs to be built separately. Backend is build into docker image
|
||||
and frontend is deployed as static files.
|
||||
|
||||
```bash
|
||||
# run in project7/backend
|
||||
docker buildx build --platform linux/amd64,linux/arm64 -t your_container_registry/your_name --push .
|
||||
cd 7project/src/backend
|
||||
# Dont forget to set correct image tag with your registry and name
|
||||
# For example lukastrkan/cc-app-demo or gitea.ltrk.dev/lukas/cc-app-demo
|
||||
docker buildx build --platform linux/amd64,linux/arm64 -t CHANGE_ME --push .
|
||||
```
|
||||
|
||||
### Frontend
|
||||
|
||||
```bash
|
||||
# run in project7/frontend
|
||||
cd project7/src/frontend
|
||||
npm ci
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Deployment Instructions
|
||||
### Setup Cluster
|
||||
Deployment should work on any Kubernetes cluster. However, we are using 4 TalosOS virtual machines (1 control plane, 3 workers)
|
||||
running on top of Proxmox VE.
|
||||
|
||||
1) Create 4 VMs with TalosOS
|
||||
Deployment is tested on TalosOS cluster with 1 control plane and 4 workers, cluster needs to be setup and configured
|
||||
manually. Terraform/OpenTofu is then used to deploy base services to the cluster. App itself is deployed automatically
|
||||
via GitHub actions and Helm chart. Frontend files are deployed to Cloudflare pages.
|
||||
|
||||
### Setup Cluster
|
||||
|
||||
Deployment should work on any Kubernetes cluster. However, we are using 5 TalosOS virtual machines (1 control plane, 4
|
||||
workers)
|
||||
running on top of Proxmox VE.
|
||||
|
||||
1) Create at least 4 VMs with TalosOS (4 cores, 8 GB RAM, 200 GB disk)
|
||||
2) Install talosctl for your OS: https://docs.siderolabs.com/talos/v1.10/getting-started/talosctl
|
||||
3) Generate Talos config
|
||||
```bash
|
||||
# TODO: add commands
|
||||
```
|
||||
4) Edit the generated worker.yaml
|
||||
- add google container registry mirror
|
||||
- add modules from config generator
|
||||
- add extramounts for persistent storage
|
||||
- add kernel modules
|
||||
4) Navigate to tofu directory
|
||||
|
||||
5) Apply the config to the VMs
|
||||
```bash
|
||||
#TODO: add config apply commands
|
||||
cd 7project/src/tofu
|
||||
````
|
||||
|
||||
5) Set IP addresses in environment variables
|
||||
|
||||
```bash
|
||||
CONTROL_PLANE_IP=<control-plane-ip>
|
||||
WORKER1_IP=<worker1-ip>
|
||||
WORKER2_IP=<worker2-ip>
|
||||
WORKER3_IP=<worker3-ip>
|
||||
WORKER4_IP=<worker4-ip>
|
||||
....
|
||||
```
|
||||
|
||||
6) Verify the cluster is up
|
||||
6) Create config files
|
||||
|
||||
```bash
|
||||
# change my-cluster to your desired cluster name
|
||||
talosctl gen config my-cluster https://$CONTROL_PLANE_IP:6443
|
||||
```
|
||||
|
||||
7) Export kubeconfig
|
||||
```bash
|
||||
# TODO: add export command
|
||||
7) Edit the generated configs
|
||||
|
||||
Apply the following changes to `worker.yaml`:
|
||||
|
||||
1) Add mounts for persistent storage to `machine.kubelet.extraMounts` section:
|
||||
|
||||
```yaml
|
||||
extraMounts:
|
||||
- destination: /var/lib/longhorn
|
||||
type: bindind.
|
||||
source: /var/lib/longhorn
|
||||
options:
|
||||
- bind
|
||||
- rshared
|
||||
- rw
|
||||
```
|
||||
|
||||
2) Change `machine.install.image` to image with extra modules:
|
||||
|
||||
```yaml
|
||||
image: factory.talos.dev/metal-installer/88d1f7a5c4f1d3aba7df787c448c1d3d008ed29cfb34af53fa0df4336a56040b:v1.11.1
|
||||
```
|
||||
|
||||
or you can use latest image generated at https://factory.talos.dev with following options:
|
||||
|
||||
- Bare-metal machine
|
||||
- your Talos os version
|
||||
- amd64 architecture
|
||||
- siderolabs/iscsi-tools
|
||||
- siderolabs/util-linux-tools
|
||||
- (Optionally) siderolabs/qemu-guest-agent
|
||||
|
||||
Then copy "Initial Installation" value and paste it to the image field.
|
||||
|
||||
3) Add docker registry mirror to `machine.registries.mirrors` section:
|
||||
|
||||
```yaml
|
||||
registries:
|
||||
mirrors:
|
||||
docker.io:
|
||||
endpoints:
|
||||
- https://mirror.gcr.io
|
||||
- https://registry-1.docker.io
|
||||
```
|
||||
|
||||
8) Apply configs to the VMs
|
||||
|
||||
```bash
|
||||
talosctl apply-config --insecure --nodes $CONTROL_PLANE_IP --file controlplane.yaml
|
||||
talosctl apply-config --insecure --nodes $WORKER1_IP --file worker.yaml
|
||||
talosctl apply-config --insecure --nodes $WORKER2_IP --file worker.yaml
|
||||
talosctl apply-config --insecure --nodes $WORKER3_IP --file worker.yaml
|
||||
talosctl apply-config --insecure --nodes $WORKER4_IP --file worker.yaml
|
||||
```
|
||||
|
||||
9) Boostrap the cluster and retrieve kubeconfig
|
||||
|
||||
```bash
|
||||
export TALOSCONFIG=$(pwd)/talosconfig
|
||||
talosctl config endpoint https://$CONTROL_PLANE_IP:6443
|
||||
talosctl config node $CONTROL_PLANE_IP
|
||||
|
||||
talosctl bootstrap
|
||||
|
||||
talosctl kubeconfig .
|
||||
```
|
||||
|
||||
You can now use k8s client like https://headlamp.dev/ with the generated kubeconfig file.
|
||||
|
||||
### Install base services to the cluster
|
||||
|
||||
1) Copy and edit variables
|
||||
|
||||
### Install
|
||||
1) Install base services to cluster
|
||||
```bash
|
||||
cd tofu
|
||||
# copy and edit variables
|
||||
cp terraform.tfvars.example terraform.tfvars
|
||||
# authenticate to your cluster/cloud as needed, then:
|
||||
```
|
||||
|
||||
- `metallb_ip_range` - set to range available in your network for load balancer services
|
||||
- `mariadb_password` - password for internal mariadb user
|
||||
- `mariadb_root_password` - password for root user
|
||||
- `mariadb_user_name` - username for admin user
|
||||
- `mariadb_user_host` - allowed hosts for admin user
|
||||
- `mariadb_user_password` - password for admin user
|
||||
- `metallb_maxscale_ip`, `metallb_service_ip`, `metallb_primary_ip`, `metallb_secondary_ip` - IPs for database
|
||||
cluster,
|
||||
set them to static IPs from the `metallb_ip_range`
|
||||
- `s3_enabled`, `s3_bucket`, `s3_region`, `s3_endpoint`, `s3_key_id`, `s3_key_secret` - S3 compatible storage for
|
||||
backups (optional)
|
||||
- `phpmyadmin_enabled` - set to false if you want to disable phpmyadmin
|
||||
- `rabbitmq-password` - password for RabbitMQ
|
||||
|
||||
- `cloudflare_account_id` - your Cloudflare account ID
|
||||
- `cloudflare_api_token` - your Cloudflare API token with permissions to manage tunnels and DNS
|
||||
- `cloudflare_email` - your Cloudflare account email
|
||||
- `cloudflare_tunnel_name` - name for the tunnel
|
||||
- `cloudflare_domain` - your domain name managed in Cloudflare
|
||||
|
||||
2) Deploy without Cloudflare module first
|
||||
|
||||
```bash
|
||||
tofu init
|
||||
tofu apply -exclude modules.cloudflare
|
||||
tofu apply
|
||||
```
|
||||
|
||||
2) Deploy the app using Helm
|
||||
```bash
|
||||
# Set the namespace
|
||||
kubectl create namespace myapp || true
|
||||
|
||||
# Install/upgrade the chart with required values
|
||||
helm upgrade --install myapp charts/myapp-chart \
|
||||
-n myapp \
|
||||
-f charts/myapp-chart/values.yaml \
|
||||
--set image.backend.repository=myorg/myapp-backend \
|
||||
--set image.backend.tag=latest \
|
||||
--set env.BACKEND_URL="https://myapp.example.com" \
|
||||
--set env.FRONTEND_URL="https://myapp.example.com" \
|
||||
--set env.SECRET="CHANGE_ME_SECRET"
|
||||
```
|
||||
Adjust values to your registry and domain. The chart’s NOTES.txt includes additional examples.
|
||||
|
||||
3) Expose and access
|
||||
- If using Cloudflare Tunnel or an ingress, configure DNS accordingly (see tofu/modules/cloudflare and deployment/tunnel.yaml).
|
||||
- For quick testing without ingress:
|
||||
```bash
|
||||
kubectl -n myapp port-forward deploy/myapp-backend 8000:8000
|
||||
kubectl -n myapp port-forward deploy/myapp-frontend 5173:80
|
||||
```
|
||||
|
||||
### Verification
|
||||
3) Deploy rest of the modules
|
||||
|
||||
```bash
|
||||
# Check pods
|
||||
kubectl -n myapp get pods
|
||||
|
||||
# Backend health
|
||||
curl -i http://127.0.0.1:8000/
|
||||
# OpenAPI
|
||||
open http://127.0.0.1:8000/docs
|
||||
|
||||
# Frontend (if port-forwarded)
|
||||
open http://localhost:5173
|
||||
tofu apply
|
||||
```
|
||||
|
||||
### Configure deployment
|
||||
|
||||
1) Create self-hosted runner with access to the cluster or make cluster publicly accessible
|
||||
2) Change `jobs.deploy.runs-on` in `.github/workflows/deploy-prod.yml` and in `.github/workflows/deploy-pr.yaml` to your
|
||||
runner label
|
||||
3) Add variables to GitHub in repository settings:
|
||||
- `PROD_DOMAIN` - base domain for deployments (e.g. ltrk.cz)
|
||||
- `DEV_FRONTEND_BASE_DOMAIN` - base domain for your cloudflare pages
|
||||
4) Add secrets to GitHub in repository settings:
|
||||
- CLOUDFLARE_ACCOUNT_ID - same as in tofu/terraform.tfvars
|
||||
- CLOUDFLARE_API_TOKEN - same as in tofu/terraform.tfvars
|
||||
- DOCKER_USER - your docker registry username
|
||||
- DOCKER_PASSWORD - your docker registry password
|
||||
- KUBE_CONFIG - content of your kubeconfig file for the cluster
|
||||
- PROD_DB_PASSWORD - same as MARIADB_PASSWORD
|
||||
- PROD_RABBITMQ_PASSWORD - same as MARIADB_PASSWORD
|
||||
- PROD_DB_ENCRYPTION_KEY - same as DB_ENCRYPTION_KEY
|
||||
- MOJEID_CLIENT_ID
|
||||
- MOJEID_CLIENT_SECRET
|
||||
- BANKID_CLIENT_ID
|
||||
- BANKID_CLIENT_SECRET
|
||||
- CSAS_CLIENT_ID
|
||||
- CSAS_CLIENT_SECRET
|
||||
- SENTRY_DSN
|
||||
- SMTP_HOST
|
||||
- SMTP_PORT
|
||||
- SMTP_USERNAME
|
||||
- SMTP_PASSWORD
|
||||
- SMTP_FROM
|
||||
- UNIRATE_API_KEY
|
||||
5) On Github open Actions tab, select "Deploy Prod" and run workflow manually
|
||||
|
||||
## Testing Instructions
|
||||
The tests are located in 7project/backend/tests directory
|
||||
If you want to test locally, you have to have the DB running locally as well (start the docker compose in /backend).
|
||||
|
||||
The tests are located in 7project/backend/tests directory. All tests are run by GitHub actions on every pull request and
|
||||
push to main.
|
||||
See the workflow [here](../.github/workflows/run-tests.yml).
|
||||
|
||||
If you want to run the tests locally, the preferred way is to use a [bash script](backend/test_locally.sh)
|
||||
that will start a test DB container with [docker compose](backend/docker-compose.test.yml) and remove it afterwards.
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
cd 7project/src/backend
|
||||
bash test_locally.sh
|
||||
```
|
||||
|
||||
### Unit Tests
|
||||
There are only 3 basic unit tests, since our services logic is very simple
|
||||
|
||||
There are only 5 basic unit tests, since our services logic is very simple
|
||||
|
||||
```bash
|
||||
pytest tests/test_unit_user_service.py
|
||||
bash test_locally.sh --only-unit
|
||||
```
|
||||
|
||||
### Integration Tests
|
||||
There are 11 basic unit tests, testing the individual backend API logic
|
||||
|
||||
There are 9 basic unit tests, testing the individual backend API logic
|
||||
|
||||
```bash
|
||||
pytest tests/test_integration_app.py
|
||||
bash test_locally.sh --only-integration
|
||||
```
|
||||
|
||||
### End-to-End Tests
|
||||
There are 7 e2e tests testing more complex app logic
|
||||
|
||||
There are 7 e2e tests, testing more complex app logic
|
||||
|
||||
```bash
|
||||
pytest tests/test_e2e.py
|
||||
bash test_locally.sh --only-e2e
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
@@ -310,7 +562,12 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
||||
|
||||
### Frontend
|
||||
|
||||
- Start with: npm run dev in 7project/frontend
|
||||
- Start with:
|
||||
|
||||
```bash
|
||||
npm run dev in 7project/src/frontend
|
||||
```
|
||||
|
||||
- Ensure VITE_BACKEND_URL is set to the backend URL (e.g., http://127.0.0.1:8000)
|
||||
- Open http://localhost:5173
|
||||
- Login, view latest transactions, filter, and add new transactions from the UI.
|
||||
@@ -319,37 +576,72 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
||||
|
||||
## Presentation Video
|
||||
|
||||
**YouTube Link**: [Insert your YouTube link here]
|
||||
**YouTube Link**: https://youtu.be/FKR85AVN8bI
|
||||
|
||||
**Duration**: [X minutes Y seconds]
|
||||
**Duration**: 9 minutes 43 seconds
|
||||
|
||||
**Video Includes**:
|
||||
|
||||
- [ ] Project overview and architecture
|
||||
- [ ] Live demonstration of key features
|
||||
- [ ] Code walkthrough
|
||||
- [ ] Build and deployment showcase
|
||||
- [x] Project overview and architecture
|
||||
- [x] Live demonstration of key features
|
||||
- [x] Code walkthrough
|
||||
- [x] Build and deployment showcase
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
#### Issue 1: [Common problem]
|
||||
#### Issue 1: Unable to apply Cloudflare terraform module
|
||||
|
||||
**Symptoms**: [What the user sees]
|
||||
**Solution**: [Step-by-step fix]
|
||||
**Symptoms**: Terraform/OpenTofu apply fails during Cloudflare module deployment.
|
||||
This is caused by unknown variable not known beforehand.
|
||||
|
||||
#### Issue 2: [Another common problem]
|
||||
**Solution**: Apply first without Cloudflare module and then apply again.
|
||||
|
||||
**Symptoms**: [What the user sees]
|
||||
**Solution**: [Step-by-step fix]
|
||||
```bash
|
||||
tofu apply -exclude modules.cloudflare
|
||||
tofu apply
|
||||
```
|
||||
|
||||
#### Issue 2: Pods are unable to start
|
||||
|
||||
**Symptoms**: Pods are unable to start with ImagePullBackOff error. This could be caused
|
||||
by either hitting docker hub rate limits or by docker hub being down.
|
||||
|
||||
**Solution**: Make sure you updated the cluster config to use registry mirror as described in
|
||||
"Setup Cluster" section.
|
||||
|
||||
### Debug Commands
|
||||
|
||||
Get a detailed description of the Deployment:
|
||||
|
||||
```bash
|
||||
# Useful commands for debugging
|
||||
# Log viewing commands
|
||||
# Service status checks
|
||||
kubectl describe deployment finance-tracker -n prod
|
||||
```
|
||||
|
||||
Get a list of pods in the Deployment:
|
||||
|
||||
```bash
|
||||
kubectl get pods -n prod
|
||||
```
|
||||
|
||||
Check the logs of a specific pod copy value for <pod-name> from the command above (--previous flag shows logs of a
|
||||
failing pod, remove it if the pod is not failing):
|
||||
|
||||
```bash
|
||||
kubectl logs <pod-name> -n prod --previous
|
||||
```
|
||||
|
||||
See the service description:
|
||||
|
||||
```bash
|
||||
kubectl describe service finance-tracker -n prod
|
||||
```
|
||||
|
||||
Connect to the pod and run a bash shell:
|
||||
|
||||
```bash
|
||||
kubectl exec -it <pod-name> -n prod -- /bin/bash
|
||||
```
|
||||
|
||||
---
|
||||
@@ -360,53 +652,67 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
||||
> This information is used for individual grading.
|
||||
> Link to the specific commit on GitHub for each contribution.
|
||||
|
||||
| Task/Component | Assigned To | Status | Time Spent | Difficulty | Notes |
|
||||
|-----------------------------------------------------------------------|-------------| ------------- |------------|------------| ----------- |
|
||||
| [Project Setup & Repository](https://github.com/dat515-2025/Group-8#) | Lukas | ✅ Complete | [X hours] | Medium | [Any notes] |
|
||||
| [Design Document](https://github.com/dat515-2025/Group-8/blob/main/6design/design.md) | Both | ✅ Complete | 4 Hours | Easy | [Any notes] |
|
||||
| [Backend API Development](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/api) | Dejan | ✅ Complete | 12 hours | Medium | [Any notes] |
|
||||
| [Database Setup & Models](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/models) | Lukas | 🔄 In Progress | [X hours] | Medium | [Any notes] |
|
||||
| [Frontend Development](https://github.com/dat515-2025/Group-8/tree/main/7project/frontend) | Dejan | ✅ Complete | 17 hours | Medium | [Any notes] |
|
||||
| [Docker Configuration](https://github.com/dat515-2025/Group-8/blob/main/7project/compose.yml) | Lukas | ✅ Complete | [X hours] | Easy | [Any notes] |
|
||||
| [Cloud Deployment](https://github.com/dat515-2025/Group-8/blob/main/7project/deployment/app-demo-deployment.yaml) | Lukas | ✅ Complete | [X hours] | Hard | [Any notes] |
|
||||
| [Testing Implementation](https://github.com/dat515-2025/group-name) | Dejan | ✅ Complete | 16 hours | Medium | [Any notes] |
|
||||
| [Documentation](https://github.com/dat515-2025/group-name) | Both | 🔄 In Progress | [X hours] | Easy | [Any notes] |
|
||||
| [Presentation Video](https://github.com/dat515-2025/group-name) | Both | ❌ Not Started | [X hours] | Medium | [Any notes] |
|
||||
|
||||
**Legend**: ✅ Complete | 🔄 In Progress | ⏳ Pending | ❌ Not Started
|
||||
| Task/Component | Assigned To | Status | Time Spent | Difficulty | Notes |
|
||||
|:----------------------------------------------------------------------------------------------------------|:------------|:-----------|:-----------|:-----------|:------|
|
||||
| [Project Setup & Repository](https://github.com/dat515-2025/Group-8/pull/1) | Both | ✅ Complete | 10 Hours | Medium | |
|
||||
| [Design Document](https://github.com/dat515-2025/Group-8/commit/f09f9eaa82d0953afe41f33c57ff63e0933a81ef) | Both | ✅ Complete | 4 Hours | Easy | |
|
||||
| [Cluster setup ](https://github.com/dat515-2025/Group-8/commit/c8048d940df00874c290d99cdb4ad366bca6e95d) | Lukas | ✅ Complete | 30 hours | Hard | |
|
||||
| [Backend API Development](https://github.com/dat515-2025/Group-8/pull/26) | Dejan | ✅ Complete | 22 hours | Medium | |
|
||||
| [Database Setup & Models](https://github.com/dat515-2025/Group-8/pull/19) | Lukas | ✅ Complete | 5 hours | Medium | |
|
||||
| [Frontend Development](https://github.com/dat515-2025/Group-8/pull/28) | Dejan | ✅ Complete | 32 hours | Medium | |
|
||||
| [Docker Configuration](https://github.com/dat515-2025/Group-8/pull/1) | Lukas | ✅ Complete | 3 hours | Easy | |
|
||||
| [Authentification](https://github.com/dat515-2025/Group-8/pull/23) | Both | ✅ Complete | 11 hours | Medium | |
|
||||
| [Transactions loading](https://github.com/dat515-2025/Group-8/pull/32) | Lukas | ✅ Complete | 7 hours | Medium | |
|
||||
| [Monitoring](https://github.com/dat515-2025/Group-8/pull/42/) | Lukas | ✅ Complete | 9 hours | Medium | |
|
||||
| [Cloud Deployment](https://github.com/dat515-2025/Group-8/pull/16) | Both | ✅ Complete | 21 hours | Hard | |
|
||||
| [Testing Implementation](https://github.com/dat515-2025/Group-8/pull/31/) | Both | ✅ Complete | 21 hours | Medium | |
|
||||
| [Documentation](https://github.com/dat515-2025/Group-8/commit/515106b238bc032d5f7d5dcae931b5cb7ee2a281) | Both | ✅ Complete | 14 hours | Medium | |
|
||||
| [Presentation Video](https://youtu.be/FKR85AVN8bI) | Both | ✅ Complete | 3 hours | Medium | |
|
||||
|
||||
## Hour Sheet
|
||||
|
||||
> Link to the specific commit on GitHub for each contribution.
|
||||
### Lukáš
|
||||
|
||||
### [Lukáš]
|
||||
|
||||
| Date | Activity | Hours | Description |
|
||||
|----------------|---------------------|------------|----------------------------------------------------|
|
||||
| 4.10 to 10.10 | Initial Setup | 40 | Repository setup, project structure, cluster setup |
|
||||
| 14.10 to 16.10 | Backend Development | 12 | Implemented user authentication - oauth |
|
||||
| 8.10 to 12.10 | CI/CD | 10 | Created database schema and models |
|
||||
| [Date] | Testing | [X.X] | Unit tests for API endpoints |
|
||||
| [Date] | Documentation | [X.X] | Updated README and design doc |
|
||||
| **Total** | | **[XX.X]** | |
|
||||
| Date | Activity | Hours | Description | Representative Commit / PR |
|
||||
|:----------------|:----------------------------|:--------|:------------------------------------------------------------------------------------|:------------------------------------------------------|
|
||||
| 18.9. - 19.9. | Initial Setup & Design | 10 | Repository init, system design diagrams, basic Terraform setup | `feat(infrastructure): add basic terraform resources` |
|
||||
| 20.9. - 5.10. | Core Infrastructure & CI/CD | 12 | K8s setup (ArgoCD), CI/CD workflows, RabbitMQ, Redis, Celery workers, DB migrations | `PR #2`, `feat(infrastructure): add rabbitmq cluster` |
|
||||
| 6.10. - 9.10. | Frontend Infra & DB | 5 | Deployed frontend to Cloudflare, setup metrics, created database models | `PR #16` (Cloudflare), `PR #19` (DB structure) |
|
||||
| 10.10. - 11.10. | Backend | 5 | Implemented OAuth support (MojeID, BankID) | `feat(auth): add support for OAuth and MojeID` |
|
||||
| 12.10. | Infrastructure | 2 | Added database backups | `feat(infrastructure): add backups` |
|
||||
| 16.10. | Infrastructure | 4 | Implemented secrets management, fixed deployment/env variables | `PR #29` (Deployment envs) |
|
||||
| 17.10. | Monitoring | 1 | Added Sentry logging | `feat(app): add sentry loging` |
|
||||
| 21.10. - 22.10. | Backend | 8 | Added ČSAS bank connection | `PR #32` (Fix React OAuth) |
|
||||
| 29.10. - 30.10. | Backend | 5 | Implemented transaction encryption, add bank scraping | `PR #39` (CSAS Scraping) |
|
||||
| 30.10. | Monitoring | 6 | Implemented Loki logging and basic Prometheus metrics | `PR #42` (Prometheus metrics) |
|
||||
| 9.11. | Monitoring | 2 | Added custom Prometheus metrics | `PR #46` (Prometheus custom metrics) |
|
||||
| 11.11. | Tests | 1 | Investigated and fixed broken Pytest environment | `fix(tests): set pytest env` |
|
||||
| 11.11. - 12.11. | Features & Deployment | 6 | Added cron support, email sender service, updated workers & image | `PR #49` (Email), `PR #50` (Update workers) |
|
||||
| 18.9 - 16.11 | Documentation | 8 | Updated report.md, design docs, and tfvars.example | `Create design.md`, `update report` |
|
||||
| 15.11 | Video | 2 | Record my video part, edit video | |
|
||||
| **Total** | | **107** | | |
|
||||
|
||||
### Dejan
|
||||
|
||||
| Date | Activity | Hours | Description |
|
||||
|-----------------|----------------------|--------|---------------------------------------------------------------|
|
||||
| 25.9. | Design | 2 | 6design |
|
||||
| 9.10 to 11.10. | Backend APIs | 12 | Implemented Backend APIs |
|
||||
| 13.10 to 15.10. | Frontend Development | 8 | Created user interface mockups |
|
||||
| Continually | Documentation | 6 | Documenting the dev process |
|
||||
| 21.10 to 23.10 | Tests, frontend | 10 | Test basics, balance charts, and frontend improvement |
|
||||
| 28.10 to 30.10 | CI | 6 | Integrated tests with test database setup on github workflows |
|
||||
| 28.10 to 30.10 | Frontend | 7 | UI improvements and exchange rate API integration |
|
||||
| 4.11 to 6.11 | Tests | 6 | Test fixes improvement, more integration and e2e |
|
||||
| 4.11 to 6.11 | Frontend | 6 | Fixes, Improved UI, added support for mobile devices |
|
||||
| **Total** | | **63** | |
|
||||
| Date | Activity | Hours | Description | Representative Commit / PR |
|
||||
|:-----------------|:---------------------|:-------|:----------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------|
|
||||
| 25.9. | Design | 2 | 6design | |
|
||||
| 9.10. to 11.10. | Backend APIs | 14 | Implemented Backend APIs | `PR #26`, `20-create-a-controller-layer-on-backend-side` |
|
||||
| 13.10. to 15.10. | Frontend Development | 8 | Created user interface mockups | `PR #28`, `frontend basics` |
|
||||
| 21.10. to 23.10. | Tests, frontend | 10 | Test basics, balance charts, and frontend improvement | `PR #31`, `30 create tests and set up a GitHub pipeline` |
|
||||
| 28.10. to 30.10. | CI/CD | 6 | Integrated tests with test database setup on github workflows | `PR #31`, `30 create tests and set up a GitHub pipeline` |
|
||||
| 28.10. to 30.10. | Frontend | 8 | UI improvements and exchange rate API integration | `PR #35`, `34 improve frontend functionality` |
|
||||
| 29.10. | Backend | 4 | Token invalidation, few fixes | `PR #38`, `fix(backend): implemented jwt token invalidation so users cannot use …` |
|
||||
| 4.11. to 6.11. | Tests | 6 | Test fixes improvement, more integration and e2e | `PR #45`, `feat(test): added more tests ` |
|
||||
| 4.11. to 6.11. | Frontend | 8 | Fixes, rates API, Improved UI, added support for mobile devices | `PR #41, #44`, `feat(frontend): added CNB API and moved management into a new tab`, `43 fix the UI layout in chrome ` |
|
||||
| 11.11. | Backend APIs | 4 | Moved rates API, mock bank to Backend, few fixes | `feat(backend): Moved the unirate API to the backend `, `feat(backend): moved mock bank to backend` |
|
||||
| 11.11. to 12.11. | Tests | 3 | Local testing DB container, few fixes | `PR #48`, `fix(tests): fixed test runtime errors regarding database connection ` |
|
||||
| 12.11. | Frontend | 3 | Enabled multiple transaction edits at once, CSAS button state | `feat(frontend): implemented multiple transaction selections in UI` |
|
||||
| 13.11. | Video | 3 | Video | |
|
||||
| 25.9. to 14.11. | Documentation | 8 | Documenting the dev process | multiple `feat(docs): report.md update` |
|
||||
| **Total** | | **87** | | |
|
||||
|
||||
|
||||
### Group Total: [XXX.X] hours
|
||||
### Group Total: 194 hours
|
||||
|
||||
---
|
||||
|
||||
@@ -414,28 +720,86 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
||||
|
||||
### What We Learned
|
||||
|
||||
[Reflect on the key technical and collaboration skills learned during this project]
|
||||
#### Technical
|
||||
|
||||
- We learned how to use AI to help us with our project.
|
||||
- We learned how to use Copilot for PR reviews.
|
||||
- We learned how to troubleshoot issues with our project in different areas.
|
||||
|
||||
#### Collaboration
|
||||
|
||||
- Weekly meetings with the TA were great for syncing up on progress, discussing issues, planning future work.
|
||||
- Using GitHub issues and pull requests was very helpful for keeping track of progress.
|
||||
|
||||
### Challenges Faced
|
||||
|
||||
[Describe the main challenges and how you overcame them]
|
||||
#### Slow cluster performance
|
||||
|
||||
This was caused by single SATA SSD disk running all VMs. This was solved by adding second NVMe disk just for Talos VMs.
|
||||
|
||||
#### Stucked IaC deployment
|
||||
|
||||
If the deployed module (helm chart for example) was not configured properly, it would get stuck and timeout resulting in
|
||||
namespace that cannot be deleted.
|
||||
This was solved by using snapshots in Proxmox and restoring if this happened.
|
||||
|
||||
#### Not enough time to implement all features
|
||||
|
||||
Since this course is worth only 5 credits, we often had to prioritize other courses we were attending over this project.
|
||||
In the end, we were able to implement all necessary features.
|
||||
|
||||
### If We Did This Again
|
||||
|
||||
#### Different framework
|
||||
|
||||
FastAPI lacks usable build in support for database migrations and implementing Alembic was a bit tricky.
|
||||
Tricky was also integrating FastAPI auth system with React frontend, since there is no official project template.
|
||||
Using .NET (which we considered initially) would probably solve these issues.
|
||||
|
||||
#### Private container registry
|
||||
|
||||
Using private container registry would allow us to include environment variables directly in the image during build.
|
||||
This would simplify deployment and CI/CD setup.
|
||||
|
||||
#### Start sooner
|
||||
|
||||
The weekly meetings helped us to start planning the project earlier and avoid spending too much time on details,
|
||||
but we could have started earlier if we had more time.
|
||||
|
||||
[What would you do differently? What worked well that you'd keep?]
|
||||
|
||||
### Individual Growth
|
||||
|
||||
#### [Team Member 1 Name]
|
||||
#### [Lukas]
|
||||
|
||||
[Personal reflection on growth, challenges, and learning]
|
||||
This course finally forced me to learn kubernetes (been on by TODO list for at least 3 years).
|
||||
I had some prior experience with terraform/opentofu from work but this improved by understanding of it.
|
||||
|
||||
#### [Team Member 2 Name]
|
||||
The biggest challenge for me was time tracking since I am used to tracking to projects, not to tasks.
|
||||
(I am bad even at that :) ).
|
||||
|
||||
It was also interesting experience to be the one responsible for the initial project structure/design/setup
|
||||
used not only by myself.
|
||||
|
||||
#### [Dejan]
|
||||
|
||||
Since I do not have a job and I am more theoretically oriented student (I am more into math, algorithms, cryptography),
|
||||
this project was probably the most complex one I have ever worked on.
|
||||
For me, it was a great experience to work on an actually deployed fullstack app and not only local development, that I
|
||||
was used to from the past.
|
||||
|
||||
It was also a great experience to collaborate with Lukas who has prior experience with app deployment and
|
||||
infrastructure.
|
||||
Thanks to this, I learned a lot new technologies and how to work in a team (First time reviewing PRs).
|
||||
|
||||
It was challenging to wrap my head around the project structure and how everything was connected (And I still think I
|
||||
have some gaps in my knowledge).
|
||||
But I think that if I decide to create my own demo project in the future, I will definitely be able to work on it much
|
||||
more efficiently.
|
||||
|
||||
[Personal reflection on growth, challenges, and learning]
|
||||
|
||||
|
||||
---
|
||||
|
||||
**Report Completion Date**: [Date]
|
||||
**Last Updated**: 15.10.2025
|
||||
**Report Completion Date**: 15.11.2025
|
||||
**Last Updated**: 15.11.2025
|
||||
14
7project/src/README.md
Normal file
14
7project/src/README.md
Normal file
@@ -0,0 +1,14 @@
|
||||
## Folder structure
|
||||
|
||||
- `src/`
|
||||
- `backend/` - Python FastAPI backend application. Described in separate [README](./backend/README.md).
|
||||
- `charts/`
|
||||
- `myapp-chart/` - Helm chart for deploying the application, supports prod and dev environments. Described in
|
||||
separate [README](./charts/README.md).
|
||||
- `frontend/` - React frontend application. Described in separate
|
||||
[README](./frontend/README.md).
|
||||
- `tofu/` - Terraform/OpenTofu services deployment configurations. Described in separate
|
||||
[README](./tofu/README.md).
|
||||
- `compose.yaml` - Docker Compose file for local development
|
||||
- `create_migration.sh` - script to create new Alembic database migration
|
||||
- `upgrade_database.sh` - script to upgrade database to latest Alembic revision
|
||||
8
7project/src/backend/.idea/.gitignore
generated
vendored
Normal file
8
7project/src/backend/.idea/.gitignore
generated
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
# Default ignored files
|
||||
/shelf/
|
||||
/workspace.xml
|
||||
# Editor-based HTTP Client requests
|
||||
/httpRequests/
|
||||
# Datasource local storage ignored files
|
||||
/dataSources/
|
||||
/dataSources.local.xml
|
||||
16
7project/src/backend/Dockerfile
Normal file
16
7project/src/backend/Dockerfile
Normal file
@@ -0,0 +1,16 @@
|
||||
FROM python:3.11-slim
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
RUN useradd --create-home --shell /bin/bash app
|
||||
|
||||
COPY requirements.txt .
|
||||
RUN pip install --no-cache-dir -r requirements.txt
|
||||
|
||||
COPY . .
|
||||
RUN chown -R app:app /app
|
||||
|
||||
USER app
|
||||
|
||||
EXPOSE 8000
|
||||
CMD ["sh", "-c", "alembic upgrade head && uvicorn app.app:fastApi --host 0.0.0.0 --port 8000"]
|
||||
23
7project/src/backend/README.md
Normal file
23
7project/src/backend/README.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Backend
|
||||
|
||||
This directory contains the backend code for the project. It is built using Python and FastAPI framework and with
|
||||
database migrations support using Alembic.
|
||||
|
||||
## Directory structure
|
||||
|
||||
- `alembic/` - database migrations
|
||||
- `app/` - main application code
|
||||
- `api/` - API endpoints - routers/controllers with request handling logic
|
||||
- `core/` - core application logic - database session management, security
|
||||
- `models/` - database models
|
||||
- `schemas/` - Endpoint schemas
|
||||
- `services/` - utilities for various tasks
|
||||
- `workers/` - background tasks
|
||||
- `app.py` - FastAPI startup script
|
||||
- `celery_app.py` - Celery startup script
|
||||
- `tests/` - tests
|
||||
- `docker-compose.test.yml` - docker compose for testing database
|
||||
- `Dockerfile` - production Dockerfile
|
||||
- `main.py` - App entrypoint
|
||||
- `requirements.txt` - Python dependencies
|
||||
- `test_locally.sh` - script to run tests with temporary database
|
||||
66
7project/src/backend/app/api/exchange_rates.py
Normal file
66
7project/src/backend/app/api/exchange_rates.py
Normal file
@@ -0,0 +1,66 @@
|
||||
import os
|
||||
from typing import List
|
||||
|
||||
import httpx
|
||||
from fastapi import APIRouter, HTTPException, Query, status
|
||||
|
||||
router = APIRouter(prefix="/exchange-rates", tags=["exchange-rates"])
|
||||
|
||||
|
||||
@router.get("", status_code=status.HTTP_200_OK)
|
||||
async def get_exchange_rates(symbols: str = Query("EUR,USD,NOK", description="Comma-separated currency codes to fetch vs CZK")):
|
||||
"""
|
||||
Fetch exchange rates from UniRate API on the backend and return CZK-per-target rates.
|
||||
- Always requests CZK in addition to requested symbols to compute conversion from USD-base.
|
||||
- Returns a list of {currencyCode, rate} where rate is CZK per 1 unit of the target currency.
|
||||
"""
|
||||
api_key = os.getenv("UNIRATE_API_KEY")
|
||||
if not api_key:
|
||||
raise HTTPException(status_code=500, detail="Server is not configured with UNIRATE_API_KEY")
|
||||
|
||||
# Ensure CZK is included for conversion
|
||||
requested = [s.strip().upper() for s in symbols.split(",") if s.strip()]
|
||||
if "CZK" not in requested:
|
||||
requested.append("CZK")
|
||||
query_symbols = ",".join(sorted(set(requested)))
|
||||
|
||||
url = f"https://unirateapi.com/api/rates?api_key={api_key}&symbols={query_symbols}"
|
||||
|
||||
try:
|
||||
async with httpx.AsyncClient(timeout=httpx.Timeout(15.0)) as client:
|
||||
resp = await client.get(url)
|
||||
if resp.status_code != httpx.codes.OK:
|
||||
raise HTTPException(status_code=502, detail=f"Upstream UniRate error: HTTP {resp.status_code}")
|
||||
data = resp.json()
|
||||
except httpx.HTTPError as e:
|
||||
raise HTTPException(status_code=502, detail=f"Failed to contact UniRate: {str(e)}")
|
||||
|
||||
# Validate response structure
|
||||
rates = data.get("rates") if isinstance(data, dict) else None
|
||||
base = data.get("base") if isinstance(data, dict) else None
|
||||
if not rates or base != "USD" or "CZK" not in rates:
|
||||
# Prefer upstream message when available
|
||||
detail = data.get("message") if isinstance(data, dict) else None
|
||||
if not detail and isinstance(data, dict):
|
||||
err = data.get("error")
|
||||
if isinstance(err, dict):
|
||||
detail = err.get("info")
|
||||
raise HTTPException(status_code=502, detail=detail or "Invalid response from UniRate API")
|
||||
|
||||
czk_per_usd = rates["CZK"]
|
||||
|
||||
# Build result excluding CZK itself
|
||||
result = []
|
||||
for code in requested:
|
||||
if code == "CZK":
|
||||
continue
|
||||
target_per_usd = rates.get(code)
|
||||
if target_per_usd in (None, 0):
|
||||
# Skip unavailable or invalid
|
||||
continue
|
||||
czk_per_target = czk_per_usd / target_per_usd
|
||||
result.append({"currencyCode": code, "rate": czk_per_target})
|
||||
|
||||
return result
|
||||
|
||||
|
||||
116
7project/src/backend/app/api/mock_bank.py
Normal file
116
7project/src/backend/app/api/mock_bank.py
Normal file
@@ -0,0 +1,116 @@
|
||||
from datetime import datetime, timedelta
|
||||
from typing import List, Optional
|
||||
import random
|
||||
|
||||
from fastapi import APIRouter, Depends
|
||||
from pydantic import BaseModel, Field, conint, confloat, validator
|
||||
from sqlalchemy import select
|
||||
from sqlalchemy.ext.asyncio import AsyncSession
|
||||
|
||||
from app.services.db import get_async_session
|
||||
from app.services.user_service import current_active_user
|
||||
from app.models.user import User
|
||||
from app.models.transaction import Transaction
|
||||
from app.models.categories import Category
|
||||
from app.schemas.transaction import TransactionRead
|
||||
|
||||
router = APIRouter(prefix="/mock-bank", tags=["mock-bank"])
|
||||
|
||||
|
||||
class GenerateOptions(BaseModel):
|
||||
count: conint(strict=True, gt=0) = Field(default=10, description="Number of transactions to generate")
|
||||
minAmount: confloat(strict=True) = Field(default=-200.0, description="Minimum transaction amount")
|
||||
maxAmount: confloat(strict=True) = Field(default=200.0, description="Maximum transaction amount")
|
||||
startDate: Optional[str] = Field(None, description="Earliest date (YYYY-MM-DD)")
|
||||
endDate: Optional[str] = Field(None, description="Latest date (YYYY-MM-DD)")
|
||||
categoryIds: List[int] = Field(default_factory=list, description="Optional category IDs to assign randomly")
|
||||
|
||||
@validator("maxAmount")
|
||||
def _validate_amounts(cls, v, values):
|
||||
min_amt = values.get("minAmount")
|
||||
if min_amt is not None and v < min_amt:
|
||||
raise ValueError("maxAmount must be greater than or equal to minAmount")
|
||||
return v
|
||||
|
||||
@validator("endDate")
|
||||
def _validate_dates(cls, v, values):
|
||||
sd = values.get("startDate")
|
||||
if v and sd:
|
||||
try:
|
||||
ed = datetime.strptime(v, "%Y-%m-%d").date()
|
||||
st = datetime.strptime(sd, "%Y-%m-%d").date()
|
||||
except ValueError:
|
||||
raise ValueError("Invalid date format, expected YYYY-MM-DD")
|
||||
if ed < st:
|
||||
raise ValueError("endDate must be greater than or equal to startDate")
|
||||
return v
|
||||
|
||||
|
||||
class GeneratedTransaction(BaseModel):
|
||||
amount: float
|
||||
date: str # YYYY-MM-DD
|
||||
category_ids: List[int] = []
|
||||
description: Optional[str] = None
|
||||
|
||||
|
||||
@router.post("/generate", response_model=List[GeneratedTransaction])
|
||||
async def generate_mock_transactions(
|
||||
options: GenerateOptions,
|
||||
user: User = Depends(current_active_user),
|
||||
):
|
||||
# Seed randomness per user to make results less erratic across multiple calls in quick succession
|
||||
seed = int(datetime.utcnow().timestamp()) ^ int(user.id)
|
||||
rnd = random.Random(seed)
|
||||
|
||||
# Determine date range
|
||||
if options.startDate:
|
||||
start_date = datetime.strptime(options.startDate, "%Y-%m-%d").date()
|
||||
else:
|
||||
start_date = (datetime.utcnow() - timedelta(days=365)).date()
|
||||
if options.endDate:
|
||||
end_date = datetime.strptime(options.endDate, "%Y-%m-%d").date()
|
||||
else:
|
||||
end_date = datetime.utcnow().date()
|
||||
|
||||
span_days = max(0, (end_date - start_date).days)
|
||||
|
||||
results: List[GeneratedTransaction] = []
|
||||
for _ in range(options.count):
|
||||
amount = round(rnd.uniform(options.minAmount, options.maxAmount), 2)
|
||||
# Pick a random date in the inclusive range
|
||||
rand_day = rnd.randint(0, span_days) if span_days > 0 else 0
|
||||
tx_date = start_date + timedelta(days=rand_day)
|
||||
# Pick category randomly from provided list, or empty
|
||||
if options.categoryIds:
|
||||
cat = [rnd.choice(options.categoryIds)]
|
||||
else:
|
||||
cat = []
|
||||
# Optional simple description for flavor
|
||||
desc = None
|
||||
# Assemble
|
||||
results.append(GeneratedTransaction(
|
||||
amount=amount,
|
||||
date=tx_date.isoformat(),
|
||||
category_ids=cat,
|
||||
description=desc,
|
||||
))
|
||||
|
||||
return results
|
||||
|
||||
|
||||
@router.get("/scrape")
|
||||
async def scrape_mock_bank():
|
||||
# 80% of the time: nothing to scrape
|
||||
if random.random() < 0.8:
|
||||
return []
|
||||
|
||||
transactions = []
|
||||
count = random.randint(1, 10)
|
||||
for _ in range(count):
|
||||
transactions.append({
|
||||
"amount": round(random.uniform(-200.0, 200.0), 2),
|
||||
"date": (datetime.utcnow().date() - timedelta(days=random.randint(0, 30))).isoformat(),
|
||||
"description": "Mock transaction",
|
||||
})
|
||||
|
||||
return transactions
|
||||
@@ -21,6 +21,7 @@ from app.api.auth import router as auth_router
|
||||
from app.api.csas import router as csas_router
|
||||
from app.api.categories import router as categories_router
|
||||
from app.api.transactions import router as transactions_router
|
||||
from app.api.exchange_rates import router as exchange_rates_router
|
||||
from app.services.user_service import auth_backend, current_active_verified_user, fastapi_users, get_oauth_provider, \
|
||||
UserManager, get_jwt_strategy
|
||||
from app.core.security import extract_bearer_token, is_token_revoked, decode_and_verify_jwt
|
||||
@@ -29,7 +30,8 @@ from app.services.user_service import SECRET
|
||||
from fastapi import FastAPI
|
||||
import sentry_sdk
|
||||
from fastapi_users.db import SQLAlchemyUserDatabase
|
||||
from app.core.db import async_session_maker
|
||||
from app.core.db import async_session_maker, engine
|
||||
from app.core.base import Base
|
||||
|
||||
sentry_sdk.init(
|
||||
dsn=os.getenv("SENTRY_DSN"),
|
||||
@@ -51,20 +53,23 @@ fastApi.add_middleware(
|
||||
allow_headers=["*"],
|
||||
)
|
||||
|
||||
prometheus = Instrumentator().instrument(fastApi)
|
||||
|
||||
# Register custom metrics
|
||||
prometheus.add(number_of_users()).add(number_of_transactions())
|
||||
|
||||
prometheus.expose(
|
||||
fastApi,
|
||||
endpoint="/metrics",
|
||||
include_in_schema=True,
|
||||
)
|
||||
if not os.getenv("PYTEST_RUN_CONFIG"):
|
||||
prometheus = Instrumentator().instrument(fastApi)
|
||||
# Register custom metrics
|
||||
prometheus.add(number_of_users()).add(number_of_transactions())
|
||||
prometheus.expose(
|
||||
fastApi,
|
||||
endpoint="/metrics",
|
||||
include_in_schema=True,
|
||||
)
|
||||
|
||||
fastApi.include_router(auth_router)
|
||||
fastApi.include_router(categories_router)
|
||||
fastApi.include_router(transactions_router)
|
||||
fastApi.include_router(exchange_rates_router)
|
||||
from app.api.mock_bank import router as mock_bank_router
|
||||
fastApi.include_router(mock_bank_router)
|
||||
|
||||
for h in list(logging.root.handlers):
|
||||
logging.root.removeHandler(h)
|
||||
@@ -1,5 +1,7 @@
|
||||
import os
|
||||
from sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker
|
||||
from sqlalchemy import create_engine
|
||||
from sqlalchemy.orm import sessionmaker
|
||||
from app.core.base import Base
|
||||
|
||||
DATABASE_URL = os.getenv("DATABASE_URL")
|
||||
@@ -23,6 +25,7 @@ host_env = os.getenv("MARIADB_HOST", "localhost")
|
||||
ssl_enabled = host_env not in {"localhost", "127.0.0.1"}
|
||||
connect_args = {"ssl": {"ssl": True}} if ssl_enabled else {}
|
||||
|
||||
# Async engine/session for the async parts of the app
|
||||
engine = create_async_engine(
|
||||
DATABASE_URL,
|
||||
pool_pre_ping=True,
|
||||
@@ -30,3 +33,13 @@ engine = create_async_engine(
|
||||
connect_args=connect_args,
|
||||
)
|
||||
async_session_maker = async_sessionmaker(engine, expire_on_commit=False)
|
||||
|
||||
# Synchronous engine/session for sync utilities (e.g., bank_scraper)
|
||||
SYNC_DATABASE_URL = DATABASE_URL.replace("+asyncmy", "+pymysql")
|
||||
engine_sync = create_engine(
|
||||
SYNC_DATABASE_URL,
|
||||
pool_pre_ping=True,
|
||||
echo=os.getenv("SQL_ECHO", "0") == "1",
|
||||
connect_args=connect_args,
|
||||
)
|
||||
sync_session_maker = sessionmaker(bind=engine_sync, expire_on_commit=False)
|
||||
@@ -49,4 +49,4 @@ def decode_and_verify_jwt(token: str, secret: str) -> dict:
|
||||
secret,
|
||||
algorithms=["HS256"],
|
||||
options={"verify_aud": False},
|
||||
) # verify_exp is True by default
|
||||
) # verify_exp is True by default
|
||||
@@ -1,10 +1,11 @@
|
||||
import uuid
|
||||
from typing import Optional
|
||||
from typing import Optional, Dict, Any
|
||||
from fastapi_users import schemas
|
||||
|
||||
class UserRead(schemas.BaseUser[uuid.UUID]):
|
||||
first_name: Optional[str] = None
|
||||
last_name: Optional[str] = None
|
||||
config: Optional[Dict[str, Any]] = None
|
||||
|
||||
class UserCreate(schemas.BaseUserCreate):
|
||||
first_name: Optional[str] = None
|
||||
@@ -1,5 +1,6 @@
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
from os.path import dirname, join
|
||||
from time import strptime
|
||||
from uuid import UUID
|
||||
@@ -7,7 +8,7 @@ from uuid import UUID
|
||||
import httpx
|
||||
from sqlalchemy import select
|
||||
|
||||
from app.core.db import async_session_maker
|
||||
from app.core.db import sync_session_maker
|
||||
from app.models.transaction import Transaction
|
||||
from app.models.user import User
|
||||
|
||||
@@ -20,26 +21,78 @@ CERTS = (
|
||||
)
|
||||
|
||||
|
||||
async def aload_ceska_sporitelna_transactions(user_id: str) -> None:
|
||||
def load_mock_bank_transactions(user_id: str) -> None:
|
||||
try:
|
||||
uid = UUID(str(user_id))
|
||||
except Exception:
|
||||
logger.error("Invalid user_id provided to bank_scraper (async): %r", user_id)
|
||||
logger.error("Invalid user_id provided to bank_scraper (sync): %r", user_id)
|
||||
return
|
||||
|
||||
await _aload_ceska_sporitelna_transactions(uid)
|
||||
_load_mock_bank_transactions(uid)
|
||||
|
||||
|
||||
async def aload_all_ceska_sporitelna_transactions() -> None:
|
||||
async with async_session_maker() as session:
|
||||
result = await session.execute(select(User))
|
||||
users = result.unique().scalars().all()
|
||||
def load_all_mock_bank_transactions() -> None:
|
||||
with sync_session_maker() as session:
|
||||
users = session.execute(select(User)).unique().scalars().all()
|
||||
logger.info("[BankScraper] Starting Mock Bank scrape for all users | count=%d", len(users))
|
||||
|
||||
processed = 0
|
||||
for user in users:
|
||||
try:
|
||||
_load_mock_bank_transactions(user.id)
|
||||
processed += 1
|
||||
except Exception:
|
||||
logger.exception("[BankScraper] Error scraping for user id=%s email=%s", user.id,
|
||||
getattr(user, 'email', None))
|
||||
logger.info("[BankScraper] Finished Mock Bank scrape for all users | processed=%d", processed)
|
||||
|
||||
|
||||
def _load_mock_bank_transactions(user_id: UUID) -> None:
|
||||
with sync_session_maker() as session:
|
||||
user: User | None = session.execute(select(User).where(User.id == user_id)).unique().scalar_one_or_none()
|
||||
if user is None:
|
||||
logger.warning("User not found for id=%s", user_id)
|
||||
return
|
||||
|
||||
transactions = []
|
||||
with httpx.Client() as client:
|
||||
response = client.get(f"{os.getenv('APP_POD_URL')}/mock-bank/scrape")
|
||||
if response.status_code != httpx.codes.OK:
|
||||
return
|
||||
for transaction in response.json():
|
||||
transactions.append(
|
||||
Transaction(
|
||||
amount=transaction["amount"],
|
||||
description=transaction.get("description"),
|
||||
date=strptime(transaction["date"], "%Y-%m-%d"),
|
||||
user_id=user_id,
|
||||
)
|
||||
)
|
||||
|
||||
for transaction in transactions:
|
||||
session.add(transaction)
|
||||
session.commit()
|
||||
|
||||
|
||||
def load_ceska_sporitelna_transactions(user_id: str) -> None:
|
||||
try:
|
||||
uid = UUID(str(user_id))
|
||||
except Exception:
|
||||
logger.error("Invalid user_id provided to bank_scraper (sync): %r", user_id)
|
||||
return
|
||||
|
||||
_load_ceska_sporitelna_transactions(uid)
|
||||
|
||||
|
||||
def load_all_ceska_sporitelna_transactions() -> None:
|
||||
with sync_session_maker() as session:
|
||||
users = session.execute(select(User)).unique().scalars().all()
|
||||
logger.info("[BankScraper] Starting CSAS scrape for all users | count=%d", len(users))
|
||||
|
||||
processed = 0
|
||||
for user in users:
|
||||
try:
|
||||
await _aload_ceska_sporitelna_transactions(user.id)
|
||||
_load_ceska_sporitelna_transactions(user.id)
|
||||
processed += 1
|
||||
except Exception:
|
||||
logger.exception("[BankScraper] Error scraping for user id=%s email=%s", user.id,
|
||||
@@ -47,10 +100,9 @@ async def aload_all_ceska_sporitelna_transactions() -> None:
|
||||
logger.info("[BankScraper] Finished CSAS scrape for all users | processed=%d", processed)
|
||||
|
||||
|
||||
async def _aload_ceska_sporitelna_transactions(user_id: UUID) -> None:
|
||||
async with (async_session_maker() as session):
|
||||
result = await session.execute(select(User).where(User.id == user_id))
|
||||
user: User = result.unique().scalar_one_or_none()
|
||||
def _load_ceska_sporitelna_transactions(user_id: UUID) -> None:
|
||||
with sync_session_maker() as session:
|
||||
user: User | None = session.execute(select(User).where(User.id == user_id)).unique().scalar_one_or_none()
|
||||
if user is None:
|
||||
logger.warning("User not found for id=%s", user_id)
|
||||
return
|
||||
@@ -65,8 +117,8 @@ async def _aload_ceska_sporitelna_transactions(user_id: UUID) -> None:
|
||||
|
||||
accounts = []
|
||||
try:
|
||||
async with httpx.AsyncClient(cert=CERTS, timeout=httpx.Timeout(20.0)) as client:
|
||||
response = await client.get(
|
||||
with httpx.Client(cert=CERTS, timeout=httpx.Timeout(20.0)) as client:
|
||||
response = client.get(
|
||||
"https://webapi.developers.erstegroup.com/api/csas/sandbox/v4/account-information/my/accounts?size=10&page=0&sort=iban&order=desc",
|
||||
headers={
|
||||
"Authorization": f"Bearer {cfg['access_token']}",
|
||||
@@ -77,7 +129,7 @@ async def _aload_ceska_sporitelna_transactions(user_id: UUID) -> None:
|
||||
if response.status_code != httpx.codes.OK:
|
||||
return
|
||||
|
||||
for account in response.json()["accounts"]:
|
||||
for account in response.json().get("accounts", []):
|
||||
accounts.append(account)
|
||||
|
||||
except (httpx.HTTPError,) as e:
|
||||
@@ -85,11 +137,13 @@ async def _aload_ceska_sporitelna_transactions(user_id: UUID) -> None:
|
||||
return
|
||||
|
||||
for account in accounts:
|
||||
id = account["id"]
|
||||
acc_id = account.get("id")
|
||||
if not acc_id:
|
||||
continue
|
||||
|
||||
url = f"https://webapi.developers.erstegroup.com/api/csas/sandbox/v4/account-information/my/accounts/{id}/transactions?size=100&page=0&sort=bookingdate&order=desc"
|
||||
async with httpx.AsyncClient(cert=CERTS) as client:
|
||||
response = await client.get(
|
||||
url = f"https://webapi.developers.erstegroup.com/api/csas/sandbox/v4/account-information/my/accounts/{acc_id}/transactions?size=100&page=0&sort=bookingdate&order=desc"
|
||||
with httpx.Client(cert=CERTS) as client:
|
||||
response = client.get(
|
||||
url,
|
||||
headers={
|
||||
"Authorization": f"Bearer {cfg['access_token']}",
|
||||
@@ -100,7 +154,7 @@ async def _aload_ceska_sporitelna_transactions(user_id: UUID) -> None:
|
||||
if response.status_code != httpx.codes.OK:
|
||||
continue
|
||||
|
||||
transactions = response.json()["transactions"]
|
||||
transactions = response.json().get("transactions", [])
|
||||
|
||||
for transaction in transactions:
|
||||
description = transaction.get("entryDetails", {}).get("transactionDetails", {}).get(
|
||||
@@ -108,9 +162,12 @@ async def _aload_ceska_sporitelna_transactions(user_id: UUID) -> None:
|
||||
date_str = transaction.get("bookingDate", {}).get("date")
|
||||
date = strptime(date_str, "%Y-%m-%d") if date_str else None
|
||||
amount = transaction.get("amount", {}).get("value")
|
||||
if transaction.get("creditDebitIndicator") == "DBIT":
|
||||
if transaction.get("creditDebitIndicator") == "DBIT" and amount is not None:
|
||||
amount = -abs(amount)
|
||||
|
||||
if amount is None:
|
||||
continue
|
||||
|
||||
obj = Transaction(
|
||||
amount=amount,
|
||||
description=description,
|
||||
@@ -118,7 +175,4 @@ async def _aload_ceska_sporitelna_transactions(user_id: UUID) -> None:
|
||||
user_id=user_id,
|
||||
)
|
||||
session.add(obj)
|
||||
await session.commit()
|
||||
|
||||
pass
|
||||
pass
|
||||
session.commit()
|
||||
@@ -14,11 +14,10 @@ from httpx_oauth.oauth2 import BaseOAuth2
|
||||
|
||||
from app.models.user import User
|
||||
from app.oauth.bank_id import BankID
|
||||
from app.oauth.csas import CSASOAuth
|
||||
from app.workers.celery_tasks import send_email
|
||||
from app.oauth.custom_openid import CustomOpenID
|
||||
from app.oauth.moje_id import MojeIDOAuth
|
||||
from app.services.db import get_user_db
|
||||
from app.core.queue import enqueue_email
|
||||
|
||||
SECRET = os.getenv("SECRET", "CHANGE_ME_SECRET")
|
||||
|
||||
@@ -87,7 +86,7 @@ class UserManager(UUIDIDMixin, BaseUserManager[User, uuid.UUID]):
|
||||
"Pokud jsi registraci neprováděl(a), tento email ignoruj.\n"
|
||||
)
|
||||
try:
|
||||
enqueue_email(to=user.email, subject=subject, body=body)
|
||||
send_email.delay(user.email, subject, body)
|
||||
except Exception as e:
|
||||
print("[Email Fallback] To:", user.email)
|
||||
print("[Email Fallback] Subject:", subject)
|
||||
86
7project/src/backend/app/workers/celery_tasks.py
Normal file
86
7project/src/backend/app/workers/celery_tasks.py
Normal file
@@ -0,0 +1,86 @@
|
||||
import logging
|
||||
import os
|
||||
import smtplib
|
||||
from email.message import EmailMessage
|
||||
|
||||
import app.services.bank_scraper
|
||||
from app.celery_app import celery_app
|
||||
|
||||
logger = logging.getLogger("celery_tasks")
|
||||
if not logger.handlers:
|
||||
_h = logging.StreamHandler()
|
||||
logger.addHandler(_h)
|
||||
logger.setLevel(logging.INFO)
|
||||
|
||||
|
||||
@celery_app.task(name="workers.send_email")
|
||||
def send_email(to: str, subject: str, body: str) -> None:
|
||||
if not (to and subject and body):
|
||||
logger.error("Email task missing fields. to=%r subject=%r body_len=%r", to, subject, len(body) if body else 0)
|
||||
return
|
||||
|
||||
host = os.getenv("SMTP_HOST")
|
||||
if not host:
|
||||
logger.error("SMTP_HOST is not configured; cannot send email")
|
||||
return
|
||||
|
||||
# Configuration
|
||||
port = int(os.getenv("SMTP_PORT", "25"))
|
||||
username = os.getenv("SMTP_USERNAME")
|
||||
password = os.getenv("SMTP_PASSWORD")
|
||||
use_tls = os.getenv("SMTP_USE_TLS", "0").lower() in {"1", "true", "yes"}
|
||||
use_ssl = os.getenv("SMTP_USE_SSL", "0").lower() in {"1", "true", "yes"}
|
||||
timeout = int(os.getenv("SMTP_TIMEOUT", "10"))
|
||||
mail_from = os.getenv("SMTP_FROM") or username or "noreply@localhost"
|
||||
|
||||
# Build message
|
||||
msg = EmailMessage()
|
||||
msg["To"] = to
|
||||
msg["From"] = mail_from
|
||||
msg["Subject"] = subject
|
||||
msg.set_content(body)
|
||||
|
||||
try:
|
||||
if use_ssl:
|
||||
with smtplib.SMTP_SSL(host=host, port=port, timeout=timeout) as smtp:
|
||||
if username and password:
|
||||
smtp.login(username, password)
|
||||
smtp.send_message(msg)
|
||||
else:
|
||||
with smtplib.SMTP(host=host, port=port, timeout=timeout) as smtp:
|
||||
# STARTTLS if requested
|
||||
if use_tls:
|
||||
smtp.starttls()
|
||||
if username and password:
|
||||
smtp.login(username, password)
|
||||
smtp.send_message(msg)
|
||||
logger.info("[Celery] Email sent | to=%s | subject=%s | body_len=%d", to, subject, len(body))
|
||||
except Exception:
|
||||
logger.exception("Failed to send email via SMTP to=%s subject=%s host=%s port=%s tls=%s ssl=%s", to, subject,
|
||||
host, port, use_tls, use_ssl)
|
||||
|
||||
|
||||
@celery_app.task(name="workers.load_transactions")
|
||||
def load_transactions(user_id: str) -> None:
|
||||
if not user_id:
|
||||
logger.error("Load transactions task missing user_id.")
|
||||
return
|
||||
|
||||
logger.info("[Celery] Starting load_transactions | user_id=%s", user_id)
|
||||
try:
|
||||
# Use synchronous bank scraper functions directly, mirroring load_all_transactions
|
||||
app.services.bank_scraper.load_mock_bank_transactions(user_id)
|
||||
app.services.bank_scraper.load_ceska_sporitelna_transactions(user_id)
|
||||
except Exception:
|
||||
logger.exception("Failed to load transactions for user_id=%s", user_id)
|
||||
else:
|
||||
logger.info("[Celery] Finished load_transactions | user_id=%s", user_id)
|
||||
|
||||
|
||||
@celery_app.task(name="workers.load_all_transactions")
|
||||
def load_all_transactions() -> None:
|
||||
logger.info("[Celery] Starting load_all_transactions")
|
||||
# Now use synchronous bank scraper functions directly
|
||||
app.services.bank_scraper.load_all_mock_bank_transactions()
|
||||
app.services.bank_scraper.load_all_ceska_sporitelna_transactions()
|
||||
logger.info("[Celery] Finished load_all_transactions")
|
||||
20
7project/src/backend/docker-compose.test.yml
Normal file
20
7project/src/backend/docker-compose.test.yml
Normal file
@@ -0,0 +1,20 @@
|
||||
version: "3.9"
|
||||
services:
|
||||
mariadb:
|
||||
image: mariadb:11.4
|
||||
container_name: test-mariadb
|
||||
environment:
|
||||
MARIADB_ROOT_PASSWORD: rootpw
|
||||
MARIADB_DATABASE: group_project
|
||||
MARIADB_USER: appuser
|
||||
MARIADB_PASSWORD: apppass
|
||||
ports:
|
||||
- "3307:3306" # host:container (use 3307 on host to avoid conflicts)
|
||||
healthcheck:
|
||||
test: ["CMD", "mariadb-admin", "ping", "-h", "127.0.0.1", "-u", "root", "-prootpw", "--silent"]
|
||||
interval: 5s
|
||||
timeout: 2s
|
||||
retries: 20
|
||||
# Truly ephemeral, fast storage (removed when container stops)
|
||||
tmpfs:
|
||||
- /var/lib/mysql
|
||||
4
7project/src/backend/main.py
Normal file
4
7project/src/backend/main.py
Normal file
@@ -0,0 +1,4 @@
|
||||
import uvicorn
|
||||
|
||||
if __name__ == "__main__":
|
||||
uvicorn.run("app.app:fastApi", host="0.0.0.0", log_level="info")
|
||||
113
7project/src/backend/test_locally.sh
Executable file
113
7project/src/backend/test_locally.sh
Executable file
@@ -0,0 +1,113 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Run tests against a disposable local MariaDB on host port 3307 using Docker Compose.
|
||||
# Requirements: Docker, docker compose plugin, Python, Alembic, pytest.
|
||||
# Usage:
|
||||
# chmod +x ./test_locally.sh
|
||||
# # From 7project/backend directory
|
||||
# ./test_locally.sh [--only-unit|--only-integration|--only-e2e] [pytest-args...]
|
||||
# # Examples:
|
||||
# ./test_locally.sh --only-unit -q
|
||||
# ./test_locally.sh --only-integration -k "login"
|
||||
# ./test_locally.sh --only-e2e -vv
|
||||
#
|
||||
# This script will:
|
||||
# 1) Start a MariaDB 11.4 container (ephemeral storage, port 3307)
|
||||
# 2) Wait until it's healthy
|
||||
# 3) Export env vars expected by the app (DATABASE_URL etc.)
|
||||
# 4) Run Alembic migrations
|
||||
# 5) Run pytest
|
||||
# 6) Tear everything down (containers and tmpfs data)
|
||||
|
||||
COMPOSE_FILE="docker-compose.test.yml"
|
||||
SERVICE_NAME="mariadb"
|
||||
CONTAINER_NAME="test-mariadb"
|
||||
|
||||
if ! command -v docker >/dev/null 2>&1; then
|
||||
echo "Docker is required but not found in PATH" >&2
|
||||
exit 1
|
||||
fi
|
||||
if ! docker compose version >/dev/null 2>&1; then
|
||||
echo "Docker Compose V2 plugin is required (docker compose)" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Bring up the DB
|
||||
echo "Starting MariaDB (port 3307) with docker compose..."
|
||||
docker compose -f "$COMPOSE_FILE" up -d
|
||||
|
||||
# Ensure we clean up on exit
|
||||
cleanup() {
|
||||
echo "\nTearing down docker compose stack..."
|
||||
docker compose -f "$COMPOSE_FILE" down -v || true
|
||||
}
|
||||
trap cleanup EXIT
|
||||
|
||||
# Wait for healthy container
|
||||
echo -n "Waiting for MariaDB to become healthy"
|
||||
for i in {1..60}; do
|
||||
status=$(docker inspect -f '{{.State.Health.Status}}' "$CONTAINER_NAME" 2>/dev/null || echo "")
|
||||
if [ "$status" = "healthy" ]; then
|
||||
echo " -> healthy"
|
||||
break
|
||||
fi
|
||||
echo -n "."
|
||||
sleep 1
|
||||
if [ $i -eq 60 ]; then
|
||||
echo "\nMariaDB did not become healthy in time" >&2
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
# Export env vars for the app/tests (match app/core/db.py expectations)
|
||||
export MARIADB_HOST=127.0.0.1
|
||||
export MARIADB_PORT=3307
|
||||
export MARIADB_DB=group_project
|
||||
export MARIADB_USER=appuser
|
||||
export MARIADB_PASSWORD=apppass
|
||||
export DATABASE_URL="mysql+asyncmy://$MARIADB_USER:$MARIADB_PASSWORD@$MARIADB_HOST:$MARIADB_PORT/$MARIADB_DB"
|
||||
export PYTEST_RUN_CONFIG="True"
|
||||
|
||||
# Determine which tests to run based on flags
|
||||
UNIT_TESTS="tests/test_unit_user_service.py"
|
||||
INTEGRATION_TESTS="tests/test_integration_app.py"
|
||||
E2E_TESTS="tests/test_e2e.py"
|
||||
|
||||
FLAG_COUNT=0
|
||||
TEST_TARGET=""
|
||||
declare -a PYTEST_ARGS=()
|
||||
for arg in "$@"; do
|
||||
case "$arg" in
|
||||
--only-unit)
|
||||
TEST_TARGET="$UNIT_TESTS"; FLAG_COUNT=$((FLAG_COUNT+1));;
|
||||
--only-integration)
|
||||
TEST_TARGET="$INTEGRATION_TESTS"; FLAG_COUNT=$((FLAG_COUNT+1));;
|
||||
--only-e2e)
|
||||
TEST_TARGET="$E2E_TESTS"; FLAG_COUNT=$((FLAG_COUNT+1));;
|
||||
*)
|
||||
PYTEST_ARGS+=("$arg");;
|
||||
esac
|
||||
done
|
||||
|
||||
if [ "$FLAG_COUNT" -gt 1 ]; then
|
||||
echo "Error: Use only one of --only-unit, --only-integration, or --only-e2e" >&2
|
||||
exit 2
|
||||
fi
|
||||
|
||||
# Run Alembic migrations then tests
|
||||
pushd . >/dev/null
|
||||
echo "Running Alembic migrations..."
|
||||
alembic upgrade head
|
||||
|
||||
echo "Running pytest..."
|
||||
if [ -n "$TEST_TARGET" ]; then
|
||||
# Use "${PYTEST_ARGS[@]:-}" to safely expand empty array with 'set -u'
|
||||
pytest "$TEST_TARGET" "${PYTEST_ARGS[@]:-}"
|
||||
else
|
||||
# Use "${PYTEST_ARGS[@]:-}" to safely expand empty array with 'set -u'
|
||||
pytest "${PYTEST_ARGS[@]:-}"
|
||||
fi
|
||||
popd >/dev/null
|
||||
|
||||
# Cleanup handled by trap
|
||||
@@ -3,17 +3,6 @@ import pytest
|
||||
from httpx import AsyncClient, ASGITransport
|
||||
|
||||
|
||||
def test_root_ok(client):
|
||||
resp = client.get("/")
|
||||
assert resp.status_code == status.HTTP_200_OK
|
||||
assert resp.json() == {"status": "ok"}
|
||||
|
||||
|
||||
def test_authenticated_route_requires_auth(client):
|
||||
resp = client.get("/authenticated-route")
|
||||
assert resp.status_code in (status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN)
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_create_and_get_category(fastapi_app, test_user):
|
||||
# Use AsyncClient for async tests
|
||||
@@ -165,6 +154,6 @@ async def test_delete_transaction_not_found(fastapi_app, test_user):
|
||||
async with AsyncClient(transport=transport, base_url="http://testserver") as ac:
|
||||
token = (await ac.post("/auth/jwt/login", data=test_user)).json()["access_token"]
|
||||
h = {"Authorization": f"Bearer {token}"}
|
||||
r = await ac.delete("/transactions/999999/delete", headers=h)
|
||||
r = await ac.delete("/transactions/9999999/delete", headers=h)
|
||||
assert r.status_code == status.HTTP_404_NOT_FOUND
|
||||
|
||||
@@ -1,7 +1,5 @@
|
||||
import types
|
||||
import asyncio
|
||||
import pytest
|
||||
|
||||
from fastapi import status
|
||||
from app.services import user_service
|
||||
|
||||
|
||||
@@ -22,20 +20,30 @@ def test_get_jwt_strategy_lifetime():
|
||||
# Basic smoke check: strategy has a lifetime set to 604800
|
||||
assert getattr(strategy, "lifetime_seconds", None) in (604800,)
|
||||
|
||||
def test_root_ok(client):
|
||||
resp = client.get("/")
|
||||
assert resp.status_code == status.HTTP_200_OK
|
||||
assert resp.json() == {"status": "ok"}
|
||||
|
||||
|
||||
def test_authenticated_route_requires_auth(client):
|
||||
resp = client.get("/authenticated-route")
|
||||
assert resp.status_code in (status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN)
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_on_after_request_verify_enqueues_email(monkeypatch):
|
||||
calls = {}
|
||||
|
||||
def fake_enqueue_email(to: str, subject: str, body: str):
|
||||
calls.setdefault("emails", []).append({
|
||||
"to": to,
|
||||
"subject": subject,
|
||||
"body": body,
|
||||
})
|
||||
class FakeCeleryTask:
|
||||
def delay(to: str, subject: str, body: str):
|
||||
calls.setdefault("emails", []).append({
|
||||
"to": to,
|
||||
"subject": subject,
|
||||
"body": body,
|
||||
})
|
||||
|
||||
# Patch the enqueue_email used inside user_service
|
||||
monkeypatch.setattr(user_service, "enqueue_email", fake_enqueue_email)
|
||||
monkeypatch.setattr(user_service, "send_email", FakeCeleryTask)
|
||||
|
||||
class DummyUser:
|
||||
def __init__(self, email):
|
||||
30
7project/src/charts/README.md
Normal file
30
7project/src/charts/README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Helm chart deployment
|
||||
|
||||
This directory contains a Helm chart for deploying the app to a cluster, it support bot production and preview
|
||||
deployment.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
- `myapp-chart/`
|
||||
- `templates/`
|
||||
- `app-deployment.yaml` - Kubernetes Deployment for the application
|
||||
- `cron.yaml` - cronjob for periodic tasks - periodically calls app endpoint
|
||||
- `database.yaml` - Creates database using MariaDB operator. Production database is kept, but preview/dev
|
||||
database is dropped after uninstalling the chart.
|
||||
- `database-grant.yaml` - Defines rights for the database user
|
||||
- `database-user.yaml` - Creates database user
|
||||
- `monitoring.yaml` - Adds /metrics endpoint to Prometheus scraping
|
||||
- `prod.yaml` - Application secrets
|
||||
- `rabbitmq-cluster.yaml` - Defines RabbitMQ cluster for this deployment
|
||||
- `rabbitmq-permission.yalm` - Defines RabbitMQ user permissions
|
||||
- `rabbitmq-queue.yaml` - Defines RabbitMQ queue
|
||||
- `rabbitmq-user.yaml` - Defines RabbitMQ user
|
||||
- `rabbitmq-user-secret.yaml` - Defines RabbitMQ user secret
|
||||
- `service.yaml` - Kubernetes Service for the application
|
||||
- `tunnel.yaml` - Cloudflare tunnel for accessing the application¨
|
||||
- `worker-deployment.yaml` - Kubernetes Deployment for the Celery worker, uses same image as the app-deployment,
|
||||
but with different entrypoint
|
||||
- `Chart.yaml` - Helm chart metadata
|
||||
- `values.yaml` - list of all configurable values
|
||||
- `values-dev.yaml` - default values for development/preview deployment
|
||||
- `values-prod.yaml` - default values for production deployment
|
||||
@@ -90,6 +90,11 @@ spec:
|
||||
secretKeyRef:
|
||||
name: prod
|
||||
key: CSAS_CLIENT_SECRET
|
||||
- name: UNIRATE_API_KEY
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: prod
|
||||
key: UNIRATE_API_KEY
|
||||
- name: DOMAIN
|
||||
value: {{ required "Set .Values.domain" .Values.domain | quote }}
|
||||
- name: DOMAIN_SCHEME
|
||||
@@ -26,3 +26,4 @@ stringData:
|
||||
SMTP_USE_TLS: {{ .Values.smtp.tls | default false | quote }}
|
||||
SMTP_USE_SSL: {{ .Values.smtp.ssl | default false | quote }}
|
||||
SMTP_FROM: {{ .Values.smtp.from | default "" | quote }}
|
||||
UNIRATE_API_KEY: {{ .Values.unirate.key | default "" | quote }}
|
||||
@@ -120,3 +120,5 @@ spec:
|
||||
secretKeyRef:
|
||||
name: prod
|
||||
key: SMTP_FROM
|
||||
- name: APP_POD_URL
|
||||
value: {{ printf "http://%s.%s.svc.cluster.local" .Values.app.name .Release.Namespace | quote }}
|
||||
@@ -13,6 +13,9 @@ deployment: ""
|
||||
domain: ""
|
||||
domain_scheme: ""
|
||||
|
||||
unirate:
|
||||
key: ""
|
||||
|
||||
frontend_domain: ""
|
||||
frontend_domain_scheme: ""
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user