Compare commits
31 Commits
Docs/kovsp
...
v4
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
70d10719e6 | ||
|
|
85f7c6e690 | ||
|
|
2ac2f17d1a | ||
|
|
7cd4bb6b09 | ||
| 1bf4d875af | |||
|
|
8a01bba644 | ||
|
|
cf2edab297 | ||
|
|
5443002c5f | ||
| e19a5aac9a | |||
|
|
3515703a90 | ||
|
|
a6966e055d | ||
|
|
e41be61321 | ||
| 1b4194ee7d | |||
|
|
4763cbed95 | ||
|
|
9253283953 | ||
| 596828e827 | |||
|
|
c6c2e27d34 | ||
| bc2eca7eac | |||
| 86ceab10ad | |||
| 785e40f538 | |||
| 39da1be9de | |||
|
|
7ef9855016 | ||
|
|
b5902c0bb7 | ||
| 76a1c18b56 | |||
|
|
27394df920 | ||
| 3df33093ed | |||
| 300b3cde34 | |||
| a19e0bf922 | |||
| 7625eecbd9 | |||
| d819368962 | |||
| 8818b12fa5 |
95
.github/workflows/dispatcher.yml
vendored
Normal file
95
.github/workflows/dispatcher.yml
vendored
Normal file
@@ -0,0 +1,95 @@
|
||||
name: Dispatcher
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- '**'
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
dispatch:
|
||||
runs-on: self-hosted
|
||||
outputs:
|
||||
engine: ${{ steps.check.outputs.engine }}
|
||||
server: ${{ steps.check.outputs.server }}
|
||||
ui: ${{ steps.check.outputs.ui }}
|
||||
steps:
|
||||
- name: Determine which tests to run
|
||||
id: check
|
||||
run: |
|
||||
BRANCH="${{ github.ref_name }}"
|
||||
echo "Branch: $BRANCH"
|
||||
|
||||
ENGINE=false
|
||||
SERVER=false
|
||||
UI=false
|
||||
|
||||
if [[ "$BRANCH" == *"Engine"* ]]; then
|
||||
ENGINE=true
|
||||
fi
|
||||
if [[ "$BRANCH" == *"Server"* ]]; then
|
||||
SERVER=true
|
||||
fi
|
||||
if [[ "$BRANCH" == *"UI"* ]]; then
|
||||
UI=true
|
||||
fi
|
||||
|
||||
# Run all on master
|
||||
if [[ "$BRANCH" == "master" ]]; then
|
||||
ENGINE=true
|
||||
SERVER=true
|
||||
UI=true
|
||||
fi
|
||||
|
||||
echo "engine=$ENGINE" >> $GITHUB_OUTPUT
|
||||
echo "server=$SERVER" >> $GITHUB_OUTPUT
|
||||
echo "ui=$UI" >> $GITHUB_OUTPUT
|
||||
|
||||
engine:
|
||||
needs: dispatch
|
||||
if: needs.dispatch.outputs.engine == 'true'
|
||||
uses: ./.github/workflows/engine_test.yml
|
||||
secrets: inherit
|
||||
|
||||
server:
|
||||
needs: dispatch
|
||||
if: needs.dispatch.outputs.server == 'true'
|
||||
uses: ./.github/workflows/server_test.yml
|
||||
secrets: inherit
|
||||
|
||||
ui:
|
||||
needs: dispatch
|
||||
if: needs.dispatch.outputs.ui == 'true'
|
||||
uses: ./.github/workflows/ui_test.yml
|
||||
secrets: inherit
|
||||
|
||||
|
||||
test-data-upload:
|
||||
needs: [engine, server, ui]
|
||||
if: always()
|
||||
uses: ./.github/workflows/upload_data.yml
|
||||
secrets: inherit
|
||||
|
||||
|
||||
release:
|
||||
needs: test-data-upload
|
||||
if: github.ref == 'refs/heads/master'
|
||||
uses: ./.github/workflows/release.yml
|
||||
secrets: inherit
|
||||
|
||||
cleanup:
|
||||
runs-on: self-hosted
|
||||
needs: [engine, server, ui, test-data-upload, release]
|
||||
if: always()
|
||||
steps:
|
||||
- name: Final cleanup
|
||||
run: |
|
||||
echo "Final cleanup on self-hosted runner..."
|
||||
cd "$GITHUB_WORKSPACE"
|
||||
git clean -fdx
|
||||
git reset --hard
|
||||
|
||||
|
||||
|
||||
17
.github/workflows/engine_test.yml
vendored
Normal file
17
.github/workflows/engine_test.yml
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
name: Engine Tests
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
workflow_call:
|
||||
|
||||
jobs:
|
||||
engine-tests:
|
||||
runs-on: self-hosted
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Run Engine tests
|
||||
run: |
|
||||
bash .github/workflows/test.sh engine/
|
||||
106
.github/workflows/release.yml
vendored
Normal file
106
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,106 @@
|
||||
name: Release build
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
workflow_call:
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
release:
|
||||
name: Build and release (master only)
|
||||
runs-on: self-hosted
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Build Engine for Linux
|
||||
run: |
|
||||
cd $(git rev-parse --show-toplevel)
|
||||
pwd
|
||||
mkdir release/linux -p
|
||||
cd engine/
|
||||
rustup target add x86_64-unknown-linux-gnu
|
||||
cargo build --release --target x86_64-unknown-linux-gnu
|
||||
pwd
|
||||
cp target/x86_64-unknown-linux-gnu/release/engine $(git rev-parse --show-toplevel)/release/linux/engine
|
||||
|
||||
- name: Build Server for Linux
|
||||
run: |
|
||||
cd $(git rev-parse --show-toplevel)
|
||||
pwd
|
||||
mkdir release/linux -p
|
||||
cd server/
|
||||
rustup target add x86_64-unknown-linux-gnu
|
||||
cargo build --release --target x86_64-unknown-linux-gnu
|
||||
pwd
|
||||
cp target/x86_64-unknown-linux-gnu/release/server $(git rev-parse --show-toplevel)/release/linux/server
|
||||
|
||||
- name: Build UI for Linux
|
||||
run: |
|
||||
cd $(git rev-parse --show-toplevel)
|
||||
pwd
|
||||
mkdir release/linux -p
|
||||
cd ui/
|
||||
rustup target add x86_64-unknown-linux-gnu
|
||||
cargo build --release --target x86_64-unknown-linux-gnu
|
||||
pwd
|
||||
cp target/x86_64-unknown-linux-gnu/release/ui $(git rev-parse --show-toplevel)/release/linux/ui
|
||||
|
||||
|
||||
- name: Build Engine for Windows
|
||||
run: |
|
||||
cd $(git rev-parse --show-toplevel)
|
||||
pwd
|
||||
mkdir release/windows -p
|
||||
cd engine/
|
||||
rustup target add x86_64-pc-windows-gnu
|
||||
cargo build --release --target x86_64-pc-windows-gnu
|
||||
pwd
|
||||
cp target/x86_64-pc-windows-gnu/release/engine.exe $(git rev-parse --show-toplevel)/release/windows/engine.exe
|
||||
|
||||
- name: Build Server for Windows
|
||||
run: |
|
||||
cd $(git rev-parse --show-toplevel)
|
||||
pwd
|
||||
mkdir release/windows -p
|
||||
cd server/
|
||||
rustup target add x86_64-pc-windows-gnu
|
||||
cargo build --release --target x86_64-pc-windows-gnu
|
||||
pwd
|
||||
cp target/x86_64-pc-windows-gnu/release/server.exe $(git rev-parse --show-toplevel)/release/windows/server.exe
|
||||
|
||||
- name: Build UI for Windows
|
||||
run: |
|
||||
cd $(git rev-parse --show-toplevel)
|
||||
pwd
|
||||
mkdir release/windows -p
|
||||
cd ui/
|
||||
rustup target add x86_64-pc-windows-gnu
|
||||
cargo build --release --target x86_64-pc-windows-gnu
|
||||
pwd
|
||||
cp target/x86_64-pc-windows-gnu/release/ui.exe $(git rev-parse --show-toplevel)/release/windows/ui.exe
|
||||
|
||||
- name: Compress build folders for upload
|
||||
run: |
|
||||
cd $(git rev-parse --show-toplevel)
|
||||
pwd
|
||||
cd release/
|
||||
zip linux.zip linux/*
|
||||
zip windows.zip windows/*
|
||||
|
||||
- name: Create GitHub Release
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
tag_name: "v${{ github.run_number }}"
|
||||
name: "Release v${{ github.run_number }}"
|
||||
generate_release_notes: true
|
||||
files: |
|
||||
release/linux.zip
|
||||
release/windows.zip
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
|
||||
17
.github/workflows/server_test.yml
vendored
Normal file
17
.github/workflows/server_test.yml
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
name: Server Tests
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
workflow_call:
|
||||
|
||||
jobs:
|
||||
server-tests:
|
||||
runs-on: self-hosted
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Run Server tests
|
||||
run: |
|
||||
bash .github/workflows/test.sh server/
|
||||
37
.github/workflows/test.sh
vendored
Executable file
37
.github/workflows/test.sh
vendored
Executable file
@@ -0,0 +1,37 @@
|
||||
#!/usr/bin/env bash
|
||||
set -e
|
||||
|
||||
# --- ARGUMENT CHECK ---
|
||||
if [ -z "$1" ]; then
|
||||
echo "Usage: $0 <project_path>"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# --- SETUP VARIABLES ---
|
||||
PROJECT_PATH="$1"
|
||||
PROJECT_NAME=$(basename "$PROJECT_PATH")
|
||||
ROOT_DIR=$(git rev-parse --show-toplevel)
|
||||
|
||||
LOG_FILE="${PROJECT_NAME}_test.log"
|
||||
FINAL_LOG="${ROOT_DIR}/test_data.log"
|
||||
|
||||
# --- MOVE TO PROJECT DIRECTORY ---
|
||||
echo ">>> Running tests for project: $PROJECT_NAME"
|
||||
cd "$PROJECT_PATH" || { echo "Error: Could not cd into $PROJECT_PATH"; exit 1; }
|
||||
|
||||
# --- RUN TESTS ---
|
||||
cargo test --verbose | tee full_test_output.log
|
||||
|
||||
# --- EXTRACT TEST SECTION ---
|
||||
# Create the log file with the project name as the first line
|
||||
echo "$PROJECT_NAME" > "$LOG_FILE"
|
||||
|
||||
# Then append only the lines between "running X test(s)" and the first empty line
|
||||
awk '/^running [0-9]+ test[s]?$/,/^$/' full_test_output.log >> "$LOG_FILE"
|
||||
|
||||
# --- APPEND TO GLOBAL LOG (in repo root) ---
|
||||
cat "$LOG_FILE" >> "$FINAL_LOG"
|
||||
|
||||
# --- SUMMARY ---
|
||||
echo ">>> Test output extracted to $PROJECT_PATH/$LOG_FILE"
|
||||
echo ">>> Appended to $FINAL_LOG"
|
||||
17
.github/workflows/ui_test.yml
vendored
Normal file
17
.github/workflows/ui_test.yml
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
name: UI Tests
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
workflow_call:
|
||||
|
||||
jobs:
|
||||
ui-tests:
|
||||
runs-on: self-hosted
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Run UI tests
|
||||
run: |
|
||||
bash .github/workflows/test.sh ui/
|
||||
52
.github/workflows/upload_data.yml
vendored
Normal file
52
.github/workflows/upload_data.yml
vendored
Normal file
@@ -0,0 +1,52 @@
|
||||
name: Upload Test Results to Google Sheets
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
workflow_call:
|
||||
|
||||
jobs:
|
||||
upload:
|
||||
runs-on: self-hosted
|
||||
steps:
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
pip install gspread google-auth --break-system-packages
|
||||
|
||||
- name: Upload test_data.log to Google Sheets
|
||||
env:
|
||||
GOOGLE_SERVICE_ACCOUNT_JSON: ${{ secrets.GOOGLE_SERVICE_ACCOUNT_JSON }}
|
||||
SPREADSHEET_ID: ${{ secrets.SPREADSHEET_ID }}
|
||||
run: |
|
||||
echo "$GOOGLE_SERVICE_ACCOUNT_JSON" > service_account.json
|
||||
|
||||
python <<'PYCODE'
|
||||
import gspread, json, time, subprocess
|
||||
|
||||
# credentials
|
||||
creds = json.load(open("service_account.json"))
|
||||
gc = gspread.service_account_from_dict(creds)
|
||||
sh = gc.open_by_key("${{ secrets.SPREADSHEET_ID }}")
|
||||
v = subprocess.run(['git','rev-parse','--show-toplevel'], capture_output=True).stdout.decode().strip()
|
||||
print(f"{v}/test_data.log")
|
||||
|
||||
with open(f"{v}/test_data.log", "r") as f:
|
||||
lines = [line.strip() for line in f if line.strip()]
|
||||
|
||||
project = lines[0].lower()
|
||||
worksheet = sh.worksheet(project)
|
||||
|
||||
# project name
|
||||
data = lines[1:]
|
||||
|
||||
#blank rows
|
||||
existing_rows = len(worksheet.get_all_values())
|
||||
start_row = existing_rows + 3
|
||||
|
||||
# Split data into columns (by spaces)
|
||||
rows_to_append = [row.split() for row in data]
|
||||
|
||||
for i, row in enumerate(rows_to_append):
|
||||
worksheet.insert_row(row, start_row + i)
|
||||
|
||||
print(f"Uploaded {len(rows_to_append)} rows to '{project}' tab.")
|
||||
PYCODE
|
||||
51
Docs/funk_spec.md
Normal file
51
Docs/funk_spec.md
Normal file
@@ -0,0 +1,51 @@
|
||||
## 5. Követelménylista
|
||||
|
||||
### Szerver
|
||||
| Név | Verzió | Leírás |
|
||||
| --- | ------ | ------ |
|
||||
| **WebSocket** | 1.0 | A szerver és a kliens között folyamatos kétirányú kommunikációt biztosít. A kapcsolat létrejötte után a szerver valós időben képes fogadni és továbbítani az eseményeket (pl. lépés végrehajtása, állapotfrissítés). Hiba esetén a kapcsolat automatikusan újraépül. |
|
||||
| **Kapcsolatok csoportosítása** | 1.0 | A szerver figyeli az elérhető, szabad klienseket, majd két szabad kapcsolatot automatikusan összerendel egy meccsbe. A csoportosítás után a játékosok azonos „room”-ba kerülnek, és a szerver biztosítja az egymás közötti adatkommunikációt. |
|
||||
| **Kommunikáció az engine-nel** | 1.0 | A szerver a játékosoktól érkező lépéseket és játékinformációkat továbbítja az engine-nek feldolgozásra. Az engine válasza után a szerver visszaküldi az eredményt a klienseknek (pl. érvényes lépés, matt, patt). A kommunikáció aszinkron módon zajlik, válaszidő-ellenőrzéssel. |
|
||||
| **Kommunikáció a UI-al** | 1.0 | A szerver WebSocket-en keresztül adatokat továbbít a felhasználói felület és az engine között. A UI által kért műveletek (pl. új meccs létrehozása, állapotlekérés) feldolgozását a szerver közvetíti.|
|
||||
### Engine
|
||||
| Név | Verzió | Leírás |
|
||||
| --- | ------ | ------ |
|
||||
| **Bitboard** | 1.0 | A játék táblaállapotát bitműveletekkel reprezentálja a hatékonyság érdekében. Minden bábu típus és szín külön bitmask-on kerül tárolásra, lehetővé téve a gyors lekérdezéseket és lépésellenőrzéseket. |
|
||||
| **Lépésgenerálás LUT** | 1.0 | Előre kiszámított lookup táblák segítségével gyorsítja a lépésgenerálást és szabályellenőrzést. Ez csökkenti a számítási időt, és optimalizálja az engine teljesítményét. |
|
||||
| **Lépésgenerálás** | 1.0 | A különböző bábutípusok (gyalog, bástya, futó, stb.) lépési logikáját valósítja meg. A függvények ellenőrzik a lépés érvényességét, figyelembe véve az aktuális állást, sakkhelyzetet és speciális szabályokat (pl. sáncolás, en passant). |
|
||||
| **Util függvények** | 1.0 | Segédfüggvények az engine belső működéséhez, például raycast műveletek, bitműveleti maszkok kezelése, valamint logikai ellenőrzések a lépések és ütések számításához. |
|
||||
|
||||
### UI
|
||||
| Név | Verzió | Leírás |
|
||||
| --- | ------ | ------ |
|
||||
| **Belépés** | 1.0 | A felhasználó a kezdőképernyőn keresztül adhatja meg a nevét lokális játékhoz, vagy hitelesítheti magát online játékmód esetén. Hibás adatok esetén a rendszer figyelmeztetést küld. |
|
||||
| **Főmenü** | 1.0 | Az alkalmazás központi navigációs felülete, ahol a felhasználó meccset kereshet, új játékot indíthat lokálisan, vagy beállításokat módosíthat. A menü megjeleníti az aktuális státuszt (online/offline). |
|
||||
| **Játék** | 1.0 | A játékfelület megjeleníti a táblát, bábukat, lépéseket, és az aktuális játékállást. Támogatja mind az online, mind a lokális módot. A felület kezeli az interakciókat (lépéskattintás, visszavonás, végeredmény kijelzés). |
|
||||
| **Kommunikáció a szerverrel** | 1.0 | A kliens a szerveren keresztül kommunikál az engine-nel. A UI felel az üzenetek küldéséért (lépés, új játék, visszajelzés), valamint a szervertől kapott események vizuális megjelenítéséért. |
|
||||
|
||||
|
||||
### GitHub Actions (CI/CD)
|
||||
| Név | Leírás |
|
||||
| --- | ------ |
|
||||
| Folyamatos tesztelés | A projekt minden commit után automatikusan tesztelődik. A pipeline lefuttatja a teszteket, és értesítést küld hibás build esetén. |
|
||||
| Folyamatos integráció | Az új funkciók beolvadásakor a rendszer automatikusan integrálja a változtatásokat, új buildet hoz létre, és frissíti a fejlesztői környezetet. |
|
||||
| Tesztadatok | A tesztadatok legyenek elérhetőek egy táblázatban, dátummal ellátva. (Google Sheets) |
|
||||
|
||||
## A github workflow folyamata:
|
||||
|
||||
A githubon tárolt kód minden feltöltésnél a kód mindig automatikus tesztelve van, egy workflow által. Ennek a működése:
|
||||
1. A brancheket a következő képpen kell elnevezni: Projekt/task_neve (a task neve a kanban tablabol jon).
|
||||
2. 3 projekt van a github repository-ban: Engine, Server és a UI. Ennek megfelelően a következőképpen kell kinézniük a brancheknek:
|
||||
- Engine/task_1
|
||||
- Server/task_1
|
||||
- UI/task_1
|
||||
Erre azért van szükség mert a github workflow ezek alapján az elnevezések alapján fogja eldönteni melyik teszteket futtassa. Ha az Engine projekthez lett feltöltve kód, akkor csak az ahhoz tartozó teszteket futtassa.
|
||||
3. A workflow folyamat a következő:
|
||||
Amikor feltöltődik a három projekt közül valamelyikére egy új commit. A github workflow megnézni mi a branch neve. Ezután letölti a projektet githubról, és lefuttatja azon projekt teszteit. A tesztek eredményét feltölti egy google táblazat fájlba, ahonnan bármikor visszenézhető. Minden teszt eredmény az annak megfelően elnevezett munkalapra kerül be (Engine, Server, UI), egymás alá táblázatos elrendezésben. Az oszlopok a következőek: Dátum, függvény neve, teszt bemenet, teszt kimenet, sikeres-e.
|
||||
Amikor a main/master branchre kerül fel kód. A teszt az előbbiek alapján ugyanúgy lefut, csak itt mind a 3 projekt tesztje le fog futni és az eredmény egy main/master nevű munkalapra fog feltöltődni a táblázatban. Amint sikeresen lefut a tesztelés, elindul egy automatikus build, ami le fogja build-elni a projekteket. Ezután létrehoz egy új Release-t githubon, ahol beállítja a verzió számot a rust projektben beállított verzió számra, majd feltölti oda a fájlokat amiket a build hozott létre, és kiteszi ezt a buildet.
|
||||
|
||||
|
||||
A workflow 3 külön fáljba van bontva:
|
||||
1. A dispatcher (dispatch.yml). Ez indítja el a workflow-t ami teszteli a kódot a megfelelő branchen, elindítja a release workflow-t ami feltölti a master branchről buildelt projekt fájlokat.
|
||||
2. A teszter (tests.yml). Ez a workflow bele fog lépni a megfelelő projekt mappába és lefutattja a megírt teszteket, és feltölti az eredményt egy google spreadsheet-be.
|
||||
3. A release (release.yml). Amint sikeresek a tesztek elindul ez a workflow és lefordítja a kódot majd feltölti github-ra egy új release-ként
|
||||
4
engine/.cargo/config.toml
Normal file
4
engine/.cargo/config.toml
Normal file
@@ -0,0 +1,4 @@
|
||||
[target.x86_64-unknown-linux-gnu]
|
||||
linker = "x86_64-linux-gnu-gcc"
|
||||
[target.x86_64-pc-windows-gnu]
|
||||
linker = "x86_64-w64-mingw32-gcc"
|
||||
4
server/.cargo/config.toml
Normal file
4
server/.cargo/config.toml
Normal file
@@ -0,0 +1,4 @@
|
||||
[target.x86_64-unknown-linux-gnu]
|
||||
linker = "x86_64-linux-gnu-gcc"
|
||||
[target.x86_64-pc-windows-gnu]
|
||||
linker = "x86_64-w64-mingw32-gcc"
|
||||
4
ui/.cargo/config.toml
Normal file
4
ui/.cargo/config.toml
Normal file
@@ -0,0 +1,4 @@
|
||||
[target.x86_64-unknown-linux-gnu]
|
||||
linker = "x86_64-linux-gnu-gcc"
|
||||
[target.x86_64-pc-windows-gnu]
|
||||
linker = "x86_64-w64-mingw32-gcc"
|
||||
Reference in New Issue
Block a user