内容
# Test Results Manager - TypeScript Edition
A comprehensive Node.js Express server for managing test results with TypeScript, Prisma database operations, MVC architecture, and Model Context Protocol (MCP) integration.
## Features
- 🚀 **TypeScript**: Full type safety and modern development experience
- 🏗️ **MVC Architecture**: Clean separation with models, controllers, and services
- 🗄️ **Prisma ORM**: Type-safe database operations with PostgreSQL
- 🔧 **MCP Integration**: Model Context Protocol for advanced tool interactions
- 📊 **Test Analytics**: Comprehensive test result tracking and analysis
- 🔍 **Error Analysis**: Automated error pattern recognition and categorization
- 🎯 **RESTful API**: Well-structured API endpoints for all operations
- 🐳 **Docker Support**: PostgreSQL database with Docker Compose
## Setup Instructions
### Prerequisites
- Node.js 18+
- npm 8+
- Docker and Docker Compose
### Installation
1. **Clone and install dependencies:**
```sh
git clone <repository-url>
cd test-portal-be
npm install
```
2. **Start PostgreSQL with Docker:**
```sh
docker-compose up -d postgres
```
3. **Create a `.env` file** in the root of the project:
```env
DATABASE_URL="postgresql://postgres:postgres@localhost:5433/test_portal"
PORT=3001
NODE_ENV=development
AUTH_PROVIDER=local
```
4. **Initialize Prisma and set up the database:**
```sh
npx prisma migrate dev --name "initial-postgresql-migration"
```
5. **Build and run the server:**
```sh
# Development mode with hot reloading
npm run dev
# Production build
npm run build
npm run server
```
6. **Seed persisted skill packages** (optional):
```sh
npm run seed
```
This command idempotently seeds the system skill packages. Container-based
deployments run the same seeder automatically at startup.
7. **Verify installation:**
Open `http://localhost:3001/api/v2/results` in your browser
## Development Scripts
```sh
# Development with hot reloading
npm run dev
# Type checking
npm run type-check
# Unit tests
npm test # runs Jest via ts-jest
# Build for production
npm run build
# Production server
npm run server
# Linting and code quality
npm run lint
# Database operations
npm run migrate
npm run db:generate
# Docker operations
docker-compose up -d postgres # Start PostgreSQL
docker-compose down # Stop all services
docker-compose logs postgres # View PostgreSQL logs
```
## Prompt Tests
Datasets must be generated first.
See __prompts-tests__/README.md for prompt test commands.
## TypeScript Features
- **Strict type checking** with comprehensive type definitions
- **Path aliases** (`@/*`) for clean imports
- **ES modules** support with proper Node.js configuration
- **Prisma integration** with generated types
- **ESLint configuration** with TypeScript rules
- **Development experience** optimized with tsx and nodemon
## Project Structure
```
src/
├── controllers/ # Express route handlers
├── services/ # Business logic layer
├── models/ # Database access layer
├── routes/ # API route definitions
├── handlers/ # MCP request handlers
├── mcp/ # Model Context Protocol integration
│ ├── tools/ # MCP tool definitions
│ ├── schemas/ # Zod validation schemas
│ └── helpers/ # MCP utility functions
├── lib/ # Utility libraries
├── types/ # TypeScript type definitions
└── middleware/ # Express middleware
```
## API Endpoints
### Authentication
- `GET /api/v2/auth/config` - Discover the active auth provider and capability flags
- `POST /api/v2/auth/signup` - Sign up through the configured provider
- `POST /api/v2/auth/login` - Login through the configured provider
- `POST /api/v2/auth/refresh-token` - Exchange a refresh token for new internal JWTs
- `POST /api/v2/auth/logout` - Logout through the configured provider
### Core Resources
- `GET /api/v2/results` - Get test results with filtering
- `GET /api/v2/executions` - Get test executions
- `GET /api/v2/specs` - Get test specifications
- `GET /api/v2/issues` - Get identified issues
- `GET /api/v2/assumptions` - Get error assumptions
### Analysis & Reports
- `POST /api/v2/upload-json-report` - Upload a JSON test report using JWT authentication
- `POST /api/v2/upload-json-report-api-key` - Upload a JSON test report using API key authentication
- `POST /api/v2/result-errors/:id/review` - Analyze error patterns
- `PUT /api/v2/result-errors/:id/assign` - Assign issue to error
### Status & Health
- `GET /api/v2/status` - System health check
## Documentation
- **[Development Guide](docs/DEVELOPMENT_GUIDE.md)** - Complete setup and development guide
- [API Documentation](docs/API_DOCUMENTATION.md)
- [How to Inspect the MCP Server](docs/INSPECT_MCP_SERVER.md)
- [MCP Tools Documentation](docs/MCP_TOOLS.md)
- [Docker Deployment Guide](docs/DOCKER.md)
- [Release Guide](docs/RELEASE.md)
- [Contributing Guide](CONTRIBUTING.md)
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for the contributor workflow, including the `npm run new:file -- <path>` command for supported new source files.
To backfill the standard Apache 2.0 header across existing supported files in `src`, `__tests__`, and `__prompts-tests__`, run `npm run headers:add`.
This project uses TypeScript with strict type checking. Please ensure:
1. All code passes TypeScript compilation (`npm run type-check`)
2. ESLint passes without errors (`npm run lint`)
3. Follow the established patterns for types and interfaces
4. Use path aliases (`@/*`) for internal imports
## License
This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for the full text and [NOTICE](NOTICE) for the project copyright notice.
MCP 市场