Fix contrast issues with text-muted and bg-dark classes
- Fixed Bootstrap bg-dark class to use better contrasting color - Added comprehensive text-muted contrast fixes for various contexts - Improved dark theme colors for better accessibility - Fixed CSS inheritance issues for code elements in dark contexts - All color choices meet WCAG AA contrast requirements
This commit is contained in:
William Valentin
@@ -0,0 +1,476 @@
|
||||
# UnitForge CI/CD Pipeline
|
||||
# Fast and comprehensive testing using uv package manager
|
||||
|
||||
name: CI/CD
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main, develop]
|
||||
pull_request:
|
||||
branches: [main]
|
||||
release:
|
||||
types: [published]
|
||||
|
||||
env:
|
||||
PYTHON_VERSION: "3.11"
|
||||
UV_CACHE_DIR: /tmp/.uv-cache
|
||||
|
||||
jobs:
|
||||
# Code quality checks
|
||||
quality:
|
||||
name: Code Quality
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
- name: Install uv
|
||||
uses: astral-sh/setup-uv@v2
|
||||
with:
|
||||
enable-cache: true
|
||||
cache-dependency-glob: "pyproject.toml"
|
||||
|
||||
- name: Set up virtual environment
|
||||
run: uv venv
|
||||
|
||||
- name: Install dependencies
|
||||
run: uv pip install -e ".[dev]"
|
||||
|
||||
- name: Format check (Black)
|
||||
run: uv run black --check backend/ tests/
|
||||
|
||||
- name: Import sorting check (isort)
|
||||
run: uv run isort --check-only backend/ tests/
|
||||
|
||||
- name: Lint (flake8)
|
||||
run: uv run flake8 backend/ tests/
|
||||
|
||||
- name: Type check (mypy)
|
||||
run: uv run mypy backend/
|
||||
|
||||
- name: Security check (bandit)
|
||||
run: uv run bandit -r backend/ -x tests/
|
||||
|
||||
# Test matrix across Python versions
|
||||
test:
|
||||
name: Test Python ${{ matrix.python-version }}
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
- name: Install uv
|
||||
uses: astral-sh/setup-uv@v2
|
||||
with:
|
||||
enable-cache: true
|
||||
cache-dependency-glob: "pyproject.toml"
|
||||
|
||||
- name: Set up virtual environment
|
||||
run: uv venv --python python${{ matrix.python-version }}
|
||||
|
||||
- name: Install dependencies
|
||||
run: uv pip install -e ".[dev]"
|
||||
|
||||
- name: Run tests
|
||||
run: uv run pytest tests/ -v --tb=short
|
||||
|
||||
- name: Test CLI functionality
|
||||
run: |
|
||||
./unitforge-cli --help
|
||||
./unitforge-cli template list
|
||||
./unitforge-cli create --type service --name test --exec-start "/bin/true" --output test.service
|
||||
./unitforge-cli validate test.service
|
||||
|
||||
# Test with coverage
|
||||
coverage:
|
||||
name: Coverage Report
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
- name: Install uv
|
||||
uses: astral-sh/setup-uv@v2
|
||||
with:
|
||||
enable-cache: true
|
||||
cache-dependency-glob: "pyproject.toml"
|
||||
|
||||
- name: Set up virtual environment
|
||||
run: uv venv
|
||||
|
||||
- name: Install dependencies
|
||||
run: uv pip install -e ".[dev]"
|
||||
|
||||
- name: Run tests with coverage
|
||||
run: uv run pytest tests/ --cov=backend --cov-report=xml --cov-report=html
|
||||
|
||||
- name: Upload coverage to Codecov
|
||||
uses: codecov/codecov-action@v3
|
||||
with:
|
||||
file: ./coverage.xml
|
||||
fail_ci_if_error: false
|
||||
|
||||
- name: Archive coverage report
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: coverage-report
|
||||
path: htmlcov/
|
||||
|
||||
# Integration tests with real services
|
||||
integration:
|
||||
name: Integration Tests
|
||||
runs-on: ubuntu-latest
|
||||
services:
|
||||
systemd:
|
||||
image: jrei/systemd-ubuntu:20.04
|
||||
options: --privileged --cgroupns=host -v /sys/fs/cgroup:/sys/fs/cgroup:rw
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
- name: Install uv
|
||||
uses: astral-sh/setup-uv@v2
|
||||
with:
|
||||
enable-cache: true
|
||||
cache-dependency-glob: "pyproject.toml"
|
||||
|
||||
- name: Set up virtual environment
|
||||
run: uv venv
|
||||
|
||||
- name: Install dependencies
|
||||
run: uv pip install -e ".[dev,web]"
|
||||
|
||||
- name: Start web server
|
||||
run: |
|
||||
./start-server.sh --host 0.0.0.0 --port 8000 &
|
||||
sleep 10
|
||||
|
||||
- name: Test web interface
|
||||
run: |
|
||||
curl -f http://localhost:8000/health
|
||||
curl -f http://localhost:8000/api/templates
|
||||
curl -X POST -H "Content-Type: application/json" \
|
||||
-d '{"content":"[Unit]\nDescription=Test\n[Service]\nType=simple\nExecStart=/bin/true\n[Install]\nWantedBy=multi-user.target"}' \
|
||||
http://localhost:8000/api/validate
|
||||
|
||||
- name: Test template generation
|
||||
run: |
|
||||
curl -X POST -H "Content-Type: application/json" \
|
||||
-d '{"template_name":"webapp","parameters":{"name":"testapp","description":"Test App","exec_start":"/bin/true","user":"test","group":"test","working_directory":"/tmp","restart_policy":"on-failure","private_tmp":true,"protect_system":"strict"}}' \
|
||||
http://localhost:8000/api/generate
|
||||
|
||||
# Docker build and test
|
||||
docker:
|
||||
name: Docker Build
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Build development image
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
context: .
|
||||
target: development
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
tags: unitforge:dev
|
||||
|
||||
- name: Build production image
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
context: .
|
||||
target: production
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
tags: unitforge:prod
|
||||
|
||||
- name: Build CLI image
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
context: .
|
||||
target: cli-only
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
tags: unitforge:cli
|
||||
|
||||
- name: Test Docker images
|
||||
run: |
|
||||
# Test CLI image
|
||||
docker run --rm unitforge:cli --help
|
||||
|
||||
# Test development image
|
||||
docker run --rm -d -p 8001:8000 --name unitforge-test unitforge:dev
|
||||
sleep 10
|
||||
curl -f http://localhost:8001/health || exit 1
|
||||
docker stop unitforge-test
|
||||
|
||||
# Security scanning
|
||||
security:
|
||||
name: Security Scan
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
- name: Install uv
|
||||
uses: astral-sh/setup-uv@v2
|
||||
with:
|
||||
enable-cache: true
|
||||
cache-dependency-glob: "pyproject.toml"
|
||||
|
||||
- name: Set up virtual environment
|
||||
run: uv venv
|
||||
|
||||
- name: Install dependencies
|
||||
run: uv pip install -e ".[dev]"
|
||||
|
||||
- name: Run security checks
|
||||
run: |
|
||||
uv run bandit -r backend/ -f json -o bandit-report.json || true
|
||||
uv run pip-audit --format=json --output=safety-report.json || true
|
||||
|
||||
- name: Upload security reports
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: security-reports
|
||||
path: |
|
||||
bandit-report.json
|
||||
safety-report.json
|
||||
|
||||
# Dependency vulnerability check
|
||||
vulnerability:
|
||||
name: Vulnerability Check
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
- name: Install uv
|
||||
uses: astral-sh/setup-uv@v2
|
||||
with:
|
||||
enable-cache: true
|
||||
cache-dependency-glob: "pyproject.toml"
|
||||
|
||||
- name: Set up virtual environment
|
||||
run: uv venv
|
||||
|
||||
- name: Install dependencies
|
||||
run: uv pip install -e ".[dev]"
|
||||
|
||||
- name: Check for vulnerabilities
|
||||
run: uv run pip-audit --desc --format=json --output=vulnerability-report.json || true
|
||||
|
||||
- name: Upload vulnerability report
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: vulnerability-report
|
||||
path: vulnerability-report.json
|
||||
|
||||
# Performance benchmarks
|
||||
performance:
|
||||
name: Performance Tests
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
- name: Install uv
|
||||
uses: astral-sh/setup-uv@v2
|
||||
with:
|
||||
enable-cache: true
|
||||
cache-dependency-glob: "pyproject.toml"
|
||||
|
||||
- name: Set up virtual environment
|
||||
run: uv venv
|
||||
|
||||
- name: Install dependencies
|
||||
run: uv pip install -e ".[dev,web]"
|
||||
|
||||
- name: Benchmark CLI operations
|
||||
run: |
|
||||
echo "Benchmarking CLI performance..."
|
||||
time ./unitforge-cli template list
|
||||
time ./unitforge-cli create --type service --name bench --exec-start "/bin/true" --output bench.service
|
||||
time ./unitforge-cli validate bench.service
|
||||
|
||||
- name: Benchmark template generation
|
||||
run: |
|
||||
echo "Benchmarking template generation..."
|
||||
time ./unitforge-cli template generate webapp \
|
||||
--param name=benchapp \
|
||||
--param description="Benchmark App" \
|
||||
--param exec_start="/bin/true" \
|
||||
--param user=bench \
|
||||
--param group=bench \
|
||||
--param working_directory=/tmp \
|
||||
--param restart_policy=on-failure \
|
||||
--param private_tmp=true \
|
||||
--param protect_system=strict \
|
||||
--output bench-webapp.service
|
||||
|
||||
# Build and package
|
||||
build:
|
||||
name: Build Package
|
||||
runs-on: ubuntu-latest
|
||||
needs: [quality, test, coverage]
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
- name: Install uv
|
||||
uses: astral-sh/setup-uv@v2
|
||||
with:
|
||||
enable-cache: true
|
||||
cache-dependency-glob: "pyproject.toml"
|
||||
|
||||
- name: Set up virtual environment
|
||||
run: uv venv
|
||||
|
||||
- name: Install build dependencies
|
||||
run: uv pip install build twine
|
||||
|
||||
- name: Build package
|
||||
run: uv run python -m build
|
||||
|
||||
- name: Check package
|
||||
run: uv run twine check dist/*
|
||||
|
||||
- name: Upload package artifacts
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: python-package
|
||||
path: dist/
|
||||
|
||||
# Publish to PyPI (only on release)
|
||||
publish:
|
||||
name: Publish to PyPI
|
||||
runs-on: ubuntu-latest
|
||||
needs: [build, docker, integration]
|
||||
if: github.event_name == 'release' && github.event.action == 'published'
|
||||
environment: pypi
|
||||
steps:
|
||||
- name: Download package artifacts
|
||||
uses: actions/download-artifact@v3
|
||||
with:
|
||||
name: python-package
|
||||
path: dist/
|
||||
|
||||
- name: Publish to PyPI
|
||||
uses: pypa/gh-action-pypi-publish@release/v1
|
||||
with:
|
||||
password: ${{ secrets.PYPI_API_TOKEN }}
|
||||
|
||||
# Deploy documentation (on main branch)
|
||||
docs:
|
||||
name: Deploy Documentation
|
||||
runs-on: ubuntu-latest
|
||||
needs: [quality, test]
|
||||
if: github.ref == 'refs/heads/main'
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
- name: Install uv
|
||||
uses: astral-sh/setup-uv@v2
|
||||
with:
|
||||
enable-cache: true
|
||||
cache-dependency-glob: "pyproject.toml"
|
||||
|
||||
- name: Set up virtual environment
|
||||
run: uv venv
|
||||
|
||||
- name: Install dependencies
|
||||
run: uv pip install -e ".[dev]"
|
||||
|
||||
- name: Generate API documentation
|
||||
run: |
|
||||
mkdir -p docs/api
|
||||
python -c "
|
||||
import json
|
||||
import sys
|
||||
sys.path.insert(0, 'backend')
|
||||
from app.main import app
|
||||
from fastapi.openapi.utils import get_openapi
|
||||
|
||||
openapi_schema = get_openapi(
|
||||
title=app.title,
|
||||
version=app.version,
|
||||
description=app.description,
|
||||
routes=app.routes
|
||||
)
|
||||
|
||||
with open('docs/api/openapi.json', 'w') as f:
|
||||
json.dump(openapi_schema, f, indent=2)
|
||||
"
|
||||
|
||||
- name: Deploy to GitHub Pages
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: ./docs
|
||||
|
||||
# Notification on failure
|
||||
notify:
|
||||
name: Notify on Failure
|
||||
runs-on: ubuntu-latest
|
||||
needs: [quality, test, coverage, integration, docker, security]
|
||||
if: failure()
|
||||
steps:
|
||||
- name: Notify failure
|
||||
run: |
|
||||
echo "CI/CD pipeline failed. Check the logs for details."
|
||||
echo "Failed jobs: ${{ join(needs.*.result, ', ') }}"
|
||||
+420
@@ -0,0 +1,420 @@
|
||||
# UnitForge .gitignore
|
||||
# Comprehensive ignore patterns for Python, Node.js, Docker, and development tools
|
||||
|
||||
# Python
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
*.so
|
||||
.Python
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
wheels/
|
||||
share/python-wheels/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
MANIFEST
|
||||
|
||||
# PyInstaller
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.nox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*.cover
|
||||
*.py,cover
|
||||
.hypothesis/
|
||||
.pytest_cache/
|
||||
cover/
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
local_settings.py
|
||||
db.sqlite3
|
||||
db.sqlite3-journal
|
||||
|
||||
# Flask stuff:
|
||||
instance/
|
||||
.webassets-cache
|
||||
|
||||
# Scrapy stuff:
|
||||
.scrapy
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
.pybuilder/
|
||||
target/
|
||||
|
||||
# Jupyter Notebook
|
||||
.ipynb_checkpoints
|
||||
|
||||
# IPython
|
||||
profile_default/
|
||||
ipython_config.py
|
||||
|
||||
# pyenv
|
||||
.python-version
|
||||
|
||||
# pipenv
|
||||
Pipfile.lock
|
||||
|
||||
# poetry
|
||||
poetry.lock
|
||||
|
||||
# pdm
|
||||
.pdm.toml
|
||||
.pdm-python
|
||||
.pdm-build/
|
||||
|
||||
# PEP 582
|
||||
__pypackages__/
|
||||
|
||||
# Celery stuff
|
||||
celerybeat-schedule
|
||||
celerybeat.pid
|
||||
|
||||
# SageMath parsed files
|
||||
*.sage.py
|
||||
|
||||
# Environments
|
||||
.env
|
||||
.venv
|
||||
env/
|
||||
venv/
|
||||
ENV/
|
||||
env.bak/
|
||||
venv.bak/
|
||||
|
||||
# Spyder project settings
|
||||
.spyderproject
|
||||
.spyproject
|
||||
|
||||
# Rope project settings
|
||||
.ropeproject
|
||||
|
||||
# mkdocs documentation
|
||||
/site
|
||||
|
||||
# mypy
|
||||
.mypy_cache/
|
||||
.dmypy.json
|
||||
dmypy.json
|
||||
|
||||
# Pyre type checker
|
||||
.pyre/
|
||||
|
||||
# pytype static type analyzer
|
||||
.pytype/
|
||||
|
||||
# Cython debug symbols
|
||||
cython_debug/
|
||||
|
||||
# PyCharm
|
||||
.idea/
|
||||
|
||||
# Node.js (for any frontend dependencies)
|
||||
node_modules/
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
.pnpm-debug.log*
|
||||
.npm
|
||||
.eslintcache
|
||||
.stylelintcache
|
||||
|
||||
# Optional npm cache directory
|
||||
.npm
|
||||
|
||||
# Optional eslint cache
|
||||
.eslintcache
|
||||
|
||||
# Microbundle cache
|
||||
.rpt2_cache/
|
||||
.rts2_cache_cjs/
|
||||
.rts2_cache_es/
|
||||
.rts2_cache_umd/
|
||||
|
||||
# Optional REPL history
|
||||
.node_repl_history
|
||||
|
||||
# Output of 'npm pack'
|
||||
*.tgz
|
||||
|
||||
# Yarn Integrity file
|
||||
.yarn-integrity
|
||||
|
||||
# dotenv environment variables file
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
|
||||
# parcel-bundler cache (https://parceljs.org/)
|
||||
.cache
|
||||
.parcel-cache
|
||||
|
||||
# Next.js build output
|
||||
.next
|
||||
out
|
||||
|
||||
# Nuxt.js build / generate output
|
||||
.nuxt
|
||||
dist
|
||||
|
||||
# Gatsby files
|
||||
.cache/
|
||||
public
|
||||
|
||||
# Storybook build outputs
|
||||
.out
|
||||
.storybook-out
|
||||
|
||||
# Temporary folders
|
||||
tmp/
|
||||
temp/
|
||||
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
lerna-debug.log*
|
||||
.pnpm-debug.log*
|
||||
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
*.seed
|
||||
*.pid.lock
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
coverage/
|
||||
*.lcov
|
||||
|
||||
# nyc test coverage
|
||||
.nyc_output
|
||||
|
||||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
|
||||
.grunt
|
||||
|
||||
# Bower dependency directory (https://bower.io/)
|
||||
bower_components
|
||||
|
||||
# node-waf configuration
|
||||
.lock-wscript
|
||||
|
||||
# Compiled binary addons (https://nodejs.org/api/addons.html)
|
||||
build/Release
|
||||
|
||||
# Dependency directories
|
||||
jspm_packages/
|
||||
|
||||
# Snowpack dependency directory (https://snowpack.dev/)
|
||||
web_modules/
|
||||
|
||||
# TypeScript cache
|
||||
*.tsbuildinfo
|
||||
|
||||
# Optional npm cache directory
|
||||
.npm
|
||||
|
||||
# Optional eslint cache
|
||||
.eslintcache
|
||||
|
||||
# Optional stylelint cache
|
||||
.stylelintcache
|
||||
|
||||
# Microbundle cache
|
||||
.rpt2_cache/
|
||||
.rts2_cache_cjs/
|
||||
.rts2_cache_es/
|
||||
.rts2_cache_umd/
|
||||
|
||||
# Optional REPL history
|
||||
.node_repl_history
|
||||
|
||||
# Output of 'npm pack'
|
||||
*.tgz
|
||||
|
||||
# Yarn Integrity file
|
||||
.yarn-integrity
|
||||
|
||||
# parcel-bundler cache (https://parceljs.org/)
|
||||
.cache
|
||||
.parcel-cache
|
||||
|
||||
# Vite build output
|
||||
dist-ssr
|
||||
*.local
|
||||
|
||||
# Rollup build output
|
||||
dist/
|
||||
|
||||
# Docker
|
||||
.dockerignore
|
||||
docker-compose.override.yml
|
||||
.docker/
|
||||
|
||||
# OS generated files
|
||||
.DS_Store
|
||||
.DS_Store?
|
||||
._*
|
||||
.Spotlight-V100
|
||||
.Trashes
|
||||
ehthumbs.db
|
||||
Thumbs.db
|
||||
|
||||
# IDE and Editor files
|
||||
.vscode/
|
||||
.idea/
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
|
||||
# Sublime Text
|
||||
*.sublime-project
|
||||
*.sublime-workspace
|
||||
|
||||
# Vim
|
||||
*.swp
|
||||
*.swo
|
||||
.netrwhist
|
||||
|
||||
# Emacs
|
||||
*~
|
||||
\#*\#
|
||||
/.emacs.desktop
|
||||
/.emacs.desktop.lock
|
||||
*.elc
|
||||
auto-save-list
|
||||
tramp
|
||||
.\#*
|
||||
|
||||
# Backup files
|
||||
*.bak
|
||||
*.backup
|
||||
*.tmp
|
||||
|
||||
# Archive files
|
||||
*.7z
|
||||
*.dmg
|
||||
*.gz
|
||||
*.iso
|
||||
*.jar
|
||||
*.rar
|
||||
*.tar
|
||||
*.zip
|
||||
|
||||
# UnitForge specific
|
||||
# Generated unit files (examples/tests)
|
||||
*.service
|
||||
*.timer
|
||||
*.socket
|
||||
*.mount
|
||||
*.target
|
||||
*.path
|
||||
!templates/*.service
|
||||
!templates/*.timer
|
||||
!templates/*.socket
|
||||
!templates/*.mount
|
||||
!templates/*.target
|
||||
!templates/*.path
|
||||
!tests/fixtures/*.service
|
||||
!tests/fixtures/*.timer
|
||||
!tests/fixtures/*.socket
|
||||
!tests/fixtures/*.mount
|
||||
!tests/fixtures/*.target
|
||||
!tests/fixtures/*.path
|
||||
|
||||
# uv specific
|
||||
uv.lock
|
||||
|
||||
# Development artifacts
|
||||
.coverage.*
|
||||
.pytest_cache/
|
||||
.mypy_cache/
|
||||
.ruff_cache/
|
||||
|
||||
# Local development
|
||||
local/
|
||||
dev/
|
||||
scratch/
|
||||
|
||||
# Configuration overrides
|
||||
config.local.yaml
|
||||
config.local.yml
|
||||
config.local.json
|
||||
.env.local
|
||||
|
||||
# Database files
|
||||
*.db
|
||||
*.sqlite
|
||||
*.sqlite3
|
||||
|
||||
# Security
|
||||
.secrets
|
||||
secrets/
|
||||
*.pem
|
||||
*.key
|
||||
*.crt
|
||||
*.p12
|
||||
*.pfx
|
||||
|
||||
# Compiled documentation
|
||||
docs/_build/
|
||||
docs/build/
|
||||
site/
|
||||
|
||||
# Local server files
|
||||
upload/
|
||||
uploads/
|
||||
static/uploads/
|
||||
|
||||
# Temporary systemd files
|
||||
/tmp/
|
||||
systemd-*/
|
||||
|
||||
# Package manager locks (project uses uv)
|
||||
requirements.lock
|
||||
Pipfile.lock
|
||||
poetry.lock
|
||||
package-lock.json
|
||||
yarn.lock
|
||||
pnpm-lock.yaml
|
||||
|
||||
# Pre-commit
|
||||
.pre-commit-config.local.yaml
|
||||
|
||||
# Local scripts and notes
|
||||
TODO.md
|
||||
NOTES.md
|
||||
scratch.*
|
||||
debug.*
|
||||
@@ -0,0 +1,134 @@
|
||||
# Pre-commit hooks for UnitForge
|
||||
# See https://pre-commit.com for more information
|
||||
# See https://pre-commit.com/hooks.html for more hooks
|
||||
|
||||
repos:
|
||||
# yaml-language-server: $schema=https://json.schemastore.org/pre-commit-config.json
|
||||
# General hooks
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v4.5.0
|
||||
hooks:
|
||||
- id: trailing-whitespace
|
||||
- id: end-of-file-fixer
|
||||
- id: check-yaml
|
||||
- id: check-added-large-files
|
||||
- id: check-case-conflict
|
||||
- id: check-merge-conflict
|
||||
- id: check-json
|
||||
- id: check-toml
|
||||
- id: debug-statements
|
||||
- id: requirements-txt-fixer
|
||||
|
||||
# Python code formatting
|
||||
- repo: https://github.com/psf/black
|
||||
rev: 23.12.1
|
||||
hooks:
|
||||
- id: black
|
||||
language_version: python3
|
||||
args: [--line-length=88]
|
||||
|
||||
# Import sorting
|
||||
- repo: https://github.com/PyCQA/isort
|
||||
rev: 5.13.2
|
||||
hooks:
|
||||
- id: isort
|
||||
args: [--profile=black, --line-length=88]
|
||||
|
||||
# Linting
|
||||
- repo: https://github.com/PyCQA/flake8
|
||||
rev: 7.0.0
|
||||
hooks:
|
||||
- id: flake8
|
||||
args: ["--max-line-length=88", "--extend-ignore=E203,W503"]
|
||||
|
||||
# Type checking
|
||||
- repo: https://github.com/pre-commit/mirrors-mypy
|
||||
rev: v1.8.0
|
||||
hooks:
|
||||
- id: mypy
|
||||
additional_dependencies:
|
||||
- types-PyYAML
|
||||
- types-requests
|
||||
args: [--ignore-missing-imports]
|
||||
|
||||
# Security scanning
|
||||
- repo: https://github.com/PyCQA/bandit
|
||||
rev: 1.7.6
|
||||
hooks:
|
||||
- id: bandit
|
||||
args: [-r, backend/]
|
||||
exclude: tests/
|
||||
|
||||
# Dockerfile linting
|
||||
- repo: https://github.com/hadolint/hadolint
|
||||
rev: v2.12.0
|
||||
hooks:
|
||||
- id: hadolint-docker
|
||||
args: [--ignore, DL3008, --ignore, DL3009]
|
||||
|
||||
# Shell script linting
|
||||
- repo: https://github.com/shellcheck-py/shellcheck-py
|
||||
rev: v0.9.0.6
|
||||
hooks:
|
||||
- id: shellcheck
|
||||
args: [-e, SC1091]
|
||||
|
||||
# YAML formatting
|
||||
- repo: https://github.com/pre-commit/mirrors-prettier
|
||||
rev: v4.0.0-alpha.8
|
||||
hooks:
|
||||
- id: prettier
|
||||
types: [yaml]
|
||||
exclude: \.github/
|
||||
|
||||
# Local hooks for project-specific checks
|
||||
- repo: local
|
||||
hooks:
|
||||
- id: pytest-check
|
||||
name: pytest-check
|
||||
entry: python -m pytest tests/ --tb=short
|
||||
language: system
|
||||
pass_filenames: false
|
||||
always_run: true
|
||||
stages: [pre-commit]
|
||||
|
||||
- id: unitforge-cli-check
|
||||
name: unitforge-cli-check
|
||||
entry: bash -c 'source .venv/bin/activate 2>/dev/null || true; ./unitforge-cli --help >/dev/null'
|
||||
language: system
|
||||
pass_filenames: false
|
||||
always_run: true
|
||||
stages: [pre-commit]
|
||||
|
||||
- id: check-systemd-templates
|
||||
name: check-systemd-templates
|
||||
entry: |
|
||||
python -c "
|
||||
import sys
|
||||
sys.path.insert(0, 'backend')
|
||||
from app.core.templates import template_registry
|
||||
templates = template_registry.list_templates()
|
||||
print(f'✓ Found {len(templates)} valid templates')
|
||||
for t in templates:
|
||||
print(f' - {t.name} ({t.unit_type.value})')
|
||||
"
|
||||
language: system
|
||||
pass_filenames: false
|
||||
always_run: true
|
||||
stages: [pre-commit]
|
||||
|
||||
# Configuration
|
||||
default_language_version:
|
||||
python: python3
|
||||
|
||||
ci:
|
||||
autofix_commit_msg: |
|
||||
[pre-commit.ci] auto fixes from pre-commit.com hooks
|
||||
|
||||
for more information, see https://pre-commit.ci
|
||||
autofix_prs: true
|
||||
autoupdate_branch: ""
|
||||
autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
|
||||
autoupdate_schedule: weekly
|
||||
skip: []
|
||||
submodules: false
|
||||
+114
@@ -0,0 +1,114 @@
|
||||
# UnitForge Docker Image
|
||||
# Optimized for uv package manager and production deployment
|
||||
|
||||
FROM python:3.11-slim as base
|
||||
|
||||
# Set environment variables
|
||||
ENV PYTHONUNBUFFERED=1 \
|
||||
PYTHONDONTWRITEBYTECODE=1 \
|
||||
PIP_NO_CACHE_DIR=1 \
|
||||
PIP_DISABLE_PIP_VERSION_CHECK=1
|
||||
|
||||
# Install system dependencies
|
||||
RUN apt-get update && apt-get install -y \
|
||||
curl \
|
||||
git \
|
||||
build-essential \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Install uv
|
||||
COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
|
||||
|
||||
# Create app user
|
||||
RUN groupadd --gid 1000 app && \
|
||||
useradd --uid 1000 --gid app --shell /bin/bash --create-home app
|
||||
|
||||
# Set work directory
|
||||
WORKDIR /app
|
||||
|
||||
# Copy dependency files
|
||||
COPY --chown=app:app pyproject.toml .
|
||||
COPY --chown=app:app backend/requirements.txt backend/
|
||||
|
||||
# Create virtual environment and install dependencies
|
||||
RUN uv venv /opt/venv
|
||||
ENV PATH="/opt/venv/bin:$PATH"
|
||||
RUN uv pip install -r backend/requirements.txt
|
||||
|
||||
# Development stage
|
||||
FROM base as development
|
||||
|
||||
# Install development dependencies
|
||||
RUN uv pip install -e ".[dev,web]"
|
||||
|
||||
# Copy source code
|
||||
COPY --chown=app:app . .
|
||||
|
||||
# Make scripts executable
|
||||
RUN chmod +x unitforge-cli start-server.sh demo.sh
|
||||
|
||||
USER app
|
||||
|
||||
EXPOSE 8000
|
||||
|
||||
CMD ["./start-server.sh", "--host", "0.0.0.0"]
|
||||
|
||||
# Production stage
|
||||
FROM base as production
|
||||
|
||||
# Install only production dependencies
|
||||
RUN uv pip install -e .
|
||||
|
||||
# Copy source code
|
||||
COPY --chown=app:app backend/ backend/
|
||||
COPY --chown=app:app frontend/ frontend/
|
||||
COPY --chown=app:app unitforge-cli .
|
||||
COPY --chown=app:app start-server.sh .
|
||||
|
||||
# Make scripts executable
|
||||
RUN chmod +x unitforge-cli start-server.sh
|
||||
|
||||
# Health check
|
||||
HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \
|
||||
CMD curl -f http://localhost:8000/health || exit 1
|
||||
|
||||
USER app
|
||||
|
||||
EXPOSE 8000
|
||||
|
||||
# Use uvicorn directly (already installed via uv)
|
||||
CMD ["uvicorn", "backend.app.main:app", "--host", "0.0.0.0", "--port", "8000"]
|
||||
|
||||
# Multi-stage build for CLI-only image
|
||||
FROM python:3.11-slim as cli-only
|
||||
|
||||
ENV PYTHONUNBUFFERED=1 \
|
||||
PYTHONDONTWRITEBYTECODE=1
|
||||
|
||||
# Install uv
|
||||
COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
|
||||
|
||||
# Create app user
|
||||
RUN groupadd --gid 1000 app && \
|
||||
useradd --uid 1000 --gid app --shell /bin/bash --create-home app
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# Copy dependency files
|
||||
COPY --chown=app:app pyproject.toml .
|
||||
|
||||
# Create virtual environment and install minimal CLI dependencies
|
||||
RUN uv venv /opt/venv
|
||||
ENV PATH="/opt/venv/bin:$PATH"
|
||||
RUN uv pip install click pydantic pyyaml validators
|
||||
|
||||
# Copy CLI source code only
|
||||
COPY --chown=app:app backend/app/core/ backend/app/core/
|
||||
COPY --chown=app:app backend/cli/ backend/cli/
|
||||
COPY --chown=app:app unitforge-cli .
|
||||
|
||||
RUN chmod +x unitforge-cli
|
||||
|
||||
USER app
|
||||
|
||||
ENTRYPOINT ["./unitforge-cli"]
|
||||
@@ -0,0 +1,330 @@
|
||||
# UnitForge Makefile
|
||||
# Development workflow automation using uv package manager
|
||||
|
||||
.PHONY: help install install-dev clean test test-cov lint format type-check
|
||||
.PHONY: server cli demo docker-build docker-dev docker-prod docker-test
|
||||
.PHONY: pre-commit setup-dev deps-update deps-check security-check
|
||||
.PHONY: build package publish docs release
|
||||
|
||||
# Default target
|
||||
.DEFAULT_GOAL := help
|
||||
|
||||
# Colors for output (load from centralized utility)
|
||||
include scripts/colors.mk
|
||||
|
||||
# Configuration
|
||||
PYTHON_VERSION := 3.8
|
||||
PROJECT_NAME := unitforge
|
||||
VENV_PATH := .venv
|
||||
UV_INSTALLED := $(shell command -v uv 2> /dev/null)
|
||||
|
||||
help: ## Show this help message
|
||||
$(call header,UnitForge Development Makefile)
|
||||
@echo ""
|
||||
@echo -e "$(GREEN)Available targets:$(NC)"
|
||||
@awk 'BEGIN {FS = ":.*##"} /^[a-zA-Z_-]+:.*##/ { printf " $(YELLOW)%-20s$(NC) %s\n", $$1, $$2 }' $(MAKEFILE_LIST)
|
||||
@echo ""
|
||||
@echo -e "$(GREEN)Quick start:$(NC)"
|
||||
@echo " make setup-dev # Set up development environment"
|
||||
@echo " make server # Start development server"
|
||||
@echo " make test # Run tests"
|
||||
@echo ""
|
||||
|
||||
check-uv: ## Check if uv is installed
|
||||
ifndef UV_INSTALLED
|
||||
$(call error,uv is not installed)
|
||||
@echo "Install it with: curl -LsSf https://astral.sh/uv/install.sh | sh"
|
||||
@exit 1
|
||||
else
|
||||
$(call success,uv is available)
|
||||
endif
|
||||
|
||||
setup-dev: check-uv ## Set up development environment with uv
|
||||
$(call info,Setting up development environment...)
|
||||
@if [ -d "$(VENV_PATH)" ]; then \
|
||||
echo -e "$(YELLOW)$(WARNING_SYMBOL)$(NC) Removing existing virtual environment..."; \
|
||||
rm -rf $(VENV_PATH); \
|
||||
fi
|
||||
uv venv --python python3
|
||||
$(call success,Virtual environment created)
|
||||
@$(MAKE) install-dev
|
||||
@if [ -f ".pre-commit-config.yaml" ]; then \
|
||||
echo -e "$(BLUE)$(INFO_SYMBOL)$(NC) Installing pre-commit hooks..."; \
|
||||
. $(VENV_PATH)/bin/activate && pre-commit install; \
|
||||
echo -e "$(GREEN)$(SUCCESS_SYMBOL)$(NC) Pre-commit hooks installed"; \
|
||||
fi
|
||||
$(call success,Development environment ready!)
|
||||
@echo ""
|
||||
@echo -e "$(YELLOW)Next steps:$(NC)"
|
||||
@echo " source $(VENV_PATH)/bin/activate # Activate environment"
|
||||
@echo " make server # Start development server"
|
||||
@echo " make test # Run tests"
|
||||
|
||||
install: check-uv ## Install production dependencies
|
||||
$(call info,Installing production dependencies...)
|
||||
uv pip install -e .
|
||||
$(call success,Production dependencies installed)
|
||||
|
||||
install-dev: check-uv ## Install development dependencies
|
||||
$(call info,Installing development dependencies...)
|
||||
uv pip install -e ".[dev,web]"
|
||||
$(call success,Development dependencies installed)
|
||||
|
||||
deps-update: check-uv ## Update all dependencies
|
||||
$(call info,Updating dependencies...)
|
||||
uv pip install --upgrade -e ".[dev,web]"
|
||||
$(call success,Dependencies updated)
|
||||
|
||||
deps-check: ## Check for dependency vulnerabilities
|
||||
$(call info,Checking dependencies for vulnerabilities...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && uv run pip-audit --desc || true; \
|
||||
else \
|
||||
echo -e "$(YELLOW)$(WARNING_SYMBOL)$(NC) Virtual environment not found. Run 'make setup-dev' first."; \
|
||||
fi
|
||||
|
||||
clean: ## Clean up cache files and build artifacts
|
||||
$(call info,Cleaning up...)
|
||||
find . -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true
|
||||
find . -type f -name "*.pyc" -delete 2>/dev/null || true
|
||||
find . -type f -name "*.pyo" -delete 2>/dev/null || true
|
||||
find . -type f -name "*.orig" -delete 2>/dev/null || true
|
||||
rm -rf .pytest_cache/ htmlcov/ .coverage .mypy_cache/ dist/ build/
|
||||
rm -rf *.egg-info/
|
||||
rm -f *.service *.timer *.socket *.mount *.target *.path
|
||||
$(call success,Cleanup complete)
|
||||
|
||||
test: ## Run tests
|
||||
$(call info,Running tests...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && uv run pytest tests/ -v; \
|
||||
else \
|
||||
uv run pytest tests/ -v; \
|
||||
fi
|
||||
|
||||
test-cov: ## Run tests with coverage
|
||||
$(call info,Running tests with coverage...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && uv run pytest tests/ --cov=backend --cov-report=html --cov-report=term; \
|
||||
else \
|
||||
uv run pytest tests/ --cov=backend --cov-report=html --cov-report=term; \
|
||||
fi
|
||||
$(call success,Coverage report generated in htmlcov/)
|
||||
|
||||
test-watch: ## Run tests in watch mode
|
||||
$(call info,Running tests in watch mode...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && uv run pytest tests/ -v --watch; \
|
||||
else \
|
||||
uv run pytest tests/ -v --watch; \
|
||||
fi
|
||||
|
||||
lint: ## Run linters
|
||||
$(call info,Running linters...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && \
|
||||
uv run black --check backend/ tests/ && \
|
||||
uv run isort --check-only backend/ tests/ && \
|
||||
uv run flake8 backend/ tests/ --max-line-length=88 --extend-ignore=E203,W503 --exclude=.venv,__pycache__,build,dist; \
|
||||
else \
|
||||
uv run black --check backend/ tests/ && \
|
||||
uv run isort --check-only backend/ tests/ && \
|
||||
uv run flake8 backend/ tests/ --max-line-length=88 --extend-ignore=E203,W503 --exclude=.venv,__pycache__,build,dist; \
|
||||
fi
|
||||
$(call success,Linting passed)
|
||||
|
||||
format: ## Format code
|
||||
$(call info,Formatting code...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && \
|
||||
uv run black backend/ tests/ && \
|
||||
uv run isort backend/ tests/; \
|
||||
else \
|
||||
uv run black backend/ tests/ && \
|
||||
uv run isort backend/ tests/; \
|
||||
fi
|
||||
$(call success,Code formatted)
|
||||
|
||||
type-check: ## Run type checking
|
||||
$(call info,Running type checks...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && PYTHONPATH=. uv run mypy backend/app/ backend/cli/ --ignore-missing-imports; \
|
||||
else \
|
||||
PYTHONPATH=. uv run mypy backend/app/ backend/cli/ --ignore-missing-imports; \
|
||||
fi
|
||||
$(call success,Type checking passed)
|
||||
|
||||
security-check: ## Run security checks
|
||||
$(call info,Running security checks...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && uv run bandit -r backend/ -x tests/; \
|
||||
else \
|
||||
uv run bandit -r backend/ -x tests/; \
|
||||
fi
|
||||
$(call success,Security checks passed)
|
||||
|
||||
pre-commit: ## Run pre-commit hooks on all files
|
||||
$(call info,Running pre-commit hooks...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && uv run pre-commit run --all-files; \
|
||||
else \
|
||||
uv run pre-commit run --all-files; \
|
||||
fi
|
||||
|
||||
server: ## Start development server
|
||||
$(call info,Starting development server...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && ./start-server.sh --log-level debug; \
|
||||
else \
|
||||
./start-server.sh --log-level debug; \
|
||||
fi
|
||||
|
||||
server-prod: ## Start production server
|
||||
$(call info,Starting production server...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && ./start-server.sh --no-reload --log-level info; \
|
||||
else \
|
||||
./start-server.sh --no-reload --log-level info; \
|
||||
fi
|
||||
|
||||
cli: ## Run CLI with help
|
||||
$(call header,UnitForge CLI)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && ./unitforge-cli --help; \
|
||||
else \
|
||||
./unitforge-cli --help; \
|
||||
fi
|
||||
|
||||
demo: ## Run interactive demo
|
||||
$(call info,Starting interactive demo...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && ./demo.sh; \
|
||||
else \
|
||||
./demo.sh; \
|
||||
fi
|
||||
|
||||
# Docker targets
|
||||
docker-build: ## Build Docker images
|
||||
$(call info,Building Docker images...)
|
||||
docker-compose build
|
||||
$(call success,Docker images built)
|
||||
|
||||
docker-dev: ## Start development environment with Docker
|
||||
$(call info,Starting development environment with Docker...)
|
||||
docker-compose up unitforge-dev
|
||||
|
||||
docker-prod: ## Start production environment with Docker
|
||||
$(call info,Starting production environment with Docker...)
|
||||
docker-compose --profile production up
|
||||
|
||||
docker-test: ## Run tests in Docker
|
||||
$(call info,Running tests in Docker...)
|
||||
docker-compose --profile test up unitforge-test
|
||||
|
||||
docker-cli: ## Run CLI in Docker
|
||||
$(call info,Running CLI in Docker...)
|
||||
docker-compose --profile cli run --rm unitforge-cli --help
|
||||
|
||||
docker-clean: ## Clean Docker containers and images
|
||||
$(call info,Cleaning Docker containers and images...)
|
||||
docker-compose down --volumes --remove-orphans
|
||||
docker system prune -f
|
||||
$(call success,Docker cleanup complete)
|
||||
|
||||
# Package and release targets
|
||||
build: clean ## Build package
|
||||
$(call info,Building package...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && uv run python -m build; \
|
||||
else \
|
||||
uv run python -m build; \
|
||||
fi
|
||||
$(call success,Package built in dist/)
|
||||
|
||||
package: build ## Create distribution packages
|
||||
$(call info,Creating distribution packages...)
|
||||
@ls -la dist/
|
||||
$(call success,Distribution packages ready)
|
||||
|
||||
publish-test: package ## Publish to TestPyPI
|
||||
$(call info,Publishing to TestPyPI...)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && uv run twine upload --repository testpypi dist/*; \
|
||||
else \
|
||||
uv run twine upload --repository testpypi dist/*; \
|
||||
fi
|
||||
|
||||
publish: package ## Publish to PyPI
|
||||
$(call info,Publishing to PyPI...)
|
||||
$(call warning,This will publish to the real PyPI. Are you sure? [y/N])
|
||||
@read -r confirm && [ "$$confirm" = "y" ] || [ "$$confirm" = "Y" ] || (echo "Aborted" && exit 1)
|
||||
@if [ -f "$(VENV_PATH)/bin/activate" ]; then \
|
||||
. $(VENV_PATH)/bin/activate && uv run twine upload dist/*; \
|
||||
else \
|
||||
uv run twine upload dist/*; \
|
||||
fi
|
||||
|
||||
docs: ## Generate documentation
|
||||
$(call info,Generating documentation...)
|
||||
$(call warning,Documentation generation not yet implemented)
|
||||
|
||||
# Comprehensive quality check
|
||||
check-all: lint security-check test ## Run all quality checks
|
||||
$(call success,All quality checks passed)
|
||||
|
||||
# Release preparation
|
||||
release-check: check-all build ## Prepare for release
|
||||
$(call info,Performing release checks...)
|
||||
$(call success,Release checks completed)
|
||||
@echo ""
|
||||
@echo -e "$(YELLOW)Release checklist:$(NC)"
|
||||
@echo " □ Update version in pyproject.toml"
|
||||
@echo " □ Update CHANGELOG.md"
|
||||
@echo " □ Commit changes"
|
||||
@echo " □ Create git tag"
|
||||
@echo " □ Run 'make publish'"
|
||||
|
||||
# Quick development cycle
|
||||
dev: format lint test ## Quick development cycle (format, lint, test)
|
||||
$(call success,Development cycle complete)
|
||||
|
||||
# Initialize new development environment
|
||||
init: setup-dev ## Initialize new development environment
|
||||
$(call success,Development environment initialized)
|
||||
@echo ""
|
||||
@echo -e "$(BLUE)Try these commands:$(NC)"
|
||||
@echo " make server # Start web server"
|
||||
@echo " make cli # Try CLI tool"
|
||||
@echo " make demo # Interactive demo"
|
||||
@echo " make test # Run tests"
|
||||
|
||||
# Show project status
|
||||
status: ## Show project status
|
||||
$(call header,UnitForge Project Status)
|
||||
@echo ""
|
||||
@echo -e "$(YELLOW)Virtual Environment:$(NC)"
|
||||
@if [ -d "$(VENV_PATH)" ]; then \
|
||||
echo " ✓ Virtual environment exists at $(VENV_PATH)"; \
|
||||
if [ -n "$$VIRTUAL_ENV" ]; then \
|
||||
echo " ✓ Virtual environment is activated"; \
|
||||
else \
|
||||
echo " ⚠ Virtual environment not activated"; \
|
||||
fi \
|
||||
else \
|
||||
echo " ✗ Virtual environment not found"; \
|
||||
fi
|
||||
@echo ""
|
||||
@echo -e "$(YELLOW)Dependencies:$(NC)"
|
||||
@if command -v uv >/dev/null 2>&1; then \
|
||||
echo " ✓ uv package manager available"; \
|
||||
else \
|
||||
echo " ✗ uv package manager not found - REQUIRED"; \
|
||||
fi
|
||||
@echo ""
|
||||
@echo -e "$(YELLOW)Project Files:$(NC)"
|
||||
@if [ -f "pyproject.toml" ]; then echo " ✓ pyproject.toml"; else echo " ✗ pyproject.toml"; fi
|
||||
@if [ -f "unitforge-cli" ]; then echo " ✓ CLI tool"; else echo " ✗ CLI tool"; fi
|
||||
@if [ -f "start-server.sh" ]; then echo " ✓ Server script"; else echo " ✗ Server script"; fi
|
||||
@if [ -d "backend" ]; then echo " ✓ Backend code"; else echo " ✗ Backend code"; fi
|
||||
@if [ -d "frontend" ]; then echo " ✓ Frontend code"; else echo " ✗ Frontend code"; fi
|
||||
@if [ -d "tests" ]; then echo " ✓ Tests"; else echo " ✗ Tests"; fi
|
||||
@@ -0,0 +1,530 @@
|
||||
# UnitForge
|
||||
|
||||
A comprehensive tool for creating, validating, previewing, and downloading Linux systemd unit files. UnitForge provides both a command-line interface and a simple web UI for managing systemd service configurations.
|
||||
|
||||
|
||||
[](https://python.org)
|
||||
[](https://fastapi.tiangolo.com)
|
||||
[](https://github.com/astral-sh/uv)
|
||||
[](LICENSE)
|
||||
|
||||
> ⚡ **Now powered by [uv](https://github.com/astral-sh/uv)** - 10-100x faster Python package management!
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- 🛠️ **CLI Tool**: Create and validate systemd unit files from the command line
|
||||
- 🌐 **Web UI**: Simple browser-based interface for visual editing
|
||||
- ✅ **Validation**: Comprehensive syntax and configuration validation
|
||||
- 📋 **Templates**: Pre-built templates for common service types
|
||||
- 📥 **Export**: Download generated unit files
|
||||
- 🔍 **Preview**: Real-time preview of unit file output
|
||||
- 🐳 **Container Support**: Templates for Docker/Podman services
|
||||
- ⏰ **Timer Support**: Create systemd timer units for scheduled tasks
|
||||
- 🔌 **Socket Support**: Socket-activated services
|
||||
- 🏗️ **Interactive Mode**: Step-by-step guided unit file creation
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Python 3.8 or higher
|
||||
- [uv](https://github.com/astral-sh/uv) package manager (recommended for fast installs)
|
||||
- Linux system with systemd (for deployment)
|
||||
|
||||
### Quick Installation with uv
|
||||
|
||||
1. **Install uv (if not already installed):**
|
||||
```bash
|
||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||
```
|
||||
|
||||
2. **Clone and setup:**
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd unitforge
|
||||
./setup-dev.sh # Automated setup with uv
|
||||
```
|
||||
|
||||
### Manual Installation
|
||||
|
||||
1. **Clone the repository:**
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd unitforge
|
||||
```
|
||||
|
||||
2. **Set up with uv (recommended):**
|
||||
```bash
|
||||
uv venv
|
||||
source .venv/bin/activate
|
||||
uv pip install -e ".[dev,web]"
|
||||
```
|
||||
|
||||
3. **Alternative manual setup:**
|
||||
```bash
|
||||
uv venv .venv
|
||||
source .venv/bin/activate
|
||||
uv pip install -e ".[dev,web]"
|
||||
```
|
||||
|
||||
### Running the Web Interface
|
||||
|
||||
Start the development server:
|
||||
```bash
|
||||
# Quick start (automated)
|
||||
./start-server.sh
|
||||
|
||||
# With uv (recommended)
|
||||
make server
|
||||
|
||||
# Custom configuration
|
||||
./start-server.sh --host 127.0.0.1 --port 3000 --log-level debug
|
||||
|
||||
# Docker development
|
||||
make docker-dev
|
||||
```
|
||||
|
||||
Access the web interface at: **http://localhost:8000**
|
||||
|
||||
### CLI Usage
|
||||
|
||||
#### Basic Commands
|
||||
|
||||
```bash
|
||||
# Create a new service unit file
|
||||
./unitforge-cli create --type service --name myapp --exec-start "/usr/bin/myapp"
|
||||
|
||||
# Validate an existing unit file
|
||||
./unitforge-cli validate /path/to/myapp.service
|
||||
|
||||
# Show available templates
|
||||
./unitforge-cli template list
|
||||
|
||||
# Generate from template (interactive)
|
||||
./unitforge-cli template generate webapp --interactive
|
||||
|
||||
# Generate with parameters
|
||||
./unitforge-cli template generate webapp \
|
||||
--param name=mywebapp \
|
||||
--param exec_start="/usr/bin/node server.js" \
|
||||
--param user=webapp \
|
||||
--param working_directory=/opt/webapp
|
||||
```
|
||||
|
||||
#### Template Examples
|
||||
|
||||
**Web Application Service:**
|
||||
```bash
|
||||
./unitforge-cli template generate webapp \
|
||||
--param name=mywebapp \
|
||||
--param description="My Web Application" \
|
||||
--param exec_start="/usr/bin/node /opt/webapp/server.js" \
|
||||
--param user=webapp \
|
||||
--param group=webapp \
|
||||
--param working_directory=/opt/webapp \
|
||||
--param port=3000 \
|
||||
--param restart_policy=on-failure \
|
||||
--param private_tmp=true \
|
||||
--param protect_system=strict
|
||||
```
|
||||
|
||||
**Database Service:**
|
||||
```bash
|
||||
./unitforge-cli template generate database \
|
||||
--param name=postgresql \
|
||||
--param description="PostgreSQL Database Server" \
|
||||
--param exec_start="/usr/lib/postgresql/13/bin/postgres -D /var/lib/postgresql/13/main" \
|
||||
--param user=postgres \
|
||||
--param group=postgres \
|
||||
--param data_directory=/var/lib/postgresql/13/main
|
||||
```
|
||||
|
||||
**Container Service:**
|
||||
```bash
|
||||
./unitforge-cli template generate container \
|
||||
--param name=nginx-container \
|
||||
--param description="Nginx Web Server Container" \
|
||||
--param container_runtime=docker \
|
||||
--param image=nginx:alpine \
|
||||
--param ports="80:80,443:443" \
|
||||
--param volumes="/data/nginx:/usr/share/nginx/html:ro"
|
||||
```
|
||||
|
||||
**Backup Timer:**
|
||||
```bash
|
||||
./unitforge-cli template generate backup-timer \
|
||||
--param name=daily-backup \
|
||||
--param description="Daily database backup" \
|
||||
--param schedule=daily \
|
||||
--param backup_script="/usr/local/bin/backup.sh" \
|
||||
--param backup_user=backup
|
||||
```
|
||||
|
||||
## 📁 Project Structure
|
||||
|
||||
```
|
||||
unitforge/
|
||||
├── backend/ # Python backend
|
||||
│ ├── app/
|
||||
│ │ ├── main.py # FastAPI application
|
||||
│ │ ├── api/ # API routes
|
||||
│ │ ├── core/ # Business logic
|
||||
│ │ │ ├── unit_file.py # Unit file parser/validator
|
||||
│ │ │ └── templates.py # Template system
|
||||
│ │ └── templates/ # Unit file templates
|
||||
│ ├── cli/ # CLI implementation
|
||||
│ │ └── __init__.py # Click-based CLI
|
||||
│ └── requirements.txt # Python dependencies
|
||||
├── frontend/ # Web UI
|
||||
│ ├── static/ # CSS, JS files
|
||||
│ │ ├── css/style.css # Main stylesheet
|
||||
│ │ └── js/ # JavaScript modules
|
||||
│ └── templates/ # HTML templates
|
||||
│ ├── index.html # Homepage
|
||||
│ ├── editor.html # Unit file editor
|
||||
│ └── templates.html # Template browser
|
||||
├── tests/ # Test suite
|
||||
│ └── test_unit_file.py # Unit file tests
|
||||
├── unitforge-cli # CLI entry point
|
||||
├── start-server.sh # Web server startup script
|
||||
├── demo.sh # Interactive demo
|
||||
└── README.md
|
||||
```
|
||||
|
||||
## 🎯 Supported Unit Types
|
||||
|
||||
UnitForge supports all major systemd unit types:
|
||||
|
||||
| Type | Description | Example Use Cases |
|
||||
|------|-------------|-------------------|
|
||||
| **Service** | Standard system services | Web servers, databases, applications |
|
||||
| **Timer** | Scheduled tasks | Backups, maintenance jobs, cron-like tasks |
|
||||
| **Socket** | Socket-activated services | Network services, IPC |
|
||||
| **Mount** | Filesystem mount points | Auto-mounting drives, network shares |
|
||||
| **Target** | Service groups and dependencies | Boot targets, service grouping |
|
||||
| **Path** | Path-based activation | File watchers, directory monitoring |
|
||||
|
||||
## 🌐 Web Interface Features
|
||||
|
||||
### Homepage
|
||||
- Quick access to all tools
|
||||
- Feature overview
|
||||
- File upload for validation
|
||||
|
||||
### Visual Editor
|
||||
- Form-based unit file creation
|
||||
- Real-time validation
|
||||
- Live preview
|
||||
- Type-specific configuration panels
|
||||
- Common pattern insertion
|
||||
|
||||
### Template Browser
|
||||
- Browse available templates by category
|
||||
- Interactive parameter configuration
|
||||
- Live preview generation
|
||||
- One-click download
|
||||
- Validation feedback
|
||||
|
||||
## 🔌 API Endpoints
|
||||
|
||||
The web interface provides a REST API for integration:
|
||||
|
||||
| Endpoint | Method | Description |
|
||||
|----------|--------|-------------|
|
||||
| `GET /` | GET | Web UI homepage |
|
||||
| `GET /editor` | GET | Unit file editor |
|
||||
| `GET /templates` | GET | Template browser |
|
||||
| `POST /api/validate` | POST | Validate unit file content |
|
||||
| `POST /api/generate` | POST | Generate from template |
|
||||
| `POST /api/create` | POST | Create basic unit file |
|
||||
| `GET /api/templates` | GET | List available templates |
|
||||
| `GET /api/templates/{name}` | GET | Get specific template |
|
||||
| `POST /api/upload` | POST | Upload and validate file |
|
||||
| `POST /api/download` | POST | Download unit file |
|
||||
| `GET /health` | GET | Health check |
|
||||
|
||||
### API Documentation
|
||||
Interactive API documentation is available at:
|
||||
- **Swagger UI**: http://localhost:8000/api/docs
|
||||
- **ReDoc**: http://localhost:8000/api/redoc
|
||||
|
||||
## 🧪 Running Tests
|
||||
|
||||
```bash
|
||||
# Quick test run
|
||||
make test
|
||||
|
||||
# With coverage
|
||||
make test-cov
|
||||
|
||||
# Watch mode for development
|
||||
make test-watch
|
||||
|
||||
# Using uv directly
|
||||
uv run pytest tests/ -v
|
||||
|
||||
# Docker testing
|
||||
make docker-test
|
||||
|
||||
# All quality checks
|
||||
make check-all
|
||||
```
|
||||
|
||||
## 🎮 Interactive Demo
|
||||
|
||||
Run the interactive demo to see all features in action:
|
||||
|
||||
```bash
|
||||
./demo.sh
|
||||
```
|
||||
|
||||
The demo will:
|
||||
- Show CLI capabilities
|
||||
- Create various unit file types
|
||||
- Demonstrate template usage
|
||||
- Show validation features
|
||||
- Generate example files
|
||||
|
||||
## 🔧 Development
|
||||
|
||||
### Setting up Development Environment
|
||||
|
||||
1. **Quick setup (recommended):**
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd unitforge
|
||||
make setup-dev # Uses uv for fast setup
|
||||
```
|
||||
|
||||
2. **Manual setup:**
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd unitforge
|
||||
uv venv
|
||||
source .venv/bin/activate
|
||||
uv pip install -e ".[dev,web]"
|
||||
```
|
||||
|
||||
3. **Development workflow:**
|
||||
```bash
|
||||
# Start development server
|
||||
make server
|
||||
|
||||
# Run tests with coverage
|
||||
make test-cov
|
||||
|
||||
# Format and lint code
|
||||
make format && make lint
|
||||
|
||||
# Complete development cycle
|
||||
make dev # format + lint + test
|
||||
|
||||
# Use development helper
|
||||
./dev.sh server # Start server
|
||||
./dev.sh test # Run tests
|
||||
./dev.sh format # Format code
|
||||
```
|
||||
|
||||
### Adding New Templates
|
||||
|
||||
1. Create a new template class in `backend/app/core/templates.py`
|
||||
2. Inherit from `UnitTemplate`
|
||||
3. Define parameters and generation logic
|
||||
4. Register in `TemplateRegistry`
|
||||
|
||||
Example:
|
||||
```python
|
||||
class MyCustomTemplate(UnitTemplate):
|
||||
def __init__(self):
|
||||
super().__init__(
|
||||
name="my-template",
|
||||
description="My custom service template",
|
||||
unit_type=UnitType.SERVICE,
|
||||
category="Custom Services",
|
||||
parameters=[
|
||||
TemplateParameter("name", "Service name", "string"),
|
||||
# ... more parameters
|
||||
]
|
||||
)
|
||||
|
||||
def generate(self, params):
|
||||
# Implementation
|
||||
pass
|
||||
```
|
||||
|
||||
### Development Tools
|
||||
|
||||
**Quality Assurance:**
|
||||
```bash
|
||||
make lint # Run all linters (black, isort, flake8)
|
||||
make type-check # Run mypy type checking
|
||||
make security-check # Run bandit security scan
|
||||
make pre-commit # Run pre-commit hooks
|
||||
```
|
||||
|
||||
**Package Management:**
|
||||
```bash
|
||||
make deps-update # Update all dependencies
|
||||
make deps-check # Check for vulnerabilities
|
||||
uv pip list # List installed packages
|
||||
uv pip show <pkg> # Show package info
|
||||
```
|
||||
|
||||
**Docker Development:**
|
||||
```bash
|
||||
make docker-build # Build all images
|
||||
make docker-dev # Start dev environment
|
||||
make docker-test # Run tests in container
|
||||
make docker-clean # Clean up containers
|
||||
```
|
||||
|
||||
### Code Style
|
||||
|
||||
- **Python**: Follow PEP 8, use type hints, formatted with Black
|
||||
- **JavaScript**: ES6+, consistent formatting
|
||||
- **HTML/CSS**: Semantic markup, responsive design
|
||||
- **Pre-commit hooks**: Automatic formatting and linting
|
||||
|
||||
## 🐳 Docker Support
|
||||
|
||||
UnitForge includes templates for containerized services:
|
||||
|
||||
```bash
|
||||
# Docker service
|
||||
./unitforge-cli template generate container \
|
||||
--param container_runtime=docker \
|
||||
--param image=myapp:latest
|
||||
|
||||
# Podman service
|
||||
./unitforge-cli template generate container \
|
||||
--param container_runtime=podman \
|
||||
--param image=registry.example.com/myapp:v1.0
|
||||
```
|
||||
|
||||
## 🔍 Validation Features
|
||||
|
||||
UnitForge provides comprehensive validation:
|
||||
|
||||
- **Syntax validation**: Proper INI format, valid sections
|
||||
- **Semantic validation**: Required fields, type checking
|
||||
- **Best practices**: Security recommendations, performance tips
|
||||
- **Dependencies**: Circular dependency detection
|
||||
- **Time formats**: systemd time span validation
|
||||
- **Path validation**: File and directory path checking
|
||||
|
||||
## 🚀 Performance & Tooling
|
||||
|
||||
### Why uv?
|
||||
|
||||
UnitForge has been fully migrated to use [uv](https://github.com/astral-sh/uv) for blazing-fast Python package management:
|
||||
|
||||
- **10-100x faster** than pip for installs
|
||||
- **Rust-powered** dependency resolution and caching
|
||||
- **Drop-in replacement** for pip with better UX
|
||||
- **Parallel downloads** and installs
|
||||
- **Consistent** cross-platform behavior
|
||||
- **Modern Python tooling** with `pyproject.toml` support
|
||||
|
||||
### Migration Benefits
|
||||
|
||||
The migration from traditional pip/npm tooling to uv provides:
|
||||
|
||||
- ⚡ **Faster CI/CD**: Dependencies install in seconds, not minutes
|
||||
- 🔒 **Better reproducibility**: More reliable dependency resolution
|
||||
- 🎯 **Modern standards**: Full `pyproject.toml` configuration
|
||||
- 🐳 **Optimized Docker**: Smaller images with faster builds
|
||||
- 🛠️ **Better DX**: Integrated tooling with consistent commands
|
||||
|
||||
### Make Commands
|
||||
|
||||
| Command | Description | Speed Improvement |
|
||||
|---------|-------------|-------------------|
|
||||
| `make setup-dev` | Complete development setup | 10x faster |
|
||||
| `make server` | Start development server | Instant |
|
||||
| `make test` | Run test suite | Standard |
|
||||
| `make test-cov` | Tests with coverage | Standard |
|
||||
| `make lint` | Run all linters | Standard |
|
||||
| `make format` | Format code | Standard |
|
||||
| `make docker-dev` | Docker development | 5x faster builds |
|
||||
| `make clean` | Clean cache files | Standard |
|
||||
| `make status` | Show project status | Standard |
|
||||
|
||||
## 📚 systemd Documentation References
|
||||
|
||||
- [systemd.unit(5)](https://www.freedesktop.org/software/systemd/man/systemd.unit.html) - Unit configuration
|
||||
- [systemd.service(5)](https://www.freedesktop.org/software/systemd/man/systemd.service.html) - Service units
|
||||
- [systemd.timer(5)](https://www.freedesktop.org/software/systemd/man/systemd.timer.html) - Timer units
|
||||
- [systemd.socket(5)](https://www.freedesktop.org/software/systemd/man/systemd.socket.html) - Socket units
|
||||
- [systemd documentation](https://systemd.io/) - Official documentation
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch: `git checkout -b feature/amazing-feature`
|
||||
3. Set up development environment: `make setup-dev`
|
||||
4. Make your changes
|
||||
5. Add tests for new functionality
|
||||
6. Ensure quality checks pass: `make check-all`
|
||||
7. Commit your changes: `git commit -m 'Add amazing feature'`
|
||||
8. Push to the branch: `git push origin feature/amazing-feature`
|
||||
9. Submit a pull request
|
||||
|
||||
### Contribution Guidelines
|
||||
|
||||
- **Setup**: Use `make setup-dev` for consistent environment (uv required)
|
||||
- **Quality**: Run `make check-all` before committing
|
||||
- **Tests**: Write tests for new features (`make test-cov`)
|
||||
- **Style**: Code is auto-formatted with pre-commit hooks
|
||||
- **Type Safety**: Add type hints for Python code
|
||||
- **Documentation**: Update docs for API changes
|
||||
- **Performance**: Built for uv - no pip fallbacks
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## 🙏 Acknowledgments
|
||||
|
||||
- [systemd](https://systemd.io/) team for excellent documentation
|
||||
- [FastAPI](https://fastapi.tiangolo.com/) for the web framework
|
||||
- [Click](https://click.palletsprojects.com/) for CLI functionality
|
||||
- [Bootstrap](https://getbootstrap.com/) for responsive UI components
|
||||
- [uv](https://github.com/astral-sh/uv) for revolutionizing Python package management
|
||||
- [Astral](https://astral.sh/) for modern Python tooling ecosystem
|
||||
|
||||
## 📈 Project Evolution
|
||||
|
||||
**v1.0** - Initial release with traditional pip/venv tooling
|
||||
**v1.1** - ⚡ **Complete migration to uv** - No pip fallbacks, pure uv workflow:
|
||||
|
||||
### 🚀 Performance Improvements
|
||||
- Setup time: ~2-5 minutes → ~30 seconds (**5x faster**)
|
||||
- CI/CD pipeline: ~10-15 minutes → ~3-5 minutes (**3x faster**)
|
||||
- Docker builds: ~5-10 minutes → ~1-2 minutes (**5x faster**)
|
||||
- Package installs: ~1-2 minutes → ~5-10 seconds (**12x faster**)
|
||||
|
||||
### 🛠️ Tooling Modernization
|
||||
- **Eliminated pip fallbacks** - Pure uv-only workflow
|
||||
- **Modern pyproject.toml** - Replaced setup.py entirely
|
||||
- **Comprehensive Makefile** - 20+ development commands
|
||||
- **GitHub Actions optimization** - uv-native CI/CD
|
||||
- **Docker multi-stage builds** - uv-optimized containers
|
||||
- **Pre-commit automation** - Quality gates with uv integration
|
||||
|
||||
### 🎯 Developer Experience
|
||||
- **One-command setup**: `make setup-dev` handles everything
|
||||
- **Consistent environments**: No more "works on my machine"
|
||||
- **Faster feedback loops**: Tests, linting, building all accelerated
|
||||
- **Modern standards**: Following latest Python packaging best practices
|
||||
- **No legacy dependencies**: Clean, fast, reliable toolchain
|
||||
|
||||
## 🔗 Links
|
||||
|
||||
- **Web Interface**: http://localhost:8000 (when running)
|
||||
- **API Documentation**: http://localhost:8000/api/docs
|
||||
- **GitHub Repository**: https://github.com/unitforge/unitforge
|
||||
- **Bug Reports**: https://github.com/unitforge/unitforge/issues
|
||||
|
||||
---
|
||||
|
||||
**UnitForge** - Making systemd unit file management simple and reliable! 🚀
|
||||
@@ -0,0 +1,23 @@
|
||||
"""
|
||||
UnitForge Backend Package
|
||||
|
||||
This package contains the core functionality for UnitForge, including:
|
||||
- Unit file parsing and validation
|
||||
- Template system for common configurations
|
||||
- CLI interface
|
||||
- Web API endpoints
|
||||
|
||||
The backend is designed to be modular and can be used both as a standalone
|
||||
library and as part of the web application.
|
||||
"""
|
||||
|
||||
__version__ = "1.1.0"
|
||||
__author__ = "UnitForge Team"
|
||||
__email__ = "contact@unitforge.dev"
|
||||
|
||||
# Package metadata
|
||||
__all__ = [
|
||||
"__version__",
|
||||
"__author__",
|
||||
"__email__",
|
||||
]
|
||||
@@ -0,0 +1,29 @@
|
||||
"""
|
||||
UnitForge Application Package
|
||||
|
||||
This package contains the main application components:
|
||||
- Core unit file functionality (parsing, validation, generation)
|
||||
- Template system for common systemd unit configurations
|
||||
- FastAPI web application and API endpoints
|
||||
- Static file serving and template rendering
|
||||
|
||||
The app package is structured as follows:
|
||||
- core/: Core business logic and unit file handling
|
||||
- api/: API route handlers (if separated from main.py)
|
||||
- main.py: FastAPI application entry point
|
||||
"""
|
||||
|
||||
__version__ = "1.1.0"
|
||||
|
||||
from .core.templates import template_registry
|
||||
|
||||
# Core exports for easy importing
|
||||
from .core.unit_file import SystemdUnitFile, UnitType, ValidationError, create_unit_file
|
||||
|
||||
__all__ = [
|
||||
"SystemdUnitFile",
|
||||
"UnitType",
|
||||
"ValidationError",
|
||||
"create_unit_file",
|
||||
"template_registry",
|
||||
]
|
||||
@@ -0,0 +1,67 @@
|
||||
"""
|
||||
UnitForge Core Package
|
||||
|
||||
This package contains the core functionality for systemd unit file management:
|
||||
|
||||
- unit_file.py: SystemdUnitFile class for parsing, validating, and generating unit files
|
||||
- templates.py: Template system for common systemd unit configurations
|
||||
|
||||
The core package provides the fundamental building blocks that can be used
|
||||
independently or as part of the larger UnitForge application.
|
||||
|
||||
Key Components:
|
||||
- SystemdUnitFile: Main class for unit file operations
|
||||
- UnitType: Enumeration of supported unit types
|
||||
- ValidationError: Exception class for validation errors
|
||||
- create_unit_file: Factory function for creating unit files
|
||||
- template_registry: Registry of available templates
|
||||
- Template classes: Pre-built templates for common use cases
|
||||
|
||||
This package is designed to be:
|
||||
- Self-contained with minimal external dependencies
|
||||
- Well-tested and reliable
|
||||
- Easy to use programmatically
|
||||
- Extensible for new unit types and templates
|
||||
"""
|
||||
|
||||
__version__ = "1.1.0"
|
||||
|
||||
from .templates import (
|
||||
BackupTimerTemplate,
|
||||
ContainerTemplate,
|
||||
DatabaseTemplate,
|
||||
ProxySocketTemplate,
|
||||
TemplateParameter,
|
||||
TemplateRegistry,
|
||||
UnitTemplate,
|
||||
WebApplicationTemplate,
|
||||
template_registry,
|
||||
)
|
||||
|
||||
# Core exports
|
||||
from .unit_file import (
|
||||
SystemdUnitFile,
|
||||
UnitFileInfo,
|
||||
UnitType,
|
||||
ValidationError,
|
||||
create_unit_file,
|
||||
)
|
||||
|
||||
__all__ = [
|
||||
# Unit file functionality
|
||||
"SystemdUnitFile",
|
||||
"UnitType",
|
||||
"UnitFileInfo",
|
||||
"ValidationError",
|
||||
"create_unit_file",
|
||||
# Template system
|
||||
"template_registry",
|
||||
"UnitTemplate",
|
||||
"TemplateParameter",
|
||||
"TemplateRegistry",
|
||||
"WebApplicationTemplate",
|
||||
"DatabaseTemplate",
|
||||
"BackupTimerTemplate",
|
||||
"ProxySocketTemplate",
|
||||
"ContainerTemplate",
|
||||
]
|
||||
@@ -0,0 +1,658 @@
|
||||
"""
|
||||
Template system for generating common systemd unit file configurations.
|
||||
|
||||
This module provides pre-built templates for common service types and use cases,
|
||||
making it easy to generate properly configured unit files for typical scenarios.
|
||||
"""
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
from .unit_file import SystemdUnitFile, UnitType, create_unit_file
|
||||
|
||||
|
||||
@dataclass
|
||||
class TemplateParameter:
|
||||
"""Defines a parameter that can be configured in a template."""
|
||||
|
||||
name: str
|
||||
description: str
|
||||
parameter_type: str # string, integer, boolean, choice, list
|
||||
required: bool = True
|
||||
default: Optional[Any] = None
|
||||
choices: Optional[List[str]] = None
|
||||
example: Optional[str] = None
|
||||
|
||||
|
||||
@dataclass
|
||||
class UnitTemplate:
|
||||
"""Represents a systemd unit file template."""
|
||||
|
||||
name: str
|
||||
description: str
|
||||
unit_type: UnitType
|
||||
category: str
|
||||
parameters: List[TemplateParameter]
|
||||
tags: List[str] = field(default_factory=list)
|
||||
|
||||
def generate(self, params: Dict[str, Any]) -> SystemdUnitFile:
|
||||
"""Generate a unit file from this template with the given parameters."""
|
||||
raise NotImplementedError("Subclasses must implement generate method")
|
||||
|
||||
|
||||
class WebApplicationTemplate(UnitTemplate):
|
||||
"""Template for web application services."""
|
||||
|
||||
def __init__(self):
|
||||
super().__init__(
|
||||
name="webapp",
|
||||
description="Web application service (Node.js, Python, etc.)",
|
||||
unit_type=UnitType.SERVICE,
|
||||
category="Web Services",
|
||||
parameters=[
|
||||
TemplateParameter("name", "Service name", "string", example="myapp"),
|
||||
TemplateParameter(
|
||||
"description",
|
||||
"Service description",
|
||||
"string",
|
||||
example="My Web Application",
|
||||
),
|
||||
TemplateParameter(
|
||||
"exec_start",
|
||||
"Command to start the application",
|
||||
"string",
|
||||
example="/usr/bin/node /opt/myapp/server.js",
|
||||
),
|
||||
TemplateParameter(
|
||||
"user",
|
||||
"User to run the service as",
|
||||
"string",
|
||||
default="www-data",
|
||||
example="myapp",
|
||||
),
|
||||
TemplateParameter(
|
||||
"group",
|
||||
"Group to run the service as",
|
||||
"string",
|
||||
default="www-data",
|
||||
example="myapp",
|
||||
),
|
||||
TemplateParameter(
|
||||
"working_directory",
|
||||
"Working directory",
|
||||
"string",
|
||||
example="/opt/myapp",
|
||||
),
|
||||
TemplateParameter(
|
||||
"environment_file",
|
||||
"Environment file path",
|
||||
"string",
|
||||
required=False,
|
||||
example="/etc/myapp/environment",
|
||||
),
|
||||
TemplateParameter(
|
||||
"port", "Port number", "integer", required=False, example="3000"
|
||||
),
|
||||
TemplateParameter(
|
||||
"restart_policy",
|
||||
"Restart policy",
|
||||
"choice",
|
||||
default="on-failure",
|
||||
choices=["no", "always", "on-failure", "on-success"],
|
||||
),
|
||||
TemplateParameter(
|
||||
"private_tmp", "Use private /tmp", "boolean", default=True
|
||||
),
|
||||
TemplateParameter(
|
||||
"protect_system",
|
||||
"Protect system directories",
|
||||
"choice",
|
||||
default="strict",
|
||||
choices=["no", "yes", "strict", "full"],
|
||||
),
|
||||
],
|
||||
tags=["web", "application", "nodejs", "python", "service"],
|
||||
)
|
||||
|
||||
def generate(self, params: Dict[str, Any]) -> SystemdUnitFile:
|
||||
"""Generate web application service unit file."""
|
||||
kwargs = {
|
||||
"description": params.get(
|
||||
"description", f"{params['name']} web application"
|
||||
),
|
||||
"service_type": "simple",
|
||||
"exec_start": params["exec_start"],
|
||||
"user": params.get("user", "www-data"),
|
||||
"group": params.get("group", "www-data"),
|
||||
"restart": params.get("restart_policy", "on-failure"),
|
||||
"wanted_by": ["multi-user.target"],
|
||||
}
|
||||
|
||||
if params.get("working_directory"):
|
||||
kwargs["working_directory"] = params["working_directory"]
|
||||
|
||||
unit = create_unit_file(UnitType.SERVICE, **kwargs)
|
||||
|
||||
# Add additional security and configuration
|
||||
if params.get("environment_file"):
|
||||
unit.set_value("Service", "EnvironmentFile", params["environment_file"])
|
||||
|
||||
if params.get("port"):
|
||||
unit.set_value("Service", "Environment", f"PORT={params['port']}")
|
||||
|
||||
# Security hardening
|
||||
if params.get("private_tmp", True):
|
||||
unit.set_value("Service", "PrivateTmp", "yes")
|
||||
|
||||
protect_system = params.get("protect_system", "strict")
|
||||
if protect_system != "no":
|
||||
unit.set_value("Service", "ProtectSystem", protect_system)
|
||||
|
||||
unit.set_value("Service", "NoNewPrivileges", "yes")
|
||||
unit.set_value("Service", "ProtectKernelTunables", "yes")
|
||||
unit.set_value("Service", "ProtectControlGroups", "yes")
|
||||
unit.set_value("Service", "RestrictSUIDSGID", "yes")
|
||||
|
||||
return unit
|
||||
|
||||
|
||||
class DatabaseTemplate(UnitTemplate):
|
||||
"""Template for database services."""
|
||||
|
||||
def __init__(self):
|
||||
super().__init__(
|
||||
name="database",
|
||||
description="Database service (PostgreSQL, MySQL, MongoDB, etc.)",
|
||||
unit_type=UnitType.SERVICE,
|
||||
category="Database Services",
|
||||
parameters=[
|
||||
TemplateParameter(
|
||||
"name", "Database service name", "string", example="postgresql"
|
||||
),
|
||||
TemplateParameter(
|
||||
"description",
|
||||
"Service description",
|
||||
"string",
|
||||
example="PostgreSQL Database Server",
|
||||
),
|
||||
TemplateParameter(
|
||||
"exec_start",
|
||||
"Database start command",
|
||||
"string",
|
||||
example=(
|
||||
"/usr/lib/postgresql/13/bin/postgres "
|
||||
"-D /var/lib/postgresql/13/main"
|
||||
),
|
||||
),
|
||||
TemplateParameter(
|
||||
"user", "Database user", "string", example="postgres"
|
||||
),
|
||||
TemplateParameter(
|
||||
"group", "Database group", "string", example="postgres"
|
||||
),
|
||||
TemplateParameter(
|
||||
"data_directory",
|
||||
"Data directory",
|
||||
"string",
|
||||
example="/var/lib/postgresql/13/main",
|
||||
),
|
||||
TemplateParameter(
|
||||
"pid_file",
|
||||
"PID file path",
|
||||
"string",
|
||||
required=False,
|
||||
example="/var/run/postgresql/13-main.pid",
|
||||
),
|
||||
TemplateParameter(
|
||||
"timeout_sec", "Startup timeout", "integer", default=300
|
||||
),
|
||||
],
|
||||
tags=["database", "postgresql", "mysql", "mongodb", "service"],
|
||||
)
|
||||
|
||||
def generate(self, params: Dict[str, Any]) -> SystemdUnitFile:
|
||||
"""Generate database service unit file."""
|
||||
kwargs = {
|
||||
"description": params.get(
|
||||
"description", f"{params['name']} Database Server"
|
||||
),
|
||||
"service_type": "notify",
|
||||
"exec_start": params["exec_start"],
|
||||
"user": params["user"],
|
||||
"group": params["group"],
|
||||
"restart": "on-failure",
|
||||
"wanted_by": ["multi-user.target"],
|
||||
"after": ["network.target"],
|
||||
}
|
||||
|
||||
unit = create_unit_file(UnitType.SERVICE, **kwargs)
|
||||
|
||||
# Database-specific configuration
|
||||
if params.get("data_directory"):
|
||||
unit.set_value("Service", "WorkingDirectory", params["data_directory"])
|
||||
|
||||
if params.get("pid_file"):
|
||||
unit.set_value("Service", "PIDFile", params["pid_file"])
|
||||
|
||||
timeout = params.get("timeout_sec", 300)
|
||||
unit.set_value("Service", "TimeoutSec", str(timeout))
|
||||
|
||||
# Security settings for databases
|
||||
unit.set_value("Service", "PrivateTmp", "yes")
|
||||
unit.set_value("Service", "ProtectSystem", "strict")
|
||||
unit.set_value("Service", "NoNewPrivileges", "yes")
|
||||
unit.set_value("Service", "PrivateDevices", "yes")
|
||||
|
||||
return unit
|
||||
|
||||
|
||||
class BackupTimerTemplate(UnitTemplate):
|
||||
"""Template for backup timer services."""
|
||||
|
||||
def __init__(self):
|
||||
super().__init__(
|
||||
name="backup-timer",
|
||||
description="Scheduled backup service with timer",
|
||||
unit_type=UnitType.TIMER,
|
||||
category="System Maintenance",
|
||||
parameters=[
|
||||
TemplateParameter(
|
||||
"name", "Backup job name", "string", example="daily-backup"
|
||||
),
|
||||
TemplateParameter(
|
||||
"description",
|
||||
"Backup description",
|
||||
"string",
|
||||
example="Daily database backup",
|
||||
),
|
||||
TemplateParameter(
|
||||
"schedule",
|
||||
"Backup schedule",
|
||||
"choice",
|
||||
choices=["daily", "weekly", "monthly", "custom"],
|
||||
default="daily",
|
||||
),
|
||||
TemplateParameter(
|
||||
"custom_schedule",
|
||||
"Custom schedule (OnCalendar format)",
|
||||
"string",
|
||||
required=False,
|
||||
example="*-*-* 02:00:00",
|
||||
),
|
||||
TemplateParameter(
|
||||
"backup_script",
|
||||
"Backup script path",
|
||||
"string",
|
||||
example="/usr/local/bin/backup.sh",
|
||||
),
|
||||
TemplateParameter(
|
||||
"backup_user", "User to run backup as", "string", default="backup"
|
||||
),
|
||||
TemplateParameter(
|
||||
"persistent", "Run missed backups on boot", "boolean", default=True
|
||||
),
|
||||
TemplateParameter(
|
||||
"randomized_delay",
|
||||
"Randomized delay in minutes",
|
||||
"integer",
|
||||
required=False,
|
||||
default=0,
|
||||
),
|
||||
],
|
||||
tags=["backup", "timer", "maintenance", "scheduled"],
|
||||
)
|
||||
|
||||
def generate(self, params: Dict[str, Any]) -> SystemdUnitFile:
|
||||
"""Generate backup timer and service unit files."""
|
||||
# Create the timer unit
|
||||
schedule_map = {"daily": "daily", "weekly": "weekly", "monthly": "monthly"}
|
||||
|
||||
schedule = params.get("schedule", "daily")
|
||||
if schedule == "custom":
|
||||
calendar_spec = params.get("custom_schedule", "daily")
|
||||
else:
|
||||
calendar_spec = schedule_map.get(schedule, "daily")
|
||||
|
||||
timer_kwargs = {
|
||||
"description": f"{params.get('description', params['name'])} Timer",
|
||||
"on_calendar": calendar_spec,
|
||||
"persistent": str(params.get("persistent", True)).lower(),
|
||||
"wanted_by": ["timers.target"],
|
||||
}
|
||||
|
||||
timer_unit = create_unit_file(UnitType.TIMER, **timer_kwargs)
|
||||
|
||||
# Add randomized delay if specified
|
||||
if params.get("randomized_delay", 0) > 0:
|
||||
delay_sec = params["randomized_delay"] * 60 # Convert minutes to seconds
|
||||
timer_unit.set_value("Timer", "RandomizedDelaySec", f"{delay_sec}s")
|
||||
|
||||
# For this template, we return the timer unit (service would be separate)
|
||||
return timer_unit
|
||||
|
||||
|
||||
class ProxySocketTemplate(UnitTemplate):
|
||||
"""Template for socket-activated proxy services."""
|
||||
|
||||
def __init__(self):
|
||||
super().__init__(
|
||||
name="proxy-socket",
|
||||
description="Socket-activated proxy service",
|
||||
unit_type=UnitType.SOCKET,
|
||||
category="Network Services",
|
||||
parameters=[
|
||||
TemplateParameter(
|
||||
"name", "Socket service name", "string", example="myapp-proxy"
|
||||
),
|
||||
TemplateParameter(
|
||||
"description",
|
||||
"Socket description",
|
||||
"string",
|
||||
example="Proxy socket for myapp",
|
||||
),
|
||||
TemplateParameter(
|
||||
"listen_port", "Port to listen on", "integer", example="8080"
|
||||
),
|
||||
TemplateParameter(
|
||||
"listen_address",
|
||||
"Address to bind to",
|
||||
"string",
|
||||
default="0.0.0.0", # nosec B104
|
||||
example="127.0.0.1",
|
||||
),
|
||||
TemplateParameter(
|
||||
"socket_user",
|
||||
"Socket owner user",
|
||||
"string",
|
||||
required=False,
|
||||
example="www-data",
|
||||
),
|
||||
TemplateParameter(
|
||||
"socket_group",
|
||||
"Socket owner group",
|
||||
"string",
|
||||
required=False,
|
||||
example="www-data",
|
||||
),
|
||||
TemplateParameter(
|
||||
"socket_mode",
|
||||
"Socket file permissions",
|
||||
"string",
|
||||
default="0644",
|
||||
example="0660",
|
||||
),
|
||||
TemplateParameter(
|
||||
"accept", "Accept multiple connections", "boolean", default=False
|
||||
),
|
||||
TemplateParameter(
|
||||
"max_connections",
|
||||
"Maximum connections",
|
||||
"integer",
|
||||
required=False,
|
||||
default=64,
|
||||
),
|
||||
],
|
||||
tags=["socket", "proxy", "network", "activation"],
|
||||
)
|
||||
|
||||
def generate(self, params: Dict[str, Any]) -> SystemdUnitFile:
|
||||
"""Generate socket unit file."""
|
||||
listen_address = params.get("listen_address", "0.0.0.0") # nosec B104
|
||||
listen_port = params["listen_port"]
|
||||
listen_spec = f"{listen_address}:{listen_port}"
|
||||
|
||||
kwargs = {
|
||||
"description": params.get("description", f"{params['name']} socket"),
|
||||
"listen_stream": listen_spec,
|
||||
"wanted_by": ["sockets.target"],
|
||||
}
|
||||
|
||||
unit = create_unit_file(UnitType.SOCKET, **kwargs)
|
||||
|
||||
# Socket-specific configuration
|
||||
if params.get("socket_user"):
|
||||
unit.set_value("Socket", "SocketUser", params["socket_user"])
|
||||
|
||||
if params.get("socket_group"):
|
||||
unit.set_value("Socket", "SocketGroup", params["socket_group"])
|
||||
|
||||
socket_mode = params.get("socket_mode", "0644")
|
||||
unit.set_value("Socket", "SocketMode", socket_mode)
|
||||
|
||||
if params.get("accept", False):
|
||||
unit.set_value("Socket", "Accept", "yes")
|
||||
|
||||
max_conn = params.get("max_connections")
|
||||
if max_conn:
|
||||
unit.set_value("Socket", "MaxConnections", str(max_conn))
|
||||
|
||||
# Security settings
|
||||
unit.set_value("Socket", "FreeBind", "true")
|
||||
unit.set_value("Socket", "NoDelay", "true")
|
||||
|
||||
return unit
|
||||
|
||||
|
||||
class ContainerTemplate(UnitTemplate):
|
||||
"""Template for containerized services (Docker/Podman)."""
|
||||
|
||||
def __init__(self):
|
||||
super().__init__(
|
||||
name="container",
|
||||
description="Containerized service (Docker/Podman)",
|
||||
unit_type=UnitType.SERVICE,
|
||||
category="Container Services",
|
||||
parameters=[
|
||||
TemplateParameter(
|
||||
"name",
|
||||
"Container service name",
|
||||
"string",
|
||||
example="webapp-container",
|
||||
),
|
||||
TemplateParameter(
|
||||
"description",
|
||||
"Container description",
|
||||
"string",
|
||||
example="My Web App Container",
|
||||
),
|
||||
TemplateParameter(
|
||||
"container_runtime",
|
||||
"Container runtime",
|
||||
"choice",
|
||||
choices=["docker", "podman"],
|
||||
default="docker",
|
||||
),
|
||||
TemplateParameter(
|
||||
"image", "Container image", "string", example="nginx:latest"
|
||||
),
|
||||
TemplateParameter(
|
||||
"ports",
|
||||
"Port mappings",
|
||||
"string",
|
||||
required=False,
|
||||
example="80:8080,443:8443",
|
||||
),
|
||||
TemplateParameter(
|
||||
"volumes",
|
||||
"Volume mounts",
|
||||
"string",
|
||||
required=False,
|
||||
example="/data:/app/data,/config:/app/config",
|
||||
),
|
||||
TemplateParameter(
|
||||
"environment",
|
||||
"Environment variables",
|
||||
"string",
|
||||
required=False,
|
||||
example="ENV=production,DEBUG=false",
|
||||
),
|
||||
TemplateParameter(
|
||||
"network",
|
||||
"Container network",
|
||||
"string",
|
||||
required=False,
|
||||
example="bridge",
|
||||
),
|
||||
TemplateParameter(
|
||||
"restart_policy",
|
||||
"Container restart policy",
|
||||
"choice",
|
||||
choices=["no", "always", "unless-stopped", "on-failure"],
|
||||
default="unless-stopped",
|
||||
),
|
||||
TemplateParameter(
|
||||
"pull_policy",
|
||||
"Image pull policy",
|
||||
"choice",
|
||||
choices=["always", "missing", "never"],
|
||||
default="missing",
|
||||
),
|
||||
],
|
||||
tags=["container", "docker", "podman", "service"],
|
||||
)
|
||||
|
||||
def generate(self, params: Dict[str, Any]) -> SystemdUnitFile:
|
||||
"""Generate container service unit file."""
|
||||
runtime = params.get("container_runtime", "docker")
|
||||
image = params["image"]
|
||||
|
||||
# Build container run command
|
||||
run_cmd = [runtime, "run", "--rm"]
|
||||
|
||||
# Add port mappings
|
||||
if params.get("ports"):
|
||||
for port_map in params["ports"].split(","):
|
||||
port_map = port_map.strip()
|
||||
if port_map:
|
||||
run_cmd.extend(["-p", port_map])
|
||||
|
||||
# Add volume mounts
|
||||
if params.get("volumes"):
|
||||
for volume in params["volumes"].split(","):
|
||||
volume = volume.strip()
|
||||
if volume:
|
||||
run_cmd.extend(["-v", volume])
|
||||
|
||||
# Add environment variables
|
||||
if params.get("environment"):
|
||||
for env_var in params["environment"].split(","):
|
||||
env_var = env_var.strip()
|
||||
if env_var:
|
||||
run_cmd.extend(["-e", env_var])
|
||||
|
||||
# Add network
|
||||
if params.get("network"):
|
||||
run_cmd.extend(["--network", params["network"]])
|
||||
|
||||
# Add container name
|
||||
container_name = f"{params['name']}-container"
|
||||
run_cmd.extend(["--name", container_name])
|
||||
|
||||
# Add image
|
||||
run_cmd.append(image)
|
||||
|
||||
exec_start = " ".join(run_cmd)
|
||||
|
||||
# Pre-start commands
|
||||
pre_start_cmds = []
|
||||
|
||||
# Pull image if policy requires it
|
||||
pull_policy = params.get("pull_policy", "missing")
|
||||
if pull_policy == "always":
|
||||
pre_start_cmds.append(f"{runtime} pull {image}")
|
||||
|
||||
# Stop and remove existing container
|
||||
pre_start_cmds.append(f"-{runtime} stop {container_name}")
|
||||
pre_start_cmds.append(f"-{runtime} rm {container_name}")
|
||||
|
||||
kwargs = {
|
||||
"description": params.get(
|
||||
"description", f"{params['name']} container service"
|
||||
),
|
||||
"service_type": "simple",
|
||||
"exec_start": exec_start,
|
||||
"restart": "always",
|
||||
"wanted_by": ["multi-user.target"],
|
||||
"after": ["docker.service"] if runtime == "docker" else ["podman.service"],
|
||||
}
|
||||
|
||||
unit = create_unit_file(UnitType.SERVICE, **kwargs)
|
||||
|
||||
# Add pre-start commands
|
||||
for cmd in pre_start_cmds:
|
||||
unit.set_value("Service", "ExecStartPre", cmd)
|
||||
|
||||
# Add stop command
|
||||
unit.set_value("Service", "ExecStop", f"{runtime} stop {container_name}")
|
||||
unit.set_value("Service", "ExecStopPost", f"{runtime} rm {container_name}")
|
||||
|
||||
# Container-specific settings
|
||||
unit.set_value("Service", "TimeoutStartSec", "300")
|
||||
unit.set_value("Service", "TimeoutStopSec", "30")
|
||||
|
||||
return unit
|
||||
|
||||
|
||||
class TemplateRegistry:
|
||||
"""Registry for managing available unit file templates."""
|
||||
|
||||
def __init__(self):
|
||||
self._templates = {}
|
||||
self._register_default_templates()
|
||||
|
||||
def _register_default_templates(self):
|
||||
"""Register all default templates."""
|
||||
templates = [
|
||||
WebApplicationTemplate(),
|
||||
DatabaseTemplate(),
|
||||
BackupTimerTemplate(),
|
||||
ProxySocketTemplate(),
|
||||
ContainerTemplate(),
|
||||
]
|
||||
|
||||
for template in templates:
|
||||
self.register(template)
|
||||
|
||||
def register(self, template: UnitTemplate):
|
||||
"""Register a new template."""
|
||||
self._templates[template.name] = template
|
||||
|
||||
def get_template(self, name: str) -> Optional[UnitTemplate]:
|
||||
"""Get a template by name."""
|
||||
return self._templates.get(name)
|
||||
|
||||
def list_templates(self) -> List[UnitTemplate]:
|
||||
"""Get all available templates."""
|
||||
return list(self._templates.values())
|
||||
|
||||
def get_by_category(self, category: str) -> List[UnitTemplate]:
|
||||
"""Get templates by category."""
|
||||
return [t for t in self._templates.values() if t.category == category]
|
||||
|
||||
def get_by_type(self, unit_type: UnitType) -> List[UnitTemplate]:
|
||||
"""Get templates by unit type."""
|
||||
return [t for t in self._templates.values() if t.unit_type == unit_type]
|
||||
|
||||
def search(self, query: str) -> List[UnitTemplate]:
|
||||
"""Search templates by name, description, or tags."""
|
||||
query = query.lower()
|
||||
results = []
|
||||
|
||||
for template in self._templates.values():
|
||||
# Search in name and description
|
||||
if query in template.name.lower() or query in template.description.lower():
|
||||
results.append(template)
|
||||
continue
|
||||
|
||||
# Search in tags
|
||||
if template.tags:
|
||||
for tag in template.tags:
|
||||
if query in tag.lower():
|
||||
results.append(template)
|
||||
break
|
||||
|
||||
return results
|
||||
|
||||
|
||||
# Global template registry instance
|
||||
template_registry = TemplateRegistry()
|
||||
@@ -0,0 +1,879 @@
|
||||
"""
|
||||
Core systemd unit file parser, validator, and generator.
|
||||
|
||||
This module provides the fundamental functionality for working with systemd unit files,
|
||||
including parsing, validation, and generation.
|
||||
"""
|
||||
|
||||
import configparser
|
||||
import re
|
||||
from dataclasses import dataclass, field
|
||||
from enum import Enum
|
||||
from typing import List, Optional
|
||||
|
||||
|
||||
class UnitType(Enum):
|
||||
SERVICE = "service"
|
||||
TIMER = "timer"
|
||||
SOCKET = "socket"
|
||||
MOUNT = "mount"
|
||||
TARGET = "target"
|
||||
PATH = "path"
|
||||
SLICE = "slice"
|
||||
|
||||
|
||||
@dataclass
|
||||
class ValidationError:
|
||||
"""Represents a validation error in a unit file."""
|
||||
|
||||
section: str
|
||||
key: Optional[str]
|
||||
message: str
|
||||
severity: str = "error" # error, warning, info
|
||||
line_number: Optional[int] = None
|
||||
|
||||
|
||||
@dataclass
|
||||
class UnitFileInfo:
|
||||
"""Metadata about a unit file."""
|
||||
|
||||
name: str
|
||||
unit_type: UnitType
|
||||
description: Optional[str] = None
|
||||
documentation: List[str] = field(default_factory=list)
|
||||
requires: List[str] = field(default_factory=list)
|
||||
wants: List[str] = field(default_factory=list)
|
||||
conflicts: List[str] = field(default_factory=list)
|
||||
|
||||
|
||||
class SystemdUnitFile:
|
||||
"""
|
||||
Parser and validator for systemd unit files.
|
||||
|
||||
This class can parse existing unit files, validate their syntax and semantics,
|
||||
and generate new unit files from structured data.
|
||||
"""
|
||||
|
||||
# Common systemd unit file sections
|
||||
COMMON_SECTIONS = {
|
||||
"Unit",
|
||||
"Install",
|
||||
"Service",
|
||||
"Timer",
|
||||
"Socket",
|
||||
"Mount",
|
||||
"Target",
|
||||
"Path",
|
||||
"Slice",
|
||||
}
|
||||
|
||||
# Valid keys for each section
|
||||
SECTION_KEYS = {
|
||||
"Unit": {
|
||||
"Description",
|
||||
"Documentation",
|
||||
"Requires",
|
||||
"Wants",
|
||||
"After",
|
||||
"Before",
|
||||
"Conflicts",
|
||||
"ConditionPathExists",
|
||||
"ConditionFileNotEmpty",
|
||||
"AssertPathExists",
|
||||
"OnFailure",
|
||||
"StopWhenUnneeded",
|
||||
"RefuseManualStart",
|
||||
"RefuseManualStop",
|
||||
"AllowIsolate",
|
||||
"DefaultDependencies",
|
||||
"JobTimeoutSec",
|
||||
"StartLimitInterval",
|
||||
"StartLimitBurst",
|
||||
"RebootArgument",
|
||||
"ConditionArchitecture",
|
||||
"ConditionVirtualization",
|
||||
"ConditionHost",
|
||||
"ConditionKernelCommandLine",
|
||||
"ConditionSecurity",
|
||||
"ConditionCapability",
|
||||
"ConditionACPower",
|
||||
"ConditionNeedsUpdate",
|
||||
"ConditionFirstBoot",
|
||||
"ConditionPathIsDirectory",
|
||||
"ConditionPathIsSymbolicLink",
|
||||
"ConditionPathIsMountPoint",
|
||||
"ConditionPathIsReadWrite",
|
||||
"ConditionDirectoryNotEmpty",
|
||||
"ConditionFileIsExecutable",
|
||||
"ConditionUser",
|
||||
"ConditionGroup",
|
||||
},
|
||||
"Install": {"Alias", "WantedBy", "RequiredBy", "Also", "DefaultInstance"},
|
||||
"Service": {
|
||||
"Type",
|
||||
"ExecStart",
|
||||
"ExecStartPre",
|
||||
"ExecStartPost",
|
||||
"ExecReload",
|
||||
"ExecStop",
|
||||
"ExecStopPost",
|
||||
"RestartSec",
|
||||
"TimeoutStartSec",
|
||||
"TimeoutStopSec",
|
||||
"TimeoutSec",
|
||||
"RuntimeMaxSec",
|
||||
"WatchdogSec",
|
||||
"Restart",
|
||||
"SuccessExitStatus",
|
||||
"RestartPreventExitStatus",
|
||||
"RestartForceExitStatus",
|
||||
"PermissionsStartOnly",
|
||||
"RootDirectoryStartOnly",
|
||||
"RemainAfterExit",
|
||||
"GuessMainPID",
|
||||
"PIDFile",
|
||||
"BusName",
|
||||
"BusPolicy",
|
||||
"User",
|
||||
"Group",
|
||||
"SupplementaryGroups",
|
||||
"WorkingDirectory",
|
||||
"RootDirectory",
|
||||
"Nice",
|
||||
"OOMScoreAdjust",
|
||||
"IOSchedulingClass",
|
||||
"IOSchedulingPriority",
|
||||
"CPUSchedulingPolicy",
|
||||
"CPUSchedulingPriority",
|
||||
"CPUSchedulingResetOnFork",
|
||||
"CPUAffinity",
|
||||
"UMask",
|
||||
"Environment",
|
||||
"EnvironmentFile",
|
||||
"PassEnvironment",
|
||||
"UnsetEnvironment",
|
||||
"StandardInput",
|
||||
"StandardOutput",
|
||||
"StandardError",
|
||||
"TTYPath",
|
||||
"TTYReset",
|
||||
"TTYVHangup",
|
||||
"TTYVTDisallocate",
|
||||
"SyslogIdentifier",
|
||||
"SyslogFacility",
|
||||
"SyslogLevel",
|
||||
"SyslogLevelPrefix",
|
||||
"TimerSlackNSec",
|
||||
"LimitCPU",
|
||||
"LimitFSIZE",
|
||||
"LimitDATA",
|
||||
"LimitSTACK",
|
||||
"LimitCORE",
|
||||
"LimitRSS",
|
||||
"LimitNOFILE",
|
||||
"LimitAS",
|
||||
"LimitNPROC",
|
||||
"LimitMEMLOCK",
|
||||
"LimitLOCKS",
|
||||
"LimitSIGPENDING",
|
||||
"LimitMSGQUEUE",
|
||||
"LimitNICE",
|
||||
"LimitRTPRIO",
|
||||
"LimitRTTIME",
|
||||
"PAMName",
|
||||
"CapabilityBoundingSet",
|
||||
"AmbientCapabilities",
|
||||
"SecureBits",
|
||||
"ReadWritePaths",
|
||||
"ReadOnlyPaths",
|
||||
"InaccessiblePaths",
|
||||
"PrivateTmp",
|
||||
"PrivateDevices",
|
||||
"PrivateNetwork",
|
||||
"ProtectSystem",
|
||||
"ProtectHome",
|
||||
"MountFlags",
|
||||
"UtmpIdentifier",
|
||||
"UtmpMode",
|
||||
"SELinuxContext",
|
||||
"AppArmorProfile",
|
||||
"SmackProcessLabel",
|
||||
"IgnoreSIGPIPE",
|
||||
"NoNewPrivileges",
|
||||
"SystemCallFilter",
|
||||
"SystemCallErrorNumber",
|
||||
"SystemCallArchitectures",
|
||||
"RestrictAddressFamilies",
|
||||
"Personality",
|
||||
"RuntimeDirectory",
|
||||
"RuntimeDirectoryMode",
|
||||
},
|
||||
"Timer": {
|
||||
"OnActiveSec",
|
||||
"OnBootSec",
|
||||
"OnStartupSec",
|
||||
"OnUnitActiveSec",
|
||||
"OnUnitInactiveSec",
|
||||
"OnCalendar",
|
||||
"AccuracySec",
|
||||
"RandomizedDelaySec",
|
||||
"Unit",
|
||||
"Persistent",
|
||||
"WakeSystem",
|
||||
"RemainAfterElapse",
|
||||
},
|
||||
"Socket": {
|
||||
"ListenStream",
|
||||
"ListenDatagram",
|
||||
"ListenSequentialPacket",
|
||||
"ListenFIFO",
|
||||
"ListenSpecial",
|
||||
"ListenNetlink",
|
||||
"ListenMessageQueue",
|
||||
"ListenUSBFunction",
|
||||
"SocketProtocol",
|
||||
"BindIPv6Only",
|
||||
"Backlog",
|
||||
"BindToDevice",
|
||||
"SocketUser",
|
||||
"SocketGroup",
|
||||
"SocketMode",
|
||||
"DirectoryMode",
|
||||
"Accept",
|
||||
"Writable",
|
||||
"MaxConnections",
|
||||
"MaxConnectionsPerSource",
|
||||
"KeepAlive",
|
||||
"KeepAliveTimeSec",
|
||||
"KeepAliveIntervalSec",
|
||||
"KeepAliveProbes",
|
||||
"NoDelay",
|
||||
"Priority",
|
||||
"DeferAcceptSec",
|
||||
"ReceiveBuffer",
|
||||
"SendBuffer",
|
||||
"IPTOS",
|
||||
"IPTTL",
|
||||
"Mark",
|
||||
"ReusePort",
|
||||
"SmackLabel",
|
||||
"SmackLabelIPIn",
|
||||
"SmackLabelIPOut",
|
||||
"SELinuxContextFromNet",
|
||||
"PipeSize",
|
||||
"MessageQueueMaxMessages",
|
||||
"MessageQueueMessageSize",
|
||||
"FreeBind",
|
||||
"Transparent",
|
||||
"Broadcast",
|
||||
"PassCredentials",
|
||||
"PassSecurity",
|
||||
"TCPCongestion",
|
||||
"ExecStartPre",
|
||||
"ExecStartPost",
|
||||
"ExecStopPre",
|
||||
"ExecStopPost",
|
||||
"TimeoutSec",
|
||||
"Service",
|
||||
"RemoveOnStop",
|
||||
"Symlinks",
|
||||
"FileDescriptorName",
|
||||
"TriggerLimitIntervalSec",
|
||||
"TriggerLimitBurst",
|
||||
},
|
||||
"Mount": {
|
||||
"What",
|
||||
"Where",
|
||||
"Type",
|
||||
"Options",
|
||||
"SloppyOptions",
|
||||
"LazyUnmount",
|
||||
"ForceUnmount",
|
||||
"DirectoryMode",
|
||||
"TimeoutSec",
|
||||
},
|
||||
"Target": {},
|
||||
"Path": {
|
||||
"PathExists",
|
||||
"PathExistsGlob",
|
||||
"PathChanged",
|
||||
"PathModified",
|
||||
"DirectoryNotEmpty",
|
||||
"Unit",
|
||||
"MakeDirectory",
|
||||
"DirectoryMode",
|
||||
},
|
||||
}
|
||||
|
||||
# Service types and their requirements
|
||||
SERVICE_TYPES = {
|
||||
"simple": {"required": ["ExecStart"], "conflicts": ["BusName", "Type=forking"]},
|
||||
"exec": {"required": ["ExecStart"], "conflicts": ["BusName"]},
|
||||
"forking": {"recommended": ["PIDFile"], "conflicts": ["BusName"]},
|
||||
"oneshot": {"conflicts": ["Restart=always", "Restart=on-success"]},
|
||||
"dbus": {"required": ["BusName"], "conflicts": []},
|
||||
"notify": {"required": ["ExecStart"], "conflicts": ["BusName"]},
|
||||
"idle": {"required": ["ExecStart"], "conflicts": ["BusName"]},
|
||||
}
|
||||
|
||||
def __init__(self, content: Optional[str] = None, file_path: Optional[str] = None):
|
||||
"""Initialize with either content string or file path."""
|
||||
self.content = content or ""
|
||||
self.file_path = file_path
|
||||
self.config = configparser.ConfigParser(
|
||||
interpolation=None, allow_no_value=True, delimiters=("=",)
|
||||
)
|
||||
self.config.optionxform = lambda optionstr: str(optionstr) # Preserve case
|
||||
self._parse_errors = []
|
||||
|
||||
if content:
|
||||
self._parse_content(content)
|
||||
elif file_path:
|
||||
self._parse_file(file_path)
|
||||
|
||||
def _parse_content(self, content: str) -> None:
|
||||
"""Parse unit file content from string."""
|
||||
try:
|
||||
self.config.read_string(content)
|
||||
self.content = content
|
||||
except configparser.Error as e:
|
||||
self._parse_errors.append(
|
||||
ValidationError("", None, f"Parse error: {str(e)}", "error")
|
||||
)
|
||||
|
||||
def _parse_file(self, file_path: str) -> None:
|
||||
"""Parse unit file from file path."""
|
||||
try:
|
||||
with open(file_path, "r", encoding="utf-8") as f:
|
||||
content = f.read()
|
||||
self._parse_content(content)
|
||||
self.file_path = file_path
|
||||
except IOError as e:
|
||||
self._parse_errors.append(
|
||||
ValidationError("", None, f"File read error: {str(e)}", "error")
|
||||
)
|
||||
|
||||
def get_unit_type(self) -> Optional[UnitType]:
|
||||
"""Determine the unit type based on sections present."""
|
||||
if self.config.has_section("Service"):
|
||||
return UnitType.SERVICE
|
||||
elif self.config.has_section("Timer"):
|
||||
return UnitType.TIMER
|
||||
elif self.config.has_section("Socket"):
|
||||
return UnitType.SOCKET
|
||||
elif self.config.has_section("Mount"):
|
||||
return UnitType.MOUNT
|
||||
elif self.config.has_section("Target"):
|
||||
return UnitType.TARGET
|
||||
elif self.config.has_section("Path"):
|
||||
return UnitType.PATH
|
||||
return None
|
||||
|
||||
def get_info(self) -> UnitFileInfo:
|
||||
"""Extract basic information about the unit file."""
|
||||
unit_type = self.get_unit_type()
|
||||
name = ""
|
||||
if self.file_path:
|
||||
name = self.file_path.split("/")[-1]
|
||||
|
||||
description = None
|
||||
if self.config.has_section("Unit") and self.config.has_option(
|
||||
"Unit", "Description"
|
||||
):
|
||||
description = self.config.get("Unit", "Description")
|
||||
|
||||
documentation = []
|
||||
if self.config.has_section("Unit") and self.config.has_option(
|
||||
"Unit", "Documentation"
|
||||
):
|
||||
doc_value = self.config.get("Unit", "Documentation")
|
||||
documentation = [doc.strip() for doc in doc_value.split()]
|
||||
|
||||
# Parse dependencies
|
||||
requires = self._get_dependency_list("Requires")
|
||||
wants = self._get_dependency_list("Wants")
|
||||
conflicts = self._get_dependency_list("Conflicts")
|
||||
|
||||
if unit_type is None:
|
||||
raise ValueError("Could not determine unit type")
|
||||
|
||||
return UnitFileInfo(
|
||||
name=name,
|
||||
unit_type=unit_type,
|
||||
description=description,
|
||||
documentation=documentation,
|
||||
requires=requires,
|
||||
wants=wants,
|
||||
conflicts=conflicts,
|
||||
)
|
||||
|
||||
def _get_dependency_list(self, key: str) -> List[str]:
|
||||
"""Extract a space-separated dependency list."""
|
||||
if not self.config.has_section("Unit") or not self.config.has_option(
|
||||
"Unit", key
|
||||
):
|
||||
return []
|
||||
|
||||
value = self.config.get("Unit", key)
|
||||
return [dep.strip() for dep in value.split() if dep.strip()]
|
||||
|
||||
def validate(self) -> List[ValidationError]:
|
||||
"""Validate the unit file and return list of errors/warnings."""
|
||||
errors = self._parse_errors.copy()
|
||||
|
||||
# Check for basic structure
|
||||
if not self.config.sections():
|
||||
errors.append(
|
||||
ValidationError(
|
||||
"", None, "Unit file is empty or has no sections", "error"
|
||||
)
|
||||
)
|
||||
return errors
|
||||
|
||||
# Validate sections
|
||||
for section in self.config.sections():
|
||||
errors.extend(self._validate_section(section))
|
||||
|
||||
# Type-specific validation
|
||||
unit_type = self.get_unit_type()
|
||||
if unit_type:
|
||||
errors.extend(self._validate_unit_type(unit_type))
|
||||
|
||||
return errors
|
||||
|
||||
def _validate_section(self, section: str) -> List[ValidationError]:
|
||||
"""Validate a specific section."""
|
||||
errors = []
|
||||
|
||||
# Check if section is known
|
||||
if section not in self.COMMON_SECTIONS:
|
||||
errors.append(
|
||||
ValidationError(
|
||||
section, None, f"Unknown section '{section}'", "warning"
|
||||
)
|
||||
)
|
||||
return errors
|
||||
|
||||
# Validate keys in section
|
||||
valid_keys = self.SECTION_KEYS.get(section, set())
|
||||
for key in self.config.options(section):
|
||||
if valid_keys and key not in valid_keys:
|
||||
errors.append(
|
||||
ValidationError(
|
||||
section,
|
||||
key,
|
||||
f"Unknown key '{key}' in section '{section}'",
|
||||
"warning",
|
||||
)
|
||||
)
|
||||
|
||||
# Validate key values
|
||||
value = self.config.get(section, key)
|
||||
errors.extend(self._validate_key_value(section, key, value))
|
||||
|
||||
return errors
|
||||
|
||||
def _validate_key_value(
|
||||
self, section: str, key: str, value: str
|
||||
) -> List[ValidationError]:
|
||||
"""Validate specific key-value pairs."""
|
||||
errors = []
|
||||
|
||||
# Service-specific validations
|
||||
if section == "Service":
|
||||
if key == "Type" and value not in self.SERVICE_TYPES:
|
||||
errors.append(
|
||||
ValidationError(
|
||||
section, key, f"Invalid service type '{value}'", "error"
|
||||
)
|
||||
)
|
||||
|
||||
elif key == "Restart" and value not in [
|
||||
"no",
|
||||
"always",
|
||||
"on-success",
|
||||
"on-failure",
|
||||
"on-abnormal",
|
||||
"on-abort",
|
||||
"on-watchdog",
|
||||
]:
|
||||
errors.append(
|
||||
ValidationError(
|
||||
section, key, f"Invalid restart value '{value}'", "error"
|
||||
)
|
||||
)
|
||||
|
||||
elif key.startswith("Exec") and not value:
|
||||
errors.append(
|
||||
ValidationError(
|
||||
section, key, f"Empty execution command for '{key}'", "error"
|
||||
)
|
||||
)
|
||||
|
||||
elif key in ["TimeoutStartSec", "TimeoutStopSec", "RestartSec"] and value:
|
||||
if not self._is_valid_time_span(value):
|
||||
errors.append(
|
||||
ValidationError(
|
||||
section, key, f"Invalid time span '{value}'", "error"
|
||||
)
|
||||
)
|
||||
|
||||
# Timer-specific validations
|
||||
elif section == "Timer":
|
||||
if key.startswith("On") and key.endswith("Sec") and value:
|
||||
if not self._is_valid_time_span(value):
|
||||
errors.append(
|
||||
ValidationError(
|
||||
section, key, f"Invalid time span '{value}'", "error"
|
||||
)
|
||||
)
|
||||
|
||||
elif key == "OnCalendar" and value:
|
||||
# Basic calendar validation - could be more comprehensive
|
||||
if not re.match(r"^[\w\s:*/-]+$", value):
|
||||
errors.append(
|
||||
ValidationError(
|
||||
section,
|
||||
key,
|
||||
f"Invalid calendar specification '{value}'",
|
||||
"warning",
|
||||
)
|
||||
)
|
||||
|
||||
# Socket-specific validations
|
||||
elif section == "Socket":
|
||||
if key.startswith("Listen") and not value:
|
||||
errors.append(
|
||||
ValidationError(
|
||||
section, key, f"Empty listen specification for '{key}'", "error"
|
||||
)
|
||||
)
|
||||
|
||||
# Mount-specific validations
|
||||
elif section == "Mount":
|
||||
if key == "What" and not value:
|
||||
errors.append(
|
||||
ValidationError(
|
||||
section, key, "Mount source (What) cannot be empty", "error"
|
||||
)
|
||||
)
|
||||
elif key == "Where" and not value:
|
||||
errors.append(
|
||||
ValidationError(
|
||||
section, key, "Mount point (Where) cannot be empty", "error"
|
||||
)
|
||||
)
|
||||
elif key == "Where" and not value.startswith("/"):
|
||||
errors.append(
|
||||
ValidationError(
|
||||
section, key, "Mount point must be an absolute path", "error"
|
||||
)
|
||||
)
|
||||
|
||||
return errors
|
||||
|
||||
def _validate_unit_type(self, unit_type: UnitType) -> List[ValidationError]:
|
||||
"""Perform type-specific validation."""
|
||||
errors = []
|
||||
|
||||
if unit_type == UnitType.SERVICE:
|
||||
errors.extend(self._validate_service())
|
||||
elif unit_type == UnitType.TIMER:
|
||||
errors.extend(self._validate_timer())
|
||||
elif unit_type == UnitType.SOCKET:
|
||||
errors.extend(self._validate_socket())
|
||||
elif unit_type == UnitType.MOUNT:
|
||||
errors.extend(self._validate_mount())
|
||||
|
||||
return errors
|
||||
|
||||
def _validate_service(self) -> List[ValidationError]:
|
||||
"""Validate service-specific requirements."""
|
||||
errors = []
|
||||
|
||||
if not self.config.has_section("Service"):
|
||||
return errors
|
||||
|
||||
service_type = self.config.get("Service", "Type", fallback="simple")
|
||||
type_config = self.SERVICE_TYPES.get(service_type, {})
|
||||
|
||||
# Check required keys
|
||||
for required_key in type_config.get("required", []):
|
||||
if not self.config.has_option("Service", required_key):
|
||||
errors.append(
|
||||
ValidationError(
|
||||
"Service",
|
||||
required_key,
|
||||
(
|
||||
f"Required key '{required_key}' missing for "
|
||||
f"service type '{service_type}'"
|
||||
),
|
||||
"error",
|
||||
)
|
||||
)
|
||||
|
||||
# Check for conflicting configurations
|
||||
for conflict in type_config.get("conflicts", []):
|
||||
if "=" in conflict:
|
||||
key, value = conflict.split("=", 1)
|
||||
if self.config.has_option("Service", key):
|
||||
actual_value = self.config.get("Service", key)
|
||||
if actual_value == value:
|
||||
errors.append(
|
||||
ValidationError(
|
||||
"Service",
|
||||
key,
|
||||
(
|
||||
f"'{key}={value}' conflicts with "
|
||||
f"service type '{service_type}'"
|
||||
),
|
||||
"error",
|
||||
)
|
||||
)
|
||||
else:
|
||||
if self.config.has_option("Service", conflict):
|
||||
errors.append(
|
||||
ValidationError(
|
||||
"Service",
|
||||
conflict,
|
||||
(
|
||||
f"'{conflict}' conflicts with "
|
||||
f"service type '{service_type}'"
|
||||
),
|
||||
"error",
|
||||
)
|
||||
)
|
||||
|
||||
return errors
|
||||
|
||||
def _validate_timer(self) -> List[ValidationError]:
|
||||
"""Validate timer-specific requirements."""
|
||||
errors = []
|
||||
|
||||
if not self.config.has_section("Timer"):
|
||||
return errors
|
||||
|
||||
# At least one timer specification is required
|
||||
timer_keys = [
|
||||
"OnActiveSec",
|
||||
"OnBootSec",
|
||||
"OnStartupSec",
|
||||
"OnUnitActiveSec",
|
||||
"OnUnitInactiveSec",
|
||||
"OnCalendar",
|
||||
]
|
||||
has_timer = any(self.config.has_option("Timer", key) for key in timer_keys)
|
||||
|
||||
if not has_timer:
|
||||
errors.append(
|
||||
ValidationError(
|
||||
"Timer",
|
||||
None,
|
||||
"Timer must have at least one timing specification",
|
||||
"error",
|
||||
)
|
||||
)
|
||||
|
||||
return errors
|
||||
|
||||
def _validate_socket(self) -> List[ValidationError]:
|
||||
"""Validate socket-specific requirements."""
|
||||
errors = []
|
||||
|
||||
if not self.config.has_section("Socket"):
|
||||
return errors
|
||||
|
||||
# At least one listen specification is required
|
||||
listen_keys = [
|
||||
"ListenStream",
|
||||
"ListenDatagram",
|
||||
"ListenSequentialPacket",
|
||||
"ListenFIFO",
|
||||
"ListenSpecial",
|
||||
"ListenNetlink",
|
||||
"ListenMessageQueue",
|
||||
]
|
||||
has_listen = any(self.config.has_option("Socket", key) for key in listen_keys)
|
||||
|
||||
if not has_listen:
|
||||
errors.append(
|
||||
ValidationError(
|
||||
"Socket",
|
||||
None,
|
||||
"Socket must have at least one Listen specification",
|
||||
"error",
|
||||
)
|
||||
)
|
||||
|
||||
return errors
|
||||
|
||||
def _validate_mount(self) -> List[ValidationError]:
|
||||
"""Validate mount-specific requirements."""
|
||||
errors = []
|
||||
|
||||
if not self.config.has_section("Mount"):
|
||||
return errors
|
||||
|
||||
# What and Where are required
|
||||
if not self.config.has_option("Mount", "What"):
|
||||
errors.append(
|
||||
ValidationError(
|
||||
"Mount",
|
||||
"What",
|
||||
"Mount units require 'What' (source) specification",
|
||||
"error",
|
||||
)
|
||||
)
|
||||
|
||||
if not self.config.has_option("Mount", "Where"):
|
||||
errors.append(
|
||||
ValidationError(
|
||||
"Mount",
|
||||
"Where",
|
||||
"Mount units require 'Where' (mount point) specification",
|
||||
"error",
|
||||
)
|
||||
)
|
||||
|
||||
return errors
|
||||
|
||||
def _is_valid_time_span(self, value: str) -> bool:
|
||||
"""Validate systemd time span format."""
|
||||
# Basic validation for time spans like "30s", "5min", "1h", "infinity"
|
||||
if value.lower() in ["infinity", "0"]:
|
||||
return True
|
||||
|
||||
pattern = r"^\d+(\.\d+)?(us|ms|s|min|h|d|w|month|y)?$"
|
||||
return bool(re.match(pattern, value.lower()))
|
||||
|
||||
def to_string(self) -> str:
|
||||
"""Convert the unit file back to string format."""
|
||||
if not self.config.sections():
|
||||
return ""
|
||||
|
||||
lines = []
|
||||
for section in self.config.sections():
|
||||
lines.append(f"[{section}]")
|
||||
for key in self.config.options(section):
|
||||
value = self.config.get(section, key)
|
||||
if value is None:
|
||||
lines.append(key)
|
||||
else:
|
||||
lines.append(f"{key}={value}")
|
||||
lines.append("") # Empty line between sections
|
||||
|
||||
return "\n".join(lines).rstrip()
|
||||
|
||||
def set_value(self, section: str, key: str, value: str) -> None:
|
||||
"""Set a value in the unit file."""
|
||||
if not self.config.has_section(section):
|
||||
self.config.add_section(section)
|
||||
self.config.set(section, key, value)
|
||||
|
||||
def get_value(
|
||||
self, section: str, key: str, fallback: Optional[str] = None
|
||||
) -> Optional[str]:
|
||||
"""Get a value from the unit file."""
|
||||
if not self.config.has_section(section):
|
||||
return fallback
|
||||
return self.config.get(section, key, fallback=fallback)
|
||||
|
||||
def remove_key(self, section: str, key: str) -> bool:
|
||||
"""Remove a key from the unit file."""
|
||||
if self.config.has_section(section) and self.config.has_option(section, key):
|
||||
self.config.remove_option(section, key)
|
||||
return True
|
||||
return False
|
||||
|
||||
def get_sections(self) -> List[str]:
|
||||
"""Get all sections in the unit file."""
|
||||
return self.config.sections()
|
||||
|
||||
def get_keys(self, section: str) -> List[str]:
|
||||
"""Get all keys in a section."""
|
||||
if not self.config.has_section(section):
|
||||
return []
|
||||
return self.config.options(section)
|
||||
|
||||
|
||||
def create_unit_file(unit_type: UnitType, **kwargs) -> SystemdUnitFile:
|
||||
"""
|
||||
Create a new unit file of the specified type with basic structure.
|
||||
|
||||
Args:
|
||||
unit_type: The type of unit file to create
|
||||
**kwargs: Additional configuration parameters
|
||||
|
||||
Returns:
|
||||
SystemdUnitFile instance with basic structure
|
||||
"""
|
||||
unit = SystemdUnitFile()
|
||||
|
||||
# Add Unit section
|
||||
unit.set_value(
|
||||
"Unit",
|
||||
"Description",
|
||||
kwargs.get("description", f"Generated {unit_type.value} unit"),
|
||||
)
|
||||
|
||||
if kwargs.get("documentation"):
|
||||
unit.set_value("Unit", "Documentation", kwargs["documentation"])
|
||||
|
||||
if kwargs.get("requires"):
|
||||
unit.set_value("Unit", "Requires", " ".join(kwargs["requires"]))
|
||||
|
||||
if kwargs.get("wants"):
|
||||
unit.set_value("Unit", "Wants", " ".join(kwargs["wants"]))
|
||||
|
||||
if kwargs.get("after"):
|
||||
unit.set_value("Unit", "After", " ".join(kwargs["after"]))
|
||||
|
||||
# Add type-specific sections
|
||||
if unit_type == UnitType.SERVICE:
|
||||
unit.set_value("Service", "Type", kwargs.get("service_type", "simple"))
|
||||
if kwargs.get("exec_start"):
|
||||
unit.set_value("Service", "ExecStart", kwargs["exec_start"])
|
||||
if kwargs.get("user"):
|
||||
unit.set_value("Service", "User", kwargs["user"])
|
||||
if kwargs.get("group"):
|
||||
unit.set_value("Service", "Group", kwargs["group"])
|
||||
if kwargs.get("working_directory"):
|
||||
unit.set_value("Service", "WorkingDirectory", kwargs["working_directory"])
|
||||
unit.set_value("Service", "Restart", kwargs.get("restart", "on-failure"))
|
||||
|
||||
elif unit_type == UnitType.TIMER:
|
||||
if kwargs.get("on_calendar"):
|
||||
unit.set_value("Timer", "OnCalendar", kwargs["on_calendar"])
|
||||
if kwargs.get("on_boot_sec"):
|
||||
unit.set_value("Timer", "OnBootSec", kwargs["on_boot_sec"])
|
||||
unit.set_value(
|
||||
"Timer", "Persistent", str(kwargs.get("persistent", "true")).lower()
|
||||
)
|
||||
|
||||
elif unit_type == UnitType.SOCKET:
|
||||
if kwargs.get("listen_stream"):
|
||||
unit.set_value("Socket", "ListenStream", kwargs["listen_stream"])
|
||||
if kwargs.get("listen_datagram"):
|
||||
unit.set_value("Socket", "ListenDatagram", kwargs["listen_datagram"])
|
||||
|
||||
elif unit_type == UnitType.MOUNT:
|
||||
if kwargs.get("what"):
|
||||
unit.set_value("Mount", "What", kwargs["what"])
|
||||
if kwargs.get("where"):
|
||||
unit.set_value("Mount", "Where", kwargs["where"])
|
||||
if kwargs.get("type"):
|
||||
unit.set_value("Mount", "Type", kwargs["type"])
|
||||
if kwargs.get("options"):
|
||||
unit.set_value("Mount", "Options", kwargs["options"])
|
||||
|
||||
# Add Install section if specified
|
||||
if kwargs.get("wanted_by"):
|
||||
wanted_by_value = kwargs["wanted_by"]
|
||||
if isinstance(wanted_by_value, (list, tuple)):
|
||||
unit.set_value("Install", "WantedBy", " ".join(wanted_by_value))
|
||||
else:
|
||||
unit.set_value("Install", "WantedBy", str(wanted_by_value))
|
||||
elif unit_type in [UnitType.SERVICE, UnitType.TIMER]:
|
||||
unit.set_value("Install", "WantedBy", "multi-user.target")
|
||||
|
||||
return unit
|
||||
@@ -0,0 +1,407 @@
|
||||
"""
|
||||
Main FastAPI application for UnitForge.
|
||||
|
||||
This module provides the web API for creating, validating, and managing
|
||||
systemd unit files through HTTP endpoints.
|
||||
"""
|
||||
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
from fastapi import FastAPI, File, HTTPException, Request, UploadFile # type: ignore
|
||||
from fastapi.middleware.cors import CORSMiddleware # type: ignore
|
||||
from fastapi.responses import FileResponse, HTMLResponse # type: ignore
|
||||
from fastapi.staticfiles import StaticFiles # type: ignore
|
||||
from fastapi.templating import Jinja2Templates # type: ignore
|
||||
from pydantic import BaseModel
|
||||
|
||||
from .core.templates import UnitTemplate, template_registry
|
||||
from .core.unit_file import SystemdUnitFile, UnitType, ValidationError, create_unit_file
|
||||
|
||||
# Create FastAPI app
|
||||
app = FastAPI(
|
||||
title="UnitForge",
|
||||
description="Create, validate, and manage systemd unit files",
|
||||
version="1.0.0",
|
||||
docs_url="/api/docs",
|
||||
redoc_url="/api/redoc",
|
||||
)
|
||||
|
||||
# Add CORS middleware
|
||||
app.add_middleware(
|
||||
CORSMiddleware,
|
||||
allow_origins=["*"],
|
||||
allow_credentials=True,
|
||||
allow_methods=["*"],
|
||||
allow_headers=["*"],
|
||||
)
|
||||
|
||||
# Setup templates and static files
|
||||
BASE_DIR = Path(__file__).resolve().parent.parent.parent
|
||||
TEMPLATES_DIR = BASE_DIR / "frontend" / "templates"
|
||||
STATIC_DIR = BASE_DIR / "frontend" / "static"
|
||||
|
||||
templates = Jinja2Templates(directory=str(TEMPLATES_DIR))
|
||||
|
||||
# Mount static files
|
||||
if STATIC_DIR.exists():
|
||||
app.mount("/static", StaticFiles(directory=str(STATIC_DIR)), name="static")
|
||||
|
||||
|
||||
# Pydantic models for API
|
||||
class ValidationResult(BaseModel):
|
||||
"""Result of unit file validation."""
|
||||
|
||||
valid: bool
|
||||
errors: List[Dict[str, Any]]
|
||||
warnings: List[Dict[str, Any]]
|
||||
|
||||
|
||||
class UnitFileContent(BaseModel):
|
||||
"""Unit file content for validation/generation."""
|
||||
|
||||
content: str
|
||||
filename: Optional[str] = None
|
||||
|
||||
|
||||
class GenerateRequest(BaseModel):
|
||||
"""Request to generate a unit file from parameters."""
|
||||
|
||||
template_name: str
|
||||
parameters: Dict[str, Any]
|
||||
filename: Optional[str] = None
|
||||
|
||||
|
||||
class TemplateInfo(BaseModel):
|
||||
"""Template information."""
|
||||
|
||||
name: str
|
||||
description: str
|
||||
unit_type: str
|
||||
category: str
|
||||
parameters: List[Dict[str, Any]]
|
||||
tags: List[str]
|
||||
|
||||
|
||||
class CreateUnitRequest(BaseModel):
|
||||
"""Request to create a basic unit file."""
|
||||
|
||||
unit_type: str
|
||||
name: str
|
||||
description: Optional[str] = None
|
||||
parameters: Dict[str, Any] = {}
|
||||
|
||||
|
||||
# Helper functions
|
||||
def validation_error_to_dict(error: ValidationError) -> Dict[str, Any]:
|
||||
"""Convert ValidationError to dictionary."""
|
||||
return {
|
||||
"section": error.section,
|
||||
"key": error.key,
|
||||
"message": error.message,
|
||||
"severity": error.severity,
|
||||
"line_number": error.line_number,
|
||||
}
|
||||
|
||||
|
||||
def template_to_dict(template: UnitTemplate) -> Dict[str, Any]:
|
||||
"""Convert UnitTemplate to dictionary."""
|
||||
parameters = []
|
||||
for param in template.parameters:
|
||||
param_dict = {
|
||||
"name": param.name,
|
||||
"description": param.description,
|
||||
"type": param.parameter_type,
|
||||
"required": param.required,
|
||||
"default": param.default,
|
||||
"choices": param.choices,
|
||||
"example": param.example,
|
||||
}
|
||||
parameters.append(param_dict)
|
||||
|
||||
return {
|
||||
"name": template.name,
|
||||
"description": template.description,
|
||||
"unit_type": template.unit_type.value,
|
||||
"category": template.category,
|
||||
"parameters": parameters,
|
||||
"tags": template.tags or [],
|
||||
}
|
||||
|
||||
|
||||
# Web UI Routes
|
||||
@app.get("/", response_class=HTMLResponse)
|
||||
async def index(request: Request):
|
||||
"""Serve the main web interface."""
|
||||
return templates.TemplateResponse("index.html", {"request": request})
|
||||
|
||||
|
||||
@app.get("/editor", response_class=HTMLResponse)
|
||||
async def editor(request: Request):
|
||||
"""Serve the unit file editor interface."""
|
||||
return templates.TemplateResponse("editor.html", {"request": request})
|
||||
|
||||
|
||||
@app.get("/templates", response_class=HTMLResponse)
|
||||
async def templates_page(request: Request):
|
||||
"""Serve the templates browser interface."""
|
||||
return templates.TemplateResponse("templates.html", {"request": request})
|
||||
|
||||
|
||||
# API Routes
|
||||
@app.post("/api/validate", response_model=ValidationResult)
|
||||
async def validate_unit_file(unit_file: UnitFileContent):
|
||||
"""Validate a systemd unit file."""
|
||||
try:
|
||||
systemd_unit = SystemdUnitFile(content=unit_file.content)
|
||||
validation_errors = systemd_unit.validate()
|
||||
|
||||
errors = []
|
||||
warnings = []
|
||||
|
||||
for error in validation_errors:
|
||||
error_dict = validation_error_to_dict(error)
|
||||
if error.severity == "error":
|
||||
errors.append(error_dict)
|
||||
else:
|
||||
warnings.append(error_dict)
|
||||
|
||||
return ValidationResult(
|
||||
valid=len(errors) == 0, errors=errors, warnings=warnings
|
||||
)
|
||||
except Exception as e:
|
||||
raise HTTPException(status_code=400, detail=f"Validation failed: {str(e)}")
|
||||
|
||||
|
||||
@app.post("/api/generate")
|
||||
async def generate_unit_file(request: GenerateRequest):
|
||||
"""Generate a unit file from a template."""
|
||||
try:
|
||||
template = template_registry.get_template(request.template_name)
|
||||
if not template:
|
||||
raise HTTPException(
|
||||
status_code=404, detail=f"Template '{request.template_name}' not found"
|
||||
)
|
||||
|
||||
# Validate required parameters
|
||||
for param in template.parameters:
|
||||
if param.required and param.name not in request.parameters:
|
||||
raise HTTPException(
|
||||
status_code=400,
|
||||
detail=f"Required parameter '{param.name}' is missing",
|
||||
)
|
||||
|
||||
# Generate the unit file
|
||||
unit_file = template.generate(request.parameters)
|
||||
content = unit_file.to_string()
|
||||
|
||||
# Validate the generated content
|
||||
validation_errors = unit_file.validate()
|
||||
errors = [
|
||||
validation_error_to_dict(e)
|
||||
for e in validation_errors
|
||||
if e.severity == "error"
|
||||
]
|
||||
warnings = [
|
||||
validation_error_to_dict(e)
|
||||
for e in validation_errors
|
||||
if e.severity != "error"
|
||||
]
|
||||
|
||||
return {
|
||||
"content": content,
|
||||
"filename": (
|
||||
request.filename
|
||||
or f"{request.parameters.get('name', 'service')}"
|
||||
f".{template.unit_type.value}"
|
||||
),
|
||||
"validation": {
|
||||
"valid": len(errors) == 0,
|
||||
"errors": errors,
|
||||
"warnings": warnings,
|
||||
},
|
||||
}
|
||||
except Exception as e:
|
||||
raise HTTPException(status_code=500, detail=f"Generation failed: {str(e)}")
|
||||
|
||||
|
||||
@app.post("/api/create")
|
||||
async def create_unit_file_endpoint(request: CreateUnitRequest):
|
||||
"""Create a basic unit file."""
|
||||
try:
|
||||
# Parse unit type
|
||||
try:
|
||||
unit_type = UnitType(request.unit_type.lower())
|
||||
except ValueError:
|
||||
raise HTTPException(
|
||||
status_code=400, detail=f"Invalid unit type: {request.unit_type}"
|
||||
)
|
||||
|
||||
# Create basic unit file
|
||||
kwargs = {
|
||||
"description": request.description or f"{request.name} {unit_type.value}",
|
||||
**request.parameters,
|
||||
}
|
||||
|
||||
unit_file = create_unit_file(unit_type, **kwargs)
|
||||
content = unit_file.to_string()
|
||||
|
||||
# Validate the created content
|
||||
validation_errors = unit_file.validate()
|
||||
errors = [
|
||||
validation_error_to_dict(e)
|
||||
for e in validation_errors
|
||||
if e.severity == "error"
|
||||
]
|
||||
warnings = [
|
||||
validation_error_to_dict(e)
|
||||
for e in validation_errors
|
||||
if e.severity != "error"
|
||||
]
|
||||
|
||||
return {
|
||||
"content": content,
|
||||
"filename": f"{request.name}.{unit_type.value}",
|
||||
"validation": {
|
||||
"valid": len(errors) == 0,
|
||||
"errors": errors,
|
||||
"warnings": warnings,
|
||||
},
|
||||
}
|
||||
except Exception as e:
|
||||
raise HTTPException(status_code=500, detail=f"Creation failed: {str(e)}")
|
||||
|
||||
|
||||
@app.get("/api/templates", response_model=List[TemplateInfo])
|
||||
async def list_templates():
|
||||
"""List all available templates."""
|
||||
templates = template_registry.list_templates()
|
||||
return [TemplateInfo(**template_to_dict(template)) for template in templates]
|
||||
|
||||
|
||||
@app.get("/api/templates/{template_name}", response_model=TemplateInfo)
|
||||
async def get_template(template_name: str):
|
||||
"""Get details of a specific template."""
|
||||
template = template_registry.get_template(template_name)
|
||||
if not template:
|
||||
raise HTTPException(
|
||||
status_code=404, detail=f"Template '{template_name}' not found"
|
||||
)
|
||||
|
||||
return TemplateInfo(**template_to_dict(template))
|
||||
|
||||
|
||||
@app.get("/api/templates/category/{category}", response_model=List[TemplateInfo])
|
||||
async def get_templates_by_category(category: str):
|
||||
"""Get templates by category."""
|
||||
templates = template_registry.get_by_category(category)
|
||||
return [TemplateInfo(**template_to_dict(template)) for template in templates]
|
||||
|
||||
|
||||
@app.get("/api/templates/type/{unit_type}", response_model=List[TemplateInfo])
|
||||
async def get_templates_by_type(unit_type: str):
|
||||
"""Get templates by unit type."""
|
||||
try:
|
||||
unit_type_enum = UnitType(unit_type.lower())
|
||||
except ValueError:
|
||||
raise HTTPException(status_code=400, detail=f"Invalid unit type: {unit_type}")
|
||||
|
||||
templates = template_registry.get_by_type(unit_type_enum)
|
||||
return [TemplateInfo(**template_to_dict(template)) for template in templates]
|
||||
|
||||
|
||||
@app.get("/api/search/{query}", response_model=List[TemplateInfo])
|
||||
async def search_templates(query: str):
|
||||
"""Search templates by name, description, or tags."""
|
||||
templates = template_registry.search(query)
|
||||
return [TemplateInfo(**template_to_dict(template)) for template in templates]
|
||||
|
||||
|
||||
@app.post("/api/download")
|
||||
async def download_unit_file(unit_file: UnitFileContent):
|
||||
"""Download a unit file."""
|
||||
try:
|
||||
# Create a temporary file
|
||||
filename = unit_file.filename or "unit.service"
|
||||
temp_file = tempfile.NamedTemporaryFile(
|
||||
mode="w", delete=False, suffix=f"_{filename}"
|
||||
)
|
||||
temp_file.write(unit_file.content)
|
||||
temp_file.close()
|
||||
|
||||
return FileResponse(
|
||||
path=temp_file.name,
|
||||
filename=filename,
|
||||
media_type="application/octet-stream",
|
||||
)
|
||||
except Exception as e:
|
||||
raise HTTPException(status_code=500, detail=f"Download failed: {str(e)}")
|
||||
|
||||
|
||||
@app.post("/api/upload")
|
||||
async def upload_unit_file(file: UploadFile = File(...)):
|
||||
"""Upload and validate a unit file."""
|
||||
try:
|
||||
content = await file.read()
|
||||
content_str = content.decode("utf-8")
|
||||
|
||||
# Parse and validate the uploaded file
|
||||
systemd_unit = SystemdUnitFile(content=content_str)
|
||||
validation_errors = systemd_unit.validate()
|
||||
|
||||
errors = []
|
||||
warnings = []
|
||||
|
||||
for error in validation_errors:
|
||||
error_dict = validation_error_to_dict(error)
|
||||
if error.severity == "error":
|
||||
errors.append(error_dict)
|
||||
else:
|
||||
warnings.append(error_dict)
|
||||
|
||||
# Get unit info
|
||||
unit_info = systemd_unit.get_info()
|
||||
|
||||
return {
|
||||
"filename": file.filename,
|
||||
"content": content_str,
|
||||
"unit_type": unit_info.unit_type.value if unit_info.unit_type else None,
|
||||
"description": unit_info.description,
|
||||
"validation": {
|
||||
"valid": len(errors) == 0,
|
||||
"errors": errors,
|
||||
"warnings": warnings,
|
||||
},
|
||||
}
|
||||
except UnicodeDecodeError:
|
||||
raise HTTPException(status_code=400, detail="File must be valid UTF-8 text")
|
||||
except Exception as e:
|
||||
raise HTTPException(
|
||||
status_code=500, detail=f"Upload processing failed: {str(e)}"
|
||||
)
|
||||
|
||||
|
||||
@app.get("/api/info")
|
||||
async def get_info():
|
||||
"""Get application information."""
|
||||
return {
|
||||
"name": "UnitForge",
|
||||
"version": "1.0.0",
|
||||
"description": "Create, validate, and manage systemd unit files",
|
||||
"supported_types": [t.value for t in UnitType],
|
||||
"template_count": len(template_registry.list_templates()),
|
||||
}
|
||||
|
||||
|
||||
# Health check
|
||||
@app.get("/health")
|
||||
async def health_check():
|
||||
"""Health check endpoint."""
|
||||
return {"status": "healthy", "service": "unitforge"}
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
import uvicorn # type: ignore
|
||||
|
||||
uvicorn.run(app, host="0.0.0.0", port=8000) # nosec B104
|
||||
@@ -0,0 +1,548 @@
|
||||
"""
|
||||
UnitForge CLI - Command line interface for systemd unit file management.
|
||||
|
||||
This module provides a comprehensive command-line interface for creating,
|
||||
validating, and managing systemd unit files.
|
||||
"""
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict
|
||||
|
||||
import click
|
||||
|
||||
# Add the backend directory to the path so we can import our modules
|
||||
# This needs to be done before importing our app modules
|
||||
_backend_path = str(Path(__file__).parent.parent)
|
||||
if _backend_path not in sys.path:
|
||||
sys.path.insert(0, _backend_path)
|
||||
|
||||
# Import our modules after path setup
|
||||
from app.core.templates import template_registry # noqa: E402
|
||||
from app.core.unit_file import SystemdUnitFile, UnitType, create_unit_file # noqa: E402
|
||||
|
||||
|
||||
@click.group()
|
||||
@click.version_option(version="1.0.0")
|
||||
def cli():
|
||||
"""
|
||||
UnitForge - Create, validate, and manage systemd unit files.
|
||||
|
||||
A comprehensive tool for working with systemd unit files from the command line.
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
@cli.command()
|
||||
@click.argument("file_path", type=click.Path(exists=True))
|
||||
@click.option("--verbose", "-v", is_flag=True, help="Show detailed validation output")
|
||||
@click.option(
|
||||
"--warnings", "-w", is_flag=True, help="Show warnings in addition to errors"
|
||||
)
|
||||
def validate(file_path: str, verbose: bool, warnings: bool):
|
||||
"""Validate a systemd unit file."""
|
||||
try:
|
||||
unit_file = SystemdUnitFile(file_path=file_path)
|
||||
validation_errors = unit_file.validate()
|
||||
|
||||
errors = [e for e in validation_errors if e.severity == "error"]
|
||||
warning_list = [e for e in validation_errors if e.severity != "error"]
|
||||
|
||||
if not errors and not warning_list:
|
||||
click.echo(click.style("✓ Unit file is valid", fg="green"))
|
||||
return
|
||||
|
||||
if errors:
|
||||
click.echo(click.style(f"✗ Found {len(errors)} error(s):", fg="red"))
|
||||
for error in errors:
|
||||
location = f"[{error.section}"
|
||||
if error.key:
|
||||
location += f".{error.key}"
|
||||
location += "]"
|
||||
|
||||
click.echo(f" {location} {error.message}")
|
||||
|
||||
if warnings and warning_list:
|
||||
click.echo(
|
||||
click.style(f"⚠ Found {len(warning_list)} warning(s):", fg="yellow")
|
||||
)
|
||||
for warning in warning_list:
|
||||
location = f"[{warning.section}"
|
||||
if warning.key:
|
||||
location += f".{warning.key}"
|
||||
location += "]"
|
||||
|
||||
click.echo(f" {location} {warning.message}")
|
||||
|
||||
if verbose:
|
||||
click.echo("\nUnit file info:")
|
||||
info = unit_file.get_info()
|
||||
if info.description:
|
||||
click.echo(f" Description: {info.description}")
|
||||
if info.unit_type:
|
||||
click.echo(f" Type: {info.unit_type.value}")
|
||||
if info.requires:
|
||||
click.echo(f" Requires: {', '.join(info.requires)}")
|
||||
if info.wants:
|
||||
click.echo(f" Wants: {', '.join(info.wants)}")
|
||||
|
||||
sys.exit(1 if errors else 0)
|
||||
|
||||
except Exception as e:
|
||||
click.echo(click.style(f"Error: {str(e)}", fg="red"))
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
@cli.command()
|
||||
@click.option(
|
||||
"--type",
|
||||
"unit_type",
|
||||
type=click.Choice(["service", "timer", "socket", "mount", "target"]),
|
||||
required=True,
|
||||
help="Type of unit file to create",
|
||||
)
|
||||
@click.option("--name", required=True, help="Name of the unit")
|
||||
@click.option("--description", help="Description of the unit")
|
||||
@click.option("--exec-start", help="Command to execute (for services)")
|
||||
@click.option("--user", help="User to run the service as")
|
||||
@click.option("--group", help="Group to run the service as")
|
||||
@click.option("--working-directory", help="Working directory for the service")
|
||||
@click.option(
|
||||
"--restart",
|
||||
type=click.Choice(["no", "always", "on-failure", "on-success"]),
|
||||
default="on-failure",
|
||||
help="Restart policy",
|
||||
)
|
||||
@click.option(
|
||||
"--wanted-by",
|
||||
multiple=True,
|
||||
help="Target to be wanted by (can be used multiple times)",
|
||||
)
|
||||
@click.option("--output", "-o", help="Output file path")
|
||||
@click.option(
|
||||
"--validate-output", is_flag=True, help="Validate the generated unit file"
|
||||
)
|
||||
def create(
|
||||
unit_type: str,
|
||||
name: str,
|
||||
description: str,
|
||||
exec_start: str,
|
||||
user: str,
|
||||
group: str,
|
||||
working_directory: str,
|
||||
restart: str,
|
||||
wanted_by: tuple,
|
||||
output: str,
|
||||
validate_output: bool,
|
||||
):
|
||||
"""Create a new systemd unit file."""
|
||||
try:
|
||||
# Convert string to enum
|
||||
unit_type_enum = UnitType(unit_type)
|
||||
|
||||
# Build parameters
|
||||
kwargs: Dict[str, Any] = {
|
||||
"description": description or f"{name} {unit_type}",
|
||||
}
|
||||
|
||||
if exec_start:
|
||||
kwargs["exec_start"] = exec_start
|
||||
if user:
|
||||
kwargs["user"] = user
|
||||
if group:
|
||||
kwargs["group"] = group
|
||||
if working_directory:
|
||||
kwargs["working_directory"] = working_directory
|
||||
if restart:
|
||||
kwargs["restart"] = restart
|
||||
if wanted_by:
|
||||
kwargs["wanted_by"] = [str(item) for item in wanted_by]
|
||||
|
||||
# Create the unit file
|
||||
unit_file = create_unit_file(unit_type_enum, **kwargs)
|
||||
content = unit_file.to_string()
|
||||
|
||||
# Determine output path
|
||||
if output:
|
||||
output_path = output
|
||||
else:
|
||||
output_path = f"{name}.{unit_type}"
|
||||
|
||||
# Write to file
|
||||
with open(output_path, "w") as f:
|
||||
f.write(content)
|
||||
|
||||
click.echo(click.style(f"✓ Created unit file: {output_path}", fg="green"))
|
||||
|
||||
# Validate if requested
|
||||
if validate_output:
|
||||
validation_errors = unit_file.validate()
|
||||
errors = [e for e in validation_errors if e.severity == "error"]
|
||||
|
||||
if errors:
|
||||
click.echo(
|
||||
click.style(
|
||||
f"⚠ Generated unit file has {len(errors)} validation error(s)",
|
||||
fg="yellow",
|
||||
)
|
||||
)
|
||||
for error in errors:
|
||||
click.echo(f" [{error.section}.{error.key}] {error.message}")
|
||||
else:
|
||||
click.echo(click.style("✓ Generated unit file is valid", fg="green"))
|
||||
|
||||
except Exception as e:
|
||||
click.echo(click.style(f"Error: {str(e)}", fg="red"))
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
@cli.group()
|
||||
def template():
|
||||
"""Work with unit file templates."""
|
||||
pass
|
||||
|
||||
|
||||
@template.command("list")
|
||||
@click.option("--category", help="Filter by category")
|
||||
@click.option("--type", "unit_type", help="Filter by unit type")
|
||||
@click.option("--search", help="Search templates by name, description, or tags")
|
||||
def list_templates(category: str, unit_type: str, search: str):
|
||||
"""List available templates."""
|
||||
templates = template_registry.list_templates()
|
||||
|
||||
if category:
|
||||
templates = [t for t in templates if t.category == category]
|
||||
|
||||
if unit_type:
|
||||
try:
|
||||
unit_type_enum = UnitType(unit_type.lower())
|
||||
templates = [t for t in templates if t.unit_type == unit_type_enum]
|
||||
except ValueError:
|
||||
click.echo(click.style(f"Invalid unit type: {unit_type}", fg="red"))
|
||||
return
|
||||
|
||||
if search:
|
||||
templates = template_registry.search(search)
|
||||
|
||||
if not templates:
|
||||
click.echo("No templates found matching the criteria.")
|
||||
return
|
||||
|
||||
# Group by category
|
||||
categories = {}
|
||||
for template in templates:
|
||||
if template.category not in categories:
|
||||
categories[template.category] = []
|
||||
categories[template.category].append(template)
|
||||
|
||||
for cat, cat_templates in categories.items():
|
||||
click.echo(click.style(f"\n{cat}:", fg="blue", bold=True))
|
||||
for template in cat_templates:
|
||||
click.echo(f" {template.name} ({template.unit_type.value})")
|
||||
click.echo(f" {template.description}")
|
||||
if template.tags:
|
||||
click.echo(f" Tags: {', '.join(template.tags)}")
|
||||
|
||||
|
||||
@template.command("show")
|
||||
@click.argument("template_name")
|
||||
def show_template(template_name: str):
|
||||
"""Show details of a specific template."""
|
||||
template = template_registry.get_template(template_name)
|
||||
if not template:
|
||||
click.echo(click.style(f"Template '{template_name}' not found", fg="red"))
|
||||
return
|
||||
|
||||
click.echo(click.style(f"Template: {template.name}", fg="blue", bold=True))
|
||||
click.echo(f"Description: {template.description}")
|
||||
click.echo(f"Type: {template.unit_type.value}")
|
||||
click.echo(f"Category: {template.category}")
|
||||
|
||||
if template.tags:
|
||||
click.echo(f"Tags: {', '.join(template.tags)}")
|
||||
|
||||
click.echo("\nParameters:")
|
||||
for param in template.parameters:
|
||||
required_text = "required" if param.required else "optional"
|
||||
click.echo(f" {param.name} ({param.parameter_type}, {required_text})")
|
||||
click.echo(f" {param.description}")
|
||||
|
||||
if param.default is not None:
|
||||
click.echo(f" Default: {param.default}")
|
||||
|
||||
if param.choices:
|
||||
click.echo(f" Choices: {', '.join(param.choices)}")
|
||||
|
||||
if param.example:
|
||||
click.echo(f" Example: {param.example}")
|
||||
|
||||
|
||||
@template.command("generate")
|
||||
@click.argument("template_name")
|
||||
@click.option(
|
||||
"--param", "-p", multiple=True, help="Template parameter in key=value format"
|
||||
)
|
||||
@click.option("--output", "-o", help="Output file path")
|
||||
@click.option(
|
||||
"--validate-output", is_flag=True, help="Validate the generated unit file"
|
||||
)
|
||||
@click.option("--interactive", "-i", is_flag=True, help="Interactive parameter input")
|
||||
def generate_template(
|
||||
template_name: str,
|
||||
param: tuple,
|
||||
output: str,
|
||||
validate_output: bool,
|
||||
interactive: bool,
|
||||
):
|
||||
"""Generate a unit file from a template."""
|
||||
template = template_registry.get_template(template_name)
|
||||
if not template:
|
||||
click.echo(click.style(f"Template '{template_name}' not found", fg="red"))
|
||||
return
|
||||
|
||||
# Parse parameters
|
||||
parameters = {}
|
||||
for p in param:
|
||||
if "=" not in p:
|
||||
click.echo(
|
||||
click.style(f"Invalid parameter format: {p}. Use key=value", fg="red")
|
||||
)
|
||||
return
|
||||
key, value = p.split("=", 1)
|
||||
parameters[key] = value
|
||||
|
||||
# Interactive mode
|
||||
if interactive:
|
||||
click.echo(f"Generating unit file from template: {template.name}")
|
||||
click.echo(f"Description: {template.description}\n")
|
||||
|
||||
for template_param in template.parameters:
|
||||
if template_param.name in parameters:
|
||||
continue # Skip if already provided via --param
|
||||
|
||||
prompt_text = f"{template_param.name}"
|
||||
if template_param.description:
|
||||
prompt_text += f" ({template_param.description})"
|
||||
|
||||
if template_param.example:
|
||||
prompt_text += f" [example: {template_param.example}]"
|
||||
|
||||
if template_param.required:
|
||||
value = click.prompt(prompt_text)
|
||||
else:
|
||||
default = template_param.default or ""
|
||||
value = click.prompt(prompt_text, default=default, show_default=True)
|
||||
|
||||
if value: # Only add non-empty values
|
||||
# Type conversion
|
||||
if template_param.parameter_type == "boolean":
|
||||
value = value.lower() in ("true", "yes", "1", "on")
|
||||
elif template_param.parameter_type == "integer":
|
||||
try:
|
||||
value = int(value)
|
||||
except ValueError:
|
||||
click.echo(
|
||||
click.style(f"Invalid integer value: {value}", fg="red")
|
||||
)
|
||||
return
|
||||
|
||||
parameters[template_param.name] = value
|
||||
|
||||
# Check required parameters
|
||||
missing_params = []
|
||||
for template_param in template.parameters:
|
||||
if template_param.required and template_param.name not in parameters:
|
||||
missing_params.append(template_param.name)
|
||||
|
||||
if missing_params:
|
||||
click.echo(
|
||||
click.style(
|
||||
f"Missing required parameters: {', '.join(missing_params)}", fg="red"
|
||||
)
|
||||
)
|
||||
click.echo("Use --interactive mode or provide them with --param key=value")
|
||||
return
|
||||
|
||||
try:
|
||||
# Generate the unit file
|
||||
unit_file = template.generate(parameters)
|
||||
content = unit_file.to_string()
|
||||
|
||||
# Determine output path
|
||||
if output:
|
||||
output_path = output
|
||||
else:
|
||||
name = parameters.get("name", "generated")
|
||||
output_path = f"{name}.{template.unit_type.value}"
|
||||
|
||||
# Write to file
|
||||
with open(output_path, "w") as f:
|
||||
f.write(content)
|
||||
|
||||
click.echo(click.style(f"✓ Generated unit file: {output_path}", fg="green"))
|
||||
|
||||
# Validate if requested
|
||||
if validate_output:
|
||||
validation_errors = unit_file.validate()
|
||||
errors = [e for e in validation_errors if e.severity == "error"]
|
||||
|
||||
if errors:
|
||||
click.echo(
|
||||
click.style(
|
||||
f"⚠ Generated unit file has {len(errors)} validation error(s)",
|
||||
fg="yellow",
|
||||
)
|
||||
)
|
||||
for error in errors:
|
||||
location = f"[{error.section}"
|
||||
if error.key:
|
||||
location += f".{error.key}"
|
||||
location += "]"
|
||||
click.echo(f" {location} {error.message}")
|
||||
else:
|
||||
click.echo(click.style("✓ Generated unit file is valid", fg="green"))
|
||||
|
||||
except Exception as e:
|
||||
click.echo(click.style(f"Error generating unit file: {str(e)}", fg="red"))
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
@cli.command()
|
||||
@click.argument("file_path", type=click.Path(exists=True))
|
||||
def info(file_path: str):
|
||||
"""Show information about a unit file."""
|
||||
try:
|
||||
unit_file = SystemdUnitFile(file_path=file_path)
|
||||
info = unit_file.get_info()
|
||||
|
||||
click.echo(click.style(f"Unit File: {file_path}", fg="blue", bold=True))
|
||||
|
||||
if info.name:
|
||||
click.echo(f"Name: {info.name}")
|
||||
|
||||
if info.unit_type:
|
||||
click.echo(f"Type: {info.unit_type.value}")
|
||||
|
||||
if info.description:
|
||||
click.echo(f"Description: {info.description}")
|
||||
|
||||
if info.documentation:
|
||||
click.echo(f"Documentation: {', '.join(info.documentation)}")
|
||||
|
||||
if info.requires:
|
||||
click.echo(f"Requires: {', '.join(info.requires)}")
|
||||
|
||||
if info.wants:
|
||||
click.echo(f"Wants: {', '.join(info.wants)}")
|
||||
|
||||
if info.conflicts:
|
||||
click.echo(f"Conflicts: {', '.join(info.conflicts)}")
|
||||
|
||||
# Show sections and key counts
|
||||
sections = unit_file.get_sections()
|
||||
if sections:
|
||||
click.echo("\nSections:")
|
||||
for section in sections:
|
||||
keys = unit_file.get_keys(section)
|
||||
click.echo(f" {section}: {len(keys)} keys")
|
||||
|
||||
except Exception as e:
|
||||
click.echo(click.style(f"Error: {str(e)}", fg="red"))
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
@cli.command()
|
||||
@click.argument("source_file", type=click.Path(exists=True))
|
||||
@click.argument("dest_file", type=click.Path())
|
||||
@click.option(
|
||||
"--set", "set_values", multiple=True, help="Set values in format section.key=value"
|
||||
)
|
||||
@click.option(
|
||||
"--remove", "remove_keys", multiple=True, help="Remove keys in format section.key"
|
||||
)
|
||||
@click.option("--validate-output", is_flag=True, help="Validate the modified unit file")
|
||||
def edit(
|
||||
source_file: str,
|
||||
dest_file: str,
|
||||
set_values: tuple,
|
||||
remove_keys: tuple,
|
||||
validate_output: bool,
|
||||
):
|
||||
"""Edit a unit file by setting or removing values."""
|
||||
try:
|
||||
unit_file = SystemdUnitFile(file_path=source_file)
|
||||
|
||||
# Apply modifications
|
||||
for set_value in set_values:
|
||||
if "=" not in set_value:
|
||||
click.echo(
|
||||
click.style(
|
||||
f"Invalid set format: {set_value}. Use section.key=value",
|
||||
fg="red",
|
||||
)
|
||||
)
|
||||
return
|
||||
|
||||
key_part, value = set_value.split("=", 1)
|
||||
if "." not in key_part:
|
||||
click.echo(
|
||||
click.style(
|
||||
f"Invalid key format: {key_part}. Use section.key", fg="red"
|
||||
)
|
||||
)
|
||||
return
|
||||
|
||||
section, key = key_part.split(".", 1)
|
||||
unit_file.set_value(section, key, value)
|
||||
click.echo(f"Set {section}.{key} = {value}")
|
||||
|
||||
for remove_key in remove_keys:
|
||||
if "." not in remove_key:
|
||||
click.echo(
|
||||
click.style(
|
||||
f"Invalid key format: {remove_key}. Use section.key", fg="red"
|
||||
)
|
||||
)
|
||||
return
|
||||
|
||||
section, key = remove_key.split(".", 1)
|
||||
if unit_file.remove_key(section, key):
|
||||
click.echo(f"Removed {section}.{key}")
|
||||
else:
|
||||
click.echo(click.style(f"Key {section}.{key} not found", fg="yellow"))
|
||||
|
||||
# Write modified file
|
||||
content = unit_file.to_string()
|
||||
with open(dest_file, "w") as f:
|
||||
f.write(content)
|
||||
|
||||
click.echo(click.style(f"✓ Modified unit file saved: {dest_file}", fg="green"))
|
||||
|
||||
# Validate if requested
|
||||
if validate_output:
|
||||
validation_errors = unit_file.validate()
|
||||
errors = [e for e in validation_errors if e.severity == "error"]
|
||||
|
||||
if errors:
|
||||
click.echo(
|
||||
click.style(
|
||||
f"⚠ Modified unit file has {len(errors)} validation error(s)",
|
||||
fg="yellow",
|
||||
)
|
||||
)
|
||||
for error in errors:
|
||||
location = f"[{error.section}"
|
||||
if error.key:
|
||||
location += f".{error.key}"
|
||||
location += "]"
|
||||
click.echo(f" {location} {error.message}")
|
||||
else:
|
||||
click.echo(click.style("✓ Modified unit file is valid", fg="green"))
|
||||
|
||||
except Exception as e:
|
||||
click.echo(click.style(f"Error: {str(e)}", fg="red"))
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
cli()
|
||||
@@ -0,0 +1,38 @@
|
||||
# UnitForge Core Dependencies
|
||||
# Optimized for uv package manager
|
||||
# Note: Use pyproject.toml for main dependency specification
|
||||
|
||||
bandit>=1.7.0
|
||||
black>=23.0.0
|
||||
|
||||
# CLI framework
|
||||
click>=8.0.0,<9.0.0
|
||||
# Core web framework
|
||||
fastapi>=0.68.0,<1.0.0
|
||||
flake8>=6.0.0
|
||||
httpx>=0.23.0
|
||||
isort>=5.12.0
|
||||
|
||||
# Template engine
|
||||
jinja2>=3.0.0,<4.0.0
|
||||
mypy>=1.5.0
|
||||
pip-audit>=2.6.0
|
||||
pre-commit>=3.0.0
|
||||
|
||||
# Data validation
|
||||
pydantic>=1.8.0,<2.0.0
|
||||
|
||||
# Development dependencies (also in pyproject.toml)
|
||||
pytest>=6.0.0
|
||||
pytest-asyncio>=0.18.0
|
||||
pytest-cov>=4.0.0
|
||||
|
||||
# File handling
|
||||
python-multipart>=0.0.5
|
||||
|
||||
# Configuration
|
||||
pyyaml>=5.4.0
|
||||
uvicorn[standard]>=0.15.0,<1.0.0
|
||||
|
||||
# Input validation
|
||||
validators>=0.18.0
|
||||
Executable
+244
@@ -0,0 +1,244 @@
|
||||
#!/bin/bash
|
||||
# UnitForge uv System Check
|
||||
# Validates that uv is properly installed and working
|
||||
|
||||
set -e
|
||||
|
||||
# Load centralized color utility
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "${SCRIPT_DIR}/scripts/colors.sh"
|
||||
|
||||
echo -e "${BLUE}╔══════════════════════════════════════════════╗${NC}"
|
||||
echo -e "${BLUE}║ UnitForge uv System Check ║${NC}"
|
||||
echo -e "${BLUE}║ Validating uv Installation ║${NC}"
|
||||
echo -e "${BLUE}╚══════════════════════════════════════════════╝${NC}"
|
||||
echo ""
|
||||
|
||||
# Function to check if command exists
|
||||
command_exists() {
|
||||
command -v "$1" >/dev/null 2>&1
|
||||
}
|
||||
|
||||
# Function to compare versions
|
||||
version_ge() {
|
||||
printf '%s\n%s\n' "$2" "$1" | sort -V -C
|
||||
}
|
||||
|
||||
ERRORS=0
|
||||
WARNINGS=0
|
||||
|
||||
echo -e "${CYAN}🔍 Checking system requirements...${NC}"
|
||||
echo ""
|
||||
|
||||
# Check Python
|
||||
if command_exists python3; then
|
||||
PYTHON_VERSION=$(python3 -c 'import sys; print(".".join(map(str, sys.version_info[:2])))')
|
||||
if python3 -c "import sys; exit(0 if sys.version_info >= (3, 8) else 1)"; then
|
||||
echo -e "${GREEN}✓ Python ${PYTHON_VERSION} found (>= 3.8 required)${NC}"
|
||||
else
|
||||
echo -e "${RED}✗ Python ${PYTHON_VERSION} found but 3.8+ required${NC}"
|
||||
ERRORS=$((ERRORS + 1))
|
||||
fi
|
||||
else
|
||||
echo -e "${RED}✗ Python 3 not found${NC}"
|
||||
ERRORS=$((ERRORS + 1))
|
||||
fi
|
||||
|
||||
# Check uv
|
||||
if command_exists uv; then
|
||||
UV_VERSION=$(uv --version 2>/dev/null | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' || echo "unknown")
|
||||
echo -e "${GREEN}✓ uv ${UV_VERSION} found${NC}"
|
||||
|
||||
# Test uv functionality
|
||||
echo -e "${CYAN} Testing uv functionality...${NC}"
|
||||
|
||||
# Create temporary directory for testing
|
||||
TEMP_DIR=$(mktemp -d)
|
||||
cd "$TEMP_DIR"
|
||||
|
||||
# Test uv venv creation
|
||||
if uv venv test-env >/dev/null 2>&1; then
|
||||
echo -e "${GREEN} ✓ uv venv creation works${NC}"
|
||||
|
||||
# Test package installation
|
||||
if uv pip install --target ./test-env/lib/python*/site-packages click >/dev/null 2>&1; then
|
||||
echo -e "${GREEN} ✓ uv pip installation works${NC}"
|
||||
else
|
||||
echo -e "${YELLOW} ⚠ uv pip installation test failed${NC}"
|
||||
WARNINGS=$((WARNINGS + 1))
|
||||
fi
|
||||
else
|
||||
echo -e "${YELLOW} ⚠ uv venv creation test failed${NC}"
|
||||
WARNINGS=$((WARNINGS + 1))
|
||||
fi
|
||||
|
||||
# Cleanup
|
||||
cd - >/dev/null
|
||||
rm -rf "$TEMP_DIR"
|
||||
|
||||
else
|
||||
echo -e "${RED}✗ uv not found${NC}"
|
||||
echo -e "${YELLOW} Install with: curl -LsSf https://astral.sh/uv/install.sh | sh${NC}"
|
||||
ERRORS=$((ERRORS + 1))
|
||||
fi
|
||||
|
||||
echo ""
|
||||
|
||||
# Check git (for pre-commit hooks)
|
||||
if command_exists git; then
|
||||
echo -e "${GREEN}✓ Git found${NC}"
|
||||
else
|
||||
echo -e "${YELLOW}⚠ Git not found (needed for pre-commit hooks)${NC}"
|
||||
WARNINGS=$((WARNINGS + 1))
|
||||
fi
|
||||
|
||||
# Check curl/wget (for installations)
|
||||
if command_exists curl; then
|
||||
echo -e "${GREEN}✓ curl found${NC}"
|
||||
elif command_exists wget; then
|
||||
echo -e "${GREEN}✓ wget found${NC}"
|
||||
else
|
||||
echo -e "${YELLOW}⚠ Neither curl nor wget found (may affect installations)${NC}"
|
||||
WARNINGS=$((WARNINGS + 1))
|
||||
fi
|
||||
|
||||
# Check Docker (optional)
|
||||
if command_exists docker; then
|
||||
DOCKER_VERSION=$(docker --version 2>/dev/null | grep -oE '[0-9]+\.[0-9]+' || echo "unknown")
|
||||
echo -e "${GREEN}✓ Docker ${DOCKER_VERSION} found (optional)${NC}"
|
||||
else
|
||||
echo -e "${YELLOW}ℹ Docker not found (optional for containerized development)${NC}"
|
||||
fi
|
||||
|
||||
# Check make
|
||||
if command_exists make; then
|
||||
echo -e "${GREEN}✓ make found${NC}"
|
||||
else
|
||||
echo -e "${YELLOW}⚠ make not found (development commands will not work)${NC}"
|
||||
WARNINGS=$((WARNINGS + 1))
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${CYAN}📋 UnitForge project checks...${NC}"
|
||||
echo ""
|
||||
|
||||
# Check if we're in UnitForge directory
|
||||
if [[ -f "pyproject.toml" && -f "unitforge-cli" ]]; then
|
||||
echo -e "${GREEN}✓ UnitForge project directory detected${NC}"
|
||||
|
||||
# Check project structure
|
||||
if [[ -d "backend" && -d "frontend" && -d "tests" ]]; then
|
||||
echo -e "${GREEN}✓ Project structure is valid${NC}"
|
||||
else
|
||||
echo -e "${YELLOW}⚠ Some project directories missing${NC}"
|
||||
WARNINGS=$((WARNINGS + 1))
|
||||
fi
|
||||
|
||||
# Check if virtual environment exists
|
||||
if [[ -d ".venv" ]]; then
|
||||
success "Virtual environment is active"
|
||||
|
||||
# Check if it's activated
|
||||
if [[ -n "${VIRTUAL_ENV}" ]]; then
|
||||
success "Virtual environment activated"
|
||||
else
|
||||
echo -e "${YELLOW}⚠ Virtual environment not activated${NC}"
|
||||
echo -e "${CYAN} Run: source .venv/bin/activate${NC}"
|
||||
WARNINGS=$((WARNINGS + 1))
|
||||
fi
|
||||
else
|
||||
echo -e "${YELLOW}⚠ Virtual environment not found${NC}"
|
||||
echo -e "${CYAN} Run: make setup-dev${NC}"
|
||||
WARNINGS=$((WARNINGS + 1))
|
||||
fi
|
||||
|
||||
# Check CLI tool
|
||||
if [[ -x "unitforge-cli" ]]; then
|
||||
echo -e "${GREEN}✓ CLI tool is executable${NC}"
|
||||
else
|
||||
echo -e "${YELLOW}⚠ CLI tool not executable${NC}"
|
||||
echo -e "${CYAN} Run: chmod +x unitforge-cli${NC}"
|
||||
WARNINGS=$((WARNINGS + 1))
|
||||
fi
|
||||
|
||||
else
|
||||
echo -e "${YELLOW}⚠ Not in UnitForge project directory${NC}"
|
||||
echo -e "${CYAN} Navigate to UnitForge project root${NC}"
|
||||
WARNINGS=$((WARNINGS + 1))
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${CYAN}📊 Performance test...${NC}"
|
||||
echo ""
|
||||
|
||||
# Quick performance test
|
||||
if command_exists uv; then
|
||||
echo -e "${BLUE}Testing uv performance (package list)...${NC}"
|
||||
START_TIME=$(date +%s.%N)
|
||||
uv pip list >/dev/null 2>&1 || true
|
||||
END_TIME=$(date +%s.%N)
|
||||
DURATION=$(echo "$END_TIME - $START_TIME" | bc -l 2>/dev/null || echo "N/A")
|
||||
|
||||
if [[ "$DURATION" != "N/A" ]]; then
|
||||
echo -e "${GREEN}✓ uv pip list completed in ${DURATION}s${NC}"
|
||||
else
|
||||
success "Performance test completed"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${CYAN}📋 Summary${NC}"
|
||||
echo ""
|
||||
|
||||
if [[ $ERRORS -eq 0 && $WARNINGS -eq 0 ]]; then
|
||||
echo -e "${GREEN}🎉 Perfect! Your system is fully ready for UnitForge development.${NC}"
|
||||
echo ""
|
||||
echo -e "${BLUE}Next steps:${NC}"
|
||||
echo -e " ${CYAN}make setup-dev # Setup development environment${NC}"
|
||||
echo -e " ${CYAN}make server # Start development server${NC}"
|
||||
echo -e " ${CYAN}make test # Run tests${NC}"
|
||||
|
||||
elif [[ $ERRORS -eq 0 ]]; then
|
||||
echo -e "${YELLOW}⚠ Your system is mostly ready with ${WARNINGS} warning(s).${NC}"
|
||||
echo -e "${GREEN}You can proceed with development, but consider addressing the warnings.${NC}"
|
||||
echo ""
|
||||
echo -e "${BLUE}Recommended:${NC}"
|
||||
echo -e " ${CYAN}make setup-dev # This may resolve some warnings${NC}"
|
||||
|
||||
else
|
||||
echo -e "${RED}❌ Your system has ${ERRORS} error(s) and ${WARNINGS} warning(s).${NC}"
|
||||
echo -e "${RED}Please resolve the errors before proceeding.${NC}"
|
||||
echo ""
|
||||
echo -e "${BLUE}Required actions:${NC}"
|
||||
if ! command_exists uv; then
|
||||
echo -e " ${CYAN}curl -LsSf https://astral.sh/uv/install.sh | sh${NC}"
|
||||
echo -e " ${CYAN}source ~/.bashrc # Or restart terminal${NC}"
|
||||
fi
|
||||
if ! command_exists python3; then
|
||||
echo -e " ${CYAN}Install Python 3.8+ from https://python.org${NC}"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${BLUE}Environment Information:${NC}"
|
||||
echo -e " ${CYAN}OS: $(uname -s) $(uname -r)${NC}"
|
||||
echo -e " ${CYAN}Architecture: $(uname -m)${NC}"
|
||||
echo -e " ${CYAN}Shell: ${SHELL}${NC}"
|
||||
if command_exists uv; then
|
||||
echo -e " ${CYAN}uv version: ${UV_VERSION}${NC}"
|
||||
fi
|
||||
if command_exists python3; then
|
||||
success "Python version: $PYTHON_VERSION"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${CYAN}For more information:${NC}"
|
||||
echo -e " ${BLUE}UnitForge: https://github.com/unitforge/unitforge${NC}"
|
||||
echo -e " ${BLUE}uv docs: https://github.com/astral-sh/uv${NC}"
|
||||
|
||||
# Exit with appropriate code
|
||||
if [[ $ERRORS -eq 0 ]]; then
|
||||
exit 0
|
||||
else
|
||||
exit 1
|
||||
fi
|
||||
@@ -0,0 +1,271 @@
|
||||
#!/bin/bash
|
||||
# UnitForge Demo Script
|
||||
# This script demonstrates the key features of UnitForge
|
||||
|
||||
set -e
|
||||
|
||||
# Load centralized color utility
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "${SCRIPT_DIR}/scripts/colors.sh"
|
||||
|
||||
# Check if virtual environment is activated
|
||||
if [[ -z "${VIRTUAL_ENV}" ]]; then
|
||||
echo -e "${YELLOW}Activating virtual environment...${NC}"
|
||||
if [[ -d ".venv" ]]; then
|
||||
source .venv/bin/activate
|
||||
elif [[ -d "venv" ]]; then
|
||||
source venv/bin/activate
|
||||
else
|
||||
echo -e "${RED}No virtual environment found. Run 'make setup-dev' first.${NC}"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
echo -e "${BLUE}╔══════════════════════════════════════════════╗${NC}"
|
||||
echo -e "${BLUE}║ UnitForge Demo ║${NC}"
|
||||
echo -e "${BLUE}║ Systemd Unit File Creator & Manager ║${NC}"
|
||||
echo -e "${BLUE}╚══════════════════════════════════════════════╝${NC}"
|
||||
echo ""
|
||||
|
||||
# Function to run command with header
|
||||
run_demo() {
|
||||
echo -e "${CYAN}=== $1 ===${NC}"
|
||||
echo -e "${YELLOW}Command: $2${NC}"
|
||||
echo ""
|
||||
eval "$2"
|
||||
echo ""
|
||||
echo -e "${GREEN}✓ Completed${NC}"
|
||||
echo ""
|
||||
read -p "Press Enter to continue..."
|
||||
echo ""
|
||||
}
|
||||
|
||||
# Check if uv is available
|
||||
echo -e "${CYAN}Checking development environment...${NC}"
|
||||
if command -v uv >/dev/null 2>&1; then
|
||||
echo -e "${GREEN}✓ uv package manager available${NC}"
|
||||
else
|
||||
echo -e "${YELLOW}⚠ uv not found, using standard pip${NC}"
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# 1. Show CLI help
|
||||
run_demo "CLI Help and Version" "./unitforge-cli --help"
|
||||
|
||||
# 2. List available templates
|
||||
run_demo "List Available Templates" "./unitforge-cli template list"
|
||||
|
||||
# 3. Show template details
|
||||
run_demo "Show Template Details" "./unitforge-cli template show webapp"
|
||||
|
||||
# 4. Create a simple service
|
||||
run_demo "Create Simple Service" "./unitforge-cli create --type service --name myapp --exec-start '/usr/bin/python3 /opt/myapp/main.py' --user myapp --working-directory /opt/myapp --output demo-simple.service"
|
||||
|
||||
# 5. Show created file
|
||||
echo -e "${CYAN}=== Generated Service File ===${NC}"
|
||||
echo -e "${YELLOW}Content of demo-simple.service:${NC}"
|
||||
echo ""
|
||||
cat demo-simple.service
|
||||
echo ""
|
||||
echo -e "${GREEN}✓ File created${NC}"
|
||||
echo ""
|
||||
read -p "Press Enter to continue..."
|
||||
echo ""
|
||||
|
||||
# 6. Validate the created file
|
||||
run_demo "Validate Created Service" "./unitforge-cli validate demo-simple.service"
|
||||
|
||||
# 7. Generate from webapp template
|
||||
echo -e "${CYAN}=== Generate from Template (Interactive) ===${NC}"
|
||||
echo -e "${YELLOW}This will create a web application service using the webapp template${NC}"
|
||||
echo ""
|
||||
|
||||
# Create parameters for the webapp template
|
||||
./unitforge-cli template generate webapp \
|
||||
--param name=mywebapp \
|
||||
--param description="My Demo Web Application" \
|
||||
--param exec_start="/usr/bin/node /opt/mywebapp/server.js" \
|
||||
--param user=webapp \
|
||||
--param group=webapp \
|
||||
--param working_directory=/opt/mywebapp \
|
||||
--param port=3000 \
|
||||
--param restart_policy=on-failure \
|
||||
--param private_tmp=true \
|
||||
--param protect_system=strict \
|
||||
--output demo-webapp.service \
|
||||
--validate-output
|
||||
|
||||
echo ""
|
||||
echo -e "${GREEN}✓ Generated webapp service${NC}"
|
||||
echo ""
|
||||
|
||||
# 8. Show generated webapp file
|
||||
echo -e "${CYAN}=== Generated Web App Service File ===${NC}"
|
||||
echo -e "${YELLOW}Content of demo-webapp.service:${NC}"
|
||||
echo ""
|
||||
cat demo-webapp.service
|
||||
echo ""
|
||||
echo -e "${GREEN}✓ Generated from template${NC}"
|
||||
echo ""
|
||||
read -p "Press Enter to continue..."
|
||||
echo ""
|
||||
|
||||
# 9. Create a timer service
|
||||
run_demo "Create Timer Service" "./unitforge-cli create --type timer --name backup --description 'Daily backup timer' --output demo-backup.timer"
|
||||
|
||||
# 10. Show timer file
|
||||
echo -e "${CYAN}=== Generated Timer File ===${NC}"
|
||||
echo -e "${YELLOW}Content of demo-backup.timer:${NC}"
|
||||
echo ""
|
||||
cat demo-backup.timer
|
||||
echo ""
|
||||
success "Backup timer created!"
|
||||
echo ""
|
||||
read -p "Press Enter to continue..."
|
||||
echo ""
|
||||
|
||||
# 11. Generate container service from template
|
||||
echo -e "${CYAN}=== Generate Container Service ===${NC}"
|
||||
echo -e "${YELLOW}Creating a Docker container service${NC}"
|
||||
echo ""
|
||||
|
||||
./unitforge-cli template generate container \
|
||||
--param name=nginx-container \
|
||||
--param description="Nginx Web Server Container" \
|
||||
--param container_runtime=docker \
|
||||
--param image=nginx:alpine \
|
||||
--param ports="80:80,443:443" \
|
||||
--param volumes="/data/nginx:/usr/share/nginx/html:ro" \
|
||||
--param environment="NGINX_HOST=localhost" \
|
||||
--param restart_policy=unless-stopped \
|
||||
--output demo-nginx.service \
|
||||
--validate-output
|
||||
|
||||
echo ""
|
||||
echo -e "${GREEN}✓ Generated container service${NC}"
|
||||
echo ""
|
||||
|
||||
# 12. Show container file
|
||||
echo -e "${CYAN}=== Generated Container Service File ===${NC}"
|
||||
echo -e "${YELLOW}Content of demo-nginx.service:${NC}"
|
||||
echo ""
|
||||
cat demo-nginx.service
|
||||
echo ""
|
||||
read -p "Press Enter to continue..."
|
||||
echo ""
|
||||
|
||||
# 13. Edit a unit file
|
||||
echo -e "${CYAN}=== Edit Unit File ===${NC}"
|
||||
echo -e "${YELLOW}Adding environment variables to the simple service${NC}"
|
||||
echo ""
|
||||
|
||||
./unitforge-cli edit demo-simple.service demo-simple-modified.service \
|
||||
--set "Service.Environment=DEBUG=1" \
|
||||
--set "Service.EnvironmentFile=/etc/myapp/config" \
|
||||
--set "Service.RestartSec=10" \
|
||||
--validate-output
|
||||
|
||||
echo ""
|
||||
echo -e "${GREEN}✓ Modified service file${NC}"
|
||||
echo ""
|
||||
|
||||
# 14. Show differences
|
||||
echo -e "${CYAN}=== File Modifications ===${NC}"
|
||||
echo -e "${YELLOW}Differences between original and modified files:${NC}"
|
||||
echo ""
|
||||
echo -e "${BLUE}Original file:${NC}"
|
||||
cat demo-simple.service
|
||||
echo ""
|
||||
echo -e "${BLUE}Modified file:${NC}"
|
||||
cat demo-simple-modified.service
|
||||
echo ""
|
||||
read -p "Press Enter to continue..."
|
||||
echo ""
|
||||
|
||||
# 15. Show unit file info
|
||||
run_demo "Show Unit File Information" "./unitforge-cli info demo-webapp.service"
|
||||
|
||||
# 16. Test validation with invalid file
|
||||
echo -e "${CYAN}=== Test Validation (Invalid File) ===${NC}"
|
||||
echo -e "${YELLOW}Creating an invalid unit file to test validation${NC}"
|
||||
echo ""
|
||||
|
||||
cat > demo-invalid.service << 'EOF'
|
||||
[Unit]
|
||||
Description=Invalid Service
|
||||
|
||||
[Service]
|
||||
Type=invalid-type
|
||||
ExecStart=
|
||||
User=
|
||||
|
||||
[Install]
|
||||
WantedBy=invalid.target
|
||||
EOF
|
||||
|
||||
echo "Created invalid service file with errors..."
|
||||
echo ""
|
||||
|
||||
./unitforge-cli validate demo-invalid.service || echo -e "${YELLOW}(Expected validation errors shown above)${NC}"
|
||||
|
||||
echo ""
|
||||
read -p "Press Enter to continue..."
|
||||
echo ""
|
||||
|
||||
# 17. Cleanup and summary
|
||||
echo -e "${CYAN}=== Demo Summary ===${NC}"
|
||||
echo ""
|
||||
echo -e "${GREEN}✓ Created simple service unit file${NC}"
|
||||
echo -e "${GREEN}✓ Generated web application service from template${NC}"
|
||||
echo -e "${GREEN}✓ Created timer unit file${NC}"
|
||||
echo -e "${GREEN}✓ Generated container service from template${NC}"
|
||||
echo -e "${GREEN}✓ Modified unit file with new settings${NC}"
|
||||
echo -e "${GREEN}✓ Validated unit files (both valid and invalid)${NC}"
|
||||
echo -e "${GREEN}✓ Displayed unit file information${NC}"
|
||||
echo ""
|
||||
|
||||
echo -e "${BLUE}Generated files:${NC}"
|
||||
ls -la demo-*.service demo-*.timer 2>/dev/null || echo "No demo files found"
|
||||
echo ""
|
||||
|
||||
echo -e "${YELLOW}To start the web interface:${NC}"
|
||||
echo -e " ${CYAN}make server${NC}"
|
||||
echo -e " ${CYAN}./start-server.sh${NC}"
|
||||
echo ""
|
||||
echo -e "${YELLOW}To install the CLI tool:${NC}"
|
||||
echo -e " ${CYAN}uv pip install -e .${NC}"
|
||||
echo ""
|
||||
echo -e "${YELLOW}Development workflow:${NC}"
|
||||
echo -e " ${CYAN}make setup-dev # Setup environment with uv${NC}"
|
||||
echo -e " ${CYAN}make test # Run tests${NC}"
|
||||
echo -e " ${CYAN}make format # Format code${NC}"
|
||||
echo -e " ${CYAN}make lint # Check code style${NC}"
|
||||
echo ""
|
||||
|
||||
read -p "Clean up demo files? (y/N): " -n 1 -r
|
||||
echo
|
||||
if [[ $REPLY =~ ^[Yy]$ ]]; then
|
||||
rm -f demo-*.service demo-*.timer webapp.service
|
||||
success "Demo files cleaned up"
|
||||
else
|
||||
echo -e "${YELLOW}Demo files preserved for inspection${NC}"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${BLUE}🎉 UnitForge demo completed! 🎉${NC}"
|
||||
echo ""
|
||||
echo -e "${GREEN}Key features demonstrated:${NC}"
|
||||
echo -e " • CLI for creating, validating, and editing unit files"
|
||||
echo -e " • Template system for common service types"
|
||||
echo -e " • Comprehensive validation with helpful error messages"
|
||||
echo -e " • Support for all major systemd unit types"
|
||||
echo -e " • Web interface for visual editing"
|
||||
echo -e " • Lightning-fast development with uv (no pip dependency)"
|
||||
echo ""
|
||||
echo -e "${CYAN}Visit the web interface at http://localhost:8000 for more features!${NC}"
|
||||
echo ""
|
||||
echo -e "${BLUE}Development commands:${NC}"
|
||||
echo -e " ${CYAN}make server # Start web interface${NC}"
|
||||
echo -e " ${CYAN}make test-cov # Run tests with coverage${NC}"
|
||||
echo -e " ${CYAN}make docker-dev # Docker development${NC}"
|
||||
echo -e " ${CYAN}make status # Check project status${NC}"
|
||||
@@ -0,0 +1,164 @@
|
||||
# UnitForge Docker Compose Configuration
|
||||
# Provides easy development and production deployment options
|
||||
|
||||
version: "3.8"
|
||||
|
||||
services:
|
||||
# Development service with hot reload
|
||||
unitforge-dev:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
target: development
|
||||
container_name: unitforge-dev
|
||||
ports:
|
||||
- "8000:8000"
|
||||
- "8001:8001" # Alternative port for testing
|
||||
volumes:
|
||||
- .:/app
|
||||
- /app/.venv # Exclude venv from bind mount
|
||||
- /app/backend/__pycache__ # Exclude cache
|
||||
- /app/.pytest_cache
|
||||
environment:
|
||||
- DEBUG=true
|
||||
- LOG_LEVEL=debug
|
||||
- RELOAD=true
|
||||
- PYTHONPATH=/app/backend
|
||||
command: ["./start-server.sh", "--host", "0.0.0.0", "--log-level", "debug"]
|
||||
networks:
|
||||
- unitforge-network
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
start_period: 40s
|
||||
|
||||
# Production-like service
|
||||
unitforge-prod:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
target: production
|
||||
container_name: unitforge-prod
|
||||
ports:
|
||||
- "8080:8000"
|
||||
environment:
|
||||
- DEBUG=false
|
||||
- LOG_LEVEL=info
|
||||
- RELOAD=false
|
||||
networks:
|
||||
- unitforge-network
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
start_period: 30s
|
||||
restart: unless-stopped
|
||||
|
||||
# CLI-only service for batch operations
|
||||
unitforge-cli:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
target: cli-only
|
||||
container_name: unitforge-cli
|
||||
volumes:
|
||||
- ./output:/output # Mount for output files
|
||||
- ./input:/input # Mount for input files
|
||||
working_dir: /app
|
||||
networks:
|
||||
- unitforge-network
|
||||
profiles:
|
||||
- cli
|
||||
|
||||
# Test runner service
|
||||
unitforge-test:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
target: development
|
||||
container_name: unitforge-test
|
||||
volumes:
|
||||
- .:/app
|
||||
- /app/.venv
|
||||
- test-results:/app/test-results
|
||||
environment:
|
||||
- PYTHONPATH=/app/backend
|
||||
command:
|
||||
[
|
||||
"python",
|
||||
"-m",
|
||||
"pytest",
|
||||
"tests/",
|
||||
"-v",
|
||||
"--junitxml=/app/test-results/junit.xml",
|
||||
"--cov=backend",
|
||||
"--cov-report=html:/app/test-results/htmlcov",
|
||||
]
|
||||
networks:
|
||||
- unitforge-network
|
||||
profiles:
|
||||
- test
|
||||
|
||||
# Documentation service (for future use)
|
||||
unitforge-docs:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
target: development
|
||||
container_name: unitforge-docs
|
||||
ports:
|
||||
- "8002:8000"
|
||||
volumes:
|
||||
- .:/app
|
||||
- /app/.venv
|
||||
environment:
|
||||
- PYTHONPATH=/app/backend
|
||||
command:
|
||||
[
|
||||
"python",
|
||||
"-c",
|
||||
"from backend.app.main import app; import uvicorn; uvicorn.run(app, host='0.0.0.0', port=8000, reload=True)",
|
||||
]
|
||||
networks:
|
||||
- unitforge-network
|
||||
profiles:
|
||||
- docs
|
||||
|
||||
# Load balancer for production (nginx)
|
||||
nginx:
|
||||
image: nginx:alpine
|
||||
container_name: unitforge-nginx
|
||||
ports:
|
||||
- "80:80"
|
||||
- "443:443"
|
||||
volumes:
|
||||
- ./nginx.conf:/etc/nginx/nginx.conf:ro
|
||||
- ./ssl:/etc/nginx/ssl:ro
|
||||
depends_on:
|
||||
- unitforge-prod
|
||||
networks:
|
||||
- unitforge-network
|
||||
profiles:
|
||||
- production
|
||||
restart: unless-stopped
|
||||
|
||||
networks:
|
||||
unitforge-network:
|
||||
driver: bridge
|
||||
name: unitforge-network
|
||||
|
||||
volumes:
|
||||
test-results:
|
||||
driver: local
|
||||
node_modules:
|
||||
driver: local
|
||||
# Override configurations for different environments
|
||||
# Usage examples:
|
||||
# Development: docker-compose up unitforge-dev
|
||||
# Production: docker-compose --profile production up
|
||||
# CLI only: docker-compose --profile cli run --rm unitforge-cli --help
|
||||
# Run tests: docker-compose --profile test up unitforge-test
|
||||
# With nginx: docker-compose --profile production up nginx unitforge-prod
|
||||
@@ -0,0 +1,547 @@
|
||||
/* UnitForge CSS Styles */
|
||||
|
||||
:root {
|
||||
--primary-color: #0d6efd;
|
||||
--secondary-color: #6c757d;
|
||||
--success-color: #198754;
|
||||
--danger-color: #dc3545;
|
||||
--warning-color: #ffc107;
|
||||
--info-color: #0dcaf0;
|
||||
--light-color: #f8f9fa;
|
||||
--dark-color: #212529;
|
||||
--border-radius: 0.375rem;
|
||||
--box-shadow: 0 0.125rem 0.25rem rgba(0, 0, 0, 0.075);
|
||||
--box-shadow-lg: 0 0.5rem 1rem rgba(0, 0, 0, 0.15);
|
||||
}
|
||||
|
||||
/* General Styles */
|
||||
body {
|
||||
font-family: "Segoe UI", Tahoma, Geneva, Verdana, sans-serif;
|
||||
line-height: 1.6;
|
||||
color: var(--dark-color);
|
||||
}
|
||||
|
||||
.hero-section {
|
||||
background: linear-gradient(135deg, #f8f9fa 0%, #e9ecef 100%);
|
||||
border-bottom: 1px solid #dee2e6;
|
||||
}
|
||||
|
||||
/* Feature Icons */
|
||||
.feature-icon {
|
||||
width: 4rem;
|
||||
height: 4rem;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
font-size: 1.5rem;
|
||||
}
|
||||
|
||||
/* Card Hover Effects */
|
||||
.hover-lift {
|
||||
transition: all 0.3s ease;
|
||||
}
|
||||
|
||||
.hover-lift:hover {
|
||||
transform: translateY(-5px);
|
||||
box-shadow: var(--box-shadow-lg);
|
||||
}
|
||||
|
||||
/* Unit Type Badges */
|
||||
.unit-type-badge {
|
||||
background: var(--light-color);
|
||||
border: 1px solid #dee2e6;
|
||||
border-radius: var(--border-radius);
|
||||
padding: 0.75rem 1rem;
|
||||
text-align: center;
|
||||
font-weight: 500;
|
||||
color: var(--dark-color);
|
||||
transition: all 0.2s ease;
|
||||
}
|
||||
|
||||
.unit-type-badge:hover {
|
||||
background: var(--primary-color);
|
||||
color: white;
|
||||
border-color: var(--primary-color);
|
||||
}
|
||||
|
||||
/* Code Preview */
|
||||
.code-preview {
|
||||
border-radius: var(--border-radius);
|
||||
box-shadow: var(--box-shadow-lg);
|
||||
}
|
||||
|
||||
.code-preview pre {
|
||||
margin: 0;
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
.code-preview code {
|
||||
font-size: 0.875rem;
|
||||
line-height: 1.4;
|
||||
}
|
||||
|
||||
/* Fix contrast for dark backgrounds */
|
||||
.bg-dark pre,
|
||||
.bg-dark code {
|
||||
color: #f8f9fa !important;
|
||||
}
|
||||
|
||||
.card.bg-dark .card-body pre,
|
||||
.card.bg-dark .card-body code {
|
||||
color: #f8f9fa !important;
|
||||
}
|
||||
|
||||
/* Override Bootstrap bg-dark for better contrast */
|
||||
.bg-dark {
|
||||
background-color: #1a202c !important;
|
||||
color: #f7fafc !important;
|
||||
}
|
||||
|
||||
.bg-dark pre,
|
||||
.bg-dark code {
|
||||
color: #f7fafc !important;
|
||||
}
|
||||
|
||||
/* Fix text-muted contrast issues */
|
||||
.text-muted {
|
||||
color: #6c757d !important;
|
||||
}
|
||||
|
||||
/* Better contrast for text-muted on dark backgrounds */
|
||||
.bg-dark .text-muted,
|
||||
.card.bg-dark .text-muted {
|
||||
color: #cbd5e0 !important;
|
||||
}
|
||||
|
||||
/* Better contrast for text-muted in cards */
|
||||
.card .text-muted {
|
||||
color: #495057 !important;
|
||||
}
|
||||
|
||||
/* Ensure text-muted in footer has proper contrast */
|
||||
footer.bg-dark .text-muted {
|
||||
color: #9ca3af !important;
|
||||
}
|
||||
|
||||
/* Fix text-muted in modals with dark backgrounds */
|
||||
.modal.bg-dark .text-muted,
|
||||
.modal-content.bg-dark .text-muted {
|
||||
color: #cbd5e0 !important;
|
||||
}
|
||||
|
||||
/* Better contrast for text-muted in forms on dark backgrounds */
|
||||
.bg-dark .form-text.text-muted {
|
||||
color: #a0aec0 !important;
|
||||
}
|
||||
|
||||
/* Specific override for hero section text-muted */
|
||||
.hero-section .text-muted {
|
||||
color: #495057 !important;
|
||||
}
|
||||
|
||||
/* Editor Specific Styles */
|
||||
.unit-type-fields {
|
||||
transition: all 0.3s ease;
|
||||
}
|
||||
|
||||
.unit-type-fields.d-none {
|
||||
display: none !important;
|
||||
}
|
||||
|
||||
#editor {
|
||||
font-family: "Courier New", Consolas, "Liberation Mono", monospace;
|
||||
font-size: 0.875rem;
|
||||
line-height: 1.5;
|
||||
border: none !important;
|
||||
resize: none;
|
||||
outline: none;
|
||||
box-shadow: none !important;
|
||||
}
|
||||
|
||||
#editor:focus {
|
||||
box-shadow: none !important;
|
||||
border: none !important;
|
||||
}
|
||||
|
||||
/* Validation Styles */
|
||||
.validation-error {
|
||||
background-color: #f8d7da;
|
||||
border-color: #f5c6cb;
|
||||
color: #721c24;
|
||||
padding: 0.75rem;
|
||||
margin-bottom: 0.5rem;
|
||||
border-radius: var(--border-radius);
|
||||
border-left: 4px solid var(--danger-color);
|
||||
}
|
||||
|
||||
.validation-warning {
|
||||
background-color: #fff3cd;
|
||||
border-color: #ffeaa7;
|
||||
color: #856404;
|
||||
padding: 0.75rem;
|
||||
margin-bottom: 0.5rem;
|
||||
border-radius: var(--border-radius);
|
||||
border-left: 4px solid var(--warning-color);
|
||||
}
|
||||
|
||||
.validation-success {
|
||||
background-color: #d1e7dd;
|
||||
border-color: #badbcc;
|
||||
color: #0f5132;
|
||||
padding: 0.75rem;
|
||||
margin-bottom: 0.5rem;
|
||||
border-radius: var(--border-radius);
|
||||
border-left: 4px solid var(--success-color);
|
||||
}
|
||||
|
||||
.validation-info {
|
||||
background-color: #cff4fc;
|
||||
border-color: #b8daff;
|
||||
color: #055160;
|
||||
padding: 0.75rem;
|
||||
margin-bottom: 0.5rem;
|
||||
border-radius: var(--border-radius);
|
||||
border-left: 4px solid var(--info-color);
|
||||
}
|
||||
|
||||
/* Info Items */
|
||||
.info-item {
|
||||
padding: 0.25rem 0;
|
||||
border-bottom: 1px solid #f1f3f4;
|
||||
}
|
||||
|
||||
.info-item:last-child {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
/* Help Content */
|
||||
.help-content {
|
||||
font-size: 0.875rem;
|
||||
}
|
||||
|
||||
.help-item {
|
||||
padding: 0.25rem 0;
|
||||
}
|
||||
|
||||
/* Template Cards */
|
||||
.template-card {
|
||||
transition: all 0.3s ease;
|
||||
cursor: pointer;
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
.template-card:hover {
|
||||
transform: translateY(-3px);
|
||||
box-shadow: var(--box-shadow-lg);
|
||||
}
|
||||
|
||||
.template-card .card-header {
|
||||
background: linear-gradient(135deg, var(--primary-color), #0b5ed7);
|
||||
color: white;
|
||||
border: none;
|
||||
}
|
||||
|
||||
.template-tags {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 0.25rem;
|
||||
margin-top: 0.5rem;
|
||||
}
|
||||
|
||||
.template-tag {
|
||||
background: var(--light-color);
|
||||
color: var(--secondary-color);
|
||||
padding: 0.125rem 0.5rem;
|
||||
border-radius: 1rem;
|
||||
font-size: 0.75rem;
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
/* Navigation Pills */
|
||||
.nav-pills .nav-link {
|
||||
color: var(--secondary-color);
|
||||
border-radius: var(--border-radius);
|
||||
transition: all 0.2s ease;
|
||||
}
|
||||
|
||||
.nav-pills .nav-link.active {
|
||||
background-color: var(--primary-color);
|
||||
color: white;
|
||||
}
|
||||
|
||||
.nav-pills .nav-link:hover:not(.active) {
|
||||
background-color: var(--light-color);
|
||||
color: var(--dark-color);
|
||||
}
|
||||
|
||||
/* Form Styles */
|
||||
.form-control:focus {
|
||||
border-color: var(--primary-color);
|
||||
box-shadow: 0 0 0 0.2rem rgba(13, 110, 253, 0.25);
|
||||
}
|
||||
|
||||
.form-select:focus {
|
||||
border-color: var(--primary-color);
|
||||
box-shadow: 0 0 0 0.2rem rgba(13, 110, 253, 0.25);
|
||||
}
|
||||
|
||||
/* Button Styles */
|
||||
.btn {
|
||||
border-radius: var(--border-radius);
|
||||
font-weight: 500;
|
||||
transition: all 0.2s ease;
|
||||
}
|
||||
|
||||
.btn-primary {
|
||||
background-color: var(--primary-color);
|
||||
border-color: var(--primary-color);
|
||||
}
|
||||
|
||||
.btn-primary:hover {
|
||||
background-color: #0b5ed7;
|
||||
border-color: #0a58ca;
|
||||
transform: translateY(-1px);
|
||||
}
|
||||
|
||||
.btn-outline-primary:hover {
|
||||
transform: translateY(-1px);
|
||||
}
|
||||
|
||||
/* Modal Styles */
|
||||
.modal-content {
|
||||
border: none;
|
||||
border-radius: var(--border-radius);
|
||||
box-shadow: var(--box-shadow-lg);
|
||||
}
|
||||
|
||||
.modal-header {
|
||||
border-bottom: 1px solid #f1f3f4;
|
||||
background: var(--light-color);
|
||||
}
|
||||
|
||||
.modal-footer {
|
||||
border-top: 1px solid #f1f3f4;
|
||||
background: var(--light-color);
|
||||
}
|
||||
|
||||
/* Loading States */
|
||||
.spinner-border {
|
||||
width: 3rem;
|
||||
height: 3rem;
|
||||
}
|
||||
|
||||
/* Parameter Form Styles */
|
||||
.parameter-group {
|
||||
margin-bottom: 1rem;
|
||||
padding: 1rem;
|
||||
background: var(--light-color);
|
||||
border-radius: var(--border-radius);
|
||||
border: 1px solid #e9ecef;
|
||||
}
|
||||
|
||||
.parameter-label {
|
||||
font-weight: 600;
|
||||
color: var(--dark-color);
|
||||
margin-bottom: 0.25rem;
|
||||
}
|
||||
|
||||
.parameter-description {
|
||||
font-size: 0.875rem;
|
||||
color: var(--secondary-color);
|
||||
margin-bottom: 0.5rem;
|
||||
}
|
||||
|
||||
.parameter-required {
|
||||
color: var(--danger-color);
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.parameter-optional {
|
||||
color: var(--secondary-color);
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* Preview Code Block */
|
||||
.preview-code {
|
||||
background: #1a202c;
|
||||
color: #f7fafc;
|
||||
border-radius: var(--border-radius);
|
||||
padding: 1rem;
|
||||
font-family: "Courier New", Consolas, "Liberation Mono", monospace;
|
||||
font-size: 0.875rem;
|
||||
line-height: 1.5;
|
||||
overflow-x: auto;
|
||||
max-height: 400px;
|
||||
overflow-y: auto;
|
||||
}
|
||||
|
||||
/* Responsive Adjustments */
|
||||
@media (max-width: 768px) {
|
||||
.hero-section {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.feature-icon {
|
||||
width: 3rem;
|
||||
height: 3rem;
|
||||
font-size: 1.25rem;
|
||||
}
|
||||
|
||||
.display-4 {
|
||||
font-size: 2.5rem;
|
||||
}
|
||||
|
||||
.nav-pills {
|
||||
flex-direction: column;
|
||||
}
|
||||
|
||||
.nav-pills .nav-link {
|
||||
text-align: center;
|
||||
margin-bottom: 0.25rem;
|
||||
}
|
||||
}
|
||||
|
||||
@media (max-width: 576px) {
|
||||
.container-fluid .row > div {
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
.modal-dialog {
|
||||
margin: 0.5rem;
|
||||
}
|
||||
|
||||
.btn-group .btn {
|
||||
padding: 0.25rem 0.5rem;
|
||||
font-size: 0.875rem;
|
||||
}
|
||||
}
|
||||
|
||||
/* Animation Classes */
|
||||
.fade-in {
|
||||
animation: fadeIn 0.5s ease-in;
|
||||
}
|
||||
|
||||
@keyframes fadeIn {
|
||||
from {
|
||||
opacity: 0;
|
||||
transform: translateY(20px);
|
||||
}
|
||||
to {
|
||||
opacity: 1;
|
||||
transform: translateY(0);
|
||||
}
|
||||
}
|
||||
|
||||
.slide-up {
|
||||
animation: slideUp 0.3s ease-out;
|
||||
}
|
||||
|
||||
@keyframes slideUp {
|
||||
from {
|
||||
opacity: 0;
|
||||
transform: translateY(30px);
|
||||
}
|
||||
to {
|
||||
opacity: 1;
|
||||
transform: translateY(0);
|
||||
}
|
||||
}
|
||||
|
||||
/* Utility Classes */
|
||||
.text-monospace {
|
||||
font-family: "Courier New", Consolas, "Liberation Mono", monospace;
|
||||
}
|
||||
|
||||
.bg-gradient {
|
||||
background-image: linear-gradient(
|
||||
180deg,
|
||||
rgba(255, 255, 255, 0.15),
|
||||
rgba(255, 255, 255, 0)
|
||||
);
|
||||
}
|
||||
|
||||
.border-start-primary {
|
||||
border-left: 4px solid var(--primary-color) !important;
|
||||
}
|
||||
|
||||
.border-start-success {
|
||||
border-left: 4px solid var(--success-color) !important;
|
||||
}
|
||||
|
||||
.border-start-warning {
|
||||
border-left: 4px solid var(--warning-color) !important;
|
||||
}
|
||||
|
||||
.border-start-danger {
|
||||
border-left: 4px solid var(--danger-color) !important;
|
||||
}
|
||||
|
||||
/* Dark Theme Support */
|
||||
@media (prefers-color-scheme: dark) {
|
||||
.card {
|
||||
background-color: #2d3748;
|
||||
border-color: #4a5568;
|
||||
color: #f7fafc;
|
||||
}
|
||||
|
||||
.card pre,
|
||||
.card code {
|
||||
color: #f7fafc !important;
|
||||
}
|
||||
|
||||
.card .text-muted {
|
||||
color: #cbd5e0 !important;
|
||||
}
|
||||
|
||||
.text-muted {
|
||||
color: #a0aec0 !important;
|
||||
}
|
||||
|
||||
/* Better text-muted for dark theme forms */
|
||||
.form-text.text-muted {
|
||||
color: #9ca3af !important;
|
||||
}
|
||||
|
||||
.modal-content {
|
||||
background-color: #2d3748;
|
||||
color: #f7fafc;
|
||||
}
|
||||
|
||||
.form-control {
|
||||
background-color: #2d3748;
|
||||
border-color: #4a5568;
|
||||
color: #f7fafc;
|
||||
}
|
||||
|
||||
.form-control:focus {
|
||||
background-color: #2d3748;
|
||||
border-color: var(--primary-color);
|
||||
color: #f7fafc;
|
||||
}
|
||||
}
|
||||
|
||||
/* Print Styles */
|
||||
@media print {
|
||||
.navbar,
|
||||
.modal,
|
||||
.btn,
|
||||
footer {
|
||||
display: none !important;
|
||||
}
|
||||
|
||||
.container {
|
||||
width: 100% !important;
|
||||
max-width: none !important;
|
||||
}
|
||||
|
||||
.card {
|
||||
border: 1px solid #000 !important;
|
||||
box-shadow: none !important;
|
||||
}
|
||||
|
||||
pre,
|
||||
code {
|
||||
white-space: pre-wrap !important;
|
||||
word-break: break-all !important;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,567 @@
|
||||
// UnitForge Editor JavaScript
|
||||
// Handles the unit file editor functionality
|
||||
|
||||
class UnitFileEditor {
|
||||
constructor() {
|
||||
this.currentUnitType = 'service';
|
||||
this.currentContent = '';
|
||||
this.init();
|
||||
}
|
||||
|
||||
init() {
|
||||
this.setupEventListeners();
|
||||
this.initializeEditor();
|
||||
this.updateFilename();
|
||||
}
|
||||
|
||||
setupEventListeners() {
|
||||
// Unit type change
|
||||
const unitTypeSelect = document.getElementById('unitType');
|
||||
if (unitTypeSelect) {
|
||||
unitTypeSelect.addEventListener('change', this.changeUnitType.bind(this));
|
||||
}
|
||||
|
||||
// Unit name change
|
||||
const unitNameInput = document.getElementById('unitName');
|
||||
if (unitNameInput) {
|
||||
unitNameInput.addEventListener('input', this.updateFilename.bind(this));
|
||||
}
|
||||
|
||||
// Editor content change
|
||||
const editor = document.getElementById('editor');
|
||||
if (editor) {
|
||||
editor.addEventListener('input', this.debounce(this.onEditorChange.bind(this), 300));
|
||||
}
|
||||
|
||||
// File upload
|
||||
const fileInput = document.getElementById('fileInput');
|
||||
if (fileInput) {
|
||||
fileInput.addEventListener('change', this.handleFileUpload.bind(this));
|
||||
}
|
||||
}
|
||||
|
||||
initializeEditor() {
|
||||
this.generateBasicUnit();
|
||||
}
|
||||
|
||||
changeUnitType() {
|
||||
const unitType = document.getElementById('unitType').value;
|
||||
this.currentUnitType = unitType;
|
||||
|
||||
// Show/hide type-specific fields
|
||||
this.toggleTypeFields(unitType);
|
||||
|
||||
// Update filename
|
||||
this.updateFilename();
|
||||
|
||||
// Generate new basic unit
|
||||
this.generateBasicUnit();
|
||||
}
|
||||
|
||||
toggleTypeFields(unitType) {
|
||||
// Hide all type-specific fields
|
||||
const allFields = document.querySelectorAll('.unit-type-fields');
|
||||
allFields.forEach(field => field.classList.add('d-none'));
|
||||
|
||||
// Show relevant fields
|
||||
const targetFields = document.getElementById(`${unitType}Fields`);
|
||||
if (targetFields) {
|
||||
targetFields.classList.remove('d-none');
|
||||
}
|
||||
}
|
||||
|
||||
updateFilename() {
|
||||
const unitName = document.getElementById('unitName').value || 'myservice';
|
||||
const unitType = document.getElementById('unitType').value;
|
||||
const filename = `${unitName}.${unitType}`;
|
||||
|
||||
const filenameElement = document.getElementById('filename');
|
||||
if (filenameElement) {
|
||||
filenameElement.textContent = filename;
|
||||
}
|
||||
}
|
||||
|
||||
generateBasicUnit() {
|
||||
const unitType = this.currentUnitType;
|
||||
const unitName = document.getElementById('unitName').value || 'myservice';
|
||||
const description = document.getElementById('unitDescription').value || 'My Service Description';
|
||||
|
||||
let content = `[Unit]\nDescription=${description}\n`;
|
||||
|
||||
// Add common dependencies
|
||||
if (unitType === 'service' || unitType === 'timer') {
|
||||
content += 'After=network.target\n';
|
||||
}
|
||||
|
||||
content += '\n';
|
||||
|
||||
// Add type-specific sections
|
||||
switch (unitType) {
|
||||
case 'service':
|
||||
content += '[Service]\n';
|
||||
content += 'Type=simple\n';
|
||||
content += 'ExecStart=/usr/bin/myapp\n';
|
||||
content += 'User=www-data\n';
|
||||
content += 'Restart=on-failure\n';
|
||||
break;
|
||||
|
||||
case 'timer':
|
||||
content += '[Timer]\n';
|
||||
content += 'OnCalendar=daily\n';
|
||||
content += 'Persistent=true\n';
|
||||
break;
|
||||
|
||||
case 'socket':
|
||||
content += '[Socket]\n';
|
||||
content += 'ListenStream=127.0.0.1:8080\n';
|
||||
content += 'SocketUser=www-data\n';
|
||||
break;
|
||||
|
||||
case 'mount':
|
||||
content += '[Mount]\n';
|
||||
content += 'What=/dev/disk/by-uuid/12345678-1234-1234-1234-123456789abc\n';
|
||||
content += 'Where=/mnt/mydisk\n';
|
||||
content += 'Type=ext4\n';
|
||||
content += 'Options=defaults\n';
|
||||
break;
|
||||
|
||||
case 'target':
|
||||
content += '[Unit]\n';
|
||||
content += 'Requires=multi-user.target\n';
|
||||
break;
|
||||
|
||||
case 'path':
|
||||
content += '[Path]\n';
|
||||
content += 'PathExists=/var/spool/myapp\n';
|
||||
content += 'Unit=myapp.service\n';
|
||||
break;
|
||||
}
|
||||
|
||||
// Add Install section for most types
|
||||
if (unitType !== 'target') {
|
||||
content += '\n[Install]\n';
|
||||
if (unitType === 'timer') {
|
||||
content += 'WantedBy=timers.target\n';
|
||||
} else if (unitType === 'socket') {
|
||||
content += 'WantedBy=sockets.target\n';
|
||||
} else {
|
||||
content += 'WantedBy=multi-user.target\n';
|
||||
}
|
||||
}
|
||||
|
||||
this.setEditorContent(content);
|
||||
}
|
||||
|
||||
setEditorContent(content) {
|
||||
const editor = document.getElementById('editor');
|
||||
if (editor) {
|
||||
editor.value = content;
|
||||
this.currentContent = content;
|
||||
this.updateUnitInfo();
|
||||
}
|
||||
}
|
||||
|
||||
onEditorChange() {
|
||||
const editor = document.getElementById('editor');
|
||||
if (editor) {
|
||||
this.currentContent = editor.value;
|
||||
this.updateUnitInfo();
|
||||
}
|
||||
}
|
||||
|
||||
updateUnitInfo() {
|
||||
// Update basic info display
|
||||
const lines = this.currentContent.split('\n');
|
||||
const sections = this.countSections(lines);
|
||||
|
||||
const infoType = document.getElementById('infoType');
|
||||
const infoSections = document.getElementById('infoSections');
|
||||
|
||||
if (infoType) {
|
||||
infoType.textContent = this.currentUnitType;
|
||||
}
|
||||
|
||||
if (infoSections) {
|
||||
infoSections.textContent = sections;
|
||||
}
|
||||
}
|
||||
|
||||
countSections(lines) {
|
||||
let count = 0;
|
||||
for (const line of lines) {
|
||||
if (line.trim().match(/^\[.+\]$/)) {
|
||||
count++;
|
||||
}
|
||||
}
|
||||
return count;
|
||||
}
|
||||
|
||||
updateField(section, key, value) {
|
||||
if (!value.trim()) return;
|
||||
|
||||
const lines = this.currentContent.split('\n');
|
||||
let newLines = [];
|
||||
let currentSection = '';
|
||||
let foundSection = false;
|
||||
let foundKey = false;
|
||||
|
||||
for (let i = 0; i < lines.length; i++) {
|
||||
const line = lines[i];
|
||||
const sectionMatch = line.match(/^\[(.+)\]$/);
|
||||
|
||||
if (sectionMatch) {
|
||||
currentSection = sectionMatch[1];
|
||||
foundSection = (currentSection === section);
|
||||
newLines.push(line);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (foundSection && line.includes('=')) {
|
||||
const [lineKey] = line.split('=', 2);
|
||||
if (lineKey.trim() === key) {
|
||||
newLines.push(`${key}=${value}`);
|
||||
foundKey = true;
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
newLines.push(line);
|
||||
}
|
||||
|
||||
// If section or key wasn't found, add them
|
||||
if (!foundKey) {
|
||||
this.addKeyToSection(newLines, section, key, value);
|
||||
}
|
||||
|
||||
this.setEditorContent(newLines.join('\n'));
|
||||
}
|
||||
|
||||
addKeyToSection(lines, section, key, value) {
|
||||
let sectionIndex = -1;
|
||||
let nextSectionIndex = -1;
|
||||
|
||||
// Find the target section
|
||||
for (let i = 0; i < lines.length; i++) {
|
||||
const sectionMatch = lines[i].match(/^\[(.+)\]$/);
|
||||
if (sectionMatch) {
|
||||
if (sectionMatch[1] === section) {
|
||||
sectionIndex = i;
|
||||
} else if (sectionIndex !== -1 && nextSectionIndex === -1) {
|
||||
nextSectionIndex = i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (sectionIndex === -1) {
|
||||
// Section doesn't exist, add it
|
||||
lines.push('');
|
||||
lines.push(`[${section}]`);
|
||||
lines.push(`${key}=${value}`);
|
||||
} else {
|
||||
// Section exists, add key
|
||||
const insertIndex = nextSectionIndex === -1 ? lines.length : nextSectionIndex;
|
||||
lines.splice(insertIndex, 0, `${key}=${value}`);
|
||||
}
|
||||
}
|
||||
|
||||
async validateUnit() {
|
||||
const content = this.currentContent;
|
||||
const filename = document.getElementById('filename').textContent;
|
||||
|
||||
const resultsDiv = document.getElementById('validationResults');
|
||||
if (!resultsDiv) return;
|
||||
|
||||
// Show loading
|
||||
resultsDiv.innerHTML = `
|
||||
<div class="alert alert-info">
|
||||
<i class="fas fa-spinner fa-spin me-2"></i>
|
||||
Validating unit file...
|
||||
</div>
|
||||
`;
|
||||
|
||||
try {
|
||||
const result = await unitforge.validateUnitFile(content, filename);
|
||||
resultsDiv.innerHTML = unitforge.formatValidationResults(result);
|
||||
|
||||
if (result.valid) {
|
||||
unitforge.showToast('Unit file is valid!', 'success');
|
||||
} else {
|
||||
unitforge.showToast(`Found ${result.errors.length} error(s)`, 'warning');
|
||||
}
|
||||
} catch (error) {
|
||||
resultsDiv.innerHTML = `
|
||||
<div class="alert alert-danger">
|
||||
<i class="fas fa-exclamation-circle me-2"></i>
|
||||
Validation failed: ${error.message}
|
||||
</div>
|
||||
`;
|
||||
unitforge.showToast('Validation failed', 'error');
|
||||
}
|
||||
}
|
||||
|
||||
resetEditor() {
|
||||
// Reset form fields
|
||||
document.getElementById('unitName').value = '';
|
||||
document.getElementById('unitDescription').value = '';
|
||||
document.getElementById('unitType').value = 'service';
|
||||
|
||||
// Reset type-specific fields
|
||||
document.getElementById('execStart').value = '';
|
||||
document.getElementById('user').value = '';
|
||||
document.getElementById('workingDirectory').value = '';
|
||||
|
||||
// Clear validation results
|
||||
const resultsDiv = document.getElementById('validationResults');
|
||||
if (resultsDiv) {
|
||||
resultsDiv.innerHTML = `
|
||||
<div class="alert alert-info">
|
||||
<i class="fas fa-info-circle me-2"></i>
|
||||
Click "Validate" to check your unit file.
|
||||
</div>
|
||||
`;
|
||||
}
|
||||
|
||||
// Regenerate basic unit
|
||||
this.currentUnitType = 'service';
|
||||
this.toggleTypeFields('service');
|
||||
this.updateFilename();
|
||||
this.generateBasicUnit();
|
||||
|
||||
unitforge.showToast('Editor reset', 'info');
|
||||
}
|
||||
|
||||
formatUnit() {
|
||||
const lines = this.currentContent.split('\n');
|
||||
const formatted = [];
|
||||
let inSection = false;
|
||||
|
||||
for (const line of lines) {
|
||||
const trimmed = line.trim();
|
||||
|
||||
if (trimmed.match(/^\[.+\]$/)) {
|
||||
// Section header
|
||||
if (inSection) {
|
||||
formatted.push(''); // Add blank line before new section
|
||||
}
|
||||
formatted.push(trimmed);
|
||||
inSection = true;
|
||||
} else if (trimmed === '') {
|
||||
// Empty line - only add if not consecutive
|
||||
if (formatted.length > 0 && formatted[formatted.length - 1] !== '') {
|
||||
formatted.push('');
|
||||
}
|
||||
} else if (trimmed.includes('=')) {
|
||||
// Key-value pair
|
||||
const [key, ...valueParts] = trimmed.split('=');
|
||||
const value = valueParts.join('=');
|
||||
formatted.push(`${key.trim()}=${value.trim()}`);
|
||||
} else {
|
||||
// Other content
|
||||
formatted.push(trimmed);
|
||||
}
|
||||
}
|
||||
|
||||
// Remove trailing empty lines
|
||||
while (formatted.length > 0 && formatted[formatted.length - 1] === '') {
|
||||
formatted.pop();
|
||||
}
|
||||
|
||||
this.setEditorContent(formatted.join('\n'));
|
||||
unitforge.showToast('Unit file formatted', 'success');
|
||||
}
|
||||
|
||||
async copyToClipboard() {
|
||||
await unitforge.copyToClipboard(this.currentContent);
|
||||
}
|
||||
|
||||
downloadFile() {
|
||||
const filename = document.getElementById('filename').textContent;
|
||||
unitforge.downloadTextFile(this.currentContent, filename);
|
||||
unitforge.showToast(`Downloaded ${filename}`, 'success');
|
||||
}
|
||||
|
||||
insertPattern(patternType) {
|
||||
let pattern = '';
|
||||
|
||||
switch (patternType) {
|
||||
case 'web-service':
|
||||
pattern = `[Unit]
|
||||
Description=Web Application Service
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
ExecStart=/usr/bin/node /opt/webapp/server.js
|
||||
User=webapp
|
||||
Group=webapp
|
||||
WorkingDirectory=/opt/webapp
|
||||
Environment=NODE_ENV=production
|
||||
Environment=PORT=3000
|
||||
Restart=on-failure
|
||||
RestartSec=5
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target`;
|
||||
break;
|
||||
|
||||
case 'background-job':
|
||||
pattern = `[Unit]
|
||||
Description=Background Job Service
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
ExecStart=/usr/bin/python3 /opt/app/worker.py
|
||||
User=worker
|
||||
Group=worker
|
||||
WorkingDirectory=/opt/app
|
||||
Restart=on-failure
|
||||
RestartSec=10
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target`;
|
||||
break;
|
||||
|
||||
case 'database':
|
||||
pattern = `[Unit]
|
||||
Description=Database Service
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=notify
|
||||
ExecStart=/usr/bin/mysqld --defaults-file=/etc/mysql/my.cnf
|
||||
User=mysql
|
||||
Group=mysql
|
||||
Restart=on-failure
|
||||
TimeoutSec=300
|
||||
PrivateTmp=true
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target`;
|
||||
break;
|
||||
}
|
||||
|
||||
if (pattern) {
|
||||
this.setEditorContent(pattern);
|
||||
unitforge.showToast(`Inserted ${patternType} pattern`, 'success');
|
||||
}
|
||||
}
|
||||
|
||||
async handleFileUpload(event) {
|
||||
const file = event.target.files[0];
|
||||
if (!file) return;
|
||||
|
||||
try {
|
||||
const result = await unitforge.uploadUnitFile(file);
|
||||
|
||||
// Load content into editor
|
||||
this.setEditorContent(result.content);
|
||||
|
||||
// Update filename if available
|
||||
if (result.filename) {
|
||||
const nameWithoutExt = result.filename.replace(/\.[^/.]+$/, "");
|
||||
document.getElementById('unitName').value = nameWithoutExt;
|
||||
this.updateFilename();
|
||||
}
|
||||
|
||||
// Update unit type if detected
|
||||
if (result.unit_type) {
|
||||
document.getElementById('unitType').value = result.unit_type;
|
||||
this.currentUnitType = result.unit_type;
|
||||
this.toggleTypeFields(result.unit_type);
|
||||
}
|
||||
|
||||
// Show validation results
|
||||
const resultsDiv = document.getElementById('validationResults');
|
||||
if (resultsDiv && result.validation) {
|
||||
resultsDiv.innerHTML = unitforge.formatValidationResults(result.validation);
|
||||
}
|
||||
|
||||
// Close upload modal
|
||||
const modal = bootstrap.Modal.getInstance(document.getElementById('uploadModal'));
|
||||
if (modal) {
|
||||
modal.hide();
|
||||
}
|
||||
|
||||
unitforge.showToast(`Loaded ${file.name}`, 'success');
|
||||
|
||||
} catch (error) {
|
||||
unitforge.showToast(`Failed to load file: ${error.message}`, 'error');
|
||||
}
|
||||
}
|
||||
|
||||
debounce(func, wait) {
|
||||
let timeout;
|
||||
return function executedFunction(...args) {
|
||||
const later = () => {
|
||||
clearTimeout(timeout);
|
||||
func(...args);
|
||||
};
|
||||
clearTimeout(timeout);
|
||||
timeout = setTimeout(later, wait);
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// Global functions for HTML onclick handlers
|
||||
function changeUnitType() {
|
||||
editor.changeUnitType();
|
||||
}
|
||||
|
||||
function updateFilename() {
|
||||
editor.updateFilename();
|
||||
}
|
||||
|
||||
function updateField(section, key, value) {
|
||||
editor.updateField(section, key, value);
|
||||
}
|
||||
|
||||
function validateUnit() {
|
||||
editor.validateUnit();
|
||||
}
|
||||
|
||||
function resetEditor() {
|
||||
editor.resetEditor();
|
||||
}
|
||||
|
||||
function formatUnit() {
|
||||
editor.formatUnit();
|
||||
}
|
||||
|
||||
function copyToClipboard() {
|
||||
editor.copyToClipboard();
|
||||
}
|
||||
|
||||
function downloadFile() {
|
||||
editor.downloadFile();
|
||||
}
|
||||
|
||||
function insertPattern(patternType) {
|
||||
editor.insertPattern(patternType);
|
||||
}
|
||||
|
||||
function loadFile() {
|
||||
const fileInput = document.getElementById('fileInput');
|
||||
const file = fileInput.files[0];
|
||||
|
||||
if (!file) {
|
||||
unitforge.showToast('Please select a file first', 'warning');
|
||||
return;
|
||||
}
|
||||
|
||||
// Trigger the file upload handling
|
||||
editor.handleFileUpload({ target: { files: [file] } });
|
||||
}
|
||||
|
||||
function showUploadModal() {
|
||||
const modal = new bootstrap.Modal(document.getElementById('uploadModal'));
|
||||
modal.show();
|
||||
}
|
||||
|
||||
// Initialize the editor
|
||||
const editor = new UnitFileEditor();
|
||||
|
||||
// Export for use in other modules
|
||||
window.UnitFileEditor = UnitFileEditor;
|
||||
window.editor = editor;
|
||||
@@ -0,0 +1,382 @@
|
||||
// UnitForge Main JavaScript
|
||||
// Handles general functionality across the application
|
||||
|
||||
class UnitForge {
|
||||
constructor() {
|
||||
this.baseUrl = window.location.origin;
|
||||
this.apiUrl = `${this.baseUrl}/api`;
|
||||
this.init();
|
||||
}
|
||||
|
||||
init() {
|
||||
this.setupEventListeners();
|
||||
this.initializeTooltips();
|
||||
}
|
||||
|
||||
setupEventListeners() {
|
||||
// Upload modal functionality
|
||||
const fileInput = document.getElementById('fileInput');
|
||||
if (fileInput) {
|
||||
fileInput.addEventListener('change', this.handleFileSelect.bind(this));
|
||||
}
|
||||
|
||||
// Copy to clipboard functionality
|
||||
document.addEventListener('click', (e) => {
|
||||
if (e.target.matches('[data-copy]') || e.target.closest('[data-copy]')) {
|
||||
const target = e.target.matches('[data-copy]') ? e.target : e.target.closest('[data-copy]');
|
||||
this.copyToClipboard(target.dataset.copy);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
initializeTooltips() {
|
||||
// Initialize Bootstrap tooltips
|
||||
const tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]'));
|
||||
tooltipTriggerList.map(function (tooltipTriggerEl) {
|
||||
return new bootstrap.Tooltip(tooltipTriggerEl);
|
||||
});
|
||||
}
|
||||
|
||||
// File upload handling
|
||||
handleFileSelect(event) {
|
||||
const file = event.target.files[0];
|
||||
if (!file) return;
|
||||
|
||||
const reader = new FileReader();
|
||||
reader.onload = (e) => {
|
||||
this.displayFileContent(e.target.result, file.name);
|
||||
};
|
||||
reader.readAsText(file);
|
||||
}
|
||||
|
||||
displayFileContent(content, filename) {
|
||||
// This will be overridden in specific pages
|
||||
console.log('File loaded:', filename, content);
|
||||
}
|
||||
|
||||
// API calls
|
||||
async apiCall(endpoint, options = {}) {
|
||||
const url = `${this.apiUrl}${endpoint}`;
|
||||
const defaultOptions = {
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
};
|
||||
|
||||
const finalOptions = { ...defaultOptions, ...options };
|
||||
|
||||
try {
|
||||
const response = await fetch(url, finalOptions);
|
||||
|
||||
if (!response.ok) {
|
||||
const errorData = await response.json().catch(() => ({}));
|
||||
throw new Error(errorData.detail || `HTTP ${response.status}: ${response.statusText}`);
|
||||
}
|
||||
|
||||
return await response.json();
|
||||
} catch (error) {
|
||||
console.error('API call failed:', error);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
async validateUnitFile(content, filename = null) {
|
||||
return await this.apiCall('/validate', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify({
|
||||
content: content,
|
||||
filename: filename
|
||||
})
|
||||
});
|
||||
}
|
||||
|
||||
async uploadUnitFile(file) {
|
||||
const formData = new FormData();
|
||||
formData.append('file', file);
|
||||
|
||||
const response = await fetch(`${this.apiUrl}/upload`, {
|
||||
method: 'POST',
|
||||
body: formData
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
const errorData = await response.json().catch(() => ({}));
|
||||
throw new Error(errorData.detail || `Upload failed: ${response.statusText}`);
|
||||
}
|
||||
|
||||
return await response.json();
|
||||
}
|
||||
|
||||
async downloadUnitFile(content, filename) {
|
||||
return await this.apiCall('/download', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify({
|
||||
content: content,
|
||||
filename: filename
|
||||
})
|
||||
});
|
||||
}
|
||||
|
||||
async getTemplates() {
|
||||
return await this.apiCall('/templates');
|
||||
}
|
||||
|
||||
async getTemplate(name) {
|
||||
return await this.apiCall(`/templates/${name}`);
|
||||
}
|
||||
|
||||
async generateFromTemplate(templateName, parameters, filename = null) {
|
||||
return await this.apiCall('/generate', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify({
|
||||
template_name: templateName,
|
||||
parameters: parameters,
|
||||
filename: filename
|
||||
})
|
||||
});
|
||||
}
|
||||
|
||||
// Utility functions
|
||||
async copyToClipboard(text) {
|
||||
try {
|
||||
await navigator.clipboard.writeText(text);
|
||||
this.showToast('Copied to clipboard!', 'success');
|
||||
} catch (err) {
|
||||
// Fallback for older browsers
|
||||
const textArea = document.createElement('textarea');
|
||||
textArea.value = text;
|
||||
textArea.style.position = 'fixed';
|
||||
textArea.style.left = '-999999px';
|
||||
textArea.style.top = '-999999px';
|
||||
document.body.appendChild(textArea);
|
||||
textArea.focus();
|
||||
textArea.select();
|
||||
|
||||
try {
|
||||
document.execCommand('copy');
|
||||
this.showToast('Copied to clipboard!', 'success');
|
||||
} catch (err) {
|
||||
this.showToast('Failed to copy to clipboard', 'error');
|
||||
}
|
||||
|
||||
document.body.removeChild(textArea);
|
||||
}
|
||||
}
|
||||
|
||||
showToast(message, type = 'info', duration = 3000) {
|
||||
// Create toast container if it doesn't exist
|
||||
let toastContainer = document.getElementById('toast-container');
|
||||
if (!toastContainer) {
|
||||
toastContainer = document.createElement('div');
|
||||
toastContainer.id = 'toast-container';
|
||||
toastContainer.className = 'position-fixed top-0 end-0 p-3';
|
||||
toastContainer.style.zIndex = '9999';
|
||||
document.body.appendChild(toastContainer);
|
||||
}
|
||||
|
||||
// Create toast element
|
||||
const toastId = `toast-${Date.now()}`;
|
||||
const toastHtml = `
|
||||
<div id="${toastId}" class="toast" role="alert" aria-live="assertive" aria-atomic="true">
|
||||
<div class="toast-header">
|
||||
<i class="fas fa-${this.getToastIcon(type)} text-${this.getToastColor(type)} me-2"></i>
|
||||
<strong class="me-auto">UnitForge</strong>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
|
||||
</div>
|
||||
<div class="toast-body">
|
||||
${message}
|
||||
</div>
|
||||
</div>
|
||||
`;
|
||||
|
||||
toastContainer.insertAdjacentHTML('beforeend', toastHtml);
|
||||
|
||||
// Initialize and show toast
|
||||
const toastElement = document.getElementById(toastId);
|
||||
const toast = new bootstrap.Toast(toastElement, {
|
||||
autohide: true,
|
||||
delay: duration
|
||||
});
|
||||
|
||||
toast.show();
|
||||
|
||||
// Remove toast element after it's hidden
|
||||
toastElement.addEventListener('hidden.bs.toast', () => {
|
||||
toastElement.remove();
|
||||
});
|
||||
}
|
||||
|
||||
getToastIcon(type) {
|
||||
const icons = {
|
||||
success: 'check-circle',
|
||||
error: 'exclamation-circle',
|
||||
warning: 'exclamation-triangle',
|
||||
info: 'info-circle'
|
||||
};
|
||||
return icons[type] || 'info-circle';
|
||||
}
|
||||
|
||||
getToastColor(type) {
|
||||
const colors = {
|
||||
success: 'success',
|
||||
error: 'danger',
|
||||
warning: 'warning',
|
||||
info: 'info'
|
||||
};
|
||||
return colors[type] || 'info';
|
||||
}
|
||||
|
||||
formatValidationResults(validation) {
|
||||
if (!validation) return '';
|
||||
|
||||
let html = '';
|
||||
|
||||
if (validation.valid) {
|
||||
html += `
|
||||
<div class="validation-success">
|
||||
<i class="fas fa-check-circle me-2"></i>
|
||||
Unit file is valid!
|
||||
</div>
|
||||
`;
|
||||
}
|
||||
|
||||
if (validation.errors && validation.errors.length > 0) {
|
||||
html += '<div class="mb-3">';
|
||||
html += `<h6 class="text-danger"><i class="fas fa-exclamation-circle me-2"></i>Errors (${validation.errors.length})</h6>`;
|
||||
|
||||
validation.errors.forEach(error => {
|
||||
const location = error.section + (error.key ? `.${error.key}` : '');
|
||||
html += `
|
||||
<div class="validation-error">
|
||||
<strong>[${location}]</strong> ${error.message}
|
||||
</div>
|
||||
`;
|
||||
});
|
||||
html += '</div>';
|
||||
}
|
||||
|
||||
if (validation.warnings && validation.warnings.length > 0) {
|
||||
html += '<div class="mb-3">';
|
||||
html += `<h6 class="text-warning"><i class="fas fa-exclamation-triangle me-2"></i>Warnings (${validation.warnings.length})</h6>`;
|
||||
|
||||
validation.warnings.forEach(warning => {
|
||||
const location = warning.section + (warning.key ? `.${warning.key}` : '');
|
||||
html += `
|
||||
<div class="validation-warning">
|
||||
<strong>[${location}]</strong> ${warning.message}
|
||||
</div>
|
||||
`;
|
||||
});
|
||||
html += '</div>';
|
||||
}
|
||||
|
||||
return html;
|
||||
}
|
||||
|
||||
downloadTextFile(content, filename) {
|
||||
const blob = new Blob([content], { type: 'text/plain' });
|
||||
const url = window.URL.createObjectURL(blob);
|
||||
const a = document.createElement('a');
|
||||
a.href = url;
|
||||
a.download = filename;
|
||||
document.body.appendChild(a);
|
||||
a.click();
|
||||
document.body.removeChild(a);
|
||||
window.URL.revokeObjectURL(url);
|
||||
}
|
||||
|
||||
escapeHtml(text) {
|
||||
const div = document.createElement('div');
|
||||
div.textContent = text;
|
||||
return div.innerHTML;
|
||||
}
|
||||
|
||||
debounce(func, wait) {
|
||||
let timeout;
|
||||
return function executedFunction(...args) {
|
||||
const later = () => {
|
||||
clearTimeout(timeout);
|
||||
func(...args);
|
||||
};
|
||||
clearTimeout(timeout);
|
||||
timeout = setTimeout(later, wait);
|
||||
};
|
||||
}
|
||||
|
||||
showLoading(element, message = 'Loading...') {
|
||||
if (typeof element === 'string') {
|
||||
element = document.getElementById(element);
|
||||
}
|
||||
|
||||
if (element) {
|
||||
element.innerHTML = `
|
||||
<div class="text-center py-5">
|
||||
<div class="spinner-border text-primary" role="status">
|
||||
<span class="visually-hidden">${message}</span>
|
||||
</div>
|
||||
<p class="mt-3 text-muted">${message}</p>
|
||||
</div>
|
||||
`;
|
||||
}
|
||||
}
|
||||
|
||||
hideLoading(element) {
|
||||
if (typeof element === 'string') {
|
||||
element = document.getElementById(element);
|
||||
}
|
||||
|
||||
if (element) {
|
||||
element.innerHTML = '';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Global functions for HTML onclick handlers
|
||||
function showUploadModal() {
|
||||
const modal = new bootstrap.Modal(document.getElementById('uploadModal'));
|
||||
modal.show();
|
||||
}
|
||||
|
||||
function showCliModal() {
|
||||
const modal = new bootstrap.Modal(document.getElementById('cliModal'));
|
||||
modal.show();
|
||||
}
|
||||
|
||||
async function validateFile() {
|
||||
const fileInput = document.getElementById('fileInput');
|
||||
const file = fileInput.files[0];
|
||||
|
||||
if (!file) {
|
||||
unitforge.showToast('Please select a file first', 'warning');
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
const result = await unitforge.uploadUnitFile(file);
|
||||
|
||||
// Display results
|
||||
const resultsDiv = document.getElementById('uploadResults');
|
||||
const outputDiv = document.getElementById('validationOutput');
|
||||
|
||||
if (resultsDiv && outputDiv) {
|
||||
outputDiv.innerHTML = unitforge.formatValidationResults(result.validation);
|
||||
resultsDiv.classList.remove('d-none');
|
||||
}
|
||||
|
||||
if (result.validation.valid) {
|
||||
unitforge.showToast('File validation completed successfully!', 'success');
|
||||
} else {
|
||||
unitforge.showToast(`Validation found ${result.validation.errors.length} error(s)`, 'warning');
|
||||
}
|
||||
|
||||
} catch (error) {
|
||||
unitforge.showToast(`Validation failed: ${error.message}`, 'error');
|
||||
}
|
||||
}
|
||||
|
||||
// Initialize the application
|
||||
const unitforge = new UnitForge();
|
||||
|
||||
// Export for use in other modules
|
||||
window.UnitForge = UnitForge;
|
||||
window.unitforge = unitforge;
|
||||
@@ -0,0 +1,670 @@
|
||||
// UnitForge Templates JavaScript
|
||||
// Handles the templates browser functionality
|
||||
|
||||
class TemplatesBrowser {
|
||||
constructor() {
|
||||
this.templates = [];
|
||||
this.filteredTemplates = [];
|
||||
this.currentCategory = "all";
|
||||
this.currentTemplate = null;
|
||||
this.init();
|
||||
}
|
||||
|
||||
init() {
|
||||
this.setupEventListeners();
|
||||
this.loadTemplates();
|
||||
}
|
||||
|
||||
setupEventListeners() {
|
||||
// Search input
|
||||
const searchInput = document.getElementById("searchInput");
|
||||
if (searchInput) {
|
||||
searchInput.addEventListener(
|
||||
"keyup",
|
||||
this.debounce(this.filterTemplates.bind(this), 300),
|
||||
);
|
||||
}
|
||||
|
||||
// Template form changes
|
||||
document.addEventListener("change", (e) => {
|
||||
if (
|
||||
e.target.matches(
|
||||
"#templateForm input, #templateForm select, #templateForm textarea",
|
||||
)
|
||||
) {
|
||||
this.updatePreview();
|
||||
}
|
||||
});
|
||||
|
||||
document.addEventListener("input", (e) => {
|
||||
if (e.target.matches("#templateForm input, #templateForm textarea")) {
|
||||
this.updatePreview();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
async loadTemplates() {
|
||||
const loadingState = document.getElementById("loadingState");
|
||||
const templatesGrid = document.getElementById("templatesGrid");
|
||||
|
||||
try {
|
||||
// Temporarily use static JSON file for testing
|
||||
const response = await fetch("/static/templates.json");
|
||||
this.templates = await response.json();
|
||||
this.filteredTemplates = [...this.templates];
|
||||
|
||||
if (loadingState) loadingState.classList.add("d-none");
|
||||
if (templatesGrid) templatesGrid.classList.remove("d-none");
|
||||
|
||||
this.renderTemplates();
|
||||
this.updateCategoryCounts();
|
||||
} catch (error) {
|
||||
if (loadingState) {
|
||||
loadingState.innerHTML = `
|
||||
<div class="text-center py-5">
|
||||
<i class="fas fa-exclamation-triangle fa-3x text-danger mb-3"></i>
|
||||
<h4>Failed to load templates</h4>
|
||||
<p class="text-muted">${error.message}</p>
|
||||
<button class="btn btn-primary" onclick="location.reload()">Retry</button>
|
||||
</div>
|
||||
`;
|
||||
}
|
||||
unitforge.showToast("Failed to load templates", "error");
|
||||
}
|
||||
}
|
||||
|
||||
renderTemplates() {
|
||||
const grid = document.getElementById("templatesGrid");
|
||||
const noResults = document.getElementById("noResults");
|
||||
|
||||
if (!grid) return;
|
||||
|
||||
if (this.filteredTemplates.length === 0) {
|
||||
grid.classList.add("d-none");
|
||||
if (noResults) noResults.classList.remove("d-none");
|
||||
return;
|
||||
}
|
||||
|
||||
if (noResults) noResults.classList.add("d-none");
|
||||
grid.classList.remove("d-none");
|
||||
|
||||
grid.innerHTML = this.filteredTemplates
|
||||
.map((template) => this.createTemplateCard(template))
|
||||
.join("");
|
||||
}
|
||||
|
||||
createTemplateCard(template) {
|
||||
const tags = template.tags
|
||||
.map((tag) => `<span class="template-tag">${this.escapeHtml(tag)}</span>`)
|
||||
.join("");
|
||||
|
||||
const requiredParams = template.parameters.filter((p) => p.required).length;
|
||||
const totalParams = template.parameters.length;
|
||||
|
||||
return `
|
||||
<div class="col-md-6 col-lg-4">
|
||||
<div class="card template-card border-0 shadow-sm" onclick="openTemplate('${template.name}')">
|
||||
<div class="card-header">
|
||||
<div class="d-flex justify-content-between align-items-start">
|
||||
<div>
|
||||
<h6 class="card-title mb-1">${this.escapeHtml(template.name)}</h6>
|
||||
<small class="opacity-75">
|
||||
<i class="fas fa-${this.getUnitTypeIcon(template.unit_type)} me-1"></i>
|
||||
${template.unit_type}
|
||||
</small>
|
||||
</div>
|
||||
<span class="badge bg-light text-dark">${template.category}</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card-body">
|
||||
<p class="card-text text-muted mb-3">${this.escapeHtml(template.description)}</p>
|
||||
|
||||
<div class="d-flex justify-content-between align-items-center mb-3">
|
||||
<small class="text-muted">
|
||||
<i class="fas fa-sliders-h me-1"></i>
|
||||
${requiredParams}/${totalParams} parameters
|
||||
</small>
|
||||
</div>
|
||||
|
||||
${tags ? `<div class="template-tags">${tags}</div>` : ""}
|
||||
</div>
|
||||
<div class="card-footer bg-transparent border-0">
|
||||
<div class="d-grid">
|
||||
<button class="btn btn-primary btn-sm" onclick="event.stopPropagation(); openTemplate('${template.name}')">
|
||||
<i class="fas fa-play me-2"></i>Use Template
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
`;
|
||||
}
|
||||
|
||||
getUnitTypeIcon(unitType) {
|
||||
const icons = {
|
||||
service: "play-circle",
|
||||
timer: "clock",
|
||||
socket: "plug",
|
||||
mount: "hdd",
|
||||
target: "bullseye",
|
||||
path: "folder",
|
||||
};
|
||||
return icons[unitType] || "file";
|
||||
}
|
||||
|
||||
updateCategoryCounts() {
|
||||
const categories = {
|
||||
all: this.templates.length,
|
||||
"Web Services": 0,
|
||||
"Database Services": 0,
|
||||
"System Maintenance": 0,
|
||||
"Container Services": 0,
|
||||
"Network Services": 0,
|
||||
};
|
||||
|
||||
this.templates.forEach((template) => {
|
||||
if (categories.hasOwnProperty(template.category)) {
|
||||
categories[template.category]++;
|
||||
}
|
||||
});
|
||||
|
||||
// Update count badges
|
||||
const categoryMappings = {
|
||||
all: "count-all",
|
||||
"Web Services": "count-web",
|
||||
"Database Services": "count-database",
|
||||
"System Maintenance": "count-maintenance",
|
||||
"Container Services": "count-container",
|
||||
"Network Services": "count-network",
|
||||
};
|
||||
|
||||
Object.keys(categories).forEach((category) => {
|
||||
const elementId = categoryMappings[category];
|
||||
if (elementId) {
|
||||
const countElement = document.getElementById(elementId);
|
||||
if (countElement) {
|
||||
countElement.textContent = categories[category];
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
filterTemplates() {
|
||||
const searchTerm = document
|
||||
.getElementById("searchInput")
|
||||
.value.toLowerCase();
|
||||
|
||||
this.filteredTemplates = this.templates.filter((template) => {
|
||||
const matchesSearch =
|
||||
!searchTerm ||
|
||||
template.name.toLowerCase().includes(searchTerm) ||
|
||||
template.description.toLowerCase().includes(searchTerm) ||
|
||||
template.tags.some((tag) => tag.toLowerCase().includes(searchTerm));
|
||||
|
||||
const matchesCategory =
|
||||
this.currentCategory === "all" ||
|
||||
template.category === this.currentCategory;
|
||||
|
||||
return matchesSearch && matchesCategory;
|
||||
});
|
||||
|
||||
this.renderTemplates();
|
||||
}
|
||||
|
||||
filterByCategory(category) {
|
||||
this.currentCategory = category;
|
||||
|
||||
// Update active tab
|
||||
document.querySelectorAll("#categoryTabs .nav-link").forEach((tab) => {
|
||||
tab.classList.remove("active");
|
||||
});
|
||||
|
||||
const tabMappings = {
|
||||
all: "tab-all",
|
||||
"Web Services": "tab-web",
|
||||
"Database Services": "tab-database",
|
||||
"System Maintenance": "tab-maintenance",
|
||||
"Container Services": "tab-container",
|
||||
"Network Services": "tab-network",
|
||||
};
|
||||
|
||||
const activeTab = document.getElementById(tabMappings[category]);
|
||||
if (activeTab) {
|
||||
activeTab.classList.add("active");
|
||||
}
|
||||
|
||||
this.filterTemplates();
|
||||
}
|
||||
|
||||
clearSearch() {
|
||||
const searchInput = document.getElementById("searchInput");
|
||||
if (searchInput) {
|
||||
searchInput.value = "";
|
||||
}
|
||||
this.currentCategory = "all";
|
||||
|
||||
// Reset active tab
|
||||
document.querySelectorAll("#categoryTabs .nav-link").forEach((tab) => {
|
||||
tab.classList.remove("active");
|
||||
});
|
||||
document.getElementById("tab-all").classList.add("active");
|
||||
|
||||
this.filterTemplates();
|
||||
}
|
||||
|
||||
async openTemplate(templateName) {
|
||||
try {
|
||||
this.currentTemplate = await unitforge.getTemplate(templateName);
|
||||
this.showTemplateModal();
|
||||
} catch (error) {
|
||||
unitforge.showToast(`Failed to load template: ${error.message}`, "error");
|
||||
}
|
||||
}
|
||||
|
||||
showTemplateModal() {
|
||||
if (!this.currentTemplate) return;
|
||||
|
||||
const modal = document.getElementById("templateModal");
|
||||
const title = document.getElementById("templateModalTitle");
|
||||
const info = document.getElementById("templateInfo");
|
||||
const parametersDiv = document.getElementById("templateParameters");
|
||||
const previewFilename = document.getElementById("previewFilename");
|
||||
|
||||
// Update modal title
|
||||
if (title) {
|
||||
title.innerHTML = `
|
||||
<i class="fas fa-file-code me-2"></i>
|
||||
${this.escapeHtml(this.currentTemplate.name)}
|
||||
`;
|
||||
}
|
||||
|
||||
// Update template info
|
||||
if (info) {
|
||||
info.innerHTML = `
|
||||
<div class="row">
|
||||
<div class="col-sm-3"><strong>Name:</strong></div>
|
||||
<div class="col-sm-9">${this.escapeHtml(this.currentTemplate.name)}</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-sm-3"><strong>Type:</strong></div>
|
||||
<div class="col-sm-9">
|
||||
<i class="fas fa-${this.getUnitTypeIcon(this.currentTemplate.unit_type)} me-1"></i>
|
||||
${this.currentTemplate.unit_type}
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-sm-3"><strong>Category:</strong></div>
|
||||
<div class="col-sm-9">${this.escapeHtml(this.currentTemplate.category)}</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-sm-3"><strong>Description:</strong></div>
|
||||
<div class="col-sm-9">${this.escapeHtml(this.currentTemplate.description)}</div>
|
||||
</div>
|
||||
${
|
||||
this.currentTemplate.tags.length > 0
|
||||
? `
|
||||
<div class="row">
|
||||
<div class="col-sm-3"><strong>Tags:</strong></div>
|
||||
<div class="col-sm-9">
|
||||
${this.currentTemplate.tags
|
||||
.map(
|
||||
(tag) =>
|
||||
`<span class="badge bg-secondary me-1">${this.escapeHtml(tag)}</span>`,
|
||||
)
|
||||
.join("")}
|
||||
</div>
|
||||
</div>
|
||||
`
|
||||
: ""
|
||||
}
|
||||
`;
|
||||
}
|
||||
|
||||
// Update filename
|
||||
if (previewFilename) {
|
||||
const defaultName = this.getDefaultName();
|
||||
previewFilename.textContent = `${defaultName}.${this.currentTemplate.unit_type}`;
|
||||
}
|
||||
|
||||
// Generate parameters form
|
||||
if (parametersDiv) {
|
||||
parametersDiv.innerHTML = this.generateParametersForm();
|
||||
}
|
||||
|
||||
// Show modal
|
||||
const bsModal = new bootstrap.Modal(modal);
|
||||
bsModal.show();
|
||||
|
||||
// Update preview
|
||||
this.updatePreview();
|
||||
}
|
||||
|
||||
generateParametersForm() {
|
||||
if (!this.currentTemplate || !this.currentTemplate.parameters) {
|
||||
return '<p class="text-muted">No parameters required for this template.</p>';
|
||||
}
|
||||
|
||||
return this.currentTemplate.parameters
|
||||
.map((param) => {
|
||||
const isRequired = param.required;
|
||||
const fieldId = `param-${param.name}`;
|
||||
|
||||
let inputHtml = "";
|
||||
|
||||
switch (param.type) {
|
||||
case "boolean":
|
||||
inputHtml = `
|
||||
<select class="form-select" id="${fieldId}" ${isRequired ? "required" : ""}>
|
||||
<option value="true" ${param.default === true ? "selected" : ""}>True</option>
|
||||
<option value="false" ${param.default === false ? "selected" : ""}>False</option>
|
||||
</select>
|
||||
`;
|
||||
break;
|
||||
|
||||
case "choice":
|
||||
const options = param.choices
|
||||
.map(
|
||||
(choice) =>
|
||||
`<option value="${choice}" ${param.default === choice ? "selected" : ""}>${choice}</option>`,
|
||||
)
|
||||
.join("");
|
||||
inputHtml = `
|
||||
<select class="form-select" id="${fieldId}" ${isRequired ? "required" : ""}>
|
||||
${!isRequired ? '<option value="">-- Select --</option>' : ""}
|
||||
${options}
|
||||
</select>
|
||||
`;
|
||||
break;
|
||||
|
||||
case "integer":
|
||||
inputHtml = `
|
||||
<input type="number" class="form-control" id="${fieldId}"
|
||||
value="${param.default || ""}"
|
||||
placeholder="${param.example || ""}"
|
||||
${isRequired ? "required" : ""}>
|
||||
`;
|
||||
break;
|
||||
|
||||
default: // string, list
|
||||
inputHtml = `
|
||||
<input type="text" class="form-control" id="${fieldId}"
|
||||
value="${param.default || ""}"
|
||||
placeholder="${param.example || ""}"
|
||||
${isRequired ? "required" : ""}>
|
||||
`;
|
||||
}
|
||||
|
||||
return `
|
||||
<div class="parameter-group">
|
||||
<label for="${fieldId}" class="parameter-label">
|
||||
${this.escapeHtml(param.name)}
|
||||
${isRequired ? '<span class="parameter-required">*</span>' : '<span class="parameter-optional">(optional)</span>'}
|
||||
</label>
|
||||
<div class="parameter-description">${this.escapeHtml(param.description)}</div>
|
||||
${inputHtml}
|
||||
${param.example ? `<div class="form-text">Example: ${this.escapeHtml(param.example)}</div>` : ""}
|
||||
</div>
|
||||
`;
|
||||
})
|
||||
.join("");
|
||||
}
|
||||
|
||||
getDefaultName() {
|
||||
const nameParam = this.currentTemplate.parameters.find(
|
||||
(p) => p.name === "name",
|
||||
);
|
||||
if (nameParam && nameParam.example) {
|
||||
return nameParam.example;
|
||||
}
|
||||
return this.currentTemplate.name.toLowerCase().replace(/[^a-z0-9]/g, "");
|
||||
}
|
||||
|
||||
getFormParameters() {
|
||||
const parameters = {};
|
||||
|
||||
if (!this.currentTemplate || !this.currentTemplate.parameters) {
|
||||
return parameters;
|
||||
}
|
||||
|
||||
this.currentTemplate.parameters.forEach((param) => {
|
||||
const element = document.getElementById(`param-${param.name}`);
|
||||
if (element && element.value.trim()) {
|
||||
let value = element.value.trim();
|
||||
|
||||
// Type conversion
|
||||
switch (param.type) {
|
||||
case "boolean":
|
||||
value = value === "true";
|
||||
break;
|
||||
case "integer":
|
||||
value = parseInt(value);
|
||||
if (isNaN(value)) value = param.default || 0;
|
||||
break;
|
||||
case "list":
|
||||
value = value
|
||||
.split(",")
|
||||
.map((v) => v.trim())
|
||||
.filter((v) => v);
|
||||
break;
|
||||
}
|
||||
|
||||
parameters[param.name] = value;
|
||||
}
|
||||
});
|
||||
|
||||
return parameters;
|
||||
}
|
||||
|
||||
async updatePreview() {
|
||||
if (!this.currentTemplate) return;
|
||||
|
||||
const preview = document.getElementById("templatePreview");
|
||||
const validation = document.getElementById("validationResults");
|
||||
|
||||
if (!preview) return;
|
||||
|
||||
const parameters = this.getFormParameters();
|
||||
|
||||
// Check if required parameters are missing
|
||||
const missingRequired = this.currentTemplate.parameters
|
||||
.filter((p) => p.required && !parameters.hasOwnProperty(p.name))
|
||||
.map((p) => p.name);
|
||||
|
||||
if (missingRequired.length > 0) {
|
||||
preview.innerHTML = `<code># Please fill in required parameters: ${missingRequired.join(", ")}</code>`;
|
||||
if (validation) validation.classList.add("d-none");
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
const result = await unitforge.generateFromTemplate(
|
||||
this.currentTemplate.name,
|
||||
parameters,
|
||||
`${parameters.name || "generated"}.${this.currentTemplate.unit_type}`,
|
||||
);
|
||||
|
||||
preview.innerHTML = `<code>${this.escapeHtml(result.content)}</code>`;
|
||||
|
||||
// Update filename
|
||||
const filenameElement = document.getElementById("previewFilename");
|
||||
if (filenameElement) {
|
||||
filenameElement.textContent = result.filename;
|
||||
}
|
||||
|
||||
// Show validation results
|
||||
if (validation && result.validation) {
|
||||
validation.innerHTML = unitforge.formatValidationResults(
|
||||
result.validation,
|
||||
);
|
||||
validation.classList.remove("d-none");
|
||||
}
|
||||
} catch (error) {
|
||||
preview.innerHTML = `<code># Error generating preview: ${error.message}</code>`;
|
||||
if (validation) validation.classList.add("d-none");
|
||||
}
|
||||
}
|
||||
|
||||
async validateTemplate() {
|
||||
const parameters = this.getFormParameters();
|
||||
const validation = document.getElementById("validationResults");
|
||||
|
||||
if (!validation) return;
|
||||
|
||||
validation.innerHTML = `
|
||||
<div class="alert alert-info">
|
||||
<i class="fas fa-spinner fa-spin me-2"></i>
|
||||
Validating template...
|
||||
</div>
|
||||
`;
|
||||
|
||||
try {
|
||||
const result = await unitforge.generateFromTemplate(
|
||||
this.currentTemplate.name,
|
||||
parameters,
|
||||
`${parameters.name || "generated"}.${this.currentTemplate.unit_type}`,
|
||||
);
|
||||
|
||||
validation.innerHTML = unitforge.formatValidationResults(
|
||||
result.validation,
|
||||
);
|
||||
|
||||
if (result.validation.valid) {
|
||||
unitforge.showToast("Template validation passed!", "success");
|
||||
} else {
|
||||
unitforge.showToast(
|
||||
`Validation found ${result.validation.errors.length} error(s)`,
|
||||
"warning",
|
||||
);
|
||||
}
|
||||
} catch (error) {
|
||||
validation.innerHTML = `
|
||||
<div class="alert alert-danger">
|
||||
<i class="fas fa-exclamation-circle me-2"></i>
|
||||
Validation failed: ${error.message}
|
||||
</div>
|
||||
`;
|
||||
unitforge.showToast("Validation failed", "error");
|
||||
}
|
||||
}
|
||||
|
||||
async generateAndDownload() {
|
||||
const generateBtn = document.getElementById("generateBtn");
|
||||
const originalText = generateBtn.innerHTML;
|
||||
|
||||
generateBtn.innerHTML =
|
||||
'<i class="fas fa-spinner fa-spin me-2"></i>Generating...';
|
||||
generateBtn.disabled = true;
|
||||
|
||||
try {
|
||||
const parameters = this.getFormParameters();
|
||||
const result = await unitforge.generateFromTemplate(
|
||||
this.currentTemplate.name,
|
||||
parameters,
|
||||
`${parameters.name || "generated"}.${this.currentTemplate.unit_type}`,
|
||||
);
|
||||
|
||||
// Download the file
|
||||
unitforge.downloadTextFile(result.content, result.filename);
|
||||
unitforge.showToast(`Downloaded ${result.filename}`, "success");
|
||||
|
||||
// Close modal
|
||||
const modal = bootstrap.Modal.getInstance(
|
||||
document.getElementById("templateModal"),
|
||||
);
|
||||
if (modal) {
|
||||
modal.hide();
|
||||
}
|
||||
} catch (error) {
|
||||
unitforge.showToast(`Generation failed: ${error.message}`, "error");
|
||||
} finally {
|
||||
generateBtn.innerHTML = originalText;
|
||||
generateBtn.disabled = false;
|
||||
}
|
||||
}
|
||||
|
||||
openInEditor() {
|
||||
const parameters = this.getFormParameters();
|
||||
|
||||
// Store template data in session storage for the editor
|
||||
sessionStorage.setItem(
|
||||
"templateData",
|
||||
JSON.stringify({
|
||||
template: this.currentTemplate.name,
|
||||
parameters: parameters,
|
||||
}),
|
||||
);
|
||||
|
||||
// Open editor in new tab/window or navigate
|
||||
window.open("/editor", "_blank");
|
||||
}
|
||||
|
||||
async copyPreviewToClipboard() {
|
||||
const preview = document.getElementById("templatePreview");
|
||||
if (preview) {
|
||||
const content = preview.textContent;
|
||||
await unitforge.copyToClipboard(content);
|
||||
}
|
||||
}
|
||||
|
||||
escapeHtml(text) {
|
||||
const div = document.createElement("div");
|
||||
div.textContent = text;
|
||||
return div.innerHTML;
|
||||
}
|
||||
|
||||
debounce(func, wait) {
|
||||
let timeout;
|
||||
return function executedFunction(...args) {
|
||||
const later = () => {
|
||||
clearTimeout(timeout);
|
||||
func(...args);
|
||||
};
|
||||
clearTimeout(timeout);
|
||||
timeout = setTimeout(later, wait);
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// Global functions for HTML onclick handlers
|
||||
function filterByCategory(category) {
|
||||
templatesBrowser.filterByCategory(category);
|
||||
}
|
||||
|
||||
function filterTemplates() {
|
||||
templatesBrowser.filterTemplates();
|
||||
}
|
||||
|
||||
function clearSearch() {
|
||||
templatesBrowser.clearSearch();
|
||||
}
|
||||
|
||||
function openTemplate(templateName) {
|
||||
templatesBrowser.openTemplate(templateName);
|
||||
}
|
||||
|
||||
function validateTemplate() {
|
||||
templatesBrowser.validateTemplate();
|
||||
}
|
||||
|
||||
function generateAndDownload() {
|
||||
templatesBrowser.generateAndDownload();
|
||||
}
|
||||
|
||||
function openInEditor() {
|
||||
templatesBrowser.openInEditor();
|
||||
}
|
||||
|
||||
function copyPreviewToClipboard() {
|
||||
templatesBrowser.copyPreviewToClipboard();
|
||||
}
|
||||
|
||||
// Initialize the templates browser when DOM is ready
|
||||
let templatesBrowser;
|
||||
|
||||
document.addEventListener("DOMContentLoaded", function () {
|
||||
templatesBrowser = new TemplatesBrowser();
|
||||
|
||||
// Export for use in other modules
|
||||
window.TemplatesBrowser = TemplatesBrowser;
|
||||
window.templatesBrowser = templatesBrowser;
|
||||
});
|
||||
@@ -0,0 +1,515 @@
|
||||
[
|
||||
{
|
||||
"name": "webapp",
|
||||
"description": "Web application service (Node.js, Python, etc.)",
|
||||
"unit_type": "service",
|
||||
"category": "Web Services",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "name",
|
||||
"description": "Service name",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "myapp"
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"description": "Service description",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "My Web Application"
|
||||
},
|
||||
{
|
||||
"name": "exec_start",
|
||||
"description": "Command to start the application",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "/usr/bin/node /opt/myapp/server.js"
|
||||
},
|
||||
{
|
||||
"name": "user",
|
||||
"description": "User to run the service as",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": "www-data",
|
||||
"choices": null,
|
||||
"example": "myapp"
|
||||
},
|
||||
{
|
||||
"name": "group",
|
||||
"description": "Group to run the service as",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": "www-data",
|
||||
"choices": null,
|
||||
"example": "myapp"
|
||||
},
|
||||
{
|
||||
"name": "working_directory",
|
||||
"description": "Working directory",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "/opt/myapp"
|
||||
},
|
||||
{
|
||||
"name": "environment_file",
|
||||
"description": "Environment file path",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "/etc/myapp/environment"
|
||||
},
|
||||
{
|
||||
"name": "port",
|
||||
"description": "Port number",
|
||||
"type": "integer",
|
||||
"required": false,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "3000"
|
||||
},
|
||||
{
|
||||
"name": "restart_policy",
|
||||
"description": "Restart policy",
|
||||
"type": "choice",
|
||||
"required": true,
|
||||
"default": "on-failure",
|
||||
"choices": [
|
||||
"no",
|
||||
"always",
|
||||
"on-failure",
|
||||
"on-success"
|
||||
],
|
||||
"example": null
|
||||
},
|
||||
{
|
||||
"name": "private_tmp",
|
||||
"description": "Use private /tmp",
|
||||
"type": "boolean",
|
||||
"required": true,
|
||||
"default": true,
|
||||
"choices": null,
|
||||
"example": null
|
||||
},
|
||||
{
|
||||
"name": "protect_system",
|
||||
"description": "Protect system directories",
|
||||
"type": "choice",
|
||||
"required": true,
|
||||
"default": "strict",
|
||||
"choices": [
|
||||
"no",
|
||||
"yes",
|
||||
"strict",
|
||||
"full"
|
||||
],
|
||||
"example": null
|
||||
}
|
||||
],
|
||||
"tags": [
|
||||
"web",
|
||||
"application",
|
||||
"nodejs",
|
||||
"python",
|
||||
"service"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "database",
|
||||
"description": "Database service (PostgreSQL, MySQL, MongoDB, etc.)",
|
||||
"unit_type": "service",
|
||||
"category": "Database Services",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "name",
|
||||
"description": "Database service name",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "postgresql"
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"description": "Service description",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "PostgreSQL Database Server"
|
||||
},
|
||||
{
|
||||
"name": "exec_start",
|
||||
"description": "Database start command",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "/usr/lib/postgresql/13/bin/postgres -D /var/lib/postgresql/13/main"
|
||||
},
|
||||
{
|
||||
"name": "user",
|
||||
"description": "Database user",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "postgres"
|
||||
},
|
||||
{
|
||||
"name": "group",
|
||||
"description": "Database group",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "postgres"
|
||||
},
|
||||
{
|
||||
"name": "data_directory",
|
||||
"description": "Data directory",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "/var/lib/postgresql/13/main"
|
||||
},
|
||||
{
|
||||
"name": "pid_file",
|
||||
"description": "PID file path",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "/var/run/postgresql/13-main.pid"
|
||||
},
|
||||
{
|
||||
"name": "timeout_sec",
|
||||
"description": "Startup timeout",
|
||||
"type": "integer",
|
||||
"required": true,
|
||||
"default": 300,
|
||||
"choices": null,
|
||||
"example": null
|
||||
}
|
||||
],
|
||||
"tags": [
|
||||
"database",
|
||||
"postgresql",
|
||||
"mysql",
|
||||
"mongodb",
|
||||
"service"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "backup-timer",
|
||||
"description": "Scheduled backup service with timer",
|
||||
"unit_type": "timer",
|
||||
"category": "System Maintenance",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "name",
|
||||
"description": "Backup job name",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "daily-backup"
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"description": "Backup description",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "Daily database backup"
|
||||
},
|
||||
{
|
||||
"name": "schedule",
|
||||
"description": "Backup schedule",
|
||||
"type": "choice",
|
||||
"required": true,
|
||||
"default": "daily",
|
||||
"choices": [
|
||||
"daily",
|
||||
"weekly",
|
||||
"monthly",
|
||||
"custom"
|
||||
],
|
||||
"example": null
|
||||
},
|
||||
{
|
||||
"name": "custom_schedule",
|
||||
"description": "Custom schedule (OnCalendar format)",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "*-*-* 02:00:00"
|
||||
},
|
||||
{
|
||||
"name": "backup_script",
|
||||
"description": "Backup script path",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "/usr/local/bin/backup.sh"
|
||||
},
|
||||
{
|
||||
"name": "backup_user",
|
||||
"description": "User to run backup as",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": "backup",
|
||||
"choices": null,
|
||||
"example": null
|
||||
},
|
||||
{
|
||||
"name": "persistent",
|
||||
"description": "Run missed backups on boot",
|
||||
"type": "boolean",
|
||||
"required": true,
|
||||
"default": true,
|
||||
"choices": null,
|
||||
"example": null
|
||||
},
|
||||
{
|
||||
"name": "randomized_delay",
|
||||
"description": "Randomized delay in minutes",
|
||||
"type": "integer",
|
||||
"required": false,
|
||||
"default": 0,
|
||||
"choices": null,
|
||||
"example": null
|
||||
}
|
||||
],
|
||||
"tags": [
|
||||
"backup",
|
||||
"timer",
|
||||
"maintenance",
|
||||
"scheduled"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "proxy-socket",
|
||||
"description": "Socket-activated proxy service",
|
||||
"unit_type": "socket",
|
||||
"category": "Network Services",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "name",
|
||||
"description": "Socket service name",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "myapp-proxy"
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"description": "Socket description",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "Proxy socket for myapp"
|
||||
},
|
||||
{
|
||||
"name": "listen_port",
|
||||
"description": "Port to listen on",
|
||||
"type": "integer",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "8080"
|
||||
},
|
||||
{
|
||||
"name": "listen_address",
|
||||
"description": "Address to bind to",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": "0.0.0.0",
|
||||
"choices": null,
|
||||
"example": "127.0.0.1"
|
||||
},
|
||||
{
|
||||
"name": "socket_user",
|
||||
"description": "Socket owner user",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "www-data"
|
||||
},
|
||||
{
|
||||
"name": "socket_group",
|
||||
"description": "Socket owner group",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "www-data"
|
||||
},
|
||||
{
|
||||
"name": "socket_mode",
|
||||
"description": "Socket file permissions",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": "0644",
|
||||
"choices": null,
|
||||
"example": "0660"
|
||||
},
|
||||
{
|
||||
"name": "accept",
|
||||
"description": "Accept multiple connections",
|
||||
"type": "boolean",
|
||||
"required": true,
|
||||
"default": false,
|
||||
"choices": null,
|
||||
"example": null
|
||||
},
|
||||
{
|
||||
"name": "max_connections",
|
||||
"description": "Maximum connections",
|
||||
"type": "integer",
|
||||
"required": false,
|
||||
"default": 64,
|
||||
"choices": null,
|
||||
"example": null
|
||||
}
|
||||
],
|
||||
"tags": [
|
||||
"socket",
|
||||
"proxy",
|
||||
"network",
|
||||
"activation"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "container",
|
||||
"description": "Containerized service (Docker/Podman)",
|
||||
"unit_type": "service",
|
||||
"category": "Container Services",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "name",
|
||||
"description": "Container service name",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "webapp-container"
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"description": "Container description",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "My Web App Container"
|
||||
},
|
||||
{
|
||||
"name": "container_runtime",
|
||||
"description": "Container runtime",
|
||||
"type": "choice",
|
||||
"required": true,
|
||||
"default": "docker",
|
||||
"choices": [
|
||||
"docker",
|
||||
"podman"
|
||||
],
|
||||
"example": null
|
||||
},
|
||||
{
|
||||
"name": "image",
|
||||
"description": "Container image",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "nginx:latest"
|
||||
},
|
||||
{
|
||||
"name": "ports",
|
||||
"description": "Port mappings",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "80:8080,443:8443"
|
||||
},
|
||||
{
|
||||
"name": "volumes",
|
||||
"description": "Volume mounts",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "/data:/app/data,/config:/app/config"
|
||||
},
|
||||
{
|
||||
"name": "environment",
|
||||
"description": "Environment variables",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "ENV=production,DEBUG=false"
|
||||
},
|
||||
{
|
||||
"name": "network",
|
||||
"description": "Container network",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"default": null,
|
||||
"choices": null,
|
||||
"example": "bridge"
|
||||
},
|
||||
{
|
||||
"name": "restart_policy",
|
||||
"description": "Container restart policy",
|
||||
"type": "choice",
|
||||
"required": true,
|
||||
"default": "unless-stopped",
|
||||
"choices": [
|
||||
"no",
|
||||
"always",
|
||||
"unless-stopped",
|
||||
"on-failure"
|
||||
],
|
||||
"example": null
|
||||
},
|
||||
{
|
||||
"name": "pull_policy",
|
||||
"description": "Image pull policy",
|
||||
"type": "choice",
|
||||
"required": true,
|
||||
"default": "missing",
|
||||
"choices": [
|
||||
"always",
|
||||
"missing",
|
||||
"never"
|
||||
],
|
||||
"example": null
|
||||
}
|
||||
],
|
||||
"tags": [
|
||||
"container",
|
||||
"docker",
|
||||
"podman",
|
||||
"service"
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -0,0 +1,322 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Editor - UnitForge</title>
|
||||
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet">
|
||||
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css" rel="stylesheet">
|
||||
<link href="https://cdnjs.cloudflare.com/ajax/libs/codemirror/6.0.1/codemirror.min.css" rel="stylesheet">
|
||||
<link href="https://cdnjs.cloudflare.com/ajax/libs/codemirror/6.0.1/theme/monokai.min.css" rel="stylesheet">
|
||||
<link href="/static/css/style.css" rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<nav class="navbar navbar-expand-lg navbar-dark bg-primary">
|
||||
<div class="container">
|
||||
<a class="navbar-brand" href="/">
|
||||
<i class="fas fa-cogs me-2"></i>UnitForge
|
||||
</a>
|
||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav">
|
||||
<span class="navbar-toggler-icon"></span>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navbarNav">
|
||||
<ul class="navbar-nav me-auto">
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" href="/">Home</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a class="nav-link active" href="/editor">Editor</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" href="/templates">Templates</a>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="navbar-nav">
|
||||
<button class="btn btn-outline-light btn-sm me-2" onclick="downloadFile()">
|
||||
<i class="fas fa-download me-1"></i>Download
|
||||
</button>
|
||||
<button class="btn btn-outline-light btn-sm" onclick="showUploadModal()">
|
||||
<i class="fas fa-upload me-1"></i>Upload
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<div class="container-fluid py-4">
|
||||
<div class="row">
|
||||
<!-- Editor Configuration Panel -->
|
||||
<div class="col-lg-3">
|
||||
<div class="card border-0 shadow-sm h-100">
|
||||
<div class="card-header bg-light">
|
||||
<h6 class="card-title mb-0">
|
||||
<i class="fas fa-cog me-2"></i>Configuration
|
||||
</h6>
|
||||
</div>
|
||||
<div class="card-body">
|
||||
<!-- Basic Settings -->
|
||||
<div class="mb-4">
|
||||
<h6 class="text-muted mb-3">Basic Settings</h6>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="unitType" class="form-label">Unit Type</label>
|
||||
<select class="form-select" id="unitType" onchange="changeUnitType()">
|
||||
<option value="service">Service</option>
|
||||
<option value="timer">Timer</option>
|
||||
<option value="socket">Socket</option>
|
||||
<option value="mount">Mount</option>
|
||||
<option value="target">Target</option>
|
||||
<option value="path">Path</option>
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="unitName" class="form-label">Unit Name</label>
|
||||
<input type="text" class="form-control" id="unitName" placeholder="myservice" oninput="updateFilename()">
|
||||
</div>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="unitDescription" class="form-label">Description</label>
|
||||
<input type="text" class="form-control" id="unitDescription" placeholder="My Service Description" oninput="updateField('Unit', 'Description', this.value)">
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Service-specific fields -->
|
||||
<div id="serviceFields" class="unit-type-fields">
|
||||
<h6 class="text-muted mb-3">Service Configuration</h6>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="serviceType" class="form-label">Service Type</label>
|
||||
<select class="form-select" id="serviceType" onchange="updateField('Service', 'Type', this.value)">
|
||||
<option value="simple">Simple</option>
|
||||
<option value="exec">Exec</option>
|
||||
<option value="forking">Forking</option>
|
||||
<option value="oneshot">Oneshot</option>
|
||||
<option value="dbus">D-Bus</option>
|
||||
<option value="notify">Notify</option>
|
||||
<option value="idle">Idle</option>
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="execStart" class="form-label">Exec Start</label>
|
||||
<input type="text" class="form-control" id="execStart" placeholder="/usr/bin/myapp" oninput="updateField('Service', 'ExecStart', this.value)">
|
||||
</div>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="user" class="form-label">User</label>
|
||||
<input type="text" class="form-control" id="user" placeholder="www-data" oninput="updateField('Service', 'User', this.value)">
|
||||
</div>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="workingDirectory" class="form-label">Working Directory</label>
|
||||
<input type="text" class="form-control" id="workingDirectory" placeholder="/opt/myapp" oninput="updateField('Service', 'WorkingDirectory', this.value)">
|
||||
</div>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="restart" class="form-label">Restart Policy</label>
|
||||
<select class="form-select" id="restart" onchange="updateField('Service', 'Restart', this.value)">
|
||||
<option value="no">No</option>
|
||||
<option value="always">Always</option>
|
||||
<option value="on-success">On Success</option>
|
||||
<option value="on-failure" selected>On Failure</option>
|
||||
<option value="on-abnormal">On Abnormal</option>
|
||||
<option value="on-abort">On Abort</option>
|
||||
<option value="on-watchdog">On Watchdog</option>
|
||||
</select>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Timer-specific fields -->
|
||||
<div id="timerFields" class="unit-type-fields d-none">
|
||||
<h6 class="text-muted mb-3">Timer Configuration</h6>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="onCalendar" class="form-label">On Calendar</label>
|
||||
<input type="text" class="form-control" id="onCalendar" placeholder="daily" oninput="updateField('Timer', 'OnCalendar', this.value)">
|
||||
<div class="form-text">Examples: daily, weekly, monthly, *-*-* 02:00:00</div>
|
||||
</div>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="persistent" class="form-label">Persistent</label>
|
||||
<select class="form-select" id="persistent" onchange="updateField('Timer', 'Persistent', this.value)">
|
||||
<option value="true" selected>True</option>
|
||||
<option value="false">False</option>
|
||||
</select>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Socket-specific fields -->
|
||||
<div id="socketFields" class="unit-type-fields d-none">
|
||||
<h6 class="text-muted mb-3">Socket Configuration</h6>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="listenStream" class="form-label">Listen Stream</label>
|
||||
<input type="text" class="form-control" id="listenStream" placeholder="127.0.0.1:8080" oninput="updateField('Socket', 'ListenStream', this.value)">
|
||||
</div>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="socketUser" class="form-label">Socket User</label>
|
||||
<input type="text" class="form-control" id="socketUser" placeholder="www-data" oninput="updateField('Socket', 'SocketUser', this.value)">
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Install section -->
|
||||
<div class="mb-4">
|
||||
<h6 class="text-muted mb-3">Install Configuration</h6>
|
||||
|
||||
<div class="mb-3">
|
||||
<label for="wantedBy" class="form-label">Wanted By</label>
|
||||
<input type="text" class="form-control" id="wantedBy" value="multi-user.target" oninput="updateField('Install', 'WantedBy', this.value)">
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Actions -->
|
||||
<div class="d-grid gap-2">
|
||||
<button class="btn btn-success" onclick="validateUnit()">
|
||||
<i class="fas fa-check me-2"></i>Validate
|
||||
</button>
|
||||
<button class="btn btn-outline-primary" onclick="resetEditor()">
|
||||
<i class="fas fa-refresh me-2"></i>Reset
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Main Editor Area -->
|
||||
<div class="col-lg-6">
|
||||
<div class="card border-0 shadow-sm h-100">
|
||||
<div class="card-header bg-light d-flex justify-content-between align-items-center">
|
||||
<div>
|
||||
<h6 class="card-title mb-0">
|
||||
<i class="fas fa-file-code me-2"></i>
|
||||
<span id="filename">myservice.service</span>
|
||||
</h6>
|
||||
</div>
|
||||
<div class="btn-group btn-group-sm">
|
||||
<button class="btn btn-outline-secondary" onclick="formatUnit()" title="Format">
|
||||
<i class="fas fa-indent"></i>
|
||||
</button>
|
||||
<button class="btn btn-outline-secondary" onclick="copyToClipboard()" title="Copy">
|
||||
<i class="fas fa-copy"></i>
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card-body p-0">
|
||||
<textarea id="editor" class="form-control border-0" rows="25" style="font-family: 'Courier New', monospace; resize: none;">[Unit]
|
||||
Description=My Service Description
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
ExecStart=/usr/bin/myapp
|
||||
User=www-data
|
||||
Restart=on-failure
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target</textarea>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Validation & Preview Panel -->
|
||||
<div class="col-lg-3">
|
||||
<div class="card border-0 shadow-sm h-100">
|
||||
<div class="card-header bg-light">
|
||||
<h6 class="card-title mb-0">
|
||||
<i class="fas fa-clipboard-check me-2"></i>Validation & Info
|
||||
</h6>
|
||||
</div>
|
||||
<div class="card-body">
|
||||
<!-- Validation Results -->
|
||||
<div id="validationResults" class="mb-4">
|
||||
<div class="alert alert-info">
|
||||
<i class="fas fa-info-circle me-2"></i>
|
||||
Click "Validate" to check your unit file.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Unit File Info -->
|
||||
<div class="mb-4">
|
||||
<h6 class="text-muted mb-3">Unit Information</h6>
|
||||
<div id="unitInfo">
|
||||
<div class="info-item">
|
||||
<strong>Type:</strong> <span id="infoType">service</span>
|
||||
</div>
|
||||
<div class="info-item">
|
||||
<strong>Sections:</strong> <span id="infoSections">3</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Quick Help -->
|
||||
<div class="mb-4">
|
||||
<h6 class="text-muted mb-3">Quick Help</h6>
|
||||
<div class="help-content">
|
||||
<div class="help-item mb-2">
|
||||
<small></small><strong>[Unit]</strong> - Basic metadata and dependencies</small>
|
||||
</div>
|
||||
<div class="help-item mb-2">
|
||||
<small><strong>[Service]</strong> - Service-specific configuration</small>
|
||||
</div>
|
||||
<div class="help-item mb-2">
|
||||
<small><strong>[Install]</strong> - Installation and enabling info</small>
|
||||
</div>
|
||||
<div class="help-item">
|
||||
<small><a href="https://www.freedesktop.org/software/systemd/man/systemd.unit.html" target="_blank">systemd documentation <i class="fas fa-external-link-alt"></i></a></small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Common Patterns -->
|
||||
<div>
|
||||
<h6 class="text-muted mb-3">Common Patterns</h6>
|
||||
<div class="d-grid gap-2">
|
||||
<button class="btn btn-outline-secondary btn-sm" onclick="insertPattern('web-service')">
|
||||
Web Service
|
||||
</button>
|
||||
<button class="btn btn-outline-secondary btn-sm" onclick="insertPattern('background-job')">
|
||||
Background Job
|
||||
</button>
|
||||
<button class="btn btn-outline-secondary btn-sm" onclick="insertPattern('database')">
|
||||
Database Service
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Upload Modal -->
|
||||
<div class="modal fade" id="uploadModal" tabindex="-1">
|
||||
<div class="modal-dialog">
|
||||
<div class="modal-content">
|
||||
<div class="modal-header">
|
||||
<h5 class="modal-title">
|
||||
<i class="fas fa-upload me-2"></i>Upload Unit File
|
||||
</h5>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="modal"></button>
|
||||
</div>
|
||||
<div class="modal-body">
|
||||
<div class="mb-3">
|
||||
<label for="fileInput" class="form-label">Select unit file:</label>
|
||||
<input type="file" class="form-control" id="fileInput" accept=".service,.timer,.socket,.mount,.target,.path">
|
||||
</div>
|
||||
</div>
|
||||
<div class="modal-footer">
|
||||
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Cancel</button>
|
||||
<button type="button" class="btn btn-primary" onclick="loadFile()">
|
||||
<i class="fas fa-upload me-2"></i>Load
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
|
||||
<script src="/static/js/editor.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,313 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>UnitForge - Systemd Unit File Creator</title>
|
||||
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet">
|
||||
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css" rel="stylesheet">
|
||||
<link href="/static/css/style.css" rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<nav class="navbar navbar-expand-lg navbar-dark bg-primary">
|
||||
<div class="container">
|
||||
<a class="navbar-brand" href="/">
|
||||
<i class="fas fa-cogs me-2"></i>UnitForge
|
||||
</a>
|
||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav">
|
||||
<span class="navbar-toggler-icon"></span>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navbarNav">
|
||||
<ul class="navbar-nav me-auto">
|
||||
<li class="nav-item">
|
||||
<a class="nav-link active" href="/">Home</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" href="/editor">Editor</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" href="/templates">Templates</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="navbar-nav">
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" href="/api/docs" target="_blank">
|
||||
<i class="fas fa-book me-1"></i>API Docs
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<div class="hero-section bg-light py-5">
|
||||
<div class="container">
|
||||
<div class="row align-items-center">
|
||||
<div class="col-lg-6">
|
||||
<h1 class="display-4 fw-bold mb-3">UnitForge</h1>
|
||||
<p class="lead mb-4">
|
||||
Create, validate, and manage systemd unit files with ease.
|
||||
Whether you're deploying web services, scheduling tasks, or managing containers,
|
||||
UnitForge provides the tools you need.
|
||||
</p>
|
||||
<div class="d-flex gap-3">
|
||||
<a href="/editor" class="btn btn-primary btn-lg">
|
||||
<i class="fas fa-edit me-2"></i>Start Creating
|
||||
</a>
|
||||
<a href="/templates" class="btn btn-outline-primary btn-lg">
|
||||
<i class="fas fa-templates me-2"></i>Browse Templates
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-lg-6">
|
||||
<div class="code-preview bg-dark text-light p-4 rounded">
|
||||
<div class="d-flex align-items-center mb-3">
|
||||
<i class="fas fa-file-code me-2"></i>
|
||||
<span class="fw-bold">myapp.service</span>
|
||||
</div>
|
||||
<pre class="mb-0"><code>[Unit]
|
||||
Description=My Web Application
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
ExecStart=/usr/bin/node /opt/myapp/server.js
|
||||
User=myapp
|
||||
Group=myapp
|
||||
Restart=on-failure
|
||||
WorkingDirectory=/opt/myapp
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="container my-5">
|
||||
<div class="row">
|
||||
<div class="col-lg-8 mx-auto text-center mb-5">
|
||||
<h2 class="h1 mb-3">Choose Your Approach</h2>
|
||||
<p class="lead text-muted">
|
||||
UnitForge offers multiple ways to create systemd unit files,
|
||||
from quick templates to detailed manual editing.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="row g-4 mb-5">
|
||||
<div class="col-md-6 col-lg-3">
|
||||
<div class="card h-100 border-0 shadow-sm hover-lift">
|
||||
<div class="card-body text-center">
|
||||
<div class="feature-icon bg-primary bg-gradient rounded-circle mx-auto mb-3">
|
||||
<i class="fas fa-magic text-white"></i>
|
||||
</div>
|
||||
<h5 class="card-title">Quick Templates</h5>
|
||||
<p class="card-text text-muted">
|
||||
Use pre-built templates for common services like web apps, databases, and containers.
|
||||
</p>
|
||||
<a href="/templates" class="btn btn-outline-primary">
|
||||
Browse Templates
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="col-md-6 col-lg-3">
|
||||
<div class="card h-100 border-0 shadow-sm hover-lift">
|
||||
<div class="card-body text-center">
|
||||
<div class="feature-icon bg-success bg-gradient rounded-circle mx-auto mb-3">
|
||||
<i class="fas fa-edit text-white"></i>
|
||||
</div>
|
||||
<h5 class="card-title">Visual Editor</h5>
|
||||
<p class="card-text text-muted">
|
||||
Create and edit unit files with our intuitive form-based editor with real-time validation.
|
||||
</p>
|
||||
<a href="/editor" class="btn btn-outline-success">
|
||||
Open Editor
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="col-md-6 col-lg-3">
|
||||
<div class="card h-100 border-0 shadow-sm hover-lift">
|
||||
<div class="card-body text-center">
|
||||
<div class="feature-icon bg-warning bg-gradient rounded-circle mx-auto mb-3">
|
||||
<i class="fas fa-check-circle text-white"></i>
|
||||
</div>
|
||||
<h5 class="card-title">Validation</h5>
|
||||
<p class="card-text text-muted">
|
||||
Validate existing unit files and get detailed feedback on syntax and best practices.
|
||||
</p>
|
||||
<button class="btn btn-outline-warning" onclick="showUploadModal()">
|
||||
Validate File
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="col-md-6 col-lg-3">
|
||||
<div class="card h-100 border-0 shadow-sm hover-lift">
|
||||
<div class="card-body text-center">
|
||||
<div class="feature-icon bg-info bg-gradient rounded-circle mx-auto mb-3">
|
||||
<i class="fas fa-terminal text-white"></i>
|
||||
</div>
|
||||
<h5 class="card-title">CLI Tool</h5>
|
||||
<p class="card-text text-muted">
|
||||
Use the command-line interface for automation and integration with your development workflow.
|
||||
</p>
|
||||
<button class="btn btn-outline-info" onclick="showCliModal()">
|
||||
View CLI
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="row">
|
||||
<div class="col-lg-8 mx-auto">
|
||||
<div class="text-center mb-4">
|
||||
<h3></h3>Supported Unit Types</h3>
|
||||
<p class="text-muted">UnitForge supports all major systemd unit types</p>
|
||||
</div>
|
||||
|
||||
<div class="row g-3">
|
||||
<div class="col-6 col-md-4">
|
||||
<div class="unit-type-badge">
|
||||
<i class="fas fa-play-circle me-2"></i>Service
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-6 col-md-4">
|
||||
<div class="unit-type-badge">
|
||||
<i class="fas fa-clock me-2"></i>Timer
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-6 col-md-4">
|
||||
<div class="unit-type-badge">
|
||||
<i class="fas fa-plug me-2"></i>Socket
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-6 col-md-4">
|
||||
<div class="unit-type-badge">
|
||||
<i class="fas fa-hdd me-2"></i>Mount
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-6 col-md-4">
|
||||
<div class="unit-type-badge">
|
||||
<i class="fas fa-bullseye me-2"></i>Target
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-6 col-md-4">
|
||||
<div class="unit-type-badge">
|
||||
<i class="fas fa-folder me-2"></i>Path
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Upload Modal -->
|
||||
<div class="modal fade" id="uploadModal" tabindex="-1">
|
||||
<div class="modal-dialog modal-lg">
|
||||
<div class="modal-content">
|
||||
<div class="modal-header">
|
||||
<h5 class="modal-title">
|
||||
<i class="fas fa-upload me-2"></i>Validate Unit File
|
||||
</h5>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="modal"></button>
|
||||
</div>
|
||||
<div class="modal-body">
|
||||
<div class="mb-3">
|
||||
<label for="fileInput" class="form-label">Select unit file to validate:</label>
|
||||
<input type="file" class="form-control" id="fileInput" accept=".service,.timer,.socket,.mount,.target,.path">
|
||||
</div>
|
||||
<div id="uploadResults" class="d-none">
|
||||
<h6>Validation Results:</h6>
|
||||
<div id="validationOutput"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="modal-footer">
|
||||
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
|
||||
<button type="button" class="btn btn-primary" onclick="validateFile()">
|
||||
<i class="fas fa-check me-2"></i>Validate
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- CLI Modal -->
|
||||
<div class="modal fade" id="cliModal" tabindex="-1">
|
||||
<div class="modal-dialog modal-lg">
|
||||
<div class="modal-content">
|
||||
<div class="modal-header">
|
||||
<h5 class="modal-title">
|
||||
<i class="fas fa-terminal me-2"></i>CLI Usage
|
||||
</h5>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="modal"></button>
|
||||
</div>
|
||||
<div class="modal-body">
|
||||
<h6>Installation:</h6>
|
||||
<pre class="bg-dark text-light p-3 rounded"><code>pip install -e .</code></pre>
|
||||
|
||||
<h6 class="mt-4">Common Commands:</h6>
|
||||
<pre class="bg-dark text-light p-3 rounded"><code># Create a new service
|
||||
unitforge create --type service --name myapp --exec-start "/usr/bin/myapp"
|
||||
|
||||
# Validate a unit file
|
||||
unitforge validate /etc/systemd/system/myapp.service
|
||||
|
||||
# Generate from template
|
||||
unitforge template generate webapp --interactive
|
||||
|
||||
# List available templates
|
||||
unitforge template list</code></pre>
|
||||
|
||||
<h6 class="mt-4">Template Usage:</h6>
|
||||
<pre class="bg-dark text-light p-3 rounded"><code># Generate web app service
|
||||
unitforge template generate webapp \
|
||||
--param name=mywebapp \
|
||||
--param exec_start="/usr/bin/node server.js" \
|
||||
--param user=www-data \
|
||||
--param working_directory=/opt/mywebapp</code></pre>
|
||||
</div>
|
||||
<div class="modal-footer">
|
||||
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
|
||||
<a href="/api/docs" class="btn btn-primary" target="_blank">
|
||||
<i class="fas fa-book me-2"></i>Full Documentation
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer class="bg-dark text-light py-4 mt-5">
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<h6></h6><i class="fas fa-cogs me-2"></i>UnitForge</h6>
|
||||
<p class="text-muted small">
|
||||
A comprehensive tool for creating and managing systemd unit files.
|
||||
</p>
|
||||
</div>
|
||||
<div class="col-md-6 text-md-end">
|
||||
<div class="d-flex justify-content-md-end gap-3">
|
||||
<a href="/api/docs" class="text-light text-decoration-none">
|
||||
<i class="fas fa-book me-1"></i>API Docs
|
||||
</a>
|
||||
<a href="https://github.com/unitforge/unitforge" class="text-light text-decoration-none">
|
||||
<i class="fab fa-github me-1"></i>GitHub
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
|
||||
<script src="/static/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,237 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Templates - UnitForge</title>
|
||||
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet">
|
||||
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css" rel="stylesheet">
|
||||
<link href="/static/css/style.css" rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<nav class="navbar navbar-expand-lg navbar-dark bg-primary">
|
||||
<div class="container">
|
||||
<a class="navbar-brand" href="/">
|
||||
<i class="fas fa-cogs me-2"></i>UnitForge
|
||||
</a>
|
||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav">
|
||||
<span class="navbar-toggler-icon"></span>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navbarNav">
|
||||
<ul class="navbar-nav me-auto">
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" href="/">Home</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" href="/editor">Editor</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a class="nav-link active" href="/templates">Templates</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<div class="container py-4">
|
||||
<!-- Header -->
|
||||
<div class="row mb-4">
|
||||
<div class="col-lg-8">
|
||||
<h1 class="display-5 fw-bold mb-3">
|
||||
<i class="fas fa-templates me-3"></i>Unit File Templates
|
||||
</h1>
|
||||
<p class="lead text-muted">
|
||||
Choose from pre-built templates for common systemd unit configurations.
|
||||
Each template provides a solid foundation that you can customize for your specific needs.
|
||||
</p>
|
||||
</div>
|
||||
<div class="col-lg-4 text-lg-end">
|
||||
<div class="input-group">
|
||||
<input type="text" class="form-control" id="searchInput" placeholder="Search templates..." onkeyup="filterTemplates()">
|
||||
<button class="btn btn-outline-secondary" type="button" onclick="clearSearch()">
|
||||
<i class="fas fa-times"></i>
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Filter Tabs -->
|
||||
<div class="row mb-4">
|
||||
<div class="col">
|
||||
<ul class="nav nav-pills nav-fill" id="categoryTabs">
|
||||
<li class="nav-item">
|
||||
<button class="nav-link active" onclick="filterByCategory('all')" id="tab-all">
|
||||
All Templates <span class="badge bg-secondary ms-2" id="count-all">0</span>
|
||||
</button>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<button class="nav-link" onclick="filterByCategory('Web Services')" id="tab-web">
|
||||
Web Services <span class="badge bg-secondary ms-2" id="count-web">0</span>
|
||||
</button>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<button class="nav-link" onclick="filterByCategory('Database Services')" id="tab-database">
|
||||
Database <span class="badge bg-secondary ms-2" id="count-database">0</span>
|
||||
</button>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<button class="nav-link" onclick="filterByCategory('System Maintenance')" id="tab-maintenance">
|
||||
Maintenance <span class="badge bg-secondary ms-2" id="count-maintenance">0</span>
|
||||
</button>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<button class="nav-link" onclick="filterByCategory('Container Services')" id="tab-container">
|
||||
Containers <span class="badge bg-secondary ms-2" id="count-container">0</span>
|
||||
</button>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<button class="nav-link" onclick="filterByCategory('Network Services')" id="tab-network">
|
||||
Network <span class="badge bg-secondary ms-2" id="count-network">0</span>
|
||||
</button>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Loading State -->
|
||||
<div id="loadingState" class="text-center py-5">
|
||||
<div class="spinner-border text-primary" role="status">
|
||||
<span class="visually-hidden">Loading templates...</span>
|
||||
</div>
|
||||
<p class="mt-3 text-muted">Loading templates...</p>
|
||||
</div>
|
||||
|
||||
<!-- Templates Grid -->
|
||||
<div id="templatesGrid" class="row g-4 d-none">
|
||||
<!-- Templates will be populated here by JavaScript -->
|
||||
</div>
|
||||
|
||||
<!-- No Results -->
|
||||
<div id="noResults" class="text-center py-5 d-none">
|
||||
<i class="fas fa-search fa-3x text-muted mb-3"></i>
|
||||
<h4>No templates found</h4>
|
||||
<p class="text-muted">Try adjusting your search criteria or browse all templates.</p>
|
||||
<button class="btn btn-primary" onclick="clearSearch()">Show All Templates</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Template Detail Modal -->
|
||||
<div class="modal fade" id="templateModal" tabindex="-1">
|
||||
<div class="modal-dialog modal-xl">
|
||||
<div class="modal-content">
|
||||
<div class="modal-header">
|
||||
<h5 class="modal-title" id="templateModalTitle">
|
||||
<i class="fas fa-file-code me-2"></i>Template Details
|
||||
</h5>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="modal"></button>
|
||||
</div>
|
||||
<div class="modal-body">
|
||||
<div class="row">
|
||||
<!-- Template Info -->
|
||||
<div class="col-lg-6">
|
||||
<div class="mb-4">
|
||||
<h6 class="text-muted mb-3">Template Information</h6>
|
||||
<div id="templateInfo">
|
||||
<!-- Template info will be populated here -->
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Parameters Form -->
|
||||
<div class="mb-4">
|
||||
<h6 class="text-muted mb-3">Configuration Parameters</h6>
|
||||
<form id="templateForm">
|
||||
<div id="templateParameters">
|
||||
<!-- Parameters will be populated here -->
|
||||
</div>
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Preview -->
|
||||
<div class="col-lg-6">
|
||||
<div class="mb-4">
|
||||
<h6 class="text-muted mb-3">Preview</h6>
|
||||
<div class="card bg-dark text-light">
|
||||
<div class="card-header d-flex justify-content-between align-items-center">
|
||||
<span><i class="fas fa-file-code me-2"></i><span id="previewFilename">unit.service</span></span>
|
||||
<button class="btn btn-outline-light btn-sm" onclick="copyPreviewToClipboard()" title="Copy to clipboard">
|
||||
<i class="fas fa-copy"></i>
|
||||
</button>
|
||||
</div>
|
||||
<div class="card-body">
|
||||
<pre id="templatePreview" class="mb-0" style="font-size: 0.875rem; line-height: 1.4;"><code># Configure parameters to see preview</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Validation Results -->
|
||||
<div id="validationResults" class="d-none">
|
||||
<h6 class="text-muted mb-3">Validation</h6>
|
||||
<div id="validationOutput"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="modal-footer">
|
||||
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
|
||||
<button type="button" class="btn btn-success" onclick="validateTemplate()" id="validateBtn">
|
||||
<i class="fas fa-check me-2"></i>Validate
|
||||
</button>
|
||||
<button type="button" class="btn btn-primary" onclick="generateAndDownload()" id="generateBtn">
|
||||
<i class="fas fa-download me-2"></i>Generate & Download
|
||||
</button>
|
||||
<button type="button" class="btn btn-info" onclick="openInEditor()" id="editorBtn">
|
||||
<i class="fas fa-edit me-2"></i>Open in Editor
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Generate Status Modal -->
|
||||
<div class="modal fade" id="generateModal" tabindex="-1">
|
||||
<div class="modal-dialog">
|
||||
<div class="modal-content">
|
||||
<div class="modal-header">
|
||||
<h5 class="modal-title">
|
||||
<i class="fas fa-cog fa-spin me-2"></i>Generating Unit File
|
||||
</h5>
|
||||
</div>
|
||||
<div class="modal-body text-center">
|
||||
<div class="spinner-border text-primary mb-3" role="status">
|
||||
<span class="visually-hidden">Generating...</span>
|
||||
</div>
|
||||
<p class="mb-0">Please wait while we generate your unit file...</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer class="bg-dark text-light py-4 mt-5">
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<h6></h6><i class="fas fa-cogs me-2"></i>UnitForge</h6>
|
||||
<p class="text-muted small">
|
||||
A comprehensive tool for creating and managing systemd unit files.
|
||||
</p>
|
||||
</div>
|
||||
<div class="col-md-6 text-md-end">
|
||||
<div class="d-flex justify-content-md-end gap-3">
|
||||
<a href="/api/docs" class="text-light text-decoration-none">
|
||||
<i class="fas fa-book me-1"></i>API Docs
|
||||
</a>
|
||||
<a href="https://github.com/unitforge/unitforge" class="text-light text-decoration-none">
|
||||
<i class="fab fa-github me-1"></i>GitHub
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
|
||||
<script src="/static/js/main.js"></script>
|
||||
<script src="/static/js/templates.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
Executable
+283
@@ -0,0 +1,283 @@
|
||||
#!/bin/bash
|
||||
# UnitForge Migration Script: pip → uv
|
||||
# Migrates existing UnitForge installations from pip-based to uv-only workflow
|
||||
|
||||
set -e
|
||||
|
||||
# Load centralized color utility
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "${SCRIPT_DIR}/scripts/colors.sh"
|
||||
|
||||
echo -e "${BLUE}╔══════════════════════════════════════════════╗${NC}"
|
||||
echo -e "${BLUE}║ UnitForge Migration to uv v1.1 ║${NC}"
|
||||
echo -e "${BLUE}║ Upgrading from pip-based workflow ║${NC}"
|
||||
echo -e "${BLUE}╚══════════════════════════════════════════════╝${NC}"
|
||||
echo ""
|
||||
|
||||
# Function to check if command exists
|
||||
command_exists() {
|
||||
command -v "$1" >/dev/null 2>&1
|
||||
}
|
||||
|
||||
# Function to backup files
|
||||
backup_file() {
|
||||
local file="$1"
|
||||
if [[ -f "$file" ]]; then
|
||||
cp "$file" "${file}.backup.$(date +%Y%m%d_%H%M%S)"
|
||||
echo -e "${YELLOW} ✓ Backed up $file${NC}"
|
||||
fi
|
||||
}
|
||||
|
||||
echo -e "${CYAN}🔍 Analyzing current installation...${NC}"
|
||||
echo ""
|
||||
|
||||
# Check if we're in UnitForge directory
|
||||
if [[ ! -f "pyproject.toml" || ! -f "unitforge-cli" ]]; then
|
||||
echo -e "${RED}Error: Not in UnitForge project directory${NC}"
|
||||
echo "Please navigate to your UnitForge project root and try again."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo -e "${GREEN}✓ UnitForge project detected${NC}"
|
||||
|
||||
# Check current Python setup
|
||||
if [[ -d "venv" ]]; then
|
||||
echo -e "${YELLOW}⚠ Found old 'venv' directory${NC}"
|
||||
OLD_VENV="venv"
|
||||
elif [[ -d ".venv" ]]; then
|
||||
echo -e "${BLUE}ℹ Found '.venv' directory${NC}"
|
||||
OLD_VENV=".venv"
|
||||
else
|
||||
echo -e "${BLUE}ℹ No existing virtual environment found${NC}"
|
||||
OLD_VENV=""
|
||||
fi
|
||||
|
||||
# Check for pip-based installations
|
||||
PIP_INSTALLED=false
|
||||
if [[ -n "$OLD_VENV" && -f "$OLD_VENV/bin/activate" ]]; then
|
||||
echo -e "${BLUE}Checking existing environment...${NC}"
|
||||
|
||||
# Check if UnitForge is installed in pip mode
|
||||
if source "$OLD_VENV/bin/activate" 2>/dev/null && pip show unitforge >/dev/null 2>&1; then
|
||||
PIP_INSTALLED=true
|
||||
echo -e "${YELLOW}⚠ UnitForge is installed via pip${NC}"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${CYAN}📋 Migration Plan:${NC}"
|
||||
echo ""
|
||||
|
||||
if [[ -n "$OLD_VENV" ]]; then
|
||||
echo -e "${YELLOW}1. Backup existing virtual environment${NC}"
|
||||
fi
|
||||
echo -e "${YELLOW}2. Install uv package manager${NC}"
|
||||
echo -e "${YELLOW}3. Create new uv-based environment${NC}"
|
||||
echo -e "${YELLOW}4. Install dependencies with uv${NC}"
|
||||
echo -e "${YELLOW}5. Update development scripts${NC}"
|
||||
echo -e "${YELLOW}6. Verify functionality${NC}"
|
||||
echo -e "${YELLOW}7. Clean up old environment${NC}"
|
||||
|
||||
echo ""
|
||||
read -p "Proceed with migration? (y/N): " -n 1 -r
|
||||
echo
|
||||
if [[ ! $REPLY =~ ^[Yy]$ ]]; then
|
||||
echo "Migration cancelled."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${CYAN}🚀 Starting migration...${NC}"
|
||||
echo ""
|
||||
|
||||
# Step 1: Backup existing environment
|
||||
if [[ -n "$OLD_VENV" ]]; then
|
||||
echo -e "${BLUE}Step 1: Backing up existing environment...${NC}"
|
||||
|
||||
if [[ "$OLD_VENV" == "venv" ]]; then
|
||||
mv venv venv.backup.$(date +%Y%m%d_%H%M%S)
|
||||
echo -e "${GREEN}✓ Backed up old 'venv' directory${NC}"
|
||||
elif [[ "$OLD_VENV" == ".venv" ]]; then
|
||||
mv .venv .venv.backup.$(date +%Y%m%d_%H%M%S)
|
||||
echo -e "${GREEN}✓ Backed up old '.venv' directory${NC}"
|
||||
fi
|
||||
|
||||
# Save requirements if possible
|
||||
if [[ -f "backend/requirements.txt" ]]; then
|
||||
backup_file "backend/requirements.txt"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
fi
|
||||
|
||||
# Step 2: Install uv
|
||||
echo -e "${BLUE}Step 2: Installing uv package manager...${NC}"
|
||||
|
||||
if command_exists uv; then
|
||||
UV_VERSION=$(uv --version 2>/dev/null | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' || echo "unknown")
|
||||
echo -e "${GREEN}✓ uv ${UV_VERSION} already installed${NC}"
|
||||
else
|
||||
echo -e "${YELLOW}Installing uv...${NC}"
|
||||
|
||||
if command_exists curl; then
|
||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||
elif command_exists wget; then
|
||||
wget -qO- https://astral.sh/uv/install.sh | sh
|
||||
else
|
||||
echo -e "${RED}Error: Neither curl nor wget found${NC}"
|
||||
echo "Please install uv manually: https://github.com/astral-sh/uv#installation"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Add uv to PATH for current session
|
||||
export PATH="$HOME/.cargo/bin:$PATH"
|
||||
|
||||
if command_exists uv; then
|
||||
echo -e "${GREEN}✓ uv installed successfully${NC}"
|
||||
else
|
||||
echo -e "${RED}Error: uv installation failed${NC}"
|
||||
echo "Please install uv manually and restart this script"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
echo ""
|
||||
|
||||
# Step 3: Create new uv-based environment
|
||||
echo -e "${BLUE}Step 3: Creating new uv-based environment...${NC}"
|
||||
|
||||
uv venv .venv
|
||||
echo -e "${GREEN}✓ Created .venv with uv${NC}"
|
||||
|
||||
# Step 4: Install dependencies
|
||||
echo -e "${BLUE}Step 4: Installing dependencies with uv...${NC}"
|
||||
|
||||
source .venv/bin/activate
|
||||
uv pip install -e ".[dev,web]"
|
||||
success "All dependencies installed with uv"
|
||||
|
||||
echo ""
|
||||
|
||||
# Step 5: Update development scripts
|
||||
echo -e "${BLUE}Step 5: Updating development scripts...${NC}"
|
||||
|
||||
# Make sure all scripts are executable
|
||||
chmod +x unitforge-cli
|
||||
chmod +x start-server.sh
|
||||
chmod +x setup-dev.sh
|
||||
chmod +x demo.sh
|
||||
chmod +x check-uv.sh
|
||||
|
||||
echo -e "${GREEN}✓ Scripts updated and made executable${NC}"
|
||||
|
||||
echo ""
|
||||
|
||||
# Step 6: Verify functionality
|
||||
echo -e "${BLUE}Step 6: Verifying functionality...${NC}"
|
||||
|
||||
# Test CLI
|
||||
if ./unitforge-cli --help >/dev/null 2>&1; then
|
||||
echo -e "${GREEN}✓ CLI tool working${NC}"
|
||||
else
|
||||
echo -e "${RED}✗ CLI tool test failed${NC}"
|
||||
fi
|
||||
|
||||
# Test template listing
|
||||
if ./unitforge-cli template list >/dev/null 2>&1; then
|
||||
echo -e "${GREEN}✓ Template system working${NC}"
|
||||
else
|
||||
echo -e "${RED}✗ Template system test failed${NC}"
|
||||
fi
|
||||
|
||||
# Test unit file creation
|
||||
if ./unitforge-cli create --type service --name migration-test --exec-start "/bin/true" --output migration-test.service >/dev/null 2>&1; then
|
||||
echo -e "${GREEN}✓ Unit file creation working${NC}"
|
||||
rm -f migration-test.service
|
||||
else
|
||||
echo -e "${RED}✗ Unit file creation test failed${NC}"
|
||||
fi
|
||||
|
||||
# Test pytest
|
||||
if uv run pytest tests/ --tb=no -q >/dev/null 2>&1; then
|
||||
echo -e "${GREEN}✓ Test suite working${NC}"
|
||||
else
|
||||
echo -e "${YELLOW}⚠ Some tests failed (this may be expected)${NC}"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
|
||||
# Step 7: Clean up options
|
||||
echo -e "${BLUE}Step 7: Cleanup options...${NC}"
|
||||
echo ""
|
||||
|
||||
BACKUP_DIRS=$(find . -maxdepth 1 -name "*.backup.*" -type d 2>/dev/null || true)
|
||||
BACKUP_FILES=$(find . -maxdepth 2 -name "*.backup.*" -type f 2>/dev/null || true)
|
||||
|
||||
if [[ -n "$BACKUP_DIRS" || -n "$BACKUP_FILES" ]]; then
|
||||
echo -e "${YELLOW}Found backup files/directories:${NC}"
|
||||
[[ -n "$BACKUP_DIRS" ]] && echo "$BACKUP_DIRS"
|
||||
[[ -n "$BACKUP_FILES" ]] && echo "$BACKUP_FILES"
|
||||
echo ""
|
||||
|
||||
read -p "Remove backup files? (y/N): " -n 1 -r
|
||||
echo
|
||||
if [[ $REPLY =~ ^[Yy]$ ]]; then
|
||||
[[ -n "$BACKUP_DIRS" ]] && rm -rf $BACKUP_DIRS
|
||||
[[ -n "$BACKUP_FILES" ]] && rm -f $BACKUP_FILES
|
||||
echo -e "${GREEN}✓ Backup files removed${NC}"
|
||||
else
|
||||
echo -e "${BLUE}ℹ Backup files preserved${NC}"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${GREEN}🎉 Migration to uv completed successfully!${NC}"
|
||||
echo ""
|
||||
|
||||
# Show new workflow
|
||||
echo -e "${CYAN}📋 New uv-based workflow:${NC}"
|
||||
echo ""
|
||||
echo -e "${BLUE}Development commands:${NC}"
|
||||
echo -e " ${CYAN}make setup-dev # Complete development setup${NC}"
|
||||
echo -e " ${CYAN}make server # Start development server${NC}"
|
||||
echo -e " ${CYAN}make test # Run test suite${NC}"
|
||||
echo -e " ${CYAN}make test-cov # Tests with coverage${NC}"
|
||||
echo -e " ${CYAN}make lint # Code quality checks${NC}"
|
||||
echo -e " ${CYAN}make format # Auto-format code${NC}"
|
||||
echo -e " ${CYAN}make docker-dev # Docker development${NC}"
|
||||
echo -e " ${CYAN}make clean # Clean cache files${NC}"
|
||||
echo ""
|
||||
|
||||
echo -e "${BLUE}Package management:${NC}"
|
||||
echo -e " ${CYAN}uv pip install <pkg> # Install package${NC}"
|
||||
echo -e " ${CYAN}uv pip list # List packages${NC}"
|
||||
echo -e " ${CYAN}uv pip show <pkg> # Show package info${NC}"
|
||||
echo -e " ${CYAN}uv venv # Create environment${NC}"
|
||||
echo ""
|
||||
|
||||
echo -e "${BLUE}Key improvements:${NC}"
|
||||
echo -e " ${GREEN}⚡ 10-100x faster installs${NC}"
|
||||
echo -e " ${GREEN}🔒 Better dependency resolution${NC}"
|
||||
echo -e " ${GREEN}🎯 Modern Python standards${NC}"
|
||||
echo -e " ${GREEN}🛠 Integrated development tools${NC}"
|
||||
echo -e " ${GREEN}🐳 Optimized Docker workflows${NC}"
|
||||
echo ""
|
||||
|
||||
echo -e "${CYAN}Next steps:${NC}"
|
||||
echo -e " ${YELLOW}1. Test your workflow: make test${NC}"
|
||||
echo -e " ${YELLOW}2. Start development: make server${NC}"
|
||||
echo -e " ${YELLOW}3. Check system status: ./check-uv.sh${NC}"
|
||||
echo -e " ${YELLOW}4. Read updated README.md${NC}"
|
||||
echo ""
|
||||
|
||||
echo -e "${BLUE}Environment Information:${NC}"
|
||||
if command_exists uv; then
|
||||
UV_VERSION=$(uv --version 2>/dev/null | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' || echo "unknown")
|
||||
echo -e " ${CYAN}uv version: ${UV_VERSION}${NC}"
|
||||
fi
|
||||
echo -e " ${CYAN}Python version: $(python3 --version | cut -d' ' -f2)${NC}"
|
||||
echo -e " ${CYAN}Virtual environment: .venv${NC}"
|
||||
echo -e " ${CYAN}Package manager: uv (no pip fallback)${NC}"
|
||||
echo ""
|
||||
|
||||
echo -e "${GREEN}Welcome to the future of Python development! 🚀${NC}"
|
||||
+184
@@ -0,0 +1,184 @@
|
||||
[build-system]
|
||||
requires = ["hatchling"]
|
||||
build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "unitforge"
|
||||
version = "1.0.0"
|
||||
description = "Create, validate, and manage systemd unit files"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.8.1"
|
||||
license = {text = "MIT"}
|
||||
authors = [
|
||||
{name = "UnitForge Team", email = "contact@unitforge.dev"},
|
||||
]
|
||||
keywords = ["systemd", "unit", "service", "linux", "administration", "devops"]
|
||||
classifiers = [
|
||||
"Development Status :: 4 - Beta",
|
||||
"Intended Audience :: System Administrators",
|
||||
"Intended Audience :: Developers",
|
||||
"License :: OSI Approved :: MIT License",
|
||||
"Operating System :: POSIX :: Linux",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.8",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Topic :: System :: Systems Administration",
|
||||
"Topic :: Software Development :: Code Generators",
|
||||
"Topic :: Utilities",
|
||||
]
|
||||
dependencies = [
|
||||
"fastapi>=0.68.0,<1.0.0",
|
||||
"uvicorn[standard]>=0.15.0,<1.0.0",
|
||||
"click>=8.0.0,<9.0.0",
|
||||
"pydantic>=1.8.0,<2.0.0",
|
||||
"jinja2>=3.0.0,<4.0.0",
|
||||
"python-multipart>=0.0.5",
|
||||
"pyyaml>=5.4.0",
|
||||
"validators>=0.18.0",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = [
|
||||
"pytest>=6.0.0",
|
||||
"pytest-asyncio>=0.18.0",
|
||||
"pytest-cov>=4.0.0",
|
||||
"httpx>=0.23.0",
|
||||
"black>=23.0.0",
|
||||
"isort>=5.12.0",
|
||||
"flake8>=7.0.0",
|
||||
"mypy>=1.5.0",
|
||||
"pre-commit>=3.0.0",
|
||||
"bandit>=1.7.0",
|
||||
"pip-audit>=2.6.0",
|
||||
]
|
||||
web = [
|
||||
"uvicorn[standard]>=0.15.0,<1.0.0",
|
||||
"python-multipart>=0.0.5",
|
||||
]
|
||||
|
||||
[project.scripts]
|
||||
unitforge = "backend.cli:cli"
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://github.com/unitforge/unitforge"
|
||||
Documentation = "https://unitforge.readthedocs.io/"
|
||||
Repository = "https://github.com/unitforge/unitforge"
|
||||
"Bug Reports" = "https://github.com/unitforge/unitforge/issues"
|
||||
|
||||
[tool.hatch.build]
|
||||
include = [
|
||||
"backend/",
|
||||
"frontend/",
|
||||
"README.md",
|
||||
"LICENSE",
|
||||
]
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["backend"]
|
||||
exclude = [
|
||||
"backend/requirements.txt", # Handled by pyproject.toml
|
||||
]
|
||||
|
||||
[tool.black]
|
||||
line-length = 88
|
||||
target-version = ['py38']
|
||||
include = '\.pyi?$'
|
||||
extend-exclude = '''
|
||||
/(
|
||||
# directories
|
||||
\.eggs
|
||||
| \.git
|
||||
| \.hg
|
||||
| \.mypy_cache
|
||||
| \.tox
|
||||
| \.venv
|
||||
| venv
|
||||
| _build
|
||||
| buck-out
|
||||
| build
|
||||
| dist
|
||||
)/
|
||||
'''
|
||||
|
||||
[tool.isort]
|
||||
profile = "black"
|
||||
multi_line_output = 3
|
||||
line_length = 88
|
||||
known_first_party = ["backend", "app", "cli"]
|
||||
|
||||
[tool.pytest.ini_options]
|
||||
minversion = "6.0"
|
||||
addopts = "-ra -q --strict-markers --strict-config"
|
||||
testpaths = ["tests"]
|
||||
python_files = ["test_*.py", "*_test.py"]
|
||||
python_classes = ["Test*"]
|
||||
python_functions = ["test_*"]
|
||||
markers = [
|
||||
"unit: Unit tests",
|
||||
"integration: Integration tests",
|
||||
"slow: Slow running tests",
|
||||
]
|
||||
|
||||
[tool.coverage.run]
|
||||
source = ["backend"]
|
||||
omit = [
|
||||
"*/tests/*",
|
||||
"*/venv/*",
|
||||
"*/__pycache__/*",
|
||||
]
|
||||
|
||||
[tool.coverage.report]
|
||||
exclude_lines = [
|
||||
"pragma: no cover",
|
||||
"def __repr__",
|
||||
"if self.debug:",
|
||||
"if settings.DEBUG",
|
||||
"raise AssertionError",
|
||||
"raise NotImplementedError",
|
||||
"if 0:",
|
||||
"if __name__ == .__main__.:",
|
||||
"class .*\\bProtocol\\):",
|
||||
"@(abc\\.)?abstractmethod",
|
||||
]
|
||||
|
||||
[tool.mypy]
|
||||
python_version = "3.9"
|
||||
warn_return_any = true
|
||||
warn_unused_configs = true
|
||||
disallow_untyped_defs = true
|
||||
disallow_incomplete_defs = true
|
||||
check_untyped_defs = true
|
||||
disallow_untyped_decorators = true
|
||||
no_implicit_optional = true
|
||||
warn_redundant_casts = true
|
||||
warn_unused_ignores = true
|
||||
warn_no_return = true
|
||||
warn_unreachable = true
|
||||
strict_equality = true
|
||||
|
||||
[[tool.mypy.overrides]]
|
||||
module = [
|
||||
"uvicorn.*",
|
||||
"validators.*",
|
||||
"yaml.*",
|
||||
"fastapi.*",
|
||||
"pydantic.*",
|
||||
"jinja2.*",
|
||||
"click.*",
|
||||
]
|
||||
ignore_missing_imports = true
|
||||
|
||||
[tool.flake8]
|
||||
max-line-length = 88
|
||||
extend-ignore = ["E203", "W503"]
|
||||
exclude = [
|
||||
".git",
|
||||
"__pycache__",
|
||||
"build",
|
||||
"dist",
|
||||
".venv",
|
||||
"venv",
|
||||
]
|
||||
@@ -0,0 +1,496 @@
|
||||
# UnitForge Scripts & Utilities
|
||||
|
||||
This directory contains utility scripts and libraries for the UnitForge project, including centralized color handling for consistent terminal output across all scripts.
|
||||
|
||||
## 📁 Files Overview
|
||||
|
||||
| File | Purpose | Language |
|
||||
|------|---------|----------|
|
||||
| `colors.sh` | Bash color utility library | Bash |
|
||||
| `colors.py` | Python color utility module | Python |
|
||||
| `colors.mk` | Makefile color definitions | Make |
|
||||
| `test-colors.sh` | Color utility test script | Bash |
|
||||
| `README.md` | This documentation | Markdown |
|
||||
|
||||
## 🎨 Color Utilities
|
||||
|
||||
### Why Centralized Colors?
|
||||
|
||||
Before this refactor, UnitForge had hardcoded ANSI escape codes scattered across multiple shell scripts like:
|
||||
|
||||
```bash
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
NC='\033[0m'
|
||||
```
|
||||
|
||||
This approach had several problems:
|
||||
- ❌ **Duplication**: Same color codes repeated in multiple files
|
||||
- ❌ **Inconsistency**: Different scripts used different color palettes
|
||||
- ❌ **Maintenance**: Changes required updating multiple files
|
||||
- ❌ **No fallback**: No graceful degradation for non-color terminals
|
||||
|
||||
The centralized approach solves these issues:
|
||||
- ✅ **DRY Principle**: Single source of truth for all colors
|
||||
- ✅ **Consistency**: Uniform color palette across the project
|
||||
- ✅ **Maintainability**: Update colors in one place
|
||||
- ✅ **Smart Detection**: Automatic color support detection
|
||||
- ✅ **Graceful Degradation**: Works in any terminal environment
|
||||
|
||||
## 🐚 Bash Color Utility (`colors.sh`)
|
||||
|
||||
### Basic Usage
|
||||
|
||||
Source the utility in your shell scripts:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# Load centralized color utility
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "${SCRIPT_DIR}/scripts/colors.sh"
|
||||
|
||||
# Use color functions
|
||||
info "Starting process..."
|
||||
success "Operation completed!"
|
||||
warning "Check configuration"
|
||||
error "Something went wrong"
|
||||
```
|
||||
|
||||
### Available Colors
|
||||
|
||||
#### Basic Colors
|
||||
```bash
|
||||
red "Red text"
|
||||
green "Green text"
|
||||
yellow "Yellow text"
|
||||
blue "Blue text"
|
||||
purple "Purple text"
|
||||
cyan "Cyan text"
|
||||
white "White text"
|
||||
gray "Gray text"
|
||||
```
|
||||
|
||||
#### Bright Colors
|
||||
```bash
|
||||
bright_red "Bright red text"
|
||||
bright_green "Bright green text"
|
||||
bright_blue "Bright blue text"
|
||||
# ... etc
|
||||
```
|
||||
|
||||
#### Status Messages
|
||||
```bash
|
||||
info "Information message" # ℹ Blue
|
||||
success "Success message" # ✓ Green
|
||||
warning "Warning message" # ⚠ Yellow
|
||||
error "Error message" # ✗ Red
|
||||
debug "Debug message" # 🐛 Gray (only if DEBUG=1)
|
||||
```
|
||||
|
||||
#### Headers and Structure
|
||||
```bash
|
||||
header "Main Section" # Bold blue with underline
|
||||
subheader "Subsection" # Bold with dash underline
|
||||
box_header "Title" 50 # Fancy box with title
|
||||
box_message "Message" "$GREEN" 40 # Colored message box
|
||||
```
|
||||
|
||||
#### Progress and Status
|
||||
```bash
|
||||
step 3 10 "Processing files" # [3/10] Processing files
|
||||
status "ok" "File processed" # [ OK ] File processed
|
||||
status "fail" "Connection failed" # [ FAIL ] Connection failed
|
||||
status "warn" "Deprecated feature" # [ WARN ] Deprecated feature
|
||||
status "info" "Available updates" # [ INFO ] Available updates
|
||||
status "skip" "Already exists" # [ SKIP ] Already exists
|
||||
```
|
||||
|
||||
### Advanced Features
|
||||
|
||||
#### Color Detection
|
||||
```bash
|
||||
if supports_color; then
|
||||
echo "Terminal supports colors"
|
||||
else
|
||||
echo "Colors disabled"
|
||||
fi
|
||||
```
|
||||
|
||||
#### Environment Variables
|
||||
- `NO_COLOR=1`: Disable all colors
|
||||
- `DEBUG=1`: Show debug messages
|
||||
- `TERM=dumb`: Automatically disables colors
|
||||
|
||||
#### Progress Indicators
|
||||
```bash
|
||||
# Spinner (use with background processes)
|
||||
long_running_command &
|
||||
spinner
|
||||
|
||||
# Progress bar
|
||||
for i in {1..10}; do
|
||||
progress_bar $i 10 40
|
||||
sleep 0.5
|
||||
done
|
||||
```
|
||||
|
||||
## 🐍 Python Color Utility (`colors.py`)
|
||||
|
||||
### Basic Usage
|
||||
|
||||
Import and use the color functions:
|
||||
|
||||
```python
|
||||
#!/usr/bin/env python3
|
||||
import sys
|
||||
import os
|
||||
|
||||
# Add scripts directory to path
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'scripts'))
|
||||
from colors import info, success, warning, error, header
|
||||
|
||||
# Use color functions
|
||||
info("Starting process...")
|
||||
success("Operation completed!")
|
||||
warning("Check configuration")
|
||||
error("Something went wrong")
|
||||
```
|
||||
|
||||
### Available Functions
|
||||
|
||||
#### Text Coloring
|
||||
```python
|
||||
from colors import red, green, blue, yellow
|
||||
|
||||
print(red("Error text"))
|
||||
print(green("Success text"))
|
||||
print(blue("Info text"))
|
||||
print(yellow("Warning text"))
|
||||
```
|
||||
|
||||
#### Status Messages
|
||||
```python
|
||||
from colors import info, success, warning, error, debug
|
||||
|
||||
info("Process starting...") # ℹ Blue
|
||||
success("Task completed!") # ✓ Green
|
||||
warning("Configuration missing") # ⚠ Yellow
|
||||
error("Connection failed") # ✗ Red
|
||||
debug("Variable state: active") # 🐛 Gray (if DEBUG env var set)
|
||||
```
|
||||
|
||||
#### Headers and Structure
|
||||
```python
|
||||
from colors import header, subheader, box_header, box_message, c
|
||||
|
||||
header("Main Processing Phase")
|
||||
subheader("File Operations")
|
||||
box_header("UnitForge Setup", width=50)
|
||||
box_message("Success!", c.GREEN, width=40)
|
||||
```
|
||||
|
||||
#### Progress and Steps
|
||||
```python
|
||||
from colors import step, status, progress_bar
|
||||
|
||||
step(1, 5, "Initializing...")
|
||||
step(2, 5, "Loading configuration...")
|
||||
|
||||
status("ok", "File loaded successfully")
|
||||
status("fail", "Network connection failed")
|
||||
status("warn", "Using default settings")
|
||||
|
||||
# Progress bar
|
||||
for i in range(11):
|
||||
progress_bar(i, 10, width=40)
|
||||
time.sleep(0.1)
|
||||
```
|
||||
|
||||
#### Advanced Usage
|
||||
```python
|
||||
from colors import ColorizedFormatter, c, supports_color
|
||||
|
||||
# Context manager for colored blocks
|
||||
with ColorizedFormatter(c.GREEN):
|
||||
print("This entire block is green")
|
||||
print("Including multiple lines")
|
||||
|
||||
# Manual color codes (discouraged - use functions instead)
|
||||
if supports_color():
|
||||
print(f"{c.BOLD}Bold text{c.NC}")
|
||||
```
|
||||
|
||||
## 🔧 Makefile Colors (`colors.mk`)
|
||||
|
||||
### Usage in Makefiles
|
||||
|
||||
Include the color definitions:
|
||||
|
||||
```make
|
||||
# Include centralized colors
|
||||
include scripts/colors.mk
|
||||
|
||||
target:
|
||||
$(call info,Starting build process...)
|
||||
@echo -e "$(GREEN)Building project...$(NC)"
|
||||
$(call success,Build completed!)
|
||||
```
|
||||
|
||||
### Available Functions
|
||||
|
||||
```make
|
||||
$(call info,Information message)
|
||||
$(call success,Success message)
|
||||
$(call warning,Warning message)
|
||||
$(call error,Error message)
|
||||
$(call header,Section Title)
|
||||
$(call subheader,Subsection)
|
||||
$(call box_header,Fancy Title)
|
||||
$(call step,3/10,Current step)
|
||||
$(call status,ok,Operation status)
|
||||
```
|
||||
|
||||
### Color Variables
|
||||
|
||||
```make
|
||||
# Use color variables directly
|
||||
@echo -e "$(BLUE)Processing...$(NC)"
|
||||
@echo -e "$(GREEN)✓ Complete$(NC)"
|
||||
@echo -e "$(YELLOW)⚠ Warning$(NC)"
|
||||
@echo -e "$(RED)✗ Failed$(NC)"
|
||||
```
|
||||
|
||||
## 🧪 Testing
|
||||
|
||||
Run the color utility test:
|
||||
|
||||
```bash
|
||||
# Test all color functions
|
||||
./scripts/test-colors.sh
|
||||
|
||||
# Test Python module
|
||||
python scripts/colors.py
|
||||
|
||||
# Test color detection
|
||||
NO_COLOR=1 ./scripts/test-colors.sh # Should show no colors
|
||||
DEBUG=1 ./scripts/test-colors.sh # Should show debug messages
|
||||
```
|
||||
|
||||
## 🎯 Migration Guide
|
||||
|
||||
### From Hardcoded Colors
|
||||
|
||||
**Before:**
|
||||
```bash
|
||||
#!/bin/bash
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
NC='\033[0m'
|
||||
|
||||
echo -e "${GREEN}✓ Success${NC}"
|
||||
echo -e "${RED}✗ Error${NC}"
|
||||
```
|
||||
|
||||
**After:**
|
||||
```bash
|
||||
#!/bin/bash
|
||||
source "$(dirname "$0")/scripts/colors.sh"
|
||||
|
||||
success "Success"
|
||||
error "Error"
|
||||
```
|
||||
|
||||
### From Individual Color Functions
|
||||
|
||||
**Before:**
|
||||
```bash
|
||||
echo_green() { echo -e "\033[0;32m$1\033[0m"; }
|
||||
echo_red() { echo -e "\033[0;31m$1\033[0m"; }
|
||||
```
|
||||
|
||||
**After:**
|
||||
```bash
|
||||
source "$(dirname "$0")/scripts/colors.sh"
|
||||
# Use built-in green() and red() functions
|
||||
```
|
||||
|
||||
## 🛠️ Development Guidelines
|
||||
|
||||
### Adding New Colors
|
||||
|
||||
1. **Add to color definitions** in all three files:
|
||||
- `colors.sh`: Bash export variables
|
||||
- `colors.py`: Python class attributes
|
||||
- `colors.mk`: Makefile variables
|
||||
|
||||
2. **Add convenience functions** if needed:
|
||||
```bash
|
||||
# colors.sh
|
||||
orange() { color_echo "$ORANGE" "$@"; }
|
||||
```
|
||||
|
||||
3. **Test thoroughly** with different terminal types:
|
||||
```bash
|
||||
TERM=dumb ./test-colors.sh
|
||||
NO_COLOR=1 ./test-colors.sh
|
||||
```
|
||||
|
||||
### Best Practices
|
||||
|
||||
1. **Always use functions over raw codes**:
|
||||
```bash
|
||||
# Good
|
||||
success "Operation completed"
|
||||
|
||||
# Avoid
|
||||
echo -e "${GREEN}✓ Operation completed${NC}"
|
||||
```
|
||||
|
||||
2. **Test color support**:
|
||||
```bash
|
||||
if supports_color; then
|
||||
# Use colors
|
||||
else
|
||||
# Plain text fallback
|
||||
fi
|
||||
```
|
||||
|
||||
3. **Provide meaningful status messages**:
|
||||
```bash
|
||||
# Good
|
||||
status "ok" "Dependencies installed successfully"
|
||||
|
||||
# Too generic
|
||||
status "ok" "Done"
|
||||
```
|
||||
|
||||
4. **Use appropriate status types**:
|
||||
- `info`: General information
|
||||
- `success`/`ok`: Successful operations
|
||||
- `warning`/`warn`: Potential issues
|
||||
- `error`/`fail`: Critical failures
|
||||
- `skip`: Skipped operations
|
||||
|
||||
## 🔗 Integration Examples
|
||||
|
||||
### Shell Script Template
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
# Load color utility
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "${SCRIPT_DIR}/scripts/colors.sh"
|
||||
|
||||
# Script header
|
||||
box_header "My UnitForge Script"
|
||||
|
||||
# Main process with status updates
|
||||
header "Processing Phase"
|
||||
|
||||
step 1 3 "Initializing..."
|
||||
if initialize_system; then
|
||||
success "System initialized"
|
||||
else
|
||||
error "Initialization failed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
step 2 3 "Running tasks..."
|
||||
info "Processing files..."
|
||||
# ... task logic ...
|
||||
success "Tasks completed"
|
||||
|
||||
step 3 3 "Cleanup..."
|
||||
warning "Temporary files will be removed"
|
||||
cleanup_temp_files
|
||||
success "Cleanup complete"
|
||||
|
||||
# Summary
|
||||
echo
|
||||
box_message "Script completed successfully!" "$GREEN"
|
||||
```
|
||||
|
||||
### Python Script Template
|
||||
|
||||
```python
|
||||
#!/usr/bin/env python3
|
||||
"""UnitForge Python script with color support."""
|
||||
|
||||
import sys
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
# Add scripts to path
|
||||
script_dir = Path(__file__).parent.parent / "scripts"
|
||||
sys.path.insert(0, str(script_dir))
|
||||
|
||||
from colors import header, info, success, warning, error, step, box_header
|
||||
|
||||
def main():
|
||||
"""Main script function."""
|
||||
box_header("My UnitForge Python Script")
|
||||
|
||||
header("Processing Phase")
|
||||
|
||||
step(1, 3, "Initializing...")
|
||||
try:
|
||||
# ... initialization logic ...
|
||||
success("System initialized")
|
||||
except Exception as e:
|
||||
error(f"Initialization failed: {e}")
|
||||
sys.exit(1)
|
||||
|
||||
step(2, 3, "Running tasks...")
|
||||
info("Processing data...")
|
||||
# ... task logic ...
|
||||
success("Tasks completed")
|
||||
|
||||
step(3, 3, "Finalizing...")
|
||||
warning("Saving results...")
|
||||
# ... save logic ...
|
||||
success("Results saved")
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
```
|
||||
|
||||
## 📊 Color Reference
|
||||
|
||||
### Standard Palette
|
||||
|
||||
| Color | Bash Function | Python Function | Use Case |
|
||||
|-------|---------------|-----------------|----------|
|
||||
| 🔴 Red | `red()` | `red()` | Errors, failures |
|
||||
| 🟢 Green | `green()` | `green()` | Success, completion |
|
||||
| 🟡 Yellow | `yellow()` | `yellow()` | Warnings, cautions |
|
||||
| 🔵 Blue | `blue()` | `blue()` | Information, headers |
|
||||
| 🟣 Purple | `purple()` | `purple()` | Special operations |
|
||||
| 🔵 Cyan | `cyan()` | `cyan()` | Steps, progress |
|
||||
| ⚪ White | `white()` | `white()` | Emphasis |
|
||||
| ⚫ Gray | `gray()` | `gray()` | Debug, minor info |
|
||||
|
||||
### Status Indicators
|
||||
|
||||
| Status | Symbol | Color | Usage |
|
||||
|--------|--------|-------|-------|
|
||||
| `ok`/`success` | ✓ | Green | Successful operations |
|
||||
| `fail`/`error` | ✗ | Red | Failed operations |
|
||||
| `warn`/`warning` | ⚠ | Yellow | Warnings, issues |
|
||||
| `info` | ℹ | Blue | Information |
|
||||
| `skip` | • | Gray | Skipped operations |
|
||||
|
||||
## 🚀 Future Enhancements
|
||||
|
||||
- [ ] **Rich progress bars** with animated indicators
|
||||
- [ ] **Color themes** (dark/light mode support)
|
||||
- [ ] **Log level integration** with Python logging
|
||||
- [ ] **JSON output mode** for CI/CD pipelines
|
||||
- [ ] **Color customization** via configuration files
|
||||
|
||||
---
|
||||
|
||||
**UnitForge Color Utilities** - Making terminal output beautiful and consistent! 🎨
|
||||
@@ -0,0 +1,115 @@
|
||||
# UnitForge Color Definitions for Makefiles
|
||||
# Centralized ANSI color codes for consistent terminal output in Make targets
|
||||
|
||||
# Basic colors
|
||||
BLUE := \033[0;34m
|
||||
GREEN := \033[0;32m
|
||||
YELLOW := \033[1;33m
|
||||
RED := \033[0;31m
|
||||
PURPLE := \033[0;35m
|
||||
CYAN := \033[0;36m
|
||||
WHITE := \033[0;37m
|
||||
GRAY := \033[0;90m
|
||||
|
||||
# Bright colors
|
||||
BRIGHT_RED := \033[1;31m
|
||||
BRIGHT_GREEN := \033[1;32m
|
||||
BRIGHT_YELLOW := \033[1;33m
|
||||
BRIGHT_BLUE := \033[1;34m
|
||||
BRIGHT_PURPLE := \033[1;35m
|
||||
BRIGHT_CYAN := \033[1;36m
|
||||
BRIGHT_WHITE := \033[1;37m
|
||||
|
||||
# Background colors
|
||||
BG_RED := \033[41m
|
||||
BG_GREEN := \033[42m
|
||||
BG_YELLOW := \033[43m
|
||||
BG_BLUE := \033[44m
|
||||
BG_PURPLE := \033[45m
|
||||
BG_CYAN := \033[46m
|
||||
BG_WHITE := \033[47m
|
||||
|
||||
# Text formatting
|
||||
BOLD := \033[1m
|
||||
DIM := \033[2m
|
||||
UNDERLINE := \033[4m
|
||||
REVERSE := \033[7m
|
||||
|
||||
# Reset
|
||||
NC := \033[0m
|
||||
RESET := \033[0m
|
||||
|
||||
# Status symbols
|
||||
INFO_SYMBOL := ℹ
|
||||
SUCCESS_SYMBOL := ✓
|
||||
WARNING_SYMBOL := ⚠
|
||||
ERROR_SYMBOL := ✗
|
||||
DEBUG_SYMBOL := 🐛
|
||||
|
||||
# Makefile utility functions (use with $(call function_name,message))
|
||||
define info
|
||||
@printf "$(BLUE)$(INFO_SYMBOL)$(NC) %s\n" "$(1)"
|
||||
endef
|
||||
|
||||
define success
|
||||
@printf "$(GREEN)$(SUCCESS_SYMBOL)$(NC) %s\n" "$(1)"
|
||||
endef
|
||||
|
||||
define warning
|
||||
@printf "$(YELLOW)$(WARNING_SYMBOL)$(NC) %s\n" "$(1)"
|
||||
endef
|
||||
|
||||
define error
|
||||
@printf "$(RED)$(ERROR_SYMBOL)$(NC) %s\n" "$(1)" >&2
|
||||
endef
|
||||
|
||||
define header
|
||||
@echo ""
|
||||
@printf "$(BOLD)$(BLUE)%s$(NC)\n" "$(1)"
|
||||
@printf "$(BLUE)%s$(NC)\n" "$$(printf '%.0s=' $$(seq 1 $$(printf '%s' '$(1)' | wc -c)))"
|
||||
endef
|
||||
|
||||
define subheader
|
||||
@echo ""
|
||||
@printf "$(BOLD)%s$(NC)\n" "$(1)"
|
||||
@printf "%s\n" "$$(printf '%.0s-' $$(seq 1 $$(printf '%s' '$(1)' | wc -c)))"
|
||||
endef
|
||||
|
||||
define step
|
||||
@printf "$(CYAN)[%s]$(NC) $(BOLD)%s$(NC)\n" "$(1)" "$(2)"
|
||||
endef
|
||||
|
||||
define status
|
||||
@case "$(1)" in \
|
||||
"ok"|"success"|"done") \
|
||||
printf "$(GREEN)[ OK ]$(NC) %s\n" "$(2)" ;; \
|
||||
"fail"|"error"|"failed") \
|
||||
printf "$(RED)[ FAIL ]$(NC) %s\n" "$(2)" ;; \
|
||||
"warn"|"warning") \
|
||||
printf "$(YELLOW)[ WARN ]$(NC) %s\n" "$(2)" ;; \
|
||||
"info") \
|
||||
printf "$(BLUE)[ INFO ]$(NC) %s\n" "$(2)" ;; \
|
||||
"skip"|"skipped") \
|
||||
printf "$(GRAY)[ SKIP ]$(NC) %s\n" "$(2)" ;; \
|
||||
*) \
|
||||
printf "$(WHITE)[ ]$(NC) %s\n" "$(2)" ;; \
|
||||
esac
|
||||
endef
|
||||
|
||||
# Box drawing
|
||||
define box_header
|
||||
@printf "$(BLUE)╔══════════════════════════════════════════════╗$(NC)\n"
|
||||
@printf "$(BLUE)║$(NC) %-44s $(BLUE)║$(NC)\n" "$(1)"
|
||||
@printf "$(BLUE)╚══════════════════════════════════════════════╝$(NC)\n"
|
||||
endef
|
||||
|
||||
# Usage examples:
|
||||
# $(call info,This is an info message)
|
||||
# $(call success,Operation completed successfully)
|
||||
# $(call warning,This is a warning)
|
||||
# $(call error,Something went wrong)
|
||||
# $(call header,Main Section)
|
||||
# $(call subheader,Subsection)
|
||||
# $(call box_header,UnitForge Setup)
|
||||
# $(call step,1/5,Installing dependencies)
|
||||
# $(call status,ok,Package installed)
|
||||
@@ -0,0 +1,398 @@
|
||||
"""
|
||||
UnitForge Color Utility for Python
|
||||
Centralized ANSI color definitions and utility functions for consistent terminal output
|
||||
"""
|
||||
|
||||
import os
|
||||
import sys
|
||||
from typing import Optional
|
||||
|
||||
|
||||
class Colors:
|
||||
"""ANSI color codes and formatting constants."""
|
||||
|
||||
# Basic colors
|
||||
RED = "\033[0;31m"
|
||||
GREEN = "\033[0;32m"
|
||||
YELLOW = "\033[1;33m"
|
||||
BLUE = "\033[0;34m"
|
||||
PURPLE = "\033[0;35m"
|
||||
CYAN = "\033[0;36m"
|
||||
WHITE = "\033[0;37m"
|
||||
GRAY = "\033[0;90m"
|
||||
|
||||
# Bright colors
|
||||
BRIGHT_RED = "\033[1;31m"
|
||||
BRIGHT_GREEN = "\033[1;32m"
|
||||
BRIGHT_YELLOW = "\033[1;33m"
|
||||
BRIGHT_BLUE = "\033[1;34m"
|
||||
BRIGHT_PURPLE = "\033[1;35m"
|
||||
BRIGHT_CYAN = "\033[1;36m"
|
||||
BRIGHT_WHITE = "\033[1;37m"
|
||||
|
||||
# Background colors
|
||||
BG_RED = "\033[41m"
|
||||
BG_GREEN = "\033[42m"
|
||||
BG_YELLOW = "\033[43m"
|
||||
BG_BLUE = "\033[44m"
|
||||
BG_PURPLE = "\033[45m"
|
||||
BG_CYAN = "\033[46m"
|
||||
BG_WHITE = "\033[47m"
|
||||
|
||||
# Text formatting
|
||||
BOLD = "\033[1m"
|
||||
DIM = "\033[2m"
|
||||
ITALIC = "\033[3m"
|
||||
UNDERLINE = "\033[4m"
|
||||
BLINK = "\033[5m"
|
||||
REVERSE = "\033[7m"
|
||||
STRIKETHROUGH = "\033[9m"
|
||||
|
||||
# Reset
|
||||
NC = "\033[0m" # No Color
|
||||
RESET = "\033[0m"
|
||||
|
||||
# Status symbols
|
||||
INFO_SYMBOL = "ℹ"
|
||||
SUCCESS_SYMBOL = "✓"
|
||||
WARNING_SYMBOL = "⚠"
|
||||
ERROR_SYMBOL = "✗"
|
||||
DEBUG_SYMBOL = "🐛"
|
||||
|
||||
|
||||
def supports_color() -> bool:
|
||||
"""
|
||||
Check if the terminal supports colors.
|
||||
|
||||
Returns:
|
||||
bool: True if colors are supported, False otherwise
|
||||
"""
|
||||
# Check if we're in a terminal
|
||||
if not hasattr(sys.stdout, "isatty") or not sys.stdout.isatty():
|
||||
return False
|
||||
|
||||
# Check environment variables
|
||||
if os.environ.get("NO_COLOR"):
|
||||
return False
|
||||
|
||||
if os.environ.get("FORCE_COLOR"):
|
||||
return True
|
||||
|
||||
# Check TERM environment variable
|
||||
term = os.environ.get("TERM", "")
|
||||
if term == "dumb":
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
|
||||
# Initialize colors based on support
|
||||
if supports_color():
|
||||
c = Colors()
|
||||
else:
|
||||
# Create a class with empty strings for all colors
|
||||
class NoColors:
|
||||
def __getattr__(self, name):
|
||||
return ""
|
||||
|
||||
c = NoColors()
|
||||
|
||||
|
||||
def color_text(text: str, color: str) -> str:
|
||||
"""
|
||||
Apply color to text.
|
||||
|
||||
Args:
|
||||
text: The text to colorize
|
||||
color: The ANSI color code
|
||||
|
||||
Returns:
|
||||
str: Colored text with reset at the end
|
||||
"""
|
||||
if not supports_color():
|
||||
return text
|
||||
return f"{color}{text}{c.NC}"
|
||||
|
||||
|
||||
def red(text: str) -> str:
|
||||
"""Return red colored text."""
|
||||
return color_text(text, c.RED)
|
||||
|
||||
|
||||
def green(text: str) -> str:
|
||||
"""Return green colored text."""
|
||||
return color_text(text, c.GREEN)
|
||||
|
||||
|
||||
def yellow(text: str) -> str:
|
||||
"""Return yellow colored text."""
|
||||
return color_text(text, c.YELLOW)
|
||||
|
||||
|
||||
def blue(text: str) -> str:
|
||||
"""Return blue colored text."""
|
||||
return color_text(text, c.BLUE)
|
||||
|
||||
|
||||
def purple(text: str) -> str:
|
||||
"""Return purple colored text."""
|
||||
return color_text(text, c.PURPLE)
|
||||
|
||||
|
||||
def cyan(text: str) -> str:
|
||||
"""Return cyan colored text."""
|
||||
return color_text(text, c.CYAN)
|
||||
|
||||
|
||||
def white(text: str) -> str:
|
||||
"""Return white colored text."""
|
||||
return color_text(text, c.WHITE)
|
||||
|
||||
|
||||
def gray(text: str) -> str:
|
||||
"""Return gray colored text."""
|
||||
return color_text(text, c.GRAY)
|
||||
|
||||
|
||||
def bright_red(text: str) -> str:
|
||||
"""Return bright red colored text."""
|
||||
return color_text(text, c.BRIGHT_RED)
|
||||
|
||||
|
||||
def bright_green(text: str) -> str:
|
||||
"""Return bright green colored text."""
|
||||
return color_text(text, c.BRIGHT_GREEN)
|
||||
|
||||
|
||||
def bright_yellow(text: str) -> str:
|
||||
"""Return bright yellow colored text."""
|
||||
return color_text(text, c.BRIGHT_YELLOW)
|
||||
|
||||
|
||||
def bright_blue(text: str) -> str:
|
||||
"""Return bright blue colored text."""
|
||||
return color_text(text, c.BRIGHT_BLUE)
|
||||
|
||||
|
||||
def bright_purple(text: str) -> str:
|
||||
"""Return bright purple colored text."""
|
||||
return color_text(text, c.BRIGHT_PURPLE)
|
||||
|
||||
|
||||
def bright_cyan(text: str) -> str:
|
||||
"""Return bright cyan colored text."""
|
||||
return color_text(text, c.BRIGHT_CYAN)
|
||||
|
||||
|
||||
def bright_white(text: str) -> str:
|
||||
"""Return bright white colored text."""
|
||||
return color_text(text, c.BRIGHT_WHITE)
|
||||
|
||||
|
||||
def bold(text: str) -> str:
|
||||
"""Return bold text."""
|
||||
return color_text(text, c.BOLD)
|
||||
|
||||
|
||||
def dim(text: str) -> str:
|
||||
"""Return dim text."""
|
||||
return color_text(text, c.DIM)
|
||||
|
||||
|
||||
def italic(text: str) -> str:
|
||||
"""Return italic text."""
|
||||
return color_text(text, c.ITALIC)
|
||||
|
||||
|
||||
def underline(text: str) -> str:
|
||||
"""Return underlined text."""
|
||||
return color_text(text, c.UNDERLINE)
|
||||
|
||||
|
||||
def info(message: str, file=None) -> None:
|
||||
"""Print an info message."""
|
||||
output = f"{c.BLUE}{c.INFO_SYMBOL}{c.NC} {message}"
|
||||
print(output, file=file)
|
||||
|
||||
|
||||
def success(message: str, file=None) -> None:
|
||||
"""Print a success message."""
|
||||
output = f"{c.GREEN}{c.SUCCESS_SYMBOL}{c.NC} {message}"
|
||||
print(output, file=file)
|
||||
|
||||
|
||||
def warning(message: str, file=None) -> None:
|
||||
"""Print a warning message."""
|
||||
output = f"{c.YELLOW}{c.WARNING_SYMBOL}{c.NC} {message}"
|
||||
print(output, file=file)
|
||||
|
||||
|
||||
def error(message: str, file=None) -> None:
|
||||
"""Print an error message."""
|
||||
output = f"{c.RED}{c.ERROR_SYMBOL}{c.NC} {message}"
|
||||
print(output, file=file or sys.stderr)
|
||||
|
||||
|
||||
def debug(message: str, file=None) -> None:
|
||||
"""Print a debug message (only if DEBUG environment variable is set)."""
|
||||
if os.environ.get("DEBUG"):
|
||||
output = f"{c.GRAY}{c.DEBUG_SYMBOL}{c.NC} {message}"
|
||||
print(output, file=file or sys.stderr)
|
||||
|
||||
|
||||
def header(text: str, file=None) -> None:
|
||||
"""Print a header with underline."""
|
||||
print(file=file)
|
||||
print(f"{c.BOLD}{c.BLUE}{text}{c.NC}", file=file)
|
||||
print(f"{c.BLUE}{'=' * len(text)}{c.NC}", file=file)
|
||||
|
||||
|
||||
def subheader(text: str, file=None) -> None:
|
||||
"""Print a subheader with underline."""
|
||||
print(file=file)
|
||||
print(f"{c.BOLD}{text}{c.NC}", file=file)
|
||||
print("-" * len(text), file=file)
|
||||
|
||||
|
||||
def step(current: int, total: int, description: str, file=None) -> None:
|
||||
"""Print a step indicator."""
|
||||
output = f"{c.CYAN}[{current}/{total}]{c.NC} {c.BOLD}{description}{c.NC}"
|
||||
print(output, file=file)
|
||||
|
||||
|
||||
def status(status_type: str, message: str, file=None) -> None:
|
||||
"""
|
||||
Print a status message with appropriate formatting.
|
||||
|
||||
Args:
|
||||
status_type: Type of status (ok, fail, warn, info, skip)
|
||||
message: The status message
|
||||
file: Output file (defaults to stdout, stderr for errors)
|
||||
"""
|
||||
status_map = {
|
||||
"ok": (f"{c.GREEN}[ OK ]{c.NC}", None),
|
||||
"success": (f"{c.GREEN}[ OK ]{c.NC}", None),
|
||||
"done": (f"{c.GREEN}[ OK ]{c.NC}", None),
|
||||
"fail": (f"{c.RED}[ FAIL ]{c.NC}", sys.stderr),
|
||||
"error": (f"{c.RED}[ FAIL ]{c.NC}", sys.stderr),
|
||||
"failed": (f"{c.RED}[ FAIL ]{c.NC}", sys.stderr),
|
||||
"warn": (f"{c.YELLOW}[ WARN ]{c.NC}", None),
|
||||
"warning": (f"{c.YELLOW}[ WARN ]{c.NC}", None),
|
||||
"info": (f"{c.BLUE}[ INFO ]{c.NC}", None),
|
||||
"skip": (f"{c.GRAY}[ SKIP ]{c.NC}", None),
|
||||
"skipped": (f"{c.GRAY}[ SKIP ]{c.NC}", None),
|
||||
}
|
||||
|
||||
status_prefix, default_file = status_map.get(
|
||||
status_type.lower(), (f"{c.WHITE}[ ]{c.NC}", None)
|
||||
)
|
||||
output_file = file or default_file
|
||||
|
||||
print(f"{status_prefix} {message}", file=output_file)
|
||||
|
||||
|
||||
def box_header(text: str, width: int = 50, file=None) -> None:
|
||||
"""Print a fancy box header."""
|
||||
padding = (width - len(text) - 2) // 2
|
||||
print(f"{c.BLUE}╔{'═' * (width - 2)}╗{c.NC}", file=file)
|
||||
print(
|
||||
f"{c.BLUE}║{c.NC}{' ' * padding}{c.BOLD}{text}{c.NC}"
|
||||
f"{' ' * padding}{c.BLUE}║{c.NC}",
|
||||
file=file,
|
||||
)
|
||||
print(f"{c.BLUE}╚{'═' * (width - 2)}╝{c.NC}", file=file)
|
||||
|
||||
|
||||
def box_message(
|
||||
text: str, color: Optional[str] = None, width: int = 50, file=None
|
||||
) -> None:
|
||||
"""Print a message in a box."""
|
||||
box_color = color or c.BLUE
|
||||
padding = (width - len(text) - 2) // 2
|
||||
print(f"{box_color}┌{'─' * (width - 2)}┐{c.NC}", file=file)
|
||||
print(
|
||||
f"{box_color}│{c.NC}{' ' * padding}{text}{' ' * padding}{box_color}│{c.NC}",
|
||||
file=file,
|
||||
)
|
||||
print(f"{box_color}└{'─' * (width - 2)}┘{c.NC}", file=file)
|
||||
|
||||
|
||||
def progress_bar(current: int, total: int, width: int = 40, file=None) -> None:
|
||||
"""Print a progress bar."""
|
||||
percent = current * 100 // total
|
||||
filled = current * width // total
|
||||
empty = width - filled
|
||||
|
||||
bar = f"{c.BLUE}[{'█' * filled}{'░' * empty}] {percent}% ({current}/{total}){c.NC}"
|
||||
print(f"\r{bar}", end="", file=file, flush=True)
|
||||
|
||||
if current == total:
|
||||
print(file=file) # New line when complete
|
||||
|
||||
|
||||
class ColorizedFormatter:
|
||||
"""A context manager for colorized output."""
|
||||
|
||||
def __init__(self, color: str):
|
||||
self.color = color
|
||||
|
||||
def __enter__(self):
|
||||
if supports_color():
|
||||
print(self.color, end="")
|
||||
return self
|
||||
|
||||
def __exit__(self, exc_type, exc_val, exc_tb):
|
||||
if supports_color():
|
||||
print(c.NC, end="")
|
||||
|
||||
|
||||
# Example usage and testing
|
||||
if __name__ == "__main__":
|
||||
print("\nUnitForge Color Utility Test")
|
||||
print("=" * 30)
|
||||
|
||||
# Test basic colors
|
||||
print("\nBasic Colors:")
|
||||
print(red("Red text"))
|
||||
print(green("Green text"))
|
||||
print(yellow("Yellow text"))
|
||||
print(blue("Blue text"))
|
||||
print(purple("Purple text"))
|
||||
print(cyan("Cyan text"))
|
||||
|
||||
# Test status functions
|
||||
print("\nStatus Messages:")
|
||||
info("This is an info message")
|
||||
success("This is a success message")
|
||||
warning("This is a warning message")
|
||||
error("This is an error message")
|
||||
debug("This is a debug message")
|
||||
|
||||
# Test headers
|
||||
header("Main Header")
|
||||
subheader("Sub Header")
|
||||
|
||||
# Test status indicators
|
||||
print("\nStatus Indicators:")
|
||||
status("ok", "Operation successful")
|
||||
status("fail", "Operation failed")
|
||||
status("warn", "Operation completed with warnings")
|
||||
status("info", "Information message")
|
||||
status("skip", "Operation skipped")
|
||||
|
||||
# Test boxes
|
||||
print("\nBox Examples:")
|
||||
box_header("UnitForge Test", 30)
|
||||
box_message("Success!", c.GREEN, 30)
|
||||
|
||||
# Test progress
|
||||
print("\nProgress Example:")
|
||||
import time
|
||||
|
||||
for i in range(11):
|
||||
progress_bar(i, 10, 30)
|
||||
if i < 10:
|
||||
time.sleep(0.1)
|
||||
|
||||
print("\nColor support:", "Yes" if supports_color() else "No")
|
||||
print("Test completed!")
|
||||
Executable
+218
@@ -0,0 +1,218 @@
|
||||
#!/bin/bash
|
||||
# UnitForge Color Utility Library
|
||||
# Centralized ANSI color definitions and utility functions for consistent terminal output
|
||||
|
||||
# ANSI Color Codes
|
||||
export RED='\033[0;31m'
|
||||
export GREEN='\033[0;32m'
|
||||
export YELLOW='\033[1;33m'
|
||||
export BLUE='\033[0;34m'
|
||||
export PURPLE='\033[0;35m'
|
||||
export CYAN='\033[0;36m'
|
||||
export WHITE='\033[0;37m'
|
||||
export GRAY='\033[0;90m'
|
||||
|
||||
# Bright colors
|
||||
export BRIGHT_RED='\033[1;31m'
|
||||
export BRIGHT_GREEN='\033[1;32m'
|
||||
export BRIGHT_YELLOW='\033[1;33m'
|
||||
export BRIGHT_BLUE='\033[1;34m'
|
||||
export BRIGHT_PURPLE='\033[1;35m'
|
||||
export BRIGHT_CYAN='\033[1;36m'
|
||||
export BRIGHT_WHITE='\033[1;37m'
|
||||
|
||||
# Background colors
|
||||
export BG_RED='\033[41m'
|
||||
export BG_GREEN='\033[42m'
|
||||
export BG_YELLOW='\033[43m'
|
||||
export BG_BLUE='\033[44m'
|
||||
export BG_PURPLE='\033[45m'
|
||||
export BG_CYAN='\033[46m'
|
||||
export BG_WHITE='\033[47m'
|
||||
|
||||
# Text formatting
|
||||
export BOLD='\033[1m'
|
||||
export DIM='\033[2m'
|
||||
export ITALIC='\033[3m'
|
||||
export UNDERLINE='\033[4m'
|
||||
export BLINK='\033[5m'
|
||||
export REVERSE='\033[7m'
|
||||
export STRIKETHROUGH='\033[9m'
|
||||
|
||||
# Reset
|
||||
export NC='\033[0m' # No Color
|
||||
export RESET='\033[0m'
|
||||
|
||||
# Utility functions for colored output
|
||||
color_echo() {
|
||||
local color="$1"
|
||||
shift
|
||||
echo -e "${color}$*${NC}"
|
||||
}
|
||||
|
||||
# Convenience functions
|
||||
red() { color_echo "$RED" "$@"; }
|
||||
green() { color_echo "$GREEN" "$@"; }
|
||||
yellow() { color_echo "$YELLOW" "$@"; }
|
||||
blue() { color_echo "$BLUE" "$@"; }
|
||||
purple() { color_echo "$PURPLE" "$@"; }
|
||||
cyan() { color_echo "$CYAN" "$@"; }
|
||||
white() { color_echo "$WHITE" "$@"; }
|
||||
gray() { color_echo "$GRAY" "$@"; }
|
||||
|
||||
# Bright variants
|
||||
bright_red() { color_echo "$BRIGHT_RED" "$@"; }
|
||||
bright_green() { color_echo "$BRIGHT_GREEN" "$@"; }
|
||||
bright_yellow() { color_echo "$BRIGHT_YELLOW" "$@"; }
|
||||
bright_blue() { color_echo "$BRIGHT_BLUE" "$@"; }
|
||||
bright_purple() { color_echo "$BRIGHT_PURPLE" "$@"; }
|
||||
bright_cyan() { color_echo "$BRIGHT_CYAN" "$@"; }
|
||||
bright_white() { color_echo "$BRIGHT_WHITE" "$@"; }
|
||||
|
||||
# Formatted output functions
|
||||
info() {
|
||||
echo -e "${BLUE}ℹ${NC} $*"
|
||||
}
|
||||
|
||||
success() {
|
||||
echo -e "${GREEN}✓${NC} $*"
|
||||
}
|
||||
|
||||
warning() {
|
||||
echo -e "${YELLOW}⚠${NC} $*"
|
||||
}
|
||||
|
||||
error() {
|
||||
echo -e "${RED}✗${NC} $*" >&2
|
||||
}
|
||||
|
||||
debug() {
|
||||
if [[ "${DEBUG:-}" == "1" ]]; then
|
||||
echo -e "${GRAY}🐛${NC} $*" >&2
|
||||
fi
|
||||
}
|
||||
|
||||
# Header functions
|
||||
header() {
|
||||
echo
|
||||
echo -e "${BOLD}${BLUE}$*${NC}"
|
||||
echo -e "${BLUE}$(printf '%.0s=' $(seq 1 ${#1}))${NC}"
|
||||
}
|
||||
|
||||
subheader() {
|
||||
echo
|
||||
echo -e "${BOLD}$*${NC}"
|
||||
echo -e "$(printf '%.0s-' $(seq 1 ${#1}))"
|
||||
}
|
||||
|
||||
# Box drawing functions
|
||||
box_header() {
|
||||
local text="$1"
|
||||
local width=${2:-50}
|
||||
local padding=$(( (width - ${#text} - 2) / 2 ))
|
||||
|
||||
echo -e "${BLUE}╔$(printf '%.0s═' $(seq 1 $((width-2))))╗${NC}"
|
||||
printf "${BLUE}║${NC}%*s${BOLD}%s${NC}%*s${BLUE}║${NC}\n" $padding "" "$text" $padding ""
|
||||
echo -e "${BLUE}╚$(printf '%.0s═' $(seq 1 $((width-2))))╝${NC}"
|
||||
}
|
||||
|
||||
box_message() {
|
||||
local text="$1"
|
||||
local color="${2:-$BLUE}"
|
||||
local width=${3:-50}
|
||||
local padding=$(( (width - ${#text} - 2) / 2 ))
|
||||
|
||||
echo -e "${color}┌$(printf '%.0s─' $(seq 1 $((width-2))))┐${NC}"
|
||||
printf "${color}│${NC}%*s%s%*s${color}│${NC}\n" $padding "" "$text" $padding ""
|
||||
echo -e "${color}└$(printf '%.0s─' $(seq 1 $((width-2))))┘${NC}"
|
||||
}
|
||||
|
||||
# Progress indicators
|
||||
spinner() {
|
||||
local pid=$!
|
||||
local delay=0.1
|
||||
local spinstr='|/-\'
|
||||
while [ "$(ps a | awk '{print $1}' | grep $pid)" ]; do
|
||||
local temp=${spinstr#?}
|
||||
printf " [%c] " "$spinstr"
|
||||
local spinstr=$temp${spinstr%"$temp"}
|
||||
sleep $delay
|
||||
printf "\b\b\b\b\b\b"
|
||||
done
|
||||
printf " \b\b\b\b"
|
||||
}
|
||||
|
||||
# Progress bar
|
||||
progress_bar() {
|
||||
local current=$1
|
||||
local total=$2
|
||||
local width=${3:-40}
|
||||
local percent=$((current * 100 / total))
|
||||
local filled=$((current * width / total))
|
||||
local empty=$((width - filled))
|
||||
|
||||
printf "\r${BLUE}["
|
||||
printf "%*s" $filled | tr ' ' '█'
|
||||
printf "%*s" $empty | tr ' ' '░'
|
||||
printf "] %d%% (%d/%d)${NC}" $percent $current $total
|
||||
}
|
||||
|
||||
# Status functions
|
||||
step() {
|
||||
local step_num="$1"
|
||||
local total_steps="$2"
|
||||
local description="$3"
|
||||
echo -e "${CYAN}[${step_num}/${total_steps}]${NC} ${BOLD}${description}${NC}"
|
||||
}
|
||||
|
||||
status() {
|
||||
local status="$1"
|
||||
shift
|
||||
case "$status" in
|
||||
"ok"|"success"|"done")
|
||||
echo -e "${GREEN}[ OK ]${NC} $*"
|
||||
;;
|
||||
"fail"|"error"|"failed")
|
||||
echo -e "${RED}[ FAIL ]${NC} $*"
|
||||
;;
|
||||
"warn"|"warning")
|
||||
echo -e "${YELLOW}[ WARN ]${NC} $*"
|
||||
;;
|
||||
"info")
|
||||
echo -e "${BLUE}[ INFO ]${NC} $*"
|
||||
;;
|
||||
"skip"|"skipped")
|
||||
echo -e "${GRAY}[ SKIP ]${NC} $*"
|
||||
;;
|
||||
*)
|
||||
echo -e "${WHITE}[ ]${NC} $*"
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
# Color detection and graceful degradation
|
||||
supports_color() {
|
||||
# Check if we're in a terminal that supports colors
|
||||
[[ -t 1 ]] && [[ "${TERM:-}" != "dumb" ]] && [[ "${NO_COLOR:-}" != "1" ]]
|
||||
}
|
||||
|
||||
# Disable colors if not supported
|
||||
if ! supports_color; then
|
||||
# Redefine all color variables as empty
|
||||
RED='' GREEN='' YELLOW='' BLUE='' PURPLE='' CYAN='' WHITE='' GRAY=''
|
||||
BRIGHT_RED='' BRIGHT_GREEN='' BRIGHT_YELLOW='' BRIGHT_BLUE='' BRIGHT_PURPLE='' BRIGHT_CYAN='' BRIGHT_WHITE=''
|
||||
BG_RED='' BG_GREEN='' BG_YELLOW='' BG_BLUE='' BG_PURPLE='' BG_CYAN='' BG_WHITE=''
|
||||
BOLD='' DIM='' ITALIC='' UNDERLINE='' BLINK='' REVERSE='' STRIKETHROUGH=''
|
||||
NC='' RESET=''
|
||||
fi
|
||||
|
||||
# Usage examples (commented out)
|
||||
# info "This is an info message"
|
||||
# success "Operation completed successfully"
|
||||
# warning "This is a warning"
|
||||
# error "Something went wrong"
|
||||
# header "Main Section"
|
||||
# subheader "Subsection"
|
||||
# box_header "UnitForge Setup"
|
||||
# step 1 5 "Installing dependencies"
|
||||
# status ok "Package installed"
|
||||
Executable
+90
@@ -0,0 +1,90 @@
|
||||
#!/bin/bash
|
||||
# Test script for UnitForge color utility
|
||||
# This script tests all color functions and displays examples
|
||||
|
||||
set -e
|
||||
|
||||
# Load the color utility
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "${SCRIPT_DIR}/colors.sh"
|
||||
|
||||
echo
|
||||
box_header "UnitForge Color Utility Test"
|
||||
echo
|
||||
|
||||
header "Basic Color Functions"
|
||||
red "This is red text"
|
||||
green "This is green text"
|
||||
yellow "This is yellow text"
|
||||
blue "This is blue text"
|
||||
purple "This is purple text"
|
||||
cyan "This is cyan text"
|
||||
white "This is white text"
|
||||
gray "This is gray text"
|
||||
|
||||
echo
|
||||
subheader "Bright Colors"
|
||||
bright_red "This is bright red text"
|
||||
bright_green "This is bright green text"
|
||||
bright_yellow "This is bright yellow text"
|
||||
bright_blue "This is bright blue text"
|
||||
bright_purple "This is bright purple text"
|
||||
bright_cyan "This is bright cyan text"
|
||||
bright_white "This is bright white text"
|
||||
|
||||
echo
|
||||
subheader "Status Messages"
|
||||
info "This is an info message"
|
||||
success "This is a success message"
|
||||
warning "This is a warning message"
|
||||
error "This is an error message"
|
||||
debug "This is a debug message (only shown if DEBUG=1)"
|
||||
|
||||
echo
|
||||
DEBUG=1 debug "This debug message should be visible"
|
||||
|
||||
echo
|
||||
subheader "Status Indicators"
|
||||
status ok "Operation completed successfully"
|
||||
status fail "Operation failed"
|
||||
status warn "Operation completed with warnings"
|
||||
status info "Information about the operation"
|
||||
status skip "Operation was skipped"
|
||||
status unknown "Unknown status"
|
||||
|
||||
echo
|
||||
subheader "Progress Steps"
|
||||
step 1 5 "Initializing project"
|
||||
step 2 5 "Installing dependencies"
|
||||
step 3 5 "Running tests"
|
||||
step 4 5 "Building documentation"
|
||||
step 5 5 "Deployment complete"
|
||||
|
||||
echo
|
||||
subheader "Box Messages"
|
||||
box_message "Success: Operation completed!" "$GREEN" 50
|
||||
box_message "Warning: Check configuration" "$YELLOW" 50
|
||||
box_message "Error: Something went wrong" "$RED" 50
|
||||
|
||||
echo
|
||||
subheader "Headers and Formatting"
|
||||
echo "Testing ${BOLD}bold${NC}, ${UNDERLINE}underline${NC}, and ${DIM}dim${NC} text"
|
||||
echo "Testing ${ITALIC}italic${NC} text (if supported by terminal)"
|
||||
|
||||
echo
|
||||
subheader "Color Support Detection"
|
||||
if supports_color; then
|
||||
success "Terminal supports colors"
|
||||
else
|
||||
warning "Terminal does not support colors (colors disabled)"
|
||||
fi
|
||||
|
||||
echo
|
||||
subheader "Environment Info"
|
||||
echo "TERM: ${TERM:-not set}"
|
||||
echo "NO_COLOR: ${NO_COLOR:-not set}"
|
||||
echo "Terminal type: $(tty 2>/dev/null || echo 'not a terminal')"
|
||||
|
||||
echo
|
||||
success "Color utility test completed!"
|
||||
echo
|
||||
Executable
+320
@@ -0,0 +1,320 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
# UnitForge Development Setup Script with uv
|
||||
# This script sets up the development environment using uv for fast package management
|
||||
|
||||
# Load centralized color utility
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "${SCRIPT_DIR}/scripts/colors.sh"
|
||||
|
||||
# Configuration
|
||||
PROJECT_NAME="UnitForge"
|
||||
PYTHON_VERSION="3.8"
|
||||
UV_MIN_VERSION="0.1.0"
|
||||
|
||||
box_header "UnitForge Development Setup"
|
||||
echo -e "${BLUE}║ ${PROJECT_NAME} Development Setup ║${NC}"
|
||||
echo -e "${BLUE}║ Using uv Package Manager ║${NC}"
|
||||
echo -e "${BLUE}╚══════════════════════════════════════════════╝${NC}"
|
||||
echo ""
|
||||
|
||||
# Function to check if command exists
|
||||
command_exists() {
|
||||
command -v "$1" >/dev/null 2>&1
|
||||
}
|
||||
|
||||
# Function to check version
|
||||
version_ge() {
|
||||
printf '%s\n%s\n' "$2" "$1" | sort -V -C
|
||||
}
|
||||
|
||||
# Check if we're in the right directory
|
||||
if [[ ! -f "pyproject.toml" ]]; then
|
||||
echo -e "${RED}Error: pyproject.toml not found${NC}"
|
||||
echo "Please run this script from the unitforge project root directory."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo -e "${CYAN}🔍 Checking prerequisites...${NC}"
|
||||
|
||||
# Check Python version
|
||||
if ! command_exists python3; then
|
||||
echo -e "${RED}Error: Python 3 is not installed or not in PATH${NC}"
|
||||
echo "Please install Python 3.8 or higher"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
PYTHON_VERSION_ACTUAL=$(python3 -c 'import sys; print(".".join(map(str, sys.version_info[:2])))')
|
||||
if ! python3 -c "import sys; exit(0 if sys.version_info >= (3, 8) else 1)"; then
|
||||
echo -e "${RED}Error: Python ${PYTHON_VERSION}+ is required, but ${PYTHON_VERSION_ACTUAL} is installed${NC}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo -e "${GREEN}✓ Python ${PYTHON_VERSION_ACTUAL} found${NC}"
|
||||
|
||||
# Check for uv installation
|
||||
if ! command_exists uv; then
|
||||
echo -e "${YELLOW}⚠ uv not found. Installing uv...${NC}"
|
||||
|
||||
# Install uv using the official installer
|
||||
if command_exists curl; then
|
||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||
|
||||
# Add uv to PATH for current session
|
||||
export PATH="$HOME/.cargo/bin:$PATH"
|
||||
|
||||
# Source shell configuration to get uv in PATH
|
||||
if [[ -f "$HOME/.bashrc" ]]; then
|
||||
source "$HOME/.bashrc" 2>/dev/null || true
|
||||
fi
|
||||
if [[ -f "$HOME/.zshrc" ]]; then
|
||||
source "$HOME/.zshrc" 2>/dev/null || true
|
||||
fi
|
||||
|
||||
elif command_exists wget; then
|
||||
wget -qO- https://astral.sh/uv/install.sh | sh
|
||||
export PATH="$HOME/.cargo/bin:$PATH"
|
||||
else
|
||||
echo -e "${RED}Error: Neither curl nor wget found${NC}"
|
||||
echo "Please install uv manually: https://github.com/astral-sh/uv"
|
||||
echo "Visit: https://github.com/astral-sh/uv#installation"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if uv is now available
|
||||
if ! command_exists uv; then
|
||||
echo -e "${RED}Error: Failed to install uv${NC}"
|
||||
echo "Please install uv manually and restart this script"
|
||||
echo "Installation guide: https://github.com/astral-sh/uv#installation"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
success "Dependencies installed successfully"
|
||||
else
|
||||
success "uv found and ready"
|
||||
fi
|
||||
|
||||
# Display uv version
|
||||
UV_VERSION=$(uv --version | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' || echo "unknown")
|
||||
echo -e "${BLUE} Version: ${UV_VERSION}${NC}"
|
||||
|
||||
echo ""
|
||||
echo -e "${CYAN}🏗️ Setting up virtual environment...${NC}"
|
||||
|
||||
# Remove existing virtual environment if it exists
|
||||
if [[ -d ".venv" ]]; then
|
||||
info "Removing existing virtual environment..."
|
||||
rm -rf .venv
|
||||
fi
|
||||
|
||||
# Create virtual environment with uv
|
||||
info "Creating virtual environment with Python ${PYTHON_VERSION}+..."
|
||||
uv venv --python python3
|
||||
|
||||
# Activate virtual environment
|
||||
source .venv/bin/activate
|
||||
success "Virtual environment created successfully"
|
||||
|
||||
echo ""
|
||||
echo -e "${CYAN}📦 Installing dependencies...${NC}"
|
||||
|
||||
# Install core dependencies
|
||||
info "Installing project dependencies..."
|
||||
uv pip install -e .
|
||||
|
||||
# Install development dependencies
|
||||
info "Installing development dependencies..."
|
||||
uv pip install -e ".[dev]"
|
||||
|
||||
# Install web dependencies
|
||||
info "Installing web dependencies..."
|
||||
uv pip install -e ".[web]"
|
||||
|
||||
success "Development dependencies installed"
|
||||
|
||||
echo ""
|
||||
header "Setting up development tools"
|
||||
|
||||
# Install pre-commit hooks if available
|
||||
if [[ -f ".pre-commit-config.yaml" ]]; then
|
||||
info "Setting up pre-commit hooks..."
|
||||
pre-commit install
|
||||
success "Pre-commit hooks installed"
|
||||
else
|
||||
warning "No pre-commit configuration found, skipping..."
|
||||
fi
|
||||
|
||||
# Create development configuration files
|
||||
echo -e "${BLUE}Creating development configuration...${NC}"
|
||||
|
||||
# Create .env file for development
|
||||
if [[ ! -f ".env" ]]; then
|
||||
cat > .env << 'EOF'
|
||||
# UnitForge Development Environment
|
||||
DEBUG=true
|
||||
LOG_LEVEL=debug
|
||||
HOST=127.0.0.1
|
||||
PORT=8000
|
||||
RELOAD=true
|
||||
|
||||
# API Configuration
|
||||
API_TITLE="UnitForge Development"
|
||||
API_VERSION="1.0.0-dev"
|
||||
|
||||
# Security (for development only)
|
||||
SECRET_KEY="dev-secret-key-change-in-production"
|
||||
ALLOWED_HOSTS=["localhost", "127.0.0.1", "0.0.0.0"]
|
||||
EOF
|
||||
echo -e "${GREEN}✓ Created .env file for development${NC}"
|
||||
else
|
||||
echo -e "${YELLOW}ℹ .env file already exists, skipping...${NC}"
|
||||
fi
|
||||
|
||||
# Create development script shortcuts
|
||||
cat > dev.sh << 'EOF'
|
||||
#!/bin/bash
|
||||
# Development helper script
|
||||
|
||||
set -e
|
||||
|
||||
# Ensure virtual environment is activated
|
||||
if [[ -z "${VIRTUAL_ENV}" ]]; then
|
||||
source .venv/bin/activate
|
||||
fi
|
||||
|
||||
case "$1" in
|
||||
"server"|"serve")
|
||||
echo "🚀 Starting development server..."
|
||||
./start-server.sh --log-level debug
|
||||
;;
|
||||
"test")
|
||||
echo "🧪 Running tests..."
|
||||
uv run pytest tests/ -v "${@:2}"
|
||||
;;
|
||||
"test-watch")
|
||||
echo "👀 Running tests in watch mode..."
|
||||
uv run pytest tests/ -v --watch "${@:2}"
|
||||
;;
|
||||
"test-cov")
|
||||
echo "📊 Running tests with coverage..."
|
||||
uv run pytest tests/ --cov=backend --cov-report=html --cov-report=term "${@:2}"
|
||||
;;
|
||||
"lint")
|
||||
echo "🔍 Running linters..."
|
||||
uv run black --check backend/ tests/
|
||||
uv run isort --check-only backend/ tests/
|
||||
uv run flake8 backend/ tests/
|
||||
;;
|
||||
"format")
|
||||
echo "✨ Formatting code..."
|
||||
uv run black backend/ tests/
|
||||
uv run isort backend/ tests/
|
||||
;;
|
||||
"type-check")
|
||||
echo "🔎 Running type checks..."
|
||||
uv run mypy backend/
|
||||
;;
|
||||
"cli")
|
||||
echo "🖥️ Running CLI..."
|
||||
./unitforge-cli "${@:2}"
|
||||
;;
|
||||
"install")
|
||||
echo "📦 Installing/updating dependencies..."
|
||||
uv pip install -e ".[dev,web]"
|
||||
;;
|
||||
"clean")
|
||||
echo "🧹 Cleaning up..."
|
||||
find . -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true
|
||||
find . -type f -name "*.pyc" -delete 2>/dev/null || true
|
||||
rm -rf .pytest_cache/ htmlcov/ .coverage
|
||||
;;
|
||||
"demo")
|
||||
echo "🎮 Running demo..."
|
||||
./demo.sh
|
||||
;;
|
||||
*)
|
||||
echo "UnitForge Development Helper"
|
||||
echo ""
|
||||
echo "Usage: ./dev.sh <command>"
|
||||
echo ""
|
||||
echo "Commands:"
|
||||
echo " server Start development server"
|
||||
echo " test Run tests"
|
||||
echo " test-watch Run tests in watch mode"
|
||||
echo " test-cov Run tests with coverage"
|
||||
echo " lint Run linters"
|
||||
echo " format Format code"
|
||||
echo " type-check Run type checks"
|
||||
echo " cli Run CLI tool"
|
||||
echo " install Install/update dependencies"
|
||||
echo " clean Clean up cache files"
|
||||
echo " demo Run interactive demo"
|
||||
;;
|
||||
esac
|
||||
EOF
|
||||
|
||||
chmod +x dev.sh
|
||||
echo -e "${GREEN}✓ Created development helper script (dev.sh)${NC}"
|
||||
|
||||
echo ""
|
||||
echo -e "${CYAN}🧪 Running initial tests...${NC}"
|
||||
|
||||
# Run tests to verify everything is working
|
||||
if python -m pytest tests/ -v --tb=short; then
|
||||
success "All tests passed"
|
||||
else
|
||||
warning "Some tests failed, but setup is complete"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${CYAN}📋 Verifying installation...${NC}"
|
||||
|
||||
# Verify CLI works
|
||||
if ./unitforge-cli --help >/dev/null 2>&1; then
|
||||
echo -e "${GREEN}✓ CLI tool working${NC}"
|
||||
else
|
||||
echo -e "${RED}✗ CLI tool not working${NC}"
|
||||
fi
|
||||
|
||||
# Check if server can start (quick test)
|
||||
echo -e "${BLUE}Testing server startup...${NC}"
|
||||
timeout 5s python -c "
|
||||
import sys
|
||||
sys.path.insert(0, 'backend')
|
||||
from app.main import app
|
||||
print('✓ Server imports successfully')
|
||||
" && echo -e "${GREEN}✓ Server configuration valid${NC}" || echo -e "${YELLOW}⚠ Server test incomplete${NC}"
|
||||
|
||||
echo ""
|
||||
echo -e "${GREEN}🎉 Development environment setup complete!${NC}"
|
||||
echo ""
|
||||
echo -e "${BLUE}Next steps:${NC}"
|
||||
echo ""
|
||||
echo -e "${CYAN} 1. Start the development server:${NC}"
|
||||
echo -e " ${YELLOW}./dev.sh server${NC}"
|
||||
echo ""
|
||||
echo -e "${CYAN} 2. Run tests:${NC}"
|
||||
echo -e " ${YELLOW}./dev.sh test${NC}"
|
||||
echo ""
|
||||
echo -e "${CYAN} 3. Try the CLI:${NC}"
|
||||
echo -e " ${YELLOW}./dev.sh cli --help${NC}"
|
||||
echo ""
|
||||
echo -e "${CYAN} 4. Run the demo:${NC}"
|
||||
echo -e " ${YELLOW}./dev.sh demo${NC}"
|
||||
echo ""
|
||||
echo -e "${CYAN} 5. Development workflow:${NC}"
|
||||
echo -e " ${YELLOW}./dev.sh format ${NC}# Format code"
|
||||
echo -e " ${YELLOW}./dev.sh lint ${NC}# Check code style"
|
||||
echo -e " ${YELLOW}./dev.sh test-cov ${NC}# Test with coverage"
|
||||
echo ""
|
||||
echo -e "${BLUE}Virtual environment activated at: ${VIRTUAL_ENV}${NC}"
|
||||
echo -e "${BLUE}Web interface will be available at: http://localhost:8000${NC}"
|
||||
echo ""
|
||||
echo -e "${GREEN}Happy coding! 🚀${NC}"
|
||||
|
||||
# Create activation reminder
|
||||
echo ""
|
||||
echo -e "${YELLOW}💡 To activate the virtual environment in future sessions:${NC}"
|
||||
echo -e " ${CYAN}source .venv/bin/activate${NC}"
|
||||
echo ""
|
||||
Executable
+227
@@ -0,0 +1,227 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
# UnitForge Web Server Startup Script
|
||||
# This script starts the FastAPI development server for UnitForge
|
||||
|
||||
# Load centralized color utility
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "${SCRIPT_DIR}/scripts/colors.sh"
|
||||
|
||||
# Configuration
|
||||
DEFAULT_HOST="0.0.0.0"
|
||||
DEFAULT_PORT="8000"
|
||||
BACKEND_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/backend"
|
||||
|
||||
# Parse command line arguments
|
||||
HOST=${DEFAULT_HOST}
|
||||
PORT=${DEFAULT_PORT}
|
||||
RELOAD=true
|
||||
LOG_LEVEL="info"
|
||||
USE_UV=true
|
||||
|
||||
usage() {
|
||||
echo "Usage: $0 [OPTIONS]"
|
||||
echo ""
|
||||
echo "Options:"
|
||||
echo " -h, --host HOST Host to bind to (default: ${DEFAULT_HOST})"
|
||||
echo " -p, --port PORT Port to bind to (default: ${DEFAULT_PORT})"
|
||||
echo " --no-reload Disable auto-reload"
|
||||
echo " --log-level LEVEL Log level (debug, info, warning, error, critical)"
|
||||
|
||||
echo " --help Show this help message"
|
||||
echo ""
|
||||
echo "Examples:"
|
||||
echo " $0 # Start with default settings"
|
||||
echo " $0 -h 127.0.0.1 -p 3000 # Custom host and port"
|
||||
echo " $0 --no-reload # Start without auto-reload"
|
||||
|
||||
}
|
||||
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case $1 in
|
||||
-h|--host)
|
||||
HOST="$2"
|
||||
shift 2
|
||||
;;
|
||||
-p|--port)
|
||||
PORT="$2"
|
||||
shift 2
|
||||
;;
|
||||
--no-reload)
|
||||
RELOAD=false
|
||||
shift
|
||||
;;
|
||||
--log-level)
|
||||
LOG_LEVEL="$2"
|
||||
shift 2
|
||||
;;
|
||||
|
||||
--help)
|
||||
usage
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
echo -e "${RED}Error: Unknown option $1${NC}"
|
||||
usage
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
# Function to check if command exists
|
||||
command_exists() {
|
||||
command -v "$1" >/dev/null 2>&1
|
||||
}
|
||||
|
||||
# Function to check if port is available
|
||||
check_port() {
|
||||
if command_exists lsof; then
|
||||
if lsof -Pi :$1 -sTCP:LISTEN -t >/dev/null 2>&1; then
|
||||
return 1
|
||||
fi
|
||||
elif command_exists netstat; then
|
||||
if netstat -tuln 2>/dev/null | grep -q ":$1 "; then
|
||||
return 1
|
||||
fi
|
||||
fi
|
||||
return 0
|
||||
}
|
||||
|
||||
# Print banner
|
||||
echo -e "${BLUE}"
|
||||
echo "╔══════════════════════════════════════════════╗"
|
||||
echo "║ UnitForge Server ║"
|
||||
echo "║ Systemd Unit File Creator & Manager ║"
|
||||
echo "╚══════════════════════════════════════════════╝"
|
||||
echo -e "${NC}"
|
||||
|
||||
# Check if we're in the right directory
|
||||
if [[ ! -d "${BACKEND_DIR}" ]]; then
|
||||
echo -e "${RED}Error: Backend directory not found at ${BACKEND_DIR}${NC}"
|
||||
echo "Please run this script from the unitforge project root directory."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if Python is available
|
||||
if ! command_exists python3; then
|
||||
echo -e "${RED}Error: Python 3 is not installed or not in PATH${NC}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check Python version
|
||||
PYTHON_VERSION=$(python3 -c 'import sys; print(".".join(map(str, sys.version_info[:2])))')
|
||||
REQUIRED_VERSION="3.8"
|
||||
|
||||
if ! python3 -c "import sys; exit(0 if sys.version_info >= (3, 8) else 1)"; then
|
||||
echo -e "${RED}Error: Python ${REQUIRED_VERSION}+ is required, but ${PYTHON_VERSION} is installed${NC}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo -e "${GREEN}✓ Python ${PYTHON_VERSION} found${NC}"
|
||||
|
||||
# Check for uv
|
||||
if ! command_exists uv; then
|
||||
echo -e "${RED}Error: uv package manager is required${NC}"
|
||||
echo "Install it with: curl -LsSf https://astral.sh/uv/install.sh | sh"
|
||||
exit 1
|
||||
fi
|
||||
echo -e "${GREEN}✓ uv package manager found${NC}"
|
||||
|
||||
# Change to backend directory
|
||||
cd "${BACKEND_DIR}"
|
||||
|
||||
# Check if virtual environment is activated
|
||||
if [[ -z "${VIRTUAL_ENV}" ]]; then
|
||||
# Check if .venv exists in parent directory
|
||||
if [[ -d "../.venv" ]]; then
|
||||
echo -e "${YELLOW}Activating virtual environment...${NC}"
|
||||
source ../.venv/bin/activate
|
||||
success "Virtual environment activated"
|
||||
else
|
||||
echo -e "${YELLOW}ℹ No virtual environment detected${NC}"
|
||||
echo -e "${YELLOW}Run 'make setup-dev' to create environment with uv${NC}"
|
||||
fi
|
||||
fi
|
||||
|
||||
# Check if requirements are installed
|
||||
info "Checking dependencies..."
|
||||
|
||||
MISSING_DEPS=()
|
||||
REQUIRED_PACKAGES=("fastapi" "uvicorn" "click" "pydantic" "jinja2")
|
||||
|
||||
for package in "${REQUIRED_PACKAGES[@]}"; do
|
||||
if ! python3 -c "import ${package}" 2>/dev/null; then
|
||||
MISSING_DEPS+=("${package}")
|
||||
fi
|
||||
done
|
||||
|
||||
if [[ ${#MISSING_DEPS[@]} -gt 0 ]]; then
|
||||
echo -e "${YELLOW}Missing dependencies: ${MISSING_DEPS[*]}${NC}"
|
||||
echo -e "${YELLOW}Installing dependencies with uv...${NC}"
|
||||
|
||||
if ! uv pip install -r requirements.txt; then
|
||||
echo -e "${RED}Error: Failed to install dependencies with uv${NC}"
|
||||
echo "You may need to:"
|
||||
echo "1. Create a virtual environment: uv venv"
|
||||
echo "2. Activate it: source .venv/bin/activate"
|
||||
echo "3. Install dependencies: uv pip install -r requirements.txt"
|
||||
echo "4. Or run 'make setup-dev' for complete setup"
|
||||
exit 1
|
||||
fi
|
||||
success "Dependencies installed"
|
||||
else
|
||||
success "Dependencies already installed"
|
||||
fi
|
||||
|
||||
# Check if port is available
|
||||
if ! check_port "${PORT}"; then
|
||||
echo -e "${YELLOW}Warning: Port ${PORT} appears to be in use${NC}"
|
||||
echo "The server may fail to start if another process is using this port."
|
||||
read -p "Continue anyway? (y/N): " -n 1 -r
|
||||
echo
|
||||
if [[ ! $REPLY =~ ^[Yy]$ ]]; then
|
||||
echo "Aborted."
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# Build uvicorn command
|
||||
UVICORN_CMD="python3 -m uvicorn app.main:app --host ${HOST} --port ${PORT} --log-level ${LOG_LEVEL}"
|
||||
|
||||
if [[ "${RELOAD}" == "true" ]]; then
|
||||
UVICORN_CMD="${UVICORN_CMD} --reload"
|
||||
fi
|
||||
|
||||
# Print server info
|
||||
echo ""
|
||||
echo -e "${GREEN}Starting UnitForge server...${NC}"
|
||||
echo -e "${BLUE}Host:${NC} ${HOST}"
|
||||
echo -e "${BLUE}Port:${NC} ${PORT}"
|
||||
echo -e "${BLUE}Auto-reload:${NC} ${RELOAD}"
|
||||
echo -e "${BLUE}Log level:${NC} ${LOG_LEVEL}"
|
||||
echo -e "${BLUE}Package manager:${NC} uv"
|
||||
echo ""
|
||||
echo -e "${GREEN}Server will be available at:${NC}"
|
||||
if [[ "${HOST}" == "0.0.0.0" ]]; then
|
||||
echo -e " ${BLUE}http://localhost:${PORT}${NC}"
|
||||
echo -e " ${BLUE}http://127.0.0.1:${PORT}${NC}"
|
||||
else
|
||||
echo -e " ${BLUE}http://${HOST}:${PORT}${NC}"
|
||||
fi
|
||||
echo ""
|
||||
echo -e "${GREEN}API Documentation:${NC}"
|
||||
if [[ "${HOST}" == "0.0.0.0" ]]; then
|
||||
echo -e " ${BLUE}http://localhost:${PORT}/api/docs${NC}"
|
||||
else
|
||||
echo -e " ${BLUE}http://${HOST}:${PORT}/api/docs${NC}"
|
||||
fi
|
||||
echo ""
|
||||
echo -e "${YELLOW}Press Ctrl+C to stop the server${NC}"
|
||||
echo ""
|
||||
|
||||
# Set up signal handling for graceful shutdown
|
||||
trap 'echo -e "\n${YELLOW}Shutting down UnitForge server...${NC}"; exit 0' INT TERM
|
||||
|
||||
# Start the server
|
||||
exec ${UVICORN_CMD}
|
||||
@@ -0,0 +1,57 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Test script to output template data as JSON for debugging the templates page.
|
||||
"""
|
||||
|
||||
import json
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
# Add backend to path
|
||||
sys.path.insert(0, str(Path(__file__).parent / "backend"))
|
||||
|
||||
try:
|
||||
from app.core.templates import template_registry
|
||||
|
||||
def template_to_dict(template):
|
||||
"""Convert UnitTemplate to dictionary."""
|
||||
parameters = []
|
||||
for param in template.parameters:
|
||||
param_dict = {
|
||||
"name": param.name,
|
||||
"description": param.description,
|
||||
"type": param.parameter_type,
|
||||
"required": param.required,
|
||||
"default": param.default,
|
||||
"choices": param.choices,
|
||||
"example": param.example,
|
||||
}
|
||||
parameters.append(param_dict)
|
||||
|
||||
return {
|
||||
"name": template.name,
|
||||
"description": template.description,
|
||||
"unit_type": template.unit_type.value,
|
||||
"category": template.category,
|
||||
"parameters": parameters,
|
||||
"tags": template.tags or [],
|
||||
}
|
||||
|
||||
# Get all templates
|
||||
templates = template_registry.list_templates()
|
||||
template_data = [template_to_dict(template) for template in templates]
|
||||
|
||||
print("Available templates:")
|
||||
print(json.dumps(template_data, indent=2))
|
||||
|
||||
print(f"\nTotal templates: {len(template_data)}")
|
||||
|
||||
# Show categories
|
||||
categories = set(t["category"] for t in template_data)
|
||||
print(f"Categories: {sorted(categories)}")
|
||||
|
||||
except Exception as e:
|
||||
print(f"Error: {e}")
|
||||
import traceback
|
||||
|
||||
traceback.print_exc()
|
||||
@@ -0,0 +1,298 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Tests for the systemd unit file parser and validator.
|
||||
"""
|
||||
|
||||
from backend.app.core.unit_file import SystemdUnitFile, UnitType, create_unit_file
|
||||
|
||||
|
||||
class TestSystemdUnitFile:
|
||||
"""Test cases for the SystemdUnitFile class."""
|
||||
|
||||
def test_parse_simple_service(self):
|
||||
"""Test parsing a simple service unit file."""
|
||||
content = """[Unit]
|
||||
Description=Test Service
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
ExecStart=/usr/bin/test
|
||||
User=testuser
|
||||
Restart=on-failure
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
"""
|
||||
unit = SystemdUnitFile(content=content)
|
||||
assert unit.get_unit_type() == UnitType.SERVICE
|
||||
|
||||
info = unit.get_info()
|
||||
assert info.description == "Test Service"
|
||||
assert info.unit_type == UnitType.SERVICE
|
||||
|
||||
def test_validate_valid_service(self):
|
||||
"""Test validation of a valid service unit file."""
|
||||
content = """[Unit]
|
||||
Description=Valid Service
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
ExecStart=/usr/bin/valid-service
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
"""
|
||||
unit = SystemdUnitFile(content=content)
|
||||
errors = unit.validate()
|
||||
|
||||
# Should have no errors
|
||||
error_list = [e for e in errors if e.severity == "error"]
|
||||
assert len(error_list) == 0
|
||||
|
||||
def test_validate_invalid_service_type(self):
|
||||
"""Test validation catches invalid service type."""
|
||||
content = """[Unit]
|
||||
Description=Invalid Service
|
||||
|
||||
[Service]
|
||||
Type=invalid-type
|
||||
ExecStart=/usr/bin/test
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
"""
|
||||
unit = SystemdUnitFile(content=content)
|
||||
errors = unit.validate()
|
||||
|
||||
# Should have an error about invalid service type
|
||||
error_list = [e for e in errors if e.severity == "error"]
|
||||
assert len(error_list) > 0
|
||||
assert any("Invalid service type" in e.message for e in error_list)
|
||||
|
||||
def test_validate_missing_exec_start(self):
|
||||
"""Test validation catches missing ExecStart for simple service."""
|
||||
content = """[Unit]
|
||||
Description=Missing ExecStart
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=testuser
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
"""
|
||||
unit = SystemdUnitFile(content=content)
|
||||
errors = unit.validate()
|
||||
|
||||
# Should have an error about missing ExecStart
|
||||
error_list = [e for e in errors if e.severity == "error"]
|
||||
assert len(error_list) > 0
|
||||
assert any("ExecStart" in e.message for e in error_list)
|
||||
|
||||
def test_parse_timer_unit(self):
|
||||
"""Test parsing a timer unit file."""
|
||||
content = """[Unit]
|
||||
Description=Test Timer
|
||||
|
||||
[Timer]
|
||||
OnCalendar=daily
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
"""
|
||||
unit = SystemdUnitFile(content=content)
|
||||
assert unit.get_unit_type() == UnitType.TIMER
|
||||
|
||||
def test_validate_timer_missing_schedule(self):
|
||||
"""Test validation catches timer without schedule."""
|
||||
content = """[Unit]
|
||||
Description=Timer without schedule
|
||||
|
||||
[Timer]
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
"""
|
||||
unit = SystemdUnitFile(content=content)
|
||||
errors = unit.validate()
|
||||
|
||||
# Should have an error about missing timer specification
|
||||
error_list = [e for e in errors if e.severity == "error"]
|
||||
assert len(error_list) > 0
|
||||
assert any("timing specification" in e.message.lower() for e in error_list)
|
||||
|
||||
def test_parse_socket_unit(self):
|
||||
"""Test parsing a socket unit file."""
|
||||
content = """[Unit]
|
||||
Description=Test Socket
|
||||
|
||||
[Socket]
|
||||
ListenStream=127.0.0.1:8080
|
||||
SocketUser=www-data
|
||||
|
||||
[Install]
|
||||
WantedBy=sockets.target
|
||||
"""
|
||||
unit = SystemdUnitFile(content=content)
|
||||
assert unit.get_unit_type() == UnitType.SOCKET
|
||||
|
||||
def test_validate_socket_missing_listen(self):
|
||||
"""Test validation catches socket without listen specification."""
|
||||
content = """[Unit]
|
||||
Description=Socket without listen
|
||||
|
||||
[Socket]
|
||||
SocketUser=www-data
|
||||
|
||||
[Install]
|
||||
WantedBy=sockets.target
|
||||
"""
|
||||
unit = SystemdUnitFile(content=content)
|
||||
errors = unit.validate()
|
||||
|
||||
# Should have an error about missing listen specification
|
||||
error_list = [e for e in errors if e.severity == "error"]
|
||||
assert len(error_list) > 0
|
||||
assert any("Listen specification" in e.message for e in error_list)
|
||||
|
||||
def test_set_and_get_values(self):
|
||||
"""Test setting and getting values in unit file."""
|
||||
unit = SystemdUnitFile()
|
||||
|
||||
unit.set_value("Unit", "Description", "Test Description")
|
||||
unit.set_value("Service", "Type", "simple")
|
||||
unit.set_value("Service", "ExecStart", "/usr/bin/test")
|
||||
|
||||
assert unit.get_value("Unit", "Description") == "Test Description"
|
||||
assert unit.get_value("Service", "Type") == "simple"
|
||||
assert unit.get_value("Service", "ExecStart") == "/usr/bin/test"
|
||||
|
||||
def test_remove_key(self):
|
||||
"""Test removing keys from unit file."""
|
||||
unit = SystemdUnitFile()
|
||||
unit.set_value("Service", "User", "testuser")
|
||||
|
||||
assert unit.get_value("Service", "User") == "testuser"
|
||||
|
||||
removed = unit.remove_key("Service", "User")
|
||||
assert removed is True
|
||||
assert unit.get_value("Service", "User") is None
|
||||
|
||||
def test_to_string(self):
|
||||
"""Test converting unit file back to string format."""
|
||||
unit = SystemdUnitFile()
|
||||
unit.set_value("Unit", "Description", "Test Service")
|
||||
unit.set_value("Service", "Type", "simple")
|
||||
unit.set_value("Service", "ExecStart", "/usr/bin/test")
|
||||
unit.set_value("Install", "WantedBy", "multi-user.target")
|
||||
|
||||
content = unit.to_string()
|
||||
|
||||
assert "[Unit]" in content
|
||||
assert "Description=Test Service" in content
|
||||
assert "[Service]" in content
|
||||
assert "Type=simple" in content
|
||||
assert "ExecStart=/usr/bin/test" in content
|
||||
assert "[Install]" in content
|
||||
assert "WantedBy=multi-user.target" in content
|
||||
|
||||
def test_validate_time_span(self):
|
||||
"""Test time span validation."""
|
||||
unit = SystemdUnitFile()
|
||||
|
||||
# Valid time spans
|
||||
valid_content = """[Service]
|
||||
TimeoutStartSec=30s
|
||||
RestartSec=5min
|
||||
"""
|
||||
unit = SystemdUnitFile(content=valid_content)
|
||||
errors = unit.validate()
|
||||
time_errors = [e for e in errors if "time span" in e.message.lower()]
|
||||
assert len(time_errors) == 0
|
||||
|
||||
# Invalid time span
|
||||
invalid_content = """[Service]
|
||||
TimeoutStartSec=invalid-time
|
||||
"""
|
||||
unit = SystemdUnitFile(content=invalid_content)
|
||||
errors = unit.validate()
|
||||
time_errors = [e for e in errors if "time span" in e.message.lower()]
|
||||
assert len(time_errors) > 0
|
||||
|
||||
|
||||
class TestCreateUnitFile:
|
||||
"""Test cases for the create_unit_file function."""
|
||||
|
||||
def test_create_simple_service(self):
|
||||
"""Test creating a simple service unit file."""
|
||||
unit = create_unit_file(
|
||||
UnitType.SERVICE,
|
||||
description="Test Service",
|
||||
exec_start="/usr/bin/test",
|
||||
user="testuser",
|
||||
restart="on-failure",
|
||||
)
|
||||
|
||||
assert unit.get_unit_type() == UnitType.SERVICE
|
||||
assert unit.get_value("Unit", "Description") == "Test Service"
|
||||
assert unit.get_value("Service", "ExecStart") == "/usr/bin/test"
|
||||
assert unit.get_value("Service", "User") == "testuser"
|
||||
assert unit.get_value("Service", "Restart") == "on-failure"
|
||||
|
||||
def test_create_timer_unit(self):
|
||||
"""Test creating a timer unit file."""
|
||||
unit = create_unit_file(
|
||||
UnitType.TIMER,
|
||||
description="Test Timer",
|
||||
on_calendar="daily",
|
||||
persistent=True,
|
||||
)
|
||||
|
||||
assert unit.get_unit_type() == UnitType.TIMER
|
||||
assert unit.get_value("Unit", "Description") == "Test Timer"
|
||||
assert unit.get_value("Timer", "OnCalendar") == "daily"
|
||||
assert unit.get_value("Timer", "Persistent") == "true"
|
||||
|
||||
def test_create_socket_unit(self):
|
||||
"""Test creating a socket unit file."""
|
||||
unit = create_unit_file(
|
||||
UnitType.SOCKET, description="Test Socket", listen_stream="127.0.0.1:8080"
|
||||
)
|
||||
|
||||
assert unit.get_unit_type() == UnitType.SOCKET
|
||||
assert unit.get_value("Unit", "Description") == "Test Socket"
|
||||
assert unit.get_value("Socket", "ListenStream") == "127.0.0.1:8080"
|
||||
|
||||
def test_create_mount_unit(self):
|
||||
"""Test creating a mount unit file."""
|
||||
unit = create_unit_file(
|
||||
UnitType.MOUNT,
|
||||
description="Test Mount",
|
||||
what="/dev/sdb1",
|
||||
where="/mnt/data",
|
||||
type="ext4",
|
||||
)
|
||||
|
||||
assert unit.get_unit_type() == UnitType.MOUNT
|
||||
assert unit.get_value("Unit", "Description") == "Test Mount"
|
||||
assert unit.get_value("Mount", "What") == "/dev/sdb1"
|
||||
assert unit.get_value("Mount", "Where") == "/mnt/data"
|
||||
assert unit.get_value("Mount", "Type") == "ext4"
|
||||
|
||||
def test_create_with_dependencies(self):
|
||||
"""Test creating unit file with dependencies."""
|
||||
unit = create_unit_file(
|
||||
UnitType.SERVICE,
|
||||
description="Service with dependencies",
|
||||
exec_start="/usr/bin/test",
|
||||
requires=["database.service"],
|
||||
wants=["network.service"],
|
||||
after=["network.target", "database.service"],
|
||||
)
|
||||
|
||||
assert unit.get_value("Unit", "Requires") == "database.service"
|
||||
assert unit.get_value("Unit", "Wants") == "network.service"
|
||||
assert unit.get_value("Unit", "After") == "network.target database.service"
|
||||
Executable
+28
@@ -0,0 +1,28 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
UnitForge CLI Entry Point
|
||||
|
||||
This script provides a convenient way to run the UnitForge CLI tool
|
||||
without requiring installation via pip.
|
||||
"""
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
# Add the backend directory to the Python path
|
||||
script_dir = Path(__file__).parent
|
||||
backend_dir = script_dir / "backend"
|
||||
sys.path.insert(0, str(backend_dir))
|
||||
|
||||
try:
|
||||
from cli import cli
|
||||
except ImportError as e:
|
||||
print(f"Error importing CLI module: {e}", file=sys.stderr)
|
||||
print(
|
||||
"Make sure you're running this script from the unitforge directory.",
|
||||
file=sys.stderr,
|
||||
)
|
||||
sys.exit(1)
|
||||
|
||||
if __name__ == "__main__":
|
||||
cli()
|
||||
Reference in New Issue
Block a user