add branch validation to queue
This commit is contained in:
227
asf-cloud-server/testarena_1/PHASE2_FEATURES.md
Normal file
227
asf-cloud-server/testarena_1/PHASE2_FEATURES.md
Normal file
@@ -0,0 +1,227 @@
|
||||
# Phase 2 Features - Implementation Summary
|
||||
|
||||
## ✅ Features Implemented
|
||||
|
||||
### 1. Right-Click Context Menu for Job Abortion
|
||||
|
||||
**Feature:** Users can right-click on "in_progress" jobs to abort them.
|
||||
|
||||
**Implementation:**
|
||||
- Added context menu that appears on right-click
|
||||
- Only shows for jobs with status "in_progress"
|
||||
- Clicking "Abort Job" marks the job as aborted (⚫ black icon)
|
||||
- Context menu automatically hides when clicking elsewhere
|
||||
|
||||
**Files Modified:**
|
||||
- `app/templates/dashboard/index.html` - Added context menu HTML and JavaScript
|
||||
- `app/static/css/style.css` - Added context menu styling
|
||||
|
||||
**Usage:**
|
||||
1. Right-click on any job with orange icon (in progress)
|
||||
2. Select "Abort Job" from the context menu
|
||||
3. Job status changes to aborted (black icon)
|
||||
|
||||
---
|
||||
|
||||
### 2. Git Branch Validation
|
||||
|
||||
**Feature:** Validates that the branch exists on remote before allowing job submission.
|
||||
|
||||
**Implementation:**
|
||||
- When user enters branch name and clicks "Validate Branch"
|
||||
- System executes SSH commands to remote server:
|
||||
1. `./TPF/gitea_repo_controller.sh clone` - Clones/updates repository
|
||||
2. `./TPF/gitea_repo_controller.sh checkout <branch_name>` - Checks out branch
|
||||
- Parses output to detect success or failure
|
||||
- Shows appropriate message to user
|
||||
|
||||
**Success Flow:**
|
||||
```
|
||||
User enters branch → Clicks "Validate Branch" →
|
||||
Loading indicator → SSH commands execute →
|
||||
Branch found → Green success message →
|
||||
"Next" button appears → User proceeds to scenario selection
|
||||
```
|
||||
|
||||
**Failure Flow:**
|
||||
```
|
||||
User enters branch → Clicks "Validate Branch" →
|
||||
Loading indicator → SSH commands execute →
|
||||
Branch not found (fatal: error) → Red error message →
|
||||
"Branch not found on remote. Please push the branch first." →
|
||||
User cannot proceed
|
||||
```
|
||||
|
||||
**Files Modified:**
|
||||
- `app/routes/jobs.py` - Added branch validation logic with SSH commands
|
||||
- `app/templates/jobs/submit.html` - Added AJAX validation and UI feedback
|
||||
- `app/static/css/style.css` - Added validation message styling
|
||||
- `Dockerfile` - Added sshpass package
|
||||
- `docker-compose.yml` - Added SSH environment variables
|
||||
- `.env.example` - Added SSH configuration template
|
||||
|
||||
**Configuration Required:**
|
||||
|
||||
Update these environment variables in `docker-compose.yml` or `.env`:
|
||||
```env
|
||||
SSH_PASSWORD=your_actual_password
|
||||
SSH_HOST=asfserver
|
||||
SSH_USER=asf
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Technical Details
|
||||
|
||||
### SSH Command Execution
|
||||
|
||||
The system uses `subprocess` to execute SSH commands:
|
||||
|
||||
```python
|
||||
# Clone repository
|
||||
clone_cmd = f"sshpass -p '{ssh_password}' ssh -o StrictHostKeyChecking=no {ssh_user}@{ssh_host} './TPF/gitea_repo_controller.sh clone'"
|
||||
|
||||
# Checkout branch
|
||||
checkout_cmd = f"sshpass -p '{ssh_password}' ssh -o StrictHostKeyChecking=no {ssh_user}@{ssh_host} './TPF/gitea_repo_controller.sh checkout {branch_name}'"
|
||||
```
|
||||
|
||||
### Error Detection
|
||||
|
||||
The system detects branch validation failures by checking for:
|
||||
- "fatal:" in stdout or stderr
|
||||
- Non-zero return code
|
||||
- Timeout (60 seconds)
|
||||
|
||||
### Security Considerations
|
||||
|
||||
⚠️ **Important:** The SSH password is stored in environment variables. For production:
|
||||
1. Use SSH keys instead of passwords
|
||||
2. Store credentials in a secure vault (e.g., HashiCorp Vault)
|
||||
3. Use encrypted environment variables
|
||||
4. Implement proper access controls
|
||||
|
||||
---
|
||||
|
||||
## 📋 Deployment Steps
|
||||
|
||||
### 1. Update Configuration
|
||||
|
||||
Edit `docker-compose.yml`:
|
||||
```yaml
|
||||
environment:
|
||||
SSH_PASSWORD: your_actual_password # Replace with real password
|
||||
SSH_HOST: asfserver # Your SSH host
|
||||
SSH_USER: asf # Your SSH user
|
||||
```
|
||||
|
||||
### 2. Rebuild Container
|
||||
|
||||
```bash
|
||||
docker-compose down
|
||||
docker-compose up -d --build
|
||||
```
|
||||
|
||||
### 3. Test Branch Validation
|
||||
|
||||
1. Go to Submit New Job
|
||||
2. Enter a valid branch name
|
||||
3. Click "Validate Branch"
|
||||
4. Should see green success message
|
||||
5. Try invalid branch - should see red error
|
||||
|
||||
### 4. Test Job Abortion
|
||||
|
||||
1. Create a job (it will be "in progress")
|
||||
2. Right-click on the job
|
||||
3. Select "Abort Job"
|
||||
4. Job icon should turn black (⚫)
|
||||
|
||||
---
|
||||
|
||||
## 🎨 UI/UX Improvements
|
||||
|
||||
### Context Menu
|
||||
- Clean, modern design
|
||||
- Smooth hover effects
|
||||
- Automatically positions near cursor
|
||||
- Closes when clicking elsewhere
|
||||
|
||||
### Branch Validation
|
||||
- Three states: Loading (yellow), Success (green), Error (red)
|
||||
- Loading spinner animation
|
||||
- Clear error messages
|
||||
- Disabled "Next" button until validation succeeds
|
||||
- Re-validation required if branch name changes
|
||||
|
||||
### Visual Feedback
|
||||
- ⚫ Black icon for aborted jobs
|
||||
- 🟠 Orange icon for in-progress jobs
|
||||
- 🟢 Green icon for passed jobs
|
||||
- 🔴 Red icon for failed jobs
|
||||
|
||||
---
|
||||
|
||||
## 🐛 Known Limitations
|
||||
|
||||
1. **SSH Password Security:** Currently stored in plain text environment variables
|
||||
2. **No Retry Logic:** If SSH command fails, user must manually retry
|
||||
3. **Timeout:** 60-second timeout for SSH commands
|
||||
4. **No Progress Bar:** User doesn't see detailed progress during validation
|
||||
5. **Single Server:** Only supports one SSH host
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Future Enhancements
|
||||
|
||||
### Suggested Improvements:
|
||||
1. **SSH Key Authentication:** Replace password with SSH keys
|
||||
2. **Retry Logic:** Automatic retry on transient failures
|
||||
3. **Progress Indicators:** Show detailed progress during validation
|
||||
4. **Multiple Servers:** Support for multiple SSH hosts
|
||||
5. **Caching:** Cache branch validation results
|
||||
6. **Webhooks:** Real-time notifications when branch is pushed
|
||||
7. **Batch Operations:** Abort multiple jobs at once
|
||||
8. **Job History:** Show abort history and who aborted
|
||||
|
||||
---
|
||||
|
||||
## 📞 Support
|
||||
|
||||
If you encounter issues:
|
||||
|
||||
1. **Branch Validation Fails:**
|
||||
- Check SSH credentials in docker-compose.yml
|
||||
- Verify sshpass is installed: `docker exec testarena_web which sshpass`
|
||||
- Check SSH connectivity: `docker exec testarena_web ssh asf@asfserver`
|
||||
- Review logs: `docker-compose logs web`
|
||||
|
||||
2. **Context Menu Not Showing:**
|
||||
- Ensure job status is "in_progress"
|
||||
- Check browser console for JavaScript errors
|
||||
- Clear browser cache
|
||||
|
||||
3. **Abort Not Working:**
|
||||
- Check logs: `docker-compose logs web`
|
||||
- Verify job exists in database
|
||||
- Check user permissions
|
||||
|
||||
---
|
||||
|
||||
## 📝 Testing Checklist
|
||||
|
||||
- [ ] Branch validation with valid branch
|
||||
- [ ] Branch validation with invalid branch
|
||||
- [ ] Branch validation timeout handling
|
||||
- [ ] Context menu appears on right-click
|
||||
- [ ] Context menu only shows for in-progress jobs
|
||||
- [ ] Abort job functionality works
|
||||
- [ ] Job icon changes to black after abort
|
||||
- [ ] Cannot proceed without valid branch
|
||||
- [ ] Re-validation required after branch name change
|
||||
- [ ] SSH commands execute successfully
|
||||
|
||||
---
|
||||
|
||||
**Implementation Date:** November 28, 2024
|
||||
**Version:** 1.1.0
|
||||
**Status:** ✅ Ready for Testing
|
||||
Reference in New Issue
Block a user