agents-cli-automation 1.0.4 → 1.0.6

package/README.md

@@ -0,0 +1,113 @@
+# Agents CLI
+
+A simple CLI tool to bootstrap production-ready Playwright automation frameworks for UI and API testing.
+
+## Installation
+
+### Option 1: Using npx (No installation required)
+```bash
+npx agents-cli-automation init
+```
+
+### Option 2: Install globally via npm
+```bash
+npm install -g agents-cli-automation
+agents init
+```
+
+### Option 3: Install locally in a project
+```bash
+npm install agents-cli-automation
+npx agents init
+```
+
+## Quick Start
+
+Run the setup command and select your testing type:
+```bash
+npx agents-cli-automation init
+```
+
+Choose from:
+1. **Playwright Setup for UI Testing** - Browser automation, E2E tests, component testing
+2. **Playwright Setup for API Testing** - REST API tests, integration testing, backend validation
+
+Follow the interactive prompts and your agent will be generated!
+
+## Available Agents
+
+### 📊 Playwright Setup for UI Testing
+Creates a production-ready Playwright framework for UI automation with:
+- ✅ Complete UI test project structure
+- ✅ UI, component, and E2E testing templates
+- ✅ Fixture configurations
+- ✅ WebServer setup for local development
+- ✅ All npm scripts configured
+- ✅ Sample tests with SauceDemo credentials
+- ✅ Headed and headless test modes
+
+### 🔌 Playwright Setup for API Testing
+Creates a production-ready Playwright framework for API automation with:
+- ✅ Complete API test project structure
+- ✅ REST API request handling
+- ✅ Response validation templates
+- ✅ Authentication fixtures
+- ✅ Database integration helpers
+- ✅ Sample API tests (GET, POST, etc.)
+- ✅ CI/CD ready configuration
+
+The generated agent will include everything you need to start automating tests immediately!
+
+## What Gets Created
+
+When you run `agents init`, a `.github/agents` directory is created in your project with one of these files:
+
+### For UI Testing
+- `playwright-ui-testing-agent.md` - Complete UI framework setup
+  - WebServer configuration
+  - Sample UI tests with SauceDemo
+  - Fixture setup
+  - Headed and headless modes
+  - Visual regression ready
+
+### For API Testing
+- `playwright-api-testing-agent.md` - Complete API framework setup
+  - REST API examples (GET, POST, etc.)
+  - Response validation
+  - Authentication fixtures
+  - Database integration helpers
+  - CI/CD ready configuration
+
+Each agent file includes:
+- Full setup instructions
+- Working sample tests
+- Verification checklist
+- Best practices
+- Environment configuration
+- Ready-to-use code snippets
+
+## Requirements
+
+- Node.js 18+
+- npm or yarn
+
+## Need Help?
+
+Each generated agent file provides comprehensive guidance:
+
+**For UI Testing:**
+- WebServer setup for local testing
+- SauceDemo test examples (login, add to cart)
+- How to replace with your own application
+- Debugging tips for browser tests
+
+**For API Testing:**
+- Writing GET, POST, PUT, DELETE tests
+- Response validation patterns
+- Authentication and headers setup
+- Environment variables configuration
+- Database integration examples
+
+---
+
+**Happy automating! 🚀**

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "agents-cli-automation",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Agents CLI",
   "type": "module",
   "bin": {
-    "agents": "./bin/index.js"
+    "agents": "bin/index.js"
   },
   "files": [
     "bin",

package/src/commands/init.js

@@ -14,12 +14,15 @@ export default async function initCommand() {
       type: "list",
       name: "setup",
       message: "Select setup",
-      choices: ["Add Playwright Agent"]
+      choices: [
+        "Playwright Setup for UI Testing",
+        "Playwright Setup for API Testing"
+      ]
     }
   ]);
 
-  if (setup === "Add Playwright Agent") {
-    // Template inside your CLI package
+  if (setup === "Playwright Setup for UI Testing") {
+    // Template for UI testing
     const templatePath = path.resolve(
       __dirname,
       "../templates/playwright-agent.md"
@@ -33,12 +36,35 @@ export default async function initCommand() {
     await fs.ensureDir(agentsDir);
 
     // Save file with .agent extension
-    const destFile = path.join(agentsDir, "playwrightsetup-agent.md");
+    const destFile = path.join(agentsDir, "playwright-ui-testing-agent.md");
 
     // Copy template content
     await fs.copyFile(templatePath, destFile);
 
-    console.log(`\n✅ Playwright agent created at ${destFile}\n`);
+    console.log(`\n✅ Playwright UI Testing agent created at ${destFile}\n`);
+  }
+
+  if (setup === "Playwright Setup for API Testing") {
+    // Template for API testing
+    const templatePath = path.resolve(
+      __dirname,
+      "../templates/playwright-agent-api.md"
+    );
+
+    // Target folder **inside the user's project**
+    const userProjectRoot = process.cwd();
+    const agentsDir = path.join(userProjectRoot, ".github", "agents");
+
+    // Ensure folder exists
+    await fs.ensureDir(agentsDir);
+
+    // Save file with .agent extension
+    const destFile = path.join(agentsDir, "playwright-api-testing-agent.md");
+
+    // Copy template content
+    await fs.copyFile(templatePath, destFile);
+
+    console.log(`\n✅ Playwright API Testing agent created at ${destFile}\n`);
   }
 
   console.log("Setup complete 🎉\n");

package/src/templates/playwright-agent-api.md

@@ -0,0 +1,190 @@
+name: Create Playwright Framework - API Testing
+description: Creates a production-ready Playwright API testing framework with all dependencies and fixtures properly configured.
+argument-hint: "framework requirements, e.g., 'REST API and webhook testing'"
+
+---
+
+# Playwright API Testing Framework Setup
+
+This agent creates a production-ready Playwright framework optimized for API automation.
+
+## Capabilities
+- Playwright API testing setup (JS / TS)
+- REST API request handling
+- Response validation
+- Database integration
+- API fixtures and helpers
+- Sample API tests
+- Scalable folder structure
+- CI/CD ready configuration
+
+## Prerequisites
+- Node.js 18+ installed
+- npm or yarn
+- API endpoint documentation
+
+## Setup Instructions
+
+### 1. Install Dependencies
+```bash
+npm install
+```
+
+### 2. Required package.json Scripts
+Ensure your `package.json` includes these scripts:
+```json
+{
+  "scripts": {
+    "test": "playwright test",
+    "test:api": "playwright test --grep @api",
+    "test:debug": "playwright test --debug",
+    "test:report": "playwright show-report"
+  }
+}
+```
+
+### 3. Playwright Configuration
+Your `playwright.config.js` should include:
+```javascript
+{
+  testDir: './tests/api',
+  fullyParallel: true,
+  workers: process.env.CI ? 1 : undefined,
+  use: {
+    baseURL: process.env.API_BASE_URL || 'https://api.example.com',
+    timeout: 10000
+  }
+}
+```
+
+### 4. Sample API Tests (Ready to Use)
+
+**Login API Test** (`tests/api/auth.spec.js`):
+```javascript
+import { test, expect } from '@playwright/test';
+
+test('@api Login endpoint', async ({ request }) => {
+  const response = await request.post('https://api.example.com/auth/login', {
+    data: {
+      username: 'testuser',
+      password: 'testpass'
+    }
+  });
+  
+  expect(response.status()).toBe(200);
+  const data = await response.json();
+  expect(data).toHaveProperty('token');
+});
+```
+
+**GET Request Test** (`tests/api/users.spec.js`):
+```javascript
+import { test, expect } from '@playwright/test';
+
+test('@api Get all users', async ({ request }) => {
+  const response = await request.get('https://api.example.com/users');
+  
+  expect(response.status()).toBe(200);
+  const data = await response.json();
+  expect(Array.isArray(data)).toBeTruthy();
+});
+
+test('@api Get specific user', async ({ request }) => {
+  const response = await request.get('https://api.example.com/users/1');
+  
+  expect(response.status()).toBe(200);
+  const data = await response.json();
+  expect(data).toHaveProperty('id');
+  expect(data.id).toBe(1);
+});
+```
+
+**POST Request Test** (`tests/api/create.spec.js`):
+```javascript
+import { test, expect } from '@playwright/test';
+
+test('@api Create new user', async ({ request }) => {
+  const response = await request.post('https://api.example.com/users', {
+    data: {
+      name: 'John Doe',
+      email: 'john@example.com'
+    }
+  });
+  
+  expect(response.status()).toBe(201);
+  const data = await response.json();
+  expect(data.name).toBe('John Doe');
+  expect(data).toHaveProperty('id');
+});
+```
+
+**API Fixture Example** (`fixtures/api.js`):
+```javascript
+import { test as base } from '@playwright/test';
+
+export const test = base.extend({
+  apiContext: async ({ playwright }, use) => {
+    const context = await playwright.request.newContext({
+      baseURL: process.env.API_BASE_URL || 'https://api.example.com',
+      extraHTTPHeaders: {
+        'Authorization': `Bearer ${process.env.API_TOKEN}`
+      }
+    });
+    
+    await use(context);
+    await context.dispose();
+  }
+});
+```
+
+### 5. Run Tests
+```bash
+# Run all API tests
+npm test
+
+# Run only tests tagged with @api
+npm run test:api
+
+# Debug mode
+npm run test:debug
+
+# View HTML report
+npm run test:report
+```
+
+## Best Practices
+- Use fixtures for authentication tokens and common setup
+- Tag tests with `@api` for easy filtering
+- Use environment variables for sensitive data (API tokens, URLs)
+- Implement proper error handling and response validation
+- Create helper functions for common API calls
+- Mock external dependencies when possible
+
+## Environment Variables
+Create a `.env` file:
+```
+API_BASE_URL=https://api.example.com
+API_TOKEN=your_token_here
+DB_HOST=localhost
+DB_USER=admin
+DB_PASS=password
+```
+
+## Verification Checklist
+✅ All dependencies installed (`npm install`)
+✅ API endpoint(s) accessible
+✅ Environment variables configured
+✅ Playwright config points to correct API base URL
+✅ Sample tests execute successfully
+✅ Response validation working
+
+## Use Cases
+- Rest API testing
+- Backend service validation
+- Integration testing
+- Microservice testing
+- Contract testing
+
+---
+
+**Ready to test your APIs! 🚀**

package/src/templates/playwright-agent.md

@@ -1,16 +1,113 @@
-name: creat playwright frmework
-description: Describe what this custom agent does and when to use it.
-argument-hint: The inputs this agent expects, e.g., "framework requirements"
+name: Create Playwright Framework - UI Testing
+description: Creates a production-ready Playwright UI automation framework with all dependencies, fixtures, and test configurations properly set up.
+argument-hint: "framework requirements, e.g., 'JavaScript with UI tests'"
 
 ---
 
-This agent creates a production-ready Playwright automation framework.
+# Playwright UI Testing Framework Setup
 
-Capabilities:
+This agent creates a production-ready Playwright framework optimized for UI automation.
+
+## Capabilities
 - Playwright setup (JS / TS)
-- API, DB, UI structure
-- Fixtures
-- Sample tests
+- UI, component, and end-to-end testing
+- Fixtures with proper configuration
+- Sample tests (headless & headed modes)
 - Scalable folder structure
+- WebServer configuration for running tests against local servers
+- Complete package.json with all required scripts
+- Visual regression testing ready
+
+## Prerequisites
+- Node.js 18+ installed
+- npm or yarn
+
+## Setup Instructions
+
+### 1. Install Dependencies
+```bash
+npm install
+```
+
+### 2. Required package.json Scripts
+Ensure your `package.json` includes these scripts:
+```json
+{
+  "scripts": {
+    "start": "node server.js",
+    "test": "playwright test",
+    "test:headed": "playwright test --headed",
+    "test:debug": "playwright test --debug",
+    "test:ui": "playwright test --ui"
+  }
+}
+```
+
+### 3. Playwright Configuration
+Your `playwright.config.js` must include:
+```javascript
+{
+  webServer: {
+    command: 'npm start',
+    url: 'http://localhost:3000',
+    reuseExistingServer: !process.env.CI,
+  }
+}
+```
+
+### 4. Sample UI Test (Ready to Use)
+For testing UI automation, use this demo application:
+
+**Application:** https://www.saucedemo.com/
+**Credentials:**
+- Username: `standard_user`
+- Password: `secret_sauce`
+
+Example test file (`tests/saucedemo.spec.js`):
+```javascript
+import { test, expect } from '@playwright/test';
+
+test('Login to SauceDemo', async ({ page }) => {
+  await page.goto('https://www.saucedemo.com/');
+  await page.fill('[data-test="username"]', 'standard_user');
+  await page.fill('[data-test="password"]', 'secret_sauce');
+  await page.click('[data-test="login-button"]');
+  await expect(page).toHaveURL('**/inventory.html');
+});
+
+test('Add product to cart', async ({ page }) => {
+  await page.goto('https://www.saucedemo.com/');
+  await page.fill('[data-test="username"]', 'standard_user');
+  await page.fill('[data-test="password"]', 'secret_sauce');
+  await page.click('[data-test="login-button"]');
+  await page.click('[data-test="add-to-cart-sauce-labs-backpack"]');
+  await expect(page.locator('[data-test="shopping-cart-badge"]')).toContainText('1');
+});
+```
+
+### 5. Run Tests
+```bash
+# Run all tests
+npm test
+
+# Run tests with UI
+npm run test:headed
+
+# Debug mode
+npm run test:debug
+```
+
+## Verification Checklist
+✅ All dependencies installed (`npm install`)
+✅ "start" script defined in package.json
+✅ Local server running on configured port
+✅ Playwright config has webServer setup
+✅ Tests execute without webServer errors
+
+## Use Cases
+- New automation projects
+- E2E testing frameworks
+- Integration testing setup
+- CI/CD pipeline automation
 
-Use this agent when starting a new automation project.
+**Note:** If you see "Missing script: start" error, add the `start` script to your package.json before running tests.