agents-cli-automation 1.0.6 → 1.0.8

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

@@ -0,0 +1,471 @@
+name: Create Playwright Framework - UI Testing (Java)
+description: Creates a production-ready Playwright UI automation framework in Java with Maven, Junit5, and all required configurations.
+argument-hint: "framework requirements, e.g., 'Java with Playwright tests'"
+
+---
+
+# Playwright UI Testing Framework - Java
+
+This agent creates a production-ready Playwright framework in Java with Maven and JUnit 5 optimized for UI automation.
+
+## Capabilities
+- **Java 11+** - Chromium only with modern Maven setup
+- **JUnit 5** - Latest testing framework
+- **Maven** - Dependency management and build automation
+- **Page Object Model (POM)** - Reusable page classes
+- **Test Fixtures** - Setup and teardown management
+- **Parallel execution** - Tests run simultaneously for speed
+- **Test data support** - JSON, CSV, YAML loading
+- **BDD Support** - Cucumber with Gherkin syntax
+- **WebDriverWait** - Explicit waits for element handling
+- **Scalable folder structure** with best practices
+
+## Prerequisites
+- Java 11 or higher installed
+- Maven 3.8+ installed
+- Git (optional)
+
+## Setup Instructions
+
+### 1. Create Maven Project Structure
+```bash
+mvn archetype:generate -DgroupId=com.test.automation -DartifactId=playwright-framework -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
+cd playwright-framework
+```
+
+### 2. Update pom.xml with Dependencies
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.test.automation</groupId>
+  <artifactId>playwright-framework</artifactId>
+  <version>1.0.0</version>
+
+  <properties>
+    <maven.compiler.source>11</maven.compiler.source>
+    <maven.compiler.target>11</maven.compiler.target>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <playwright.version>1.50.0</playwright.version>
+    <junit.version>5.10.1</junit.version>
+  </properties>
+
+  <dependencies>
+    <!-- Playwright -->
+    <dependency>
+      <groupId>com.microsoft.playwright</groupId>
+      <artifactId>playwright</artifactId>
+      <version>${playwright.version}</version>
+    </dependency>
+
+    <!-- JUnit 5 -->
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter</artifactId>
+      <version>${junit.version}</version>
+      <scope>test</scope>
+    </dependency>
+
+    <!-- JSON -->
+    <dependency>
+      <groupId>com.google.code.gson</groupId>
+      <artifactId>gson</artifactId>
+      <version>2.10.1</version>
+    </dependency>
+
+    <!-- YAML -->
+    <dependency>
+      <groupId>org.yaml</groupId>
+      <artifactId>snakeyaml</artifactId>
+      <version>2.0</version>
+    </dependency>
+
+    <!-- CSV -->
+    <dependency>
+      <groupId>org.apache.commons</groupId>
+      <artifactId>commons-csv</artifactId>
+      <version>1.10.0</version>
+    </dependency>
+
+    <!-- Cucumber -->
+    <dependency>
+      <groupId>io.cucumber</groupId>
+      <artifactId>cucumber-java</artifactId>
+      <version>7.14.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.cucumber</groupId>
+      <artifactId>cucumber-junit-platform-engine</artifactId>
+      <version>7.14.0</version>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>3.0.0-M9</version>
+      </plugin>
+    </plugins>
+  </build>
+</project>
+```
+
+### 3. Project Structure
+```
+playwright-framework/
+├── src/
+│   ├── main/
+│   │   └── java/
+│   │       └── com/test/automation/
+│   │           ├── pages/
+│   │           │   ├── BasePage.java
+│   │           │   ├── LoginPage.java
+│   │           │   ├── InventoryPage.java
+│   │           │   └── FormPage.java
+│   │           ├── utils/
+│   │           │   ├── DataReader.java
+│   │           │   ├── FormHelper.java
+│   │           │   └── TestDataManager.java
+│   │           ├── fixtures/
+│   │           │   └── TestFixtures.java
+│   │           └── model/
+│   │               ├── User.java
+│   │               ├── FormData.java
+│   │               └── Config.java
+│   ├── test/
+│   │   ├── java/
+│   │   │   └── com/test/automation/
+│   │   │       ├── tests/
+│   │   │       │   ├── SauceDemoTest.java
+│   │   │       │   └── FormTest.java
+│   │   │       └── steps/
+│   │   │           ├── LoginSteps.java
+│   │   │           └── ShoppingSteps.java
+│   │   └── resources/
+│   │       ├── features/
+│   │       │   ├── login.feature
+│   │       │   └── shopping.feature
+│   │       └── data/
+│   │           ├── users.json
+│   │           ├── formData.csv
+│   │           └── config.yaml
+└── pom.xml
+```
+
+### 4. Base Page (src/main/java/pages/BasePage.java)
+```java
+package com.test.automation.pages;
+
+import com.microsoft.playwright.Page;
+import com.microsoft.playwright.Locator;
+import java.util.concurrent.TimeoutException;
+
+public class BasePage {
+    protected Page page;
+    protected static final int TIMEOUT = 5000;
+
+    public BasePage(Page page) {
+        this.page = page;
+    }
+
+    public void navigateTo(String url) {
+        page.navigate(url);
+    }
+
+    public void click(String selector) {
+        page.click(selector);
+    }
+
+    public void fill(String selector, String text) {
+        page.fill(selector, text);
+    }
+
+    public String getText(String selector) {
+        return page.textContent(selector);
+    }
+
+    public void waitForElement(String selector) {
+        page.waitForSelector(selector, new Page.WaitForSelectorOptions().setTimeout(TIMEOUT));
+    }
+
+    public boolean isVisible(String selector) {
+        return page.locator(selector).isVisible();
+    }
+
+    public void selectDropdown(String selector, String optionText) {
+        page.click(selector);
+        page.click("text=" + optionText);
+    }
+
+    public void selectRadioButton(String labelText) {
+        Locator label = page.locator("label:has-text(\"" + labelText + "\")");
+        String radioId = label.getAttribute("for");
+        page.click("#" + radioId);
+    }
+
+    public void checkCheckbox(String labelText) {
+        Locator label = page.locator("label:has-text(\"" + labelText + "\")");
+        String checkboxId = label.getAttribute("for");
+        Locator checkbox = page.locator("#" + checkboxId);
+        if (!checkbox.isChecked()) {
+            checkbox.click();
+        }
+    }
+}
+```
+
+### 5. Login Page (src/main/java/pages/LoginPage.java)
+```java
+package com.test.automation.pages;
+
+import com.microsoft.playwright.Page;
+
+public class LoginPage extends BasePage {
+    private static final String USERNAME_FIELD = "[data-test=\"username\"]";
+    private static final String PASSWORD_FIELD = "[data-test=\"password\"]";
+    private static final String LOGIN_BUTTON = "[data-test=\"login-button\"]";
+    private static final String APP_URL = "https://www.saucedemo.com/";
+
+    public LoginPage(Page page) {
+        super(page);
+    }
+
+    public void goTo() {
+        page.navigate(APP_URL);
+    }
+
+    public void login(String username, String password) {
+        page.fill(USERNAME_FIELD, username);
+        page.fill(PASSWORD_FIELD, password);
+        page.click(LOGIN_BUTTON);
+        page.waitForURL("**/inventory.html");
+    }
+
+    public boolean isLoaded() {
+        return page.locator(USERNAME_FIELD).isVisible();
+    }
+}
+```
+
+### 6. Data Reader (src/main/java/utils/DataReader.java)
+```java
+package com.test.automation.utils;
+
+import com.google.gson.Gson;
+import com.google.gson.JsonObject;
+import org.apache.commons.csv.CSVFormat;
+import org.apache.commons.csv.CSVParser;
+import org.apache.commons.csv.CSVRecord;
+import org.yaml.snakeyaml.Yaml;
+
+import java.io.FileReader;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.*;
+
+public class DataReader {
+    private static final String DATA_DIR = "src/test/resources/data";
+
+    public static JsonObject readJSON(String filename) throws IOException {
+        String content = new String(Files.readAllBytes(Paths.get(DATA_DIR, filename)));
+        return new Gson().fromJson(content, JsonObject.class);
+    }
+
+    public static Map<String, Object> readYAML(String filename) throws IOException {
+        String content = new String(Files.readAllBytes(Paths.get(DATA_DIR, filename)));
+        Yaml yaml = new Yaml();
+        return yaml.load(content);
+    }
+
+    public static List<Map<String, String>> readCSV(String filename) throws IOException {
+        List<Map<String, String>> records = new ArrayList<>();
+        CSVParser csvParser = CSVFormat.DEFAULT.withFirstRecordAsHeader()
+                .parse(new FileReader(Paths.get(DATA_DIR, filename).toFile()));
+
+        for (CSVRecord record : csvParser) {
+            records.add(record.toMap());
+        }
+        return records;
+    }
+
+    public static Map<String, String> getRecordByKey(List<Map<String, String>> data, String key, String value) {
+        return data.stream()
+                .filter(record -> value.equals(record.get(key)))
+                .findFirst()
+                .orElse(null);
+    }
+}
+```
+
+### 7. Form Helper (src/main/java/utils/FormHelper.java)
+```java
+package com.test.automation.utils;
+
+import com.microsoft.playwright.Page;
+import com.microsoft.playwright.Locator;
+import java.util.List;
+
+public class FormHelper {
+    private Page page;
+
+    public FormHelper(Page page) {
+        this.page = page;
+    }
+
+    public void fillInput(String selector, String value) {
+        page.fill(selector, value);
+    }
+
+    public void fillTextArea(String selector, String value) {
+        page.locator(selector).clear();
+        page.locator(selector).type(value, new Locator.TypeOptions().setDelay(50));
+    }
+
+    public void selectDropdown(String dropdownSelector, String optionText) {
+        page.click(dropdownSelector);
+        page.click("text=" + optionText);
+    }
+
+    public void selectRadioButton(String labelText) {
+        Locator label = page.locator("label:has-text(\"" + labelText + "\")");
+        String radioId = label.getAttribute("for");
+        page.click("#" + radioId);
+    }
+
+    public void checkCheckbox(String labelText) {
+        Locator label = page.locator("label:has-text(\"" + labelText + "\")");
+        String checkboxId = label.getAttribute("for");
+        Locator checkbox = page.locator("#" + checkboxId);
+        if (!checkbox.isChecked()) {
+            checkbox.click();
+        }
+    }
+
+    public void checkMultiple(List<String> labels) {
+        for (String label : labels) {
+            checkCheckbox(label);
+        }
+    }
+
+    public String getInputValue(String selector) {
+        return page.inputValue(selector);
+    }
+
+    public boolean isCheckboxChecked(String labelText) {
+        Locator label = page.locator("label:has-text(\"" + labelText + "\")");
+        String checkboxId = label.getAttribute("for");
+        return page.locator("#" + checkboxId).isChecked();
+    }
+}
+```
+
+### 8. Simple Test (src/test/java/tests/SauceDemoTest.java)
+```java
+package com.test.automation.tests;
+
+import com.microsoft.playwright.*;
+import com.test.automation.pages.LoginPage;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.AfterAll;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+public class SauceDemoTest {
+    static Playwright playwright;
+    static Browser browser;
+    BrowserContext context;
+    Page page;
+
+    @BeforeAll
+    static void launchBrowser() {
+        playwright = Playwright.create();
+        browser = playwright.chromium().launch();
+    }
+
+    @AfterAll
+    static void closeBrowser() {
+        playwright.close();
+    }
+
+    @Test
+    public void testLoginWithValidCredentials() {
+        context = browser.newContext();
+        page = context.newPage();
+
+        LoginPage loginPage = new LoginPage(page);
+        loginPage.goTo();
+        loginPage.login("standard_user", "secret_sauce");
+
+        assertTrue(page.url().contains("inventory.html"));
+        context.close();
+    }
+}
+```
+
+### 9. Run Tests
+
+```bash
+# Run all tests
+mvn test
+
+# Run specific test class
+mvn test -Dtest=SauceDemoTest
+
+# Run specific test method
+mvn test -Dtest=SauceDemoTest#testLoginWithValidCredentials
+
+# Run with parallel execution
+mvn test -DthreadCount=4
+
+# Run BDD scenarios
+mvn test -Dcucumber.options="classpath:features"
+
+# View report
+# Open target/surefire-reports/index.html
+```
+
+### 10. Test Data Files
+
+**src/test/resources/data/users.json**
+```json
+{
+  "users": [
+    {
+      "id": "1",
+      "username": "standard_user",
+      "password": "secret_sauce",
+      "email": "user@example.com",
+      "firstName": "John",
+      "lastName": "Doe"
+    }
+  ]
+}
+```
+
+**src/test/resources/data/config.yaml**
+```yaml
+app:
+  url: https://www.saucedemo.com/
+  timeout: 30000
+users:
+  standard:
+    username: standard_user
+    password: secret_sauce
+```
+
+## Best Practices
+✅ **Page Object Model** - All selectors in page classes
+✅ **Fixtures** - Static setup/teardown with BeforeAll/AfterAll
+✅ **Test Data** - Externalize in JSON, CSV, YAML
+✅ **Form Helpers** - Handle all form interactions
+✅ **Parallel Execution** - Maven threadCount option
+✅ **Chromium Only** - Single browser for consistency
+✅ **Java 11+** - Modern Java features
+✅ **JUnit 5** - Latest testing framework
+✅ **Maven** - Standard Java build tool
+
+**Note:** This framework uses Java 11+, Chromium only, and Maven for build management. Use `mvn clean install` to download dependencies and run tests with `mvn test`.