Toutsu
4b0f328f2e
- Add standalone C# console runner tests/e2e/runner/ using WTelegramClient - Provide TelegramUserClient wrapper: login, create supergroup, invite bot, send messages/commands, read recent messages, wait for bot reply - Add .env.example and runner .gitignore to keep secrets/session files out of git - Update E2E README with runner instructions and status table - Runner project intentionally excluded from GM-Relay.slnx to avoid CI/AOT impact Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
127 lines
5.1 KiB
Markdown
127 lines
5.1 KiB
Markdown
# GmRelay E2E Tests
|
|
|
|
This module contains locally-run end-to-end tests for the GmRelay Telegram bot and Blazor/Web dashboard.
|
|
It is deliberately **not** wired into CI because it requires real Telegram infrastructure (MTProto user client) and a running Web instance.
|
|
|
|
## Status
|
|
|
|
Tracked as a Gitea milestone: [E2E Automation](https://git.codeanddice.ru/toutsu/GmRelayBot/issues?state=open&milestone=...) <!-- update milestone link manually -->
|
|
|
|
| Issue | Title | Status |
|
|
|-------|-------|--------|
|
|
| #144 | initData / Login Widget helper for mock Telegram auth | ✅ Done |
|
|
| #145 | Playwright tests for Blazor dashboard with mocked Telegram auth | ✅ Done |
|
|
| #146 | Telegram user client (MTProto) | 🚧 In progress |
|
|
| #147 | Automate group creation and bot invitation | ⏳ Planned |
|
|
| #148 | Scenario: /newsession from creation to publication | ⏳ Planned |
|
|
| #149 | Join/leave, waitlist, reschedule and notification scenarios | ⏳ Planned |
|
|
| #150 | Dashboard display and editing verification | ⏳ Planned |
|
|
| #151 | Console runner and cleanup | ⏳ Planned |
|
|
|
|
## Structure
|
|
|
|
```text
|
|
tests/e2e/
|
|
├── README.md
|
|
├── requirements.txt
|
|
├── .gitignore
|
|
├── helpers/
|
|
│ ├── telegram_init_data.py # Build valid Telegram auth payloads
|
|
│ ├── test_telegram_init_data.py # Self-contained sanity tests for the helper
|
|
│ └── __init__.py
|
|
├── dashboard/
|
|
│ ├── test_dashboard_auth_and_sessions.py # Playwright tests for the Blazor dashboard
|
|
│ └── __init__.py
|
|
└── runner/
|
|
├── GmRelay.E2E.Runner.csproj # C# console runner using WTelegramClient (MTProto)
|
|
├── Program.cs # Entry point for quick manual checks
|
|
├── TelegramUserClient.cs # Reusable MTProto user client wrapper
|
|
├── RunnerConfig.cs # Configuration model
|
|
├── .env.example # Required environment variables
|
|
├── .gitignore # Ignore .env and session files
|
|
└── packages.lock.json # Restored lock file for the runner project
|
|
```
|
|
|
|
## Install dependencies
|
|
|
|
### Python (dashboard tests)
|
|
|
|
```bash
|
|
python -m venv .venv
|
|
source .venv/bin/activate # Windows: .venv\Scripts\activate
|
|
pip install -r tests/e2e/requirements.txt
|
|
playwright install chromium
|
|
```
|
|
|
|
### C# runner (MTProto)
|
|
|
|
```bash
|
|
dotnet restore tests/e2e/runner/GmRelay.E2E.Runner.csproj
|
|
```
|
|
|
|
## Run helper tests
|
|
|
|
```bash
|
|
python tests/e2e/helpers/test_telegram_init_data.py
|
|
```
|
|
|
|
## Run Playwright dashboard tests
|
|
|
|
1. Start the Web dashboard (and PostgreSQL) locally. The fastest way:
|
|
```bash
|
|
dotnet run --project src/GmRelay.AppHost/GmRelay.AppHost.csproj
|
|
```
|
|
2. Export environment variables that match the running Web instance:
|
|
```bash
|
|
export GMRELAY_E2E_BASE_URL="http://localhost:8080"
|
|
export GMRELAY_E2E_BOT_TOKEN="<same-token-as-web>"
|
|
export GMRELAY_E2E_TELEGRAM_ID="9000000001"
|
|
export GMRELAY_E2E_DATABASE_URL="Host=localhost;Database=gmrelay;Username=postgres;Password=<password>"
|
|
```
|
|
3. Run the tests:
|
|
```bash
|
|
python tests/e2e/dashboard/test_dashboard_auth_and_sessions.py
|
|
```
|
|
|
|
## Run the MTProto user client runner
|
|
|
|
The runner logs in to a real Telegram user account, creates a supergroup, and invites the test bot.
|
|
|
|
1. Copy the example environment file and fill in real values:
|
|
```bash
|
|
cp tests/e2e/runner/.env.example tests/e2e/runner/.env
|
|
```
|
|
2. Edit `tests/e2e/runner/.env` with your Telegram `api_id`, `api_hash`, `phone_number`, the bot username/token, and Web URL.
|
|
3. Run:
|
|
```bash
|
|
dotnet run --project tests/e2e/runner/GmRelay.E2E.Runner.csproj
|
|
```
|
|
|
|
**Security notes:**
|
|
- Never commit `.env` or `*.session` files.
|
|
- Use a dedicated test Telegram account, never your personal or production account.
|
|
- The first run will prompt for the Telegram verification code (sent to the phone number).
|
|
- Subsequent runs reuse the persisted `.session` file.
|
|
|
|
## What the dashboard tests cover
|
|
|
|
- `test_dashboard_authenticates_and_shows_groups`
|
|
Builds a valid Mini App initData payload, posts it to `/auth/telegram-webapp`, and verifies that the Blazor home page renders the authenticated greeting.
|
|
- `test_dashboard_session_edit_flow`
|
|
Seeds a player, group, and session directly in PostgreSQL, opens the group details page, clicks through to the session editor, changes the title, and asserts the updated title appears on the page.
|
|
|
|
## What the MTProto runner currently covers
|
|
|
|
- Login as a Telegram user.
|
|
- Create a supergroup (`Channels_CreateChannel` with `megagroup: true`).
|
|
- Resolve a bot by username and invite it to the group.
|
|
- Send messages/commands and read recent messages.
|
|
- Wait for a bot reply.
|
|
|
|
## Notes
|
|
|
|
- Authentication is mocked using `helpers/telegram_init_data.py`, which mirrors `GmRelay.Shared.Telegram.TelegramAuthPayloadBuilder`.
|
|
- The Web instance validates HMAC-SHA256 with the same bot token, so the test payload is indistinguishable from a real Telegram Mini App payload.
|
|
- The runner project is intentionally **not** included in `GM-Relay.slnx` so it does not participate in CI builds or Native AOT trimming.
|
|
- For headful debugging, change `headless=True` to `headless=False` in the dashboard test file.
|