Compare commits
24 Commits
v1.0.0
...
developmen
| Author | SHA1 | Date | |
|---|---|---|---|
| 4bd84e2c7d | |||
| 7fd2e5e89b | |||
| 8fa5f18d83 | |||
| 21208897b0 | |||
| f80e253401 | |||
| 1447d770c9 | |||
| bec3efcdd0 | |||
| 5e61c838d5 | |||
| 11ee1447de | |||
| 08dee3db99 | |||
| 102814420b | |||
| 55971496c8 | |||
| 135d596119 | |||
| 205c8eb9b7 | |||
| f5528dcc9c | |||
| ce77639a47 | |||
| ce4887bae3 | |||
| ca9e88f1e2 | |||
| 4b400fea1f | |||
| 4260948c1c | |||
| cbb951d121 | |||
| a546540c45 | |||
| 174c27c933 | |||
| 1f7f211e36 |
400
.gitea/workflows/ci-cd.yml
Normal file
400
.gitea/workflows/ci-cd.yml
Normal file
@@ -0,0 +1,400 @@
|
||||
name: CI/CD Pipeline
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main, development, experimental ]
|
||||
tags: [ 'v*.*.*' ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
skip_tests:
|
||||
description: 'Skip tests'
|
||||
required: false
|
||||
default: 'false'
|
||||
type: boolean
|
||||
image_tag:
|
||||
description: 'Custom tag for Docker image'
|
||||
required: false
|
||||
default: 'latest'
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
# ==========================================
|
||||
# TESTING STAGE
|
||||
# ==========================================
|
||||
|
||||
unit-tests:
|
||||
name: Unit Tests (Python ${{ matrix.python-version }})
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ !inputs.skip_tests }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
python-version: ['3.9', '3.10', '3.11']
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
- name: Cache pip dependencies
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: ~/.cache/pip
|
||||
key: ${{ runner.os }}-py${{ matrix.python-version }}-pip-${{ hashFiles('requirements.txt', 'requirements-test.txt') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-py${{ matrix.python-version }}-pip-
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip setuptools wheel
|
||||
pip install -r requirements.txt
|
||||
pip install -r requirements-test.txt
|
||||
|
||||
- name: Create test configuration
|
||||
run: |
|
||||
mkdir -p embed logs
|
||||
cat > config.ini << EOF
|
||||
[Pterodactyl]
|
||||
PanelURL = https://panel.example.com
|
||||
ClientAPIKey = ptlc_test_client_key_123456789
|
||||
ApplicationAPIKey = ptla_test_app_key_987654321
|
||||
|
||||
[Discord]
|
||||
Token = test_discord_token_placeholder
|
||||
AllowedGuildID = 123456789
|
||||
EOF
|
||||
|
||||
- name: Run unit tests with coverage
|
||||
run: |
|
||||
pytest test_pterodisbot.py \
|
||||
-v \
|
||||
--tb=short \
|
||||
--cov=pterodisbot \
|
||||
--cov=server_metrics_graphs \
|
||||
--cov-report=xml \
|
||||
--cov-report=term \
|
||||
--cov-report=html \
|
||||
--junitxml=test-results-${{ matrix.python-version }}.xml
|
||||
|
||||
- name: Upload coverage to artifacts
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: coverage-report-py${{ matrix.python-version }}
|
||||
path: |
|
||||
coverage.xml
|
||||
htmlcov/
|
||||
test-results-${{ matrix.python-version }}.xml
|
||||
|
||||
code-quality:
|
||||
name: Code Quality & Linting
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ !inputs.skip_tests }}
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.11'
|
||||
|
||||
- name: Install linting tools
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install flake8 pylint black isort mypy
|
||||
|
||||
- name: Run flake8
|
||||
run: |
|
||||
flake8 pterodisbot.py server_metrics_graphs.py \
|
||||
--max-line-length=140 \
|
||||
--ignore=E501,W503,E203 \
|
||||
--exclude=venv,__pycache__,build,dist \
|
||||
--statistics \
|
||||
--output-file=flake8-report.txt
|
||||
continue-on-error: true
|
||||
|
||||
- name: Run pylint
|
||||
run: |
|
||||
pylint pterodisbot.py server_metrics_graphs.py \
|
||||
--disable=C0111,C0103,R0913,R0914,R0915,W0718 \
|
||||
--max-line-length=140 \
|
||||
--output-format=text \
|
||||
--reports=y > pylint-report.txt || true
|
||||
continue-on-error: true
|
||||
|
||||
- name: Check code formatting with black
|
||||
run: |
|
||||
black --check --line-length=140 --diff pterodisbot.py server_metrics_graphs.py | tee black-report.txt
|
||||
continue-on-error: true
|
||||
|
||||
- name: Check import ordering
|
||||
run: |
|
||||
isort --check-only --profile black --line-length=140 pterodisbot.py server_metrics_graphs.py
|
||||
continue-on-error: true
|
||||
|
||||
- name: Type checking with mypy
|
||||
run: |
|
||||
mypy pterodisbot.py server_metrics_graphs.py --ignore-missing-imports > mypy-report.txt || true
|
||||
continue-on-error: true
|
||||
|
||||
- name: Upload linting reports
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: code-quality-reports
|
||||
path: |
|
||||
flake8-report.txt
|
||||
pylint-report.txt
|
||||
black-report.txt
|
||||
mypy-report.txt
|
||||
|
||||
security-scan:
|
||||
name: Security Scanning
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ !inputs.skip_tests }}
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.11'
|
||||
|
||||
- name: Install security tools
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install bandit safety pip-audit
|
||||
|
||||
- name: Run bandit security scan
|
||||
run: |
|
||||
bandit -r . \
|
||||
-f json \
|
||||
-o bandit-report.json \
|
||||
-ll \
|
||||
--exclude ./venv,./test_*.py,./tests
|
||||
continue-on-error: true
|
||||
|
||||
- name: Run safety dependency check
|
||||
run: |
|
||||
pip install -r requirements.txt
|
||||
safety check --json --output safety-report.json || true
|
||||
continue-on-error: true
|
||||
|
||||
- name: Run pip-audit
|
||||
run: |
|
||||
pip-audit --desc --format json --output pip-audit-report.json || true
|
||||
continue-on-error: true
|
||||
|
||||
- name: Upload security reports
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: security-reports
|
||||
path: |
|
||||
bandit-report.json
|
||||
safety-report.json
|
||||
pip-audit-report.json
|
||||
|
||||
integration-tests:
|
||||
name: Integration Tests
|
||||
runs-on: ubuntu-latest
|
||||
needs: [unit-tests]
|
||||
if: ${{ !inputs.skip_tests }}
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.11'
|
||||
|
||||
- name: Cache dependencies
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: ~/.cache/pip
|
||||
key: ${{ runner.os }}-pip-integration-${{ hashFiles('requirements.txt') }}
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install -r requirements.txt
|
||||
pip install -r requirements-test.txt
|
||||
|
||||
- name: Create test configuration
|
||||
run: |
|
||||
mkdir -p embed logs
|
||||
cat > config.ini << EOF
|
||||
[Pterodactyl]
|
||||
PanelURL = https://panel.example.com
|
||||
ClientAPIKey = ptlc_test_client_key_123456789
|
||||
ApplicationAPIKey = ptla_test_app_key_987654321
|
||||
|
||||
[Discord]
|
||||
Token = test_discord_token_placeholder
|
||||
AllowedGuildID = 123456789
|
||||
EOF
|
||||
|
||||
- name: Run integration tests
|
||||
run: |
|
||||
pytest test_pterodisbot.py::TestIntegration \
|
||||
-v \
|
||||
--tb=short \
|
||||
--timeout=60
|
||||
|
||||
# ==========================================
|
||||
# BUILD STAGE
|
||||
# ==========================================
|
||||
|
||||
docker-build:
|
||||
name: Build Docker Image
|
||||
runs-on: ubuntu-latest
|
||||
needs: [unit-tests, code-quality, security-scan]
|
||||
if: |
|
||||
always() &&
|
||||
(needs.unit-tests.result == 'success' || inputs.skip_tests) &&
|
||||
(github.event_name == 'push' || github.event_name == 'workflow_dispatch')
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v2
|
||||
with:
|
||||
platforms: arm64
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v2
|
||||
with:
|
||||
platforms: linux/amd64,linux/arm64
|
||||
driver-opts: |
|
||||
image=moby/buildkit:latest
|
||||
|
||||
- name: Log in to registry
|
||||
uses: docker/login-action@v2
|
||||
with:
|
||||
registry: ${{ vars.REGISTRY }}
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- name: Generate Docker image tags
|
||||
id: tags
|
||||
run: |
|
||||
IMAGE_NAME="${{ vars.REGISTRY }}/${{ github.repository_owner }}/${{ vars.IMAGE_NAME }}"
|
||||
|
||||
if [ -n "${{ github.event.inputs.image_tag }}" ]; then
|
||||
PRIMARY_TAG="${{ github.event.inputs.image_tag }}"
|
||||
elif [[ ${{ github.ref }} == refs/tags/v* ]]; then
|
||||
PRIMARY_TAG="${GITHUB_REF#refs/tags/}"
|
||||
elif [[ ${{ github.ref }} == refs/heads/main ]]; then
|
||||
PRIMARY_TAG="latest"
|
||||
elif [[ ${{ github.ref }} == refs/heads/development ]]; then
|
||||
PRIMARY_TAG="development"
|
||||
elif [[ ${{ github.ref }} == refs/heads/experimental ]]; then
|
||||
PRIMARY_TAG="experimental"
|
||||
else
|
||||
PRIMARY_TAG="latest"
|
||||
fi
|
||||
|
||||
TAGS="$IMAGE_NAME:$PRIMARY_TAG,$IMAGE_NAME:${{ github.sha }}"
|
||||
|
||||
if [[ ${{ github.ref }} == refs/tags/v* ]]; then
|
||||
MAJOR_MINOR_TAG=$(echo "$PRIMARY_TAG" | sed -E 's/^v([0-9]+\.[0-9]+)\.[0-9]+.*$/v\1/')
|
||||
if [[ "$MAJOR_MINOR_TAG" != "$PRIMARY_TAG" ]]; then
|
||||
TAGS="$TAGS,$IMAGE_NAME:$MAJOR_MINOR_TAG"
|
||||
fi
|
||||
|
||||
MAJOR_TAG=$(echo "$PRIMARY_TAG" | sed -E 's/^v([0-9]+)\.[0-9]+\.[0-9]+.*$/v\1/')
|
||||
if [[ "$MAJOR_TAG" != "$PRIMARY_TAG" ]]; then
|
||||
TAGS="$TAGS,$IMAGE_NAME:$MAJOR_TAG"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "tags=$TAGS" >> $GITHUB_OUTPUT
|
||||
echo "Generated tags: $TAGS"
|
||||
|
||||
- name: Build and push multi-arch image
|
||||
uses: docker/build-push-action@v4
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
cache-from: type=registry,ref=${{ vars.REGISTRY }}/${{ github.repository_owner }}/${{ vars.IMAGE_NAME }}:cache
|
||||
cache-to: type=registry,ref=${{ vars.REGISTRY }}/${{ github.repository_owner }}/${{ vars.IMAGE_NAME }}:cache,mode=max
|
||||
tags: ${{ steps.tags.outputs.tags }}
|
||||
labels: |
|
||||
org.opencontainers.image.source=${{ github.server_url }}/${{ github.repository }}
|
||||
org.opencontainers.image.revision=${{ github.sha }}
|
||||
org.opencontainers.image.created=${{ github.event.head_commit.timestamp }}
|
||||
|
||||
# ==========================================
|
||||
# REPORTING STAGE
|
||||
# ==========================================
|
||||
|
||||
test-report:
|
||||
name: Generate Test Report
|
||||
runs-on: ubuntu-latest
|
||||
needs: [unit-tests, code-quality, security-scan, integration-tests]
|
||||
if: always() && !inputs.skip_tests
|
||||
|
||||
steps:
|
||||
- name: Download all artifacts
|
||||
uses: actions/download-artifact@v3
|
||||
|
||||
- name: Generate test summary
|
||||
run: |
|
||||
echo "## 🧪 Test Results Summary" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "### Job Status:" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- ✅ Unit Tests: \`${{ needs.unit-tests.result }}\`" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- 🎨 Code Quality: \`${{ needs.code-quality.result }}\`" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- 🔒 Security Scan: \`${{ needs.security-scan.result }}\`" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- 🔗 Integration Tests: \`${{ needs.integration-tests.result }}\`" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "### Artifacts Generated:" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- Coverage reports (HTML & XML)" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- Code quality reports (flake8, pylint, black)" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- Security scan reports (bandit, safety)" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**Commit:** \`${{ github.sha }}\`" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**Branch:** \`${{ github.ref_name }}\`" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**Triggered by:** ${{ github.actor }}" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
final-status:
|
||||
name: CI/CD Pipeline Status
|
||||
runs-on: ubuntu-latest
|
||||
needs: [test-report, docker-build]
|
||||
if: always()
|
||||
|
||||
steps:
|
||||
- name: Check pipeline status
|
||||
run: |
|
||||
echo "## 🚀 CI/CD Pipeline Complete" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
if [[ "${{ needs.docker-build.result }}" == "success" ]]; then
|
||||
echo "✅ **Docker image built and pushed successfully**" >> $GITHUB_STEP_SUMMARY
|
||||
elif [[ "${{ needs.docker-build.result }}" == "skipped" ]]; then
|
||||
echo "⏭️ **Docker build skipped**" >> $GITHUB_STEP_SUMMARY
|
||||
else
|
||||
echo "❌ **Docker build failed**" >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**Pipeline run:** ${{ github.run_number }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**Workflow:** ${{ github.workflow }}" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
- name: Fail if critical jobs failed
|
||||
if: |
|
||||
(needs.unit-tests.result == 'failure' && !inputs.skip_tests) ||
|
||||
needs.docker-build.result == 'failure'
|
||||
run: exit 1
|
||||
@@ -1,89 +0,0 @@
|
||||
name: Docker Build and Push (Multi-architecture)
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main, experimental ]
|
||||
tags: [ 'v*.*.*' ]
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
image_tag:
|
||||
description: 'Custom tag for the Docker image'
|
||||
required: true
|
||||
default: 'latest'
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
build-and-push:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v2
|
||||
with:
|
||||
platforms: arm64
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v2
|
||||
with:
|
||||
platforms: linux/amd64,linux/arm64
|
||||
driver-opts: |
|
||||
image=moby/buildkit:latest
|
||||
|
||||
- name: Log in to registry
|
||||
uses: docker/login-action@v2
|
||||
with:
|
||||
registry: ${{ vars.REGISTRY }}
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- name: Generate Docker image tags
|
||||
id: tags
|
||||
run: |
|
||||
# Base image name
|
||||
IMAGE_NAME="${{ vars.REGISTRY }}/${{ github.repository_owner }}/${{ vars.IMAGE_NAME }}"
|
||||
|
||||
# Determine primary tag
|
||||
if [ -n "${{ github.event.inputs.image_tag }}" ]; then
|
||||
PRIMARY_TAG="${{ github.event.inputs.image_tag }}"
|
||||
elif [[ ${{ github.ref }} == refs/tags/v* ]]; then
|
||||
PRIMARY_TAG="${GITHUB_REF#refs/tags/}"
|
||||
elif [[ ${{ github.ref }} == refs/heads/main ]]; then
|
||||
PRIMARY_TAG="latest"
|
||||
elif [[ ${{ github.ref }} == refs/heads/experimental ]]; then
|
||||
PRIMARY_TAG="experimental"
|
||||
else
|
||||
PRIMARY_TAG="latest"
|
||||
fi
|
||||
|
||||
# Start with primary tag and SHA tag
|
||||
TAGS="$IMAGE_NAME:$PRIMARY_TAG,$IMAGE_NAME:${{ github.sha }}"
|
||||
|
||||
# Add version tags for releases
|
||||
if [[ ${{ github.ref }} == refs/tags/v* ]]; then
|
||||
# Add major.minor tag (e.g., v1.2 for v1.2.3)
|
||||
MAJOR_MINOR_TAG=$(echo "$PRIMARY_TAG" | sed -E 's/^v([0-9]+\.[0-9]+)\.[0-9]+.*$/v\1/')
|
||||
if [[ "$MAJOR_MINOR_TAG" != "$PRIMARY_TAG" ]]; then
|
||||
TAGS="$TAGS,$IMAGE_NAME:$MAJOR_MINOR_TAG"
|
||||
fi
|
||||
|
||||
# Add major tag (e.g., v1 for v1.2.3)
|
||||
MAJOR_TAG=$(echo "$PRIMARY_TAG" | sed -E 's/^v([0-9]+)\.[0-9]+\.[0-9]+.*$/v\1/')
|
||||
if [[ "$MAJOR_TAG" != "$PRIMARY_TAG" ]]; then
|
||||
TAGS="$TAGS,$IMAGE_NAME:$MAJOR_TAG"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "tags=$TAGS" >> $GITHUB_OUTPUT
|
||||
echo "Generated tags: $TAGS"
|
||||
|
||||
- name: Build and push multi-arch image
|
||||
uses: docker/build-push-action@v4
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
cache-from: type=registry,ref=${{ vars.REGISTRY }}/${{ github.repository_owner }}/${{ vars.IMAGE_NAME }}:cache
|
||||
cache-to: type=registry,ref=${{ vars.REGISTRY }}/${{ github.repository_owner }}/${{ vars.IMAGE_NAME }}:cache,mode=max
|
||||
tags: ${{ steps.tags.outputs.tags }}
|
||||
76
.gitignore
vendored
76
.gitignore
vendored
@@ -4,6 +4,14 @@ __pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# IDEs
|
||||
.vscode/
|
||||
.idea/
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
.DS_Store
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
@@ -37,20 +45,33 @@ MANIFEST
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.nox/
|
||||
# Testing
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
*.so
|
||||
.pytest_cache/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
htmlcov/
|
||||
coverage.xml
|
||||
*.cover
|
||||
*.py,cover
|
||||
.hypothesis/
|
||||
.pytest_cache/
|
||||
cover/
|
||||
.tox/
|
||||
.nox/
|
||||
|
||||
# Test reports
|
||||
test-results*.xml
|
||||
junit*.xml
|
||||
*-report.txt
|
||||
*-report.json
|
||||
bandit-report.json
|
||||
safety-report.json
|
||||
pip-audit-report.json
|
||||
flake8-report.txt
|
||||
pylint-report.txt
|
||||
black-report.txt
|
||||
mypy-report.txt
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
@@ -83,37 +104,7 @@ target/
|
||||
profile_default/
|
||||
ipython_config.py
|
||||
|
||||
# pyenv
|
||||
# For a library or package, you might want to ignore these files since the code is
|
||||
# intended to run in multiple environments; otherwise, check them in:
|
||||
# .python-version
|
||||
|
||||
# pipenv
|
||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
||||
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
||||
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
||||
# install all needed dependencies.
|
||||
#Pipfile.lock
|
||||
|
||||
# UV
|
||||
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
||||
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
||||
# commonly ignored for libraries.
|
||||
#uv.lock
|
||||
|
||||
# poetry
|
||||
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
||||
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
||||
# commonly ignored for libraries.
|
||||
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
||||
#poetry.lock
|
||||
|
||||
# pdm
|
||||
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
||||
#pdm.lock
|
||||
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
||||
# in version control.
|
||||
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
|
||||
.pdm.toml
|
||||
.pdm-python
|
||||
.pdm-build/
|
||||
@@ -161,13 +152,6 @@ dmypy.json
|
||||
# Cython debug symbols
|
||||
cython_debug/
|
||||
|
||||
# PyCharm
|
||||
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
||||
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
||||
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
||||
#.idea/
|
||||
|
||||
# Ruff stuff:
|
||||
.ruff_cache/
|
||||
|
||||
|
||||
457
README.md
457
README.md
@@ -6,8 +6,8 @@ A feature-rich Discord bot for monitoring and managing Pterodactyl game servers
|
||||
|
||||
## Table of Contents
|
||||
- [Features](#features)
|
||||
- [Architecture Overview](#architecture-overview)
|
||||
- [Installation](#installation)
|
||||
- [Discord Bot Setup](#discord-bot-setup)
|
||||
- [Traditional Installation](#traditional-installation)
|
||||
- [Docker Installation](#docker-installation)
|
||||
- [Configuration](#configuration)
|
||||
@@ -20,52 +20,154 @@ A feature-rich Discord bot for monitoring and managing Pterodactyl game servers
|
||||
- [Permissions](#permissions)
|
||||
- [Logging System](#logging-system)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Development](#development)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
|
||||
## Features
|
||||
|
||||
### Core Functionality
|
||||
- **Real-time Server Monitoring**: Auto-updating embeds showing server status (online/offline) and detailed resource usage
|
||||
- **Power Management**: Start, stop, and restart servers directly from Discord with button controls
|
||||
- **Connection Information**: One-click display of server addresses and ports
|
||||
- **Multi-channel Support**: Status embeds can be placed in any channel with proper permissions
|
||||
### 🎮 Server Management
|
||||
- **Interactive Server Selection**: Choose servers from an intuitive dropdown menu showing all available game servers
|
||||
- **Real-time Power Controls**: Start, stop, and restart servers with color-coded button controls
|
||||
- 🟢 Green Start button
|
||||
- 🔴 Red Stop button
|
||||
- 🔵 Blue Restart button
|
||||
- **Connection Information**: Instantly view server IP addresses and ports with the "Show Address" button
|
||||
- **Multi-channel Embeds**: Deploy server status displays across any channels where the bot has permissions
|
||||
|
||||
### Intelligent Updates
|
||||
- **State Change Detection**: Embeds update immediately when server power state changes
|
||||
- **Resource Thresholds**: CPU usage changes >50% trigger updates
|
||||
- **Optimized API Calls**: Minimizes requests to the Discord API
|
||||
### 📊 Server Monitoring
|
||||
- **Live Status Tracking**: Auto-updating embeds display current server state (online/offline/starting)
|
||||
- **Resource Usage Metrics**: Detailed monitoring of:
|
||||
- CPU usage with dynamic scaling for multi-core servers
|
||||
- Memory consumption in real-time
|
||||
- Disk space utilization
|
||||
- Network activity (incoming/outgoing traffic)
|
||||
- Server uptime counter with human-readable formatting
|
||||
- **Visual Metrics Graphs**:
|
||||
- Combined CPU and memory usage graphs over the last minute
|
||||
- 6 data points captured at 10-second intervals
|
||||
- Discord dark theme-optimized styling
|
||||
- Automatic graph generation and embedding for running servers
|
||||
- Dynamic CPU scaling (100% increments) for accurate multi-vCPU visualization
|
||||
- Trend indicators (increasing/decreasing/stable) for quick status assessment
|
||||
|
||||
### Access Control
|
||||
- **Guild Restriction**: Operates only in specified Discord server
|
||||
- **Role-based Permissions**: "Game Server User" role required for interactions
|
||||
- **Admin Commands**: Special commands restricted to server administrators
|
||||
### 🔄 Intelligent Update System
|
||||
- **Smart Update Triggers**: Embeds refresh automatically when:
|
||||
- Server power state changes (offline ↔ starting ↔ running)
|
||||
- CPU usage shifts by more than 50%
|
||||
- Server is detected for the first time
|
||||
- Running servers reach 10-minute intervals (for uptime accuracy)
|
||||
- **Rate Limit Protection**: Built-in delays prevent Discord API throttling
|
||||
- **Optimized API Calls**: Minimizes unnecessary requests through change detection
|
||||
- **Background Task Management**: Asynchronous update loop runs every 10 seconds
|
||||
|
||||
### Reliability Features
|
||||
- **Persistent Storage**: Remembers embed locations between bot restarts
|
||||
- **Error Handling**: Comprehensive error recovery and logging
|
||||
- **Rate Limit Protection**: Built-in delays between API calls
|
||||
### 🔒 Security & Access Control
|
||||
- **Single-Guild Restriction**: Bot operates exclusively in your designated Discord server
|
||||
- **Role-based Permissions**: "Game Server User" role required for all server interactions
|
||||
- **Administrator Commands**: Special management commands restricted to server administrators
|
||||
- **Interaction Validation**: Every button press and command verified for proper authorization
|
||||
|
||||
## Architecture Overview
|
||||
### 💾 Data Persistence
|
||||
- **Embed Location Storage**: Automatically remembers where embeds are posted (survives bot restarts)
|
||||
- **JSON-based Storage**: Human-readable embed tracking in `embed_locations.json`
|
||||
- **Metrics History**: Maintains 1 minute of server metrics data (6 data points per server)
|
||||
- **Automatic Cleanup**: Removes tracking for deleted embeds and inactive servers
|
||||
|
||||
The bot is built with several key components:
|
||||
### 🛡️ Reliability Features
|
||||
- **Comprehensive Error Handling**: Graceful recovery from API failures and network issues
|
||||
- **Rotating Log Files**: Automatic log rotation (5MB max, 3 backup files)
|
||||
- **Debug-level Logging**: Detailed operation logs for troubleshooting
|
||||
- **Graceful Shutdown**: Proper cleanup on SIGINT/SIGTERM signals (Docker-friendly)
|
||||
- **Configuration Validation**: Startup verification of all required settings
|
||||
- **API Key Validation**: Checks for correct Pterodactyl API key formats
|
||||
|
||||
1. **PterodactylAPI Class**: Handles all communication with the Pterodactyl Panel API
|
||||
2. **ServerStatusView Class**: Manages the interactive Discord UI with control buttons
|
||||
3. **PterodactylBot Class**: Main bot class that orchestrates all operations
|
||||
4. **Background Task**: Regularly checks server status and updates embeds when needed
|
||||
5. **Configuration System**: Validates and manages all settings from config.ini
|
||||
### 🎨 User Interface
|
||||
- **Color-coded Status**: Visual indicators for server states
|
||||
- 🔵 Blue for online servers
|
||||
- 🔴 Red for offline servers
|
||||
- **Ephemeral Interactions**: Private responses visible only to command users
|
||||
- **Real-time Feedback**: Instant confirmation messages for all actions
|
||||
- **Persistent Controls**: Server control buttons remain functional indefinitely
|
||||
- **Responsive Design**: Clean, Discord-optimized embed layouts
|
||||
|
||||
The system uses aiohttp for asynchronous HTTP requests and discord.py for Discord interactions.
|
||||
### 🔧 Administrator Tools
|
||||
- **Bulk Embed Refresh**: Force-refresh all server status embeds with one command
|
||||
- **Complete Purge System**: Remove all bot embeds from the server with detailed statistics
|
||||
- **Progress Tracking**: Real-time progress updates during multi-embed operations
|
||||
- **Comprehensive Logging**: All administrative actions logged with user attribution
|
||||
|
||||
## Installation
|
||||
|
||||
### Discord Bot Setup
|
||||
|
||||
Before installing the bot software, you need to create a Discord application and bot account.
|
||||
|
||||
#### 1. Create Discord Application
|
||||
|
||||
1. Navigate to the [Discord Developer Portal](https://discord.com/developers/applications)
|
||||
2. Click the **"New Application"** button in the top-right corner
|
||||
3. Enter a name for your application (e.g., "Pterodactyl Bot")
|
||||
4. Accept the Terms of Service and click **"Create"**
|
||||
|
||||
#### 2. Configure Bot Settings
|
||||
|
||||
1. In the left sidebar, click on **"Bot"**
|
||||
2. Click **"Add Bot"** and confirm by clicking **"Yes, do it!"**
|
||||
3. Under the bot's username, you'll see a **Token** section:
|
||||
- Click **"Reset Token"** and then **"Copy"** to get your bot token
|
||||
- ⚠️ **Keep this token secret!** Never share it publicly or commit it to version control
|
||||
4. Scroll down to **"Privileged Gateway Intents"** and enable:
|
||||
- ✅ **Message Content Intent** (required for the bot to read message content)
|
||||
5. Click **"Save Changes"** at the bottom
|
||||
|
||||
#### 3. Set Bot Permissions
|
||||
|
||||
1. In the left sidebar, click on **"OAuth2"** → **"URL Generator"**
|
||||
2. Under **"Scopes"**, select:
|
||||
- ✅ `bot`
|
||||
- ✅ `applications.commands`
|
||||
3. Under **"Bot Permissions"**, select:
|
||||
- ✅ **View Channels** (allows bot to see channels)
|
||||
- ✅ **Send Messages** (allows bot to post embeds)
|
||||
- ✅ **Embed Links** (required for rich embeds)
|
||||
- ✅ **Attach Files** (required for metrics graphs)
|
||||
- ✅ **Read Message History** (allows bot to edit existing messages)
|
||||
- ✅ **Use Slash Commands** (required for `/server_status` commands)
|
||||
|
||||
#### 4. Invite Bot to Your Server
|
||||
|
||||
1. Copy the **Generated URL** at the bottom of the OAuth2 URL Generator page
|
||||
2. Paste this URL into your browser and press Enter
|
||||
3. Select the Discord server where you want to add the bot
|
||||
4. Click **"Authorize"** and complete the CAPTCHA if prompted
|
||||
5. The bot should now appear in your server (offline until you start the application)
|
||||
|
||||
#### 5. Get Your Guild ID
|
||||
|
||||
1. In Discord, enable **Developer Mode**:
|
||||
- Click the ⚙️ gear icon (User Settings)
|
||||
- Navigate to **"Advanced"** under "App Settings"
|
||||
- Toggle on **"Developer Mode"**
|
||||
2. Right-click on your server icon in the left sidebar
|
||||
3. Click **"Copy Server ID"** at the bottom of the menu
|
||||
4. Save this ID - you'll need it for the bot configuration
|
||||
|
||||
#### 6. Create Server Role
|
||||
|
||||
1. In your Discord server, click the server name at the top to open the dropdown menu
|
||||
2. Select **"Server Settings"** → **"Roles"**
|
||||
3. Click **"Create Role"**
|
||||
4. Name the role exactly: `Game Server User`
|
||||
5. The role doesn't need any special permissions - it's only used for bot access control
|
||||
6. Click **"Save Changes"**
|
||||
7. Assign this role to any users who should be able to control game servers
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Python 3.8 or higher **or** Docker
|
||||
- Discord bot token with proper permissions
|
||||
- Discord bot token (from setup above)
|
||||
- Discord server (guild) ID (from setup above)
|
||||
- Pterodactyl panel with API access
|
||||
- Server with both Client and Application API keys
|
||||
- Pterodactyl Client API key (starts with `ptlc_`)
|
||||
- Pterodactyl Application API key (starts with `ptla_`)
|
||||
|
||||
### Traditional Installation
|
||||
|
||||
@@ -121,13 +223,13 @@ The system uses aiohttp for asynchronous HTTP requests and discord.py for Discor
|
||||
pterodisbot:
|
||||
build: .
|
||||
environment:
|
||||
# Remmove brackets and spaces in environment variables
|
||||
# Remove brackets and spaces in environment variables
|
||||
# Ideally, use .env file to assign values to these instead
|
||||
- DISCORD_TOKEN={Your Discord bot token}
|
||||
- ALLOWED_GUILD_ID={The Discord server ID where the bot should operate}
|
||||
- PANEL_URL={Your Pterodactyl panel URL (must include http:// or https://)}
|
||||
- CLIENT_API_KEY={Pterodactyl client API key (starts with `ptlc_`)}
|
||||
- APPLICATION_API_KEY={Pterodactyl application API key (starts with `ptla_`)}
|
||||
- DISCORD_TOKEN={Your Discord bot token from Developer Portal}
|
||||
- ALLOWED_GUILD_ID={Your Discord server ID from step 5 above}
|
||||
- PANEL_URL={Your Pterodactyl panel URL with https://}
|
||||
- CLIENT_API_KEY={Pterodactyl client API key starting with ptlc_}
|
||||
- APPLICATION_API_KEY={Pterodactyl application API key starting with ptla_}
|
||||
volumes:
|
||||
- bot_logs:/app/logs
|
||||
- bot_embed:/app/embed
|
||||
@@ -148,7 +250,7 @@ The system uses aiohttp for asynchronous HTTP requests and discord.py for Discor
|
||||
|
||||
When using Docker or generating the config automatically, these environment variables are required:
|
||||
|
||||
- `DISCORD_TOKEN`: Your Discord bot token
|
||||
- `DISCORD_TOKEN`: Your Discord bot token (from Discord Developer Portal)
|
||||
- `ALLOWED_GUILD_ID`: The Discord server ID where the bot should operate
|
||||
- `PANEL_URL`: Your Pterodactyl panel URL (must include http:// or https://)
|
||||
- `CLIENT_API_KEY`: Pterodactyl client API key (starts with `ptlc_`)
|
||||
@@ -178,142 +280,251 @@ python generate_config.py
|
||||
|
||||
### First Run Setup
|
||||
|
||||
1. Invite your bot to your Discord server with these permissions:
|
||||
- View Channels
|
||||
- Send Messages
|
||||
- Embed Links
|
||||
- Manage Messages (for embed updates)
|
||||
- Use Slash Commands
|
||||
1. Ensure your bot is invited to your Discord server with proper permissions (see [Discord Bot Setup](#discord-bot-setup))
|
||||
|
||||
2. Create a "Game Server User" role for users who should control servers
|
||||
2. Verify the "Game Server User" role exists in your server
|
||||
|
||||
3. Use the `/server_status` command to create your first status embed
|
||||
3. Start the bot using your preferred installation method
|
||||
|
||||
4. The bot should appear online in your server
|
||||
|
||||
5. Use the `/server_status` command to create your first status embed
|
||||
|
||||
### Bot Commands
|
||||
|
||||
#### `/server_status`
|
||||
Display an interactive context menu containing all available servers which can be selected to create an embed for a given server.
|
||||
Display an interactive dropdown menu containing all available servers from your Pterodactyl panel. Select a server to create a permanent status embed in the current channel with real-time monitoring and control buttons.
|
||||
|
||||
**Features:**
|
||||
- Shows total server count and online/offline statistics
|
||||
- Lists all servers with descriptions
|
||||
- Creates persistent, auto-updating embeds
|
||||
- Automatically removes old embeds when recreating for the same server
|
||||
|
||||
#### `/refresh_embeds` (Admin only)
|
||||
Force a refresh of all server status embeds. This is useful if embeds become out of sync.
|
||||
Force a complete refresh of all server status embeds. This command:
|
||||
- Recreates all tracked embeds with fresh data
|
||||
- Deletes old embed messages to prevent duplication
|
||||
- Updates embed tracking storage
|
||||
- Provides statistics on deleted and created embeds
|
||||
|
||||
**Use cases:**
|
||||
- Embeds appear out of sync with actual server states
|
||||
- After bot configuration changes
|
||||
- Following Discord API issues
|
||||
|
||||
#### `/purge_embeds` (Admin only)
|
||||
Delete all embeds from the Discord guild.
|
||||
Permanently delete all server status embeds from the Discord server. This command:
|
||||
- Removes all tracked embed messages
|
||||
- Clears the embed tracking file
|
||||
- Provides real-time progress updates
|
||||
- Shows detailed statistics (deleted, missing, errors)
|
||||
|
||||
**Use cases:**
|
||||
- Starting fresh with new embed layout
|
||||
- Removing bot from server
|
||||
- Cleaning up after testing
|
||||
|
||||
### Embed System
|
||||
|
||||
Status embeds include:
|
||||
- Server name and current state (color-coded)
|
||||
- Resource usage (when online):
|
||||
- CPU percentage
|
||||
- Memory usage
|
||||
- Disk usage
|
||||
- Network activity
|
||||
- Interactive buttons:
|
||||
- Start (green)
|
||||
- Stop (red)
|
||||
- Restart (blue)
|
||||
- Show Address (grey)
|
||||
Status embeds dynamically display:
|
||||
|
||||
Embed locations are stored in `embed_locations.json` and persist between bot restarts.
|
||||
**Header Information:**
|
||||
- Server name with current state (color-coded)
|
||||
- Server description
|
||||
- Last updated timestamp
|
||||
|
||||
**Status Fields:**
|
||||
- 🆔 Server ID (Pterodactyl identifier)
|
||||
- ℹ️ Status (Active or Suspended)
|
||||
- ⏱️ Uptime (for running servers)
|
||||
|
||||
**Resource Usage (when online):**
|
||||
- CPU percentage with dynamic scaling
|
||||
- Memory usage (current vs. allocated)
|
||||
- Disk usage (current vs. allocated)
|
||||
- Network traffic (incoming/outgoing)
|
||||
|
||||
**Metrics Visualization (when running):**
|
||||
- Combined CPU and memory graph
|
||||
- Last 1 minute of data (6 data points)
|
||||
- Trend indicators
|
||||
- Data point counter
|
||||
|
||||
**Interactive Buttons:**
|
||||
- 🟢 **Start** - Powers on the server
|
||||
- 🔴 **Stop** - Gracefully shuts down the server
|
||||
- 🔵 **Restart** - Reboots the server
|
||||
- ⚪ **Show Address** - Displays connection information (IP:Port)
|
||||
|
||||
**Automatic Updates:**
|
||||
Embeds refresh when server state changes, including:
|
||||
- Power state transitions
|
||||
- Significant resource usage changes
|
||||
- Periodic updates for uptime accuracy
|
||||
|
||||
Embed locations are stored in `embed/embed_locations.json` and persist between bot restarts.
|
||||
|
||||
## Permissions
|
||||
|
||||
The bot implements two levels of access control:
|
||||
|
||||
1. **Guild Restriction**: Only works in the Discord server specified in `AllowedGuildID`
|
||||
2. **Role Requirement**: Users must have the "Game Server User" role to interact with server controls
|
||||
### 1. Guild Restriction
|
||||
The bot only responds to commands and interactions from the Discord server specified in `AllowedGuildID`. This prevents unauthorized use if the bot is accidentally added to other servers.
|
||||
|
||||
Administrators can use the `/refresh_embeds` and `/purge_embeds` command.
|
||||
### 2. Role-Based Access
|
||||
Users must have the **"Game Server User"** role (exact name match) to:
|
||||
- Use server control buttons (Start/Stop/Restart)
|
||||
- View server addresses
|
||||
- Interact with any bot features
|
||||
|
||||
### 3. Administrator Access
|
||||
Server administrators (users with Discord's Administrator permission) can additionally:
|
||||
- Use `/refresh_embeds` command
|
||||
- Use `/purge_embeds` command
|
||||
- No special role required - based on Discord permissions
|
||||
|
||||
**Note:** The `/server_status` command can be used by anyone, but only users with the "Game Server User" role can interact with the resulting embeds.
|
||||
|
||||
## Logging System
|
||||
|
||||
The bot maintains comprehensive logs in two locations:
|
||||
|
||||
1. **File Logs**: Rotating log files (5MB max, 3 backups) in `pterodactyl_bot.log`
|
||||
2. **Console Output**: Real-time logging to stdout
|
||||
### 1. File Logs
|
||||
- **Location**: `logs/pterodisbot.log`
|
||||
- **Rotation**: Automatic rotation when file reaches 5MB
|
||||
- **Backups**: Keeps 3 previous log files (`pterodisbot.log.1`, `.2`, `.3`)
|
||||
- **Format**: `YYYY-MM-DD HH:MM:SS - LEVEL - MESSAGE`
|
||||
|
||||
Log levels:
|
||||
- **DEBUG**: Detailed operational information (API calls, state changes)
|
||||
- **INFO**: General operational messages (bot startup, command usage)
|
||||
- **WARNING**: Potential issues (missing embeds, API warnings)
|
||||
- **ERROR**: Operational failures (API errors, permission issues)
|
||||
- **CRITICAL**: Critical failures (configuration errors, startup failures)
|
||||
### 2. Console Output
|
||||
- **Real-time**: Logs appear in stdout/stderr
|
||||
- **Format**: Same as file logs
|
||||
- **Level**: INFO and above (less verbose than file logs)
|
||||
|
||||
### Log Levels
|
||||
|
||||
- **DEBUG**: Detailed operational information (API calls, state changes, cache operations)
|
||||
- **INFO**: General operational messages (bot startup, command usage, successful operations)
|
||||
- **WARNING**: Potential issues (missing embeds, API warnings, permission issues)
|
||||
- **ERROR**: Operational failures (API errors, Discord API issues, failed operations)
|
||||
- **CRITICAL**: Critical failures (configuration errors, startup failures, unrecoverable errors)
|
||||
|
||||
### Example Log Entries
|
||||
|
||||
```
|
||||
2025-09-29 03:51:13,743 - INFO - Initialized logging system with file and console output
|
||||
2025-09-29 03:51:16,828 - INFO - Starting full refresh of all server embeds
|
||||
2025-09-29 03:51:16,829 - INFO - Bot connected as Petrodisbot (ID: 1419694924458360964)
|
||||
2025-09-29 03:52:10,481 - INFO - Start button pressed for Minecraft Server by username
|
||||
2025-09-29 03:52:14,406 - DEBUG - Power state changed for Minecraft Server: offline -> starting
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Embeds not updating:**
|
||||
- Verify the bot has proper channel permissions
|
||||
- Check API keys have correct permissions
|
||||
- Use `/refresh_embeds` to reset all embeds
|
||||
#### Embeds not updating
|
||||
**Symptoms**: Embeds show outdated information or don't change when server state changes
|
||||
|
||||
**Buttons not working:**
|
||||
- Confirm users have the "Game Server User" role
|
||||
- Ensure the bot has these permissions:
|
||||
**Solutions:**
|
||||
- Verify the bot has proper channel permissions (View Channel, Send Messages, Embed Links)
|
||||
- Check that both API keys are valid and have correct permissions
|
||||
- Review logs for API errors or rate limiting
|
||||
- Use `/refresh_embeds` to force-recreate all embeds
|
||||
- Ensure the bot hasn't been rate-limited by Discord (check logs for HTTP 429 errors)
|
||||
|
||||
#### Buttons not working
|
||||
**Symptoms**: Clicking Start/Stop/Restart buttons shows permission errors
|
||||
|
||||
**Solutions:**
|
||||
- Confirm users have the "Game Server User" role (exact name match)
|
||||
- Verify the role is properly assigned to users
|
||||
- Check bot permissions:
|
||||
- View Channel
|
||||
- Send Messages
|
||||
- Embed Links
|
||||
- Use Slash Commands
|
||||
- Ensure the interaction is happening in the correct Discord server (guild)
|
||||
|
||||
**API errors:**
|
||||
- Double-check your Pterodactyl panel URL
|
||||
#### Commands not appearing
|
||||
**Symptoms**: Slash commands don't show up when typing `/`
|
||||
|
||||
**Solutions:**
|
||||
- Wait 5-10 minutes after bot startup (command sync takes time)
|
||||
- Verify bot has "Use Slash Commands" permission
|
||||
- Check that the bot is in the correct guild (server)
|
||||
- Review logs for command sync errors
|
||||
- Try kicking and re-inviting the bot with proper OAuth2 URL
|
||||
|
||||
#### API errors
|
||||
**Symptoms**: Bot logs show Pterodactyl API failures
|
||||
|
||||
**Solutions:**
|
||||
- Double-check your Pterodactyl panel URL (must include `https://`)
|
||||
- Verify API keys are correct and not expired
|
||||
- Confirm the server exists in Pterodactyl
|
||||
- Confirm the server exists in Pterodactyl panel
|
||||
- Check API key permissions:
|
||||
- Client key needs: server resource access, power control
|
||||
- Application key needs: server list access, server details
|
||||
- Test API keys directly using Pterodactyl API documentation
|
||||
|
||||
#### Graphs not appearing
|
||||
**Symptoms**: Embeds show "Usage Trends" section but no graph image
|
||||
|
||||
**Solutions:**
|
||||
- Wait at least 20 seconds after server starts (needs 2 data points minimum)
|
||||
- Check that the server is in "running" state
|
||||
- Verify matplotlib is installed correctly (`pip install matplotlib`)
|
||||
- Review logs for graph generation errors
|
||||
- Ensure `/tmp/matplotlib` directory has write permissions (Docker)
|
||||
|
||||
#### Bot crashes on startup
|
||||
**Symptoms**: Bot exits immediately with configuration errors
|
||||
|
||||
**Solutions:**
|
||||
- Verify all required fields in `config.ini`:
|
||||
- No empty values
|
||||
- Correct format for all URLs (must include protocol)
|
||||
- API keys have correct prefixes (`ptlc_` and `ptla_`)
|
||||
- Guild ID is a valid integer
|
||||
- Check file permissions on `config.ini`
|
||||
- Review startup logs for specific validation errors
|
||||
- Test configuration validation: `python -c "from pterodisbot import validate_config; validate_config()"`
|
||||
|
||||
### Checking Logs
|
||||
|
||||
For real-time log monitoring:
|
||||
```bash
|
||||
tail -f pterodactyl_bot.log
|
||||
# Traditional installation
|
||||
tail -f logs/pterodisbot.log
|
||||
|
||||
# Docker installation
|
||||
docker logs -f pterodisbot
|
||||
|
||||
# Docker Compose
|
||||
docker-compose logs -f pterodisbot
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
### Requirements
|
||||
- Python 3.8+
|
||||
- Poetry (recommended) or pip
|
||||
|
||||
### Setup
|
||||
1. Clone the repository
|
||||
2. Install dependencies:
|
||||
```bash
|
||||
poetry install
|
||||
```
|
||||
or
|
||||
```bash
|
||||
pip install -r requirements.txt -r requirements-dev.txt
|
||||
```
|
||||
|
||||
3. Create a `.env` file with your development environment variables
|
||||
|
||||
4. Run in development mode:
|
||||
```bash
|
||||
python pterodisbot.py
|
||||
```
|
||||
|
||||
### Testing
|
||||
The project includes unit tests (to be expanded). Run with:
|
||||
For searching logs:
|
||||
```bash
|
||||
pytest
|
||||
# Find all ERROR level messages
|
||||
grep "ERROR" logs/pterodisbot.log
|
||||
|
||||
# Find logs for specific server
|
||||
grep "Server_Name" logs/pterodisbot.log
|
||||
|
||||
# View last 100 lines
|
||||
tail -n 100 logs/pterodisbot.log
|
||||
```
|
||||
|
||||
## Contributing
|
||||
### Getting Help
|
||||
|
||||
Contributions are welcome! Please follow these guidelines:
|
||||
If issues persist after trying these solutions:
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch (`git checkout -b feature/your-feature`)
|
||||
3. Commit your changes (`git commit -am 'Add some feature'`)
|
||||
4. Push to the branch (`git push origin feature/your-feature`)
|
||||
5. Open a pull request
|
||||
|
||||
### Coding Standards
|
||||
- Follow PEP 8 style guidelines
|
||||
- Include type hints for all function signatures
|
||||
- Document public methods with docstrings
|
||||
- Write tests for new functionality
|
||||
1. Enable DEBUG logging by reviewing recent log files
|
||||
2. Check the [Git Issues](https://git.serendipity.systems/k.eaven/pterodactyl-discord-bot/issues) for similar problems
|
||||
3. Verify your setup matches all requirements in [Prerequisites](#prerequisites)
|
||||
4. Test each component individually (Discord bot, Pterodactyl API, permissions)
|
||||
|
||||
## License
|
||||
|
||||
|
||||
18
dockerfile
18
dockerfile
@@ -18,13 +18,13 @@ COPY requirements.txt .
|
||||
RUN --mount=type=cache,target=/root/.cache/pip \
|
||||
pip install --no-cache-dir -r requirements.txt
|
||||
|
||||
# Final stage - using smaller base image
|
||||
FROM python:3.11-alpine3.18
|
||||
# Final stage - using slim
|
||||
FROM python:3.11-slim
|
||||
|
||||
# Install minimal runtime dependencies
|
||||
RUN apk add --no-cache \
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
tini \
|
||||
&& rm -rf /var/cache/apk/*
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Set working directory
|
||||
WORKDIR /app
|
||||
@@ -34,18 +34,22 @@ COPY --from=builder /opt/venv /opt/venv
|
||||
ENV PATH="/opt/venv/bin:$PATH"
|
||||
|
||||
# Create a non-root user
|
||||
RUN addgroup -S bot && adduser -S bot -G bot
|
||||
RUN groupadd -r bot && useradd -r -g bot bot
|
||||
|
||||
# Copy necessary files
|
||||
COPY --chown=bot:bot *.py ./
|
||||
COPY --chown=bot:bot entrypoint.sh ./
|
||||
# Add other necessary directories/files as needed
|
||||
|
||||
# Create directories for persistent storage
|
||||
RUN mkdir -p logs embed && \
|
||||
chown -R bot:bot /app logs embed && \
|
||||
chmod -R 777 /app logs embed
|
||||
|
||||
# Create and set permissions for matplotlib config directory
|
||||
RUN mkdir -p /tmp/matplotlib && \
|
||||
chown -R bot:bot /tmp/matplotlib && \
|
||||
chmod -R 777 /tmp/matplotlib
|
||||
|
||||
# Switch to non root user
|
||||
USER bot
|
||||
|
||||
@@ -54,6 +58,8 @@ ENV PYTHONUNBUFFERED=1
|
||||
ENV CONFIG_PATH=/app/config.ini
|
||||
ENV PYTHONDONTWRITEBYTECODE=1
|
||||
ENV PYTHONPYCACHEPREFIX=/tmp
|
||||
ENV MPLCONFIGDIR=/tmp/matplotlib
|
||||
ENV MPLBACKEND=Agg
|
||||
|
||||
# Run the bot using tini and entrypoint script
|
||||
ENTRYPOINT ["tini", "--", "/bin/sh", "entrypoint.sh"]
|
||||
File diff suppressed because it is too large
Load Diff
574
pterodisbot.py
574
pterodisbot.py
File diff suppressed because it is too large
Load Diff
26
requirements-test.txt
Normal file
26
requirements-test.txt
Normal file
@@ -0,0 +1,26 @@
|
||||
# Testing Dependencies for Pterodactyl Discord Bot
|
||||
|
||||
# Core testing framework
|
||||
pytest>=7.4.0
|
||||
pytest-asyncio>=0.21.0
|
||||
pytest-cov>=4.1.0
|
||||
pytest-mock>=3.11.1
|
||||
pytest-timeout>=2.1.0
|
||||
|
||||
# Code quality and linting
|
||||
flake8>=6.0.0
|
||||
pylint>=2.17.0
|
||||
black>=23.7.0
|
||||
isort>=5.12.0
|
||||
|
||||
# Security scanning
|
||||
bandit>=1.7.5
|
||||
safety>=2.3.5
|
||||
|
||||
# Mocking and fixtures
|
||||
pytest-fixtures>=0.1.0
|
||||
freezegun>=1.2.2
|
||||
|
||||
# Coverage reporting
|
||||
coverage>=7.2.7
|
||||
coverage-badge>=1.1.0
|
||||
@@ -2,3 +2,4 @@ discord.py>=2.3.0
|
||||
aiohttp>=3.8.0
|
||||
configparser>=5.3.0
|
||||
python-dotenv
|
||||
matplotlib
|
||||
528
server_metrics_graphs.py
Normal file
528
server_metrics_graphs.py
Normal file
@@ -0,0 +1,528 @@
|
||||
"""
|
||||
Server Metrics Graphs Module for Pterodactyl Discord Bot
|
||||
|
||||
This module provides graphing capabilities for server CPU and memory usage.
|
||||
Generates line graphs as PNG images for embedding in Discord messages.
|
||||
"""
|
||||
|
||||
import io
|
||||
import logging
|
||||
import math
|
||||
from collections import deque
|
||||
from datetime import datetime
|
||||
from typing import Dict, Optional
|
||||
|
||||
import matplotlib
|
||||
import matplotlib.dates as mdates
|
||||
import matplotlib.pyplot as plt
|
||||
|
||||
matplotlib.use("Agg") # Use non-interactive backend for server environments
|
||||
|
||||
# Get the logger from the main bot module
|
||||
logger = logging.getLogger("pterodisbot")
|
||||
|
||||
|
||||
class ServerMetricsGraphs:
|
||||
"""
|
||||
Manages CPU and memory usage graphs for individual servers.
|
||||
|
||||
Features:
|
||||
- Stores last 6 data points (1 minute of history at 10-second intervals)
|
||||
- Generates PNG images of line graphs for Discord embedding
|
||||
- Automatic data rotation (FIFO queue with max 6 points)
|
||||
- Separate tracking for CPU percentage and memory MB usage
|
||||
- Dynamic CPU scaling in 100% increments for multi-vCPU servers
|
||||
- Clean graph styling optimized for Discord dark theme
|
||||
"""
|
||||
|
||||
def __init__(self, server_id: str, server_name: str):
|
||||
"""
|
||||
Initialize metrics tracking for a server.
|
||||
|
||||
Args:
|
||||
server_id: Pterodactyl server identifier
|
||||
server_name: Human-readable server name
|
||||
"""
|
||||
self.server_id = server_id
|
||||
self.server_name = server_name
|
||||
|
||||
# Use deque with maxlen=6 for automatic FIFO rotation
|
||||
# Each entry is a tuple: (timestamp, cpu_percent, memory_mb)
|
||||
self.data_points = deque(maxlen=6)
|
||||
|
||||
# Track if we have enough data for meaningful graphs (at least 2 points)
|
||||
self.has_sufficient_data = False
|
||||
|
||||
logger.debug(f"Initialized metrics tracking for server {server_name} ({server_id})")
|
||||
|
||||
def add_data_point(self, cpu_percent: float, memory_mb: float, timestamp: Optional[datetime] = None):
|
||||
"""
|
||||
Add a new data point to the metrics history.
|
||||
|
||||
Args:
|
||||
cpu_percent: Current CPU usage percentage
|
||||
memory_mb: Current memory usage in megabytes
|
||||
timestamp: Optional timestamp, defaults to current time
|
||||
"""
|
||||
if timestamp is None:
|
||||
timestamp = datetime.now()
|
||||
|
||||
# Add new data point (automatically rotates old data due to maxlen=6)
|
||||
self.data_points.append((timestamp, cpu_percent, memory_mb))
|
||||
|
||||
# Update sufficient data flag
|
||||
self.has_sufficient_data = len(self.data_points) >= 2
|
||||
|
||||
logger.debug(f"Added metrics data point for {self.server_name}: CPU={cpu_percent}%, Memory={memory_mb}MB")
|
||||
|
||||
def _calculate_cpu_scale_limit(self, max_cpu_value: float) -> int:
|
||||
"""
|
||||
Calculate appropriate CPU scale limit in 100% increments.
|
||||
|
||||
Args:
|
||||
max_cpu_value: Maximum CPU value in the dataset
|
||||
|
||||
Returns:
|
||||
Scale limit rounded up to nearest 100% increment
|
||||
"""
|
||||
if max_cpu_value <= 100:
|
||||
return 100
|
||||
|
||||
# Round up to nearest 100% increment
|
||||
# e.g., 150% -> 200%, 250% -> 300%, 350% -> 400%
|
||||
return math.ceil(max_cpu_value / 100) * 100
|
||||
|
||||
def generate_cpu_graph(self) -> Optional[io.BytesIO]:
|
||||
"""
|
||||
Generate a CPU usage line graph as a PNG image.
|
||||
|
||||
Returns:
|
||||
BytesIO object containing PNG image data, or None if insufficient data
|
||||
"""
|
||||
if not self.has_sufficient_data:
|
||||
logger.debug(f"Insufficient data for CPU graph generation: {self.server_name}")
|
||||
return None
|
||||
|
||||
try:
|
||||
# Extract timestamps and CPU data
|
||||
timestamps = [point[0] for point in self.data_points]
|
||||
cpu_values = [point[1] for point in self.data_points]
|
||||
|
||||
# Calculate dynamic CPU scale limit
|
||||
max_cpu = max(cpu_values)
|
||||
cpu_scale_limit = self._calculate_cpu_scale_limit(max_cpu)
|
||||
|
||||
# Create figure with dark theme styling
|
||||
plt.style.use("dark_background")
|
||||
fig, ax = plt.subplots(figsize=(8, 4), dpi=100)
|
||||
fig.patch.set_facecolor("#2f3136") # Discord dark theme background
|
||||
ax.set_facecolor("#36393f") # Slightly lighter for graph area
|
||||
|
||||
# Plot CPU line with gradient fill
|
||||
ax.fill_between(timestamps, cpu_values, alpha=0.3, color="#7289da")
|
||||
|
||||
# Customize axes with dynamic scaling
|
||||
ax.set_ylabel("CPU Usage (%)", color="#ffffff", fontsize=10)
|
||||
ax.set_ylim(0, cpu_scale_limit)
|
||||
|
||||
# Add horizontal grid lines at 100% increments for better readability
|
||||
for i in range(100, cpu_scale_limit + 1, 100):
|
||||
ax.axhline(y=i, color="#ffffff", alpha=0.2, linestyle="--", linewidth=0.8)
|
||||
|
||||
# Format time axis
|
||||
ax.xaxis.set_major_formatter(mdates.DateFormatter("%H:%M:%S"))
|
||||
ax.xaxis.set_major_locator(mdates.SecondLocator(interval=20))
|
||||
plt.setp(
|
||||
ax.xaxis.get_majorticklabels(),
|
||||
rotation=45,
|
||||
ha="right",
|
||||
color="#ffffff",
|
||||
fontsize=8,
|
||||
)
|
||||
|
||||
# Style the graph
|
||||
ax.tick_params(colors="#ffffff", labelsize=8)
|
||||
ax.grid(True, alpha=0.3, color="#ffffff")
|
||||
ax.spines["bottom"].set_color("#ffffff")
|
||||
ax.spines["left"].set_color("#ffffff")
|
||||
ax.spines["top"].set_visible(False)
|
||||
ax.spines["right"].set_visible(False)
|
||||
|
||||
# Add title with scale info for multi-vCPU servers
|
||||
title = f"{self.server_name} - CPU Usage"
|
||||
if cpu_scale_limit > 100:
|
||||
estimated_vcpus = cpu_scale_limit // 100
|
||||
title += f" (~{estimated_vcpus} vCPU cores)"
|
||||
ax.set_title(title, color="#ffffff", fontsize=12, pad=20)
|
||||
|
||||
# Tight layout to prevent label cutoff
|
||||
plt.tight_layout()
|
||||
|
||||
# Save to BytesIO
|
||||
img_buffer = io.BytesIO()
|
||||
plt.savefig(
|
||||
img_buffer,
|
||||
format="png",
|
||||
facecolor="#2f3136",
|
||||
edgecolor="none",
|
||||
bbox_inches="tight",
|
||||
dpi=100,
|
||||
)
|
||||
img_buffer.seek(0)
|
||||
|
||||
# Clean up matplotlib resources
|
||||
plt.close(fig)
|
||||
|
||||
logger.debug(f"Generated CPU graph for {self.server_name} (scale: 0-{cpu_scale_limit}%)")
|
||||
return img_buffer
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to generate CPU graph for {self.server_name}: {str(e)}")
|
||||
plt.close("all") # Clean up any remaining figures
|
||||
return None
|
||||
|
||||
def generate_memory_graph(self) -> Optional[io.BytesIO]:
|
||||
"""
|
||||
Generate a memory usage line graph as a PNG image.
|
||||
|
||||
Returns:
|
||||
BytesIO object containing PNG image data, or None if insufficient data
|
||||
"""
|
||||
if not self.has_sufficient_data:
|
||||
logger.debug(f"Insufficient data for memory graph generation: {self.server_name}")
|
||||
return None
|
||||
|
||||
try:
|
||||
# Extract timestamps and memory data
|
||||
timestamps = [point[0] for point in self.data_points]
|
||||
memory_values = [point[2] for point in self.data_points]
|
||||
|
||||
# Create figure with dark theme styling
|
||||
plt.style.use("dark_background")
|
||||
fig, ax = plt.subplots(figsize=(8, 4), dpi=100)
|
||||
fig.patch.set_facecolor("#2f3136") # Discord dark theme background
|
||||
ax.set_facecolor("#36393f") # Slightly lighter for graph area
|
||||
|
||||
# Plot memory line with gradient fill
|
||||
ax.fill_between(timestamps, memory_values, alpha=0.3, color="#43b581")
|
||||
|
||||
# Customize axes
|
||||
ax.set_ylabel("Memory Usage (MB)", color="#ffffff", fontsize=10)
|
||||
ax.set_ylim(0, max(memory_values) * 1.1) # Dynamic scaling with 10% padding
|
||||
|
||||
# Format time axis
|
||||
ax.xaxis.set_major_formatter(mdates.DateFormatter("%H:%M:%S"))
|
||||
ax.xaxis.set_major_locator(mdates.SecondLocator(interval=20))
|
||||
plt.setp(
|
||||
ax.xaxis.get_majorticklabels(),
|
||||
rotation=45,
|
||||
ha="right",
|
||||
color="#ffffff",
|
||||
fontsize=8,
|
||||
)
|
||||
|
||||
# Style the graph
|
||||
ax.tick_params(colors="#ffffff", labelsize=8)
|
||||
ax.grid(True, alpha=0.3, color="#ffffff")
|
||||
ax.spines["bottom"].set_color("#ffffff")
|
||||
ax.spines["left"].set_color("#ffffff")
|
||||
ax.spines["top"].set_visible(False)
|
||||
ax.spines["right"].set_visible(False)
|
||||
|
||||
# Add title
|
||||
ax.set_title(
|
||||
f"{self.server_name} - Memory Usage",
|
||||
color="#ffffff",
|
||||
fontsize=12,
|
||||
pad=20,
|
||||
)
|
||||
|
||||
# Tight layout to prevent label cutoff
|
||||
plt.tight_layout()
|
||||
|
||||
# Save to BytesIO
|
||||
img_buffer = io.BytesIO()
|
||||
plt.savefig(
|
||||
img_buffer,
|
||||
format="png",
|
||||
facecolor="#2f3136",
|
||||
edgecolor="none",
|
||||
bbox_inches="tight",
|
||||
dpi=100,
|
||||
)
|
||||
img_buffer.seek(0)
|
||||
|
||||
# Clean up matplotlib resources
|
||||
plt.close(fig)
|
||||
|
||||
logger.debug(f"Generated memory graph for {self.server_name}")
|
||||
return img_buffer
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to generate memory graph for {self.server_name}: {str(e)}")
|
||||
plt.close("all") # Clean up any remaining figures
|
||||
return None
|
||||
|
||||
def generate_combined_graph(self) -> Optional[io.BytesIO]:
|
||||
"""
|
||||
Generate a combined CPU and memory usage graph as a PNG image.
|
||||
|
||||
Returns:
|
||||
BytesIO object containing PNG image data, or None if insufficient data
|
||||
"""
|
||||
if not self.has_sufficient_data:
|
||||
logger.debug(f"Insufficient data for combined graph generation: {self.server_name}")
|
||||
return None
|
||||
|
||||
try:
|
||||
# Extract data
|
||||
timestamps = [point[0] for point in self.data_points]
|
||||
cpu_values = [point[1] for point in self.data_points]
|
||||
memory_values = [point[2] for point in self.data_points]
|
||||
|
||||
# Calculate dynamic CPU scale limit
|
||||
max_cpu = max(cpu_values)
|
||||
cpu_scale_limit = self._calculate_cpu_scale_limit(max_cpu)
|
||||
|
||||
# Create figure with two subplots
|
||||
plt.style.use("dark_background")
|
||||
fig, (ax1, ax2) = plt.subplots(2, 1, figsize=(8, 6), dpi=100, sharex=True)
|
||||
fig.patch.set_facecolor("#2f3136")
|
||||
|
||||
# CPU subplot
|
||||
ax1.set_facecolor("#36393f")
|
||||
ax1.plot(
|
||||
timestamps,
|
||||
cpu_values,
|
||||
color="#7289da",
|
||||
linewidth=2.5,
|
||||
marker="o",
|
||||
markersize=4,
|
||||
)
|
||||
ax1.fill_between(timestamps, cpu_values, alpha=0.3, color="#7289da")
|
||||
ax1.set_ylabel("CPU Usage (%)", color="#ffffff", fontsize=10)
|
||||
ax1.set_ylim(0, cpu_scale_limit)
|
||||
ax1.tick_params(colors="#ffffff", labelsize=8)
|
||||
ax1.grid(True, alpha=0.3, color="#ffffff")
|
||||
|
||||
# Add horizontal grid lines at 100% increments for CPU subplot
|
||||
for i in range(100, cpu_scale_limit + 1, 100):
|
||||
ax1.axhline(y=i, color="#ffffff", alpha=0.2, linestyle="--", linewidth=0.8)
|
||||
|
||||
# Title with vCPU info if applicable
|
||||
title = f"{self.server_name} - Resource Usage"
|
||||
if cpu_scale_limit > 100:
|
||||
estimated_vcpus = cpu_scale_limit // 100
|
||||
title += f" (~{estimated_vcpus} vCPU cores)"
|
||||
ax1.set_title(title, color="#ffffff", fontsize=12)
|
||||
|
||||
# Memory subplot
|
||||
ax2.set_facecolor("#36393f")
|
||||
ax2.plot(
|
||||
timestamps,
|
||||
memory_values,
|
||||
color="#43b581",
|
||||
linewidth=2.5,
|
||||
marker="o",
|
||||
markersize=4,
|
||||
)
|
||||
ax2.fill_between(timestamps, memory_values, alpha=0.3, color="#43b581")
|
||||
ax2.set_ylabel("Memory (MB)", color="#ffffff", fontsize=10)
|
||||
ax2.set_ylim(0, max(memory_values) * 1.1)
|
||||
ax2.tick_params(colors="#ffffff", labelsize=8)
|
||||
ax2.grid(True, alpha=0.3, color="#ffffff")
|
||||
|
||||
# Format time axis (only on bottom subplot)
|
||||
ax2.xaxis.set_major_formatter(mdates.DateFormatter("%H:%M:%S"))
|
||||
ax2.xaxis.set_major_locator(mdates.SecondLocator(interval=20))
|
||||
plt.setp(
|
||||
ax2.xaxis.get_majorticklabels(),
|
||||
rotation=45,
|
||||
ha="right",
|
||||
color="#ffffff",
|
||||
fontsize=8,
|
||||
)
|
||||
|
||||
# Style both subplots
|
||||
for ax in [ax1, ax2]:
|
||||
ax.spines["bottom"].set_color("#ffffff")
|
||||
ax.spines["left"].set_color("#ffffff")
|
||||
ax.spines["top"].set_visible(False)
|
||||
ax.spines["right"].set_visible(False)
|
||||
|
||||
plt.tight_layout()
|
||||
|
||||
# Save to BytesIO
|
||||
img_buffer = io.BytesIO()
|
||||
plt.savefig(
|
||||
img_buffer,
|
||||
format="png",
|
||||
facecolor="#2f3136",
|
||||
edgecolor="none",
|
||||
bbox_inches="tight",
|
||||
dpi=100,
|
||||
)
|
||||
img_buffer.seek(0)
|
||||
|
||||
plt.close(fig)
|
||||
|
||||
logger.debug(f"Generated combined graph for {self.server_name} (CPU scale: 0-{cpu_scale_limit}%)")
|
||||
return img_buffer
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Failed to generate combined graph for {self.server_name}: {str(e)}")
|
||||
plt.close("all")
|
||||
return None
|
||||
|
||||
def get_data_summary(self) -> Dict[str, any]:
|
||||
"""
|
||||
Get summary statistics for the current data points.
|
||||
|
||||
Returns:
|
||||
Dictionary containing data point count, latest values, and trends
|
||||
"""
|
||||
if not self.data_points:
|
||||
return {
|
||||
"point_count": 0,
|
||||
"has_data": False,
|
||||
"latest_cpu": 0,
|
||||
"latest_memory": 0,
|
||||
}
|
||||
|
||||
# Get latest values
|
||||
latest_point = self.data_points[-1]
|
||||
latest_cpu = latest_point[1]
|
||||
latest_memory = latest_point[2]
|
||||
|
||||
# Calculate CPU scale info
|
||||
max_cpu = max(point[1] for point in self.data_points)
|
||||
cpu_scale_limit = self._calculate_cpu_scale_limit(max_cpu)
|
||||
estimated_vcpus = cpu_scale_limit // 100
|
||||
|
||||
# Calculate trends if we have multiple points
|
||||
cpu_trend = "stable"
|
||||
memory_trend = "stable"
|
||||
|
||||
if len(self.data_points) >= 2:
|
||||
first_point = self.data_points[0]
|
||||
cpu_change = latest_cpu - first_point[1]
|
||||
memory_change = latest_memory - first_point[2]
|
||||
|
||||
# Determine trends (>5% change considered significant)
|
||||
if abs(cpu_change) > 5:
|
||||
cpu_trend = "increasing" if cpu_change > 0 else "decreasing"
|
||||
|
||||
if abs(memory_change) > 50: # 50MB change threshold
|
||||
memory_trend = "increasing" if memory_change > 0 else "decreasing"
|
||||
|
||||
return {
|
||||
"point_count": len(self.data_points),
|
||||
"has_data": self.has_sufficient_data,
|
||||
"latest_cpu": latest_cpu,
|
||||
"latest_memory": latest_memory,
|
||||
"cpu_trend": cpu_trend,
|
||||
"memory_trend": memory_trend,
|
||||
"cpu_scale_limit": cpu_scale_limit,
|
||||
"estimated_vcpus": estimated_vcpus,
|
||||
"time_span_minutes": len(self.data_points) * 10 / 60, # Convert to minutes
|
||||
}
|
||||
|
||||
|
||||
class ServerMetricsManager:
|
||||
"""
|
||||
Global manager for all server metrics graphs.
|
||||
|
||||
Handles:
|
||||
- Creation and cleanup of ServerMetricsGraphs instances
|
||||
- Bulk operations across all tracked servers
|
||||
- Memory management for graph storage
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
"""Initialize the metrics manager."""
|
||||
self.server_graphs: Dict[str, ServerMetricsGraphs] = {}
|
||||
logger.info("Initialized ServerMetricsManager")
|
||||
|
||||
def get_or_create_server_graphs(self, server_id: str, server_name: str) -> ServerMetricsGraphs:
|
||||
"""
|
||||
Get existing ServerMetricsGraphs instance or create a new one.
|
||||
|
||||
Args:
|
||||
server_id: Pterodactyl server identifier
|
||||
server_name: Human-readable server name
|
||||
|
||||
Returns:
|
||||
ServerMetricsGraphs instance for the specified server
|
||||
"""
|
||||
if server_id not in self.server_graphs:
|
||||
self.server_graphs[server_id] = ServerMetricsGraphs(server_id, server_name)
|
||||
logger.debug(f"Created new metrics graphs for server {server_name}")
|
||||
|
||||
return self.server_graphs[server_id]
|
||||
|
||||
def add_server_data(self, server_id: str, server_name: str, cpu_percent: float, memory_mb: float):
|
||||
"""
|
||||
Add data point to a server's metrics tracking.
|
||||
|
||||
Args:
|
||||
server_id: Pterodactyl server identifier
|
||||
server_name: Human-readable server name
|
||||
cpu_percent: Current CPU usage percentage
|
||||
memory_mb: Current memory usage in megabytes
|
||||
"""
|
||||
graphs = self.get_or_create_server_graphs(server_id, server_name)
|
||||
graphs.add_data_point(cpu_percent, memory_mb)
|
||||
|
||||
def remove_server(self, server_id: str):
|
||||
"""
|
||||
Remove a server from metrics tracking.
|
||||
|
||||
Args:
|
||||
server_id: Pterodactyl server identifier to remove
|
||||
"""
|
||||
if server_id in self.server_graphs:
|
||||
del self.server_graphs[server_id]
|
||||
logger.debug(f"Removed metrics tracking for server {server_id}")
|
||||
|
||||
def get_server_graphs(self, server_id: str) -> Optional[ServerMetricsGraphs]:
|
||||
"""
|
||||
Get ServerMetricsGraphs instance for a specific server.
|
||||
|
||||
Args:
|
||||
server_id: Pterodactyl server identifier
|
||||
|
||||
Returns:
|
||||
ServerMetricsGraphs instance or None if not found
|
||||
"""
|
||||
return self.server_graphs.get(server_id)
|
||||
|
||||
def cleanup_old_servers(self, active_server_ids: list):
|
||||
"""
|
||||
Remove tracking for servers that no longer exist.
|
||||
|
||||
Args:
|
||||
active_server_ids: List of currently active server IDs
|
||||
"""
|
||||
servers_to_remove = []
|
||||
for server_id in self.server_graphs:
|
||||
if server_id not in active_server_ids:
|
||||
servers_to_remove.append(server_id)
|
||||
|
||||
for server_id in servers_to_remove:
|
||||
self.remove_server(server_id)
|
||||
|
||||
if servers_to_remove:
|
||||
logger.info(f"Cleaned up metrics for {len(servers_to_remove)} inactive servers")
|
||||
|
||||
def get_summary(self) -> Dict[str, any]:
|
||||
"""
|
||||
Get summary of all tracked servers.
|
||||
|
||||
Returns:
|
||||
Dictionary with tracking statistics
|
||||
"""
|
||||
return {
|
||||
"total_servers": len(self.server_graphs),
|
||||
"servers_with_data": sum(1 for graphs in self.server_graphs.values() if graphs.has_sufficient_data),
|
||||
"total_data_points": sum(len(graphs.data_points) for graphs in self.server_graphs.values()),
|
||||
}
|
||||
797
test_pterodisbot.py
Normal file
797
test_pterodisbot.py
Normal file
@@ -0,0 +1,797 @@
|
||||
"""
|
||||
Unit and Integration Tests for Pterodactyl Discord Bot
|
||||
|
||||
Test coverage:
|
||||
- Configuration validation
|
||||
- Pterodactyl API client operations
|
||||
- Discord bot commands and interactions
|
||||
- Server metrics tracking
|
||||
- Embed management
|
||||
- Error handling
|
||||
"""
|
||||
|
||||
import pytest
|
||||
import asyncio
|
||||
import json
|
||||
import os
|
||||
from unittest.mock import Mock, AsyncMock, patch, MagicMock
|
||||
from datetime import datetime
|
||||
import configparser
|
||||
import discord
|
||||
from discord.ext import commands
|
||||
import aiohttp
|
||||
|
||||
# Import the modules to test
|
||||
import sys
|
||||
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
|
||||
|
||||
from pterodisbot import (
|
||||
PterodactylAPI,
|
||||
ServerStatusView,
|
||||
PterodactylBot,
|
||||
ConfigValidationError,
|
||||
validate_config,
|
||||
REQUIRED_ROLE
|
||||
)
|
||||
from server_metrics_graphs import ServerMetricsGraphs, ServerMetricsManager
|
||||
|
||||
|
||||
# ==========================================
|
||||
# FIXTURES
|
||||
# ==========================================
|
||||
|
||||
@pytest.fixture
|
||||
def mock_config():
|
||||
"""
|
||||
Create a mock configuration for testing.
|
||||
|
||||
Returns:
|
||||
ConfigParser: A properly configured test configuration object
|
||||
"""
|
||||
config = configparser.ConfigParser()
|
||||
config['Pterodactyl'] = {
|
||||
'PanelURL': 'https://panel.example.com',
|
||||
'ClientAPIKey': 'ptlc_test_client_key_123',
|
||||
'ApplicationAPIKey': 'ptla_test_app_key_456'
|
||||
}
|
||||
config['Discord'] = {
|
||||
'Token': 'test_discord_token',
|
||||
'AllowedGuildID': '123456789'
|
||||
}
|
||||
return config
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mock_pterodactyl_api():
|
||||
"""
|
||||
Create a mock PterodactylAPI instance with properly configured session.
|
||||
|
||||
Returns:
|
||||
PterodactylAPI: A mocked API instance ready for testing
|
||||
"""
|
||||
api = PterodactylAPI(
|
||||
'https://panel.example.com',
|
||||
'ptlc_test_client_key',
|
||||
'ptla_test_app_key'
|
||||
)
|
||||
# Create a proper async mock session
|
||||
api.session = AsyncMock(spec=aiohttp.ClientSession)
|
||||
api.session.close = AsyncMock() # Ensure close is an async mock
|
||||
return api
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def sample_server_data():
|
||||
"""
|
||||
Sample server data from Pterodactyl API.
|
||||
|
||||
Returns:
|
||||
dict: Server attributes in Pterodactyl API format
|
||||
"""
|
||||
return {
|
||||
'attributes': {
|
||||
'identifier': 'abc123',
|
||||
'name': 'Test Server',
|
||||
'description': 'A test game server',
|
||||
'suspended': False,
|
||||
'limits': {
|
||||
'cpu': 200,
|
||||
'memory': 2048,
|
||||
'disk': 10240
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def sample_resources_data():
|
||||
"""
|
||||
Sample resource usage data from Pterodactyl API.
|
||||
|
||||
Returns:
|
||||
dict: Resource usage attributes in Pterodactyl API format
|
||||
"""
|
||||
return {
|
||||
'attributes': {
|
||||
'current_state': 'running',
|
||||
'resources': {
|
||||
'cpu_absolute': 45.5,
|
||||
'memory_bytes': 1073741824, # 1GB
|
||||
'disk_bytes': 5368709120, # 5GB
|
||||
'network_rx_bytes': 10485760, # 10MB
|
||||
'network_tx_bytes': 5242880, # 5MB
|
||||
'uptime': 3600000 # 1 hour in milliseconds
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mock_discord_interaction():
|
||||
"""
|
||||
Create a mock Discord interaction with properly configured user roles.
|
||||
|
||||
Returns:
|
||||
AsyncMock: A mocked Discord interaction object
|
||||
"""
|
||||
interaction = AsyncMock(spec=discord.Interaction)
|
||||
interaction.user = Mock()
|
||||
interaction.user.name = 'TestUser'
|
||||
|
||||
# Create mock role with proper name attribute
|
||||
mock_role = Mock()
|
||||
mock_role.name = REQUIRED_ROLE
|
||||
interaction.user.roles = [mock_role]
|
||||
|
||||
interaction.guild_id = 123456789
|
||||
interaction.channel = Mock()
|
||||
interaction.channel.id = 987654321
|
||||
interaction.response = AsyncMock()
|
||||
interaction.followup = AsyncMock()
|
||||
return interaction
|
||||
|
||||
|
||||
# ==========================================
|
||||
# CONFIGURATION VALIDATION TESTS
|
||||
# ==========================================
|
||||
|
||||
class TestConfigValidation:
|
||||
"""Test configuration validation logic."""
|
||||
|
||||
def test_valid_config(self, mock_config, monkeypatch):
|
||||
"""
|
||||
Test that valid configuration passes validation.
|
||||
|
||||
Args:
|
||||
mock_config: Pytest fixture providing valid config
|
||||
monkeypatch: Pytest monkeypatch fixture for patching
|
||||
"""
|
||||
monkeypatch.setattr('pterodisbot.config', mock_config)
|
||||
|
||||
# Should not raise any exceptions
|
||||
try:
|
||||
validate_config()
|
||||
except ConfigValidationError:
|
||||
pytest.fail("Valid configuration should not raise ConfigValidationError")
|
||||
|
||||
def test_missing_pterodactyl_section(self, monkeypatch):
|
||||
"""
|
||||
Test validation fails with missing Pterodactyl section.
|
||||
|
||||
Args:
|
||||
monkeypatch: Pytest monkeypatch fixture for patching
|
||||
"""
|
||||
config = configparser.ConfigParser()
|
||||
config['Discord'] = {
|
||||
'Token': 'test_token',
|
||||
'AllowedGuildID': '123456789'
|
||||
}
|
||||
monkeypatch.setattr('pterodisbot.config', config)
|
||||
|
||||
with pytest.raises(ConfigValidationError, match="Missing \\[Pterodactyl\\] section"):
|
||||
validate_config()
|
||||
|
||||
def test_invalid_api_key_prefix(self, mock_config, monkeypatch):
|
||||
"""
|
||||
Test validation fails with incorrect API key prefix.
|
||||
|
||||
Args:
|
||||
mock_config: Pytest fixture providing config
|
||||
monkeypatch: Pytest monkeypatch fixture for patching
|
||||
"""
|
||||
mock_config['Pterodactyl']['ClientAPIKey'] = 'invalid_prefix_key'
|
||||
monkeypatch.setattr('pterodisbot.config', mock_config)
|
||||
|
||||
with pytest.raises(ConfigValidationError, match="ClientAPIKey should start with 'ptlc_'"):
|
||||
validate_config()
|
||||
|
||||
def test_invalid_guild_id(self, mock_config, monkeypatch):
|
||||
"""
|
||||
Test validation fails with invalid guild ID.
|
||||
|
||||
Args:
|
||||
mock_config: Pytest fixture providing config
|
||||
monkeypatch: Pytest monkeypatch fixture for patching
|
||||
"""
|
||||
mock_config['Discord']['AllowedGuildID'] = 'not_a_number'
|
||||
monkeypatch.setattr('pterodisbot.config', mock_config)
|
||||
|
||||
with pytest.raises(ConfigValidationError, match="AllowedGuildID must be a valid integer"):
|
||||
validate_config()
|
||||
|
||||
def test_invalid_panel_url(self, mock_config, monkeypatch):
|
||||
"""
|
||||
Test validation fails with invalid panel URL.
|
||||
|
||||
Args:
|
||||
mock_config: Pytest fixture providing config
|
||||
monkeypatch: Pytest monkeypatch fixture for patching
|
||||
"""
|
||||
mock_config['Pterodactyl']['PanelURL'] = 'not-a-url'
|
||||
monkeypatch.setattr('pterodisbot.config', mock_config)
|
||||
|
||||
with pytest.raises(ConfigValidationError, match="PanelURL must start with http"):
|
||||
validate_config()
|
||||
|
||||
|
||||
# ==========================================
|
||||
# PTERODACTYL API TESTS
|
||||
# ==========================================
|
||||
|
||||
class TestPterodactylAPI:
|
||||
"""Test Pterodactyl API client functionality."""
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_initialize(self):
|
||||
"""
|
||||
Test API client initialization.
|
||||
|
||||
Verifies that the API client properly creates an aiohttp session
|
||||
"""
|
||||
api = PterodactylAPI('https://panel.example.com', 'ptlc_key', 'ptla_key')
|
||||
await api.initialize()
|
||||
|
||||
assert api.session is not None
|
||||
assert isinstance(api.session, aiohttp.ClientSession)
|
||||
|
||||
await api.close()
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_close(self, mock_pterodactyl_api):
|
||||
"""
|
||||
Test API client cleanup properly calls session.close().
|
||||
|
||||
Args:
|
||||
mock_pterodactyl_api: Pytest fixture providing mocked API instance
|
||||
"""
|
||||
# Ensure the session is marked as not closed
|
||||
mock_pterodactyl_api.session.closed = False
|
||||
|
||||
await mock_pterodactyl_api.close()
|
||||
|
||||
# Verify close was called once
|
||||
mock_pterodactyl_api.session.close.assert_called_once()
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_request_success(self, mock_pterodactyl_api):
|
||||
"""
|
||||
Test successful API request with properly mocked context manager.
|
||||
|
||||
Args:
|
||||
mock_pterodactyl_api: Pytest fixture providing mocked API instance
|
||||
"""
|
||||
# Create a mock response
|
||||
mock_response = AsyncMock()
|
||||
mock_response.status = 200
|
||||
mock_response.json = AsyncMock(return_value={'data': 'test'})
|
||||
|
||||
# Create a mock context manager that returns the response
|
||||
mock_context = AsyncMock()
|
||||
mock_context.__aenter__.return_value = mock_response
|
||||
mock_context.__aexit__.return_value = AsyncMock()
|
||||
|
||||
# Configure the session.request to return the context manager
|
||||
mock_pterodactyl_api.session.request = Mock(return_value=mock_context)
|
||||
|
||||
result = await mock_pterodactyl_api._request('GET', 'test/endpoint')
|
||||
|
||||
assert result == {'data': 'test'}
|
||||
mock_pterodactyl_api.session.request.assert_called_once()
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_request_error(self, mock_pterodactyl_api):
|
||||
"""
|
||||
Test API request error handling with properly mocked context manager.
|
||||
|
||||
Args:
|
||||
mock_pterodactyl_api: Pytest fixture providing mocked API instance
|
||||
"""
|
||||
# Create a mock error response
|
||||
mock_response = AsyncMock()
|
||||
mock_response.status = 404
|
||||
mock_response.json = AsyncMock(return_value={
|
||||
'errors': [{'detail': 'Server not found'}]
|
||||
})
|
||||
|
||||
# Create a mock context manager that returns the error response
|
||||
mock_context = AsyncMock()
|
||||
mock_context.__aenter__.return_value = mock_response
|
||||
mock_context.__aexit__.return_value = AsyncMock()
|
||||
|
||||
# Configure the session.request to return the context manager
|
||||
mock_pterodactyl_api.session.request = Mock(return_value=mock_context)
|
||||
|
||||
result = await mock_pterodactyl_api._request('GET', 'test/endpoint')
|
||||
|
||||
assert result['status'] == 'error'
|
||||
assert 'Server not found' in result['message']
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_get_servers(self, mock_pterodactyl_api, sample_server_data):
|
||||
"""
|
||||
Test retrieving server list from API.
|
||||
|
||||
Args:
|
||||
mock_pterodactyl_api: Pytest fixture providing mocked API instance
|
||||
sample_server_data: Pytest fixture providing sample server data
|
||||
"""
|
||||
mock_pterodactyl_api._request = AsyncMock(return_value={
|
||||
'data': [sample_server_data]
|
||||
})
|
||||
|
||||
servers = await mock_pterodactyl_api.get_servers()
|
||||
|
||||
assert len(servers) == 1
|
||||
assert servers[0] == sample_server_data
|
||||
mock_pterodactyl_api._request.assert_called_once_with(
|
||||
'GET', 'application/servers', use_application_key=True
|
||||
)
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_get_server_resources(self, mock_pterodactyl_api, sample_resources_data):
|
||||
"""
|
||||
Test retrieving server resource usage from API.
|
||||
|
||||
Args:
|
||||
mock_pterodactyl_api: Pytest fixture providing mocked API instance
|
||||
sample_resources_data: Pytest fixture providing sample resource data
|
||||
"""
|
||||
mock_pterodactyl_api._request = AsyncMock(return_value=sample_resources_data)
|
||||
|
||||
resources = await mock_pterodactyl_api.get_server_resources('abc123')
|
||||
|
||||
assert resources['attributes']['current_state'] == 'running'
|
||||
mock_pterodactyl_api._request.assert_called_once_with(
|
||||
'GET', 'client/servers/abc123/resources'
|
||||
)
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_power_action_valid(self, mock_pterodactyl_api):
|
||||
"""
|
||||
Test sending valid power action to server.
|
||||
|
||||
Args:
|
||||
mock_pterodactyl_api: Pytest fixture providing mocked API instance
|
||||
"""
|
||||
mock_pterodactyl_api._request = AsyncMock(return_value={'status': 'success'})
|
||||
|
||||
result = await mock_pterodactyl_api.send_power_action('abc123', 'start')
|
||||
|
||||
assert result['status'] == 'success'
|
||||
mock_pterodactyl_api._request.assert_called_once_with(
|
||||
'POST', 'client/servers/abc123/power', {'signal': 'start'}
|
||||
)
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_power_action_invalid(self, mock_pterodactyl_api):
|
||||
"""
|
||||
Test sending invalid power action returns error.
|
||||
|
||||
Args:
|
||||
mock_pterodactyl_api: Pytest fixture providing mocked API instance
|
||||
"""
|
||||
result = await mock_pterodactyl_api.send_power_action('abc123', 'invalid_action')
|
||||
|
||||
assert result['status'] == 'error'
|
||||
assert 'Invalid action' in result['message']
|
||||
|
||||
|
||||
# ==========================================
|
||||
# SERVER METRICS TESTS
|
||||
# ==========================================
|
||||
|
||||
class TestServerMetricsGraphs:
|
||||
"""Test server metrics tracking and graphing."""
|
||||
|
||||
def test_initialization(self):
|
||||
"""
|
||||
Test metrics graph initialization with empty state.
|
||||
"""
|
||||
graphs = ServerMetricsGraphs('abc123', 'Test Server')
|
||||
|
||||
assert graphs.server_id == 'abc123'
|
||||
assert graphs.server_name == 'Test Server'
|
||||
assert len(graphs.data_points) == 0
|
||||
assert graphs.has_sufficient_data is False
|
||||
|
||||
def test_add_data_point(self):
|
||||
"""
|
||||
Test adding data points and checking sufficient data threshold.
|
||||
"""
|
||||
graphs = ServerMetricsGraphs('abc123', 'Test Server')
|
||||
|
||||
graphs.add_data_point(50.0, 1024.0)
|
||||
|
||||
assert len(graphs.data_points) == 1
|
||||
assert graphs.has_sufficient_data is False
|
||||
|
||||
graphs.add_data_point(55.0, 1100.0)
|
||||
|
||||
assert len(graphs.data_points) == 2
|
||||
assert graphs.has_sufficient_data is True
|
||||
|
||||
def test_data_rotation(self):
|
||||
"""
|
||||
Test automatic data point rotation (FIFO with maxlen=6).
|
||||
"""
|
||||
graphs = ServerMetricsGraphs('abc123', 'Test Server')
|
||||
|
||||
# Add 8 data points to test rotation
|
||||
for i in range(8):
|
||||
graphs.add_data_point(float(i * 10), float(i * 100))
|
||||
|
||||
# Should only keep the last 6
|
||||
assert len(graphs.data_points) == 6
|
||||
assert graphs.data_points[0][1] == 20.0 # CPU of 3rd point
|
||||
assert graphs.data_points[-1][1] == 70.0 # CPU of 8th point
|
||||
|
||||
def test_cpu_scale_calculation(self):
|
||||
"""
|
||||
Test dynamic CPU scale limit calculation for multi-vCPU servers.
|
||||
"""
|
||||
graphs = ServerMetricsGraphs('abc123', 'Test Server')
|
||||
|
||||
# Test single vCPU (<=100%)
|
||||
assert graphs._calculate_cpu_scale_limit(75.0) == 100
|
||||
assert graphs._calculate_cpu_scale_limit(100.0) == 100
|
||||
|
||||
# Test multi-vCPU scenarios
|
||||
assert graphs._calculate_cpu_scale_limit(150.0) == 200
|
||||
assert graphs._calculate_cpu_scale_limit(250.0) == 300
|
||||
assert graphs._calculate_cpu_scale_limit(350.0) == 400
|
||||
|
||||
def test_get_data_summary(self):
|
||||
"""
|
||||
Test data summary generation including trends.
|
||||
"""
|
||||
graphs = ServerMetricsGraphs('abc123', 'Test Server')
|
||||
|
||||
# No data case
|
||||
summary = graphs.get_data_summary()
|
||||
assert summary['point_count'] == 0
|
||||
assert summary['has_data'] is False
|
||||
|
||||
# Add data points with increasing trend
|
||||
graphs.add_data_point(50.0, 1000.0)
|
||||
graphs.add_data_point(60.0, 1100.0)
|
||||
|
||||
summary = graphs.get_data_summary()
|
||||
assert summary['point_count'] == 2
|
||||
assert summary['has_data'] is True
|
||||
assert summary['latest_cpu'] == 60.0
|
||||
assert summary['latest_memory'] == 1100.0
|
||||
assert summary['cpu_trend'] == 'increasing'
|
||||
|
||||
def test_generate_graph_insufficient_data(self):
|
||||
"""
|
||||
Test graph generation returns None with insufficient data.
|
||||
"""
|
||||
graphs = ServerMetricsGraphs('abc123', 'Test Server')
|
||||
|
||||
# Only one data point - should return None
|
||||
graphs.add_data_point(50.0, 1000.0)
|
||||
|
||||
assert graphs.generate_cpu_graph() is None
|
||||
assert graphs.generate_memory_graph() is None
|
||||
assert graphs.generate_combined_graph() is None
|
||||
|
||||
|
||||
class TestServerMetricsManager:
|
||||
"""Test server metrics manager."""
|
||||
|
||||
def test_initialization(self):
|
||||
"""
|
||||
Test manager initialization with empty state.
|
||||
"""
|
||||
manager = ServerMetricsManager()
|
||||
assert len(manager.server_graphs) == 0
|
||||
|
||||
def test_get_or_create_server_graphs(self):
|
||||
"""
|
||||
Test getting or creating server graphs returns same instance.
|
||||
"""
|
||||
manager = ServerMetricsManager()
|
||||
|
||||
graphs1 = manager.get_or_create_server_graphs('abc123', 'Test Server')
|
||||
graphs2 = manager.get_or_create_server_graphs('abc123', 'Test Server')
|
||||
|
||||
assert graphs1 is graphs2 # Should return same instance
|
||||
assert len(manager.server_graphs) == 1
|
||||
|
||||
def test_add_server_data(self):
|
||||
"""
|
||||
Test adding data through manager properly creates graphs.
|
||||
"""
|
||||
manager = ServerMetricsManager()
|
||||
|
||||
manager.add_server_data('abc123', 'Test Server', 50.0, 1024.0)
|
||||
|
||||
graphs = manager.get_server_graphs('abc123')
|
||||
assert graphs is not None
|
||||
assert len(graphs.data_points) == 1
|
||||
|
||||
def test_remove_server(self):
|
||||
"""
|
||||
Test removing server from tracking.
|
||||
"""
|
||||
manager = ServerMetricsManager()
|
||||
|
||||
manager.add_server_data('abc123', 'Test Server', 50.0, 1024.0)
|
||||
assert 'abc123' in manager.server_graphs
|
||||
|
||||
manager.remove_server('abc123')
|
||||
assert 'abc123' not in manager.server_graphs
|
||||
|
||||
def test_cleanup_old_servers(self):
|
||||
"""
|
||||
Test cleanup of inactive servers not in active list.
|
||||
"""
|
||||
manager = ServerMetricsManager()
|
||||
|
||||
# Add data for 3 servers
|
||||
manager.add_server_data('server1', 'Server 1', 50.0, 1024.0)
|
||||
manager.add_server_data('server2', 'Server 2', 60.0, 2048.0)
|
||||
manager.add_server_data('server3', 'Server 3', 70.0, 3072.0)
|
||||
|
||||
# Only server1 and server2 are still active
|
||||
manager.cleanup_old_servers(['server1', 'server2'])
|
||||
|
||||
assert 'server1' in manager.server_graphs
|
||||
assert 'server2' in manager.server_graphs
|
||||
assert 'server3' not in manager.server_graphs
|
||||
|
||||
def test_get_summary(self):
|
||||
"""
|
||||
Test getting manager summary with statistics.
|
||||
"""
|
||||
manager = ServerMetricsManager()
|
||||
|
||||
# Add some servers with varying data
|
||||
manager.add_server_data('server1', 'Server 1', 50.0, 1024.0)
|
||||
manager.add_server_data('server1', 'Server 1', 55.0, 1100.0)
|
||||
manager.add_server_data('server2', 'Server 2', 60.0, 2048.0)
|
||||
|
||||
summary = manager.get_summary()
|
||||
assert summary['total_servers'] == 2
|
||||
assert summary['servers_with_data'] == 1 # Only server1 has >=2 points
|
||||
assert summary['total_data_points'] == 3
|
||||
|
||||
|
||||
# ==========================================
|
||||
# DISCORD BOT TESTS
|
||||
# ==========================================
|
||||
|
||||
class TestServerStatusView:
|
||||
"""Test Discord UI view for server status."""
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_view_initialization(self, mock_pterodactyl_api, sample_server_data):
|
||||
"""
|
||||
Test view initialization with server data.
|
||||
|
||||
Args:
|
||||
mock_pterodactyl_api: Pytest fixture providing mocked API instance
|
||||
sample_server_data: Pytest fixture providing sample server data
|
||||
"""
|
||||
view = ServerStatusView(
|
||||
'abc123',
|
||||
'Test Server',
|
||||
mock_pterodactyl_api,
|
||||
sample_server_data
|
||||
)
|
||||
|
||||
assert view.server_id == 'abc123'
|
||||
assert view.server_name == 'Test Server'
|
||||
assert view.api is mock_pterodactyl_api
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_interaction_check_authorized(self, mock_pterodactyl_api,
|
||||
sample_server_data, mock_discord_interaction):
|
||||
"""
|
||||
Test interaction check with authorized user having required role.
|
||||
|
||||
Args:
|
||||
mock_pterodactyl_api: Pytest fixture providing mocked API instance
|
||||
sample_server_data: Pytest fixture providing sample server data
|
||||
mock_discord_interaction: Pytest fixture providing mocked Discord interaction
|
||||
"""
|
||||
view = ServerStatusView('abc123', 'Test Server',
|
||||
mock_pterodactyl_api, sample_server_data)
|
||||
|
||||
result = await view.interaction_check(mock_discord_interaction)
|
||||
|
||||
assert result is True
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_interaction_check_wrong_guild(self, mock_pterodactyl_api,
|
||||
sample_server_data, mock_discord_interaction):
|
||||
"""
|
||||
Test interaction check rejects wrong guild.
|
||||
|
||||
Args:
|
||||
mock_pterodactyl_api: Pytest fixture providing mocked API instance
|
||||
sample_server_data: Pytest fixture providing sample server data
|
||||
mock_discord_interaction: Pytest fixture providing mocked Discord interaction
|
||||
"""
|
||||
view = ServerStatusView('abc123', 'Test Server',
|
||||
mock_pterodactyl_api, sample_server_data)
|
||||
|
||||
mock_discord_interaction.guild_id = 999999999 # Wrong guild
|
||||
|
||||
result = await view.interaction_check(mock_discord_interaction)
|
||||
|
||||
assert result is False
|
||||
mock_discord_interaction.response.send_message.assert_called_once()
|
||||
|
||||
|
||||
class TestPterodactylBot:
|
||||
"""Test main bot class."""
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_bot_initialization(self):
|
||||
"""
|
||||
Test bot initialization with default values.
|
||||
"""
|
||||
intents = discord.Intents.default()
|
||||
bot = PterodactylBot(command_prefix="!", intents=intents)
|
||||
|
||||
assert bot.server_cache == {}
|
||||
assert bot.embed_locations == {}
|
||||
assert bot.metrics_manager is not None
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_track_new_embed(self):
|
||||
"""
|
||||
Test tracking new embed location in storage.
|
||||
"""
|
||||
intents = discord.Intents.default()
|
||||
bot = PterodactylBot(command_prefix="!", intents=intents)
|
||||
|
||||
mock_message = Mock()
|
||||
mock_message.channel = Mock()
|
||||
mock_message.channel.id = 123456
|
||||
mock_message.id = 789012
|
||||
|
||||
with patch.object(bot, 'save_embed_locations', new=AsyncMock()):
|
||||
await bot.track_new_embed('abc123', mock_message)
|
||||
|
||||
assert 'abc123' in bot.embed_locations
|
||||
assert bot.embed_locations['abc123']['channel_id'] == '123456'
|
||||
assert bot.embed_locations['abc123']['message_id'] == '789012'
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_load_embed_locations(self, tmp_path):
|
||||
"""
|
||||
Test loading embed locations from JSON file.
|
||||
|
||||
Args:
|
||||
tmp_path: Pytest fixture providing temporary directory
|
||||
"""
|
||||
intents = discord.Intents.default()
|
||||
bot = PterodactylBot(command_prefix="!", intents=intents)
|
||||
|
||||
# Create temporary embed locations file
|
||||
embed_file = tmp_path / "embed_locations.json"
|
||||
test_data = {
|
||||
'abc123': {
|
||||
'channel_id': '123456',
|
||||
'message_id': '789012'
|
||||
}
|
||||
}
|
||||
embed_file.write_text(json.dumps(test_data))
|
||||
|
||||
bot.embed_storage_path = embed_file
|
||||
await bot.load_embed_locations()
|
||||
|
||||
assert 'abc123' in bot.embed_locations
|
||||
assert bot.embed_locations['abc123']['channel_id'] == '123456'
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_save_embed_locations(self, tmp_path):
|
||||
"""
|
||||
Test saving embed locations to JSON file.
|
||||
|
||||
Args:
|
||||
tmp_path: Pytest fixture providing temporary directory
|
||||
"""
|
||||
intents = discord.Intents.default()
|
||||
bot = PterodactylBot(command_prefix="!", intents=intents)
|
||||
|
||||
embed_file = tmp_path / "embed_locations.json"
|
||||
bot.embed_storage_path = embed_file
|
||||
|
||||
bot.embed_locations = {
|
||||
'abc123': {
|
||||
'channel_id': '123456',
|
||||
'message_id': '789012'
|
||||
}
|
||||
}
|
||||
|
||||
await bot.save_embed_locations()
|
||||
|
||||
assert embed_file.exists()
|
||||
loaded_data = json.loads(embed_file.read_text())
|
||||
assert loaded_data == bot.embed_locations
|
||||
|
||||
|
||||
# ==========================================
|
||||
# INTEGRATION TESTS
|
||||
# ==========================================
|
||||
|
||||
class TestIntegration:
|
||||
"""Integration tests for complete workflows."""
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_server_status_command_flow(self, mock_discord_interaction,
|
||||
sample_server_data, sample_resources_data):
|
||||
"""
|
||||
Test complete server status command flow.
|
||||
|
||||
Args:
|
||||
mock_discord_interaction: Pytest fixture providing mocked Discord interaction
|
||||
sample_server_data: Pytest fixture providing sample server data
|
||||
sample_resources_data: Pytest fixture providing sample resource data
|
||||
"""
|
||||
# This would require extensive mocking of Discord.py internals
|
||||
# Simplified test to verify command registration
|
||||
|
||||
intents = discord.Intents.default()
|
||||
bot = PterodactylBot(command_prefix="!", intents=intents)
|
||||
|
||||
# Verify command exists in tree
|
||||
assert bot.tree is not None
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_metrics_collection_and_graphing(self):
|
||||
"""
|
||||
Test complete metrics collection and graph generation flow.
|
||||
"""
|
||||
manager = ServerMetricsManager()
|
||||
|
||||
# Simulate data collection over time
|
||||
for i in range(6):
|
||||
cpu = 50.0 + (i * 5)
|
||||
memory = 1000.0 + (i * 100)
|
||||
manager.add_server_data('test_server', 'Test Server', cpu, memory)
|
||||
|
||||
graphs = manager.get_server_graphs('test_server')
|
||||
assert graphs is not None
|
||||
assert graphs.has_sufficient_data
|
||||
|
||||
# Generate graphs
|
||||
cpu_graph = graphs.generate_cpu_graph()
|
||||
memory_graph = graphs.generate_memory_graph()
|
||||
combined_graph = graphs.generate_combined_graph()
|
||||
|
||||
# Verify graphs were generated
|
||||
assert cpu_graph is not None
|
||||
assert memory_graph is not None
|
||||
assert combined_graph is not None
|
||||
|
||||
|
||||
# ==========================================
|
||||
# RUN TESTS
|
||||
# ==========================================
|
||||
|
||||
if __name__ == '__main__':
|
||||
pytest.main([__file__, '-v', '--tb=short'])
|
||||
Reference in New Issue
Block a user