Documentation is Updated

Author: letzautomate

README.md

@@ -5,6 +5,15 @@ This is a robust end-to-end Test Automation Framework built using **Playwright**
 
 ---
 
+## 📚 Documentation
+
+- [BasePage](docs/BasePage.md)
+- [LoginPage](docs/LoginPage.md)
+- [HomePage](docs/HomePage.md)
+- [Logger Utility](docs/logger.md)
+- [Allure Helper](docs/allureHelper.md)
+- [Playwright Config](docs/playwright-config.md)
+
 ## 🚀 Features
 
 - ✅ TypeScript-based Playwright tests

docs/AllureHelper.md

@@ -0,0 +1,28 @@
+# Allure Helper
+
+**File:** `utils/allureHelper.ts`
+
+## Purpose
+
+Simplifies Allure reporting integration.  
+Allows marking steps with status and stopping tests on failure.
+
+---
+
+## Key Method
+
+### stepCheck
+
+```typescript
+stepCheck(message: string, status: string = 'passed', shouldStop: boolean = false)
+```
+- Logs and reports a step.
+- Optionally fails the test if `shouldStop` is true.
+
+---
+
+## Usage Example
+
+```typescript
+await AllureHelper.stepCheck('Login is successful');
+```

docs/BasePage.md

@@ -0,0 +1,107 @@
+# BasePage Class
+
+**File:** `pages/BasePage.ts`
+
+## Purpose
+
+The `BasePage` class provides reusable, robust, and well-logged utility methods for interacting with web elements in Playwright.  
+All specific page classes should extend `BasePage` to inherit these utilities, ensuring consistency and reducing code duplication.
+
+---
+
+## Methods
+
+### waitForElement
+
+```typescript
+async waitForElement(
+    locator: Locator,
+    timeout: number = 5000,
+    maxRetries: number = 3,
+    delayBetweenRetries: number = 1000
+): Promise<void>
+```
+Waits for an element to appear/become ready, with configurable retries and delays.  
+- Retries up to `maxRetries` times, waiting `timeout` ms each time.
+- Logs each attempt and failure.
+- Throws an error if the element is not found after all retries.
+
+---
+
+### clickElement
+
+```typescript
+async clickElement(locator: Locator, wait: boolean = true): Promise<void>
+```
+Clicks an element, optionally waiting for it to be ready first.
+
+---
+
+### enterText
+
+```typescript
+async enterText(locator: Locator, value: string, wait: boolean = true): Promise<void>
+```
+Fills an input field with the provided value, optionally waiting for readiness.
+
+---
+
+### typeText
+
+```typescript
+async typeText(locator: Locator, value: string, wait: boolean = true): Promise<void>
+```
+Types text into an input field character by character, simulating real user input.
+
+---
+
+### selectDropdown
+
+```typescript
+async selectDropdown(locator: Locator, value: string, wait: boolean = true): Promise<void>
+```
+Selects an option from a dropdown by value.
+
+---
+
+### getElementText
+
+```typescript
+async getElementText(locator: Locator, wait: boolean = true): Promise<string>
+```
+Retrieves the text content of an element.
+
+---
+
+### isElementVisible
+
+```typescript
+async isElementVisible(locator: Locator): Promise<boolean>
+```
+Checks if an element is visible on the page.
+
+---
+
+## Logging
+
+All actions are logged using the shared logger utility for traceability and easier debugging.
+
+---
+
+## Usage Example
+
+```typescript
+import { BasePage } from './BasePage';
+
+class LoginPage extends BasePage {
+    // Define locators and page-specific methods here
+}
+```
+
+---
+
+## Maintenance Tips
+
+- Add new generic element actions here so all pages benefit.
+- Avoid page-specific logic in `BasePage`.
+- Use logs to diagnose flaky tests or UI issues

docs/HomePage.md

@@ -0,0 +1,29 @@
+# HomePage Class
+
+**File:** `pages/HomePage.ts`
+
+## Purpose
+
+Encapsulates actions and verifications for the home page after login.
+
+---
+
+## Typical Methods
+
+- `verifyLoginIsSuccessful()`: Checks if login succeeded by verifying the URL or a specific element.
+- `verifyProductExists(productName: string)`: Checks if a product is visible on the home page.
+
+---
+
+## Usage Example
+
+```typescript
+const homePage = new HomePage(page);
+await homePage.verifyLoginIsSuccessful();
+```
+
+---
+
+## Maintenance Tips
+
+- Add new methods for home page actions or verifications as needed.

docs/Logger.md

@@ -0,0 +1,24 @@
+# Logger Utility
+
+**File:** `utils/logger.ts`
+
+## Purpose
+
+Provides centralized logging using Winston.  
+Logs to both console and file for traceability.
+
+---
+
+## Usage Example
+
+```typescript
+logger.info('This is an info message');
+logger.error('This is an error message');
+```
+
+---
+
+## Maintenance Tips
+
+- Adjust log levels or formats as needed.
+- Ensure logs are rotated or archived in CI environments.

docs/LoginPage.md

@@ -0,0 +1,32 @@
+# LoginPage Class
+
+**File:** `pages/LoginPage.ts`
+
+## Purpose
+
+Encapsulates all selectors and actions for the login page.  
+Provides a single place to maintain login logic, making tests more readable and maintainable.
+
+---
+
+## Typical Methods
+
+- `goto()`: Navigates to the login page URL.
+- `login(userName: string, password: string)`: Fills in the username and password fields and clicks the login button.
+
+---
+
+## Usage Example
+
+```typescript
+const loginPage = new LoginPage(page);
+await loginPage.goto();
+await loginPage.login('user', 'pass');
+```
+
+---
+
+## Maintenance Tips
+
+- Update selectors here if the login page UI changes.
+- Add new login-related actions as needed.

docs/PlaywrightConfiguration.md

@@ -0,0 +1,19 @@
+# Playwright Configuration
+
+**File:** `playwright.config.ts`
+
+## Purpose
+
+Centralizes all Playwright test settings:  
+- Test directory  
+- Retries  
+- Timeouts  
+- Reporters  
+- Browser/project settings
+
+---
+
+## Maintenance Tips
+
+- Update browser/project settings as needed.
+- Adjust timeouts and retries for stability.

pages/BasePage.ts

@@ -40,7 +40,8 @@ export class BasePage {
 
     async enterText(locator: Locator, value: string, wait: boolean = true): Promise<void> {
         if (wait) await this.waitForElement(locator);
-        await locator.fill(value);
+        const response = await locator.fill(value);
+        
         logger.info(`Filled input ${locator.toString()} with value: ${value}`);
     }
 

pages/HomePage.ts

@@ -7,7 +7,8 @@ export class HomePage extends BasePage{
     protected readonly page: Page;
 
     private txtProductLink(productName: string) :Locator {
-        return this.page.locator(`text="${productName}"`)
+        return this.page.locator(`text="${productName}"`);
+       
     }
 
 

pages/LoginPage.ts

@@ -8,15 +8,15 @@ export class LoginPage extends BasePage {
 
 
     private get txtUserName(): Locator {
-        return this.page.locator('#user-name');
+        return this.page.getByRole('textbox', {name : 'Username'});
     }
 
     private get txtPassword(): Locator {
-        return this.page.locator('#password');
+        return this.page.getByRole('textbox', {name:'Password'});
     }
 
     private get btnLogin() : Locator {
-        return this.page.locator('#login-button');
+        return this.page.getByRole('button',{name : 'Login'});
     }
 
     async goto() {
@@ -29,7 +29,7 @@ export class LoginPage extends BasePage {
     }
 
     async login(userName: string, password: string) {
-        await this.enterText(this.txtUserName, userName);
+        const response = await this.enterText(this.txtUserName, userName);
         await this.enterText(this.txtPassword, password);
         await this.clickElement(this.btnLogin);
     }