GeneralBots/bottest
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update PROMPT.md

Browse source
This commit is contained in:
Rodrigo Rodriguez (Pragmatismo) 2026-01-22 20:24:08 -03:00
parent 05446c6716
commit 899b433529
1 changed files with 33 additions and 190 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

223
PROMPT.md
View file

@ -1,150 +1,34 @@
# BotTest Development Prompt # BotTest Development Guide
**Version:** 6.1.0 **Version:** 6.2.0
**Purpose:** Test infrastructure for General Bots ecosystem **Purpose:** Test infrastructure for General Bots ecosystem
--- ---
## ZERO TOLERANCE POLICY ## ZERO TOLERANCE POLICY
**This project has the strictest code quality requirements possible.**
**EVERY SINGLE WARNING MUST BE FIXED. NO EXCEPTIONS.** **EVERY SINGLE WARNING MUST BE FIXED. NO EXCEPTIONS.**
--- ---
## ABSOLUTE PROHIBITIONS ## ❌ ABSOLUTE PROHIBITIONS
``` ```
❌ NEVER use #![allow()] or #[allow()] to silence warnings ❌ NEVER use #![allow()] or #[allow()] in source code
❌ NEVER use _ prefix for unused variables - DELETE the variable or USE it ❌ NEVER use _ prefix for unused variables - DELETE or USE them
❌ NEVER use .unwrap() - use ? or proper error handling ❌ NEVER use .unwrap() - use ? or proper error handling
❌ NEVER use .expect() - use ? or proper error handling ❌ NEVER use .expect() - use ? or proper error handling
❌ NEVER use panic!() or unreachable!() - handle all cases ❌ NEVER use panic!() or unreachable!()
❌ NEVER use todo!() or unimplemented!() - write real code ❌ NEVER use todo!() or unimplemented!()
❌ NEVER leave unused imports - DELETE them ❌ NEVER leave unused imports or dead code
❌ NEVER leave dead code - DELETE it or IMPLEMENT it ❌ NEVER add comments - code must be self-documenting
❌ NEVER use approximate constants (3.14159) - use std::f64::consts::PI
❌ NEVER silence clippy - FIX THE CODE
❌ NEVER add comments explaining what code does - code must be self-documenting
``` ```
--- ---
## MANDATORY CODE PATTERNS ## 🏗️ ARCHITECTURE
### Error Handling - Use `?` Operator E2E tests use `USE_BOTSERVER_BOOTSTRAP=1` mode. The botserver handles all service installation during bootstrap.
```rust
// ❌ WRONG
let value = something.unwrap();
let value = something.expect("msg");
// ✅ CORRECT
let value = something?;
let value = something.ok_or_else(|| Error::NotFound)?;
```
### Self Usage in Impl Blocks
```rust
// ❌ WRONG
impl MyStruct {
fn new() -> MyStruct { MyStruct { } }
}
// ✅ CORRECT
impl MyStruct {
fn new() -> Self { Self { } }
}
```
### Format Strings - Inline Variables
```rust
// ❌ WRONG
format!("Hello {}", name)
// ✅ CORRECT
format!("Hello {name}")
```
### Derive Eq with PartialEq
```rust
// ❌ WRONG
#[derive(PartialEq)]
struct MyStruct { }
// ✅ CORRECT
#[derive(PartialEq, Eq)]
struct MyStruct { }
```
---
## Weekly Maintenance - EVERY MONDAY
### Package Review Checklist
**Every Monday, review the following:**
1. **Dependency Updates**
```bash
cargo outdated
cargo audit
```
2. **Package Consolidation Opportunities**
- Check if new crates can replace custom code
- Look for crates that combine multiple dependencies
- Review `Cargo.toml` for redundant dependencies
3. **Code Reduction Candidates**
- Custom mock implementations that can use crates
- Test utilities that have crate equivalents
- Boilerplate that can be replaced with macros
4. **Test Infrastructure Updates**
- Check for new testing patterns
- Review mock server libraries
- Update fixture generation approaches
### Packages to Watch
| Area | Potential Packages | Purpose |
|------|-------------------|---------|
| Mocking | `wiremock`, `mockall` | Simplify mock creation |
| Assertions | `assertables`, `pretty_assertions` | Better test output |
| Fixtures | `fake`, `proptest` | Generate test data |
| Async Testing | `tokio-test` | Async test utilities |
---
## CRITICAL RULE
🚫 **NO .md FILES IN ROOT OF ANY PROJECT**
All documentation goes in `botbook/src/17-testing/`:
- `README.md` - Testing overview
- `e2e-testing.md` - E2E test guide
- `architecture.md` - Testing architecture
- `performance.md` - Performance testing
- `best-practices.md` - Best practices
This PROMPT.md is the ONLY exception (it's for developers).
---
## Core Principle
**Reuse botserver bootstrap code** - Don't duplicate installation logic. The bootstrap module already knows how to install PostgreSQL, MinIO, Redis. We wrap it with test-specific configuration (custom ports, temp directories).
---
## Architecture
**IMPORTANT:** E2E tests always use `USE_BOTSERVER_BOOTSTRAP=1` mode. No global PostgreSQL or other services are required. The botserver handles all service installation during bootstrap.
``` ```
TestHarness::full() / E2E Tests TestHarness::full() / E2E Tests
@ -163,38 +47,17 @@ TestHarness::full() / E2E Tests
│ └── Redis (cache) │ └── Redis (cache)
│ │
└── Return TestContext └── Return TestContext
TestContext provides:
- db_pool() -> Database connection
- minio_client() -> S3 client
- redis_client() -> Redis client
- mock_*() -> Mock server controls
On Drop:
- Stop all services
- Remove temp directory
``` ```
--- ---
## Code Style ## 🧪 TEST CATEGORIES
Same as botserver PROMPT.md:
- KISS, NO TALK, SECURED CODE ONLY
- No comments, no placeholders
- Complete, production-ready code
- Return 0 warnings
---
## Test Categories
### Unit Tests (no services) ### Unit Tests (no services)
```rust ```rust
#[test] #[test]
fn test_pure_logic() { fn test_pure_logic() {
// No TestHarness needed // No TestHarness needed
// Test pure functions directly
} }
``` ```
@ -202,8 +65,8 @@ fn test_pure_logic() {
```rust ```rust
#[tokio::test] #[tokio::test]
async fn test_with_database() { async fn test_with_database() {
let ctx = TestHarness::quick().await.unwrap(); let ctx = TestHarness::quick().await?;
let pool = ctx.db_pool().await.unwrap(); let pool = ctx.db_pool().await?;
// Use real database // Use real database
} }
``` ```
@ -212,16 +75,16 @@ async fn test_with_database() {
```rust ```rust
#[tokio::test] #[tokio::test]
async fn test_user_flow() { async fn test_user_flow() {
let ctx = TestHarness::full().await.unwrap(); let ctx = TestHarness::full().await?;
let server = ctx.start_botserver().await.unwrap(); let server = ctx.start_botserver().await?;
let browser = Browser::new().await.unwrap(); let browser = Browser::new().await?;
// Automate browser // Automate browser
} }
``` ```
--- ---
## Mock Server Patterns ## 🎭 MOCK SERVER PATTERNS
### Expect specific calls ### Expect specific calls
```rust ```rust
@ -240,7 +103,7 @@ ctx.mock_llm().next_call_fails(500, "Internal error");
--- ---
## Fixture Patterns ## 🏭 FIXTURE PATTERNS
### Factory functions ### Factory functions
```rust ```rust
@ -257,16 +120,7 @@ ctx.insert(&bot).await;
--- ---
## Cleanup ## ⚡ PARALLEL SAFETY
Always automatic via Drop trait. But can force:
```rust
ctx.cleanup().await; // Explicit cleanup
```
---
## Parallel Safety
- Each test gets unique ports via PortAllocator - Each test gets unique ports via PortAllocator
- Each test gets unique temp directory - Each test gets unique temp directory
@ -275,34 +129,23 @@ ctx.cleanup().await; // Explicit cleanup
--- ---
## Documentation Location ## 📖 DOCUMENTATION LOCATION
For guides, tutorials, and reference: All documentation goes in `botbook/src/17-testing/`:
→ Use `botbook/src/17-testing/` - `README.md` - Testing overview
- `e2e-testing.md` - E2E test guide
Examples: - `architecture.md` - Testing architecture
- E2E testing setup → `botbook/src/17-testing/e2e-testing.md` - `best-practices.md` - Best practices
- Architecture details → `botbook/src/17-testing/architecture.md`
- Performance tips → `botbook/src/17-testing/performance.md`
Never create .md files at:
- ✗ Root of bottest/
- ✗ Root of botserver/
- ✗ Root of botapp/
- ✗ Any project root
All non-PROMPT.md documentation belongs in botbook.
--- ---
## Remember ## 🔑 REMEMBER
- **ZERO WARNINGS** - Every clippy warning must be fixed - **ZERO WARNINGS** - Every clippy warning must be fixed
- **NO ALLOW ATTRIBUTES** - Never silence warnings, fix the code - **NO ALLOW ATTRIBUTES** - Never silence warnings
- **NO DEAD CODE** - Delete unused code, never prefix with _ - **NO DEAD CODE** - Delete unused code
- **NO UNWRAP/EXPECT** - Use ? operator or proper error handling - **NO UNWRAP/EXPECT** - Use ? operator
- **INLINE FORMAT ARGS** - format!("{name}") not format!("{}", name) - **INLINE FORMAT ARGS** - `format!("{name}")` not `format!("{}", name)`
- **USE SELF** - In impl blocks, use Self not the type name - **USE SELF** - In impl blocks, use Self not the type name
- **DERIVE EQ** - Always derive Eq with PartialEq - **Reuse bootstrap** - Don't duplicate botserver installation logic
- **Version**: Always 6.1.0 - do not change without approval - **Version 6.2.0** - do not change without approval
- **Session Continuation**: When running out of context, create detailed summary: (1) what was done, (2) what remains, (3) specific files and line numbers, (4) exact next steps.