lukas/uis-cloud-computing
1
0
Fork 0
mirror of https://github.com/dat515-2025/Group-8.git synced 2026-03-22 15:12:08 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat(docs): report.md update

Browse Source
This commit is contained in:
ribardej
2025-11-13 12:36:05 +01:00
parent deb67f421e
commit ba7798259c
2 changed files with 32 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
7project/backend/test-with-ephemeral-mariadb.sh → 7project/backend/test_locally.sh
View File

@@ -4,13 +4,13 @@ set -euo pipefail
# Run tests against a disposable local MariaDB on host port 3307 using Docker Compose. # Run tests against a disposable local MariaDB on host port 3307 using Docker Compose.
# Requirements: Docker, docker compose plugin, Python, Alembic, pytest. # Requirements: Docker, docker compose plugin, Python, Alembic, pytest.
# Usage: # Usage:
# chmod +x ./test-with-ephemeral-mariadb.sh # chmod +x ./test_locally.sh
# # From 7project/backend directory # # From 7project/backend directory
# ./test-with-ephemeral-mariadb.sh [--only-unit|--only-integration|--only-e2e] [pytest-args...] # ./test_locally.sh [--only-unit|--only-integration|--only-e2e] [pytest-args...]
# # Examples: # # Examples:
# ./test-with-ephemeral-mariadb.sh --only-unit -q # ./test_locally.sh --only-unit -q
# ./test-with-ephemeral-mariadb.sh --only-integration -k "login" # ./test_locally.sh --only-integration -k "login"
# ./test-with-ephemeral-mariadb.sh --only-e2e -vv # ./test_locally.sh --only-e2e -vv
# #
# This script will: # This script will:
# 1) Start a MariaDB 11.4 container (ephemeral storage, port 3307) # 1) Start a MariaDB 11.4 container (ephemeral storage, port 3307)

47
7project/report.md
View File

@@ -423,12 +423,11 @@ The tests are located in 7project/backend/tests directory. All tests are run by
push to main. push to main.
See the workflow [here](../.github/workflows/run-tests.yml). See the workflow [here](../.github/workflows/run-tests.yml).
If you want to run the tests locally, the preferred is to use a [bash script](backend/test-with-ephemeral-mariadb.sh) 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](backend/docker-compose.test.yml) and remove it afterward. that will start a test DB container with [docker compose](backend/docker-compose.test.yml) and remove it afterwards.
```bash ```bash
cd 7project/backend cd 7project/backend
bash test-with-ephemeral-mariadb.sh bash test_locally.sh
``` ```
### Unit Tests ### Unit Tests
@@ -436,7 +435,7 @@ bash test-with-ephemeral-mariadb.sh
There are only 5 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 ```bash
bash test-with-ephemeral-mariadb.sh --only-unit bash test_locally.sh --only-unit
``` ```
### Integration Tests ### Integration Tests
@@ -444,7 +443,7 @@ bash test-with-ephemeral-mariadb.sh --only-unit
There are 9 basic unit tests, testing the individual backend API logic There are 9 basic unit tests, testing the individual backend API logic
```bash ```bash
bash test-with-ephemeral-mariadb.sh --only-integration bash test_locally.sh --only-integration
``` ```
### End-to-End Tests ### End-to-End Tests
@@ -452,7 +451,7 @@ bash test-with-ephemeral-mariadb.sh --only-integration
There are 7 e2e tests, testing more complex app logic There are 7 e2e tests, testing more complex app logic
```bash ```bash
bash test-with-ephemeral-mariadb.sh --only-e2e bash test_locally.sh --only-e2e
``` ```
## Usage Examples ## Usage Examples
@@ -580,18 +579,22 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
### Dejan ### Dejan
| Date | Activity | Hours | Description | | Date | Activity | Hours | Description | Representative Commit / PR |
|-----------------|----------------------|--------|---------------------------------------------------------------| |:----------------|:-------------------------|:-------|:--------------------------------------------------------------|:---------------------------------------------------------|
| 25.9. | Design | 2 | 6design | | 25.9. | Design | 2 | 6design | |
| 9.10 to 11.10. | Backend APIs | 12 | Implemented Backend APIs | | 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 | | 13.10 to 15.10. | Frontend Development | 8 | Created user interface mockups | `PR #28`, `frontend basics` |
| Continually | Documentation | 6 | Documenting the dev process | | Continually | Documentation | 7 | Documenting the dev process | |
| 21.10 to 23.10 | Tests, frontend | 10 | Test basics, balance charts, and frontend improvement | | 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 | 6 | Integrated tests with test database setup on github workflows | | 28.10 to 30.10 | CI | 6 | Integrated tests with test database setup on github workflows | `PR #28`, `frontend basics` |
| 28.10 to 30.10 | Frontend | 7 | UI improvements and exchange rate API integration | | 28.10 to 30.10 | Frontend | 8 | UI improvements and exchange rate API integration | `PR #28`, `frontend basics` |
| 4.11 to 6.11 | Tests | 6 | Test fixes improvement, more integration and e2e | | 4.11 to 6.11 | Tests | 6 | Test fixes improvement, more integration and e2e | `PR #28`, `frontend basics` |
| 4.11 to 6.11 | Frontend | 6 | Fixes, Improved UI, added support for mobile devices | | 4.11 to 6.11 | Frontend | 6 | Fixes, Improved UI, added support for mobile devices | `PR #28`, `frontend basics` |
| **Total** | | **63** | | | 11.11 | Backend APIs | 4 | Moved rates API, mock bank to Backend, few fixes | `PR #28`, `frontend basics` |
| 11.11 to 12.11 | Tests | 3 | Local testing DB container, few fixes | `PR #28`, `frontend basics` |
| 12.11 | Frontend | 3 | Enabled multiple transaction edits at once, CSAS button state | `PR #28`, `frontend basics` |
| 13.11 | Video | 3 | Video | |
| **Total** | | **80** | | |
### Group Total: [XXX.X] hours ### Group Total: [XXX.X] hours
@@ -640,7 +643,11 @@ used not only by myself.
[Personal reflection on growth, challenges, and learning] [Personal reflection on growth, challenges, and learning]
#### [Team Member 2 Name] #### [Dejan]
Since I do not have a job, this project was probably the most complex one I have ever worked on.
It was also the first school project where I was encouraged to use AI.
Lukas
[Personal reflection on growth, challenges, and learning] [Personal reflection on growth, challenges, and learning]