220 lines
4.8 KiB
Markdown
220 lines
4.8 KiB
Markdown
# 🚀 ASF TestArena - START HERE
|
|
|
|
Welcome to ASF TestArena! This document will get you up and running quickly.
|
|
|
|
## 📋 What You Have
|
|
|
|
✅ **Complete Phase 1 Implementation**
|
|
- Login system with authentication
|
|
- Modern gradient theme with your logo
|
|
- Admin dashboard for user management
|
|
- User dashboard with job list and details
|
|
- 5-step job submission workflow
|
|
- Docker Compose setup with PostgreSQL
|
|
- Caddy reverse proxy integration ready
|
|
|
|
## 🎯 Quick Start (3 Steps)
|
|
|
|
### Step 1: Configure Environment (Optional)
|
|
|
|
Edit `.env` file if you want to change default passwords:
|
|
```bash
|
|
cp .env.example .env
|
|
# Edit .env with your preferred values
|
|
```
|
|
|
|
### Step 2: Deploy the Application
|
|
|
|
**Windows (PowerShell):**
|
|
```powershell
|
|
.\deploy.ps1
|
|
```
|
|
|
|
**Windows (CMD):**
|
|
```bash
|
|
start.bat
|
|
```
|
|
|
|
**Linux/Mac:**
|
|
```bash
|
|
chmod +x deploy.sh
|
|
./deploy.sh
|
|
```
|
|
|
|
The deployment script will:
|
|
- Check prerequisites (Docker, Docker Compose)
|
|
- Create Caddy network if needed
|
|
- Build and start containers
|
|
- Verify everything is running
|
|
|
|
### Step 3: Login
|
|
|
|
- URL: https://testarena.nabd-co.com
|
|
- Username: `admin`
|
|
- Password: `admin123`
|
|
|
|
⚠️ **Change the password immediately!**
|
|
|
|
## 📚 Documentation
|
|
|
|
| Document | Purpose |
|
|
|----------|---------|
|
|
| **QUICK_START.md** | Fast reference guide |
|
|
| **SETUP.md** | Detailed setup instructions |
|
|
| **CADDY_INTEGRATION.md** | Caddy configuration guide |
|
|
| **PROJECT_STATUS.md** | Implementation status |
|
|
| **DEPLOYMENT_CHECKLIST.md** | Pre-deployment checklist |
|
|
| **README.md** | General overview |
|
|
|
|
## 🎨 Features Implemented
|
|
|
|
### 1. Login Page
|
|
- Clean, modern design
|
|
- Your logo (icon.png)
|
|
- Secure authentication
|
|
|
|
### 2. Admin Dashboard
|
|
- Create users with roles (Admin/User)
|
|
- Reset user passwords
|
|
- Delete users
|
|
- View all jobs
|
|
|
|
### 3. User Dashboard
|
|
- **Left Panel:** Job list with status icons
|
|
- 🟢 Passed
|
|
- 🔴 Failed
|
|
- 🟠 In Progress
|
|
- ⚫ Aborted
|
|
- **Right Panel:** Detailed job information
|
|
- Submit new jobs button
|
|
|
|
### 4. Submit Workflow
|
|
1. Enter Git branch name
|
|
2. Select test scenarios (checkboxes)
|
|
3. Choose environment (Sensor Hub / Main Board)
|
|
4. Select test mode (Simulator / HIL)
|
|
5. Configure options and submit
|
|
|
|
## 🔧 What's Next (Phase 2)
|
|
|
|
The following features need implementation:
|
|
|
|
1. **Git Integration**
|
|
- Branch checkout
|
|
- Scenario detection script
|
|
|
|
2. **Test Execution**
|
|
- Background job processing
|
|
- Real-time status updates
|
|
- Process management
|
|
|
|
3. **Results Management**
|
|
- HTML report generation
|
|
- Results storage
|
|
- 7-day auto cleanup
|
|
|
|
4. **Job Control**
|
|
- Abort running jobs
|
|
- Kill processes
|
|
|
|
## 📞 Need Help?
|
|
|
|
### Common Issues
|
|
|
|
**Can't access the site?**
|
|
- Check Docker is running: `docker ps`
|
|
- View logs: `docker-compose logs -f`
|
|
- Verify Caddy configuration
|
|
|
|
**Database errors?**
|
|
- Wait 30 seconds after startup
|
|
- Check logs: `docker-compose logs db`
|
|
|
|
**502 Bad Gateway?**
|
|
- Web container starting up - wait a moment
|
|
- Check: `docker-compose logs web`
|
|
|
|
### Useful Commands
|
|
|
|
```bash
|
|
# View logs
|
|
docker-compose logs -f
|
|
|
|
# Restart
|
|
docker-compose restart
|
|
|
|
# Stop
|
|
docker-compose down
|
|
|
|
# Rebuild
|
|
docker-compose up -d --build
|
|
```
|
|
|
|
## ✅ Testing Checklist
|
|
|
|
After deployment, test these:
|
|
|
|
- [ ] Login page loads
|
|
- [ ] Logo displays correctly
|
|
- [ ] Admin can login
|
|
- [ ] Admin can create users
|
|
- [ ] Admin can reset passwords
|
|
- [ ] Admin can delete users
|
|
- [ ] User can login
|
|
- [ ] User sees only their jobs
|
|
- [ ] Submit workflow works (all 5 steps)
|
|
- [ ] Jobs appear in dashboard
|
|
- [ ] Job details display correctly
|
|
|
|
## 🔐 Security
|
|
|
|
**Before going live:**
|
|
|
|
1. Change admin password
|
|
2. Update SECRET_KEY in docker-compose.yml
|
|
3. Update database password
|
|
4. Enable HTTPS via Caddy
|
|
5. Review firewall rules
|
|
|
|
## 📊 Project Structure
|
|
|
|
```
|
|
testarena/
|
|
├── app/ # Flask application
|
|
│ ├── routes/ # API endpoints
|
|
│ ├── templates/ # HTML pages
|
|
│ ├── static/ # CSS, images
|
|
│ └── models.py # Database models
|
|
├── docker-compose.yml # Container setup
|
|
├── Dockerfile # Web app image
|
|
├── requirements.txt # Python packages
|
|
└── wsgi.py # Entry point
|
|
```
|
|
|
|
## 🎉 You're Ready!
|
|
|
|
1. Read **QUICK_START.md** for immediate setup
|
|
2. Follow **DEPLOYMENT_CHECKLIST.md** before going live
|
|
3. Check **CADDY_INTEGRATION.md** for proxy setup
|
|
4. Review **PROJECT_STATUS.md** for implementation details
|
|
|
|
## 💡 Tips
|
|
|
|
- Use `start.bat` on Windows for easy startup
|
|
- Use `logs.bat` to monitor application logs
|
|
- Use `stop.bat` to shut down cleanly
|
|
- Check `SETUP.md` for troubleshooting
|
|
|
|
## 📧 Ready for Phase 2?
|
|
|
|
When you're ready to implement test execution, provide:
|
|
|
|
1. Your Caddy network name
|
|
2. Git repository details
|
|
3. Test execution scripts
|
|
4. Result format requirements
|
|
|
|
---
|
|
|
|
**Let's get started! Run `start.bat` or check QUICK_START.md**
|