Claude Test Framework - Demo Project

中文文档 | English Documentation

Live demonstration project for the claude-test CLI framework - showcasing intelligent automation testing powered by Claude Code + Playwright MCP with natural language YAML-based testing, dynamic element targeting, multi-environment configuration, and session persistence.

🚀 About This Project

This is a demonstration and example project for the claude-test CLI tool. While this project contains working test cases and comprehensive documentation, the actual framework code and CLI commands have been moved to the official claude-test npm package.

🧠 How Playwright MCP Works - The Core Innovation

🎯 Revolutionary Element Targeting System

Unlike traditional Playwright automation that relies on fragile CSS selectors or XPath expressions, Playwright MCP uses a revolutionary dynamic element identification system:

flowchart TD
    A["🌐 Web Page Loaded"] --> B["🔍 Playwright MCP Scans Page"]
    B --> C["🏷️ Assigns Unique ref_id to Each Element"]
    C --> D["📋 Creates Accessibility Snapshot"]
    D --> E["🤖 Claude Code Receives Element Map"]
    E --> F["🗣️ User Writes Natural Language Step"]
    F --> G["🎯 Claude Matches Description to ref_id"]
    G --> H["⚡ Executes Precise Action"]
    
    style A fill:#4CAF50,stroke:#2E7D32,stroke-width:3px,color:#ffffff
    style B fill:#2196F3,stroke:#1565C0,stroke-width:3px,color:#ffffff
    style C fill:#FF9800,stroke:#F57C00,stroke-width:3px,color:#ffffff
    style D fill:#9C27B0,stroke:#6A1B9A,stroke-width:3px,color:#ffffff
    style E fill:#F44336,stroke:#C62828,stroke-width:3px,color:#ffffff
    style F fill:#607D8B,stroke:#37474F,stroke-width:3px,color:#ffffff
    style G fill:#3F51B5,stroke:#283593,stroke-width:3px,color:#ffffff
    style H fill:#4CAF50,stroke:#2E7D32,stroke-width:3px,color:#ffffff

🎯 Dynamic ref_id Generation

When Playwright MCP accesses a web page, it automatically:

Scans all interactive elements on the page (buttons, inputs, links, etc.)
Assigns unique ref_id attributes to each element dynamically
Creates an accessibility snapshot with element descriptions and their corresponding ref_ids
Provides this mapping to Claude Code for intelligent element selection

🎯 Intelligent Element Selection

Instead of guessing selectors, Claude Code can:

See exactly what elements exist on the page with human-readable descriptions
Reference elements by their unique ref_id with 100% accuracy
Avoid brittle selector-based failures that plague traditional automation
Handle dynamic content without manual selector updates

🎯 Natural Language to Precise Actions

# Your YAML test step:
- "Click Add to Cart button for first product"

# What happens behind the scenes:
# 1. Playwright MCP identifies all "Add to Cart" buttons
# 2. Assigns ref_ids: button[ref_id="addcart_123"], button[ref_id="addcart_456"]
# 3. Claude Code intelligently selects the first one: ref_id="addcart_123"
# 4. Executes precise click action without guessing selectors

🎯 Benefits Over Traditional Automation

Traditional Approach	Playwright MCP Approach
`page.click('#add-cart-btn-1')`	Claude sees "Add to Cart button for Sauce Labs Backpack" with ref_id
Brittle CSS selectors	Dynamic element identification
Breaks when HTML changes	Adapts to page structure automatically
Requires manual maintenance	Self-healing element detection
Multiple retry attempts	First-time accurate targeting

This is why our YAML-based approach is so powerful - you write in natural language, and Playwright MCP handles the complex element targeting automatically.

🎬 Demo Video

Watch the live demonstration of YAML-based Playwright testing in action:

📺 Watch Demo Video - See how to write and execute tests using natural language with Claude Code and Playwright MCP.

🌟 Key Features

🌍 Multi-Environment Support: Support for dev/test/prod environments with automatic configuration loading
📚 Reusable Step Libraries: Parameterized reusable step libraries to improve testing efficiency
🗣️ Natural Language: Direct use of natural language for test step descriptions, easy to read and write
🔧 Environment Variables: Automatic configuration loading from .env files, secure management of sensitive information
📊 Smart Reporting: Configurable test report generation with embedded data supporting HTML/JSON formats
📝 Smart Prompts: Claude Code project commands support parameter prompts
🚀 Session Persistence: Revolutionary cross-command session persistence - login once, test forever
⚡ Performance Boost: 80-95% performance improvement after first login with persistent sessions

🗺️ Development Roadmap

We're actively working on exciting new features to make YAML-based testing even more powerful:

✅ Completed Features

✅ Cursor IDE Support - COMPLETED 🎉

✅ Project Rules Integration: Complete .mdc rule file for Cursor AI integration
✅ Command Support: Full /run-yaml-test command support in Cursor
✅ Session Persistence: Same 80-95% performance boost in Cursor as Claude Code
✅ Cross-Platform Compatibility: Unified framework works seamlessly in both IDEs

✅ Test Suites Support - COMPLETED 🎉

✅ Suite Organization: Group related test cases into logical suites
✅ Batch Execution: Run entire test suites with a single command
✅ Suite-level Configuration: Environment variables and settings per suite
✅ Suite Reporting: Aggregated reports across multiple test cases
✅ Pre/Post Actions: Suite-level setup and cleanup operations
✅ Validation Commands: Comprehensive suite validation functionality

# Example: test-suites/e-commerce.yml
name: "E-commerce Test Suite"
description: "Complete e-commerce workflow testing"
tags:
  - e-commerce
  - integration
test-cases:
  - "test-cases/order.yml"
  - "test-cases/product-details.yml"
  - "test-cases/sort-optimized.yml"

Available Suite Commands:

/run-test-suite suite:e-commerce.yml env:test
/validate-test-suite suite:smoke-tests.yml env:dev

📅 Release Timeline

Feature	Status	Expected Release
✅ Cursor IDE Support	✅ Completed	✅ Released
✅ Test Suites Support	✅ Completed	✅ Released

🚀 Quick Start

1. Install the claude-test CLI

npm install -g claude-test

2. Install Playwright MCP

claude mcp add playwright -- npx -y @playwright/mcp@latest \
  --user-data-dir ~/.cache/claude-playwright \
  --storage-state ~/.cache/claude-playwright/auth-state.json \
  --save-trace \
  --output-dir ~/CascadeProjects/claude-code-playwright-mcp-test/screenshots

3. Initialize a New Project (Alternative to Using This Demo)

# Create a new project with the framework
cd your-new-project
claude-test init

4. Or Use This Demo Project

# Clone this demo project
git clone https://github.com/terryso/claude-code-playwright-mcp-test.git
cd claude-code-playwright-mcp-test

# Execute order test
/run-yaml-test file:test-cases/order.yml env:dev

# View reports
/view-reports-index

Simple YAML Test Example

# test-cases/example.yml
tags:
  - smoke
steps:
  - include: "login"
  - "Click Add to Cart button for first product"
  - "Click shopping cart icon"
  - "Verify cart contains 1 item"

📚 Documentation

📖 Installation Guide - Detailed setup instructions
🏗️ Project Structure - Understanding the framework structure
⚡ Commands Reference - Complete command documentation
📝 YAML Format Guide - Writing test cases and step libraries
🔧 Environment Configuration - Multi-environment setup
✨ Best Practices - Tips for effective testing

📊 Latest Test Results

📈 Latest Test Report - Automatically generated after each test run, showing detailed execution results, screenshots, and performance metrics.

💡 Feature Requests

Have ideas for new features? We'd love to hear from you!

Open an Issue with the enhancement label
Join discussions in our community
Contribute to the roadmap planning

🤝 Contributing

Fork the project
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add some amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

📺 Resources

🛠️ Official CLI Tool

📦 claude-test CLI - Official CLI package for framework management
📥 NPM Package - Global installation via npm
📋 CLI Documentation - Complete usage guide and API reference

📖 Learning Resources

🎬 Demo Video - Live demonstration of the framework
📈 Latest Test Report - Most recent test execution results
📖 Medium Article - Detailed explanation and benefits

🔧 Tools & Integrations

🛠️ Claude Code - AI-powered development environment
🎭 Playwright MCP - Browser automation integration

🆘 Support

For CLI Tool Issues

🐛 CLI Issues - Report CLI bugs or feature requests
📖 CLI Documentation - Complete CLI usage guide

For Demo Project Issues

Watch the demo video for visual guidance
Check the documentation
Review Demo Issues
Create a new Issue describing the problem
Use /help in Claude Code for more assistance

🔗 Related Projects

📦 claude-test CLI - Official CLI tool for framework management
🎬 Demo Video - Live demonstration of YAML testing
📖 Medium Article - In-depth framework explanation

⭐ Star History

Happy Testing! 🚀

This demo project showcases the power of the claude-test CLI framework. For new projects, install the CLI globally and use claude-test init to get started.

Name		Name	Last commit message	Last commit date
Latest commit History 37 Commits
.claude		.claude
.cursor/rules		.cursor/rules
.github/workflows		.github/workflows
assets		assets
data-examples		data-examples
docs		docs
steps		steps
test-cases		test-cases
test-suites		test-suites
.env.dev		.env.dev
.env.example		.env.example
.env.prod		.env.prod
.env.test		.env.test
.gitignore		.gitignore
CLAUDE.md		CLAUDE.md
README.cn.md		README.cn.md
README.md		README.md
USAGE_EXAMPLE.md		USAGE_EXAMPLE.md
package-lock.json		package-lock.json
package.json		package.json

terryso/claude-code-playwright-mcp-test

Folders and files

Latest commit

History

Repository files navigation